API Reference for Typescript

Constructs

App

Represents a cdktf application.

Initializers

import { App } from 'cdktf'

new App(config?: AppConfig)

config^Optional

• Type: AppConfig

configuration.

Methods

toString

public toString(): string

Returns a string representation of this construct.

crossStackReference

public crossStackReference(fromStack: TerraformStack, toStack: TerraformStack, identifier: string): string

Creates a reference from one stack to another, invoked on prepareStack since it creates extra resources.

fromStack^Required

• Type: TerraformStack

toStack^Required

• Type: TerraformStack

identifier^Required

• Type: string

synth

public synth(): void

Synthesizes all resources to the output directory.

Static Functions

isConstruct

import { App } from 'cdktf'

App.isConstruct(x: any)

Checks if x is a construct.

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

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

x^Required

• Type: any

Any object.

isApp

import { App } from 'cdktf'

App.isApp(x: any)

x^Required

• Type: any

of

import { App } from 'cdktf'

App.of(construct: IConstruct)

construct^Required

• Type: constructs.IConstruct

Properties

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

manifest^Required

public readonly manifest: Manifest;

• Type: Manifest

outdir^Required

public readonly outdir: string;

• Type: string

The output directory into which resources will be synthesized.

skipBackendValidation^Required

public readonly skipBackendValidation: boolean;

• Type: boolean

Whether to skip backend validation during synthesis of the app.

skipValidation^Required

public readonly skipValidation: boolean;

• Type: boolean

Whether to skip all validations during synthesis of the app.

targetStackId^Optional

public readonly targetStackId: string;

• Type: string

The stack which will be synthesized.

If not set, all stacks will be synthesized.

ArtifactoryBackend

Initializers

import { ArtifactoryBackend } from 'cdktf'

new ArtifactoryBackend(scope: Construct, props: ArtifactoryBackendConfig)

scope^Required

• Type: constructs.Construct

props^Required

• Type: ArtifactoryBackendConfig

Methods

toString

public toString(): string

Returns a string representation of this construct.

addOverride

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

path^Required

• Type: string

value^Required

• Type: any

overrideLogicalId

public overrideLogicalId(newLogicalId: string): void

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

newLogicalId^Required

• Type: string

The new logical ID to use for this stack element.

resetOverrideLogicalId

public resetOverrideLogicalId(): void

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

toMetadata

public toMetadata(): any

toTerraform

public toTerraform(): any

Adds this resource to the terraform JSON output.

getRemoteStateDataSource

public getRemoteStateDataSource(scope: Construct, name: string, _fromStack: string): TerraformRemoteState

Creates a TerraformRemoteState resource that accesses this backend.

scope^Required

• Type: constructs.Construct

name^Required

• Type: string

_fromStack^Required

• Type: string

Static Functions

isConstruct

import { ArtifactoryBackend } from 'cdktf'

ArtifactoryBackend.isConstruct(x: any)

Checks if x is a construct.

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

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

x^Required

• Type: any

Any object.

isTerraformElement

import { ArtifactoryBackend } from 'cdktf'

ArtifactoryBackend.isTerraformElement(x: any)

x^Required

• Type: any

isBackend

import { ArtifactoryBackend } from 'cdktf'

ArtifactoryBackend.isBackend(x: any)

x^Required

• Type: any

Properties

node^Required

• Deprecated: CDK for Terraform no longer supports the artifactory backend. Terraform deprecated artifactory in v1.2.3 and removed it in v1.3.

public readonly node: Node;

• Type: constructs.Node

The tree node.

cdktfStack^Required

• Deprecated: CDK for Terraform no longer supports the artifactory backend. Terraform deprecated artifactory in v1.2.3 and removed it in v1.3.

public readonly cdktfStack: TerraformStack;

• Type: TerraformStack

fqn^Required

• Deprecated: CDK for Terraform no longer supports the artifactory backend. Terraform deprecated artifactory in v1.2.3 and removed it in v1.3.

public readonly fqn: string;

• Type: string

friendlyUniqueId^Required

• Deprecated: CDK for Terraform no longer supports the artifactory backend. Terraform deprecated artifactory in v1.2.3 and removed it in v1.3.

public readonly friendlyUniqueId: string;

• Type: string

AzurermBackend

Initializers

import { AzurermBackend } from 'cdktf'

new AzurermBackend(scope: Construct, props: AzurermBackendConfig)

scope^Required

• Type: constructs.Construct

props^Required

• Type: AzurermBackendConfig

Methods

toString

public toString(): string

Returns a string representation of this construct.

addOverride

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

path^Required

• Type: string

value^Required

• Type: any

overrideLogicalId

