Skip to content

Latest commit

 

History

History
3776 lines (2308 loc) · 157 KB

segment.typescript.md

File metadata and controls

3776 lines (2308 loc) · 157 KB

segment Submodule

Constructs

Segment

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

Initializers 

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

new segment.Segment(scope: Construct, id: string, config: SegmentConfig)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id string The scoped construct ID.
config SegmentConfig 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".
putExcludedContexts No description.
putIncludedContexts No description.
putRules No description.
resetDescription No description.
resetExcluded No description.
resetExcludedContexts No description.
resetId No description.
resetIncluded No description.
resetIncludedContexts No description.
resetRules No description.
resetTags No description.
resetUnbounded No description.
resetUnboundedContextKind 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".

putExcludedContexts 
public putExcludedContexts(value: IResolvable | SegmentExcludedContexts[]): void
valueRequired
putIncludedContexts 
public putIncludedContexts(value: IResolvable | SegmentIncludedContexts[]): void
valueRequired
putRules 
public putRules(value: IResolvable | SegmentRules[]): void
valueRequired
resetDescription 
public resetDescription(): void
resetExcluded 
public resetExcluded(): void
resetExcludedContexts 
public resetExcludedContexts(): void
resetId 
public resetId(): void
resetIncluded 
public resetIncluded(): void
resetIncludedContexts 
public resetIncludedContexts(): void
resetRules 
public resetRules(): void
resetTags 
public resetTags(): void
resetUnbounded 
public resetUnbounded(): void
resetUnboundedContextKind 
public resetUnboundedContextKind(): 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 Segment resource upon running "cdktf plan ".
isConstruct 
import { segment } from '@cdktf/provider-launchdarkly'

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

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

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

segment.Segment.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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

importFromIdRequired
  • Type: string

The id of the existing Segment that should be imported.

