Package com.hashicorp.cdktf

Class TerraformStack

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

com.hashicorp.cdktf.TerraformStack

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.93.0 (build 1706ca5)",
           date="2024-01-15T15:38:01.174Z")
@Stability(Experimental)
public class TerraformStack
extends software.constructs.Construct

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	TerraformStack(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	TerraformStack(software.amazon.jsii.JsiiObjectRef objRef)
	TerraformStack(software.constructs.Construct scope, String id)

Method Summary

Modifier and Type	Method	Description
void	addDependency(TerraformStack dependency)
void	addOverride(String path, Object value)
protected String	allocateLogicalId(Object tfElement)	(experimental) Returns the naming scheme used to allocate logical IDs.
List<TerraformProvider>	allProviders()
Boolean	dependsOn(TerraformStack stack)
TerraformBackend	ensureBackendExists()
List<TerraformStack>	getDependencies()
String	getLogicalId(Object tfElement)
TerraformResourceTargets	getMoveTargets()
IStackSynthesizer	getSynthesizer()
Boolean	hasResourceMove()
static Boolean	isStack(Object x)
static TerraformStack	of(software.constructs.IConstruct construct)
void	prepareStack()
TerraformRemoteState	registerIncomingCrossStackReference(TerraformStack fromStack)
TerraformOutput	registerOutgoingCrossStackReference(String identifier)
void	runAllValidations()	(experimental) Run all validations on the stack.
void	setDependencies(List<TerraformStack> value)
void	setMoveTargets(TerraformResourceTargets value)
void	setSynthesizer(IStackSynthesizer value)
Map<String,Object>	toHclTerraform()
Object	toTerraform()

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

TerraformStack

protected TerraformStack(software.amazon.jsii.JsiiObjectRef objRef)

TerraformStack

protected TerraformStack(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

TerraformStack

@Stability(Experimental)
public TerraformStack(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Method Details

isStack

@Stability(Experimental)
@NotNull
public static Boolean isStack(@NotNull
 Object x)

Parameters:

x - This parameter is required.

of

@Stability(Experimental)
@NotNull
public static TerraformStack of(@NotNull
 software.constructs.IConstruct construct)

Parameters:

construct - This parameter is required.

addDependency

@Stability(Experimental)
public void addDependency(@NotNull
 TerraformStack dependency)

Parameters:

dependency - This parameter is required.

addOverride

@Stability(Experimental)
public void addOverride(@NotNull
 String path,
 @NotNull
 Object value)

Parameters:

path - This parameter is required.

value - This parameter is required.

allocateLogicalId

@Stability(Experimental)
@NotNull
protected String allocateLogicalId(@NotNull
 Object tfElement)

(experimental) Returns the naming scheme used to allocate logical IDs.

By default, uses the HashedAddressingScheme but this method can be overridden to customize this behavior.

Parameters:

tfElement - The element for which the logical ID is allocated. This parameter is required.

allProviders

@Stability(Experimental)
@NotNull
public List<TerraformProvider> allProviders()

dependsOn

@Stability(Experimental)
@NotNull
public Boolean dependsOn(@NotNull
 TerraformStack stack)

Parameters:

stack - This parameter is required.

ensureBackendExists

@Stability(Experimental)
@NotNull
public TerraformBackend ensureBackendExists()

getLogicalId

@Stability(Experimental)
@NotNull
public String getLogicalId(@NotNull
 Object tfElement)

Parameters:

tfElement - This parameter is required.

hasResourceMove

@Stability(Experimental)
@NotNull
public Boolean hasResourceMove()

prepareStack

@Stability(Experimental)
public void prepareStack()

registerIncomingCrossStackReference

@Stability(Experimental)
@NotNull
public TerraformRemoteState registerIncomingCrossStackReference(@NotNull
 TerraformStack fromStack)

Parameters:

fromStack - This parameter is required.

registerOutgoingCrossStackReference

@Stability(Experimental)
@NotNull
public TerraformOutput registerOutgoingCrossStackReference(@NotNull
 String identifier)

Parameters:

identifier - This parameter is required.

runAllValidations

@Stability(Experimental)
public void runAllValidations()

(experimental) Run all validations on the stack.

toHclTerraform

@Stability(Experimental)
@NotNull
public Map<String,Object> toHclTerraform()

toTerraform

@Stability(Experimental)
@NotNull
public Object toTerraform()

getDependencies

@Stability(Experimental)
@NotNull
public List<TerraformStack> getDependencies()

setDependencies

@Stability(Experimental)
public void setDependencies(@NotNull
 List<TerraformStack> value)

getMoveTargets

@Stability(Experimental)
@NotNull
public TerraformResourceTargets getMoveTargets()

setMoveTargets

@Stability(Experimental)
public void setMoveTargets(@NotNull
 TerraformResourceTargets value)

getSynthesizer

@Stability(Experimental)
@NotNull
public IStackSynthesizer getSynthesizer()

setSynthesizer

@Stability(Experimental)
public void setSynthesizer(@NotNull
 IStackSynthesizer value)