public overrideLogicalId(newLogicalId: string): void

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

newLogicalId^Required

• Type: string

The new logical ID to use for this stack element.

resetOverrideLogicalId

public resetOverrideLogicalId(): void

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

toMetadata

public toMetadata(): any

toTerraform

public toTerraform(): any

Adds this resource to the terraform JSON output.

getRemoteStateDataSource

public getRemoteStateDataSource(scope: Construct, name: string, _fromStack: string): TerraformRemoteState

Creates a TerraformRemoteState resource that accesses this backend.

scope^Required

• Type: constructs.Construct

name^Required

• Type: string

_fromStack^Required

• Type: string

Static Functions

isConstruct

import { AzurermBackend } from 'cdktf'

AzurermBackend.isConstruct(x: any)

Checks if x is a construct.

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

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

x^Required

• Type: any

Any object.

isTerraformElement

import { AzurermBackend } from 'cdktf'

AzurermBackend.isTerraformElement(x: any)

x^Required

• Type: any

isBackend

import { AzurermBackend } from 'cdktf'

AzurermBackend.isBackend(x: any)

x^Required

• Type: any

Properties

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

cdktfStack^Required

public readonly cdktfStack: TerraformStack;

• Type: TerraformStack

fqn^Required

public readonly fqn: string;

• Type: string

friendlyUniqueId^Required

public readonly friendlyUniqueId: string;

• Type: string

CloudBackend

