Python: DataTerraformRemoteStateCosConfig

Initializer

import cdktn

cdktn.DataTerraformRemoteStateCosConfig(
  defaults: typing.Mapping[typing.Any] = None,
  workspace: str = None,
  bucket: str,
  accelerate: bool = None,
  acl: str = None,
  assume_role: CosBackendAssumeRole = None,
  domain: str = None,
  encrypt: bool = None,
  endpoint: str = None,
  key: str = None,
  prefix: str = None,
  region: str = None,
  secret_id: str = None,
  secret_key: str = None,
  security_token: str = None
)

Properties

Name	Type	Description
`defaults`	`typing.Mapping[typing.Any]`	No description.
`workspace`	`str`	No description.
`bucket`	`str`	(Required) The name of the COS bucket.
`accelerate`	`bool`	(Optional) Whether to enable global Acceleration.
`acl`	`str`	(Optional) Object ACL to be applied to the state file, allows private and public-read.
`assume_role`	`CosBackendAssumeRole`	(Optional) The assume_role block.
`domain`	`str`	(Optional) The root domain of the API request.
`encrypt`	`bool`	(Optional) Whether to enable server side encryption of the state file.
`endpoint`	`str`	(Optional) The Custom Endpoint for the COS backend.
`key`	`str`	(Optional) The path for saving the state file in bucket.
`prefix`	`str`	(Optional) The directory for saving the state file in bucket.
`region`	`str`	(Optional) The region of the COS bucket.
`secret_id`	`str`	(Optional) Secret id of Tencent Cloud.
`secret_key`	`str`	(Optional) Secret key of Tencent Cloud.
`security_token`	`str`	(Optional) TencentCloud Security Token of temporary access credentials.

`defaults`^Optional

defaults: typing.Mapping[typing.Any]

Type: typing.Mapping[typing.Any]

`workspace`^Optional

workspace: str

Type: str

`bucket`^Required

bucket: str

Type: str

(Required) The name of the COS bucket. You shall manually create it first.

`accelerate`^Optional

accelerate: bool

Type: bool

(Optional) Whether to enable global Acceleration. Defaults to false.

`acl`^Optional

acl: str

Type: str

(Optional) Object ACL to be applied to the state file, allows private and public-read. Defaults to private.

`assume_role`^Optional

assume_role: CosBackendAssumeRole

Type: CosBackendAssumeRole

(Optional) The assume_role block. If provided, terraform will attempt to assume this role using the supplied credentials.

`domain`^Optional

domain: str

Type: str

(Optional) The root domain of the API request. Defaults to tencentcloudapi.com. It supports the environment variable TENCENTCLOUD_DOMAIN.

`encrypt`^Optional

encrypt: bool

Type: bool

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

`endpoint`^Optional

endpoint: str

Type: str

(Optional) The Custom Endpoint for the COS backend. It supports the environment variable TENCENTCLOUD_ENDPOINT.

`key`^Optional

key: str

Type: str

(Optional) The path for saving the state file in bucket. Defaults to terraform.tfstate.

`prefix`^Optional

prefix: str

Type: str

(Optional) The directory for saving the state file in bucket. Default to “env:”.

`region`^Optional

region: str

Type: str

(Optional) The region of the COS bucket. It supports environment variables TENCENTCLOUD_REGION.

`secret_id`^Optional

secret_id: str

Type: str

(Optional) Secret id of Tencent Cloud. It supports environment variables TENCENTCLOUD_SECRET_ID.

`secret_key`^Optional

secret_key: str

Type: str

(Optional) Secret key of Tencent Cloud. It supports environment variables TENCENTCLOUD_SECRET_KEY.

`security_token`^Optional

security_token: str

Type: str

(Optional) TencentCloud Security Token of temporary access credentials. It supports environment variables TENCENTCLOUD_SECURITY_TOKEN.

Python: DataTerraformRemoteStateConsulConfig

Python: DataTerraformRemoteStateGcsConfig

⌘I

​Initializer

​Properties

​defaultsOptional

​workspaceOptional

​bucketRequired

​accelerateOptional

​aclOptional

​assume_roleOptional

​domainOptional

​encryptOptional

​endpointOptional

​keyOptional

​prefixOptional

​regionOptional

​secret_idOptional

​secret_keyOptional

​security_tokenOptional