Typescript: Classes

Annotations

Includes API for attaching annotations such as warning messages to constructs.

Methods

addError

public addError(message: string): void

Adds an { "error": < message > } metadata entry to this construct.

The toolkit will fail synthesis when errors are reported.

message^Required

• Type: string

The error message.

addInfo

public addInfo(message: string): void

Adds an info metadata entry to this construct.

The CLI will display the info message when apps are synthesized.

message^Required

• Type: string

The info message.

addWarning

public addWarning(message: string): void

Adds a warning metadata entry to this construct.

The CLI will display the warning when an app is synthesized. In a future release the CLI might introduce a --strict flag which will then fail the synthesis if it encounters a warning.

message^Required

• Type: string

The warning message.

Static Functions

of

import { Annotations } from 'cdktf'

Annotations.of(scope: IConstruct)

Returns the annotations API for a construct scope.

scope^Required

• Type: constructs.IConstruct

The scope.

AnyListList

Initializers

import { AnyListList } from 'cdktf'

new AnyListList(terraformResource: IInterpolatingParent, terraformAttribute: string, wrapsSet: boolean)

terraformResource^Required

• Type: IInterpolatingParent

terraformAttribute^Required

• Type: string

wrapsSet^Required

• Type: boolean

Methods

allWithMapKey

public allWithMapKey(mapKeyAttributeName: string): DynamicListTerraformIterator

Creating an iterator for this complex list.

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

mapKeyAttributeName^Required

• Type: string

computeFqn

public computeFqn(): string

resolve

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_context^Required

• Type: IResolveContext

toString

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

get

public get(index: number): IResolvable

index^Required

• Type: number

Properties

creationStack^Required

public readonly creationStack: string[];

• Type: string[]

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

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

fqn^Required

public readonly fqn: string;

• Type: string

AnyListMap

Initializers

import { AnyListMap } from 'cdktf'

new AnyListMap(terraformResource: IInterpolatingParent, terraformAttribute: string)

terraformResource^Required

• Type: IInterpolatingParent

terraformAttribute^Required

• Type: string

Methods

computeFqn

public computeFqn(): string

interpolationForAttribute

public interpolationForAttribute(property: string): IResolvable

property^Required

• Type: string

resolve

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_context^Required

• Type: IResolveContext

toString

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

get

public get(key: string): IResolvable

key^Required

• Type: string

Properties

creationStack^Required

public readonly creationStack: string[];

• Type: string[]

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

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

fqn^Required

public readonly fqn: string;

• Type: string

AnyMap

• Implements: ITerraformAddressable, IResolvable

Initializers

import { AnyMap } from 'cdktf'

new AnyMap(terraformResource: IInterpolatingParent, terraformAttribute: string)

terraformResource^Required

• Type: IInterpolatingParent

terraformAttribute^Required

• Type: string

Methods

computeFqn

public computeFqn(): string

lookup

public lookup(key: string): any

key^Required

• Type: string

resolve

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_context^Required

• Type: IResolveContext

toString

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

Properties

creationStack^Required

public readonly creationStack: string[];

• Type: string[]

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

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

fqn^Required

public readonly fqn: string;

• Type: string

AnyMapList

Initializers

import { AnyMapList } from 'cdktf'

new AnyMapList(terraformResource: IInterpolatingParent, terraformAttribute: string, wrapsSet: boolean)

terraformResource^Required

• Type: IInterpolatingParent

terraformAttribute^Required

• Type: string

wrapsSet^Required

• Type: boolean

Methods

computeFqn

public computeFqn(): string

interpolationForAttribute

public interpolationForAttribute(property: string): IResolvable

property^Required

• Type: string

resolve

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_context^Required

• Type: IResolveContext

toString

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

get

public get(index: number): AnyMap

index^Required

• Type: number

Properties

creationStack^Required

public readonly creationStack: string[];

• Type: string[]

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

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

fqn^Required

public readonly fqn: string;

• Type: string

Aspects

Aspects can be applied to CDK tree scopes and can operate on the tree before synthesis.

Methods

add

public add(aspect: IAspect): void

