Skip to content

Latest commit

 

History

History
3510 lines (2149 loc) · 155 KB

featureFlag.typescript.md

File metadata and controls

3510 lines (2149 loc) · 155 KB

featureFlag Submodule

Constructs

FeatureFlag

Represents a {@link https://registry.terraform.io/providers/launchdarkly/launchdarkly/2.24.0/docs/resources/feature_flag launchdarkly_feature_flag}.

Initializers 

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

new featureFlag.FeatureFlag(scope: Construct, id: string, config: FeatureFlagConfig)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id string The scoped construct ID.
config FeatureFlagConfig 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".
putClientSideAvailability No description.
putCustomProperties No description.
putDefaults No description.
putVariations No description.
resetArchived No description.
resetClientSideAvailability No description.
resetCustomProperties No description.
resetDefaults No description.
resetDescription No description.
resetId No description.
resetIncludeInSnippet No description.
resetMaintainerId No description.
resetMaintainerTeamKey No description.
resetTags No description.
resetTemporary No description.
resetVariations 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".

putClientSideAvailability 
public putClientSideAvailability(value: IResolvable | FeatureFlagClientSideAvailability[]): void
valueRequired
putCustomProperties 
public putCustomProperties(value: IResolvable | FeatureFlagCustomProperties[]): void
valueRequired
putDefaults 
public putDefaults(value: FeatureFlagDefaults): void
valueRequired
putVariations 
public putVariations(value: IResolvable | FeatureFlagVariations[]): void
valueRequired
resetArchived 
public resetArchived(): void
resetClientSideAvailability 
public resetClientSideAvailability(): void
resetCustomProperties 
public resetCustomProperties(): void
resetDefaults 
public resetDefaults(): void
resetDescription 
public resetDescription(): void
resetId 
public resetId(): void
resetIncludeInSnippet 
public resetIncludeInSnippet(): void
resetMaintainerId 
public resetMaintainerId(): void
resetMaintainerTeamKey 
public resetMaintainerTeamKey(): void
resetTags 
public resetTags(): void
resetTemporary 
public resetTemporary(): void
resetVariations 
public resetVariations(): 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 FeatureFlag resource upon running "cdktf plan ".
isConstruct 
import { featureFlag } from '@cdktf/provider-launchdarkly'

featureFlag.FeatureFlag.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 { featureFlag } from '@cdktf/provider-launchdarkly'

featureFlag.FeatureFlag.isTerraformElement(x: any)
xRequired
  • Type: any
isTerraformResource 
import { featureFlag } from '@cdktf/provider-launchdarkly'

featureFlag.FeatureFlag.isTerraformResource(x: any)
xRequired
  • Type: any
generateConfigForImport 
import { featureFlag } from '@cdktf/provider-launchdarkly'

featureFlag.FeatureFlag.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

Generates CDKTF code for importing a FeatureFlag 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 FeatureFlag to import.

importFromIdRequired
  • Type: string

The id of the existing FeatureFlag that should be imported.

Refer to the {@link https://registry.terraform.io/providers/launchdarkly/launchdarkly/2.24.0/docs/resources/feature_flag#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 FeatureFlag 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.
clientSideAvailability FeatureFlagClientSideAvailabilityList No description.
customProperties FeatureFlagCustomPropertiesList No description.
defaults FeatureFlagDefaultsOutputReference No description.
variations FeatureFlagVariationsList No description.
archivedInput boolean | cdktf.IResolvable No description.
clientSideAvailabilityInput cdktf.IResolvable | FeatureFlagClientSideAvailability[] No description.
customPropertiesInput cdktf.IResolvable | FeatureFlagCustomProperties[] No description.
defaultsInput FeatureFlagDefaults No description.
descriptionInput string No description.
idInput string No description.
includeInSnippetInput boolean | cdktf.IResolvable No description.
keyInput string No description.
maintainerIdInput string No description.
maintainerTeamKeyInput string No description.
nameInput string No description.
projectKeyInput string No description.
tagsInput string[] No description.
temporaryInput boolean | cdktf.IResolvable No description.
variationsInput cdktf.IResolvable | FeatureFlagVariations[] No description.
variationTypeInput string No description.
archived boolean | cdktf.IResolvable No description.
description string No description.
id string No description.
includeInSnippet boolean | cdktf.IResolvable No description.
key string No description.
maintainerId string No description.
maintainerTeamKey string No description.
name string No description.
projectKey string No description.
tags string[] No description.
temporary boolean | cdktf.IResolvable No description.
variationType 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[]
clientSideAvailabilityRequired 
public readonly clientSideAvailability: FeatureFlagClientSideAvailabilityList;
customPropertiesRequired 
public readonly customProperties: FeatureFlagCustomPropertiesList;
defaultsRequired 
public readonly defaults: FeatureFlagDefaultsOutputReference;
variationsRequired 
public readonly variations: FeatureFlagVariationsList;
archivedInputOptional 
public readonly archivedInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
clientSideAvailabilityInputOptional 
public readonly clientSideAvailabilityInput: IResolvable | FeatureFlagClientSideAvailability[];
customPropertiesInputOptional 
public readonly customPropertiesInput: IResolvable | FeatureFlagCustomProperties[];
defaultsInputOptional 
public readonly defaultsInput: FeatureFlagDefaults;
descriptionInputOptional 
public readonly descriptionInput: string;
  • Type: string
idInputOptional 
public readonly idInput: string;
  • Type: string
includeInSnippetInputOptional 
public readonly includeInSnippetInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
keyInputOptional 
public readonly keyInput: string;
  • Type: string
maintainerIdInputOptional 
public readonly maintainerIdInput: string;
  • Type: string
maintainerTeamKeyInputOptional 
public readonly maintainerTeamKeyInput: string;
  • Type: string
nameInputOptional 
public readonly nameInput: string;
  • Type: string
projectKeyInputOptional 
public readonly projectKeyInput: string;
  • Type: string
tagsInputOptional 
public readonly tagsInput: string[];
  • Type: string[]
temporaryInputOptional 
public readonly temporaryInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
variationsInputOptional 
public readonly variationsInput: IResolvable | FeatureFlagVariations[];
variationTypeInputOptional 
public readonly variationTypeInput: string;
  • Type: string
archivedRequired 
public readonly archived: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
descriptionRequired 
public readonly description: string;
  • Type: string
idRequired 
public readonly id: string;
  • Type: string
includeInSnippetRequired 
public readonly includeInSnippet: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
keyRequired 
public readonly key: string;
  • Type: string
maintainerIdRequired 
public readonly maintainerId: string;
  • Type: string
maintainerTeamKeyRequired 
public readonly maintainerTeamKey: string;
  • Type: string
nameRequired 
public readonly name: string;
  • Type: string
projectKeyRequired 
public readonly projectKey: string;
  • Type: string
tagsRequired 
public readonly tags: string[];
  • Type: string[]
temporaryRequired 
public readonly temporary: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
variationTypeRequired 
public readonly variationType: string;
  • Type: string

Constants

Name Type Description
tfResourceType string No description.
tfResourceTypeRequired 
public readonly tfResourceType: string;
  • Type: string

Structs

FeatureFlagClientSideAvailability

Initializer 

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

const featureFlagClientSideAvailability: featureFlag.FeatureFlagClientSideAvailability = { ... }

Properties

Name Type Description
usingEnvironmentId boolean | cdktf.IResolvable Whether this flag is available to SDKs using the client-side ID.
usingMobileKey boolean | cdktf.IResolvable Whether this flag is available to SDKs using a mobile key.
usingEnvironmentIdOptional 
public readonly usingEnvironmentId: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Whether this flag is available to SDKs using the client-side ID.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/launchdarkly/launchdarkly/2.24.0/docs/resources/feature_flag#using_environment_id FeatureFlag#using_environment_id}

usingMobileKeyOptional 
public readonly usingMobileKey: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Whether this flag is available to SDKs using a mobile key.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/launchdarkly/launchdarkly/2.24.0/docs/resources/feature_flag#using_mobile_key FeatureFlag#using_mobile_key}

FeatureFlagConfig

Initializer 

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

const featureFlagConfig: featureFlag.FeatureFlagConfig = { ... }

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 unique feature flag key that references the flag in your application code.
name string The human-readable name of the feature flag.
projectKey string The feature flag's project key.
variationType string The feature flag's variation type: boolean, string, number or json.
archived boolean | cdktf.IResolvable Specifies whether the flag is archived or not.
clientSideAvailability cdktf.IResolvable | FeatureFlagClientSideAvailability[] client_side_availability block.
customProperties cdktf.IResolvable | FeatureFlagCustomProperties[] custom_properties block.
defaults FeatureFlagDefaults defaults block.
description string The feature flag's description.
id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/launchdarkly/launchdarkly/2.24.0/docs/resources/feature_flag#id FeatureFlag#id}.
includeInSnippet boolean | cdktf.IResolvable Specifies whether this flag should be made available to the client-side JavaScript SDK using the client-side Id.
maintainerId string The feature flag maintainer's 24 character alphanumeric team member ID.
maintainerTeamKey string The key of the associated team that maintains this feature flag. maintainer_id cannot be set if maintainer_team_key is set.
tags string[] Tags associated with your resource.
temporary boolean | cdktf.IResolvable Specifies whether the flag is a temporary flag.
variations cdktf.IResolvable | FeatureFlagVariations[] variations block.
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[]
keyRequired 
public readonly key: string;
  • Type: string

The unique feature flag key that references the flag in your application code.

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.24.0/docs/resources/feature_flag#key FeatureFlag#key}

nameRequired 
public readonly name: string;
  • Type: string

The human-readable name of the feature flag.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/launchdarkly/launchdarkly/2.24.0/docs/resources/feature_flag#name FeatureFlag#name}

projectKeyRequired 
public readonly projectKey: string;
  • Type: string

The feature flag's 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.24.0/docs/resources/feature_flag#project_key FeatureFlag#project_key}

variationTypeRequired 
public readonly variationType: string;
  • Type: string

The feature flag's variation type: boolean, string, number or json.

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.24.0/docs/resources/feature_flag#variation_type FeatureFlag#variation_type}

archivedOptional 
public readonly archived: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Specifies whether the flag is archived or not.

Note that you cannot create a new flag that is archived, but can update a flag to be archived.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/launchdarkly/launchdarkly/2.24.0/docs/resources/feature_flag#archived FeatureFlag#archived}

clientSideAvailabilityOptional 
public readonly clientSideAvailability: IResolvable | FeatureFlagClientSideAvailability[];

client_side_availability block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/launchdarkly/launchdarkly/2.24.0/docs/resources/feature_flag#client_side_availability FeatureFlag#client_side_availability}

customPropertiesOptional 
public readonly customProperties: IResolvable | FeatureFlagCustomProperties[];

custom_properties block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/launchdarkly/launchdarkly/2.24.0/docs/resources/feature_flag#custom_properties FeatureFlag#custom_properties}

defaultsOptional 
public readonly defaults: FeatureFlagDefaults;

defaults block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/launchdarkly/launchdarkly/2.24.0/docs/resources/feature_flag#defaults FeatureFlag#defaults}

descriptionOptional 
public readonly description: string;
  • Type: string

The feature flag's description.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/launchdarkly/launchdarkly/2.24.0/docs/resources/feature_flag#description FeatureFlag#description}

idOptional 
public readonly id: string;
  • Type: string

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

includeInSnippetOptional 
public readonly includeInSnippet: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Specifies whether this flag should be made available to the client-side JavaScript SDK using the client-side Id.

This value gets its default from your project configuration if not set. include_in_snippet is now deprecated. Please migrate to client_side_availability.using_environment_id to maintain future compatibility.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/launchdarkly/launchdarkly/2.24.0/docs/resources/feature_flag#include_in_snippet FeatureFlag#include_in_snippet}

maintainerIdOptional 
public readonly maintainerId: string;
  • Type: string

The feature flag maintainer's 24 character alphanumeric team member ID.

maintainer_team_key cannot be set if maintainer_id is set. If neither is set, it will automatically be or stay set to the member ID associated with the API key used by your LaunchDarkly Terraform provider or the most recently-set maintainer.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/launchdarkly/launchdarkly/2.24.0/docs/resources/feature_flag#maintainer_id FeatureFlag#maintainer_id}

maintainerTeamKeyOptional 
public readonly maintainerTeamKey: string;
  • Type: string

The key of the associated team that maintains this feature flag. maintainer_id cannot be set if maintainer_team_key is set.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/launchdarkly/launchdarkly/2.24.0/docs/resources/feature_flag#maintainer_team_key FeatureFlag#maintainer_team_key}

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.24.0/docs/resources/feature_flag#tags FeatureFlag#tags}

temporaryOptional 
public readonly temporary: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Specifies whether the flag is a temporary flag.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/launchdarkly/launchdarkly/2.24.0/docs/resources/feature_flag#temporary FeatureFlag#temporary}

variationsOptional 
public readonly variations: IResolvable | FeatureFlagVariations[];

variations block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/launchdarkly/launchdarkly/2.24.0/docs/resources/feature_flag#variations FeatureFlag#variations}

FeatureFlagCustomProperties

Initializer 

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

const featureFlagCustomProperties: featureFlag.FeatureFlagCustomProperties = { ... }

Properties

Name Type Description
key string The unique custom property key.
name string The name of the custom property.
value string[] The list of custom property value strings.
keyRequired 
public readonly key: string;
  • Type: string

The unique custom property key.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/launchdarkly/launchdarkly/2.24.0/docs/resources/feature_flag#key FeatureFlag#key}

nameRequired 
public readonly name: string;
  • Type: string

The name of the custom property.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/launchdarkly/launchdarkly/2.24.0/docs/resources/feature_flag#name FeatureFlag#name}

valueRequired 
public readonly value: string[];
  • Type: string[]

The list of custom property value strings.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/launchdarkly/launchdarkly/2.24.0/docs/resources/feature_flag#value FeatureFlag#value}

FeatureFlagDefaults

Initializer 

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

const featureFlagDefaults: featureFlag.FeatureFlagDefaults = { ... }

Properties

Name Type Description
offVariation number The index of the variation the flag will default to in all new environments when off.
onVariation number The index of the variation the flag will default to in all new environments when on.
offVariationRequired 
public readonly offVariation: number;
  • Type: number

The index of the variation the flag will default to in all new environments when off.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/launchdarkly/launchdarkly/2.24.0/docs/resources/feature_flag#off_variation FeatureFlag#off_variation}

onVariationRequired 
public readonly onVariation: number;
  • Type: number

The index of the variation the flag will default to in all new environments when on.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/launchdarkly/launchdarkly/2.24.0/docs/resources/feature_flag#on_variation FeatureFlag#on_variation}

FeatureFlagVariations

Initializer 

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

const featureFlagVariations: featureFlag.FeatureFlagVariations = { ... }

Properties

Name Type Description
value string The variation value.
description string The variation's description.
name string The name of the variation.
valueRequired 
public readonly value: string;
  • Type: string

The variation value.

The value's type must correspond to the variation_type argument. For example: variation_type = "boolean" accepts only true or false. The number variation type accepts both floats and ints, but please note that any trailing zeroes on floats will be trimmed (i.e. 1.1 and 1.100 will both be converted to 1.1).

If you wish to define an empty string variation, you must still define the value field on the variations block like so:

variations {
  value = ""
}

-> Note: Terraform manages variations as an ordered array and identifies them by index. This means that if you change the order of your variations block, you may end up destroying and recreating those variations. Additionally, if you delete variations that have targets that have been attached outside of Terraform, those targets may be incorrectly reassigned to a different variation.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/launchdarkly/launchdarkly/2.24.0/docs/resources/feature_flag#value FeatureFlag#value}

descriptionOptional 
public readonly description: string;
  • Type: string

The variation's description.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/launchdarkly/launchdarkly/2.24.0/docs/resources/feature_flag#description FeatureFlag#description}

nameOptional 
public readonly name: string;
  • Type: string

The name of the variation.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/launchdarkly/launchdarkly/2.24.0/docs/resources/feature_flag#name FeatureFlag#name}

Classes

FeatureFlagClientSideAvailabilityList

Initializers 

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

new featureFlag.FeatureFlagClientSideAvailabilityList(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): FeatureFlagClientSideAvailabilityOutputReference
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 | FeatureFlagClientSideAvailability[] 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 | FeatureFlagClientSideAvailability[];

FeatureFlagClientSideAvailabilityOutputReference

Initializers 

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

new featureFlag.FeatureFlagClientSideAvailabilityOutputReference(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.
resetUsingEnvironmentId No description.
resetUsingMobileKey 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.

resetUsingEnvironmentId 
public resetUsingEnvironmentId(): void
resetUsingMobileKey 
public resetUsingMobileKey(): 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.
usingEnvironmentIdInput boolean | cdktf.IResolvable No description.
usingMobileKeyInput boolean | cdktf.IResolvable No description.
usingEnvironmentId boolean | cdktf.IResolvable No description.
usingMobileKey boolean | cdktf.IResolvable No description.
internalValue cdktf.IResolvable | FeatureFlagClientSideAvailability 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
usingEnvironmentIdInputOptional 
public readonly usingEnvironmentIdInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
usingMobileKeyInputOptional 
public readonly usingMobileKeyInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
usingEnvironmentIdRequired 
public readonly usingEnvironmentId: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
usingMobileKeyRequired 
public readonly usingMobileKey: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
internalValueOptional 
public readonly internalValue: IResolvable | FeatureFlagClientSideAvailability;

FeatureFlagCustomPropertiesList

Initializers 

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

new featureFlag.FeatureFlagCustomPropertiesList(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): FeatureFlagCustomPropertiesOutputReference
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 | FeatureFlagCustomProperties[] 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 | FeatureFlagCustomProperties[];

FeatureFlagCustomPropertiesOutputReference

Initializers 

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

new featureFlag.FeatureFlagCustomPropertiesOutputReference(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.
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.

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.
keyInput string No description.
nameInput string No description.
valueInput string[] No description.
key string No description.
name string No description.
value string[] No description.
internalValue cdktf.IResolvable | FeatureFlagCustomProperties 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
keyInputOptional 
public readonly keyInput: string;
  • Type: string
nameInputOptional 
public readonly nameInput: string;
  • Type: string
valueInputOptional 
public readonly valueInput: string[];
  • Type: string[]
keyRequired 
public readonly key: string;
  • Type: string
nameRequired 
public readonly name: string;
  • Type: string
valueRequired 
public readonly value: string[];
  • Type: string[]
internalValueOptional 
public readonly internalValue: IResolvable | FeatureFlagCustomProperties;

FeatureFlagDefaultsOutputReference

Initializers 

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

new featureFlag.FeatureFlagDefaultsOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)
Name Type Description
terraformResource cdktf.IInterpolatingParent The parent resource.
terraformAttribute string The attribute on the parent resource this class is referencing.
terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.

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

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.
offVariationInput number No description.
onVariationInput number No description.
offVariation number No description.
onVariation number No description.
internalValue FeatureFlagDefaults 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
offVariationInputOptional 
public readonly offVariationInput: number;
  • Type: number
onVariationInputOptional 
public readonly onVariationInput: number;
  • Type: number
offVariationRequired 
public readonly offVariation: number;
  • Type: number
onVariationRequired 
public readonly onVariation: number;
  • Type: number
internalValueOptional 
public readonly internalValue: FeatureFlagDefaults;

FeatureFlagVariationsList

Initializers 

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

new featureFlag.FeatureFlagVariationsList(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): FeatureFlagVariationsOutputReference
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 | FeatureFlagVariations[] 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 | FeatureFlagVariations[];

FeatureFlagVariationsOutputReference

Initializers 

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

new featureFlag.FeatureFlagVariationsOutputReference(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.
resetDescription No description.
resetName 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.

resetDescription 
public resetDescription(): void
resetName 
public resetName(): 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.
descriptionInput string No description.
nameInput string No description.
valueInput string No description.
description string No description.
name string No description.
value string No description.
internalValue cdktf.IResolvable | FeatureFlagVariations 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
descriptionInputOptional 
public readonly descriptionInput: string;
  • Type: string
nameInputOptional 
public readonly nameInput: string;
  • Type: string
valueInputOptional 
public readonly valueInput: string;
  • Type: string
descriptionRequired 
public readonly description: string;
  • Type: string
nameRequired 
public readonly name: string;
  • Type: string
valueRequired 
public readonly value: string;
  • Type: string
internalValueOptional 
public readonly internalValue: IResolvable | FeatureFlagVariations;