Package 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

Direct Known Subclasses:

DataResource

@Generated(value="jsii-pacmak/1.93.0 (build 1706ca5)",
           date="2024-02-05T09:47:54.031Z")
@Stability(Experimental)
public class TerraformResource
extends TerraformElement
implements ITerraformResource, ITerraformDependable, IInterpolatingParent

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final 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 software.constructs.IConstruct

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

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

IInterpolatingParent.Jsii$Default, IInterpolatingParent.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.ITerraformResource

ITerraformResource.Jsii$Default, ITerraformResource.Jsii$Proxy

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	addMoveTarget(String moveTarget)	(experimental) Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
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()
Object	hasResourceMove()
void	importFrom(String id)
void	importFrom(String id, TerraformProvider provider)
IResolvable	interpolationForAttribute(String terraformAttribute)
static Boolean	isTerraformResource(Object x)
void	moveFromId(String id)	(experimental) Move the resource corresponding to "id" to this resource.
void	moveTo(String moveTarget)	(experimental) Moves this resource to the target resource given by moveTarget.
void	moveTo(String moveTarget, Object index)	(experimental) Moves this resource to the target resource given by moveTarget.
void	moveToId(String id)	(experimental) Moves this resource to the resource corresponding to "id".
void	setConnection(SSHProvisionerConnection value)
void	setConnection(WinrmProvisionerConnection value)
void	setCount(TerraformCount value)
void	setCount(Number 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()
protected Map<String,Object>	synthesizeHclAttributes()
Object	toHclTerraform()
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.ITerraformAddressable

getFqn

Methods inherited from interface com.hashicorp.cdktf.ITerraformResource

getFqn, getFriendlyUniqueId

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

TerraformResource

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

TerraformResource

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

TerraformResource

@Stability(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 Details

isTerraformResource

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

Parameters:

x - This parameter is required.

addMoveTarget

@Stability(Experimental)
public void addMoveTarget(@NotNull
 String moveTarget)

(experimental) Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

Parameters:

moveTarget - The string move target that will correspond to this resource. This parameter is required.

getAnyMapAttribute

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

Parameters:

terraformAttribute - This parameter is required.

getBooleanAttribute

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

Parameters:

terraformAttribute - This parameter is required.

getBooleanMapAttribute

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

Parameters:

terraformAttribute - This parameter is required.

getListAttribute

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

Parameters:

terraformAttribute - This parameter is required.

getNumberAttribute

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

Parameters:

terraformAttribute - This parameter is required.

getNumberListAttribute

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

Parameters:

terraformAttribute - This parameter is required.

getNumberMapAttribute

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

Parameters:

terraformAttribute - This parameter is required.

getStringAttribute

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

Parameters:

terraformAttribute - This parameter is required.

getStringMapAttribute

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

Parameters:

terraformAttribute - This parameter is required.

hasResourceMove

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

importFrom

@Stability(Experimental)
public void importFrom(@NotNull
 String id,
 @Nullable
 TerraformProvider provider)

Parameters:

id - This parameter is required.

provider -

importFrom

@Stability(Experimental)
public void importFrom(@NotNull
 String id)

Parameters:

id - This parameter is required.

interpolationForAttribute

@Stability(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.

moveFromId

@Stability(Experimental)
public void moveFromId(@NotNull
 String id)

(experimental) Move the resource corresponding to "id" to this resource.

Note that the resource being moved from must be marked as moved using it's instance function.

Parameters:

id - Full id of resource being moved from, e.g. "aws_s3_bucket.example". This parameter is required.

moveTo

@Stability(Experimental)
public void moveTo(@NotNull
 String moveTarget,
 @Nullable
 Object index)

(experimental) Moves this resource to the target resource given by moveTarget.

Parameters:

moveTarget - The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. This parameter is required.

index - Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.

moveTo

@Stability(Experimental)
public void moveTo(@NotNull
 String moveTarget)

(experimental) Moves this resource to the target resource given by moveTarget.

Parameters:

moveTarget - The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. This parameter is required.

moveToId

@Stability(Experimental)
public void moveToId(@NotNull
 String id)

(experimental) Moves this resource to the resource corresponding to "id".

Parameters:

id - Full id of resource to move to, e.g. "aws_s3_bucket.example". This parameter is required.

synthesizeAttributes

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

synthesizeHclAttributes

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

toHclTerraform

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

Overrides:

toHclTerraform in class TerraformElement

toMetadata

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

Overrides:

toMetadata in class TerraformElement

toTerraform

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

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

Overrides:

toTerraform in class TerraformElement

getTerraformMetaArguments

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

getTerraformResourceType

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

Specified by:

getTerraformResourceType in interface ITerraformResource

getTerraformGeneratorMetadata

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

getConnection

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

setConnection

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

setConnection

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

getCount

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

Specified by:

getCount in interface ITerraformResource

setCount

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

Specified by:

setCount in interface ITerraformResource

setCount

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

Specified by:

setCount in interface ITerraformResource

getDependsOn

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

Specified by:

getDependsOn in interface ITerraformResource

setDependsOn

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

Specified by:

setDependsOn in interface ITerraformResource

getForEach

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

Specified by:

getForEach in interface ITerraformResource

setForEach

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

Specified by:

setForEach in interface ITerraformResource

getLifecycle

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

Specified by:

getLifecycle in interface ITerraformResource

setLifecycle

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

Specified by:

setLifecycle in interface ITerraformResource

getProvider

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

Specified by:

getProvider in interface ITerraformResource

setProvider

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

Specified by:

setProvider in interface ITerraformResource

getProvisioners

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

setProvisioners

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