Adds an aspect to apply this scope before synthesis.

aspect^Required

• Type: IAspect

The aspect to add.

Static Functions

of

import { Aspects } from 'cdktf'

Aspects.of(scope: IConstruct)

Returns the Aspects object associated with a construct scope.

scope^Required

• Type: constructs.IConstruct

The scope for which these aspects will apply.

Properties

all^Required

public readonly all: IAspect[];

• Type: IAspect[]

The list of aspects which were directly applied on this scope.

AssertionReturn

Class representing the contents of a return by an assertion.

Initializers

import { testingMatchers } from 'cdktf'

new testingMatchers.AssertionReturn(message: string, pass: boolean)

message^Required

• Type: string

String message containing information about the result of the assertion.

pass^Required

• Type: boolean

Boolean pass denoting the success of the assertion.

Properties

message^Required

public readonly message: string;

• Type: string

String message containing information about the result of the assertion.

pass^Required

public readonly pass: boolean;

• Type: boolean

Boolean pass denoting the success of the assertion.

BooleanList

Initializers

import { BooleanList } from 'cdktf'

new BooleanList(terraformResource: IInterpolatingParent, terraformAttribute: string, wrapsSet: boolean)

terraformResource^Required

• Type: IInterpolatingParent

terraformAttribute^Required

• Type: string

wrapsSet^Required

• Type: boolean

Methods

allWithMapKey

public allWithMapKey(mapKeyAttributeName: string): DynamicListTerraformIterator

Creating an iterator for this complex list.

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

mapKeyAttributeName^Required

• Type: string

computeFqn

public computeFqn(): string

resolve

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_context^Required

• Type: IResolveContext

toString

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

get

public get(index: number): IResolvable

index^Required

• Type: number

Properties

creationStack^Required

public readonly creationStack: string[];

• Type: string[]

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

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

fqn^Required

public readonly fqn: string;

• Type: string

BooleanListList

Initializers

import { BooleanListList } from 'cdktf'

new BooleanListList(terraformResource: IInterpolatingParent, terraformAttribute: string, wrapsSet: boolean)

terraformResource^Required

• Type: IInterpolatingParent

terraformAttribute^Required

• Type: string

wrapsSet^Required

• Type: boolean

Methods

allWithMapKey

public allWithMapKey(mapKeyAttributeName: string): DynamicListTerraformIterator

Creating an iterator for this complex list.

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

mapKeyAttributeName^Required

• Type: string

computeFqn

public computeFqn(): string

resolve

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_context^Required

• Type: IResolveContext

toString

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

get

public get(index: number): IResolvable

index^Required

• Type: number

Properties

creationStack^Required

public readonly creationStack: string[];

• Type: string[]

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

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

fqn^Required

public readonly fqn: string;

• Type: string

BooleanListMap

Initializers

import { BooleanListMap } from 'cdktf'

new BooleanListMap(terraformResource: IInterpolatingParent, terraformAttribute: string)

terraformResource^Required

• Type: IInterpolatingParent

terraformAttribute^Required

• Type: string

Methods

computeFqn

public computeFqn(): string

interpolationForAttribute

public interpolationForAttribute(property: string): IResolvable

property^Required

• Type: string

resolve

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_context^Required

• Type: IResolveContext

toString

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

get

public get(key: string): IResolvable

key^Required

• Type: string

Properties

creationStack^Required

public readonly creationStack: string[];

• Type: string[]

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

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

fqn^Required

public readonly fqn: string;

• Type: string

BooleanMap

• Implements: ITerraformAddressable, IResolvable

Initializers

import { BooleanMap } from 'cdktf'

new BooleanMap(terraformResource: IInterpolatingParent, terraformAttribute: string)

terraformResource^Required

• Type: IInterpolatingParent

terraformAttribute^Required

• Type: string

Methods

computeFqn

public computeFqn(): string

lookup

public lookup(key: string): IResolvable

key^Required

• Type: string

resolve

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_context^Required

• Type: IResolveContext

toString

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

Properties

creationStack^Required

public readonly creationStack: string[];

