> ## Documentation Index > Fetch the complete documentation index at: https://cdktn.io/docs/llms.txt > Use this file to discover all available pages before exploring further. # Java: TerraformResource > CDKTN Core API Reference for TerraformResource in Java. * *Implements:* ITerraformResource, ITerraformDependable, IInterpolatingParent ## Initializers ```java theme={null} 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) // .forEach(ITerraformIterator) // .lifecycle(TerraformResourceLifecycle) // .provider(TerraformProvider) // .provisioners(java.util.List) .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> *** ### `forEach`^Optional * *Type:* ITerraformIterator *** ### `lifecycle`^Optional * *Type:* TerraformResourceLifecycle *** ### `provider`^Optional * *Type:* TerraformProvider *** ### `provisioners`^Optional * *Type:* java.util.List\<FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner> *** ### `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` ```java theme={null} public java.lang.String toString() ``` Returns a string representation of this construct. ### `with` ```java theme={null} 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` ```java theme={null} public void addOverride(java.lang.String path, java.lang.Object value) ``` #### `path`^Required * *Type:* java.lang.String *** #### `value`^Required * *Type:* java.lang.Object *** ### `overrideLogicalId` ```java theme={null} 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` ```java theme={null} public void resetOverrideLogicalId() ``` Resets a previously passed logical Id to use the auto-generated logical id again. ### `toHclTerraform` ```java theme={null} public java.lang.Object toHclTerraform() ``` ### `toMetadata` ```java theme={null} public java.lang.Object toMetadata() ``` ### `toTerraform` ```java theme={null} public java.lang.Object toTerraform() ``` Adds this resource to the terraform JSON output. ### `addMoveTarget` ```java theme={null} 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` ```java theme={null} public java.util.Map getAnyMapAttribute(java.lang.String terraformAttribute) ``` #### `terraformAttribute`^Required * *Type:* java.lang.String *** ### `getBooleanAttribute` ```java theme={null} public IResolvable getBooleanAttribute(java.lang.String terraformAttribute) ``` #### `terraformAttribute`^Required * *Type:* java.lang.String *** ### `getBooleanMapAttribute` ```java theme={null} public java.util.Map getBooleanMapAttribute(java.lang.String terraformAttribute) ``` #### `terraformAttribute`^Required * *Type:* java.lang.String *** ### `getListAttribute` ```java theme={null} public java.util.List getListAttribute(java.lang.String terraformAttribute) ``` #### `terraformAttribute`^Required * *Type:* java.lang.String *** ### `getNumberAttribute` ```java theme={null} public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute) ``` #### `terraformAttribute`^Required * *Type:* java.lang.String *** ### `getNumberListAttribute` ```java theme={null} public java.util.List getNumberListAttribute(java.lang.String terraformAttribute) ``` #### `terraformAttribute`^Required * *Type:* java.lang.String *** ### `getNumberMapAttribute` ```java theme={null} public java.util.Map getNumberMapAttribute(java.lang.String terraformAttribute) ``` #### `terraformAttribute`^Required * *Type:* java.lang.String *** ### `getStringAttribute` ```java theme={null} public java.lang.String getStringAttribute(java.lang.String terraformAttribute) ``` #### `terraformAttribute`^Required * *Type:* java.lang.String *** ### `getStringMapAttribute` ```java theme={null} public java.util.Map getStringMapAttribute(java.lang.String terraformAttribute) ``` #### `terraformAttribute`^Required * *Type:* java.lang.String *** ### `hasResourceMove` ```java theme={null} public TerraformResourceMoveByTarget|TerraformResourceMoveById hasResourceMove() ``` ### `importFrom` ```java theme={null} 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` ```java theme={null} public IResolvable interpolationForAttribute(java.lang.String terraformAttribute) ``` #### `terraformAttribute`^Required * *Type:* java.lang.String *** ### `moveFromId` ```java theme={null} 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` ```java theme={null} 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` ```java theme={null} 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` ```java theme={null} 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` ```java theme={null} import io.cdktn.cdktn.TerraformResource; TerraformResource.isTerraformElement(java.lang.Object x) ``` #### `x`^Required * *Type:* java.lang.Object *** ### `isTerraformResource` ```java theme={null} 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 ```java theme={null} public Node getNode(); ``` * *Type:* software.constructs.Node The tree node. *** ### `cdktfStack`^Required ```java theme={null} public TerraformStack getCdktfStack(); ``` * *Type:* TerraformStack *** ### `fqn`^Required ```java theme={null} public java.lang.String getFqn(); ``` * *Type:* java.lang.String *** ### `friendlyUniqueId`^Required ```java theme={null} public java.lang.String getFriendlyUniqueId(); ``` * *Type:* java.lang.String *** ### `terraformMetaArguments`^Required ```java theme={null} public java.util.Map getTerraformMetaArguments(); ``` * *Type:* java.util.Map\< java.lang.String, java.lang.Object > *** ### `terraformResourceType`^Required ```java theme={null} public java.lang.String getTerraformResourceType(); ``` * *Type:* java.lang.String *** ### `terraformGeneratorMetadata`^Optional ```java theme={null} public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata(); ``` * *Type:* TerraformProviderGeneratorMetadata *** ### `connection`^Optional ```java theme={null} public SSHProvisionerConnection|WinrmProvisionerConnection getConnection(); ``` * *Type:* SSHProvisionerConnection|WinrmProvisionerConnection *** ### `count`^Optional ```java theme={null} public java.lang.Number|TerraformCount getCount(); ``` * *Type:* java.lang.Number|TerraformCount *** ### `dependsOn`^Optional ```java theme={null} public java.util.List getDependsOn(); ``` * *Type:* java.util.List\< java.lang.String > *** ### `forEach`^Optional ```java theme={null} public ITerraformIterator getForEach(); ``` * *Type:* ITerraformIterator *** ### `lifecycle`^Optional ```java theme={null} public TerraformResourceLifecycle getLifecycle(); ``` * *Type:* TerraformResourceLifecycle *** ### `provider`^Optional ```java theme={null} public TerraformProvider getProvider(); ``` * *Type:* TerraformProvider *** ### `provisioners`^Optional ```java theme={null} public java.util.List getProvisioners(); ``` * *Type:* java.util.List\<FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner> ***