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

> CDKTN Core API Reference for TerraformVariable in Java.

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

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

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

TerraformVariable.Builder.create(Construct scope, java.lang.String id)
//  .default(java.lang.Object)
//  .description(java.lang.String)
//  .nullable(java.lang.Boolean)
//  .sensitive(java.lang.Boolean)
//  .type(java.lang.String)
//  .validation(java.util.List<TerraformVariableValidationConfig>)
    .build();
```

| **Name**                                                                                          | **Type**                                                                                                               | **Description**                                                                                                                              |
| ------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
| <code><a href="#cdktn.TerraformVariable.Initializer.parameter.scope">scope</a></code>             | <code>software.constructs.Construct</code>                                                                             | *No description.*                                                                                                                            |
| <code><a href="#cdktn.TerraformVariable.Initializer.parameter.id">id</a></code>                   | <code>java.lang.String</code>                                                                                          | *No description.*                                                                                                                            |
| <code><a href="#cdktn.TerraformVariable.Initializer.parameter.default">default</a></code>         | <code>java.lang.Object</code>                                                                                          | *No description.*                                                                                                                            |
| <code><a href="#cdktn.TerraformVariable.Initializer.parameter.description">description</a></code> | <code>java.lang.String</code>                                                                                          | *No description.*                                                                                                                            |
| <code><a href="#cdktn.TerraformVariable.Initializer.parameter.nullable">nullable</a></code>       | <code>java.lang.Boolean</code>                                                                                         | *No description.*                                                                                                                            |
| <code><a href="#cdktn.TerraformVariable.Initializer.parameter.sensitive">sensitive</a></code>     | <code>java.lang.Boolean</code>                                                                                         | *No description.*                                                                                                                            |
| <code><a href="#cdktn.TerraformVariable.Initializer.parameter.type">type</a></code>               | <code>java.lang.String</code>                                                                                          | The type argument in a variable block allows you to restrict the type of value that will be accepted as the value for a variable.            |
| <code><a href="#cdktn.TerraformVariable.Initializer.parameter.validation">validation</a></code>   | <code>java.util.List\<<a href="#cdktn.TerraformVariableValidationConfig">TerraformVariableValidationConfig</a>></code> | Specify arbitrary custom validation rules for a particular variable using a validation block nested within the corresponding variable block. |

***

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

* *Type:* software.constructs.Construct

***

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

* *Type:* java.lang.String

***

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

* *Type:* java.lang.Object

***

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

* *Type:* java.lang.String

***

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

* *Type:* java.lang.Boolean

***

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

* *Type:* java.lang.Boolean

***

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

* *Type:* java.lang.String

The type argument in a variable block allows you to restrict the type of value that will be accepted as the value for a variable.

If no type constraint is set then a value of any type is accepted.

While type constraints are optional, we recommend specifying them; they serve as easy reminders for users of the module, and allow Terraform to return a helpful error message if the wrong type is used.

Type constraints are created from a mixture of type keywords and type constructors. The supported type keywords are:

* string
* number
* bool

The type constructors allow you to specify complex types such as collections:

* list(\< TYPE >)
* set(\< TYPE >)
* map(\< TYPE >)
* object(\{\< ATTR NAME > = \< TYPE >, ... })
* tuple(\[\< TYPE >, ...])

The keyword any may be used to indicate that any type is acceptable. For more information on the meaning and behavior of these different types, as well as detailed information about automatic conversion of complex types, refer to [Type Constraints](https://developer.hashicorp.com/terraform/language/expressions/type-constraints).

If both the type and default arguments are specified, the given default value must be convertible to the specified type.

***

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

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

Specify arbitrary custom validation rules for a particular variable using a validation block nested within the corresponding variable block.

***

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

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

Returns a string representation of this construct.

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

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

The mixins to apply.

***

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

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

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

* *Type:* java.lang.String

***

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

* *Type:* java.lang.Object

***

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

* *Type:* java.lang.String

The new logical ID to use for this stack element.

***

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

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

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

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

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

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

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

```java theme={null}
public void addValidation(TerraformVariableValidationConfig validation)
```

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

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

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

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

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

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

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

* *Type:* java.lang.Object

Any object.

***

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

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

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

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

* *Type:* java.lang.Object

***

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

| **Name**                                                                                       | **Type**                                                                                                               | **Description**   |
| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ----------------- |
| <code><a href="#cdktn.TerraformVariable.property.node">node</a></code>                         | <code>software.constructs.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>java.lang.String</code>                                                                                          | *No description.* |
| <code><a href="#cdktn.TerraformVariable.property.friendlyUniqueId">friendlyUniqueId</a></code> | <code>java.lang.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>java.util.List\< java.lang.String ></code>                                                                       | *No description.* |
| <code><a href="#cdktn.TerraformVariable.property.numberValue">numberValue</a></code>           | <code>java.lang.Number</code>                                                                                          | *No description.* |
| <code><a href="#cdktn.TerraformVariable.property.stringValue">stringValue</a></code>           | <code>java.lang.String</code>                                                                                          | *No description.* |
| <code><a href="#cdktn.TerraformVariable.property.value">value</a></code>                       | <code>java.lang.Object</code>                                                                                          | *No description.* |
| <code><a href="#cdktn.TerraformVariable.property.default">default</a></code>                   | <code>java.lang.Object</code>                                                                                          | *No description.* |
| <code><a href="#cdktn.TerraformVariable.property.description">description</a></code>           | <code>java.lang.String</code>                                                                                          | *No description.* |
| <code><a href="#cdktn.TerraformVariable.property.nullable">nullable</a></code>                 | <code>java.lang.Boolean</code>                                                                                         | *No description.* |
| <code><a href="#cdktn.TerraformVariable.property.sensitive">sensitive</a></code>               | <code>java.lang.Boolean</code>                                                                                         | *No description.* |
| <code><a href="#cdktn.TerraformVariable.property.type">type</a></code>                         | <code>java.lang.String</code>                                                                                          | *No description.* |
| <code><a href="#cdktn.TerraformVariable.property.validation">validation</a></code>             | <code>java.util.List\<<a href="#cdktn.TerraformVariableValidationConfig">TerraformVariableValidationConfig</a>></code> | *No description.* |

***

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

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

* *Type:* software.constructs.Node

The tree node.

***

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

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

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

***

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

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

* *Type:* java.lang.String

***

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

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

* *Type:* java.lang.String

***

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

```java theme={null}
public IResolvable getBooleanValue();
```

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

***

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

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

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

***

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

```java theme={null}
public java.lang.Number getNumberValue();
```

* *Type:* java.lang.Number

***

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

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

* *Type:* java.lang.String

***

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

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

* *Type:* java.lang.Object

***

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

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

* *Type:* java.lang.Object

***

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

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

* *Type:* java.lang.String

***

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

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

* *Type:* java.lang.Boolean

***

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

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

* *Type:* java.lang.Boolean

***

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

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

* *Type:* java.lang.String

***

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

```java theme={null}
public java.util.List<TerraformVariableValidationConfig> getValidation();
```

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

***