Skip to content

Latest commit

 

History

History
2133 lines (1316 loc) · 92.5 KB

environment.typescript.md

File metadata and controls

2133 lines (1316 loc) · 92.5 KB

environment Submodule

Constructs

Environment

Represents a {@link https://registry.terraform.io/providers/launchdarkly/launchdarkly/2.21.2/docs/resources/environment launchdarkly_environment}.

Initializers

import { environment } from '@cdktf/provider-launchdarkly'

new environment.Environment(scope: Construct, id: string, config: EnvironmentConfig)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id string The scoped construct ID.
config EnvironmentConfig No description.

scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.


idRequired
  • Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope


configRequired

Methods

Name Description
toString Returns a string representation of this construct.
addOverride No description.
overrideLogicalId Overrides the auto-generated logical ID with a specific ID.
resetOverrideLogicalId Resets a previously passed logical Id to use the auto-generated logical id again.
toHclTerraform No description.
toMetadata No description.
toTerraform Adds this resource to the terraform JSON output.
addMoveTarget Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
getAnyMapAttribute No description.
getBooleanAttribute No description.
getBooleanMapAttribute No description.
getListAttribute No description.
getNumberAttribute No description.
getNumberListAttribute No description.
getNumberMapAttribute No description.
getStringAttribute No description.
getStringMapAttribute No description.
hasResourceMove No description.
importFrom No description.
interpolationForAttribute No description.
moveFromId Move the resource corresponding to "id" to this resource.
moveTo Moves this resource to the target resource given by moveTarget.
moveToId Moves this resource to the resource corresponding to "id".
putApprovalSettings No description.
resetApprovalSettings No description.
resetConfirmChanges No description.
resetCritical No description.
resetDefaultTrackEvents No description.
resetDefaultTtl No description.
resetId No description.
resetRequireComments No description.
resetSecureMode No description.
resetTags No description.

toString
public toString(): string

Returns a string representation of this construct.

addOverride
public addOverride(path: string, value: any): void
pathRequired
  • Type: string

valueRequired
  • Type: any

overrideLogicalId
public overrideLogicalId(newLogicalId: string): void

Overrides the auto-generated logical ID with a specific ID.

newLogicalIdRequired
  • Type: string

The new logical ID to use for this stack element.


resetOverrideLogicalId
public resetOverrideLogicalId(): void

Resets a previously passed logical Id to use the auto-generated logical id again.

toHclTerraform
public toHclTerraform(): any
toMetadata
public toMetadata(): any
toTerraform
public toTerraform(): any

Adds this resource to the terraform JSON output.

addMoveTarget
public addMoveTarget(moveTarget: string): void

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

moveTargetRequired
  • Type: string

The string move target that will correspond to this resource.


getAnyMapAttribute
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string

getBooleanAttribute
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string

getBooleanMapAttribute
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
terraformAttributeRequired
  • Type: string

getListAttribute
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string

getNumberAttribute
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string

getNumberListAttribute
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string

getNumberMapAttribute
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
terraformAttributeRequired
  • Type: string

getStringAttribute
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string

getStringMapAttribute
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
terraformAttributeRequired
  • Type: string

hasResourceMove
public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById
importFrom
public importFrom(id: string, provider?: TerraformProvider): void
idRequired
  • Type: string

providerOptional
  • Type: cdktf.TerraformProvider

interpolationForAttribute
public interpolationForAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string

moveFromId
public moveFromId(id: string): void

Move the resource corresponding to "id" to this resource.

Note that the resource being moved from must be marked as moved using it's instance function.

idRequired
  • Type: string

Full id of resource being moved from, e.g. "aws_s3_bucket.example".


moveTo
public moveTo(moveTarget: string, index?: string | number): void

Moves this resource to the target resource given by moveTarget.

moveTargetRequired
  • Type: string

The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.


indexOptional
  • Type: string | number

Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.


moveToId
public moveToId(id: string): void

Moves this resource to the resource corresponding to "id".

idRequired
  • Type: string

Full id of resource to move to, e.g. "aws_s3_bucket.example".


putApprovalSettings
public putApprovalSettings(value: IResolvable | EnvironmentApprovalSettings[]): void
valueRequired

resetApprovalSettings
public resetApprovalSettings(): void
resetConfirmChanges
public resetConfirmChanges(): void
resetCritical
public resetCritical(): void
resetDefaultTrackEvents
public resetDefaultTrackEvents(): void
resetDefaultTtl
public resetDefaultTtl(): void
resetId
public resetId(): void
resetRequireComments
public resetRequireComments(): void
resetSecureMode
public resetSecureMode(): void
resetTags
public resetTags(): void

Static Functions

Name Description
isConstruct Checks if x is a construct.
isTerraformElement No description.
isTerraformResource No description.
generateConfigForImport Generates CDKTF code for importing a Environment resource upon running "cdktf plan ".

isConstruct
import { environment } from '@cdktf/provider-launchdarkly'

environment.Environment.isConstruct(x: any)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

xRequired
  • Type: any

Any object.


isTerraformElement
import { environment } from '@cdktf/provider-launchdarkly'

environment.Environment.isTerraformElement(x: any)
xRequired
  • Type: any

isTerraformResource
import { environment } from '@cdktf/provider-launchdarkly'

environment.Environment.isTerraformResource(x: any)
xRequired
  • Type: any

generateConfigForImport
import { environment } from '@cdktf/provider-launchdarkly'

environment.Environment.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

Generates CDKTF code for importing a Environment resource upon running "cdktf plan ".

scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.


importToIdRequired
  • Type: string

The construct id used in the generated config for the Environment to import.


importFromIdRequired
  • Type: string

The id of the existing Environment that should be imported.

Refer to the {@link https://registry.terraform.io/providers/launchdarkly/launchdarkly/2.21.2/docs/resources/environment#import import section} in the documentation of this resource for the id to use


providerOptional
  • Type: cdktf.TerraformProvider

? Optional instance of the provider where the Environment to import is found.


Properties

Name Type Description
node constructs.Node The tree node.
cdktfStack cdktf.TerraformStack No description.
fqn string No description.
friendlyUniqueId string No description.
terraformMetaArguments {[ key: string ]: any} No description.
terraformResourceType string No description.
terraformGeneratorMetadata cdktf.TerraformProviderGeneratorMetadata No description.
connection cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection No description.
count number | cdktf.TerraformCount No description.
dependsOn string[] No description.
forEach cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[] No description.
apiKey string No description.
approvalSettings EnvironmentApprovalSettingsList No description.
clientSideId string No description.
mobileKey string No description.
approvalSettingsInput cdktf.IResolvable | EnvironmentApprovalSettings[] No description.
colorInput string No description.
confirmChangesInput boolean | cdktf.IResolvable No description.
criticalInput boolean | cdktf.IResolvable No description.
defaultTrackEventsInput boolean | cdktf.IResolvable No description.
defaultTtlInput number No description.
idInput string No description.
keyInput string No description.
nameInput string No description.
projectKeyInput string No description.
requireCommentsInput boolean | cdktf.IResolvable No description.
secureModeInput boolean | cdktf.IResolvable No description.
tagsInput string[] No description.
color string No description.
confirmChanges boolean | cdktf.IResolvable No description.
critical boolean | cdktf.IResolvable No description.
defaultTrackEvents boolean | cdktf.IResolvable No description.
defaultTtl number No description.
id string No description.
key string No description.
name string No description.
projectKey string No description.
requireComments boolean | cdktf.IResolvable No description.
secureMode boolean | cdktf.IResolvable No description.
tags string[] No description.

nodeRequired
public readonly node: Node;
  • Type: constructs.Node

The tree node.


cdktfStackRequired
public readonly cdktfStack: TerraformStack;
  • Type: cdktf.TerraformStack

fqnRequired
public readonly fqn: string;
  • Type: string

friendlyUniqueIdRequired
public readonly friendlyUniqueId: string;
  • Type: string

terraformMetaArgumentsRequired
public readonly terraformMetaArguments: {[ key: string ]: any};
  • Type: {[ key: string ]: any}

terraformResourceTypeRequired
public readonly terraformResourceType: string;
  • Type: string

terraformGeneratorMetadataOptional
public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;
  • Type: cdktf.TerraformProviderGeneratorMetadata

connectionOptional
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
  • Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

countOptional
public readonly count: number | TerraformCount;
  • Type: number | cdktf.TerraformCount

dependsOnOptional
public readonly dependsOn: string[];
  • Type: string[]

forEachOptional
public readonly forEach: ITerraformIterator;
  • Type: cdktf.ITerraformIterator

lifecycleOptional
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktf.TerraformResourceLifecycle

providerOptional
public readonly provider: TerraformProvider;
  • Type: cdktf.TerraformProvider

provisionersOptional
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
  • Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

apiKeyRequired
public readonly apiKey: string;
  • Type: string

approvalSettingsRequired
public readonly approvalSettings: EnvironmentApprovalSettingsList;

clientSideIdRequired
public readonly clientSideId: string;
  • Type: string

mobileKeyRequired
public readonly mobileKey: string;
  • Type: string

approvalSettingsInputOptional
public readonly approvalSettingsInput: IResolvable | EnvironmentApprovalSettings[];

colorInputOptional
public readonly colorInput: string;
  • Type: string

confirmChangesInputOptional
public readonly confirmChangesInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

criticalInputOptional
public readonly criticalInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

defaultTrackEventsInputOptional
public readonly defaultTrackEventsInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

defaultTtlInputOptional
public readonly defaultTtlInput: number;
  • Type: number

idInputOptional
public readonly idInput: string;
  • Type: string

keyInputOptional
public readonly keyInput: string;
  • Type: string

nameInputOptional
public readonly nameInput: string;
  • Type: string

projectKeyInputOptional
public readonly projectKeyInput: string;
  • Type: string

requireCommentsInputOptional
public readonly requireCommentsInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

secureModeInputOptional
public readonly secureModeInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

tagsInputOptional
public readonly tagsInput: string[];
  • Type: string[]

colorRequired
public readonly color: string;
  • Type: string

confirmChangesRequired
public readonly confirmChanges: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

criticalRequired
public readonly critical: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

defaultTrackEventsRequired
public readonly defaultTrackEvents: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

defaultTtlRequired
public readonly defaultTtl: number;
  • Type: number

idRequired
public readonly id: string;
  • Type: string

keyRequired
public readonly key: string;
  • Type: string

nameRequired
public readonly name: string;
  • Type: string

projectKeyRequired
public readonly projectKey: string;
  • Type: string

requireCommentsRequired
public readonly requireComments: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

secureModeRequired
public readonly secureMode: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

tagsRequired
public readonly tags: string[];
  • Type: string[]

Constants

Name Type Description
tfResourceType string No description.

tfResourceTypeRequired
public readonly tfResourceType: string;
  • Type: string

Structs

EnvironmentApprovalSettings

Initializer

import { environment } from '@cdktf/provider-launchdarkly'

const environmentApprovalSettings: environment.EnvironmentApprovalSettings = { ... }

Properties

Name Type Description
canApplyDeclinedChanges boolean | cdktf.IResolvable 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.
canReviewOwnRequest boolean | cdktf.IResolvable 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.
required boolean | cdktf.IResolvable Set to true for changes to flags in this environment to require approval.
requiredApprovalTags string[] An array of tags used to specify which flags with those tags require approval.
serviceConfig {[ key: string ]: string} The configuration for the service associated with this approval.
serviceKind string The kind of service associated with this approval.

canApplyDeclinedChangesOptional
public readonly canApplyDeclinedChanges: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/launchdarkly/launchdarkly/2.21.2/docs/resources/environment#can_apply_declined_changes Environment#can_apply_declined_changes}


canReviewOwnRequestOptional
public readonly canReviewOwnRequest: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Set to true if requesters can approve or decline their own request. They may always comment. Defaults to false.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/launchdarkly/launchdarkly/2.21.2/docs/resources/environment#can_review_own_request Environment#can_review_own_request}


minNumApprovalsOptional
public readonly minNumApprovals: number;
  • Type: number

The number of approvals required before an approval request can be applied.

This number must be between 1 and 5. Defaults to 1.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/launchdarkly/launchdarkly/2.21.2/docs/resources/environment#min_num_approvals Environment#min_num_approvals}


requiredOptional
public readonly required: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/launchdarkly/launchdarkly/2.21.2/docs/resources/environment#required Environment#required}


requiredApprovalTagsOptional
public readonly requiredApprovalTags: string[];
  • Type: 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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/launchdarkly/launchdarkly/2.21.2/docs/resources/environment#required_approval_tags Environment#required_approval_tags}


serviceConfigOptional
public readonly serviceConfig: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

The configuration for the service associated with this approval.

This is specific to each approval service. For a service_kind of servicenow, the following fields apply:

 - `template` (String) The sys_id of the Standard Change Request Template in ServiceNow that LaunchDarkly will use when creating the change request.
 - `detail_column` (String) The name of the ServiceNow Change Request column LaunchDarkly uses to populate detailed approval request information. 

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/launchdarkly/launchdarkly/2.21.2/docs/resources/environment#service_config Environment#service_config}


serviceKindOptional
public readonly serviceKind: string;
  • Type: string

The kind of service associated with this approval.

This determines which platform is used for requesting approval. Valid values are servicenow, launchdarkly.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/launchdarkly/launchdarkly/2.21.2/docs/resources/environment#service_kind Environment#service_kind}


EnvironmentConfig

Initializer

import { environment } from '@cdktf/provider-launchdarkly'

const environmentConfig: environment.EnvironmentConfig = { ... }

Properties

Name Type Description
connection cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection No description.
count number | cdktf.TerraformCount No description.
dependsOn cdktf.ITerraformDependable[] No description.
forEach cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[] No description.
color string The color swatch as an RGB hex value with no leading #. For example: 000000.
key string The project-unique key for the environment.
name string The name of the environment.
projectKey string The LaunchDarkly project key.
approvalSettings cdktf.IResolvable | EnvironmentApprovalSettings[] approval_settings block.
confirmChanges boolean | cdktf.IResolvable Set to true if this environment requires confirmation for flag and segment changes.
critical boolean | cdktf.IResolvable Denotes whether the environment is critical.
defaultTrackEvents boolean | cdktf.IResolvable Set to true to enable data export for every flag created in this environment after you configure this argument.
defaultTtl number The TTL for the environment.
id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/launchdarkly/launchdarkly/2.21.2/docs/resources/environment#id Environment#id}.
requireComments boolean | cdktf.IResolvable Set to true if this environment requires comments for flag and segment changes.
secureMode boolean | cdktf.IResolvable Set to true to ensure a user of the client-side SDK cannot impersonate another user.
tags string[] Tags associated with your resource.

connectionOptional
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
  • Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

countOptional
public readonly count: number | TerraformCount;
  • Type: number | cdktf.TerraformCount

dependsOnOptional
public readonly dependsOn: ITerraformDependable[];
  • Type: cdktf.ITerraformDependable[]

forEachOptional
public readonly forEach: ITerraformIterator;
  • Type: cdktf.ITerraformIterator

lifecycleOptional
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktf.TerraformResourceLifecycle

providerOptional
public readonly provider: TerraformProvider;
  • Type: cdktf.TerraformProvider

provisionersOptional
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
  • Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

colorRequired
public readonly color: string;
  • Type: string

The color swatch as an RGB hex value with no leading #. For example: 000000.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/launchdarkly/launchdarkly/2.21.2/docs/resources/environment#color Environment#color}


keyRequired
public readonly key: string;
  • Type: 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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/launchdarkly/launchdarkly/2.21.2/docs/resources/environment#key Environment#key}


nameRequired
public readonly name: string;
  • Type: string

The name of the environment.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/launchdarkly/launchdarkly/2.21.2/docs/resources/environment#name Environment#name}


projectKeyRequired
public readonly projectKey: string;
  • Type: string

The LaunchDarkly project key.

A change in this field will force the destruction of the existing resource and the creation of a new one.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/launchdarkly/launchdarkly/2.21.2/docs/resources/environment#project_key Environment#project_key}


approvalSettingsOptional
public readonly approvalSettings: IResolvable | EnvironmentApprovalSettings[];

approval_settings block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/launchdarkly/launchdarkly/2.21.2/docs/resources/environment#approval_settings Environment#approval_settings}


confirmChangesOptional
public readonly confirmChanges: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Set to true if this environment requires confirmation for flag and segment changes.

This field will default to false when not set.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/launchdarkly/launchdarkly/2.21.2/docs/resources/environment#confirm_changes Environment#confirm_changes}


criticalOptional
public readonly critical: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Denotes whether the environment is critical.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/launchdarkly/launchdarkly/2.21.2/docs/resources/environment#critical Environment#critical}


defaultTrackEventsOptional
public readonly defaultTrackEvents: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/launchdarkly/launchdarkly/2.21.2/docs/resources/environment#default_track_events Environment#default_track_events}


defaultTtlOptional
public readonly defaultTtl: number;
  • Type: 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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/launchdarkly/launchdarkly/2.21.2/docs/resources/environment#default_ttl Environment#default_ttl}


idOptional
public readonly id: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/launchdarkly/launchdarkly/2.21.2/docs/resources/environment#id Environment#id}.

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.


requireCommentsOptional
public readonly requireComments: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Set to true if this environment requires comments for flag and segment changes.

This field will default to false when not set.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/launchdarkly/launchdarkly/2.21.2/docs/resources/environment#require_comments Environment#require_comments}


secureModeOptional
public readonly secureMode: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/launchdarkly/launchdarkly/2.21.2/docs/resources/environment#secure_mode Environment#secure_mode}


tagsOptional
public readonly tags: string[];
  • Type: string[]

Tags associated with your resource.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/launchdarkly/launchdarkly/2.21.2/docs/resources/environment#tags Environment#tags}


Classes

EnvironmentApprovalSettingsList

Initializers

import { environment } from '@cdktf/provider-launchdarkly'

new environment.EnvironmentApprovalSettingsList(terraformResource: IInterpolatingParent, terraformAttribute: string, wrapsSet: boolean)
Name Type Description
terraformResource cdktf.IInterpolatingParent The parent resource.
terraformAttribute string The attribute on the parent resource this class is referencing.
wrapsSet boolean whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.


terraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.


wrapsSetRequired
  • Type: boolean

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).


Methods

Name Description
allWithMapKey Creating an iterator for this complex list.
computeFqn No description.
resolve Produce the Token's value at resolution time.
toString Return a string representation of this resolvable object.
get No description.

allWithMapKey
public allWithMapKey(mapKeyAttributeName: string): DynamicListTerraformIterator

Creating an iterator for this complex list.

The list will be converted into a map with the mapKeyAttributeName as the key.

mapKeyAttributeNameRequired
  • Type: string

computeFqn
public computeFqn(): string
resolve
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext

toString
public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

get
public get(index: number): EnvironmentApprovalSettingsOutputReference
indexRequired
  • Type: number

the index of the item to return.


Properties

Name Type Description
creationStack string[] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn string No description.
internalValue cdktf.IResolvable | EnvironmentApprovalSettings[] No description.

creationStackRequired
public readonly creationStack: string[];
  • Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.


fqnRequired
public readonly fqn: string;
  • Type: string

internalValueOptional
public readonly internalValue: IResolvable | EnvironmentApprovalSettings[];

EnvironmentApprovalSettingsOutputReference

Initializers

import { environment } from '@cdktf/provider-launchdarkly'

new environment.EnvironmentApprovalSettingsOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string, complexObjectIndex: number, complexObjectIsFromSet: boolean)
Name Type Description
terraformResource cdktf.IInterpolatingParent The parent resource.
terraformAttribute string The attribute on the parent resource this class is referencing.
complexObjectIndex number the index of this item in the list.
complexObjectIsFromSet boolean whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.


terraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.


complexObjectIndexRequired
  • Type: number

the index of this item in the list.


complexObjectIsFromSetRequired
  • Type: boolean

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).


Methods

Name Description
computeFqn No description.
getAnyMapAttribute No description.
getBooleanAttribute No description.
getBooleanMapAttribute No description.
getListAttribute No description.
getNumberAttribute No description.
getNumberListAttribute No description.
getNumberMapAttribute No description.
getStringAttribute No description.
getStringMapAttribute No description.
interpolationForAttribute No description.
resolve Produce the Token's value at resolution time.
toString Return a string representation of this resolvable object.
resetCanApplyDeclinedChanges No description.
resetCanReviewOwnRequest No description.
resetMinNumApprovals No description.
resetRequired No description.
resetRequiredApprovalTags No description.
resetServiceConfig No description.
resetServiceKind No description.

computeFqn
public computeFqn(): string
getAnyMapAttribute
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string

getBooleanAttribute
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string

getBooleanMapAttribute
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
terraformAttributeRequired
  • Type: string

getListAttribute
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string

getNumberAttribute
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string

getNumberListAttribute
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string

getNumberMapAttribute
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
terraformAttributeRequired
  • Type: string

getStringAttribute
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string

getStringMapAttribute
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
terraformAttributeRequired
  • Type: string