Refer to the {@link https://registry.terraform.io/providers/launchdarkly/launchdarkly/2.24.0/docs/resources/segment#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 Segment 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.
creationDate number No description.
excludedContexts SegmentExcludedContextsList No description.
includedContexts SegmentIncludedContextsList No description.
rules SegmentRulesList No description.
descriptionInput string No description.
envKeyInput string No description.
excludedContextsInput cdktf.IResolvable | SegmentExcludedContexts[] No description.
excludedInput string[] No description.
idInput string No description.
includedContextsInput cdktf.IResolvable | SegmentIncludedContexts[] No description.
includedInput string[] No description.
keyInput string No description.
nameInput string No description.
projectKeyInput string No description.
rulesInput cdktf.IResolvable | SegmentRules[] No description.
tagsInput string[] No description.
unboundedContextKindInput string No description.
unboundedInput boolean | cdktf.IResolvable No description.
description string No description.
envKey string No description.
excluded string[] No description.
id string No description.
included string[] No description.
key string No description.
name string No description.
projectKey string No description.
tags string[] No description.
unbounded boolean | cdktf.IResolvable No description.
unboundedContextKind 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[]
creationDateRequired 
public readonly creationDate: number;
  • Type: number
excludedContextsRequired 
public readonly excludedContexts: SegmentExcludedContextsList;
includedContextsRequired 
public readonly includedContexts: SegmentIncludedContextsList;
rulesRequired 
public readonly rules: SegmentRulesList;
descriptionInputOptional 
public readonly descriptionInput: string;
  • Type: string
envKeyInputOptional 
public readonly envKeyInput: string;
  • Type: string
excludedContextsInputOptional 
public readonly excludedContextsInput: IResolvable | SegmentExcludedContexts[];
excludedInputOptional 
public readonly excludedInput: string[];
  • Type: string[]
idInputOptional 
public readonly idInput: string;
  • Type: string
includedContextsInputOptional 
public readonly includedContextsInput: IResolvable | SegmentIncludedContexts[];
includedInputOptional 
public readonly includedInput: string[];
  • Type: string[]
keyInputOptional 
public readonly keyInput: string;
  • Type: string
nameInputOptional 
public readonly nameInput: string;
  • Type: string
projectKeyInputOptional 
public readonly projectKeyInput: string;
  • Type: string
rulesInputOptional 
public readonly rulesInput: IResolvable | SegmentRules[];
tagsInputOptional 
public readonly tagsInput: string[];
  • Type: string[]
unboundedContextKindInputOptional 
public readonly unboundedContextKindInput: string;
  • Type: string
unboundedInputOptional 
public readonly unboundedInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
descriptionRequired 
public readonly description: string;
  • Type: string
envKeyRequired 
public readonly envKey: string;
  • Type: string
excludedRequired 
public readonly excluded: string[];
  • Type: string[]
idRequired 
public readonly id: string;
  • Type: string
includedRequired 
public readonly included: string[];
  • Type: string[]
keyRequired 
public readonly key: string;
  • Type: string
nameRequired 
public readonly name: string;
  • Type: string
projectKeyRequired 
public readonly projectKey: string;
  • Type: string
tagsRequired 
public readonly tags: string[];
  • Type: string[]
unboundedRequired 
public readonly unbounded: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
unboundedContextKindRequired 
public readonly unboundedContextKind: string;
  • Type: string

Constants

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

Structs

SegmentConfig

Initializer 

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

const segmentConfig: segment.SegmentConfig = { ... }

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.
envKey string The segment's environment key.
key string The unique key that references the segment.
name string The human-friendly name for the segment.
projectKey string The segment's project key.
description string The description of the segment's purpose.
excluded string[] List of user keys excluded from the segment.
excludedContexts cdktf.IResolvable | SegmentExcludedContexts[] excluded_contexts block.
id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/launchdarkly/launchdarkly/2.24.0/docs/resources/segment#id Segment#id}.
included string[] List of user keys included in the segment.
includedContexts cdktf.IResolvable | SegmentIncludedContexts[] included_contexts block.
rules cdktf.IResolvable | SegmentRules[] rules block.
tags string[] Tags associated with your resource.
unbounded boolean | cdktf.IResolvable Whether to create a standard segment (false) or a Big Segment (true).
unboundedContextKind string For Big Segments, the targeted context kind.
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[]
envKeyRequired 
public readonly envKey: string;
  • Type: string

The segment's environment 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/segment#env_key Segment#env_key}

keyRequired 
public readonly key: string;
  • Type: string

The unique key that references the segment.

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/segment#key Segment#key}

nameRequired 
public readonly name: string;
  • Type: string

The human-friendly name for the segment.

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

projectKeyRequired 
public readonly projectKey: string;
  • Type: string

The segment'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/segment#project_key Segment#project_key}

descriptionOptional 
public readonly description: string;
  • Type: string

The description of the segment's purpose.

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

excludedOptional 
public readonly excluded: string[];
  • Type: string[]

List of user keys excluded from the segment.

To target on other context kinds, use the excluded_contexts block attribute. This attribute is not valid when unbounded is set to true.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/launchdarkly/launchdarkly/2.24.0/docs/resources/segment#excluded Segment#excluded}

excludedContextsOptional 
public readonly excludedContexts: IResolvable | SegmentExcludedContexts[];

excluded_contexts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/launchdarkly/launchdarkly/2.24.0/docs/resources/segment#excluded_contexts Segment#excluded_contexts}

idOptional 
public readonly id: string;
  • Type: string

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

includedOptional 
public readonly included: string[];
  • Type: string[]

List of user keys included in the segment.

To target on other context kinds, use the included_contexts block attribute. This attribute is not valid when unbounded is set to true.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/launchdarkly/launchdarkly/2.24.0/docs/resources/segment#included Segment#included}

includedContextsOptional 
public readonly includedContexts: IResolvable | SegmentIncludedContexts[];

included_contexts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/launchdarkly/launchdarkly/2.24.0/docs/resources/segment#included_contexts Segment#included_contexts}

rulesOptional 
public readonly rules: IResolvable | SegmentRules[];

rules block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/launchdarkly/launchdarkly/2.24.0/docs/resources/segment#rules Segment#rules}

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/segment#tags Segment#tags}

unboundedOptional 
public readonly unbounded: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Whether to create a standard segment (false) or a Big Segment (true).

Standard segments include rule-based and smaller list-based segments. Big Segments include larger list-based segments and synced segments. Only use a Big Segment if you need to add more than 15,000 individual targets. It is not possible to manage the list of targeted contexts for Big Segments with Terraform. 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/segment#unbounded Segment#unbounded}

unboundedContextKindOptional 
public readonly unboundedContextKind: string;
  • Type: string

For Big Segments, the targeted context kind.

If this attribute is not specified it will default to user. 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/segment#unbounded_context_kind Segment#unbounded_context_kind}

SegmentExcludedContexts

Initializer 

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

const segmentExcludedContexts: segment.SegmentExcludedContexts = { ... }

Properties

Name Type Description
contextKind string The context kind associated with this segment target. To target on user contexts, use the included and excluded attributes.
values string[] List of target object keys included in or excluded from the segment.
contextKindRequired 
public readonly contextKind: string;
  • Type: string

The context kind associated with this segment target. To target on user contexts, use the included and excluded attributes.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/launchdarkly/launchdarkly/2.24.0/docs/resources/segment#context_kind Segment#context_kind}

valuesRequired 
public readonly values: string[];
  • Type: string[]

List of target object keys included in or excluded from the segment.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/launchdarkly/launchdarkly/2.24.0/docs/resources/segment#values Segment#values}

SegmentIncludedContexts

Initializer 

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

const segmentIncludedContexts: segment.SegmentIncludedContexts = { ... }

Properties

Name Type Description
contextKind string The context kind associated with this segment target. To target on user contexts, use the included and excluded attributes.
values string[] List of target object keys included in or excluded from the segment.
contextKindRequired 
public readonly contextKind: string;
  • Type: string

The context kind associated with this segment target. To target on user contexts, use the included and excluded attributes.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/launchdarkly/launchdarkly/2.24.0/docs/resources/segment#context_kind Segment#context_kind}

valuesRequired 
public readonly values: string[];
  • Type: string[]

List of target object keys included in or excluded from the segment.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/launchdarkly/launchdarkly/2.24.0/docs/resources/segment#values Segment#values}

SegmentRules

Initializer 

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

const segmentRules: segment.SegmentRules = { ... }

Properties

Name Type Description
bucketBy string The attribute by which to group contexts together.
clauses cdktf.IResolvable | SegmentRulesClauses[] clauses block.
rolloutContextKind string The context kind associated with this segment rule.
weight number The integer weight of the rule (between 1 and 100000).
bucketByOptional 
public readonly bucketBy: string;
  • Type: string

The attribute by which to group contexts together.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/launchdarkly/launchdarkly/2.24.0/docs/resources/segment#bucket_by Segment#bucket_by}

clausesOptional 
public readonly clauses: IResolvable | SegmentRulesClauses[];

clauses block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/launchdarkly/launchdarkly/2.24.0/docs/resources/segment#clauses Segment#clauses}

rolloutContextKindOptional 
public readonly rolloutContextKind: string;
  • Type: string

The context kind associated with this segment rule.

This argument is only valid if weight is also specified. If omitted, defaults to user.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/launchdarkly/launchdarkly/2.24.0/docs/resources/segment#rollout_context_kind Segment#rollout_context_kind}

weightOptional 
public readonly weight: number;
  • Type: number

The integer weight of the rule (between 1 and 100000).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/launchdarkly/launchdarkly/2.24.0/docs/resources/segment#weight Segment#weight}

SegmentRulesClauses

Initializer 

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

const segmentRulesClauses: segment.SegmentRulesClauses = { ... }

Properties

Name Type Description
attribute string The user attribute to operate on.
op string The operator associated with the rule clause.
values string[] The list of values associated with the rule clause.
contextKind string The context kind associated with this rule clause. If omitted, defaults to user.
negate boolean | cdktf.IResolvable Whether to negate the rule clause.
valueType string The type for each of the clause's values.
attributeRequired 
public readonly attribute: string;
  • Type: string

The user attribute to operate on.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/launchdarkly/launchdarkly/2.24.0/docs/resources/segment#attribute Segment#attribute}

opRequired 
public readonly op: string;
  • Type: string

The operator associated with the rule clause.

Available options are in, endsWith, startsWith, matches, contains, lessThan, lessThanOrEqual, greaterThanOrEqual, before, after, segmentMatch, semVerEqual, semVerLessThan, and semVerGreaterThan. Read LaunchDarkly's Operators documentation for more information.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/launchdarkly/launchdarkly/2.24.0/docs/resources/segment#op Segment#op}

valuesRequired 
public readonly values: string[];
  • Type: string[]

The list of values associated with the rule clause.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/launchdarkly/launchdarkly/2.24.0/docs/resources/segment#values Segment#values}

contextKindOptional 
public readonly contextKind: string;
  • Type: string

The context kind associated with this rule clause. If omitted, defaults to user.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/launchdarkly/launchdarkly/2.24.0/docs/resources/segment#context_kind Segment#context_kind}

negateOptional 
public readonly negate: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Whether to negate the rule clause.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/launchdarkly/launchdarkly/2.24.0/docs/resources/segment#negate Segment#negate}

valueTypeOptional 
public readonly valueType: string;
  • Type: string

The type for each of the clause's values.

Available types are boolean, string, and number. If omitted, value_type defaults to string.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/launchdarkly/launchdarkly/2.24.0/docs/resources/segment#value_type Segment#value_type}

Classes

SegmentExcludedContextsList

Initializers 

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

new segment.SegmentExcludedContextsList(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): SegmentExcludedContextsOutputReference
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 | SegmentExcludedContexts[] 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 | SegmentExcludedContexts[];

SegmentExcludedContextsOutputReference

Initializers 

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

new segment.SegmentExcludedContextsOutputReference(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.
contextKindInput string No description.
valuesInput string[] No description.
contextKind string No description.
values string[] No description.
internalValue cdktf.IResolvable | SegmentExcludedContexts 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
contextKindInputOptional 
public readonly contextKindInput: string;
  • Type: string
valuesInputOptional 
public readonly valuesInput: string[];
  • Type: string[]
contextKindRequired 
public readonly contextKind: string;
  • Type: string
valuesRequired 
public readonly values: string[];
  • Type: string[]
internalValueOptional 
public readonly internalValue: IResolvable | SegmentExcludedContexts;

SegmentIncludedContextsList

Initializers 

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

new segment.SegmentIncludedContextsList(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): SegmentIncludedContextsOutputReference
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 | SegmentIncludedContexts[] 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 | SegmentIncludedContexts[];

SegmentIncludedContextsOutputReference

Initializers 

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

new segment.SegmentIncludedContextsOutputReference(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.
contextKindInput string No description.
valuesInput string[] No description.
contextKind string No description.
values string[] No description.
internalValue cdktf.IResolvable | SegmentIncludedContexts 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
contextKindInputOptional 
public readonly contextKindInput: string;
  • Type: string
valuesInputOptional 
public readonly valuesInput: string[];
  • Type: string[]
contextKindRequired 
public readonly contextKind: string;
  • Type: string
valuesRequired 
public readonly values: string[];
  • Type: string[]
internalValueOptional 
public readonly internalValue: IResolvable | SegmentIncludedContexts;

SegmentRulesClausesList

Initializers 

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

new segment.SegmentRulesClausesList(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): SegmentRulesClausesOutputReference
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 | SegmentRulesClauses[] 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 | SegmentRulesClauses[];

SegmentRulesClausesOutputReference

Initializers 

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

new segment.SegmentRulesClausesOutputReference(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.
resetContextKind No description.
resetNegate No description.
resetValueType 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.

resetContextKind 
public resetContextKind(): void
resetNegate 
public resetNegate(): void
resetValueType 
public resetValueType(): 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.
attributeInput string No description.
contextKindInput string No description.
negateInput boolean | cdktf.IResolvable No description.
opInput string No description.
valuesInput string[] No description.
valueTypeInput string No description.
attribute string No description.
contextKind string No description.
negate boolean | cdktf.IResolvable No description.
op string No description.
values string[] No description.
valueType string No description.
internalValue cdktf.IResolvable | SegmentRulesClauses 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
attributeInputOptional 
public readonly attributeInput: string;
  • Type: string
contextKindInputOptional 
public readonly contextKindInput: string;
  • Type: string
negateInputOptional 
public readonly negateInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
opInputOptional 
public readonly opInput: string;
  • Type: string
valuesInputOptional 
public readonly valuesInput: string[];
  • Type: string[]
valueTypeInputOptional 
public readonly valueTypeInput: string;
  • Type: string
attributeRequired 
public readonly attribute: string;
  • Type: string
contextKindRequired 
public readonly contextKind: string;
  • Type: string
negateRequired 
public readonly negate: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
opRequired 
public readonly op: string;
  • Type: string
valuesRequired 
public readonly values: string[];
  • Type: string[]
valueTypeRequired 
public readonly valueType: string;
  • Type: string
internalValueOptional 
public readonly internalValue: IResolvable | SegmentRulesClauses;

SegmentRulesList

Initializers 

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

new segment.SegmentRulesList(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): SegmentRulesOutputReference
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 | SegmentRules[] 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 | SegmentRules[];

SegmentRulesOutputReference

Initializers 

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

new segment.SegmentRulesOutputReference(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.
putClauses No description.
resetBucketBy No description.
resetClauses No description.
resetRolloutContextKind No description.
resetWeight 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.

putClauses 
public putClauses(value: IResolvable | SegmentRulesClauses[]): void
valueRequired
resetBucketBy 
public resetBucketBy(): void
resetClauses 
public resetClauses(): void
resetRolloutContextKind 
public resetRolloutContextKind(): void
resetWeight 
public resetWeight(): 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.
clauses SegmentRulesClausesList No description.
bucketByInput string No description.
clausesInput cdktf.IResolvable | SegmentRulesClauses[] No description.
rolloutContextKindInput string No description.
weightInput number No description.
bucketBy string No description.
rolloutContextKind string No description.
weight number No description.
internalValue cdktf.IResolvable | SegmentRules 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
clausesRequired 
public readonly clauses: SegmentRulesClausesList;
bucketByInputOptional 
public readonly bucketByInput: string;
  • Type: string
clausesInputOptional 
public readonly clausesInput: IResolvable | SegmentRulesClauses[];
rolloutContextKindInputOptional 
public readonly rolloutContextKindInput: string;
  • Type: string
weightInputOptional 
public readonly weightInput: number;
  • Type: number
bucketByRequired 
public readonly bucketBy: string;
  • Type: string
rolloutContextKindRequired 
public readonly rolloutContextKind: string;
  • Type: string
weightRequired 
public readonly weight: number;
  • Type: number
internalValueOptional 
public readonly internalValue: IResolvable | SegmentRules;