Typescript: DataTerraformRemoteStateCosConfig

Initializer

import { DataTerraformRemoteStateCosConfig } from 'cdktn'

const dataTerraformRemoteStateCosConfig: DataTerraformRemoteStateCosConfig = { ... }

Properties

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

`defaults`^Optional

public readonly defaults: {[ key: string ]: any};

Type: {[ key: string ]: any}

`workspace`^Optional

public readonly workspace: string;

Type: string

`bucket`^Required

public readonly bucket: string;

Type: string

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

`accelerate`^Optional

public readonly accelerate: boolean;

Type: boolean

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

`acl`^Optional

public readonly acl: string;

Type: string

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

`assumeRole`^Optional

public readonly assumeRole: CosBackendAssumeRole;

Type: CosBackendAssumeRole

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

`domain`^Optional

public readonly domain: string;

Type: string

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

`encrypt`^Optional

public readonly encrypt: boolean;

Type: boolean

(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

public readonly endpoint: string;

Type: string

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

`key`^Optional

public readonly key: string;

Type: string

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

`prefix`^Optional

public readonly prefix: string;

Type: string

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

`region`^Optional

public readonly region: string;

Type: string

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

`secretId`^Optional

public readonly secretId: string;

Type: string

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

`secretKey`^Optional

public readonly secretKey: string;

Type: string

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

`securityToken`^Optional

public readonly securityToken: string;

Type: string

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

Typescript: DataTerraformRemoteStateConsulConfig

Typescript: DataTerraformRemoteStateGcsConfig

⌘I

​Initializer

​Properties

​defaultsOptional

​workspaceOptional

​bucketRequired

​accelerateOptional

​aclOptional

​assumeRoleOptional

​domainOptional

​encryptOptional

​endpointOptional

​keyOptional

​prefixOptional

​regionOptional

​secretIdOptional

​secretKeyOptional

​securityTokenOptional