Python: ConsulBackend - CDK Terrain (CDKTN)

Initializers

import cdktn

cdktn.ConsulBackend(
  scope: Construct,
  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
)

Name	Type	Description
`scope`	`constructs.Construct`	No 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.

`scope`^Required

Type: constructs.Construct

`access_token`^Required

Type: str

(Required) Access token.

`path`^Required

Type: str

(Required) Path in the Consul KV store.

`address`^Optional

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

Type: str

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

`cert_file`^Optional

Type: str

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

`datacenter`^Optional

Type: str

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

`gzip`^Optional

Type: bool

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

`http_auth`^Optional

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

Type: str

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

`lock`^Optional

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

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.

Methods

Name	Description
`to_string`	Returns a string representation of this construct.
`add_override`	No description.
`override_logical_id`	Overrides the auto-generated logical ID with a specific ID.
`reset_override_logical_id`	Resets a previously passed logical Id to use the auto-generated logical id again.
`to_hcl_terraform`	No description.
`to_metadata`	No description.
`to_terraform`	Adds this resource to the terraform JSON output.
`get_remote_state_data_source`	Creates a TerraformRemoteState resource that accesses this backend.

`to_string`

def to_string() -> str

Returns a string representation of this construct.

`add_override`

def add_override(
  path: str,
  value: typing.Any
) -> None

`path`^Required

Type: str

`value`^Required

Type: typing.Any

`override_logical_id`

def override_logical_id(
  new_logical_id: str
) -> None

Overrides the auto-generated logical ID with a specific ID.

`new_logical_id`^Required

Type: str

The new logical ID to use for this stack element.

`reset_override_logical_id`

def reset_override_logical_id() -> None

Resets a previously passed logical Id to use the auto-generated logical id again.

`to_hcl_terraform`

def to_hcl_terraform() -> typing.Any

`to_metadata`

def to_metadata() -> typing.Any

`to_terraform`

def to_terraform() -> typing.Any

Adds this resource to the terraform JSON output.

`get_remote_state_data_source`

def get_remote_state_data_source(
  scope: Construct,
  name: str,
  _fromstack: str
) -> TerraformRemoteState

Creates a TerraformRemoteState resource that accesses this backend.

`scope`^Required

Type: constructs.Construct

`name`^Required

Type: str

`_fromstack`^Required

Type: str

Static Functions

Name	Description
`is_construct`	Checks if `x` is a construct.
`is_terraform_element`	No description.
`is_backend`	No description.

`is_construct`

import cdktn

cdktn.ConsulBackend.is_construct(
  x: typing.Any
)

Checks if x is a construct. Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

`x`^Required

Type: typing.Any

Any object.

`is_terraform_element`

import cdktn

cdktn.ConsulBackend.is_terraform_element(
  x: typing.Any
)

`x`^Required

Type: typing.Any

`is_backend`

import cdktn

cdktn.ConsulBackend.is_backend(
  x: typing.Any
)

`x`^Required

Type: typing.Any

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.
`cdktf_stack`	`TerraformStack`	No description.
`fqn`	`str`	No description.
`friendly_unique_id`	`str`	No description.

`node`^Required

node: Node

Type: constructs.Node

The tree node.

`cdktf_stack`^Required

cdktf_stack: TerraformStack

Type: TerraformStack

`fqn`^Required

fqn: str

Type: str

`friendly_unique_id`^Required

friendly_unique_id: str

Type: str

Overview

TypeScript

Python

Java

C#

Go

​Initializers

​scopeRequired

​access_tokenRequired

​pathRequired

​addressOptional

​ca_fileOptional

​cert_fileOptional

​datacenterOptional

​gzipOptional

​http_authOptional

​key_fileOptional

​lockOptional

​schemeOptional

​Methods

​to_string

​add_override

​pathRequired

​valueRequired

​override_logical_id

​new_logical_idRequired

​reset_override_logical_id

​to_hcl_terraform

​to_metadata

​to_terraform

​get_remote_state_data_source

​scopeRequired

​nameRequired

​_fromstackRequired

​Static Functions

​is_construct

​xRequired

​is_terraform_element

​xRequired

​is_backend

​xRequired

​Properties

​nodeRequired

​cdktf_stackRequired

​fqnRequired

​friendly_unique_idRequired

Initializers

`scope`^Required

`access_token`^Required

`path`^Required

`address`^Optional

`ca_file`^Optional

`cert_file`^Optional

`datacenter`^Optional

`gzip`^Optional

`http_auth`^Optional

`key_file`^Optional

`lock`^Optional

`scheme`^Optional

Methods

`to_string`

`add_override`

`path`^Required

`value`^Required

`override_logical_id`

`new_logical_id`^Required

`reset_override_logical_id`

`to_hcl_terraform`

`to_metadata`

`to_terraform`

`get_remote_state_data_source`

`scope`^Required

`name`^Required

`_fromstack`^Required

Static Functions

`is_construct`

`x`^Required

`is_terraform_element`

`x`^Required

`is_backend`

`x`^Required

Properties

`node`^Required

`cdktf_stack`^Required

`fqn`^Required

`friendly_unique_id`^Required