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.77.0 (build 3e5fa88)",
           date="2023-04-05T14:53:11.995Z")
 @Stability(value=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 and Description
	TerraformStack(software.constructs.Construct scope, String id)
protected	TerraformStack(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	TerraformStack(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and 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)
IStackSynthesizer	getSynthesizer()
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	setSynthesizer(IStackSynthesizer value)
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 Detail

TerraformStack

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

TerraformStack

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

TerraformStack

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

Parameters:

scope - This parameter is required.

id - This parameter is required.

Method Detail

isStack

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

Parameters:

x - This parameter is required.

of

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

Parameters:

construct - This parameter is required.

addDependency

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

Parameters:

dependency - This parameter is required.

addOverride

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

Parameters:

path - This parameter is required.

value - This parameter is required.

allocateLogicalId

@Stability(value=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(value=Experimental)
 @NotNull
public List<TerraformProvider> allProviders()

dependsOn

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

Parameters:

stack - This parameter is required.

ensureBackendExists

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

getLogicalId

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

Parameters:

tfElement - This parameter is required.

prepareStack

@Stability(value=Experimental)
public void prepareStack()

registerIncomingCrossStackReference

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

Parameters:

fromStack - This parameter is required.

registerOutgoingCrossStackReference

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

Parameters:

identifier - This parameter is required.

runAllValidations

@Stability(value=Experimental)
public void runAllValidations()

(experimental) Run all validations on the stack.

toTerraform

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

getDependencies

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

setDependencies

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

getSynthesizer

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

setSynthesizer

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