Skip to main content

​
Initializer 

import "github.com/open-constructs/cdk-terrain-go/cdktn"

&cdktn.DataTerraformRemoteStateConsulConfig {
	Defaults: *map[string]interface{},
	Workspace: *string,
	AccessToken: *string,
	Path: *string,
	Address: *string,
	CaFile: *string,
	CertFile: *string,
	Datacenter: *string,
	Gzip: *bool,
	HttpAuth: *string,
	KeyFile: *string,
	Lock: *bool,
	Scheme: *string,
}

​
Properties

NameTypeDescription
Defaults*map[string]interface{}No description.
Workspace*stringNo 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*bool(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*bool(Optional) false to disable locking.
Scheme*string(Optional) Specifies what protocol to use when talking to the given address,either http or https.

​
DefaultsOptional 

Defaults *map[string]interface{}
  • Type: *map[string]interface{}

​
WorkspaceOptional 

Workspace *string
  • Type: *string

​
AccessTokenRequired 

AccessToken *string
  • Type: *string
(Required) Access token.

​
PathRequired 

Path *string
  • Type: *string
(Required) Path in the Consul KV store.

​
AddressOptional 

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 

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

​
CertFileOptional 

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

​
DatacenterOptional 

Datacenter *string
  • Type: *string
(Optional) The datacenter to use. Defaults to that of the agent.

​
GzipOptional 

Gzip *bool
  • Type: *bool
(Optional) true to compress the state data using gzip, or false (the default) to leave it uncompressed.

​
HttpAuthOptional 

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 

KeyFile *string
  • Type: *string
(Optional) A path to a PEM-encoded private key, required if cert_file is specified.

​
LockOptional 

Lock *bool
  • Type: *bool
(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 

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.