Java: TerraformResource - CDK Terrain (CDKTN)

Implements: ITerraformResource, ITerraformDependable, IInterpolatingParent

Initializers

import io.cdktn.cdktn.TerraformResource;

TerraformResource.Builder.create(Construct scope, java.lang.String id)
//  .connection(SSHProvisionerConnection|WinrmProvisionerConnection)
//  .count(java.lang.Number|TerraformCount)
//  .dependsOn(java.util.List<ITerraformDependable>)
//  .forEach(ITerraformIterator)
//  .lifecycle(TerraformResourceLifecycle)
//  .provider(TerraformProvider)
//  .provisioners(java.util.List<FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner>)
    .terraformResourceType(java.lang.String)
//  .terraformGeneratorMetadata(TerraformProviderGeneratorMetadata)
    .build();

Name	Type	Description
`scope`	`software.constructs.Construct`	No description.
`id`	`java.lang.String`	No description.
`connection`	`SSHProvisionerConnection\|WinrmProvisionerConnection`	No description.
`count`	`java.lang.Number\|TerraformCount`	No description.
`dependsOn`	`java.util.List<ITerraformDependable>`	No description.
`forEach`	`ITerraformIterator`	No description.
`lifecycle`	`TerraformResourceLifecycle`	No description.
`provider`	`TerraformProvider`	No description.
`provisioners`	`java.util.List<FileProvisioner\|LocalExecProvisioner\|RemoteExecProvisioner>`	No description.
`terraformResourceType`	`java.lang.String`	No description.
`terraformGeneratorMetadata`	`TerraformProviderGeneratorMetadata`	No description.

`scope`^Required

Type: software.constructs.Construct

`id`^Required

Type: java.lang.String

`connection`^Optional

Type: SSHProvisionerConnection|WinrmProvisionerConnection

`count`^Optional

Type: java.lang.Number|TerraformCount

`dependsOn`^Optional

Type: java.util.List<ITerraformDependable>

`terraformResourceType`^Required

Type: java.lang.String

`terraformGeneratorMetadata`^Optional

Type: TerraformProviderGeneratorMetadata

Methods

Name	Description
`toString`	Returns a string representation of this construct.
`with`	Applies one or more mixins to this construct.
`addOverride`	No description.
`overrideLogicalId`	Overrides the auto-generated logical ID with a specific ID.
`resetOverrideLogicalId`	Resets a previously passed logical Id to use the auto-generated logical id again.
`toHclTerraform`	No description.
`toMetadata`	No description.
`toTerraform`	Adds this resource to the terraform JSON output.
`addMoveTarget`	Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
`getAnyMapAttribute`	No description.
`getBooleanAttribute`	No description.
`getBooleanMapAttribute`	No description.
`getListAttribute`	No description.
`getNumberAttribute`	No description.
`getNumberListAttribute`	No description.
`getNumberMapAttribute`	No description.
`getStringAttribute`	No description.
`getStringMapAttribute`	No description.
`hasResourceMove`	No description.
`importFrom`	No description.
`interpolationForAttribute`	No description.
`moveFromId`	Move the resource corresponding to “id” to this resource.
`moveTo`	Moves this resource to the target resource given by moveTarget.
`moveToId`	Moves this resource to the resource corresponding to “id”.

`toString`

public java.lang.String toString()

Returns a string representation of this construct.

`with`

public IConstruct with(IMixin... mixins)

Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

`mixins`^Required

Type: software.constructs.IMixin…

The mixins to apply.

`addOverride`

public void addOverride(java.lang.String path, java.lang.Object value)

`path`^Required

Type: java.lang.String

`value`^Required

Type: java.lang.Object

`overrideLogicalId`

public void overrideLogicalId(java.lang.String newLogicalId)

Overrides the auto-generated logical ID with a specific ID.

`newLogicalId`^Required

Type: java.lang.String

The new logical ID to use for this stack element.

`resetOverrideLogicalId`

public void resetOverrideLogicalId()

Resets a previously passed logical Id to use the auto-generated logical id again.

`toHclTerraform`

public java.lang.Object toHclTerraform()

`toMetadata`

public java.lang.Object toMetadata()

`toTerraform`

public java.lang.Object toTerraform()

Adds this resource to the terraform JSON output.

`addMoveTarget`

public void addMoveTarget(java.lang.String moveTarget)

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

`moveTarget`^Required

Type: java.lang.String

The string move target that will correspond to this resource.

`getAnyMapAttribute`

public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)

`terraformAttribute`^Required

Type: java.lang.String

`getBooleanAttribute`

public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)

`terraformAttribute`^Required

Type: java.lang.String

