dataLaunchdarklyEnvironment.typescript.md

dataLaunchdarklyEnvironment Submodule

Constructs

DataLaunchdarklyEnvironment

Represents a {@link https://registry.terraform.io/providers/launchdarkly/launchdarkly/2.24.0/docs/data-sources/environment launchdarkly_environment}.

Initializers

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

new dataLaunchdarklyEnvironment.DataLaunchdarklyEnvironment(scope: Construct, id: string, config: DataLaunchdarklyEnvironmentConfig)

Name	Type	Description
scope	constructs.Construct	The scope in which to define this construct.
id	string	The scoped construct ID.
config	DataLaunchdarklyEnvironmentConfig	No description.

---

scope^Required

• Type: constructs.Construct

The scope in which to define this construct.

---

id^Required

• Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

---

config^Required

• Type: DataLaunchdarklyEnvironmentConfig

---

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	Adds this resource to the terraform JSON output.
toMetadata	No description.
toTerraform	Adds this resource to the terraform JSON output.
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.
resetCritical	No description.
resetId	No description.

---

toString

public toString(): string

Returns a string representation of this construct.

addOverride

public addOverride(path: string, value: any): void

path^Required

• Type: string

---

value^Required

• Type: any

---

overrideLogicalId

public overrideLogicalId(newLogicalId: string): void

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

newLogicalId^Required

• 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

Adds this resource to the terraform JSON output.

toMetadata

public toMetadata(): any

toTerraform

public toTerraform(): any

Adds this resource to the terraform JSON output.

getAnyMapAttribute

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

terraformAttribute^Required

• Type: string

---

getBooleanAttribute

public getBooleanAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

getBooleanMapAttribute

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

terraformAttribute^Required

• Type: string

---

getListAttribute

public getListAttribute(terraformAttribute: string): string[]

terraformAttribute^Required

• Type: string

---

getNumberAttribute

public getNumberAttribute(terraformAttribute: string): number

terraformAttribute^Required

• Type: string

---

getNumberListAttribute

public getNumberListAttribute(terraformAttribute: string): number[]

terraformAttribute^Required

• Type: string

---

getNumberMapAttribute

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

terraformAttribute^Required

• Type: string

---

getStringAttribute

public getStringAttribute(terraformAttribute: string): string

terraformAttribute^Required

• Type: string

---

getStringMapAttribute

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

terraformAttribute^Required

• Type: string

---

interpolationForAttribute

public interpolationForAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

resetCritical

public resetCritical(): void

resetId

public resetId(): void

Static Functions

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

---

isConstruct

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

dataLaunchdarklyEnvironment.DataLaunchdarklyEnvironment.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.

x^Required

• Type: any

Any object.

---

isTerraformElement

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

dataLaunchdarklyEnvironment.DataLaunchdarklyEnvironment.isTerraformElement(x: any)

x^Required

• Type: any

---

isTerraformDataSource

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

dataLaunchdarklyEnvironment.DataLaunchdarklyEnvironment.isTerraformDataSource(x: any)

x^Required

• Type: any

---

generateConfigForImport

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

dataLaunchdarklyEnvironment.DataLaunchdarklyEnvironment.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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

scope^Required

• Type: constructs.Construct

The scope in which to define this construct.

---

importToId^Required

• Type: string

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

---

importFromId^Required

• Type: string

The id of the existing DataLaunchdarklyEnvironment that should be imported.

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

---

provider^Optional

• Type: cdktf.TerraformProvider

? Optional instance of the provider where the DataLaunchdarklyEnvironment 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.
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.
apiKey	string	No description.
approvalSettings	DataLaunchdarklyEnvironmentApprovalSettingsList	No description.
clientSideId	string	No description.
color	string	No description.
confirmChanges	cdktf.IResolvable	No description.
defaultTrackEvents	cdktf.IResolvable	No description.
defaultTtl	number	No description.
mobileKey	string	No description.
name	string	No description.
requireComments	cdktf.IResolvable	No description.
secureMode	cdktf.IResolvable	No description.
tags	string[]	No description.
criticalInput	boolean | cdktf.IResolvable	No description.
idInput	string	No description.
keyInput	string	No description.
projectKeyInput	string	No description.
critical	boolean | cdktf.IResolvable	No description.
id	string	No description.
key	string	No description.
projectKey	string	No description.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

cdktfStack^Required

public readonly cdktfStack: TerraformStack;

• Type: cdktf.TerraformStack

---

fqn^Required

public readonly fqn: string;

• Type: string

---

friendlyUniqueId^Required

public readonly friendlyUniqueId: string;

• Type: string

---

terraformMetaArguments^Required

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

• Type: {[ key: string ]: any}

---

terraformResourceType^Required

public readonly terraformResourceType: string;

• Type: string

---

terraformGeneratorMetadata^Optional

public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;

• Type: cdktf.TerraformProviderGeneratorMetadata

---

count^Optional

public readonly count: number | TerraformCount;

• Type: number | cdktf.TerraformCount

---

dependsOn^Optional

public readonly dependsOn: string[];

• Type: string[]

---

forEach^Optional

public readonly forEach: ITerraformIterator;

• Type: cdktf.ITerraformIterator

---

lifecycle^Optional

public readonly lifecycle: TerraformResourceLifecycle;

• Type: cdktf.TerraformResourceLifecycle

---

provider^Optional

public readonly provider: TerraformProvider;

• Type: cdktf.TerraformProvider

---

apiKey^Required

public readonly apiKey: string;

• Type: string

---

approvalSettings^Required

public readonly approvalSettings: DataLaunchdarklyEnvironmentApprovalSettingsList;

• Type: DataLaunchdarklyEnvironmentApprovalSettingsList

---

clientSideId^Required

public readonly clientSideId: string;

• Type: string

---

color^Required

public readonly color: string;

• Type: string

---

confirmChanges^Required

public readonly confirmChanges: IResolvable;

• Type: cdktf.IResolvable

---

defaultTrackEvents^Required

public readonly defaultTrackEvents: IResolvable;

• Type: cdktf.IResolvable

---

defaultTtl^Required

public readonly defaultTtl: number;

• Type: number

---

mobileKey^Required

public readonly mobileKey: string;

• Type: string

---

name^Required

public readonly name: string;

• Type: string

---

requireComments^Required

public readonly requireComments: IResolvable;

• Type: cdktf.IResolvable

---

secureMode^Required

public readonly secureMode: IResolvable;

• Type: cdktf.IResolvable

---

tags^Required

public readonly tags: string[];

• Type: string[]

---

criticalInput^Optional

public readonly criticalInput: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

idInput^Optional

public readonly idInput: string;

• Type: string

---

keyInput^Optional

public readonly keyInput: string;

• Type: string

---

projectKeyInput^Optional

public readonly projectKeyInput: string;

• Type: string

---

critical^Required

public readonly critical: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

id^Required

public readonly id: string;

• Type: string

---

key^Required

public readonly key: string;

• Type: string

---

projectKey^Required

public readonly projectKey: string;

• Type: string

---

Constants

Name	Type	Description
tfResourceType	string	No description.

---

tfResourceType^Required

public readonly tfResourceType: string;

• Type: string

---

Structs

DataLaunchdarklyEnvironmentApprovalSettings

Initializer

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

const dataLaunchdarklyEnvironmentApprovalSettings: dataLaunchdarklyEnvironment.DataLaunchdarklyEnvironmentApprovalSettings = { ... }

DataLaunchdarklyEnvironmentConfig

Initializer

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

const dataLaunchdarklyEnvironmentConfig: dataLaunchdarklyEnvironment.DataLaunchdarklyEnvironmentConfig = { ... }

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.
key	string	The project-unique key for the environment.
projectKey	string	The environment's project key.
critical	boolean | cdktf.IResolvable	Denotes whether the environment is critical.
id	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/launchdarkly/launchdarkly/2.24.0/docs/data-sources/environment#id DataLaunchdarklyEnvironment#id}.

---

connection^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

• Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

---

count^Optional

public readonly count: number | TerraformCount;

• Type: number | cdktf.TerraformCount

---

dependsOn^Optional

public readonly dependsOn: ITerraformDependable[];

• Type: cdktf.ITerraformDependable[]

---

forEach^Optional

public readonly forEach: ITerraformIterator;

• Type: cdktf.ITerraformIterator

---

lifecycle^Optional

public readonly lifecycle: TerraformResourceLifecycle;

• Type: cdktf.TerraformResourceLifecycle

---

provider^Optional

public readonly provider: TerraformProvider;

• Type: cdktf.TerraformProvider

---

provisioners^Optional

public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];

• Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

---

key^Required

public readonly key: string;

• Type: string

The project-unique key for the environment.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/launchdarkly/launchdarkly/2.24.0/docs/data-sources/environment#key DataLaunchdarklyEnvironment#key}

---

projectKey^Required

public readonly projectKey: string;

• Type: string

The environment's project key.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/launchdarkly/launchdarkly/2.24.0/docs/data-sources/environment#project_key DataLaunchdarklyEnvironment#project_key}

---

critical^Optional

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.24.0/docs/data-sources/environment#critical DataLaunchdarklyEnvironment#critical}

---

id^Optional

public readonly id: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/launchdarkly/launchdarkly/2.24.0/docs/data-sources/environment#id DataLaunchdarklyEnvironment#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.

---

Classes

DataLaunchdarklyEnvironmentApprovalSettingsList

Initializers

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

new dataLaunchdarklyEnvironment.DataLaunchdarklyEnvironmentApprovalSettingsList(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).

---

terraformResource^Required

• Type: cdktf.IInterpolatingParent

The parent resource.

---

terraformAttribute^Required

• Type: string

The attribute on the parent resource this class is referencing.

---

wrapsSet^Required

• 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.

mapKeyAttributeName^Required

• Type: string

---

computeFqn

public computeFqn(): string

resolve

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_context^Required

