Python: SwiftBackend - CDK Terrain (CDKTN)

Initializers

import cdktn

cdktn.SwiftBackend(
  scope: Construct,
  container: str,
  application_credential_id: str = None,
  application_credential_name: str = None,
  application_credential_secret: str = None,
  archive_container: str = None,
  auth_url: str = None,
  cacert_file: str = None,
  cert: str = None,
  cloud: str = None,
  default_domain: str = None,
  domain_id: str = None,
  domain_name: str = None,
  expire_after: str = None,
  insecure: bool = None,
  key: str = None,
  password: str = None,
  project_domain_id: str = None,
  project_domain_name: str = None,
  region_name: str = None,
  state_name: str = None,
  tenant_id: str = None,
  tenant_name: str = None,
  token: str = None,
  user_domain_id: str = None,
  user_domain_name: str = None,
  user_id: str = None,
  user_name: str = None
)

Name	Type	Description
`scope`	`constructs.Construct`	No description.
`container`	`str`	No description.
`application_credential_id`	`str`	No description.
`application_credential_name`	`str`	No description.
`application_credential_secret`	`str`	No description.
`archive_container`	`str`	No description.
`auth_url`	`str`	No description.
`cacert_file`	`str`	No description.
`cert`	`str`	No description.
`cloud`	`str`	No description.
`default_domain`	`str`	No description.
`domain_id`	`str`	No description.
`domain_name`	`str`	No description.
`expire_after`	`str`	No description.
`insecure`	`bool`	No description.
`key`	`str`	No description.
`password`	`str`	No description.
`project_domain_id`	`str`	No description.
`project_domain_name`	`str`	No description.
`region_name`	`str`	No description.
`state_name`	`str`	No description.
`tenant_id`	`str`	No description.
`tenant_name`	`str`	No description.
`token`	`str`	No description.
`user_domain_id`	`str`	No description.
`user_domain_name`	`str`	No description.
`user_id`	`str`	No description.
`user_name`	`str`	No description.

`scope`^Required

Type: constructs.Construct

`container`^Required

Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
Type: str

`application_credential_id`^Optional

Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
Type: str

`application_credential_name`^Optional

Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
Type: str

`application_credential_secret`^Optional

Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
Type: str

`archive_container`^Optional

Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
Type: str

`auth_url`^Optional

Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
Type: str

`cacert_file`^Optional

Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
Type: str

`cert`^Optional

Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
Type: str

`cloud`^Optional

Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
Type: str

`default_domain`^Optional

Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
Type: str

`domain_id`^Optional

Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
Type: str

`domain_name`^Optional

Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
Type: str

`expire_after`^Optional

Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
Type: str

`insecure`^Optional

Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
Type: bool

`key`^Optional

Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
Type: str

`password`^Optional

Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
Type: str

`project_domain_id`^Optional

Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
Type: str

`project_domain_name`^Optional

Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
Type: str

`region_name`^Optional

Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
Type: str

`state_name`^Optional

Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
Type: str

`tenant_id`^Optional

Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
Type: str

`tenant_name`^Optional

Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
Type: str

`token`^Optional

Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
Type: str

`user_domain_id`^Optional

Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
Type: str

`user_domain_name`^Optional

Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
Type: str

`user_id`^Optional

Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
Type: str

`user_name`^Optional

Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
Type: str

Methods

Name	Description
`to_string`	Returns a string representation of this construct.
`with`	Applies one or more mixins to 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.

`with`

def with(
  mixins: *IMixin
) -> IConstruct

Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

`mixins`^Required

Type: *constructs.IMixin

The mixins to apply.

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

`x`^Required

Type: typing.Any

`is_backend`

import cdktn

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

Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.

node: Node

Type: constructs.Node

The tree node.

`cdktf_stack`^Required

Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.

cdktf_stack: TerraformStack

Type: TerraformStack

`fqn`^Required

Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.

fqn: str

Type: str

`friendly_unique_id`^Required

Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.

friendly_unique_id: str

Type: str

​Initializers

​scopeRequired

​containerRequired

​application_credential_idOptional

​application_credential_nameOptional

​application_credential_secretOptional

​archive_containerOptional

​auth_urlOptional

​cacert_fileOptional

​certOptional

​cloudOptional

​default_domainOptional

​domain_idOptional

​domain_nameOptional

​expire_afterOptional

​insecureOptional

​keyOptional

​passwordOptional

​project_domain_idOptional

​project_domain_nameOptional

​region_nameOptional

​state_nameOptional

​tenant_idOptional

​tenant_nameOptional

​tokenOptional

​user_domain_idOptional

​user_domain_nameOptional

​user_idOptional

​user_nameOptional

​Methods

​to_string

​with

​mixinsRequired

​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

`container`^Required

`application_credential_id`^Optional

`application_credential_name`^Optional

`application_credential_secret`^Optional

`archive_container`^Optional

`auth_url`^Optional

`cacert_file`^Optional

`cert`^Optional

`cloud`^Optional

`default_domain`^Optional

`domain_id`^Optional

`domain_name`^Optional

`expire_after`^Optional

`insecure`^Optional

`key`^Optional

`password`^Optional

`project_domain_id`^Optional

`project_domain_name`^Optional

`region_name`^Optional

`state_name`^Optional

`tenant_id`^Optional

`tenant_name`^Optional

`token`^Optional

`user_domain_id`^Optional

`user_domain_name`^Optional

`user_id`^Optional

`user_name`^Optional

Methods

`to_string`

`with`

`mixins`^Required

`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