Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Honeycombio Provider
  3. API Docs
  4. Environment
honeycombio 0.31.0 published on Friday, Mar 7, 2025 by honeycombio
honeycombio/terraform-provider-honeycombio

honeycombio.Environment

Explore with Pulumi AI

honeycombio logo
honeycombio 0.31.0 published on Friday, Mar 7, 2025 by honeycombio
honeycombio/terraform-provider-honeycombio

    # Resource: honeycombio.Environment

    Creates a Honeycomb Environment.

    This resource requires the provider be configured with a Management Key with environments:write in the configured scopes.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as honeycombio from "@pulumi/honeycombio";

const uat = new honeycombio.Environment("uat", {color: "green"});

    import pulumi
import pulumi_honeycombio as honeycombio

uat = honeycombio.Environment("uat", color="green")

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/honeycombio/honeycombio"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := honeycombio.NewEnvironment(ctx, "uat", &honeycombio.EnvironmentArgs{
			Color: pulumi.String("green"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Honeycombio = Pulumi.Honeycombio;

return await Deployment.RunAsync(() => 
{
    var uat = new Honeycombio.Environment("uat", new()
    {
        Color = "green",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.honeycombio.Environment;
import com.pulumi.honeycombio.EnvironmentArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var uat = new Environment("uat", EnvironmentArgs.builder()
            .color("green")
            .build());

    }
}

    resources:
  uat:
    type: honeycombio:Environment
    properties:
      color: green

    Create Environment Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Environment(name: string, args?: EnvironmentArgs, opts?: CustomResourceOptions);
    @overload
def Environment(resource_name: str,
                args: Optional[EnvironmentArgs] = None,
                opts: Optional[ResourceOptions] = None)

@overload
def Environment(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                color: Optional[str] = None,
                delete_protected: Optional[bool] = None,
                description: Optional[str] = None,
                name: Optional[str] = None)
    func NewEnvironment(ctx *Context, name string, args *EnvironmentArgs, opts ...ResourceOption) (*Environment, error)
    public Environment(string name, EnvironmentArgs? args = null, CustomResourceOptions? opts = null)
    public Environment(String name, EnvironmentArgs args)
public Environment(String name, EnvironmentArgs args, CustomResourceOptions options)

    type: honeycombio:Environment
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args EnvironmentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args EnvironmentArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args EnvironmentArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EnvironmentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EnvironmentArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var environmentResource = new Honeycombio.Environment("environmentResource", new()
{
    Color = "string",
    DeleteProtected = false,
    Description = "string",
    Name = "string",
});

    example, err := honeycombio.NewEnvironment(ctx, "environmentResource", &honeycombio.EnvironmentArgs{
Color: pulumi.String("string"),
DeleteProtected: pulumi.Bool(false),
Description: pulumi.String("string"),
Name: pulumi.String("string"),
})

    var environmentResource = new Environment("environmentResource", EnvironmentArgs.builder()
    .color("string")
    .deleteProtected(false)
    .description("string")
    .name("string")
    .build());

    environment_resource = honeycombio.Environment("environmentResource",
    color="string",
    delete_protected=False,
    description="string",
    name="string")

    const environmentResource = new honeycombio.Environment("environmentResource", {
    color: "string",
    deleteProtected: false,
    description: "string",
    name: "string",
});

    type: honeycombio:Environment
properties:
    color: string
    deleteProtected: false
    description: string
    name: string

    Environment Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Environment resource accepts the following input properties:

    Color string
    The color to display the Environment in the navigation bar. If not provided one will be randomly selected at creation. One of blue, green, gold, red, purple, lightBlue, lightGreen, lightGold, lightRed, lightPurple.
    DeleteProtected bool
    the current state of the Environment's deletion protection status. Defaults to true. Cannot be set to false on create.
    Description string
    A description for the Environment.
    Name string
    The name of the Environment. Must be unique to the Team.
    Color string
    The color to display the Environment in the navigation bar. If not provided one will be randomly selected at creation. One of blue, green, gold, red, purple, lightBlue, lightGreen, lightGold, lightRed, lightPurple.
    DeleteProtected bool
    the current state of the Environment's deletion protection status. Defaults to true. Cannot be set to false on create.
    Description string
    A description for the Environment.
    Name string
    The name of the Environment. Must be unique to the Team.
    color String
    The color to display the Environment in the navigation bar. If not provided one will be randomly selected at creation. One of blue, green, gold, red, purple, lightBlue, lightGreen, lightGold, lightRed, lightPurple.
    deleteProtected Boolean
    the current state of the Environment's deletion protection status. Defaults to true. Cannot be set to false on create.
    description String
    A description for the Environment.
    name String
    The name of the Environment. Must be unique to the Team.
    color string
    The color to display the Environment in the navigation bar. If not provided one will be randomly selected at creation. One of blue, green, gold, red, purple, lightBlue, lightGreen, lightGold, lightRed, lightPurple.
    deleteProtected boolean
    the current state of the Environment's deletion protection status. Defaults to true. Cannot be set to false on create.
    description string
    A description for the Environment.
    name string
    The name of the Environment. Must be unique to the Team.
    color str
    The color to display the Environment in the navigation bar. If not provided one will be randomly selected at creation. One of blue, green, gold, red, purple, lightBlue, lightGreen, lightGold, lightRed, lightPurple.
    delete_protected bool
    the current state of the Environment's deletion protection status. Defaults to true. Cannot be set to false on create.
    description str
    A description for the Environment.
    name str
    The name of the Environment. Must be unique to the Team.
    color String
    The color to display the Environment in the navigation bar. If not provided one will be randomly selected at creation. One of blue, green, gold, red, purple, lightBlue, lightGreen, lightGold, lightRed, lightPurple.
    deleteProtected Boolean
    the current state of the Environment's deletion protection status. Defaults to true. Cannot be set to false on create.
    description String
    A description for the Environment.
    name String
    The name of the Environment. Must be unique to the Team.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Environment resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Slug string
    The slug of the Environment.
    Id string
    The provider-assigned unique ID for this managed resource.
    Slug string
    The slug of the Environment.
    id String
    The provider-assigned unique ID for this managed resource.
    slug String
    The slug of the Environment.
    id string
    The provider-assigned unique ID for this managed resource.
    slug string
    The slug of the Environment.
    id str
    The provider-assigned unique ID for this managed resource.
    slug str
    The slug of the Environment.
    id String
    The provider-assigned unique ID for this managed resource.
    slug String
    The slug of the Environment.

    Look up Existing Environment Resource

    Get an existing Environment resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: EnvironmentState, opts?: CustomResourceOptions): Environment
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        color: Optional[str] = None,
        delete_protected: Optional[bool] = None,
        description: Optional[str] = None,
        name: Optional[str] = None,
        slug: Optional[str] = None) -> Environment
    func GetEnvironment(ctx *Context, name string, id IDInput, state *EnvironmentState, opts ...ResourceOption) (*Environment, error)
    public static Environment Get(string name, Input<string> id, EnvironmentState? state, CustomResourceOptions? opts = null)
    public static Environment get(String name, Output<String> id, EnvironmentState state, CustomResourceOptions options)
    resources:  _:    type: honeycombio:Environment    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Color string
    The color to display the Environment in the navigation bar. If not provided one will be randomly selected at creation. One of blue, green, gold, red, purple, lightBlue, lightGreen, lightGold, lightRed, lightPurple.
    DeleteProtected bool
    the current state of the Environment's deletion protection status. Defaults to true. Cannot be set to false on create.
    Description string
    A description for the Environment.
    Name string
    The name of the Environment. Must be unique to the Team.
    Slug string
    The slug of the Environment.
    Color string
    The color to display the Environment in the navigation bar. If not provided one will be randomly selected at creation. One of blue, green, gold, red, purple, lightBlue, lightGreen, lightGold, lightRed, lightPurple.
    DeleteProtected bool
    the current state of the Environment's deletion protection status. Defaults to true. Cannot be set to false on create.
    Description string
    A description for the Environment.
    Name string
    The name of the Environment. Must be unique to the Team.
    Slug string
    The slug of the Environment.
    color String
    The color to display the Environment in the navigation bar. If not provided one will be randomly selected at creation. One of blue, green, gold, red, purple, lightBlue, lightGreen, lightGold, lightRed, lightPurple.
    deleteProtected Boolean
    the current state of the Environment's deletion protection status. Defaults to true. Cannot be set to false on create.
    description String
    A description for the Environment.
    name String
    The name of the Environment. Must be unique to the Team.
    slug String
    The slug of the Environment.
    color string
    The color to display the Environment in the navigation bar. If not provided one will be randomly selected at creation. One of blue, green, gold, red, purple, lightBlue, lightGreen, lightGold, lightRed, lightPurple.
    deleteProtected boolean
    the current state of the Environment's deletion protection status. Defaults to true. Cannot be set to false on create.
    description string
    A description for the Environment.
    name string
    The name of the Environment. Must be unique to the Team.
    slug string
    The slug of the Environment.
    color str
    The color to display the Environment in the navigation bar. If not provided one will be randomly selected at creation. One of blue, green, gold, red, purple, lightBlue, lightGreen, lightGold, lightRed, lightPurple.
    delete_protected bool
    the current state of the Environment's deletion protection status. Defaults to true. Cannot be set to false on create.
    description str
    A description for the Environment.
    name str
    The name of the Environment. Must be unique to the Team.
    slug str
    The slug of the Environment.
    color String
    The color to display the Environment in the navigation bar. If not provided one will be randomly selected at creation. One of blue, green, gold, red, purple, lightBlue, lightGreen, lightGold, lightRed, lightPurple.
    deleteProtected Boolean
    the current state of the Environment's deletion protection status. Defaults to true. Cannot be set to false on create.
    description String
    A description for the Environment.
    name String
    The name of the Environment. Must be unique to the Team.
    slug String
    The slug of the Environment.

    Import

    Environments can be imported by their ID. e.g.

    $ pulumi import honeycombio:index/environment:Environment myenv hcaen_01j1jrsewaha3m0z6fwffpcrxg

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    honeycombio honeycombio/terraform-provider-honeycombio
    License
    Notes
    This Pulumi package is based on the honeycombio Terraform Provider.
    honeycombio logo
    honeycombio 0.31.0 published on Friday, Mar 7, 2025 by honeycombio
    honeycombio/terraform-provider-honeycombio