• Type: string[]

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

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

fqn^Required

public readonly fqn: string;

• Type: string

BooleanMapList

Initializers

import { BooleanMapList } from 'cdktf'

new BooleanMapList(terraformResource: IInterpolatingParent, terraformAttribute: string, wrapsSet: boolean)

terraformResource^Required

• Type: IInterpolatingParent

terraformAttribute^Required

• Type: string

wrapsSet^Required

• Type: boolean

Methods

computeFqn

public computeFqn(): string

interpolationForAttribute

public interpolationForAttribute(property: string): IResolvable

property^Required

• Type: string

resolve

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_context^Required

• Type: IResolveContext

toString

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

get

public get(index: number): BooleanMap

index^Required

• Type: number

Properties

creationStack^Required

public readonly creationStack: string[];

• Type: string[]

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

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

fqn^Required

public readonly fqn: string;

• Type: string

CloudWorkspace

A cloud workspace can either be a single named workspace, or a list of tagged workspaces.

Initializers

import { CloudWorkspace } from "cdktf";

new CloudWorkspace();

Methods

toTerraform

public toTerraform(): any

ComplexComputedList

• Implements: IInterpolatingParent, IResolvable, ITerraformAddressable

Initializers

import { ComplexComputedList } from 'cdktf'

new ComplexComputedList(terraformResource: IInterpolatingParent, terraformAttribute: string, complexComputedListIndex: string, wrapsSet?: boolean)

terraformResource^Required

• Type: IInterpolatingParent

terraformAttribute^Required

• Type: string

complexComputedListIndex^Required

• Type: string

wrapsSet^Optional

• Type: boolean

Methods

computeFqn

public computeFqn(): string

getAnyMapAttribute

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

terraformAttribute^Required

• Type: string

getBooleanAttribute

public getBooleanAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

getBooleanMapAttribute

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

terraformAttribute^Required

• Type: string

getListAttribute

public getListAttribute(terraformAttribute: string): string[]

terraformAttribute^Required

• Type: string

getNumberAttribute

public getNumberAttribute(terraformAttribute: string): number

terraformAttribute^Required

• Type: string

getNumberListAttribute

public getNumberListAttribute(terraformAttribute: string): number[]

terraformAttribute^Required

• Type: string

getNumberMapAttribute

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

terraformAttribute^Required

• Type: string

getStringAttribute

public getStringAttribute(terraformAttribute: string): string

terraformAttribute^Required

• Type: string

getStringMapAttribute

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

terraformAttribute^Required

• Type: string

interpolationForAttribute

public interpolationForAttribute(property: string): IResolvable

property^Required

• Type: string

resolve

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_context^Required

• Type: IResolveContext

toString

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

Properties

creationStack^Required

• Deprecated: Going to be replaced by Array of ComplexListItem and will be removed in the future

public readonly creationStack: string[];

• Type: string[]

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

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

fqn^Required

• Deprecated: Going to be replaced by Array of ComplexListItem and will be removed in the future

public readonly fqn: string;

• Type: string

ComplexList

• Implements: ITerraformAddressable, IResolvable

Initializers

import { ComplexList } from 'cdktf'

new ComplexList(terraformResource: IInterpolatingParent, terraformAttribute: string, wrapsSet: boolean)

terraformResource^Required

• Type: IInterpolatingParent

terraformAttribute^Required

• Type: string

wrapsSet^Required

• Type: boolean

Methods

allWithMapKey

public allWithMapKey(mapKeyAttributeName: string): DynamicListTerraformIterator

Creating an iterator for this complex list.

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

mapKeyAttributeName^Required

• Type: string

computeFqn

public computeFqn(): string

resolve

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_context^Required

• Type: IResolveContext

toString

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

Properties

creationStack^Required

public readonly creationStack: string[];

• Type: string[]

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

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

fqn^Required

public readonly fqn: string;

• Type: string

ComplexMap

• Implements: ITerraformAddressable, IResolvable

Initializers

import { ComplexMap } from 'cdktf'

new ComplexMap(terraformResource: IInterpolatingParent, terraformAttribute: string)

