Typescript: DataTerraformRemoteStateConsulConfig

CDKTN Core API Reference for DataTerraformRemoteStateConsulConfig in Typescript.

Initializer

import { DataTerraformRemoteStateConsulConfig } from 'cdktn'

const dataTerraformRemoteStateConsulConfig: DataTerraformRemoteStateConsulConfig = { ... }

Properties

Name	Type	Description
defaults	{[ key: string ]: any}	No description.
workspace	string	No description.
accessToken	string	(Required) Access token.
path	string	(Required) Path in the Consul KV store.
address	string	(Optional) DNS name and port of your Consul endpoint specified in the format dnsname:port.
caFile	string	(Optional) A path to a PEM-encoded certificate authority used to verify the remote agent’s certificate.
certFile	string	(Optional) A path to a PEM-encoded certificate provided to the remote agent;
datacenter	string	(Optional) The datacenter to use.
gzip	boolean	(Optional) true to compress the state data using gzip, or false (the default) to leave it uncompressed.
httpAuth	string	(Optional) HTTP Basic Authentication credentials to be used when communicating with Consul, in the format of either user or user:pass.
keyFile	string	(Optional) A path to a PEM-encoded private key, required if cert_file is specified.
lock	boolean	(Optional) false to disable locking.
scheme	string	(Optional) Specifies what protocol to use when talking to the given address,either http or https.

---

defaults^Optional

public readonly defaults: {[ key: string ]: any};

• Type: {[ key: string ]: any}

---

workspace^Optional

public readonly workspace: string;

• Type: string

---

accessToken^Required

public readonly accessToken: string;

• Type: string

(Required) Access token.

---

path^Required

public readonly path: string;

• Type: string

(Required) Path in the Consul KV store.

---

address^Optional

public readonly address: string;

• Type: string

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

Defaults to the local agent HTTP listener.

---

caFile^Optional

public readonly caFile: string;

• Type: string

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

---

certFile^Optional

public readonly certFile: string;

• Type: string

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

requires use of key_file.

---

datacenter^Optional

public readonly datacenter: string;

• Type: string

(Optional) The datacenter to use.

Defaults to that of the agent.

---

gzip^Optional

public readonly gzip: boolean;

• Type: boolean

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

---

httpAuth^Optional

public readonly httpAuth: string;

• Type: string

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

---

keyFile^Optional

public readonly keyFile: string;

• Type: string

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

---

lock^Optional

public readonly lock: boolean;

• Type: 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^Optional

public readonly scheme: string;

• Type: 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.

---