com.hashicorp.cdktf.TerraformStack Maven / Gradle / Ivy
package com.hashicorp.cdktf;
/**
*/
@javax.annotation.Generated(value = "jsii-pacmak/1.98.0 (build 00b106d)", date = "2024-05-27T11:46:32.286Z")
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@software.amazon.jsii.Jsii(module = com.hashicorp.cdktf.$Module.class, fqn = "cdktf.TerraformStack")
public class TerraformStack extends software.constructs.Construct {
protected TerraformStack(final software.amazon.jsii.JsiiObjectRef objRef) {
super(objRef);
}
protected TerraformStack(final software.amazon.jsii.JsiiObject.InitializationMode initializationMode) {
super(initializationMode);
}
/**
* @param scope This parameter is required.
* @param id This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public TerraformStack(final @org.jetbrains.annotations.NotNull software.constructs.Construct scope, final @org.jetbrains.annotations.NotNull java.lang.String id) {
super(software.amazon.jsii.JsiiObject.InitializationMode.JSII);
software.amazon.jsii.JsiiEngine.getInstance().createNewObject(this, new Object[] { java.util.Objects.requireNonNull(scope, "scope is required"), java.util.Objects.requireNonNull(id, "id is required") });
}
/**
* @param x This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public static @org.jetbrains.annotations.NotNull java.lang.Boolean isStack(final @org.jetbrains.annotations.NotNull java.lang.Object x) {
return software.amazon.jsii.JsiiObject.jsiiStaticCall(com.hashicorp.cdktf.TerraformStack.class, "isStack", software.amazon.jsii.NativeType.forClass(java.lang.Boolean.class), new Object[] { x });
}
/**
* @param construct This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public static @org.jetbrains.annotations.NotNull com.hashicorp.cdktf.TerraformStack of(final @org.jetbrains.annotations.NotNull software.constructs.IConstruct construct) {
return software.amazon.jsii.JsiiObject.jsiiStaticCall(com.hashicorp.cdktf.TerraformStack.class, "of", software.amazon.jsii.NativeType.forClass(com.hashicorp.cdktf.TerraformStack.class), new Object[] { java.util.Objects.requireNonNull(construct, "construct is required") });
}
/**
* @param dependency This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public void addDependency(final @org.jetbrains.annotations.NotNull com.hashicorp.cdktf.TerraformStack dependency) {
software.amazon.jsii.Kernel.call(this, "addDependency", software.amazon.jsii.NativeType.VOID, new Object[] { java.util.Objects.requireNonNull(dependency, "dependency is required") });
}
/**
* @param path This parameter is required.
* @param value This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public void addOverride(final @org.jetbrains.annotations.NotNull java.lang.String path, final @org.jetbrains.annotations.NotNull java.lang.Object value) {
software.amazon.jsii.Kernel.call(this, "addOverride", software.amazon.jsii.NativeType.VOID, new Object[] { java.util.Objects.requireNonNull(path, "path is required"), value });
}
/**
* (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.
*
* @param tfElement The element for which the logical ID is allocated. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
protected @org.jetbrains.annotations.NotNull java.lang.String allocateLogicalId(final @org.jetbrains.annotations.NotNull java.lang.Object tfElement) {
if (software.amazon.jsii.Configuration.getRuntimeTypeChecking()) {
if (
!(tfElement instanceof software.constructs.Node)
&& !(tfElement instanceof com.hashicorp.cdktf.TerraformElement)
) {
throw new IllegalArgumentException(
new java.lang.StringBuilder("Expected ")
.append("tfElement")
.append(" to be one of: software.constructs.Node, com.hashicorp.cdktf.TerraformElement; received ")
.append(tfElement.getClass()).toString());
}
}
return software.amazon.jsii.Kernel.call(this, "allocateLogicalId", software.amazon.jsii.NativeType.forClass(java.lang.String.class), new Object[] { java.util.Objects.requireNonNull(tfElement, "tfElement is required") });
}
/**
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull java.util.List allProviders() {
return java.util.Collections.unmodifiableList(software.amazon.jsii.Kernel.call(this, "allProviders", software.amazon.jsii.NativeType.listOf(software.amazon.jsii.NativeType.forClass(com.hashicorp.cdktf.TerraformProvider.class))));
}
/**
* @param stack This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull java.lang.Boolean dependsOn(final @org.jetbrains.annotations.NotNull com.hashicorp.cdktf.TerraformStack stack) {
return software.amazon.jsii.Kernel.call(this, "dependsOn", software.amazon.jsii.NativeType.forClass(java.lang.Boolean.class), new Object[] { java.util.Objects.requireNonNull(stack, "stack is required") });
}
/**
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull com.hashicorp.cdktf.TerraformBackend ensureBackendExists() {
return software.amazon.jsii.Kernel.call(this, "ensureBackendExists", software.amazon.jsii.NativeType.forClass(com.hashicorp.cdktf.TerraformBackend.class));
}
/**
* @param tfElement This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull java.lang.String getLogicalId(final @org.jetbrains.annotations.NotNull java.lang.Object tfElement) {
if (software.amazon.jsii.Configuration.getRuntimeTypeChecking()) {
if (
!(tfElement instanceof software.constructs.Node)
&& !(tfElement instanceof com.hashicorp.cdktf.TerraformElement)
) {
throw new IllegalArgumentException(
new java.lang.StringBuilder("Expected ")
.append("tfElement")
.append(" to be one of: software.constructs.Node, com.hashicorp.cdktf.TerraformElement; received ")
.append(tfElement.getClass()).toString());
}
}
return software.amazon.jsii.Kernel.call(this, "getLogicalId", software.amazon.jsii.NativeType.forClass(java.lang.String.class), new Object[] { java.util.Objects.requireNonNull(tfElement, "tfElement is required") });
}
/**
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull java.lang.Boolean hasResourceMove() {
return software.amazon.jsii.Kernel.call(this, "hasResourceMove", software.amazon.jsii.NativeType.forClass(java.lang.Boolean.class));
}
/**
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public void prepareStack() {
software.amazon.jsii.Kernel.call(this, "prepareStack", software.amazon.jsii.NativeType.VOID);
}
/**
* @param fromStack This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull com.hashicorp.cdktf.TerraformRemoteState registerIncomingCrossStackReference(final @org.jetbrains.annotations.NotNull com.hashicorp.cdktf.TerraformStack fromStack) {
return software.amazon.jsii.Kernel.call(this, "registerIncomingCrossStackReference", software.amazon.jsii.NativeType.forClass(com.hashicorp.cdktf.TerraformRemoteState.class), new Object[] { java.util.Objects.requireNonNull(fromStack, "fromStack is required") });
}
/**
* @param identifier This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull com.hashicorp.cdktf.TerraformOutput registerOutgoingCrossStackReference(final @org.jetbrains.annotations.NotNull java.lang.String identifier) {
return software.amazon.jsii.Kernel.call(this, "registerOutgoingCrossStackReference", software.amazon.jsii.NativeType.forClass(com.hashicorp.cdktf.TerraformOutput.class), new Object[] { java.util.Objects.requireNonNull(identifier, "identifier is required") });
}
/**
* (experimental) Run all validations on the stack.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public void runAllValidations() {
software.amazon.jsii.Kernel.call(this, "runAllValidations", software.amazon.jsii.NativeType.VOID);
}
/**
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull java.util.Map toHclTerraform() {
return java.util.Collections.unmodifiableMap(software.amazon.jsii.Kernel.call(this, "toHclTerraform", software.amazon.jsii.NativeType.mapOf(software.amazon.jsii.NativeType.forClass(java.lang.Object.class))));
}
/**
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull java.lang.Object toTerraform() {
return software.amazon.jsii.Kernel.call(this, "toTerraform", software.amazon.jsii.NativeType.forClass(java.lang.Object.class));
}
/**
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull java.util.List getDependencies() {
return java.util.Collections.unmodifiableList(software.amazon.jsii.Kernel.get(this, "dependencies", software.amazon.jsii.NativeType.listOf(software.amazon.jsii.NativeType.forClass(com.hashicorp.cdktf.TerraformStack.class))));
}
/**
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public void setDependencies(final @org.jetbrains.annotations.NotNull java.util.List value) {
software.amazon.jsii.Kernel.set(this, "dependencies", java.util.Objects.requireNonNull(value, "dependencies is required"));
}
/**
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull com.hashicorp.cdktf.TerraformResourceTargets getMoveTargets() {
return software.amazon.jsii.Kernel.get(this, "moveTargets", software.amazon.jsii.NativeType.forClass(com.hashicorp.cdktf.TerraformResourceTargets.class));
}
/**
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public void setMoveTargets(final @org.jetbrains.annotations.NotNull com.hashicorp.cdktf.TerraformResourceTargets value) {
software.amazon.jsii.Kernel.set(this, "moveTargets", java.util.Objects.requireNonNull(value, "moveTargets is required"));
}
/**
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull com.hashicorp.cdktf.IStackSynthesizer getSynthesizer() {
return software.amazon.jsii.Kernel.get(this, "synthesizer", software.amazon.jsii.NativeType.forClass(com.hashicorp.cdktf.IStackSynthesizer.class));
}
/**
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public void setSynthesizer(final @org.jetbrains.annotations.NotNull com.hashicorp.cdktf.IStackSynthesizer value) {
software.amazon.jsii.Kernel.set(this, "synthesizer", java.util.Objects.requireNonNull(value, "synthesizer is required"));
}
}