Typescript: 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 { ConsulBackendConfig } from 'cdktn'

const consulBackendConfig: ConsulBackendConfig = { ... }

Properties

Name	Type	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.

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

Typescript: CloudBackendConfig

Typescript: CosBackendAssumeRole

⌘I

​Initializer

​Properties

​accessTokenRequired

​pathRequired

​addressOptional

​caFileOptional

​certFileOptional

​datacenterOptional

​gzipOptional

​httpAuthOptional

​keyFileOptional

​lockOptional

​schemeOptional