terraformResource^Required

• Type: IInterpolatingParent

terraformAttribute^Required

• Type: string

Methods

computeFqn

public computeFqn(): string

interpolationForAttribute

public interpolationForAttribute(property: string): IResolvable

property^Required

• Type: string

resolve

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_context^Required

• Type: IResolveContext

toString

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

Properties

creationStack^Required

public readonly creationStack: string[];

• Type: string[]

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

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

fqn^Required

public readonly fqn: string;

• Type: string

ComplexObject

• Implements: IInterpolatingParent, IResolvable, ITerraformAddressable

Initializers

import { ComplexObject } from 'cdktf'

new ComplexObject(terraformResource: IInterpolatingParent, terraformAttribute: string, complexObjectIsFromSet: boolean, complexObjectIndex?: string | number)

terraformResource^Required

• Type: IInterpolatingParent

terraformAttribute^Required

• Type: string

complexObjectIsFromSet^Required

• Type: boolean

set to true if this item is from inside a set and needs tolist() for accessing it set to "0" for single list items.

complexObjectIndex^Optional

• Type: string | number

the index of the complex object in a list.

Methods

computeFqn

public computeFqn(): string

getAnyMapAttribute

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

terraformAttribute^Required

• Type: string

getBooleanAttribute

public getBooleanAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

getBooleanMapAttribute

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

terraformAttribute^Required

• Type: string

getListAttribute

public getListAttribute(terraformAttribute: string): string[]

terraformAttribute^Required

• Type: string

getNumberAttribute

public getNumberAttribute(terraformAttribute: string): number

terraformAttribute^Required

• Type: string

getNumberListAttribute

public getNumberListAttribute(terraformAttribute: string): number[]

terraformAttribute^Required

• Type: string

getNumberMapAttribute

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

terraformAttribute^Required

• Type: string

getStringAttribute

public getStringAttribute(terraformAttribute: string): string

terraformAttribute^Required

• Type: string

getStringMapAttribute

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

terraformAttribute^Required

• Type: string

interpolationForAttribute

public interpolationForAttribute(property: string): IResolvable

property^Required

• Type: string

resolve

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_context^Required

• Type: IResolveContext

toString

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

Properties

creationStack^Required

public readonly creationStack: string[];

• Type: string[]

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

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

fqn^Required

public readonly fqn: string;

• Type: string

DefaultTokenResolver

• Implements: ITokenResolver

Default resolver implementation.

Initializers

import { DefaultTokenResolver } from 'cdktf'

new DefaultTokenResolver(concat: IFragmentConcatenator)

concat^Required

• Type: IFragmentConcatenator

Methods

resolveList

public resolveList(xs: string[], context: IResolveContext): any

Resolves a list of string.

xs^Required

• Type: string[]

context^Required

• Type: IResolveContext

resolveMap

public resolveMap(xs: {[ key: string ]: any}, context: IResolveContext): any

Resolves a map token.

xs^Required

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

context^Required

• Type: IResolveContext

resolveNumberList

public resolveNumberList(xs: number[], context: IResolveContext): any

Resolves a list of numbers.

xs^Required

• Type: number[]

context^Required

• Type: IResolveContext

resolveString

public resolveString(fragments: TokenizedStringFragments, context: IResolveContext): any

Resolve string fragments to Tokens.

fragments^Required

• Type: TokenizedStringFragments

context^Required

• Type: IResolveContext

resolveToken

public resolveToken(t: IResolvable, context: IResolveContext, postProcessor: IPostProcessor): any

Default Token resolution.

Resolve the Token, recurse into whatever it returns, then finally post-process it.

t^Required

• Type: IResolvable

context^Required

• Type: IResolveContext

postProcessor^Required

• Type: IPostProcessor

DynamicListTerraformIterator

Initializers

import { DynamicListTerraformIterator } from 'cdktf'

new DynamicListTerraformIterator(list: string[] | IResolvable | number[] | boolean | IResolvable[], mapKeyAttributeName: string)

list^Required

• Type: string[] | IResolvable | number[] | boolean | IResolvable[]

