CSharp: DataTerraformRemoteStateConsulConfig

CDKTN Core API Reference for DataTerraformRemoteStateConsulConfig in CSharp.

Initializer

using Io.Cdktn;

new DataTerraformRemoteStateConsulConfig {
    System.Collections.Generic.IDictionary<string, object> Defaults = null,
    string Workspace = null,
    string AccessToken,
    string Path,
    string Address = null,
    string CaFile = null,
    string CertFile = null,
    string Datacenter = null,
    bool Gzip = null,
    string HttpAuth = null,
    string KeyFile = null,
    bool Lock = null,
    string Scheme = null
};

Properties

Name	Type	Description
Defaults	System.Collections.Generic.IDictionary< string, object >	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	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.

---

Defaults^Optional

public System.Collections.Generic.IDictionary<string, object> Defaults { get; set; }

• Type: System.Collections.Generic.IDictionary< string, object >

---

Workspace^Optional

public string Workspace { get; set; }

• Type: string

---

AccessToken^Required

public string AccessToken { get; set; }

• Type: string

(Required) Access token.

---

Path^Required

public string Path { get; set; }

• Type: string

(Required) Path in the Consul KV store.

---

Address^Optional

public string Address { get; set; }

• 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 string CaFile { get; set; }

• Type: string

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

---

CertFile^Optional

public string CertFile { get; set; }

• Type: string

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

requires use of key_file.

---

Datacenter^Optional

public string Datacenter { get; set; }

• Type: string

(Optional) The datacenter to use.

Defaults to that of the agent.

---

Gzip^Optional

public bool Gzip { get; set; }

• Type: bool

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

---

HttpAuth^Optional

public string HttpAuth { get; set; }

• 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 string KeyFile { get; set; }

• Type: string

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

---

Lock^Optional

public bool Lock { get; set; }

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

---

Scheme^Optional

public string Scheme { get; set; }

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

---