`getBooleanMapAttribute`

public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)

`terraformAttribute`^Required

Type: java.lang.String

`getListAttribute`

public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)

`terraformAttribute`^Required

Type: java.lang.String

`getNumberAttribute`

public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)

`terraformAttribute`^Required

Type: java.lang.String

`getNumberListAttribute`

public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)

`terraformAttribute`^Required

Type: java.lang.String

`getNumberMapAttribute`

public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)

`terraformAttribute`^Required

Type: java.lang.String

`getStringAttribute`

public java.lang.String getStringAttribute(java.lang.String terraformAttribute)

`terraformAttribute`^Required

Type: java.lang.String

`getStringMapAttribute`

public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)

`terraformAttribute`^Required

Type: java.lang.String

`hasResourceMove`

public TerraformResourceMoveByTarget|TerraformResourceMoveById hasResourceMove()

`importFrom`

public void importFrom(java.lang.String id)
public void importFrom(java.lang.String id, TerraformProvider provider)

`id`^Required

Type: java.lang.String

`provider`^Optional

Type: TerraformProvider

`interpolationForAttribute`

public IResolvable interpolationForAttribute(java.lang.String terraformAttribute)

`terraformAttribute`^Required

Type: java.lang.String

`moveFromId`

public void moveFromId(java.lang.String id)

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.

`id`^Required

Type: java.lang.String

Full id of resource being moved from, e.g. “aws_s3_bucket.example”.

`moveTo`

public void moveTo(java.lang.String moveTarget)
public void moveTo(java.lang.String moveTarget, java.lang.String|java.lang.Number index)

Moves this resource to the target resource given by moveTarget.

`moveTarget`^Required

Type: java.lang.String

The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.

`index`^Optional

Type: java.lang.String|java.lang.Number

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

`moveToId`

public void moveToId(java.lang.String id)

Moves this resource to the resource corresponding to “id”.

`id`^Required

Type: java.lang.String

Full id of resource to move to, e.g. “aws_s3_bucket.example”.

Static Functions

Name	Description
`isConstruct`	Checks if `x` is a construct.
`isTerraformElement`	No description.
`isTerraformResource`	No description.

`isConstruct`

import io.cdktn.cdktn.TerraformResource;

TerraformResource.isConstruct(java.lang.Object x)

Checks if x is a construct. Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

`x`^Required

Type: java.lang.Object

Any object.

`isTerraformElement`

import io.cdktn.cdktn.TerraformResource;

TerraformResource.isTerraformElement(java.lang.Object x)

`x`^Required

Type: java.lang.Object

`isTerraformResource`

import io.cdktn.cdktn.TerraformResource;

TerraformResource.isTerraformResource(java.lang.Object x)

`x`^Required

Type: java.lang.Object

Properties

Name	Type	Description
`node`	`software.constructs.Node`	The tree node.
`cdktfStack`	`TerraformStack`	No description.
`fqn`	`java.lang.String`	No description.
`friendlyUniqueId`	`java.lang.String`	No description.
`terraformMetaArguments`	`java.util.Map< java.lang.String, java.lang.Object >`	No description.
`terraformResourceType`	`java.lang.String`	No description.
`terraformGeneratorMetadata`	`TerraformProviderGeneratorMetadata`	No description.
`connection`	`SSHProvisionerConnection\|WinrmProvisionerConnection`	No description.
`count`	`java.lang.Number\|TerraformCount`	No description.
`dependsOn`	`java.util.List< java.lang.String >`	No description.
`forEach`	`ITerraformIterator`	No description.
`lifecycle`	`TerraformResourceLifecycle`	No description.
`provider`	`TerraformProvider`	No description.
`provisioners`	`java.util.List<FileProvisioner\|LocalExecProvisioner\|RemoteExecProvisioner>`	No description.

`node`^Required

public Node getNode();

Type: software.constructs.Node

The tree node.

`cdktfStack`^Required

public TerraformStack getCdktfStack();

Type: TerraformStack

`fqn`^Required

public java.lang.String getFqn();

Type: java.lang.String

`friendlyUniqueId`^Required

public java.lang.String getFriendlyUniqueId();

Type: java.lang.String

`terraformMetaArguments`^Required

public java.util.Map<java.lang.String, java.lang.Object> getTerraformMetaArguments();

Type: java.util.Map< java.lang.String, java.lang.Object >

`terraformResourceType`^Required

public java.lang.String getTerraformResourceType();

Type: java.lang.String

`terraformGeneratorMetadata`^Optional

public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata();

Type: TerraformProviderGeneratorMetadata

`connection`^Optional

public SSHProvisionerConnection|WinrmProvisionerConnection getConnection();

