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

> CDKTN Core API Reference for DataTerraformRemoteStateConsulConfig in Java.

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

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

DataTerraformRemoteStateConsulConfig.builder()
//  .defaults(java.util.Map<java.lang.String, java.lang.Object>)
//  .workspace(java.lang.String)
    .accessToken(java.lang.String)
    .path(java.lang.String)
//  .address(java.lang.String)
//  .caFile(java.lang.String)
//  .certFile(java.lang.String)
//  .datacenter(java.lang.String)
//  .gzip(java.lang.Boolean)
//  .httpAuth(java.lang.String)
//  .keyFile(java.lang.String)
//  .lock(java.lang.Boolean)
//  .scheme(java.lang.String)
    .build();
```

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

| **Name**                                                                                                | **Type**                                                          | **Description**                                                                                                                        |
| ------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- |
| <code><a href="#cdktn.DataTerraformRemoteStateConsulConfig.property.defaults">defaults</a></code>       | <code>java.util.Map\< java.lang.String, java.lang.Object ></code> | *No description.*                                                                                                                      |
| <code><a href="#cdktn.DataTerraformRemoteStateConsulConfig.property.workspace">workspace</a></code>     | <code>java.lang.String</code>                                     | *No description.*                                                                                                                      |
| <code><a href="#cdktn.DataTerraformRemoteStateConsulConfig.property.accessToken">accessToken</a></code> | <code>java.lang.String</code>                                     | (Required) Access token.                                                                                                               |
| <code><a href="#cdktn.DataTerraformRemoteStateConsulConfig.property.path">path</a></code>               | <code>java.lang.String</code>                                     | (Required) Path in the Consul KV store.                                                                                                |
| <code><a href="#cdktn.DataTerraformRemoteStateConsulConfig.property.address">address</a></code>         | <code>java.lang.String</code>                                     | (Optional) DNS name and port of your Consul endpoint specified in the format dnsname:port.                                             |
| <code><a href="#cdktn.DataTerraformRemoteStateConsulConfig.property.caFile">caFile</a></code>           | <code>java.lang.String</code>                                     | (Optional) A path to a PEM-encoded certificate authority used to verify the remote agent's certificate.                                |
| <code><a href="#cdktn.DataTerraformRemoteStateConsulConfig.property.certFile">certFile</a></code>       | <code>java.lang.String</code>                                     | (Optional) A path to a PEM-encoded certificate provided to the remote agent;                                                           |
| <code><a href="#cdktn.DataTerraformRemoteStateConsulConfig.property.datacenter">datacenter</a></code>   | <code>java.lang.String</code>                                     | (Optional) The datacenter to use.                                                                                                      |
| <code><a href="#cdktn.DataTerraformRemoteStateConsulConfig.property.gzip">gzip</a></code>               | <code>java.lang.Boolean</code>                                    | (Optional) true to compress the state data using gzip, or false (the default) to leave it uncompressed.                                |
| <code><a href="#cdktn.DataTerraformRemoteStateConsulConfig.property.httpAuth">httpAuth</a></code>       | <code>java.lang.String</code>                                     | (Optional) HTTP Basic Authentication credentials to be used when communicating with Consul, in the format of either user or user:pass. |
| <code><a href="#cdktn.DataTerraformRemoteStateConsulConfig.property.keyFile">keyFile</a></code>         | <code>java.lang.String</code>                                     | (Optional) A path to a PEM-encoded private key, required if cert\_file is specified.                                                   |
| <code><a href="#cdktn.DataTerraformRemoteStateConsulConfig.property.lock">lock</a></code>               | <code>java.lang.Boolean</code>                                    | (Optional) false to disable locking.                                                                                                   |
| <code><a href="#cdktn.DataTerraformRemoteStateConsulConfig.property.scheme">scheme</a></code>           | <code>java.lang.String</code>                                     | (Optional) Specifies what protocol to use when talking to the given address,either http or https.                                      |

***

### `defaults`<sup>Optional</sup> <a name="defaults" id="cdktn.DataTerraformRemoteStateConsulConfig.property.defaults" />

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

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

***

### `workspace`<sup>Optional</sup> <a name="workspace" id="cdktn.DataTerraformRemoteStateConsulConfig.property.workspace" />

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

* *Type:* java.lang.String

***

### `accessToken`<sup>Required</sup> <a name="accessToken" id="cdktn.DataTerraformRemoteStateConsulConfig.property.accessToken" />

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

* *Type:* java.lang.String

(Required) Access token.

***

### `path`<sup>Required</sup> <a name="path" id="cdktn.DataTerraformRemoteStateConsulConfig.property.path" />

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

* *Type:* java.lang.String

(Required) Path in the Consul KV store.

***

### `address`<sup>Optional</sup> <a name="address" id="cdktn.DataTerraformRemoteStateConsulConfig.property.address" />

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

* *Type:* java.lang.String

(Optional) DNS name and port of your Consul endpoint specified in the format dnsname:port.

Defaults to the local agent HTTP listener.

***

### `caFile`<sup>Optional</sup> <a name="caFile" id="cdktn.DataTerraformRemoteStateConsulConfig.property.caFile" />

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

* *Type:* java.lang.String

(Optional) A path to a PEM-encoded certificate authority used to verify the remote agent's certificate.

***

### `certFile`<sup>Optional</sup> <a name="certFile" id="cdktn.DataTerraformRemoteStateConsulConfig.property.certFile" />

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

* *Type:* java.lang.String

(Optional) A path to a PEM-encoded certificate provided to the remote agent;

requires use of key\_file.

***

### `datacenter`<sup>Optional</sup> <a name="datacenter" id="cdktn.DataTerraformRemoteStateConsulConfig.property.datacenter" />

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

* *Type:* java.lang.String

(Optional) The datacenter to use.

Defaults to that of the agent.

***

### `gzip`<sup>Optional</sup> <a name="gzip" id="cdktn.DataTerraformRemoteStateConsulConfig.property.gzip" />

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

* *Type:* java.lang.Boolean

(Optional) true to compress the state data using gzip, or false (the default) to leave it uncompressed.

***

### `httpAuth`<sup>Optional</sup> <a name="httpAuth" id="cdktn.DataTerraformRemoteStateConsulConfig.property.httpAuth" />

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

* *Type:* java.lang.String

(Optional) HTTP Basic Authentication credentials to be used when communicating with Consul, in the format of either user or user:pass.

***

### `keyFile`<sup>Optional</sup> <a name="keyFile" id="cdktn.DataTerraformRemoteStateConsulConfig.property.keyFile" />

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

* *Type:* java.lang.String

(Optional) A path to a PEM-encoded private key, required if cert\_file is specified.

***

### `lock`<sup>Optional</sup> <a name="lock" id="cdktn.DataTerraformRemoteStateConsulConfig.property.lock" />

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

* *Type:* java.lang.Boolean

(Optional) false to disable locking.

This defaults to true, but will require session permissions with Consul and
at least kv write permissions on \$path/.lock to perform locking.

***

### `scheme`<sup>Optional</sup> <a name="scheme" id="cdktn.DataTerraformRemoteStateConsulConfig.property.scheme" />

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

* *Type:* java.lang.String

(Optional) Specifies what protocol to use when talking to the given address,either http or https.

SSL support can also be triggered by setting then environment variable CONSUL\_HTTP\_SSL to true.

***