• 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): DataLaunchdarklyEnvironmentApprovalSettingsOutputReference

index^Required

• 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.

---

creationStack^Required

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.

---

fqn^Required

public readonly fqn: string;

• Type: string

---

DataLaunchdarklyEnvironmentApprovalSettingsOutputReference

Initializers

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

new dataLaunchdarklyEnvironment.DataLaunchdarklyEnvironmentApprovalSettingsOutputReference(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).

---

terraformResource^Required

• Type: cdktf.IInterpolatingParent

The parent resource.

---

terraformAttribute^Required

• Type: string

The attribute on the parent resource this class is referencing.

---

complexObjectIndex^Required

• Type: number

the index of this item in the list.

---

complexObjectIsFromSet^Required

• 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.

---

computeFqn

public computeFqn(): string

getAnyMapAttribute

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

terraformAttribute^Required

• Type: string

---

getBooleanAttribute

public getBooleanAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

getBooleanMapAttribute

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

terraformAttribute^Required

• Type: string

---

getListAttribute

public getListAttribute(terraformAttribute: string): string[]

terraformAttribute^Required

• Type: string

---

getNumberAttribute

public getNumberAttribute(terraformAttribute: string): number

terraformAttribute^Required

• Type: string

---

getNumberListAttribute

public getNumberListAttribute(terraformAttribute: string): number[]

terraformAttribute^Required

• Type: string

---

getNumberMapAttribute

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

terraformAttribute^Required

• Type: string

---

getStringAttribute

public getStringAttribute(terraformAttribute: string): string

terraformAttribute^Required

• Type: string

---

getStringMapAttribute

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

terraformAttribute^Required

• Type: string

---

interpolationForAttribute

public interpolationForAttribute(property: string): IResolvable

property^Required

• Type: string

---

resolve

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_context^Required

• Type: cdktf.IResolveContext

---

toString

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

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.
autoApplyApprovedChanges	cdktf.IResolvable	No description.
canApplyDeclinedChanges	cdktf.IResolvable	No description.
canReviewOwnRequest	cdktf.IResolvable	No description.
minNumApprovals	number	No description.
required	cdktf.IResolvable	No description.
requiredApprovalTags	string[]	No description.
serviceConfig	cdktf.StringMap	No description.
serviceKind	string	No description.
internalValue	DataLaunchdarklyEnvironmentApprovalSettings	No description.

---

creationStack^Required

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.

---

fqn^Required

public readonly fqn: string;

• Type: string

---

autoApplyApprovedChanges^Required

public readonly autoApplyApprovedChanges: IResolvable;

• Type: cdktf.IResolvable

---

canApplyDeclinedChanges^Required

public readonly canApplyDeclinedChanges: IResolvable;

• Type: cdktf.IResolvable

---

canReviewOwnRequest^Required

public readonly canReviewOwnRequest: IResolvable;

• Type: cdktf.IResolvable

---

minNumApprovals^Required

public readonly minNumApprovals: number;

• Type: number

---

required^Required

public readonly required: IResolvable;

• Type: cdktf.IResolvable

---

requiredApprovalTags^Required

public readonly requiredApprovalTags: string[];

• Type: string[]

---

serviceConfig^Required

public readonly serviceConfig: StringMap;

• Type: cdktf.StringMap

---

serviceKind^Required

public readonly serviceKind: string;

• Type: string

---

internalValue^Optional

public readonly internalValue: DataLaunchdarklyEnvironmentApprovalSettings;

• Type: DataLaunchdarklyEnvironmentApprovalSettings

---