Python: HttpBackend - CDK Terrain (CDKTN)

Initializers

import cdktn

cdktn.HttpBackend(
  scope: Construct,
  address: str,
  client_ca_certificate_pem: str = None,
  client_certificate_pem: str = None,
  client_private_key_pem: str = None,
  lock_address: str = None,
  lock_method: str = None,
  password: str = None,
  retry_max: typing.Union[int, float] = None,
  retry_wait_max: typing.Union[int, float] = None,
  retry_wait_min: typing.Union[int, float] = None,
  skip_cert_verification: bool = None,
  unlock_address: str = None,
  unlock_method: str = None,
  update_method: str = None,
  username: str = None
)

Name	Type	Description
`scope`	`constructs.Construct`	No description.
`address`	`str`	(Required) The address of the REST endpoint.
`client_ca_certificate_pem`	`str`	(Optional) A PEM-encoded CA certificate chain used by the client to verify server certificates during TLS authentication.
`client_certificate_pem`	`str`	(Optional) A PEM-encoded certificate used by the server to verify the client during mutual TLS (mTLS) authentication.
`client_private_key_pem`	`str`	(Optional) A PEM-encoded private key, required if client_certificate_pem is specified.
`lock_address`	`str`	(Optional) The address of the lock REST endpoint.
`lock_method`	`str`	(Optional) The HTTP method to use when locking.
`password`	`str`	(Optional) The password for HTTP basic authentication.
`retry_max`	`typing.Union[int, float]`	(Optional) The number of HTTP request retries.
`retry_wait_max`	`typing.Union[int, float]`	(Optional) The maximum time in seconds to wait between HTTP request attempts.
`retry_wait_min`	`typing.Union[int, float]`	(Optional) The minimum time in seconds to wait between HTTP request attempts.
`skip_cert_verification`	`bool`	(Optional) Whether to skip TLS verification.
`unlock_address`	`str`	(Optional) The address of the unlock REST endpoint.
`unlock_method`	`str`	(Optional) The HTTP method to use when unlocking.
`update_method`	`str`	(Optional) HTTP method to use when updating state.
`username`	`str`	(Optional) The username for HTTP basic authentication.

`scope`^Required

Type: constructs.Construct

`address`^Required

Type: str

(Required) The address of the REST endpoint.

`client_ca_certificate_pem`^Optional

Type: str

(Optional) A PEM-encoded CA certificate chain used by the client to verify server certificates during TLS authentication.

`client_certificate_pem`^Optional

Type: str

(Optional) A PEM-encoded certificate used by the server to verify the client during mutual TLS (mTLS) authentication.

`client_private_key_pem`^Optional

Type: str

(Optional) A PEM-encoded private key, required if client_certificate_pem is specified.

`lock_address`^Optional

Type: str

(Optional) The address of the lock REST endpoint. Defaults to disabled.

`lock_method`^Optional

Type: str

(Optional) The HTTP method to use when locking. Defaults to LOCK.

`password`^Optional

Type: str

(Optional) The password for HTTP basic authentication.

`retry_max`^Optional

Type: typing.Union[int, float]

(Optional) The number of HTTP request retries. Defaults to 2.

`retry_wait_max`^Optional

Type: typing.Union[int, float]

(Optional) The maximum time in seconds to wait between HTTP request attempts. Defaults to 30.

`retry_wait_min`^Optional

Type: typing.Union[int, float]

(Optional) The minimum time in seconds to wait between HTTP request attempts. Defaults to 1.

`skip_cert_verification`^Optional

Type: bool

(Optional) Whether to skip TLS verification. Defaults to false.

`unlock_address`^Optional

Type: str

(Optional) The address of the unlock REST endpoint. Defaults to disabled.

`unlock_method`^Optional

Type: str

(Optional) The HTTP method to use when unlocking. Defaults to UNLOCK.

`update_method`^Optional

Type: str

(Optional) HTTP method to use when updating state. Defaults to POST.

`username`^Optional

Type: str

(Optional) The username for HTTP basic authentication.

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.HttpBackend.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.HttpBackend.is_terraform_element(
  x: typing.Any
)

`x`^Required

Type: typing.Any

`is_backend`

import cdktn

cdktn.HttpBackend.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

Documentation Index

​Initializers

​scopeRequired

​addressRequired

​client_ca_certificate_pemOptional

​client_certificate_pemOptional

​client_private_key_pemOptional

​lock_addressOptional

​lock_methodOptional

​passwordOptional

​retry_maxOptional

​retry_wait_maxOptional

​retry_wait_minOptional

​skip_cert_verificationOptional

​unlock_addressOptional

​unlock_methodOptional

​update_methodOptional

​usernameOptional

​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

`address`^Required

`client_ca_certificate_pem`^Optional

`client_certificate_pem`^Optional

`client_private_key_pem`^Optional

`lock_address`^Optional

`lock_method`^Optional

`password`^Optional

`retry_max`^Optional

`retry_wait_max`^Optional

`retry_wait_min`^Optional

`skip_cert_verification`^Optional

`unlock_address`^Optional

`unlock_method`^Optional

`update_method`^Optional

`username`^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