Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Launch Darkly
  3. API Docs
  4. Environment
Launch Darkly v0.0.6 published on Sunday, Feb 19, 2023 by lbrlabs
lbrlabs/pulumi-launchdarkly

launchdarkly.Environment

Explore with Pulumi AI

Launch Darkly v0.0.6 published on Sunday, Feb 19, 2023 by lbrlabs
lbrlabs/pulumi-launchdarkly

Import

You can import a LaunchDarkly environment using this formatproject_key/environment_key. For example

 $ pulumi import launchdarkly:index/environment:Environment staging example-project/staging
Copy

Example Usage

using System.Collections.Generic;
using Pulumi;
using Launchdarkly = Lbrlabs.PulumiPackage.Launchdarkly;

return await Deployment.RunAsync(() => 
{
    var staging = new Launchdarkly.Environment("staging", new()
    {
        Key = "staging",
        Color = "ff00ff",
        Tags = new[]
        {
            "terraform",
            "staging",
        },
        ProjectKey = launchdarkly_project.Example.Key,
    });

});
Copy
package main

import (
	"github.com/lbrlabs/pulumi-launchdarkly/sdk/go/launchdarkly"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := launchdarkly.NewEnvironment(ctx, "staging", &launchdarkly.EnvironmentArgs{
			Key:   pulumi.String("staging"),
			Color: pulumi.String("ff00ff"),
			Tags: pulumi.StringArray{
				pulumi.String("terraform"),
				pulumi.String("staging"),
			},
			ProjectKey: pulumi.Any(launchdarkly_project.Example.Key),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.launchdarkly.Environment;
import com.pulumi.launchdarkly.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 staging = new Environment("staging", EnvironmentArgs.builder()        
            .key("staging")
            .color("ff00ff")
            .tags(            
                "terraform",
                "staging")
            .projectKey(launchdarkly_project.example().key())
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as launchdarkly from "@lbrlabs/pulumi-launchdarkly";

const staging = new launchdarkly.Environment("staging", {
    key: "staging",
    color: "ff00ff",
    tags: [
        "terraform",
        "staging",
    ],
    projectKey: launchdarkly_project.example.key,
});
Copy
import pulumi
import lbrlabs_pulumi_launchdarkly as launchdarkly

staging = launchdarkly.Environment("staging",
    key="staging",
    color="ff00ff",
    tags=[
        "terraform",
        "staging",
    ],
    project_key=launchdarkly_project["example"]["key"])
Copy
resources:
  staging:
    type: launchdarkly:Environment
    properties:
      key: staging
      color: ff00ff
      tags:
        - terraform
        - staging
      projectKey: ${launchdarkly_project.example.key}
Copy
using System.Collections.Generic;
using Pulumi;
using Launchdarkly = Lbrlabs.PulumiPackage.Launchdarkly;

return await Deployment.RunAsync(() => 
{
    var approvalsExample = new Launchdarkly.Environment("approvalsExample", new()
    {
        Key = "approvals-example",
        Color = "ff00ff",
        Tags = new[]
        {
            "terraform",
            "staging",
        },
        ApprovalSettings = new[]
        {
            new Launchdarkly.Inputs.EnvironmentApprovalSettingArgs
            {
                Required = true,
                CanReviewOwnRequest = true,
                MinNumApprovals = 2,
                CanApplyDeclinedChanges = true,
            },
        },
        ProjectKey = launchdarkly_project.Example.Key,
    });

});
Copy
package main

import (
	"github.com/lbrlabs/pulumi-launchdarkly/sdk/go/launchdarkly"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := launchdarkly.NewEnvironment(ctx, "approvalsExample", &launchdarkly.EnvironmentArgs{
			Key:   pulumi.String("approvals-example"),
			Color: pulumi.String("ff00ff"),
			Tags: pulumi.StringArray{
				pulumi.String("terraform"),
				pulumi.String("staging"),
			},
			ApprovalSettings: launchdarkly.EnvironmentApprovalSettingArray{
				&launchdarkly.EnvironmentApprovalSettingArgs{
					Required:                pulumi.Bool(true),
					CanReviewOwnRequest:     pulumi.Bool(true),
					MinNumApprovals:         pulumi.Int(2),
					CanApplyDeclinedChanges: pulumi.Bool(true),
				},
			},
			ProjectKey: pulumi.Any(launchdarkly_project.Example.Key),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.launchdarkly.Environment;
import com.pulumi.launchdarkly.EnvironmentArgs;
import com.pulumi.launchdarkly.inputs.EnvironmentApprovalSettingArgs;
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 approvalsExample = new Environment("approvalsExample", EnvironmentArgs.builder()        
            .key("approvals-example")
            .color("ff00ff")
            .tags(            
                "terraform",
                "staging")
            .approvalSettings(EnvironmentApprovalSettingArgs.builder()
                .required(true)
                .canReviewOwnRequest(true)
                .minNumApprovals(2)
                .canApplyDeclinedChanges(true)
                .build())
            .projectKey(launchdarkly_project.example().key())
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as launchdarkly from "@lbrlabs/pulumi-launchdarkly";

const approvalsExample = new launchdarkly.Environment("approvalsExample", {
    key: "approvals-example",
    color: "ff00ff",
    tags: [
        "terraform",
        "staging",
    ],
    approvalSettings: [{
        required: true,
        canReviewOwnRequest: true,
        minNumApprovals: 2,
        canApplyDeclinedChanges: true,
    }],
    projectKey: launchdarkly_project.example.key,
});
Copy
import pulumi
import lbrlabs_pulumi_launchdarkly as launchdarkly

approvals_example = launchdarkly.Environment("approvalsExample",
    key="approvals-example",
    color="ff00ff",
    tags=[
        "terraform",
        "staging",
    ],
    approval_settings=[launchdarkly.EnvironmentApprovalSettingArgs(
        required=True,
        can_review_own_request=True,
        min_num_approvals=2,
        can_apply_declined_changes=True,
    )],
    project_key=launchdarkly_project["example"]["key"])
Copy
resources:
  approvalsExample:
    type: launchdarkly:Environment
    properties:
      key: approvals-example
      color: ff00ff
      tags:
        - terraform
        - staging
      approvalSettings:
        - required: true
          canReviewOwnRequest: true
          minNumApprovals: 2
          canApplyDeclinedChanges: true
      projectKey: ${launchdarkly_project.example.key}
Copy

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: EnvironmentArgs,
                opts: Optional[ResourceOptions] = None)

@overload
def Environment(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                color: Optional[str] = None,
                key: Optional[str] = None,
                project_key: Optional[str] = None,
                approval_settings: Optional[Sequence[EnvironmentApprovalSettingArgs]] = None,
                confirm_changes: Optional[bool] = None,
                default_track_events: Optional[bool] = None,
                default_ttl: Optional[int] = None,
                name: Optional[str] = None,
                require_comments: Optional[bool] = None,
                secure_mode: Optional[bool] = None,
                tags: Optional[Sequence[str]] = None)
func NewEnvironment(ctx *Context, name string, args EnvironmentArgs, opts ...ResourceOption) (*Environment, error)
public Environment(string name, EnvironmentArgs args, CustomResourceOptions? opts = null)
public Environment(String name, EnvironmentArgs args)
public Environment(String name, EnvironmentArgs args, CustomResourceOptions options)

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

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. EnvironmentArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. 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 This property is required. string
The unique name of the resource.
args This property is required. EnvironmentArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. EnvironmentArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. 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 Launchdarkly.Environment("environmentResource", new()
{
    Color = "string",
    Key = "string",
    ProjectKey = "string",
    ApprovalSettings = new[]
    {
        new Launchdarkly.Inputs.EnvironmentApprovalSettingArgs
        {
            CanApplyDeclinedChanges = false,
            CanReviewOwnRequest = false,
            MinNumApprovals = 0,
            Required = false,
            RequiredApprovalTags = new[]
            {
                "string",
            },
        },
    },
    ConfirmChanges = false,
    DefaultTrackEvents = false,
    DefaultTtl = 0,
    Name = "string",
    RequireComments = false,
    SecureMode = false,
    Tags = new[]
    {
        "string",
    },
});
Copy
example, err := launchdarkly.NewEnvironment(ctx, "environmentResource", &launchdarkly.EnvironmentArgs{
	Color:      pulumi.String("string"),
	Key:        pulumi.String("string"),
	ProjectKey: pulumi.String("string"),
	ApprovalSettings: launchdarkly.EnvironmentApprovalSettingArray{
		&launchdarkly.EnvironmentApprovalSettingArgs{
			CanApplyDeclinedChanges: pulumi.Bool(false),
			CanReviewOwnRequest:     pulumi.Bool(false),
			MinNumApprovals:         pulumi.Int(0),
			Required:                pulumi.Bool(false),
			RequiredApprovalTags: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
	},
	ConfirmChanges:     pulumi.Bool(false),
	DefaultTrackEvents: pulumi.Bool(false),
	DefaultTtl:         pulumi.Int(0),
	Name:               pulumi.String("string"),
	RequireComments:    pulumi.Bool(false),
	SecureMode:         pulumi.Bool(false),
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
})
Copy
var environmentResource = new Environment("environmentResource", EnvironmentArgs.builder()
    .color("string")
    .key("string")
    .projectKey("string")
    .approvalSettings(EnvironmentApprovalSettingArgs.builder()
        .canApplyDeclinedChanges(false)
        .canReviewOwnRequest(false)
        .minNumApprovals(0)
        .required(false)
        .requiredApprovalTags("string")
        .build())
    .confirmChanges(false)
    .defaultTrackEvents(false)
    .defaultTtl(0)
    .name("string")
    .requireComments(false)
    .secureMode(false)
    .tags("string")
    .build());
Copy
environment_resource = launchdarkly.Environment("environmentResource",
    color="string",
    key="string",
    project_key="string",
    approval_settings=[{
        "can_apply_declined_changes": False,
        "can_review_own_request": False,
        "min_num_approvals": 0,
        "required": False,
        "required_approval_tags": ["string"],
    }],
    confirm_changes=False,
    default_track_events=False,
    default_ttl=0,
    name="string",
    require_comments=False,
    secure_mode=False,
    tags=["string"])
Copy
const environmentResource = new launchdarkly.Environment("environmentResource", {
    color: "string",
    key: "string",
    projectKey: "string",
    approvalSettings: [{
        canApplyDeclinedChanges: false,
        canReviewOwnRequest: false,
        minNumApprovals: 0,
        required: false,
        requiredApprovalTags: ["string"],
    }],
    confirmChanges: false,
    defaultTrackEvents: false,
    defaultTtl: 0,
    name: "string",
    requireComments: false,
    secureMode: false,
    tags: ["string"],
});
Copy
type: launchdarkly:Environment
properties:
    approvalSettings:
        - canApplyDeclinedChanges: false
          canReviewOwnRequest: false
          minNumApprovals: 0
          required: false
          requiredApprovalTags:
            - string
    color: string
    confirmChanges: false
    defaultTrackEvents: false
    defaultTtl: 0
    key: string
    name: string
    projectKey: string
    requireComments: false
    secureMode: false
    tags:
        - string
Copy

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 This property is required. string
The color swatch as an RGB hex value with no leading #. For example: 000000.
Key
This property is required.
Changes to this property will trigger replacement.
string
The project-unique key for the environment. A change in this field will force the destruction of the existing resource and the creation of a new one.
ProjectKey
This property is required.
Changes to this property will trigger replacement.
string
  • The environment's project key. A change in this field will force the destruction of the existing resource and the creation of a new one.
ApprovalSettings List<Lbrlabs.PulumiPackage.Launchdarkly.Inputs.EnvironmentApprovalSetting>
ConfirmChanges bool
Set to true if this environment requires confirmation for flag and segment changes. This field will default to false when not set.
DefaultTrackEvents bool
Set to true to enable data export for every flag created in this environment after you configure this argument. This field will default to false when not set. To learn more, read Data Export.
DefaultTtl int
The TTL for the environment. This must be between 0 and 60 minutes. The TTL setting only applies to environments using the PHP SDK. This field will default to 0 when not set. To learn more, read TTL settings.
Name string
The name of the environment.
RequireComments bool
Set to true if this environment requires comments for flag and segment changes. This field will default to false when not set.
SecureMode bool
Set to true to ensure a user of the client-side SDK cannot impersonate another user. This field will default to false when not set.
Tags List<string>
Set of tags associated with the environment.
Color This property is required. string
The color swatch as an RGB hex value with no leading #. For example: 000000.
Key
This property is required.
Changes to this property will trigger replacement.
string
The project-unique key for the environment. A change in this field will force the destruction of the existing resource and the creation of a new one.
ProjectKey
This property is required.
Changes to this property will trigger replacement.
string
  • The environment's project key. A change in this field will force the destruction of the existing resource and the creation of a new one.
ApprovalSettings []EnvironmentApprovalSettingArgs
ConfirmChanges bool
Set to true if this environment requires confirmation for flag and segment changes. This field will default to false when not set.
DefaultTrackEvents bool
Set to true to enable data export for every flag created in this environment after you configure this argument. This field will default to false when not set. To learn more, read Data Export.
DefaultTtl int
The TTL for the environment. This must be between 0 and 60 minutes. The TTL setting only applies to environments using the PHP SDK. This field will default to 0 when not set. To learn more, read TTL settings.
Name string
The name of the environment.
RequireComments bool
Set to true if this environment requires comments for flag and segment changes. This field will default to false when not set.
SecureMode bool
Set to true to ensure a user of the client-side SDK cannot impersonate another user. This field will default to false when not set.
Tags []string
Set of tags associated with the environment.
color This property is required. String
The color swatch as an RGB hex value with no leading #. For example: 000000.
key
This property is required.
Changes to this property will trigger replacement.
String
The project-unique key for the environment. A change in this field will force the destruction of the existing resource and the creation of a new one.
projectKey
This property is required.
Changes to this property will trigger replacement.
String
  • The environment's project key. A change in this field will force the destruction of the existing resource and the creation of a new one.
approvalSettings List<EnvironmentApprovalSetting>
confirmChanges Boolean
Set to true if this environment requires confirmation for flag and segment changes. This field will default to false when not set.
defaultTrackEvents Boolean
Set to true to enable data export for every flag created in this environment after you configure this argument. This field will default to false when not set. To learn more, read Data Export.
defaultTtl Integer
The TTL for the environment. This must be between 0 and 60 minutes. The TTL setting only applies to environments using the PHP SDK. This field will default to 0 when not set. To learn more, read TTL settings.
name String
The name of the environment.
requireComments Boolean
Set to true if this environment requires comments for flag and segment changes. This field will default to false when not set.
secureMode Boolean
Set to true to ensure a user of the client-side SDK cannot impersonate another user. This field will default to false when not set.
tags List<String>
Set of tags associated with the environment.
color This property is required. string
The color swatch as an RGB hex value with no leading #. For example: 000000.
key
This property is required.
Changes to this property will trigger replacement.
string
The project-unique key for the environment. A change in this field will force the destruction of the existing resource and the creation of a new one.
projectKey
This property is required.
Changes to this property will trigger replacement.
string
  • The environment's project key. A change in this field will force the destruction of the existing resource and the creation of a new one.
approvalSettings EnvironmentApprovalSetting[]
confirmChanges boolean
Set to true if this environment requires confirmation for flag and segment changes. This field will default to false when not set.
defaultTrackEvents boolean
Set to true to enable data export for every flag created in this environment after you configure this argument. This field will default to false when not set. To learn more, read Data Export.
defaultTtl number
The TTL for the environment. This must be between 0 and 60 minutes. The TTL setting only applies to environments using the PHP SDK. This field will default to 0 when not set. To learn more, read TTL settings.
name string
The name of the environment.
requireComments boolean
Set to true if this environment requires comments for flag and segment changes. This field will default to false when not set.
secureMode boolean
Set to true to ensure a user of the client-side SDK cannot impersonate another user. This field will default to false when not set.
tags string[]
Set of tags associated with the environment.
color This property is required. str
The color swatch as an RGB hex value with no leading #. For example: 000000.
key
This property is required.
Changes to this property will trigger replacement.
str
The project-unique key for the environment. A change in this field will force the destruction of the existing resource and the creation of a new one.
project_key
This property is required.
Changes to this property will trigger replacement.
str
  • The environment's project key. A change in this field will force the destruction of the existing resource and the creation of a new one.
approval_settings Sequence[EnvironmentApprovalSettingArgs]
confirm_changes bool
Set to true if this environment requires confirmation for flag and segment changes. This field will default to false when not set.
default_track_events bool
Set to true to enable data export for every flag created in this environment after you configure this argument. This field will default to false when not set. To learn more, read Data Export.
default_ttl int
The TTL for the environment. This must be between 0 and 60 minutes. The TTL setting only applies to environments using the PHP SDK. This field will default to 0 when not set. To learn more, read TTL settings.
name str
The name of the environment.
require_comments bool
Set to true if this environment requires comments for flag and segment changes. This field will default to false when not set.
secure_mode bool
Set to true to ensure a user of the client-side SDK cannot impersonate another user. This field will default to false when not set.
tags Sequence[str]
Set of tags associated with the environment.
color This property is required. String
The color swatch as an RGB hex value with no leading #. For example: 000000.
key
This property is required.
Changes to this property will trigger replacement.
String
The project-unique key for the environment. A change in this field will force the destruction of the existing resource and the creation of a new one.
projectKey
This property is required.
Changes to this property will trigger replacement.
String
  • The environment's project key. A change in this field will force the destruction of the existing resource and the creation of a new one.
approvalSettings List<Property Map>
confirmChanges Boolean
Set to true if this environment requires confirmation for flag and segment changes. This field will default to false when not set.
defaultTrackEvents Boolean
Set to true to enable data export for every flag created in this environment after you configure this argument. This field will default to false when not set. To learn more, read Data Export.
defaultTtl Number
The TTL for the environment. This must be between 0 and 60 minutes. The TTL setting only applies to environments using the PHP SDK. This field will default to 0 when not set. To learn more, read TTL settings.
name String
The name of the environment.
requireComments Boolean
Set to true if this environment requires comments for flag and segment changes. This field will default to false when not set.
secureMode Boolean
Set to true to ensure a user of the client-side SDK cannot impersonate another user. This field will default to false when not set.
tags List<String>
Set of tags associated with the environment.

Outputs

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

ApiKey string
The environment's SDK key.
ClientSideId string
The environment's client-side ID.
Id string
The provider-assigned unique ID for this managed resource.
MobileKey string
The environment's mobile key.
ApiKey string
The environment's SDK key.
ClientSideId string
The environment's client-side ID.
Id string
The provider-assigned unique ID for this managed resource.
MobileKey string
The environment's mobile key.
apiKey String
The environment's SDK key.
clientSideId String
The environment's client-side ID.
id String
The provider-assigned unique ID for this managed resource.
mobileKey String
The environment's mobile key.
apiKey string
The environment's SDK key.
clientSideId string
The environment's client-side ID.
id string
The provider-assigned unique ID for this managed resource.
mobileKey string
The environment's mobile key.
api_key str
The environment's SDK key.
client_side_id str
The environment's client-side ID.
id str
The provider-assigned unique ID for this managed resource.
mobile_key str
The environment's mobile key.
apiKey String
The environment's SDK key.
clientSideId String
The environment's client-side ID.
id String
The provider-assigned unique ID for this managed resource.
mobileKey String
The environment's mobile key.

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,
        api_key: Optional[str] = None,
        approval_settings: Optional[Sequence[EnvironmentApprovalSettingArgs]] = None,
        client_side_id: Optional[str] = None,
        color: Optional[str] = None,
        confirm_changes: Optional[bool] = None,
        default_track_events: Optional[bool] = None,
        default_ttl: Optional[int] = None,
        key: Optional[str] = None,
        mobile_key: Optional[str] = None,
        name: Optional[str] = None,
        project_key: Optional[str] = None,
        require_comments: Optional[bool] = None,
        secure_mode: Optional[bool] = None,
        tags: Optional[Sequence[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: launchdarkly:Environment    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
ApiKey string
The environment's SDK key.
ApprovalSettings List<Lbrlabs.PulumiPackage.Launchdarkly.Inputs.EnvironmentApprovalSetting>
ClientSideId string
The environment's client-side ID.
Color string
The color swatch as an RGB hex value with no leading #. For example: 000000.
ConfirmChanges bool
Set to true if this environment requires confirmation for flag and segment changes. This field will default to false when not set.
DefaultTrackEvents bool
Set to true to enable data export for every flag created in this environment after you configure this argument. This field will default to false when not set. To learn more, read Data Export.
DefaultTtl int
The TTL for the environment. This must be between 0 and 60 minutes. The TTL setting only applies to environments using the PHP SDK. This field will default to 0 when not set. To learn more, read TTL settings.
Key Changes to this property will trigger replacement. string
The project-unique key for the environment. A change in this field will force the destruction of the existing resource and the creation of a new one.
MobileKey string
The environment's mobile key.
Name string
The name of the environment.
ProjectKey Changes to this property will trigger replacement. string
  • The environment's project key. A change in this field will force the destruction of the existing resource and the creation of a new one.
RequireComments bool
Set to true if this environment requires comments for flag and segment changes. This field will default to false when not set.
SecureMode bool
Set to true to ensure a user of the client-side SDK cannot impersonate another user. This field will default to false when not set.
Tags List<string>
Set of tags associated with the environment.
ApiKey string
The environment's SDK key.
ApprovalSettings []EnvironmentApprovalSettingArgs
ClientSideId string
The environment's client-side ID.
Color string
The color swatch as an RGB hex value with no leading #. For example: 000000.
ConfirmChanges bool
Set to true if this environment requires confirmation for flag and segment changes. This field will default to false when not set.
DefaultTrackEvents bool
Set to true to enable data export for every flag created in this environment after you configure this argument. This field will default to false when not set. To learn more, read Data Export.
DefaultTtl int
The TTL for the environment. This must be between 0 and 60 minutes. The TTL setting only applies to environments using the PHP SDK. This field will default to 0 when not set. To learn more, read TTL settings.
Key Changes to this property will trigger replacement. string
The project-unique key for the environment. A change in this field will force the destruction of the existing resource and the creation of a new one.
MobileKey string
The environment's mobile key.
Name string
The name of the environment.
ProjectKey Changes to this property will trigger replacement. string
  • The environment's project key. A change in this field will force the destruction of the existing resource and the creation of a new one.
RequireComments bool
Set to true if this environment requires comments for flag and segment changes. This field will default to false when not set.
SecureMode bool
Set to true to ensure a user of the client-side SDK cannot impersonate another user. This field will default to false when not set.
Tags []string
Set of tags associated with the environment.
apiKey String
The environment's SDK key.
approvalSettings List<EnvironmentApprovalSetting>
clientSideId String
The environment's client-side ID.
color String
The color swatch as an RGB hex value with no leading #. For example: 000000.
confirmChanges Boolean
Set to true if this environment requires confirmation for flag and segment changes. This field will default to false when not set.
defaultTrackEvents Boolean
Set to true to enable data export for every flag created in this environment after you configure this argument. This field will default to false when not set. To learn more, read Data Export.
defaultTtl Integer
The TTL for the environment. This must be between 0 and 60 minutes. The TTL setting only applies to environments using the PHP SDK. This field will default to 0 when not set. To learn more, read TTL settings.
key Changes to this property will trigger replacement. String
The project-unique key for the environment. A change in this field will force the destruction of the existing resource and the creation of a new one.
mobileKey String
The environment's mobile key.
name String
The name of the environment.
projectKey Changes to this property will trigger replacement. String
  • The environment's project key. A change in this field will force the destruction of the existing resource and the creation of a new one.
requireComments Boolean
Set to true if this environment requires comments for flag and segment changes. This field will default to false when not set.
secureMode Boolean
Set to true to ensure a user of the client-side SDK cannot impersonate another user. This field will default to false when not set.
tags List<String>
Set of tags associated with the environment.
apiKey string
The environment's SDK key.
approvalSettings EnvironmentApprovalSetting[]
clientSideId string
The environment's client-side ID.
color string
The color swatch as an RGB hex value with no leading #. For example: 000000.
confirmChanges boolean
Set to true if this environment requires confirmation for flag and segment changes. This field will default to false when not set.
defaultTrackEvents boolean
Set to true to enable data export for every flag created in this environment after you configure this argument. This field will default to false when not set. To learn more, read Data Export.
defaultTtl number
The TTL for the environment. This must be between 0 and 60 minutes. The TTL setting only applies to environments using the PHP SDK. This field will default to 0 when not set. To learn more, read TTL settings.
key Changes to this property will trigger replacement. string
The project-unique key for the environment. A change in this field will force the destruction of the existing resource and the creation of a new one.
mobileKey string
The environment's mobile key.
name string
The name of the environment.
projectKey Changes to this property will trigger replacement. string
  • The environment's project key. A change in this field will force the destruction of the existing resource and the creation of a new one.
requireComments boolean
Set to true if this environment requires comments for flag and segment changes. This field will default to false when not set.
secureMode boolean
Set to true to ensure a user of the client-side SDK cannot impersonate another user. This field will default to false when not set.
tags string[]
Set of tags associated with the environment.
api_key str
The environment's SDK key.
approval_settings Sequence[EnvironmentApprovalSettingArgs]
client_side_id str
The environment's client-side ID.
color str
The color swatch as an RGB hex value with no leading #. For example: 000000.
confirm_changes bool
Set to true if this environment requires confirmation for flag and segment changes. This field will default to false when not set.
default_track_events bool
Set to true to enable data export for every flag created in this environment after you configure this argument. This field will default to false when not set. To learn more, read Data Export.
default_ttl int
The TTL for the environment. This must be between 0 and 60 minutes. The TTL setting only applies to environments using the PHP SDK. This field will default to 0 when not set. To learn more, read TTL settings.
key Changes to this property will trigger replacement. str
The project-unique key for the environment. A change in this field will force the destruction of the existing resource and the creation of a new one.
mobile_key str
The environment's mobile key.
name str
The name of the environment.
project_key Changes to this property will trigger replacement. str
  • The environment's project key. A change in this field will force the destruction of the existing resource and the creation of a new one.
require_comments bool
Set to true if this environment requires comments for flag and segment changes. This field will default to false when not set.
secure_mode bool
Set to true to ensure a user of the client-side SDK cannot impersonate another user. This field will default to false when not set.
tags Sequence[str]
Set of tags associated with the environment.
apiKey String
The environment's SDK key.
approvalSettings List<Property Map>
clientSideId String
The environment's client-side ID.
color String
The color swatch as an RGB hex value with no leading #. For example: 000000.
confirmChanges Boolean
Set to true if this environment requires confirmation for flag and segment changes. This field will default to false when not set.
defaultTrackEvents Boolean
Set to true to enable data export for every flag created in this environment after you configure this argument. This field will default to false when not set. To learn more, read Data Export.
defaultTtl Number
The TTL for the environment. This must be between 0 and 60 minutes. The TTL setting only applies to environments using the PHP SDK. This field will default to 0 when not set. To learn more, read TTL settings.
key Changes to this property will trigger replacement. String
The project-unique key for the environment. A change in this field will force the destruction of the existing resource and the creation of a new one.
mobileKey String
The environment's mobile key.
name String
The name of the environment.
projectKey Changes to this property will trigger replacement. String
  • The environment's project key. A change in this field will force the destruction of the existing resource and the creation of a new one.
requireComments Boolean
Set to true if this environment requires comments for flag and segment changes. This field will default to false when not set.
secureMode Boolean
Set to true to ensure a user of the client-side SDK cannot impersonate another user. This field will default to false when not set.
tags List<String>
Set of tags associated with the environment.

Supporting Types

EnvironmentApprovalSetting
, EnvironmentApprovalSettingArgs

CanApplyDeclinedChanges bool
Set to true if changes can be applied as long as the min_num_approvals is met, regardless of whether any reviewers have declined a request. Defaults to true.
CanReviewOwnRequest bool
Set to true if requesters can approve or decline their own request. They may always comment. Defaults to false.
MinNumApprovals int
The number of approvals required before an approval request can be applied. This number must be between 1 and 5. Defaults to 1.
Required bool
Set to true for changes to flags in this environment to require approval. You may only set required to true if required_approval_tags is not set and vice versa. Defaults to false.
RequiredApprovalTags List<string>
An array of tags used to specify which flags with those tags require approval. You may only set required_approval_tags if required is not set to true and vice versa.
CanApplyDeclinedChanges bool
Set to true if changes can be applied as long as the min_num_approvals is met, regardless of whether any reviewers have declined a request. Defaults to true.
CanReviewOwnRequest bool
Set to true if requesters can approve or decline their own request. They may always comment. Defaults to false.
MinNumApprovals int
The number of approvals required before an approval request can be applied. This number must be between 1 and 5. Defaults to 1.
Required bool
Set to true for changes to flags in this environment to require approval. You may only set required to true if required_approval_tags is not set and vice versa. Defaults to false.
RequiredApprovalTags []string
An array of tags used to specify which flags with those tags require approval. You may only set required_approval_tags if required is not set to true and vice versa.
canApplyDeclinedChanges Boolean
Set to true if changes can be applied as long as the min_num_approvals is met, regardless of whether any reviewers have declined a request. Defaults to true.
canReviewOwnRequest Boolean
Set to true if requesters can approve or decline their own request. They may always comment. Defaults to false.
minNumApprovals Integer
The number of approvals required before an approval request can be applied. This number must be between 1 and 5. Defaults to 1.
required Boolean
Set to true for changes to flags in this environment to require approval. You may only set required to true if required_approval_tags is not set and vice versa. Defaults to false.
requiredApprovalTags List<String>
An array of tags used to specify which flags with those tags require approval. You may only set required_approval_tags if required is not set to true and vice versa.
canApplyDeclinedChanges boolean
Set to true if changes can be applied as long as the min_num_approvals is met, regardless of whether any reviewers have declined a request. Defaults to true.
canReviewOwnRequest boolean
Set to true if requesters can approve or decline their own request. They may always comment. Defaults to false.
minNumApprovals number
The number of approvals required before an approval request can be applied. This number must be between 1 and 5. Defaults to 1.
required boolean
Set to true for changes to flags in this environment to require approval. You may only set required to true if required_approval_tags is not set and vice versa. Defaults to false.
requiredApprovalTags string[]
An array of tags used to specify which flags with those tags require approval. You may only set required_approval_tags if required is not set to true and vice versa.
can_apply_declined_changes bool
Set to true if changes can be applied as long as the min_num_approvals is met, regardless of whether any reviewers have declined a request. Defaults to true.
can_review_own_request bool
Set to true if requesters can approve or decline their own request. They may always comment. Defaults to false.
min_num_approvals int
The number of approvals required before an approval request can be applied. This number must be between 1 and 5. Defaults to 1.
required bool
Set to true for changes to flags in this environment to require approval. You may only set required to true if required_approval_tags is not set and vice versa. Defaults to false.
required_approval_tags Sequence[str]
An array of tags used to specify which flags with those tags require approval. You may only set required_approval_tags if required is not set to true and vice versa.
canApplyDeclinedChanges Boolean
Set to true if changes can be applied as long as the min_num_approvals is met, regardless of whether any reviewers have declined a request. Defaults to true.
canReviewOwnRequest Boolean
Set to true if requesters can approve or decline their own request. They may always comment. Defaults to false.
minNumApprovals Number
The number of approvals required before an approval request can be applied. This number must be between 1 and 5. Defaults to 1.
required Boolean
Set to true for changes to flags in this environment to require approval. You may only set required to true if required_approval_tags is not set and vice versa. Defaults to false.
requiredApprovalTags List<String>
An array of tags used to specify which flags with those tags require approval. You may only set required_approval_tags if required is not set to true and vice versa.

Package Details

Repository
launchdarkly lbrlabs/pulumi-launchdarkly
License
Notes
This Pulumi package is based on the launchdarkly Terraform Provider.
Launch Darkly v0.0.6 published on Sunday, Feb 19, 2023 by lbrlabs
lbrlabs/pulumi-launchdarkly