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

> CDKTN Core API Reference for TerraformHclModule in Java.

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

```java theme={null}
import io.cdktn.cdktn.TerraformHclModule;

TerraformHclModule.Builder.create(Construct scope, java.lang.String id)
//  .dependsOn(java.util.List<ITerraformDependable>)
//  .forEach(ITerraformIterator)
//  .providers(java.util.List<TerraformProvider|TerraformModuleProvider>)
//  .skipAssetCreationFromLocalModules(java.lang.Boolean)
    .source(java.lang.String)
//  .version(java.lang.String)
//  .variables(java.util.Map<java.lang.String, java.lang.Object>)
    .build();
```

| **Name**                                                                                                                                       | **Type**                                                                                                                                                     | **Description**   |
| ---------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------- |
| <code><a href="#cdktn.TerraformHclModule.Initializer.parameter.scope">scope</a></code>                                                         | <code>software.constructs.Construct</code>                                                                                                                   | *No description.* |
| <code><a href="#cdktn.TerraformHclModule.Initializer.parameter.id">id</a></code>                                                               | <code>java.lang.String</code>                                                                                                                                | *No description.* |
| <code><a href="#cdktn.TerraformHclModule.Initializer.parameter.dependsOn">dependsOn</a></code>                                                 | <code>java.util.List\<<a href="#cdktn.ITerraformDependable">ITerraformDependable</a>></code>                                                                 | *No description.* |
| <code><a href="#cdktn.TerraformHclModule.Initializer.parameter.forEach">forEach</a></code>                                                     | <code><a href="#cdktn.ITerraformIterator">ITerraformIterator</a></code>                                                                                      | *No description.* |
| <code><a href="#cdktn.TerraformHclModule.Initializer.parameter.providers">providers</a></code>                                                 | <code>java.util.List\<<a href="#cdktn.TerraformProvider">TerraformProvider</a>\|<a href="#cdktn.TerraformModuleProvider">TerraformModuleProvider</a>></code> | *No description.* |
| <code><a href="#cdktn.TerraformHclModule.Initializer.parameter.skipAssetCreationFromLocalModules">skipAssetCreationFromLocalModules</a></code> | <code>java.lang.Boolean</code>                                                                                                                               | *No description.* |
| <code><a href="#cdktn.TerraformHclModule.Initializer.parameter.source">source</a></code>                                                       | <code>java.lang.String</code>                                                                                                                                | *No description.* |
| <code><a href="#cdktn.TerraformHclModule.Initializer.parameter.version">version</a></code>                                                     | <code>java.lang.String</code>                                                                                                                                | *No description.* |
| <code><a href="#cdktn.TerraformHclModule.Initializer.parameter.variables">variables</a></code>                                                 | <code>java.util.Map\< java.lang.String, java.lang.Object ></code>                                                                                            | *No description.* |

***

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

* *Type:* software.constructs.Construct

***

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

* *Type:* java.lang.String

***

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

* *Type:* java.util.List\<<a href="#cdktn.ITerraformDependable">ITerraformDependable</a>>

***

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

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

***

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

* *Type:* java.util.List\<<a href="#cdktn.TerraformProvider">TerraformProvider</a>|<a href="#cdktn.TerraformModuleProvider">TerraformModuleProvider</a>>

***

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

* *Type:* java.lang.Boolean

***

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

* *Type:* java.lang.String

***

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

* *Type:* java.lang.String

***

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

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

***

## 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" />

```java theme={null}
public java.lang.String toString()
```

Returns a string representation of this construct.

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

* *Type:* software.constructs.IMixin...

The mixins to apply.

***

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

```java theme={null}
public void addOverride(java.lang.String path, java.lang.Object value)
```

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

* *Type:* java.lang.String

***

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

* *Type:* java.lang.Object

***

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

```java theme={null}
public void overrideLogicalId(java.lang.String newLogicalId)
```

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

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

* *Type:* java.lang.String

The new logical ID to use for this stack element.

***

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

```java theme={null}
public void resetOverrideLogicalId()
```

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

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

```java theme={null}
public java.lang.Object toHclTerraform()
```

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

```java theme={null}
public java.lang.Object toMetadata()
```

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

```java theme={null}
public java.lang.Object toTerraform()
```

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

```java theme={null}
public void addProvider(TerraformProvider|TerraformModuleProvider provider)
```

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

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

