com.hashicorp.cdktf

Class DataTerraformRemoteStateCos.Builder

java.lang.Object

com.hashicorp.cdktf.DataTerraformRemoteStateCos.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<DataTerraformRemoteStateCos>

Enclosing class:

DataTerraformRemoteStateCos

@Stability(value=Experimental)
public static final class DataTerraformRemoteStateCos.Builder
extends Object
implements software.amazon.jsii.Builder<DataTerraformRemoteStateCos>

(experimental) A fluent builder for DataTerraformRemoteStateCos.

Method Summary

Modifier and Type	Method and Description
DataTerraformRemoteStateCos.Builder	acl(String acl) (experimental) (Optional) Object ACL to be applied to the state file, allows private and public-read.
DataTerraformRemoteStateCos.Builder	bucket(String bucket) (experimental) (Required) The name of the COS bucket.
DataTerraformRemoteStateCos	build()
static DataTerraformRemoteStateCos.Builder	create(software.constructs.Construct scope, String id)
DataTerraformRemoteStateCos.Builder	defaults(Map<String,? extends Object> defaults)
DataTerraformRemoteStateCos.Builder	encrypt(Boolean encrypt) (experimental) (Optional) Whether to enable server side encryption of the state file.
DataTerraformRemoteStateCos.Builder	key(String key) (experimental) (Optional) The path for saving the state file in bucket.
DataTerraformRemoteStateCos.Builder	prefix(String prefix) (experimental) (Optional) The directory for saving the state file in bucket.
DataTerraformRemoteStateCos.Builder	region(String region) (experimental) (Optional) The region of the COS bucket.
DataTerraformRemoteStateCos.Builder	secretId(String secretId) (experimental) (Optional) Secret id of Tencent Cloud.
DataTerraformRemoteStateCos.Builder	secretKey(String secretKey) (experimental) (Optional) Secret key of Tencent Cloud.
DataTerraformRemoteStateCos.Builder	workspace(String workspace)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

@Stability(value=Experimental)
public static DataTerraformRemoteStateCos.Builder create(software.constructs.Construct scope,
                                                                                        String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of DataTerraformRemoteStateCos.Builder.

defaults

@Stability(value=Experimental)
public DataTerraformRemoteStateCos.Builder defaults(Map<String,? extends Object> defaults)

Parameters:

defaults - This parameter is required.

Returns:

this

workspace

@Stability(value=Experimental)
public DataTerraformRemoteStateCos.Builder workspace(String workspace)

Parameters:

workspace - This parameter is required.

Returns:

this

bucket

@Stability(value=Experimental)
public DataTerraformRemoteStateCos.Builder bucket(String bucket)

(experimental) (Required) The name of the COS bucket.

You shall manually create it first.

Parameters:

bucket - (Required) The name of the COS bucket. This parameter is required.

Returns:

this

acl

@Stability(value=Experimental)
public DataTerraformRemoteStateCos.Builder acl(String acl)

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

Defaults to private.

Parameters:

acl - (Optional) Object ACL to be applied to the state file, allows private and public-read. This parameter is required.

Returns:

this

encrypt

@Stability(value=Experimental)
public DataTerraformRemoteStateCos.Builder encrypt(Boolean encrypt)

(experimental) (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.

Parameters:

encrypt - (Optional) Whether to enable server side encryption of the state file. This parameter is required.

Returns:

this

key

@Stability(value=Experimental)
public DataTerraformRemoteStateCos.Builder key(String key)

(experimental) (Optional) The path for saving the state file in bucket.

Defaults to terraform.tfstate.

Parameters:

key - (Optional) The path for saving the state file in bucket. This parameter is required.

Returns:

this

prefix

@Stability(value=Experimental)
public DataTerraformRemoteStateCos.Builder prefix(String prefix)

(experimental) (Optional) The directory for saving the state file in bucket.

Default to "env:".

Parameters:

prefix - (Optional) The directory for saving the state file in bucket. This parameter is required.

Returns:

this

region

@Stability(value=Experimental)
public DataTerraformRemoteStateCos.Builder region(String region)

(experimental) (Optional) The region of the COS bucket.

It supports environment variables TENCENTCLOUD_REGION.

Parameters:

region - (Optional) The region of the COS bucket. This parameter is required.

Returns:

this

secretId

@Stability(value=Experimental)
public DataTerraformRemoteStateCos.Builder secretId(String secretId)

(experimental) (Optional) Secret id of Tencent Cloud.

It supports environment variables TENCENTCLOUD_SECRET_ID.

Parameters:

secretId - (Optional) Secret id of Tencent Cloud. This parameter is required.

Returns:

this

secretKey

@Stability(value=Experimental)
public DataTerraformRemoteStateCos.Builder secretKey(String secretKey)

(experimental) (Optional) Secret key of Tencent Cloud.

It supports environment variables TENCENTCLOUD_SECRET_KEY.

Parameters:

secretKey - (Optional) Secret key of Tencent Cloud. This parameter is required.

Returns:

this

build

@Stability(value=Experimental)
public DataTerraformRemoteStateCos build()

Specified by:

build in interface software.amazon.jsii.Builder<DataTerraformRemoteStateCos>