com.hashicorp.cdktf

Class TerraformResource

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

com.hashicorp.cdktf.TerraformElement

com.hashicorp.cdktf.TerraformResource

All Implemented Interfaces:

IInterpolatingParent, ITerraformAddressable, ITerraformDependable, ITerraformResource, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.79.0 (build b22f628)",
           date="2023-04-14T14:24:19.201Z")
 @Stability(value=Experimental)
public class TerraformResource
extends TerraformElement
implements ITerraformResource, ITerraformDependable, IInterpolatingParent

Nested Class Summary

Nested Classes

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

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

software.amazon.jsii.JsiiObject.InitializationMode

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

ITerraformResource.Jsii$Default, ITerraformResource.Jsii$Proxy

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

ITerraformDependable.Jsii$Default, ITerraformDependable.Jsii$Proxy

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

IInterpolatingParent.Jsii$Default, IInterpolatingParent.Jsii$Proxy

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
	TerraformResource(software.constructs.Construct scope, String id, TerraformResourceConfig config)
protected	TerraformResource(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	TerraformResource(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
Map<String,Object>	getAnyMapAttribute(String terraformAttribute)
IResolvable	getBooleanAttribute(String terraformAttribute)
Map<String,Boolean>	getBooleanMapAttribute(String terraformAttribute)
Object	getConnection()
Object	getCount()
List<String>	getDependsOn()
ITerraformIterator	getForEach()
TerraformResourceLifecycle	getLifecycle()
List<String>	getListAttribute(String terraformAttribute)
Number	getNumberAttribute(String terraformAttribute)
List<Number>	getNumberListAttribute(String terraformAttribute)
Map<String,Number>	getNumberMapAttribute(String terraformAttribute)
TerraformProvider	getProvider()
List<Object>	getProvisioners()
String	getStringAttribute(String terraformAttribute)
Map<String,String>	getStringMapAttribute(String terraformAttribute)
TerraformProviderGeneratorMetadata	getTerraformGeneratorMetadata()
Map<String,Object>	getTerraformMetaArguments()
String	getTerraformResourceType()
IResolvable	interpolationForAttribute(String terraformAttribute)
static Boolean	isTerraformResource(Object x)
void	setConnection(SSHProvisionerConnection value)
void	setConnection(WinrmProvisionerConnection value)
void	setCount(Number value)
void	setCount(TerraformCount value)
void	setDependsOn(List<String> value)
void	setForEach(ITerraformIterator value)
void	setLifecycle(TerraformResourceLifecycle value)
void	setProvider(TerraformProvider value)
void	setProvisioners(List<Object> value)
protected Map<String,Object>	synthesizeAttributes()
Object	toMetadata()
Object	toTerraform() (experimental) Adds this resource to the terraform JSON output.

Methods inherited from class com.hashicorp.cdktf.TerraformElement

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

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

getFqn, getFriendlyUniqueId

Methods inherited from interface com.hashicorp.cdktf.ITerraformAddressable

getFqn

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

TerraformResource

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

TerraformResource

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

TerraformResource

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

Parameters:

scope - This parameter is required.

id - This parameter is required.

config - This parameter is required.

Method Detail

isTerraformResource

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

Parameters:

x - This parameter is required.

getAnyMapAttribute

@Stability(value=Experimental)
 @NotNull
public Map<String,Object> getAnyMapAttribute(@NotNull
                                                                                      String terraformAttribute)

Parameters:

terraformAttribute - This parameter is required.

getBooleanAttribute

@Stability(value=Experimental)
 @NotNull
public IResolvable getBooleanAttribute(@NotNull
                                                                                String terraformAttribute)

Parameters:

terraformAttribute - This parameter is required.

getBooleanMapAttribute

@Stability(value=Experimental)
 @NotNull
public Map<String,Boolean> getBooleanMapAttribute(@NotNull
                                                                                           String terraformAttribute)

Parameters:

terraformAttribute - This parameter is required.

getListAttribute

@Stability(value=Experimental)
 @NotNull
public List<String> getListAttribute(@NotNull
                                                                              String terraformAttribute)

Parameters:

terraformAttribute - This parameter is required.

getNumberAttribute

@Stability(value=Experimental)
 @NotNull
public Number getNumberAttribute(@NotNull
                                                                          String terraformAttribute)

Parameters:

terraformAttribute - This parameter is required.

getNumberListAttribute

@Stability(value=Experimental)
 @NotNull
public List<Number> getNumberListAttribute(@NotNull
                                                                                    String terraformAttribute)

Parameters:

terraformAttribute - This parameter is required.

getNumberMapAttribute

@Stability(value=Experimental)
 @NotNull
public Map<String,Number> getNumberMapAttribute(@NotNull
                                                                                         String terraformAttribute)

Parameters:

terraformAttribute - This parameter is required.

getStringAttribute

@Stability(value=Experimental)
 @NotNull
public String getStringAttribute(@NotNull
                                                                          String terraformAttribute)

Parameters:

terraformAttribute - This parameter is required.

getStringMapAttribute

@Stability(value=Experimental)
 @NotNull
public Map<String,String> getStringMapAttribute(@NotNull
                                                                                         String terraformAttribute)

Parameters:

terraformAttribute - This parameter is required.

interpolationForAttribute

@Stability(value=Experimental)
 @NotNull
public IResolvable interpolationForAttribute(@NotNull
                                                                                      String terraformAttribute)

Specified by:

interpolationForAttribute in interface IInterpolatingParent

Specified by:

interpolationForAttribute in interface ITerraformResource

Parameters:

terraformAttribute - This parameter is required.

synthesizeAttributes

@Stability(value=Experimental)
 @NotNull
protected Map<String,Object> synthesizeAttributes()

toMetadata

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

Overrides:

toMetadata in class TerraformElement

toTerraform

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

(experimental) Adds this resource to the terraform JSON output.

Overrides:

toTerraform in class TerraformElement

getTerraformMetaArguments

@Stability(value=Experimental)
 @NotNull
public Map<String,Object> getTerraformMetaArguments()

getTerraformResourceType

@Stability(value=Experimental)
 @NotNull
public String getTerraformResourceType()

Specified by:

getTerraformResourceType in interface ITerraformResource

getTerraformGeneratorMetadata

@Stability(value=Experimental)
 @Nullable
public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata()

getConnection

@Stability(value=Experimental)
 @Nullable
public Object getConnection()

setConnection

@Stability(value=Experimental)
public void setConnection(@Nullable
                                                         SSHProvisionerConnection value)

setConnection

@Stability(value=Experimental)
public void setConnection(@Nullable
                                                         WinrmProvisionerConnection value)

getCount

@Stability(value=Experimental)
 @Nullable
public Object getCount()

Specified by:

getCount in interface ITerraformResource

setCount

@Stability(value=Experimental)
public void setCount(@Nullable
                                                    Number value)

Specified by:

setCount in interface ITerraformResource

setCount

@Stability(value=Experimental)
public void setCount(@Nullable
                                                    TerraformCount value)

Specified by:

setCount in interface ITerraformResource

getDependsOn

@Stability(value=Experimental)
 @Nullable
public List<String> getDependsOn()

Specified by:

getDependsOn in interface ITerraformResource

setDependsOn

@Stability(value=Experimental)
public void setDependsOn(@Nullable
                                                        List<String> value)

Specified by:

setDependsOn in interface ITerraformResource

getForEach

@Stability(value=Experimental)
 @Nullable
public ITerraformIterator getForEach()

Specified by:

getForEach in interface ITerraformResource

setForEach

@Stability(value=Experimental)
public void setForEach(@Nullable
                                                      ITerraformIterator value)

Specified by:

setForEach in interface ITerraformResource

getLifecycle

@Stability(value=Experimental)
 @Nullable
public TerraformResourceLifecycle getLifecycle()

Specified by:

getLifecycle in interface ITerraformResource

setLifecycle

@Stability(value=Experimental)
public void setLifecycle(@Nullable
                                                        TerraformResourceLifecycle value)

Specified by:

setLifecycle in interface ITerraformResource

getProvider

@Stability(value=Experimental)
 @Nullable
public TerraformProvider getProvider()

Specified by:

getProvider in interface ITerraformResource

setProvider

@Stability(value=Experimental)
public void setProvider(@Nullable
                                                       TerraformProvider value)

Specified by:

setProvider in interface ITerraformResource

getProvisioners

@Stability(value=Experimental)
 @Nullable
public List<Object> getProvisioners()

setProvisioners

@Stability(value=Experimental)
public void setProvisioners(@Nullable
                                                           List<Object> value)