Skip to main content

​
Initializer 

import { DataTerraformRemoteStateConsulConfig } from 'cdktn'

const dataTerraformRemoteStateConsulConfig: DataTerraformRemoteStateConsulConfig = { ... }

​
Properties

NameTypeDescription
defaults{[ key: string ]: any}No description.
workspacestringNo description.
accessTokenstring(Required) Access token.
pathstring(Required) Path in the Consul KV store.
addressstring(Optional) DNS name and port of your Consul endpoint specified in the format dnsname:port.
caFilestring(Optional) A path to a PEM-encoded certificate authority used to verify the remote agent’s certificate.
certFilestring(Optional) A path to a PEM-encoded certificate provided to the remote agent;
datacenterstring(Optional) The datacenter to use.
gzipboolean(Optional) true to compress the state data using gzip, or false (the default) to leave it uncompressed.
httpAuthstring(Optional) HTTP Basic Authentication credentials to be used when communicating with Consul, in the format of either user or user:pass.
keyFilestring(Optional) A path to a PEM-encoded private key, required if cert_file is specified.
lockboolean(Optional) false to disable locking.
schemestring(Optional) Specifies what protocol to use when talking to the given address,either http or https.

​
defaultsOptional 

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

​
workspaceOptional 

public readonly workspace: string;
  • Type: string

​
accessTokenRequired 

public readonly accessToken: string;
  • Type: string
(Required) Access token.

​
pathRequired 

public readonly path: string;
  • Type: string
(Required) Path in the Consul KV store.

​
addressOptional 

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.

​
caFileOptional 

public readonly caFile: string;
  • Type: string
(Optional) A path to a PEM-encoded certificate authority used to verify the remote agent’s certificate.

​
certFileOptional 

public readonly certFile: string;
  • Type: string
(Optional) A path to a PEM-encoded certificate provided to the remote agent; requires use of key_file.

​
datacenterOptional 

public readonly datacenter: string;
  • Type: string
(Optional) The datacenter to use. Defaults to that of the agent.

​
gzipOptional 

public readonly gzip: boolean;
  • Type: boolean
(Optional) true to compress the state data using gzip, or false (the default) to leave it uncompressed.

​
httpAuthOptional 

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.

​
keyFileOptional 

public readonly keyFile: string;
  • Type: string
(Optional) A path to a PEM-encoded private key, required if cert_file is specified.

​
lockOptional 

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.

​
schemeOptional 

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.