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

> CDKTN Core API Reference for TerraformHclModule in Go.

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

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

cdktn.NewTerraformHclModule(scope Construct, id *string, options TerraformHclModuleConfig) TerraformHclModule
```

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

***

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

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

***

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

* *Type:* \*string

***

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

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

***

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

| **Name**                                                                                           | **Description**                                                                   |
| -------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- |
| <code><a href="#cdktn.TerraformHclModule.toString">ToString</a></code>                             | Returns a string representation of this construct.                                |
| <code><a href="#cdktn.TerraformHclModule.with">With</a></code>                                     | Applies one or more mixins to this construct.                                     |
| <code><a href="#cdktn.TerraformHclModule.addOverride">AddOverride</a></code>                       | *No description.*                                                                 |
| <code><a href="#cdktn.TerraformHclModule.overrideLogicalId">OverrideLogicalId</a></code>           | Overrides the auto-generated logical ID with a specific ID.                       |
| <code><a href="#cdktn.TerraformHclModule.resetOverrideLogicalId">ResetOverrideLogicalId</a></code> | Resets a previously passed logical Id to use the auto-generated logical id again. |
| <code><a href="#cdktn.TerraformHclModule.toHclTerraform">ToHclTerraform</a></code>                 | *No description.*                                                                 |
| <code><a href="#cdktn.TerraformHclModule.toMetadata">ToMetadata</a></code>                         | *No description.*                                                                 |
| <code><a href="#cdktn.TerraformHclModule.toTerraform">ToTerraform</a></code>                       | *No description.*                                                                 |
| <code><a href="#cdktn.TerraformHclModule.addProvider">AddProvider</a></code>                       | *No description.*                                                                 |
| <code><a href="#cdktn.TerraformHclModule.getString">GetString</a></code>                           | *No description.*                                                                 |
| <code><a href="#cdktn.TerraformHclModule.interpolationForOutput">InterpolationForOutput</a></code> | *No description.*                                                                 |
| <code><a href="#cdktn.TerraformHclModule.get">Get</a></code>                                       | *No description.*                                                                 |
| <code><a href="#cdktn.TerraformHclModule.getBoolean">GetBoolean</a></code>                         | *No description.*                                                                 |
| <code><a href="#cdktn.TerraformHclModule.getList">GetList</a></code>                               | *No description.*                                                                 |
| <code><a href="#cdktn.TerraformHclModule.getNumber">GetNumber</a></code>                           | *No description.*                                                                 |
| <code><a href="#cdktn.TerraformHclModule.set">Set</a></code>                                       | *No description.*                                                                 |

***

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

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

Returns a string representation of this construct.

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

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

The mixins to apply.

***

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

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

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

* *Type:* \*string

***

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

* *Type:* interface\{}

***

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

* *Type:* \*string

The new logical ID to use for this stack element.

***

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

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

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

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

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

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

### `AddProvider` <a name="AddProvider" id="cdktn.TerraformHclModule.addProvider" />

```go theme={null}
func AddProvider(provider interface{})
```

#### `provider`<sup>Required</sup> <a name="provider" id="cdktn.TerraformHclModule.addProvider.parameter.provider" />

* *Type:* interface\{}

***

### `GetString` <a name="GetString" id="cdktn.TerraformHclModule.getString" />

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

#### `output`<sup>Required</sup> <a name="output" id="cdktn.TerraformHclModule.getString.parameter.output" />

* *Type:* \*string

***

### `InterpolationForOutput` <a name="InterpolationForOutput" id="cdktn.TerraformHclModule.interpolationForOutput" />

```go theme={null}
func InterpolationForOutput(moduleOutput *string) IResolvable
```

#### `moduleOutput`<sup>Required</sup> <a name="moduleOutput" id="cdktn.TerraformHclModule.interpolationForOutput.parameter.moduleOutput" />

* *Type:* \*string

***

### `Get` <a name="Get" id="cdktn.TerraformHclModule.get" />

```go theme={null}
func Get(output *string) interface{}
```

#### `output`<sup>Required</sup> <a name="output" id="cdktn.TerraformHclModule.get.parameter.output" />

* *Type:* \*string

***

### `GetBoolean` <a name="GetBoolean" id="cdktn.TerraformHclModule.getBoolean" />

```go theme={null}
func GetBoolean(output *string) IResolvable
```

#### `output`<sup>Required</sup> <a name="output" id="cdktn.TerraformHclModule.getBoolean.parameter.output" />

* *Type:* \*string

***

### `GetList` <a name="GetList" id="cdktn.TerraformHclModule.getList" />

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

#### `output`<sup>Required</sup> <a name="output" id="cdktn.TerraformHclModule.getList.parameter.output" />

* *Type:* \*string

***

### `GetNumber` <a name="GetNumber" id="cdktn.TerraformHclModule.getNumber" />

```go theme={null}
func GetNumber(output *string) *f64
```

#### `output`<sup>Required</sup> <a name="output" id="cdktn.TerraformHclModule.getNumber.parameter.output" />

* *Type:* \*string

***

### `Set` <a name="Set" id="cdktn.TerraformHclModule.set" />

```go theme={null}
func Set(variable *string, value interface{})
```

#### `variable`<sup>Required</sup> <a name="variable" id="cdktn.TerraformHclModule.set.parameter.variable" />

* *Type:* \*string

***

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

* *Type:* interface\{}

***

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

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

***

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

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

cdktn.TerraformHclModule_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.TerraformHclModule.isConstruct.parameter.x" />

* *Type:* interface\{}

Any object.

***

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

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

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

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

* *Type:* interface\{}

***

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

| **Name**                                                                                                                          | **Type**                                                                | **Description**   |
| --------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------- |
| <code><a href="#cdktn.TerraformHclModule.property.node">Node</a></code>                                                           | <code>github.com/aws/constructs-go/constructs/v10.Node</code>           | The tree node.    |
| <code><a href="#cdktn.TerraformHclModule.property.cdktfStack">CdktfStack</a></code>                                               | <code><a href="#cdktn.TerraformStack">TerraformStack</a></code>         | *No description.* |
| <code><a href="#cdktn.TerraformHclModule.property.fqn">Fqn</a></code>                                                             | <code>\*string</code>                                                   | *No description.* |
| <code><a href="#cdktn.TerraformHclModule.property.friendlyUniqueId">FriendlyUniqueId</a></code>                                   | <code>\*string</code>                                                   | *No description.* |
| <code><a href="#cdktn.TerraformHclModule.property.source">Source</a></code>                                                       | <code>\*string</code>                                                   | *No description.* |
| <code><a href="#cdktn.TerraformHclModule.property.providers">Providers</a></code>                                                 | <code>\*\[]interface\{}</code>                                          | *No description.* |
| <code><a href="#cdktn.TerraformHclModule.property.skipAssetCreationFromLocalModules">SkipAssetCreationFromLocalModules</a></code> | <code>\*bool</code>                                                     | *No description.* |
| <code><a href="#cdktn.TerraformHclModule.property.version">Version</a></code>                                                     | <code>\*string</code>                                                   | *No description.* |
| <code><a href="#cdktn.TerraformHclModule.property.dependsOn">DependsOn</a></code>                                                 | <code>\*\[]\*string</code>                                              | *No description.* |
| <code><a href="#cdktn.TerraformHclModule.property.forEach">ForEach</a></code>                                                     | <code><a href="#cdktn.ITerraformIterator">ITerraformIterator</a></code> | *No description.* |
| <code><a href="#cdktn.TerraformHclModule.property.variables">Variables</a></code>                                                 | <code>\*map\[string]interface\{}</code>                                 | *No description.* |

***

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

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

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

***

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

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

* *Type:* \*string

***

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

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

* *Type:* \*string

***

### `Source`<sup>Required</sup> <a name="Source" id="cdktn.TerraformHclModule.property.source" />

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

* *Type:* \*string

***

### `Providers`<sup>Optional</sup> <a name="Providers" id="cdktn.TerraformHclModule.property.providers" />

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

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

***

### `SkipAssetCreationFromLocalModules`<sup>Optional</sup> <a name="SkipAssetCreationFromLocalModules" id="cdktn.TerraformHclModule.property.skipAssetCreationFromLocalModules" />

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

* *Type:* \*bool

***

### `Version`<sup>Optional</sup> <a name="Version" id="cdktn.TerraformHclModule.property.version" />

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

* *Type:* \*string

***

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

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

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

***

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

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

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

***

### `Variables`<sup>Optional</sup> <a name="Variables" id="cdktn.TerraformHclModule.property.variables" />

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

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

***
