Python: ConsulBackendConfig - CDK Terrain (CDKTN)

Stores the state in the Consul KV store at a given path. This backend supports state locking. Read more about this backend in the Terraform docs: https://developer.hashicorp.com/terraform/language/settings/backends/consul

Initializer

import cdktn

cdktn.ConsulBackendConfig(
  access_token: str,
  path: str,
  address: str = None,
  ca_file: str = None,
  cert_file: str = None,
  datacenter: str = None,
  gzip: bool = None,
  http_auth: str = None,
  key_file: str = None,
  lock: bool = None,
  scheme: str = None
)

Properties

Name	Type	Description
`access_token`	`str`	(Required) Access token.
`path`	`str`	(Required) Path in the Consul KV store.
`address`	`str`	(Optional) DNS name and port of your Consul endpoint specified in the format dnsname:port.
`ca_file`	`str`	(Optional) A path to a PEM-encoded certificate authority used to verify the remote agent’s certificate.
`cert_file`	`str`	(Optional) A path to a PEM-encoded certificate provided to the remote agent;
`datacenter`	`str`	(Optional) The datacenter to use.
`gzip`	`bool`	(Optional) true to compress the state data using gzip, or false (the default) to leave it uncompressed.
`http_auth`	`str`	(Optional) HTTP Basic Authentication credentials to be used when communicating with Consul, in the format of either user or user:pass.
`key_file`	`str`	(Optional) A path to a PEM-encoded private key, required if cert_file is specified.
`lock`	`bool`	(Optional) false to disable locking.
`scheme`	`str`	(Optional) Specifies what protocol to use when talking to the given address,either http or https.

`access_token`^Required

access_token: str

Type: str

(Required) Access token.

`path`^Required

path: str

Type: str

(Required) Path in the Consul KV store.

`address`^Optional

address: str

Type: str

(Optional) DNS name and port of your Consul endpoint specified in the format dnsname:port. Defaults to the local agent HTTP listener.

`ca_file`^Optional

ca_file: str

Type: str

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

`cert_file`^Optional

cert_file: str

Type: str

(Optional) A path to a PEM-encoded certificate provided to the remote agent; requires use of key_file.

`datacenter`^Optional

datacenter: str

Type: str

(Optional) The datacenter to use. Defaults to that of the agent.

`gzip`^Optional

gzip: bool

Type: bool

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

`http_auth`^Optional

http_auth: str

Type: str

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

`key_file`^Optional

key_file: str

Type: str

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

`lock`^Optional

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.

`scheme`^Optional

scheme: str

Type: str

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

Python: CloudBackendConfig

Python: CosBackendAssumeRole

⌘I

​Initializer

​Properties

​access_tokenRequired

​pathRequired

​addressOptional

​ca_fileOptional

​cert_fileOptional

​datacenterOptional

​gzipOptional

​http_authOptional

​key_fileOptional

​lockOptional

​schemeOptional