> ## 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.

# Go: TerraformResource

> CDKTN Core API Reference for TerraformResource in Go.

* *Implements:* <a href="#cdktn.ITerraformResource">ITerraformResource</a>, <a href="#cdktn.ITerraformDependable">ITerraformDependable</a>, <a href="#cdktn.IInterpolatingParent">IInterpolatingParent</a>

## Initializers <a name="Initializers" id="cdktn.TerraformResource.Initializer" />

```go theme={null}
import "github.com/open-constructs/cdk-terrain-go/cdktn"

cdktn.NewTerraformResource(scope Construct, id *string, config TerraformResourceConfig) TerraformResource
```

| **Name**                                                                                | **Type**                                                                          | **Description**   |
| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | ----------------- |
| <code><a href="#cdktn.TerraformResource.Initializer.parameter.scope">scope</a></code>   | <code>github.com/aws/constructs-go/constructs/v10.Construct</code>                | *No description.* |
| <code><a href="#cdktn.TerraformResource.Initializer.parameter.id">id</a></code>         | <code>\*string</code>                                                             | *No description.* |
| <code><a href="#cdktn.TerraformResource.Initializer.parameter.config">config</a></code> | <code><a href="#cdktn.TerraformResourceConfig">TerraformResourceConfig</a></code> | *No description.* |

***

### `scope`<sup>Required</sup> <a name="scope" id="cdktn.TerraformResource.Initializer.parameter.scope" />

* *Type:* github.com/aws/constructs-go/constructs/v10.Construct

***

### `id`<sup>Required</sup> <a name="id" id="cdktn.TerraformResource.Initializer.parameter.id" />

* *Type:* \*string

***

### `config`<sup>Required</sup> <a name="config" id="cdktn.TerraformResource.Initializer.parameter.config" />

* *Type:* <a href="#cdktn.TerraformResourceConfig">TerraformResourceConfig</a>

***

## Methods <a name="Methods" id="Methods" />

| **Name**                                                                                                | **Description**                                                                                                                     |
| ------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |
| <code><a href="#cdktn.TerraformResource.toString">ToString</a></code>                                   | Returns a string representation of this construct.                                                                                  |
| <code><a href="#cdktn.TerraformResource.with">With</a></code>                                           | Applies one or more mixins to this construct.                                                                                       |
| <code><a href="#cdktn.TerraformResource.addOverride">AddOverride</a></code>                             | *No description.*                                                                                                                   |
| <code><a href="#cdktn.TerraformResource.overrideLogicalId">OverrideLogicalId</a></code>                 | Overrides the auto-generated logical ID with a specific ID.                                                                         |
| <code><a href="#cdktn.TerraformResource.resetOverrideLogicalId">ResetOverrideLogicalId</a></code>       | Resets a previously passed logical Id to use the auto-generated logical id again.                                                   |
| <code><a href="#cdktn.TerraformResource.toHclTerraform">ToHclTerraform</a></code>                       | *No description.*                                                                                                                   |
| <code><a href="#cdktn.TerraformResource.toMetadata">ToMetadata</a></code>                               | *No description.*                                                                                                                   |
| <code><a href="#cdktn.TerraformResource.toTerraform">ToTerraform</a></code>                             | Adds this resource to the terraform JSON output.                                                                                    |
| <code><a href="#cdktn.TerraformResource.addMoveTarget">AddMoveTarget</a></code>                         | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. |
| <code><a href="#cdktn.TerraformResource.getAnyMapAttribute">GetAnyMapAttribute</a></code>               | *No description.*                                                                                                                   |
| <code><a href="#cdktn.TerraformResource.getBooleanAttribute">GetBooleanAttribute</a></code>             | *No description.*                                                                                                                   |
| <code><a href="#cdktn.TerraformResource.getBooleanMapAttribute">GetBooleanMapAttribute</a></code>       | *No description.*                                                                                                                   |
| <code><a href="#cdktn.TerraformResource.getListAttribute">GetListAttribute</a></code>                   | *No description.*                                                                                                                   |
| <code><a href="#cdktn.TerraformResource.getNumberAttribute">GetNumberAttribute</a></code>               | *No description.*                                                                                                                   |
| <code><a href="#cdktn.TerraformResource.getNumberListAttribute">GetNumberListAttribute</a></code>       | *No description.*                                                                                                                   |
| <code><a href="#cdktn.TerraformResource.getNumberMapAttribute">GetNumberMapAttribute</a></code>         | *No description.*                                                                                                                   |
| <code><a href="#cdktn.TerraformResource.getStringAttribute">GetStringAttribute</a></code>               | *No description.*                                                                                                                   |
| <code><a href="#cdktn.TerraformResource.getStringMapAttribute">GetStringMapAttribute</a></code>         | *No description.*                                                                                                                   |
| <code><a href="#cdktn.TerraformResource.hasResourceMove">HasResourceMove</a></code>                     | *No description.*                                                                                                                   |
| <code><a href="#cdktn.TerraformResource.importFrom">ImportFrom</a></code>                               | *No description.*                                                                                                                   |
| <code><a href="#cdktn.TerraformResource.interpolationForAttribute">InterpolationForAttribute</a></code> | *No description.*                                                                                                                   |
| <code><a href="#cdktn.TerraformResource.moveFromId">MoveFromId</a></code>                               | Move the resource corresponding to "id" to this resource.                                                                           |
| <code><a href="#cdktn.TerraformResource.moveTo">MoveTo</a></code>                                       | Moves this resource to the target resource given by moveTarget.                                                                     |
| <code><a href="#cdktn.TerraformResource.moveToId">MoveToId</a></code>                                   | Moves this resource to the resource corresponding to "id".                                                                          |