mapKeyAttributeName^Required

• Type: string

Methods

dynamic

public dynamic(attributes: {[ key: string ]: any}): IResolvable

Creates a dynamic expression that can be used to loop over this iterator in a dynamic block.

As this returns an IResolvable you might need to wrap the output in a Token, e.g. Token.asString. See https://developer.hashicorp.com/terraform/cdktf/concepts/iterators#using-iterators-for-list-attributes

attributes^Required

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

forExpressionForList

public forExpressionForList(expression: string | IResolvable): IResolvable

Creates a for expression that results in a list.

This method allows you to create every possible for expression, but requires more knowledge about Terraform's for expression syntax. For the most common use cases you can use keys(), values(), and pluckProperty() instead.

You may write any valid Terraform for each expression, e.g. TerraformIterator.fromList(myIteratorSourceVar).forExpressionForList("val.foo if val.bar == true") will result in [ for key, val in var.myIteratorSource: val.foo if val.bar == true ].

As this returns an IResolvable you might need to wrap the output in a Token, e.g. Token.asString.

expression^Required

• Type: string | IResolvable

The expression to use in the for mapping.

forExpressionForMap

public forExpressionForMap(keyExpression: string | IResolvable, valueExpression: string | IResolvable): IResolvable

Creates a for expression that results in a map.

This method allows you to create every possible for expression, but requires more knowledge about Terraforms for expression syntax. For the most common use cases you can use keys(), values(), and pluckProperty instead.

You may write any valid Terraform for each expression, e.g. TerraformIterator.fromMap(myIteratorSourceVar).forExpressionForMap("key", "val.foo if val.bar == true") will result in { for key, val in var.myIteratorSource: key = > val.foo if val.bar == true }.

As this returns an IResolvable you might need to wrap the output in a Token, e.g. Token.asString.

keyExpression^Required

• Type: string | IResolvable

The expression to use as key in the for mapping.

valueExpression^Required

• Type: string | IResolvable

The expression to use as value in the for mapping.

getAny

public getAny(attribute: string): IResolvable

attribute^Required

• Type: string

name of the property to retrieve.

getAnyMap

public getAnyMap(attribute: string): {[ key: string ]: any}

attribute^Required

• Type: string

name of the property to retrieve.

getBoolean

public getBoolean(attribute: string): IResolvable

attribute^Required

• Type: string

name of the property to retrieve.

getBooleanMap

public getBooleanMap(attribute: string): {[ key: string ]: boolean}

attribute^Required

• Type: string

name of the property to retrieve.

getList

public getList(attribute: string): string[]

attribute^Required

• Type: string

name of the property to retrieve.

getMap

public getMap(attribute: string): {[ key: string ]: any}

attribute^Required

• Type: string

name of the property to retrieve.

getNumber

public getNumber(attribute: string): number

attribute^Required

• Type: string

name of the property to retrieve.

getNumberList

public getNumberList(attribute: string): number[]

attribute^Required

• Type: string

name of the property to retrieve.

getNumberMap

public getNumberMap(attribute: string): {[ key: string ]: number}

attribute^Required

• Type: string

name of the property to retrieve.

getString

public getString(attribute: string): string

attribute^Required

• Type: string

name of the property to retrieve.

getStringMap

public getStringMap(attribute: string): {[ key: string ]: string}

attribute^Required

• Type: string

name of the property to retrieve.

keys

public keys(): IResolvable

Creates a for expression that maps the iterators to its keys.

For lists these would be the indices, for maps the keys. As this returns an IResolvable you might need to wrap the output in a Token, e.g. Token.asString.

pluckProperty

public pluckProperty(property: string): IResolvable

Creates a for expression that accesses the key on each element of the iterator.

As this returns an IResolvable you might need to wrap the output in a Token, e.g. Token.asString.

property^Required

• Type: string

The property of the iterators values to map to.

values

public values(): IResolvable

Creates a for expression that maps the iterators to its value in case it is a map.

For lists these would stay the same. As this returns an IResolvable you might need to wrap the output in a Token, e.g. Token.asString.

Static Functions