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

# CSharp: TerraformModule

> CDKTN Core API Reference for TerraformModule in CSharp.

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

TerraformModule can be used to reference a local terraform module or a module from the Terraform Registry.

It should be used if you can not use generated bindings for the module as you would get by adding the module
to your cdktf.json files "terraformModules" array and running cdktn get.

This class is not creating a Terraform module to be used outside of CDKTN.
If you want to bundle certain resources together like you would do with a Terraform module,
you should use Constructs instead, see [http://cdk.tf/constructs](http://cdk.tf/constructs) for more details.

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

```csharp theme={null}
using Io.Cdktn;

new TerraformModule(Construct Scope, string Id, TerraformModuleConfig Options);
```

| **Name**                                                                                | **Type**                                                                      | **Description**   |
| --------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------- |
| <code><a href="#cdktn.TerraformModule.Initializer.parameter.scope">Scope</a></code>     | <code>Constructs.Construct</code>                                             | *No description.* |
| <code><a href="#cdktn.TerraformModule.Initializer.parameter.id">Id</a></code>           | <code>string</code>                                                           | *No description.* |
| <code><a href="#cdktn.TerraformModule.Initializer.parameter.options">Options</a></code> | <code><a href="#cdktn.TerraformModuleConfig">TerraformModuleConfig</a></code> | *No description.* |

***

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

* *Type:* Constructs.Construct

***

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

* *Type:* string

***

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

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

***

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

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

***

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

```csharp theme={null}
private string ToString()
```

Returns a string representation of this construct.

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

```csharp theme={null}
private IConstruct With(params 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.TerraformModule.with.parameter.mixins" />

* *Type:* params Constructs.IMixin\[]

The mixins to apply.

***

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

```csharp theme={null}
private void AddOverride(string Path, object Value)
```

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

* *Type:* string

***

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

* *Type:* object

***

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

```csharp theme={null}
private void OverrideLogicalId(string NewLogicalId)
```

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

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

* *Type:* string

The new logical ID to use for this stack element.

***

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

```csharp theme={null}
private void ResetOverrideLogicalId()
```

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

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

```csharp theme={null}
private object ToHclTerraform()
```

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

```csharp theme={null}
private object ToMetadata()
```

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

```csharp theme={null}
private object ToTerraform()
```

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

```csharp theme={null}
private void AddProvider(TerraformProvider|TerraformModuleProvider Provider)
```

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

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

***

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

```csharp theme={null}
private string GetString(string Output)
```

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

* *Type:* string

***

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

```csharp theme={null}
private IResolvable InterpolationForOutput(string ModuleOutput)
```

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

* *Type:* string

***

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

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

***

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

```csharp theme={null}
using Io.Cdktn;

TerraformModule.IsConstruct(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.TerraformModule.isConstruct.parameter.x" />

* *Type:* object

Any object.

***

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

```csharp theme={null}
using Io.Cdktn;

TerraformModule.IsTerraformElement(object X);
```

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

* *Type:* object

***

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

| **Name**                                                                                                                       | **Type**                                                                                                                                       | **Description**   |
| ------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------- | ----------------- |
| <code><a href="#cdktn.TerraformModule.property.node">Node</a></code>                                                           | <code>Constructs.Node</code>                                                                                                                   | The tree node.    |
| <code><a href="#cdktn.TerraformModule.property.cdktfStack">CdktfStack</a></code>                                               | <code><a href="#cdktn.TerraformStack">TerraformStack</a></code>                                                                                | *No description.* |
| <code><a href="#cdktn.TerraformModule.property.fqn">Fqn</a></code>                                                             | <code>string</code>                                                                                                                            | *No description.* |
| <code><a href="#cdktn.TerraformModule.property.friendlyUniqueId">FriendlyUniqueId</a></code>                                   | <code>string</code>                                                                                                                            | *No description.* |
| <code><a href="#cdktn.TerraformModule.property.source">Source</a></code>                                                       | <code>string</code>                                                                                                                            | *No description.* |
| <code><a href="#cdktn.TerraformModule.property.providers">Providers</a></code>                                                 | <code><a href="#cdktn.TerraformProvider">TerraformProvider</a>\|<a href="#cdktn.TerraformModuleProvider">TerraformModuleProvider</a>\[]</code> | *No description.* |
| <code><a href="#cdktn.TerraformModule.property.skipAssetCreationFromLocalModules">SkipAssetCreationFromLocalModules</a></code> | <code>bool</code>                                                                                                                              | *No description.* |
| <code><a href="#cdktn.TerraformModule.property.version">Version</a></code>                                                     | <code>string</code>                                                                                                                            | *No description.* |
| <code><a href="#cdktn.TerraformModule.property.dependsOn">DependsOn</a></code>                                                 | <code>string\[]</code>                                                                                                                         | *No description.* |
| <code><a href="#cdktn.TerraformModule.property.forEach">ForEach</a></code>                                                     | <code><a href="#cdktn.ITerraformIterator">ITerraformIterator</a></code>                                                                        | *No description.* |

***

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

```csharp theme={null}
public Node Node { get; }
```

* *Type:* Constructs.Node

The tree node.

***

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

```csharp theme={null}
public TerraformStack CdktfStack { get; }
```

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

***

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

```csharp theme={null}
public string Fqn { get; }
```

* *Type:* string

***

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

```csharp theme={null}
public string FriendlyUniqueId { get; }
```

* *Type:* string

***

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

```csharp theme={null}
public string Source { get; }
```

* *Type:* string

***

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

```csharp theme={null}
public (TerraformProvider|TerraformModuleProvider)[] Providers { get; }
```

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

***

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

```csharp theme={null}
public bool SkipAssetCreationFromLocalModules { get; }
```

* *Type:* bool

***

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

```csharp theme={null}
public string Version { get; }
```

* *Type:* string

***

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

```csharp theme={null}
public string[] DependsOn { get; }
```

* *Type:* string\[]

***

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

```csharp theme={null}
public ITerraformIterator ForEach { get; }
```

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

***
