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

> CDKTN Core API Reference for TerraformProvider in Java.

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

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

TerraformProvider.Builder.create(Construct scope, java.lang.String id)
    .terraformResourceType(java.lang.String)
//  .terraformGeneratorMetadata(TerraformProviderGeneratorMetadata)
//  .terraformProviderSource(java.lang.String)
    .build();
```

| **Name**                                                                                                                        | **Type**                                                                                                | **Description**   |
| ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ----------------- |
| <code><a href="#cdktn.TerraformProvider.Initializer.parameter.scope">scope</a></code>                                           | <code>software.constructs.Construct</code>                                                              | *No description.* |
| <code><a href="#cdktn.TerraformProvider.Initializer.parameter.id">id</a></code>                                                 | <code>java.lang.String</code>                                                                           | *No description.* |
| <code><a href="#cdktn.TerraformProvider.Initializer.parameter.terraformResourceType">terraformResourceType</a></code>           | <code>java.lang.String</code>                                                                           | *No description.* |
| <code><a href="#cdktn.TerraformProvider.Initializer.parameter.terraformGeneratorMetadata">terraformGeneratorMetadata</a></code> | <code><a href="#cdktn.TerraformProviderGeneratorMetadata">TerraformProviderGeneratorMetadata</a></code> | *No description.* |
| <code><a href="#cdktn.TerraformProvider.Initializer.parameter.terraformProviderSource">terraformProviderSource</a></code>       | <code>java.lang.String</code>                                                                           | *No description.* |

***

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

* *Type:* software.constructs.Construct

***

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

* *Type:* java.lang.String

***

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

* *Type:* java.lang.String

***

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

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

***

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

* *Type:* java.lang.String

***

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

| **Name**                                                                                          | **Description**                                                                   |
| ------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- |
| <code><a href="#cdktn.TerraformProvider.toString">toString</a></code>                             | Returns a string representation of this construct.                                |
| <code><a href="#cdktn.TerraformProvider.with">with</a></code>                                     | Applies one or more mixins to this construct.                                     |
| <code><a href="#cdktn.TerraformProvider.addOverride">addOverride</a></code>                       | *No description.*                                                                 |
| <code><a href="#cdktn.TerraformProvider.overrideLogicalId">overrideLogicalId</a></code>           | Overrides the auto-generated logical ID with a specific ID.                       |
| <code><a href="#cdktn.TerraformProvider.resetOverrideLogicalId">resetOverrideLogicalId</a></code> | Resets a previously passed logical Id to use the auto-generated logical id again. |
| <code><a href="#cdktn.TerraformProvider.toHclTerraform">toHclTerraform</a></code>                 | *No description.*                                                                 |
| <code><a href="#cdktn.TerraformProvider.toMetadata">toMetadata</a></code>                         | *No description.*                                                                 |
| <code><a href="#cdktn.TerraformProvider.toTerraform">toTerraform</a></code>                       | Adds this resource to the terraform JSON output.                                  |

***

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

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

Returns a string representation of this construct.

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

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

The mixins to apply.

***

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

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

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

* *Type:* java.lang.String

***

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

* *Type:* java.lang.Object

***

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

* *Type:* java.lang.String

The new logical ID to use for this stack element.

***

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

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

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

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

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

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

Adds this resource to the terraform JSON output.

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

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

***

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

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

TerraformProvider.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.TerraformProvider.isConstruct.parameter.x" />

* *Type:* java.lang.Object

Any object.

***

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

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

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

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

* *Type:* java.lang.Object

***

### `isTerraformProvider` <a name="isTerraformProvider" id="cdktn.TerraformProvider.isTerraformProvider" />

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

TerraformProvider.isTerraformProvider(java.lang.Object x)
```

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

* *Type:* java.lang.Object

***

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

| **Name**                                                                                                           | **Type**                                                                                                | **Description**   |
| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------- | ----------------- |
| <code><a href="#cdktn.TerraformProvider.property.node">node</a></code>                                             | <code>software.constructs.Node</code>                                                                   | The tree node.    |
| <code><a href="#cdktn.TerraformProvider.property.cdktfStack">cdktfStack</a></code>                                 | <code><a href="#cdktn.TerraformStack">TerraformStack</a></code>                                         | *No description.* |
| <code><a href="#cdktn.TerraformProvider.property.fqn">fqn</a></code>                                               | <code>java.lang.String</code>                                                                           | *No description.* |
| <code><a href="#cdktn.TerraformProvider.property.friendlyUniqueId">friendlyUniqueId</a></code>                     | <code>java.lang.String</code>                                                                           | *No description.* |
| <code><a href="#cdktn.TerraformProvider.property.metaAttributes">metaAttributes</a></code>                         | <code>java.util.Map\< java.lang.String, java.lang.Object ></code>                                       | *No description.* |
| <code><a href="#cdktn.TerraformProvider.property.terraformResourceType">terraformResourceType</a></code>           | <code>java.lang.String</code>                                                                           | *No description.* |
| <code><a href="#cdktn.TerraformProvider.property.terraformGeneratorMetadata">terraformGeneratorMetadata</a></code> | <code><a href="#cdktn.TerraformProviderGeneratorMetadata">TerraformProviderGeneratorMetadata</a></code> | *No description.* |
| <code><a href="#cdktn.TerraformProvider.property.terraformProviderSource">terraformProviderSource</a></code>       | <code>java.lang.String</code>                                                                           | *No description.* |
| <code><a href="#cdktn.TerraformProvider.property.alias">alias</a></code>                                           | <code>java.lang.String</code>                                                                           | *No description.* |

***

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

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

* *Type:* software.constructs.Node

The tree node.

***

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

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

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

***

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

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

* *Type:* java.lang.String

***

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

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

* *Type:* java.lang.String

***

### `metaAttributes`<sup>Required</sup> <a name="metaAttributes" id="cdktn.TerraformProvider.property.metaAttributes" />

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

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

***

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

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

* *Type:* java.lang.String

***

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

```java theme={null}
public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata();
```

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

***

### `terraformProviderSource`<sup>Optional</sup> <a name="terraformProviderSource" id="cdktn.TerraformProvider.property.terraformProviderSource" />

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

* *Type:* java.lang.String

***

### `alias`<sup>Optional</sup> <a name="alias" id="cdktn.TerraformProvider.property.alias" />

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

* *Type:* java.lang.String

***