> ## 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: TerraformVariable

> CDKTN Core API Reference for TerraformVariable in Go.

* *Implements:* <a href="#cdktn.ITerraformAddressable">ITerraformAddressable</a>

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

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

cdktn.NewTerraformVariable(scope Construct, id *string, config TerraformVariableConfig) TerraformVariable
```

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

***

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

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

***

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

* *Type:* \*string

***

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

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

***

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

| **Name**                                                                                            | **Description**                                                                   |
| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- |
| <code><a href="#cdktn.TerraformVariable.toString">ToString</a></code>                               | Returns a string representation of this construct.                                |
| <code><a href="#cdktn.TerraformVariable.with">With</a></code>                                       | Applies one or more mixins to this construct.                                     |
| <code><a href="#cdktn.TerraformVariable.addOverride">AddOverride</a></code>                         | *No description.*                                                                 |
| <code><a href="#cdktn.TerraformVariable.overrideLogicalId">OverrideLogicalId</a></code>             | Overrides the auto-generated logical ID with a specific ID.                       |
| <code><a href="#cdktn.TerraformVariable.resetOverrideLogicalId">ResetOverrideLogicalId</a></code>   | Resets a previously passed logical Id to use the auto-generated logical id again. |
| <code><a href="#cdktn.TerraformVariable.toHclTerraform">ToHclTerraform</a></code>                   | *No description.*                                                                 |
| <code><a href="#cdktn.TerraformVariable.toMetadata">ToMetadata</a></code>                           | *No description.*                                                                 |
| <code><a href="#cdktn.TerraformVariable.toTerraform">ToTerraform</a></code>                         | *No description.*                                                                 |
| <code><a href="#cdktn.TerraformVariable.addValidation">AddValidation</a></code>                     | *No description.*                                                                 |
| <code><a href="#cdktn.TerraformVariable.synthesizeAttributes">SynthesizeAttributes</a></code>       | *No description.*                                                                 |
| <code><a href="#cdktn.TerraformVariable.synthesizeHclAttributes">SynthesizeHclAttributes</a></code> | *No description.*                                                                 |

***

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

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

Returns a string representation of this construct.

### `With` <a name="With" id="cdktn.TerraformVariable.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.TerraformVariable.with.parameter.mixins" />

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

The mixins to apply.

***

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

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

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

* *Type:* \*string

***

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

* *Type:* interface\{}

***

### `OverrideLogicalId` <a name="OverrideLogicalId" id="cdktn.TerraformVariable.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.TerraformVariable.overrideLogicalId.parameter.newLogicalId" />

* *Type:* \*string

The new logical ID to use for this stack element.

***

### `ResetOverrideLogicalId` <a name="ResetOverrideLogicalId" id="cdktn.TerraformVariable.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.TerraformVariable.toHclTerraform" />

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

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

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

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

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

### `AddValidation` <a name="AddValidation" id="cdktn.TerraformVariable.addValidation" />

```go theme={null}
func AddValidation(validation TerraformVariableValidationConfig)
```

#### `validation`<sup>Required</sup> <a name="validation" id="cdktn.TerraformVariable.addValidation.parameter.validation" />

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

***

### `SynthesizeAttributes` <a name="SynthesizeAttributes" id="cdktn.TerraformVariable.synthesizeAttributes" />

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

### `SynthesizeHclAttributes` <a name="SynthesizeHclAttributes" id="cdktn.TerraformVariable.synthesizeHclAttributes" />

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

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

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

***

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

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

cdktn.TerraformVariable_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.TerraformVariable.isConstruct.parameter.x" />

* *Type:* interface\{}

Any object.

***

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

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

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

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

* *Type:* interface\{}

***

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

| **Name**                                                                                       | **Type**                                                                                                   | **Description**   |
| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ----------------- |
| <code><a href="#cdktn.TerraformVariable.property.node">Node</a></code>                         | <code>github.com/aws/constructs-go/constructs/v10.Node</code>                                              | The tree node.    |
| <code><a href="#cdktn.TerraformVariable.property.cdktfStack">CdktfStack</a></code>             | <code><a href="#cdktn.TerraformStack">TerraformStack</a></code>                                            | *No description.* |
| <code><a href="#cdktn.TerraformVariable.property.fqn">Fqn</a></code>                           | <code>\*string</code>                                                                                      | *No description.* |
| <code><a href="#cdktn.TerraformVariable.property.friendlyUniqueId">FriendlyUniqueId</a></code> | <code>\*string</code>                                                                                      | *No description.* |
| <code><a href="#cdktn.TerraformVariable.property.booleanValue">BooleanValue</a></code>         | <code><a href="#cdktn.IResolvable">IResolvable</a></code>                                                  | *No description.* |
| <code><a href="#cdktn.TerraformVariable.property.listValue">ListValue</a></code>               | <code>\*\[]\*string</code>                                                                                 | *No description.* |
| <code><a href="#cdktn.TerraformVariable.property.numberValue">NumberValue</a></code>           | <code>\*f64</code>                                                                                         | *No description.* |
| <code><a href="#cdktn.TerraformVariable.property.stringValue">StringValue</a></code>           | <code>\*string</code>                                                                                      | *No description.* |
| <code><a href="#cdktn.TerraformVariable.property.value">Value</a></code>                       | <code>interface\{}</code>                                                                                  | *No description.* |
| <code><a href="#cdktn.TerraformVariable.property.default">Default</a></code>                   | <code>interface\{}</code>                                                                                  | *No description.* |
| <code><a href="#cdktn.TerraformVariable.property.description">Description</a></code>           | <code>\*string</code>                                                                                      | *No description.* |
| <code><a href="#cdktn.TerraformVariable.property.nullable">Nullable</a></code>                 | <code>\*bool</code>                                                                                        | *No description.* |
| <code><a href="#cdktn.TerraformVariable.property.sensitive">Sensitive</a></code>               | <code>\*bool</code>                                                                                        | *No description.* |
| <code><a href="#cdktn.TerraformVariable.property.type">Type</a></code>                         | <code>\*string</code>                                                                                      | *No description.* |
| <code><a href="#cdktn.TerraformVariable.property.validation">Validation</a></code>             | <code>\*\[]<a href="#cdktn.TerraformVariableValidationConfig">TerraformVariableValidationConfig</a></code> | *No description.* |

***

### `Node`<sup>Required</sup> <a name="Node" id="cdktn.TerraformVariable.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.TerraformVariable.property.cdktfStack" />

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

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

***

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

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

* *Type:* \*string

***

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

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

* *Type:* \*string

***

### `BooleanValue`<sup>Required</sup> <a name="BooleanValue" id="cdktn.TerraformVariable.property.booleanValue" />

```go theme={null}
func BooleanValue() IResolvable
```

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

***

### `ListValue`<sup>Required</sup> <a name="ListValue" id="cdktn.TerraformVariable.property.listValue" />

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

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

***

### `NumberValue`<sup>Required</sup> <a name="NumberValue" id="cdktn.TerraformVariable.property.numberValue" />

```go theme={null}
func NumberValue() *f64
```

* *Type:* \*f64

***

### `StringValue`<sup>Required</sup> <a name="StringValue" id="cdktn.TerraformVariable.property.stringValue" />

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

* *Type:* \*string

***

### `Value`<sup>Required</sup> <a name="Value" id="cdktn.TerraformVariable.property.value" />

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

* *Type:* interface\{}

***

### `Default`<sup>Optional</sup> <a name="Default" id="cdktn.TerraformVariable.property.default" />

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

* *Type:* interface\{}

***

### `Description`<sup>Optional</sup> <a name="Description" id="cdktn.TerraformVariable.property.description" />

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

* *Type:* \*string

***

### `Nullable`<sup>Optional</sup> <a name="Nullable" id="cdktn.TerraformVariable.property.nullable" />

```go theme={null}
func Nullable() *bool
```

* *Type:* \*bool

***

### `Sensitive`<sup>Optional</sup> <a name="Sensitive" id="cdktn.TerraformVariable.property.sensitive" />

```go theme={null}
func Sensitive() *bool
```

* *Type:* \*bool

***

### `Type`<sup>Optional</sup> <a name="Type" id="cdktn.TerraformVariable.property.type" />

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

* *Type:* \*string

***

### `Validation`<sup>Optional</sup> <a name="Validation" id="cdktn.TerraformVariable.property.validation" />

```go theme={null}
func Validation() *[]TerraformVariableValidationConfig
```

* *Type:* \*\[]<a href="#cdktn.TerraformVariableValidationConfig">TerraformVariableValidationConfig</a>

***