***

### `ToString` <a name="ToString" id="cdktn.TerraformResource.toString" />

```go theme={null}
func ToString() *string
```

Returns a string representation of this construct.

### `With` <a name="With" id="cdktn.TerraformResource.with" />

```go theme={null}
func With(mixins ...IMixin) IConstruct
```

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`<sup>Required</sup> <a name="mixins" id="cdktn.TerraformResource.with.parameter.mixins" />

* *Type:* ...github.com/aws/constructs-go/constructs/v10.IMixin

The mixins to apply.

***

### `AddOverride` <a name="AddOverride" id="cdktn.TerraformResource.addOverride" />

```go theme={null}
func AddOverride(path *string, value interface{})
```

#### `path`<sup>Required</sup> <a name="path" id="cdktn.TerraformResource.addOverride.parameter.path" />

* *Type:* \*string

***

#### `value`<sup>Required</sup> <a name="value" id="cdktn.TerraformResource.addOverride.parameter.value" />

* *Type:* interface\{}

***

### `OverrideLogicalId` <a name="OverrideLogicalId" id="cdktn.TerraformResource.overrideLogicalId" />

```go theme={null}
func OverrideLogicalId(newLogicalId *string)
```

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

#### `newLogicalId`<sup>Required</sup> <a name="newLogicalId" id="cdktn.TerraformResource.overrideLogicalId.parameter.newLogicalId" />

* *Type:* \*string

The new logical ID to use for this stack element.

***

### `ResetOverrideLogicalId` <a name="ResetOverrideLogicalId" id="cdktn.TerraformResource.resetOverrideLogicalId" />

```go theme={null}
func ResetOverrideLogicalId()
```

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

### `ToHclTerraform` <a name="ToHclTerraform" id="cdktn.TerraformResource.toHclTerraform" />

```go theme={null}
func ToHclTerraform() interface{}
```

### `ToMetadata` <a name="ToMetadata" id="cdktn.TerraformResource.toMetadata" />

```go theme={null}
func ToMetadata() interface{}
```

### `ToTerraform` <a name="ToTerraform" id="cdktn.TerraformResource.toTerraform" />

```go theme={null}
func ToTerraform() interface{}
```

Adds this resource to the terraform JSON output.

### `AddMoveTarget` <a name="AddMoveTarget" id="cdktn.TerraformResource.addMoveTarget" />

```go theme={null}
func AddMoveTarget(moveTarget *string)
```

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

#### `moveTarget`<sup>Required</sup> <a name="moveTarget" id="cdktn.TerraformResource.addMoveTarget.parameter.moveTarget" />

* *Type:* \*string

The string move target that will correspond to this resource.

***

### `GetAnyMapAttribute` <a name="GetAnyMapAttribute" id="cdktn.TerraformResource.getAnyMapAttribute" />

```go theme={null}
func GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}
```

#### `terraformAttribute`<sup>Required</sup> <a name="terraformAttribute" id="cdktn.TerraformResource.getAnyMapAttribute.parameter.terraformAttribute" />

* *Type:* \*string

***

### `GetBooleanAttribute` <a name="GetBooleanAttribute" id="cdktn.TerraformResource.getBooleanAttribute" />

```go theme={null}
func GetBooleanAttribute(terraformAttribute *string) IResolvable
```

#### `terraformAttribute`<sup>Required</sup> <a name="terraformAttribute" id="cdktn.TerraformResource.getBooleanAttribute.parameter.terraformAttribute" />

* *Type:* \*string

***

### `GetBooleanMapAttribute` <a name="GetBooleanMapAttribute" id="cdktn.TerraformResource.getBooleanMapAttribute" />

```go theme={null}
func GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool
```

#### `terraformAttribute`<sup>Required</sup> <a name="terraformAttribute" id="cdktn.TerraformResource.getBooleanMapAttribute.parameter.terraformAttribute" />

* *Type:* \*string

***

### `GetListAttribute` <a name="GetListAttribute" id="cdktn.TerraformResource.getListAttribute" />

```go theme={null}
func GetListAttribute(terraformAttribute *string) *[]*string
```

#### `terraformAttribute`<sup>Required</sup> <a name="terraformAttribute" id="cdktn.TerraformResource.getListAttribute.parameter.terraformAttribute" />

* *Type:* \*string

***

### `GetNumberAttribute` <a name="GetNumberAttribute" id="cdktn.TerraformResource.getNumberAttribute" />

```go theme={null}
func GetNumberAttribute(terraformAttribute *string) *f64
```

#### `terraformAttribute`<sup>Required</sup> <a name="terraformAttribute" id="cdktn.TerraformResource.getNumberAttribute.parameter.terraformAttribute" />

* *Type:* \*string

***

### `GetNumberListAttribute` <a name="GetNumberListAttribute" id="cdktn.TerraformResource.getNumberListAttribute" />

```go theme={null}
func GetNumberListAttribute(terraformAttribute *string) *[]*f64
```

#### `terraformAttribute`<sup>Required</sup> <a name="terraformAttribute" id="cdktn.TerraformResource.getNumberListAttribute.parameter.terraformAttribute" />

* *Type:* \*string

***

### `GetNumberMapAttribute` <a name="GetNumberMapAttribute" id="cdktn.TerraformResource.getNumberMapAttribute" />

```go theme={null}
func GetNumberMapAttribute(terraformAttribute *string) *map[string]*f64
```

#### `terraformAttribute`<sup>Required</sup> <a name="terraformAttribute" id="cdktn.TerraformResource.getNumberMapAttribute.parameter.terraformAttribute" />

* *Type:* \*string

***

### `GetStringAttribute` <a name="GetStringAttribute" id="cdktn.TerraformResource.getStringAttribute" />

```go theme={null}
func GetStringAttribute(terraformAttribute *string) *string
```

#### `terraformAttribute`<sup>Required</sup> <a name="terraformAttribute" id="cdktn.TerraformResource.getStringAttribute.parameter.terraformAttribute" />

* *Type:* \*string

***

### `GetStringMapAttribute` <a name="GetStringMapAttribute" id="cdktn.TerraformResource.getStringMapAttribute" />

```go theme={null}
func GetStringMapAttribute(terraformAttribute *string) *map[string]*string
```

#### `terraformAttribute`<sup>Required</sup> <a name="terraformAttribute" id="cdktn.TerraformResource.getStringMapAttribute.parameter.terraformAttribute" />

* *Type:* \*string

***

### `HasResourceMove` <a name="HasResourceMove" id="cdktn.TerraformResource.hasResourceMove" />

```go theme={null}
func HasResourceMove() interface{}
```

### `ImportFrom` <a name="ImportFrom" id="cdktn.TerraformResource.importFrom" />

```go theme={null}
func ImportFrom(id *string, provider TerraformProvider)
```

#### `id`<sup>Required</sup> <a name="id" id="cdktn.TerraformResource.importFrom.parameter.id" />

* *Type:* \*string

***

#### `provider`<sup>Optional</sup> <a name="provider" id="cdktn.TerraformResource.importFrom.parameter.provider" />

* *Type:* <a href="#cdktn.TerraformProvider">TerraformProvider</a>

***

### `InterpolationForAttribute` <a name="InterpolationForAttribute" id="cdktn.TerraformResource.interpolationForAttribute" />

```go theme={null}
func InterpolationForAttribute(terraformAttribute *string) IResolvable
```

#### `terraformAttribute`<sup>Required</sup> <a name="terraformAttribute" id="cdktn.TerraformResource.interpolationForAttribute.parameter.terraformAttribute" />

* *Type:* \*string

***

### `MoveFromId` <a name="MoveFromId" id="cdktn.TerraformResource.moveFromId" />

```go theme={null}
func MoveFromId(id *string)
```

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`<sup>Required</sup> <a name="id" id="cdktn.TerraformResource.moveFromId.parameter.id" />

