Documentation Index
Fetch the complete documentation index at: https://cdktn.io/docs/llms.txt
Use this file to discover all available pages before exploring further.
Initializers
import { TerraformStack } from 'cdktn'
new TerraformStack(scope: Construct, id: string)
| Name | Type | Description |
|---|
scope | constructs.Construct | No description. |
id | string | No description. |
scopeRequired
- Type: constructs.Construct
idRequired
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
addDependency
public addDependency(dependency: TerraformStack): void
dependencyRequired
addOverride
public addOverride(path: string, value: any): void
pathRequired
valueRequired
allProviders
public allProviders(): TerraformProvider[]
dependsOn
public dependsOn(stack: TerraformStack): boolean
stackRequired
ensureBackendExists
public ensureBackendExists(): TerraformBackend
getLogicalId
public getLogicalId(tfElement: Node | TerraformElement): string
tfElementRequired
hasResourceMove
public hasResourceMove(): boolean
prepareStack
public prepareStack(): void
registerIncomingCrossStackReference
public registerIncomingCrossStackReference(fromStack: TerraformStack): TerraformRemoteState
fromStackRequired
registerOutgoingCrossStackReference
public registerOutgoingCrossStackReference(identifier: string): TerraformOutput
identifierRequired
runAllValidations
public runAllValidations(): void
public toHclTerraform(): {[ key: string ]: any}
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)
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
Any object.
isStack
import { TerraformStack } from 'cdktn'
TerraformStack.isStack(x: any)
xRequired
import { TerraformStack } from 'cdktn'
TerraformStack.of(construct: IConstruct)
constructRequired
- 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. |
nodeRequired
public readonly node: Node;
dependenciesRequired
public readonly dependencies: TerraformStack[];
moveTargetsRequired
public readonly moveTargets: TerraformResourceTargets;
synthesizerRequired
public readonly synthesizer: IStackSynthesizer;
