Python: OssBackend - CDK Terrain (CDKTN)

Initializers

import cdktn

cdktn.OssBackend(
  scope: Construct,
  bucket: str,
  access_key: str = None,
  acl: str = None,
  assume_role: OssAssumeRole = None,
  assume_role_policy: str = None,
  assume_role_role_arn: str = None,
  assume_role_session_expiration: typing.Union[int, float] = None,
  assume_role_session_name: str = None,
  ecs_role_name: str = None,
  encrypt: bool = None,
  endpoint: str = None,
  key: str = None,
  prefix: str = None,
  profile: str = None,
  region: str = None,
  secret_key: str = None,
  security_token: str = None,
  shared_credentials_file: str = None,
  sts_endpoint: str = None,
  tablestore_endpoint: str = None,
  tablestore_table: str = None
)

Name	Type	Description
`scope`	`constructs.Construct`	No description.
`bucket`	`str`	(Required) The name of the OSS bucket.
`access_key`	`str`	(Optional) Alibaba Cloud access key.
`acl`	`str`	(Optional) Object ACL to be applied to the state file.
`assume_role`	`OssAssumeRole`	No description.
`assume_role_policy`	`str`	(Optional, Available in 1.1.0+) A more restrictive policy to apply to the temporary credentials. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use this policy to grant permissions that exceed those of the role that is being assumed.
`assume_role_role_arn`	`str`	(Optional, Available in 1.1.0+) The ARN of the role to assume. If ARN is set to an empty string, it does not perform role switching. It supports the environment variable ALICLOUD_ASSUME_ROLE_ARN. Terraform executes configuration on account with provided credentials.
`assume_role_session_expiration`	`typing.Union[int, float]`	(Optional, Available in 1.1.0+) The time after which the established session for assuming role expires. Valid value range: [900-3600] seconds. Default to 3600 (in this case Alibaba Cloud uses its own default value). It supports environment variable ALICLOUD_ASSUME_ROLE_SESSION_EXPIRATION.
`assume_role_session_name`	`str`	(Optional, Available in 1.1.0+) The session name to use when assuming the role. If omitted, ‘terraform’ is passed to the AssumeRole call as session name. It supports environment variable ALICLOUD_ASSUME_ROLE_SESSION_NAME.
`ecs_role_name`	`str`	(Optional, Available in 0.12.14+) The RAM Role Name attached on a ECS instance for API operations. You can retrieve this from the ‘Access Control’ section of the Alibaba Cloud console.
`encrypt`	`bool`	(Optional) Whether to enable server side encryption of the state file.
`endpoint`	`str`	(Optional) A custom endpoint for the OSS API.
`key`	`str`	(Optional) The name of the state file.
`prefix`	`str`	(Optional) The path directory of the state file will be stored.
`profile`	`str`	(Optional, Available in 0.12.8+) This is the Alibaba Cloud profile name as set in the shared credentials file. It can also be sourced from the ALICLOUD_PROFILE environment variable.
`region`	`str`	(Optional) The region of the OSS bucket.
`secret_key`	`str`	(Optional) Alibaba Cloud secret access key.
`security_token`	`str`	(Optional) STS access token.
`shared_credentials_file`	`str`	(Optional, Available in 0.12.8+) This is the path to the shared credentials file. It can also be sourced from the ALICLOUD_SHARED_CREDENTIALS_FILE environment variable. If this is not set and a profile is specified, ~/.aliyun/config.json will be used.
`sts_endpoint`	`str`	(Optional, Available in 1.0.11+) Custom endpoint for the AliCloud Security Token Service (STS) API. It supports environment variable ALICLOUD_STS_ENDPOINT.
`tablestore_endpoint`	`str`	(Optional) A custom endpoint for the TableStore API.
`tablestore_table`	`str`	(Optional) A TableStore table for state locking and consistency.

`scope`^Required

Type: constructs.Construct

`bucket`^Required

Type: str

(Required) The name of the OSS bucket.

`access_key`^Optional

Type: str

(Optional) Alibaba Cloud access key. It supports environment variables ALICLOUD_ACCESS_KEY and ALICLOUD_ACCESS_KEY_ID.

`acl`^Optional

Type: str

(Optional) Object ACL to be applied to the state file.

`assume_role`^Optional

Deprecated: Use flattened assume role options
Type: OssAssumeRole

`assume_role_policy`^Optional

Type: str

(Optional, Available in 1.1.0+) A more restrictive policy to apply to the temporary credentials. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use this policy to grant permissions that exceed those of the role that is being assumed.

