Package com.hashicorp.cdktf

Class TerraformVariable

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

com.hashicorp.cdktf.TerraformElement

com.hashicorp.cdktf.TerraformVariable

All Implemented Interfaces:

ITerraformAddressable, 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.176Z")
@Stability(Experimental)
public class TerraformVariable
extends TerraformElement
implements ITerraformAddressable

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	TerraformVariable.Builder	(experimental) A fluent builder for TerraformVariable.

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

Nested classes/interfaces inherited from interface com.hashicorp.cdktf.ITerraformAddressable

ITerraformAddressable.Jsii$Default, ITerraformAddressable.Jsii$Proxy

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	addValidation(TerraformVariableValidationConfig validation)
IResolvable	getBooleanValue()
Object	getDefaultValue()
String	getDescription()
List<String>	getListValue()
Boolean	getNullable()
Number	getNumberValue()
Boolean	getSensitive()
String	getStringValue()
String	getType()
List<TerraformVariableValidationConfig>	getValidation()
Object	getValue()
Map<String,Object>	synthesizeAttributes()
Map<String,Object>	synthesizeHclAttributes()
Object	toHclTerraform()
String	toString()	(experimental) Returns a string representation of this construct.
Object	toTerraform()

Methods inherited from class com.hashicorp.cdktf.TerraformElement

addOverride, getCdktfStack, getConstructNodeMetadata, getFqn, getFriendlyUniqueId, getRawOverrides, isTerraformElement, overrideLogicalId, resetOverrideLogicalId, toMetadata

Methods inherited from class software.constructs.Construct

getNode, isConstruct

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 com.hashicorp.cdktf.ITerraformAddressable

getFqn

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

TerraformVariable

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

TerraformVariable

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

TerraformVariable

@Stability(Experimental)
public TerraformVariable(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 TerraformVariableConfig config)

Parameters:

scope - This parameter is required.

id - This parameter is required.

config - This parameter is required.

Method Details

addValidation

@Stability(Experimental)
public void addValidation(@NotNull
 TerraformVariableValidationConfig validation)

Parameters:

validation - This parameter is required.

synthesizeAttributes

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

synthesizeHclAttributes

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

toHclTerraform

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

Overrides:

toHclTerraform in class TerraformElement

toString

@Stability(Experimental)
@NotNull
public String toString()

(experimental) Returns a string representation of this construct.

Overrides:

toString in class software.constructs.Construct

Returns:

a string token referencing the value of this variable

toTerraform

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

Overrides:

toTerraform in class TerraformElement

getBooleanValue

@Stability(Experimental)
@NotNull
public IResolvable getBooleanValue()

getListValue

@Stability(Experimental)
@NotNull
public List<String> getListValue()

getNumberValue

@Stability(Experimental)
@NotNull
public Number getNumberValue()

getStringValue

@Stability(Experimental)
@NotNull
public String getStringValue()

getValue

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

getDefaultValue

@Stability(Experimental)
@Nullable
public Object getDefaultValue()

getDescription

@Stability(Experimental)
@Nullable
public String getDescription()

getNullable

@Stability(Experimental)
@Nullable
public Boolean getNullable()

getSensitive

@Stability(Experimental)
@Nullable
public Boolean getSensitive()

getType

@Stability(Experimental)
@Nullable
public String getType()

getValidation

@Stability(Experimental)
@Nullable
public List<TerraformVariableValidationConfig> getValidation()