Type: SSHProvisionerConnection|WinrmProvisionerConnection

`count`^Optional

public java.lang.Number|TerraformCount getCount();

Type: java.lang.Number|TerraformCount

`dependsOn`^Optional

public java.util.List<java.lang.String> getDependsOn();

Type: java.util.List< java.lang.String >

`forEach`^Optional

public ITerraformIterator getForEach();

Type: ITerraformIterator

`lifecycle`^Optional

public TerraformResourceLifecycle getLifecycle();

Type: TerraformResourceLifecycle

`provider`^Optional

public TerraformProvider getProvider();

Type: TerraformProvider

`provisioners`^Optional

public java.util.List<FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner> getProvisioners();

Type: java.util.List<FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner>

​Initializers

​scopeRequired

​idRequired

​connectionOptional

​countOptional

​dependsOnOptional

​forEachOptional

​lifecycleOptional

​providerOptional

​provisionersOptional

​terraformResourceTypeRequired

​terraformGeneratorMetadataOptional

​Methods

​toString

​with

​mixinsRequired

​addOverride

​pathRequired

​valueRequired

​overrideLogicalId

​newLogicalIdRequired

​resetOverrideLogicalId

​toHclTerraform

​toMetadata

​toTerraform

​addMoveTarget

​moveTargetRequired

​getAnyMapAttribute

​terraformAttributeRequired

​getBooleanAttribute

​terraformAttributeRequired

​getBooleanMapAttribute

​terraformAttributeRequired

​getListAttribute

​terraformAttributeRequired

​getNumberAttribute

​terraformAttributeRequired

​getNumberListAttribute

​terraformAttributeRequired

​getNumberMapAttribute

​terraformAttributeRequired

​getStringAttribute

​terraformAttributeRequired

​getStringMapAttribute

​terraformAttributeRequired

​hasResourceMove

​importFrom

​idRequired

​providerOptional

​interpolationForAttribute

​terraformAttributeRequired

​moveFromId

​idRequired

​moveTo

​moveTargetRequired

​indexOptional

​moveToId

​idRequired

​Static Functions

​isConstruct

​xRequired

​isTerraformElement

​xRequired

​isTerraformResource

​xRequired

​Properties

​nodeRequired

​cdktfStackRequired

​fqnRequired

​friendlyUniqueIdRequired

​terraformMetaArgumentsRequired

​terraformResourceTypeRequired

​terraformGeneratorMetadataOptional

​connectionOptional

​countOptional

​dependsOnOptional

​forEachOptional

​lifecycleOptional

​providerOptional

​provisionersOptional

Initializers

`scope`^Required

`id`^Required

`connection`^Optional

`count`^Optional

`dependsOn`^Optional

`forEach`^Optional

`lifecycle`^Optional

`provider`^Optional

`provisioners`^Optional

`terraformResourceType`^Required

`terraformGeneratorMetadata`^Optional

Methods

`toString`

`with`

`mixins`^Required

`addOverride`

`path`^Required

`value`^Required

`overrideLogicalId`

`newLogicalId`^Required

`resetOverrideLogicalId`

`toHclTerraform`

`toMetadata`

`toTerraform`

`addMoveTarget`

`moveTarget`^Required

`getAnyMapAttribute`

`terraformAttribute`^Required

`getBooleanAttribute`

`terraformAttribute`^Required

`getBooleanMapAttribute`

`terraformAttribute`^Required

`getListAttribute`

`terraformAttribute`^Required

`getNumberAttribute`

`terraformAttribute`^Required

`getNumberListAttribute`

`terraformAttribute`^Required

`getNumberMapAttribute`

`terraformAttribute`^Required

`getStringAttribute`

`terraformAttribute`^Required

`getStringMapAttribute`

`terraformAttribute`^Required

`hasResourceMove`

`importFrom`

`id`^Required

`provider`^Optional

`interpolationForAttribute`

`terraformAttribute`^Required

`moveFromId`

`id`^Required

`moveTo`

`moveTarget`^Required

`index`^Optional

`moveToId`

`id`^Required

Static Functions

`isConstruct`

`x`^Required

`isTerraformElement`

`x`^Required

`isTerraformResource`

`x`^Required

Properties

`node`^Required

`cdktfStack`^Required

`fqn`^Required

`friendlyUniqueId`^Required

`terraformMetaArguments`^Required

`terraformResourceType`^Required

`terraformGeneratorMetadata`^Optional

`connection`^Optional

`count`^Optional

`dependsOn`^Optional

`forEach`^Optional

`lifecycle`^Optional

`provider`^Optional

`provisioners`^Optional