interpolationForAttribute
public interpolationForAttribute(property: string): IResolvable
propertyRequired
  • Type: string

resolve
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext

toString
public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetCanApplyDeclinedChanges
public resetCanApplyDeclinedChanges(): void
resetCanReviewOwnRequest
public resetCanReviewOwnRequest(): void
resetMinNumApprovals
public resetMinNumApprovals(): void
resetRequired
public resetRequired(): void
resetRequiredApprovalTags
public resetRequiredApprovalTags(): void
resetServiceConfig
public resetServiceConfig(): void
resetServiceKind
public resetServiceKind(): void

Properties

Name Type Description
creationStack string[] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn string No description.
canApplyDeclinedChangesInput boolean | cdktf.IResolvable No description.
canReviewOwnRequestInput boolean | cdktf.IResolvable No description.
minNumApprovalsInput number No description.
requiredApprovalTagsInput string[] No description.
requiredInput boolean | cdktf.IResolvable No description.
serviceConfigInput {[ key: string ]: string} No description.
serviceKindInput string No description.
canApplyDeclinedChanges boolean | cdktf.IResolvable No description.
canReviewOwnRequest boolean | cdktf.IResolvable No description.
minNumApprovals number No description.
required boolean | cdktf.IResolvable No description.
requiredApprovalTags string[] No description.
serviceConfig {[ key: string ]: string} No description.
serviceKind string No description.
internalValue cdktf.IResolvable | EnvironmentApprovalSettings No description.