* *Type:* \*string

Full id of resource being moved from, e.g. "aws\_s3\_bucket.example".

***

### `MoveTo` <a name="MoveTo" id="cdktn.TerraformResource.moveTo" />

```go theme={null}
func MoveTo(moveTarget *string, index interface{})
```

Moves this resource to the target resource given by moveTarget.

#### `moveTarget`<sup>Required</sup> <a name="moveTarget" id="cdktn.TerraformResource.moveTo.parameter.moveTarget" />

* *Type:* \*string

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

***

#### `index`<sup>Optional</sup> <a name="index" id="cdktn.TerraformResource.moveTo.parameter.index" />

* *Type:* interface\{}

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

***

### `MoveToId` <a name="MoveToId" id="cdktn.TerraformResource.moveToId" />

```go theme={null}
func MoveToId(id *string)
```

Moves this resource to the resource corresponding to "id".

#### `id`<sup>Required</sup> <a name="id" id="cdktn.TerraformResource.moveToId.parameter.id" />

* *Type:* \*string

Full id of resource to move to, e.g. "aws\_s3\_bucket.example".

***

## Static Functions <a name="Static Functions" id="Static Functions" />

| **Name**                                                                                    | **Description**               |
| ------------------------------------------------------------------------------------------- | ----------------------------- |
| <code><a href="#cdktn.TerraformResource.isConstruct">IsConstruct</a></code>                 | Checks if `x` is a construct. |
| <code><a href="#cdktn.TerraformResource.isTerraformElement">IsTerraformElement</a></code>   | *No description.*             |
| <code><a href="#cdktn.TerraformResource.isTerraformResource">IsTerraformResource</a></code> | *No description.*             |