The Cloud Backend synthesizes a {@link https://developer.hashicorp.com/terraform/cli/cloud/settings#the-cloud-block cloud block}. The cloud block is a nested block within the top-level terraform settings block. It specifies which Terraform Cloud workspaces to use for the current working directory. The cloud block only affects Terraform CLI's behavior. When Terraform Cloud uses a configuration that contains a cloud block - for example, when a workspace is configured to use a VCS provider directly - it ignores the block and behaves according to its own workspace settings.

Initializers

import { CloudBackend } from 'cdktf'

new CloudBackend(scope: Construct, props: CloudBackendConfig)

scope^Required

• Type: constructs.Construct

props^Required

• Type: CloudBackendConfig

Methods

toString

public toString(): string

Returns a string representation of this construct.

addOverride

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

path^Required

• Type: string

value^Required

• Type: any

overrideLogicalId

public overrideLogicalId(newLogicalId: string): void

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

newLogicalId^Required

• Type: string

The new logical ID to use for this stack element.

resetOverrideLogicalId

public resetOverrideLogicalId(): void

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

toMetadata

public toMetadata(): any

toTerraform

public toTerraform(): any

Adds this resource to the terraform JSON output.

getRemoteStateDataSource

public getRemoteStateDataSource(scope: Construct, name: string, _fromStack: string): TerraformRemoteState

Creates a TerraformRemoteState resource that accesses this backend.

scope^Required

• Type: constructs.Construct

name^Required

• Type: string

_fromStack^Required

• Type: string

Static Functions

isConstruct

import { CloudBackend } from 'cdktf'

CloudBackend.isConstruct(x: any)

Checks if x is a construct.

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

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

x^Required

• Type: any

Any object.

isTerraformElement

import { CloudBackend } from 'cdktf'

CloudBackend.isTerraformElement(x: any)

x^Required

• Type: any

isBackend

import { CloudBackend } from 'cdktf'

CloudBackend.isBackend(x: any)

x^Required

• Type: any

Properties

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

cdktfStack^Required

public readonly cdktfStack: TerraformStack;

• Type: TerraformStack

fqn^Required

public readonly fqn: string;

• Type: string

friendlyUniqueId^Required

public readonly friendlyUniqueId: string;

• Type: string

ConsulBackend

Initializers

import { ConsulBackend } from 'cdktf'

new ConsulBackend(scope: Construct, props: ConsulBackendConfig)

scope^Required

• Type: constructs.Construct

props^Required

• Type: ConsulBackendConfig

Methods

toString

public toString(): string

Returns a string representation of this construct.

addOverride

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

path^Required

• Type: string

value^Required

• Type: any

overrideLogicalId

public overrideLogicalId(newLogicalId: string): void

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

newLogicalId^Required

• Type: string

The new logical ID to use for this stack element.

resetOverrideLogicalId

public resetOverrideLogicalId(): void

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

toMetadata

public toMetadata(): any

toTerraform

public toTerraform(): any

Adds this resource to the terraform JSON output.

getRemoteStateDataSource

public getRemoteStateDataSource(scope: Construct, name: string, _fromStack: string): TerraformRemoteState

Creates a TerraformRemoteState resource that accesses this backend.

scope^Required

• Type: constructs.Construct

name^Required

• Type: string

_fromStack^Required

• Type: string

Static Functions

isConstruct

import { ConsulBackend } from 'cdktf'

ConsulBackend.isConstruct(x: any)

Checks if x is a construct.

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

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

x^Required

• Type: any

Any object.

isTerraformElement

import { ConsulBackend } from 'cdktf'

ConsulBackend.isTerraformElement(x: any)

x^Required

• Type: any

isBackend

import { ConsulBackend } from 'cdktf'

ConsulBackend.isBackend(x: any)

x^Required

• Type: any

Properties

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

cdktfStack^Required

public readonly cdktfStack: TerraformStack;

• Type: TerraformStack

fqn^Required

public readonly fqn: string;

• Type: string

friendlyUniqueId^Required

public readonly friendlyUniqueId: string;

• Type: string

CosBackend

Initializers

import { CosBackend } from 'cdktf'

new CosBackend(scope: Construct, props: CosBackendConfig)

scope^Required

• Type: constructs.Construct

props^Required

• Type: CosBackendConfig

Methods

toString

public toString(): string

Returns a string representation of this construct.

addOverride

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

path^Required

• Type: string

value^Required

• Type: any

overrideLogicalId

public overrideLogicalId(newLogicalId: string): void

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

newLogicalId^Required

• Type: string

The new logical ID to use for this stack element.

resetOverrideLogicalId

public resetOverrideLogicalId(): void

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

toMetadata

public toMetadata(): any

toTerraform

public toTerraform(): any

Adds this resource to the terraform JSON output.

getRemoteStateDataSource

public getRemoteStateDataSource(scope: Construct, name: string, _fromStack: string): TerraformRemoteState

Creates a TerraformRemoteState resource that accesses this backend.

scope^Required

• Type: constructs.Construct

name^Required

• Type: string

_fromStack^Required

• Type: string

Static Functions

isConstruct

import { CosBackend } from 'cdktf'

CosBackend.isConstruct(x: any)

Checks if x is a construct.

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

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

x^Required

• Type: any

Any object.

isTerraformElement

import { CosBackend } from 'cdktf'

CosBackend.isTerraformElement(x: any)

x^Required

• Type: any

isBackend

import { CosBackend } from 'cdktf'

CosBackend.isBackend(x: any)

x^Required

• Type: any

Properties

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

cdktfStack^Required

public readonly cdktfStack: TerraformStack;

• Type: TerraformStack

fqn^Required

public readonly fqn: string;

• Type: string

friendlyUniqueId^Required

public readonly friendlyUniqueId: string;

• Type: string

DataTerraformRemoteState

Initializers

import { DataTerraformRemoteState } from 'cdktf'

new DataTerraformRemoteState(scope: Construct, id: string, config: DataTerraformRemoteStateRemoteConfig)

scope^Required

• Type: constructs.Construct

id^Required

• Type: string

config^Required

• Type: DataTerraformRemoteStateRemoteConfig

Methods

toString

public toString(): string

Returns a string representation of this construct.

addOverride

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

path^Required

• Type: string

value^Required

• Type: any

overrideLogicalId

public overrideLogicalId(newLogicalId: string): void

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

newLogicalId^Required

• Type: string

The new logical ID to use for this stack element.

resetOverrideLogicalId

public resetOverrideLogicalId(): void

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

toMetadata

public toMetadata(): any

toTerraform

public toTerraform(): any

Adds this resource to the terraform JSON output.

get

public get(output: string): IResolvable

output^Required

• Type: string

getBoolean

public getBoolean(output: string): IResolvable

output^Required

• Type: string

getList

public getList(output: string): string[]

output^Required

• Type: string

getNumber

public getNumber(output: string): number

output^Required

• Type: string

getString

public getString(output: string): string

output^Required

• Type: string

Static Functions

isConstruct

import { DataTerraformRemoteState } from 'cdktf'

DataTerraformRemoteState.isConstruct(x: any)

Checks if x is a construct.

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

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

x^Required

• Type: any

Any object.

isTerraformElement

import { DataTerraformRemoteState } from 'cdktf'

DataTerraformRemoteState.isTerraformElement(x: any)

x^Required

• Type: any

Properties

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

cdktfStack^Required

public readonly cdktfStack: TerraformStack;

• Type: TerraformStack

fqn^Required

public readonly fqn: string;

• Type: string

friendlyUniqueId^Required

public readonly friendlyUniqueId: string;

• Type: string

Constants

tfResourceType^Required

public readonly tfResourceType: string;

• Type: string

DataTerraformRemoteStateArtifactory

Initializers

import { DataTerraformRemoteStateArtifactory } from 'cdktf'

new DataTerraformRemoteStateArtifactory(scope: Construct, id: string, config: DataTerraformRemoteStateArtifactoryConfig)

scope^Required

• Type: constructs.Construct

id^Required

• Type: string

config^Required

• Type: DataTerraformRemoteStateArtifactoryConfig

Methods

toString

public toString(): string

Returns a string representation of this construct.

addOverride

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

path^Required

• Type: string

value^Required

• Type: any

overrideLogicalId

public overrideLogicalId(newLogicalId: string): void

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

newLogicalId^Required

• Type: string

The new logical ID to use for this stack element.

resetOverrideLogicalId

public resetOverrideLogicalId(): void

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

toMetadata

public toMetadata(): any

toTerraform

public toTerraform(): any

Adds this resource to the terraform JSON output.

get

public get(output: string): IResolvable

output^Required

• Type: string

getBoolean

public getBoolean(output: string): IResolvable

output^Required

• Type: string

getList

public getList(output: string): string[]

output^Required

• Type: string

getNumber

public getNumber(output: string): number

output^Required

• Type: string

getString

public getString(output: string): string

output^Required

• Type: string

Static Functions

isConstruct

import { DataTerraformRemoteStateArtifactory } from 'cdktf'

DataTerraformRemoteStateArtifactory.isConstruct(x: any)

Checks if x is a construct.

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

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

x^Required

• Type: any

Any object.

isTerraformElement

import { DataTerraformRemoteStateArtifactory } from 'cdktf'

DataTerraformRemoteStateArtifactory.isTerraformElement(x: any)

x^Required

• Type: any

Properties

node^Required

• Deprecated: CDK for Terraform no longer supports the artifactory backend. Terraform deprecated artifactory in v1.2.3 and removed it in v1.3.

public readonly node: Node;

• Type: constructs.Node

The tree node.

cdktfStack^Required

• Deprecated: CDK for Terraform no longer supports the artifactory backend. Terraform deprecated artifactory in v1.2.3 and removed it in v1.3.

public readonly cdktfStack: TerraformStack;

• Type: TerraformStack

fqn^Required

• Deprecated: CDK for Terraform no longer supports the artifactory backend. Terraform deprecated artifactory in v1.2.3 and removed it in v1.3.

public readonly fqn: string;

• Type: string

friendlyUniqueId^Required

• Deprecated: CDK for Terraform no longer supports the artifactory backend. Terraform deprecated artifactory in v1.2.3 and removed it in v1.3.

public readonly friendlyUniqueId: string;

• Type: string

Constants

tfResourceType^Required

• Deprecated: CDK for Terraform no longer supports the artifactory backend. Terraform deprecated artifactory in v1.2.3 and removed it in v1.3.

public readonly tfResourceType: string;

• Type: string

DataTerraformRemoteStateAzurerm

Initializers

import { DataTerraformRemoteStateAzurerm } from 'cdktf'

new DataTerraformRemoteStateAzurerm(scope: Construct, id: string, config: DataTerraformRemoteStateAzurermConfig)

scope^Required

• Type: constructs.Construct

id^Required

• Type: string

config^Required

• Type: DataTerraformRemoteStateAzurermConfig

Methods

toString

public toString(): string

Returns a string representation of this construct.

addOverride

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

path^Required

• Type: string

value^Required

• Type: any

overrideLogicalId

public overrideLogicalId(newLogicalId: string): void

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

newLogicalId^Required

• Type: string

The new logical ID to use for this stack element.

resetOverrideLogicalId

public resetOverrideLogicalId(): void

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

toMetadata

public toMetadata(): any

toTerraform

public toTerraform(): any

Adds this resource to the terraform JSON output.

get

public get(output: string): IResolvable

output^Required

• Type: string

getBoolean

public getBoolean(output: string): IResolvable

output^Required

• Type: string

getList

public getList(output: string): string[]

output^Required

• Type: string

getNumber

public getNumber(output: string): number

output^Required

• Type: string

getString

public getString(output: string): string

output^Required

• Type: string

Static Functions

isConstruct

import { DataTerraformRemoteStateAzurerm } from 'cdktf'

DataTerraformRemoteStateAzurerm.isConstruct(x: any)

Checks if x is a construct.

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

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

x^Required

• Type: any

Any object.

isTerraformElement

import { DataTerraformRemoteStateAzurerm } from 'cdktf'

DataTerraformRemoteStateAzurerm.isTerraformElement(x: any)

x^Required

• Type: any

Properties

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

cdktfStack^Required

public readonly cdktfStack: TerraformStack;

• Type: TerraformStack

fqn^Required

public readonly fqn: string;