creationStackRequired
public readonly creationStack: string[];
  • Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.


fqnRequired
public readonly fqn: string;
  • Type: string

canApplyDeclinedChangesInputOptional
public readonly canApplyDeclinedChangesInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

canReviewOwnRequestInputOptional
public readonly canReviewOwnRequestInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

minNumApprovalsInputOptional
public readonly minNumApprovalsInput: number;
  • Type: number

requiredApprovalTagsInputOptional
public readonly requiredApprovalTagsInput: string[];
  • Type: string[]

requiredInputOptional
public readonly requiredInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

serviceConfigInputOptional
public readonly serviceConfigInput: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

serviceKindInputOptional
public readonly serviceKindInput: string;
  • Type: string

canApplyDeclinedChangesRequired
public readonly canApplyDeclinedChanges: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

canReviewOwnRequestRequired
public readonly canReviewOwnRequest: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

minNumApprovalsRequired
public readonly minNumApprovals: number;
  • Type: number

requiredRequired
public readonly required: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

requiredApprovalTagsRequired
public readonly requiredApprovalTags: string[];
  • Type: string[]

serviceConfigRequired
public readonly serviceConfig: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

serviceKindRequired
public readonly serviceKind: string;
  • Type: string

internalValueOptional
public readonly internalValue: IResolvable | EnvironmentApprovalSettings;