Java: TerraformStack - CDK Terrain (CDKTN)

Initializers

import io.cdktn.cdktn.TerraformStack;

new TerraformStack(Construct scope, java.lang.String id);

Name	Type	Description
`scope`	`software.constructs.Construct`	No description.
`id`	`java.lang.String`	No description.

`scope`^Required

Type: software.constructs.Construct

`id`^Required

Type: java.lang.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 java.lang.String toString()

Returns a string representation of this construct.

`addDependency`

public void addDependency(TerraformStack dependency)

`dependency`^Required

Type: TerraformStack

`addOverride`

public void addOverride(java.lang.String path, java.lang.Object value)

`path`^Required

Type: java.lang.String

`value`^Required

Type: java.lang.Object

`allProviders`

public java.util.List<TerraformProvider> allProviders()

`dependsOn`

public java.lang.Boolean dependsOn(TerraformStack stack)

`stack`^Required

Type: TerraformStack

`ensureBackendExists`

public TerraformBackend ensureBackendExists()

`getLogicalId`

public java.lang.String getLogicalId(Node|TerraformElement tfElement)

`tfElement`^Required

Type: software.constructs.Node|TerraformElement

`hasResourceMove`

public java.lang.Boolean hasResourceMove()

`prepareStack`

public void prepareStack()

`registerIncomingCrossStackReference`

public TerraformRemoteState registerIncomingCrossStackReference(TerraformStack fromStack)

`fromStack`^Required

Type: TerraformStack

`registerOutgoingCrossStackReference`

public TerraformOutput registerOutgoingCrossStackReference(java.lang.String identifier)

`identifier`^Required

Type: java.lang.String

`runAllValidations`

public void runAllValidations()

Run all validations on the stack.

`toHclTerraform`

public java.util.Map<java.lang.String, java.lang.Object> toHclTerraform()

`toTerraform`

public java.lang.Object toTerraform()

Static Functions

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

`isConstruct`

import io.cdktn.cdktn.TerraformStack;

TerraformStack.isConstruct(java.lang.Object x)

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: java.lang.Object

Any object.

`isStack`

import io.cdktn.cdktn.TerraformStack;

TerraformStack.isStack(java.lang.Object x)

`x`^Required

Type: java.lang.Object

`of`

import io.cdktn.cdktn.TerraformStack;

TerraformStack.of(IConstruct construct)

`construct`^Required

Type: software.constructs.IConstruct

Properties

Name	Type	Description
`node`	`software.constructs.Node`	The tree node.
`dependencies`	`java.util.List<TerraformStack>`	No description.
`moveTargets`	`TerraformResourceTargets`	No description.
`synthesizer`	`IStackSynthesizer`	No description.

`node`^Required

public Node getNode();

Type: software.constructs.Node

The tree node.

`dependencies`^Required

public java.util.List<TerraformStack> getDependencies();

Type: java.util.List<TerraformStack>

`moveTargets`^Required

public TerraformResourceTargets getMoveTargets();

Type: TerraformResourceTargets

`synthesizer`^Required

public IStackSynthesizer getSynthesizer();

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