***

### `IsConstruct` <a name="IsConstruct" id="cdktn.TerraformResource.isConstruct" />

```go theme={null}
import "github.com/open-constructs/cdk-terrain-go/cdktn"

cdktn.TerraformResource_IsConstruct(x interface{}) *bool
```

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`<sup>Required</sup> <a name="x" id="cdktn.TerraformResource.isConstruct.parameter.x" />

* *Type:* interface\{}

Any object.

***

### `IsTerraformElement` <a name="IsTerraformElement" id="cdktn.TerraformResource.isTerraformElement" />

```go theme={null}
import "github.com/open-constructs/cdk-terrain-go/cdktn"

cdktn.TerraformResource_IsTerraformElement(x interface{}) *bool
```

#### `x`<sup>Required</sup> <a name="x" id="cdktn.TerraformResource.isTerraformElement.parameter.x" />

* *Type:* interface\{}

***

### `IsTerraformResource` <a name="IsTerraformResource" id="cdktn.TerraformResource.isTerraformResource" />

```go theme={null}
import "github.com/open-constructs/cdk-terrain-go/cdktn"

cdktn.TerraformResource_IsTerraformResource(x interface{}) *bool
```

#### `x`<sup>Required</sup> <a name="x" id="cdktn.TerraformResource.isTerraformResource.parameter.x" />

* *Type:* interface\{}

***

## Properties <a name="Properties" id="Properties" />

| **Name**                                                                                                           | **Type**                                                                                                | **Description**   |
| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------- | ----------------- |
| <code><a href="#cdktn.TerraformResource.property.node">Node</a></code>                                             | <code>github.com/aws/constructs-go/constructs/v10.Node</code>                                           | The tree node.    |
| <code><a href="#cdktn.TerraformResource.property.cdktfStack">CdktfStack</a></code>                                 | <code><a href="#cdktn.TerraformStack">TerraformStack</a></code>                                         | *No description.* |
| <code><a href="#cdktn.TerraformResource.property.fqn">Fqn</a></code>                                               | <code>\*string</code>                                                                                   | *No description.* |
| <code><a href="#cdktn.TerraformResource.property.friendlyUniqueId">FriendlyUniqueId</a></code>                     | <code>\*string</code>                                                                                   | *No description.* |
| <code><a href="#cdktn.TerraformResource.property.terraformMetaArguments">TerraformMetaArguments</a></code>         | <code>\*map\[string]interface\{}</code>                                                                 | *No description.* |
| <code><a href="#cdktn.TerraformResource.property.terraformResourceType">TerraformResourceType</a></code>           | <code>\*string</code>                                                                                   | *No description.* |
| <code><a href="#cdktn.TerraformResource.property.terraformGeneratorMetadata">TerraformGeneratorMetadata</a></code> | <code><a href="#cdktn.TerraformProviderGeneratorMetadata">TerraformProviderGeneratorMetadata</a></code> | *No description.* |
| <code><a href="#cdktn.TerraformResource.property.connection">Connection</a></code>                                 | <code>interface\{}</code>                                                                               | *No description.* |
| <code><a href="#cdktn.TerraformResource.property.count">Count</a></code>                                           | <code>interface\{}</code>                                                                               | *No description.* |
| <code><a href="#cdktn.TerraformResource.property.dependsOn">DependsOn</a></code>                                   | <code>\*\[]\*string</code>                                                                              | *No description.* |
| <code><a href="#cdktn.TerraformResource.property.forEach">ForEach</a></code>                                       | <code><a href="#cdktn.ITerraformIterator">ITerraformIterator</a></code>                                 | *No description.* |
| <code><a href="#cdktn.TerraformResource.property.lifecycle">Lifecycle</a></code>                                   | <code><a href="#cdktn.TerraformResourceLifecycle">TerraformResourceLifecycle</a></code>                 | *No description.* |
| <code><a href="#cdktn.TerraformResource.property.provider">Provider</a></code>                                     | <code><a href="#cdktn.TerraformProvider">TerraformProvider</a></code>                                   | *No description.* |
| <code><a href="#cdktn.TerraformResource.property.provisioners">Provisioners</a></code>                             | <code>\*\[]interface\{}</code>                                                                          | *No description.* |

***

### `Node`<sup>Required</sup> <a name="Node" id="cdktn.TerraformResource.property.node" />

```go theme={null}
func Node() Node
```

* *Type:* github.com/aws/constructs-go/constructs/v10.Node

The tree node.

***

### `CdktfStack`<sup>Required</sup> <a name="CdktfStack" id="cdktn.TerraformResource.property.cdktfStack" />

```go theme={null}
func CdktfStack() TerraformStack
```

* *Type:* <a href="#cdktn.TerraformStack">TerraformStack</a>

***

### `Fqn`<sup>Required</sup> <a name="Fqn" id="cdktn.TerraformResource.property.fqn" />

```go theme={null}
func Fqn() *string
```

* *Type:* \*string

***

### `FriendlyUniqueId`<sup>Required</sup> <a name="FriendlyUniqueId" id="cdktn.TerraformResource.property.friendlyUniqueId" />

```go theme={null}
func FriendlyUniqueId() *string
```

* *Type:* \*string

***

### `TerraformMetaArguments`<sup>Required</sup> <a name="TerraformMetaArguments" id="cdktn.TerraformResource.property.terraformMetaArguments" />

```go theme={null}
func TerraformMetaArguments() *map[string]interface{}
```

* *Type:* \*map\[string]interface\{}

***

### `TerraformResourceType`<sup>Required</sup> <a name="TerraformResourceType" id="cdktn.TerraformResource.property.terraformResourceType" />

```go theme={null}
func TerraformResourceType() *string
```

* *Type:* \*string

***

### `TerraformGeneratorMetadata`<sup>Optional</sup> <a name="TerraformGeneratorMetadata" id="cdktn.TerraformResource.property.terraformGeneratorMetadata" />

```go theme={null}
func TerraformGeneratorMetadata() TerraformProviderGeneratorMetadata
```

* *Type:* <a href="#cdktn.TerraformProviderGeneratorMetadata">TerraformProviderGeneratorMetadata</a>

***

### `Connection`<sup>Optional</sup> <a name="Connection" id="cdktn.TerraformResource.property.connection" />

```go theme={null}
func Connection() interface{}
```

* *Type:* interface\{}

***

### `Count`<sup>Optional</sup> <a name="Count" id="cdktn.TerraformResource.property.count" />

```go theme={null}
func Count() interface{}
```

* *Type:* interface\{}

***

### `DependsOn`<sup>Optional</sup> <a name="DependsOn" id="cdktn.TerraformResource.property.dependsOn" />

```go theme={null}
func DependsOn() *[]*string
```

* *Type:* \*\[]\*string

***

### `ForEach`<sup>Optional</sup> <a name="ForEach" id="cdktn.TerraformResource.property.forEach" />

```go theme={null}
func ForEach() ITerraformIterator
```

* *Type:* <a href="#cdktn.ITerraformIterator">ITerraformIterator</a>

***

### `Lifecycle`<sup>Optional</sup> <a name="Lifecycle" id="cdktn.TerraformResource.property.lifecycle" />

```go theme={null}
func Lifecycle() TerraformResourceLifecycle
```

* *Type:* <a href="#cdktn.TerraformResourceLifecycle">TerraformResourceLifecycle</a>

***

### `Provider`<sup>Optional</sup> <a name="Provider" id="cdktn.TerraformResource.property.provider" />

```go theme={null}
func Provider() TerraformProvider
```

* *Type:* <a href="#cdktn.TerraformProvider">TerraformProvider</a>

***

### `Provisioners`<sup>Optional</sup> <a name="Provisioners" id="cdktn.TerraformResource.property.provisioners" />

```go theme={null}
func Provisioners() *[]interface{}
```

* *Type:* \*\[]interface\{}

***