`assume_role_role_arn`^Optional

Type: str

(Optional, Available in 1.1.0+) The ARN of the role to assume. If ARN is set to an empty string, it does not perform role switching. It supports the environment variable ALICLOUD_ASSUME_ROLE_ARN. Terraform executes configuration on account with provided credentials.

`assume_role_session_expiration`^Optional

Type: typing.Union[int, float]

(Optional, Available in 1.1.0+) The time after which the established session for assuming role expires. Valid value range: [900-3600] seconds. Default to 3600 (in this case Alibaba Cloud uses its own default value). It supports environment variable ALICLOUD_ASSUME_ROLE_SESSION_EXPIRATION.

`assume_role_session_name`^Optional

Type: str

(Optional, Available in 1.1.0+) The session name to use when assuming the role. If omitted, ‘terraform’ is passed to the AssumeRole call as session name. It supports environment variable ALICLOUD_ASSUME_ROLE_SESSION_NAME.

`ecs_role_name`^Optional

Type: str

(Optional, Available in 0.12.14+) The RAM Role Name attached on a ECS instance for API operations. You can retrieve this from the ‘Access Control’ section of the Alibaba Cloud console.

`encrypt`^Optional

Type: bool

(Optional) Whether to enable server side encryption of the state file. If it is true, OSS will use ‘AES256’ encryption algorithm to encrypt state file.

`endpoint`^Optional

Type: str

(Optional) A custom endpoint for the OSS API. It supports environment variables ALICLOUD_OSS_ENDPOINT and OSS_ENDPOINT.

`key`^Optional

Type: str

(Optional) The name of the state file. Defaults to terraform.tfstate.

`prefix`^Optional

Type: str

(Optional) The path directory of the state file will be stored. Default to “env:”.

`profile`^Optional

Type: str

(Optional, Available in 0.12.8+) This is the Alibaba Cloud profile name as set in the shared credentials file. It can also be sourced from the ALICLOUD_PROFILE environment variable.

`region`^Optional

Type: str

(Optional) The region of the OSS bucket. It supports environment variables ALICLOUD_REGION and ALICLOUD_DEFAULT_REGION.

`secret_key`^Optional

Type: str

(Optional) Alibaba Cloud secret access key. It supports environment variables ALICLOUD_SECRET_KEY and ALICLOUD_ACCESS_KEY_SECRET.

`security_token`^Optional

Type: str

(Optional) STS access token. It supports environment variable ALICLOUD_SECURITY_TOKEN.

`shared_credentials_file`^Optional

Type: str

(Optional, Available in 0.12.8+) This is the path to the shared credentials file. It can also be sourced from the ALICLOUD_SHARED_CREDENTIALS_FILE environment variable. If this is not set and a profile is specified, ~/.aliyun/config.json will be used.

`sts_endpoint`^Optional

Type: str

(Optional, Available in 1.0.11+) Custom endpoint for the AliCloud Security Token Service (STS) API. It supports environment variable ALICLOUD_STS_ENDPOINT.

`tablestore_endpoint`^Optional

Type: str

(Optional) A custom endpoint for the TableStore API.

`tablestore_table`^Optional

Type: str

(Optional) A TableStore table for state locking and consistency. The table must have a primary key named LockID of type String.

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

`x`^Required

Type: typing.Any

`is_backend`

import cdktn

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

​bucketRequired

​access_keyOptional

​aclOptional

​assume_roleOptional

​assume_role_policyOptional

​assume_role_role_arnOptional

​assume_role_session_expirationOptional

​assume_role_session_nameOptional

​ecs_role_nameOptional

​encryptOptional

​endpointOptional

​keyOptional

​prefixOptional

​profileOptional

​regionOptional

​secret_keyOptional

​security_tokenOptional

​shared_credentials_fileOptional

​sts_endpointOptional

​tablestore_endpointOptional

​tablestore_tableOptional

​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

`bucket`^Required

`access_key`^Optional

`acl`^Optional

`assume_role`^Optional

`assume_role_policy`^Optional

`assume_role_role_arn`^Optional

`assume_role_session_expiration`^Optional

`assume_role_session_name`^Optional

`ecs_role_name`^Optional

`encrypt`^Optional

`endpoint`^Optional

`key`^Optional

`prefix`^Optional

`profile`^Optional

`region`^Optional

`secret_key`^Optional

`security_token`^Optional

`shared_credentials_file`^Optional

`sts_endpoint`^Optional

`tablestore_endpoint`^Optional

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