***

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

```java theme={null}
public java.lang.String getString(java.lang.String output)
```

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

* *Type:* java.lang.String

***

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

```java theme={null}
public IResolvable interpolationForOutput(java.lang.String moduleOutput)
```

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

* *Type:* java.lang.String

***

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

```java theme={null}
public java.lang.Object get(java.lang.String output)
```

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

* *Type:* java.lang.String

***

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

```java theme={null}
public IResolvable getBoolean(java.lang.String output)
```

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

* *Type:* java.lang.String

***

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

```java theme={null}
public java.util.List<java.lang.String> getList(java.lang.String output)
```

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

* *Type:* java.lang.String

***

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

```java theme={null}
public java.lang.Number getNumber(java.lang.String output)
```

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

* *Type:* java.lang.String

***

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

```java theme={null}
public void set(java.lang.String variable, java.lang.Object value)
```

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

* *Type:* java.lang.String

***

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

* *Type:* java.lang.Object

***

## 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" />

```java theme={null}
import io.cdktn.cdktn.TerraformHclModule;

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

* *Type:* java.lang.Object

Any object.

***

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

```java theme={null}
import io.cdktn.cdktn.TerraformHclModule;

TerraformHclModule.isTerraformElement(java.lang.Object x)
```

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

* *Type:* java.lang.Object

***

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

| **Name**                                                                                                                          | **Type**                                                                                                                                                     | **Description**   |
| --------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------- |
| <code><a href="#cdktn.TerraformHclModule.property.node">node</a></code>                                                           | <code>software.constructs.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>java.lang.String</code>                                                                                                                                | *No description.* |
| <code><a href="#cdktn.TerraformHclModule.property.friendlyUniqueId">friendlyUniqueId</a></code>                                   | <code>java.lang.String</code>                                                                                                                                | *No description.* |
| <code><a href="#cdktn.TerraformHclModule.property.source">source</a></code>                                                       | <code>java.lang.String</code>                                                                                                                                | *No description.* |
| <code><a href="#cdktn.TerraformHclModule.property.providers">providers</a></code>                                                 | <code>java.util.List\<<a href="#cdktn.TerraformProvider">TerraformProvider</a>\|<a href="#cdktn.TerraformModuleProvider">TerraformModuleProvider</a>></code> | *No description.* |
| <code><a href="#cdktn.TerraformHclModule.property.skipAssetCreationFromLocalModules">skipAssetCreationFromLocalModules</a></code> | <code>java.lang.Boolean</code>                                                                                                                               | *No description.* |
| <code><a href="#cdktn.TerraformHclModule.property.version">version</a></code>                                                     | <code>java.lang.String</code>                                                                                                                                | *No description.* |
| <code><a href="#cdktn.TerraformHclModule.property.dependsOn">dependsOn</a></code>                                                 | <code>java.util.List\< java.lang.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>java.util.Map\< java.lang.String, java.lang.Object ></code>                                                                                            | *No description.* |

***

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

```java theme={null}
public Node getNode();
```

* *Type:* software.constructs.Node

The tree node.

***

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

```java theme={null}
public TerraformStack getCdktfStack();
```

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

***

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

```java theme={null}
public java.lang.String getFqn();
```

* *Type:* java.lang.String

***

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

```java theme={null}
public java.lang.String getFriendlyUniqueId();
```

* *Type:* java.lang.String

***

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

```java theme={null}
public java.lang.String getSource();
```

* *Type:* java.lang.String

***

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

```java theme={null}
public java.util.List<TerraformProvider|TerraformModuleProvider> getProviders();
```

* *Type:* java.util.List\<<a href="#cdktn.TerraformProvider">TerraformProvider</a>|<a href="#cdktn.TerraformModuleProvider">TerraformModuleProvider</a>>

***

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

```java theme={null}
public java.lang.Boolean getSkipAssetCreationFromLocalModules();
```

* *Type:* java.lang.Boolean

***

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

```java theme={null}
public java.lang.String getVersion();
```

* *Type:* java.lang.String

***

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

```java theme={null}
public java.util.List<java.lang.String> getDependsOn();
```

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

***

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

```java theme={null}
public ITerraformIterator getForEach();
```

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

***

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

```java theme={null}
public java.util.Map<java.lang.String, java.lang.Object> getVariables();
```

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

***