Typescript: TerraformStack - CDK Terrain (CDKTN)

Initializers

import { TerraformStack } from 'cdktn'

new TerraformStack(scope: Construct, id: string)

Name	Type	Description
`scope`	`constructs.Construct`	No description.
`id`	`string`	No description.

`scope`^Required

Type: constructs.Construct

`id`^Required

Type: string

Methods

Name	Description
`toString`	Returns a string representation of this construct.
`addDependency`	No description.
`addOverride`	No description.
`allProviders`	No description.
`dependsOn`	No description.
`ensureBackendExists`	No description.
`getLogicalId`	No description.
`hasResourceMove`	No description.
`prepareStack`	No description.
`registerIncomingCrossStackReference`	No description.
`registerOutgoingCrossStackReference`	No description.
`runAllValidations`	Run all validations on the stack.
`toHclTerraform`	No description.
`toTerraform`	No description.

`toString`

public toString(): string

Returns a string representation of this construct.

`addDependency`

public addDependency(dependency: TerraformStack): void

`dependency`^Required

Type: TerraformStack

`addOverride`

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

`path`^Required

Type: string

`value`^Required

Type: any

`allProviders`

public allProviders(): TerraformProvider[]

`dependsOn`

public dependsOn(stack: TerraformStack): boolean

`stack`^Required

Type: TerraformStack

`ensureBackendExists`

public ensureBackendExists(): TerraformBackend

`getLogicalId`

public getLogicalId(tfElement: Node | TerraformElement): string

`tfElement`^Required

Type: constructs.Node | TerraformElement

`hasResourceMove`

public hasResourceMove(): boolean

`prepareStack`

public prepareStack(): void

`registerIncomingCrossStackReference`

public registerIncomingCrossStackReference(fromStack: TerraformStack): TerraformRemoteState

`fromStack`^Required

Type: TerraformStack

`registerOutgoingCrossStackReference`

public registerOutgoingCrossStackReference(identifier: string): TerraformOutput

`identifier`^Required

Type: string

`runAllValidations`

public runAllValidations(): void

Run all validations on the stack.

`toHclTerraform`

public toHclTerraform(): {[ key: string ]: any}

`toTerraform`

public toTerraform(): any

Static Functions

Name	Description
`isConstruct`	Checks if `x` is a construct.
`isStack`	No description.
`of`	No description.

`isConstruct`

import { TerraformStack } from 'cdktn'

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

`isStack`

import { TerraformStack } from 'cdktn'

TerraformStack.isStack(x: any)

`x`^Required

Type: any

`of`

import { TerraformStack } from 'cdktn'

TerraformStack.of(construct: IConstruct)

`construct`^Required

Type: constructs.IConstruct

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.
`dependencies`	`TerraformStack[]`	No description.
`moveTargets`	`TerraformResourceTargets`	No description.
`synthesizer`	`IStackSynthesizer`	No description.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`dependencies`^Required

public readonly dependencies: TerraformStack[];

Type: TerraformStack[]

`moveTargets`^Required

public readonly moveTargets: TerraformResourceTargets;

Type: TerraformResourceTargets

`synthesizer`^Required

public readonly synthesizer: IStackSynthesizer;

Type: IStackSynthesizer

Overview

TypeScript

Python

Java

C#

Go

​Initializers

​scopeRequired

​idRequired

​Methods

​toString

​addDependency

​dependencyRequired

​addOverride

​pathRequired

​valueRequired

​allProviders

​dependsOn

​stackRequired

​ensureBackendExists

​getLogicalId

​tfElementRequired

​hasResourceMove

​prepareStack

​registerIncomingCrossStackReference

​fromStackRequired

​registerOutgoingCrossStackReference

​identifierRequired

​runAllValidations

​toHclTerraform

​toTerraform

​Static Functions

​isConstruct

​xRequired

​isStack

​xRequired

​of

​constructRequired

​Properties

​nodeRequired

​dependenciesRequired

​moveTargetsRequired

​synthesizerRequired

Initializers

`scope`^Required

`id`^Required

Methods

`toString`

`addDependency`

`dependency`^Required

`addOverride`

`path`^Required

`value`^Required

`allProviders`

`dependsOn`

`stack`^Required

`ensureBackendExists`

`getLogicalId`

`tfElement`^Required

`hasResourceMove`

`prepareStack`

`registerIncomingCrossStackReference`

`fromStack`^Required

`registerOutgoingCrossStackReference`

`identifier`^Required

`runAllValidations`

`toHclTerraform`

`toTerraform`

Static Functions

`isConstruct`

`x`^Required

`isStack`

`x`^Required

`of`

`construct`^Required

Properties

`node`^Required

`dependencies`^Required

`moveTargets`^Required

`synthesizer`^Required