Package com.hashicorp.cdktf

Class DataTerraformRemoteStateCosConfig.Builder

java.lang.Object

com.hashicorp.cdktf.DataTerraformRemoteStateCosConfig.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<DataTerraformRemoteStateCosConfig>

Enclosing interface:

DataTerraformRemoteStateCosConfig

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

A builder for DataTerraformRemoteStateCosConfig

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
DataTerraformRemoteStateCosConfig.Builder	accelerate(Boolean accelerate)	Sets the value of CosBackendConfig.getAccelerate()
DataTerraformRemoteStateCosConfig.Builder	acl(String acl)	Sets the value of CosBackendConfig.getAcl()
DataTerraformRemoteStateCosConfig.Builder	assumeRole(CosBackendAssumeRole assumeRole)	Sets the value of CosBackendConfig.getAssumeRole()
DataTerraformRemoteStateCosConfig.Builder	bucket(String bucket)	Sets the value of CosBackendConfig.getBucket()
DataTerraformRemoteStateCosConfig	build()	Builds the configured instance.
DataTerraformRemoteStateCosConfig.Builder	defaults(Map<String,? extends Object> defaults)	Sets the value of DataTerraformRemoteStateConfig.getDefaults()
DataTerraformRemoteStateCosConfig.Builder	domain(String domain)	Sets the value of CosBackendConfig.getDomain()
DataTerraformRemoteStateCosConfig.Builder	encrypt(Boolean encrypt)	Sets the value of CosBackendConfig.getEncrypt()
DataTerraformRemoteStateCosConfig.Builder	endpoint(String endpoint)	Sets the value of CosBackendConfig.getEndpoint()
DataTerraformRemoteStateCosConfig.Builder	key(String key)	Sets the value of CosBackendConfig.getKey()
DataTerraformRemoteStateCosConfig.Builder	prefix(String prefix)	Sets the value of CosBackendConfig.getPrefix()
DataTerraformRemoteStateCosConfig.Builder	region(String region)	Sets the value of CosBackendConfig.getRegion()
DataTerraformRemoteStateCosConfig.Builder	secretId(String secretId)	Sets the value of CosBackendConfig.getSecretId()
DataTerraformRemoteStateCosConfig.Builder	secretKey(String secretKey)	Sets the value of CosBackendConfig.getSecretKey()
DataTerraformRemoteStateCosConfig.Builder	securityToken(String securityToken)	Sets the value of CosBackendConfig.getSecurityToken()
DataTerraformRemoteStateCosConfig.Builder	workspace(String workspace)	Sets the value of DataTerraformRemoteStateConfig.getWorkspace()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

defaults

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

Sets the value of DataTerraformRemoteStateConfig.getDefaults()

Parameters:

defaults - the value to be set.

Returns:

this

workspace

@Stability(Experimental)
public DataTerraformRemoteStateCosConfig.Builder workspace(String workspace)

Sets the value of DataTerraformRemoteStateConfig.getWorkspace()

Parameters:

workspace - the value to be set.

Returns:

this

bucket

@Stability(Experimental)
public DataTerraformRemoteStateCosConfig.Builder bucket(String bucket)

Sets the value of CosBackendConfig.getBucket()

Parameters:

bucket - (Required) The name of the COS bucket. This parameter is required. You shall manually create it first.

Returns:

this

accelerate

@Stability(Experimental)
public DataTerraformRemoteStateCosConfig.Builder accelerate(Boolean accelerate)

Sets the value of CosBackendConfig.getAccelerate()

Parameters:

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

Returns:

this

acl

@Stability(Experimental)
public DataTerraformRemoteStateCosConfig.Builder acl(String acl)

Sets the value of CosBackendConfig.getAcl()

Parameters:

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

Returns:

this

assumeRole

@Stability(Experimental)
public DataTerraformRemoteStateCosConfig.Builder assumeRole(CosBackendAssumeRole assumeRole)

Sets the value of CosBackendConfig.getAssumeRole()

Parameters:

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

Returns:

this

domain

@Stability(Experimental)
public DataTerraformRemoteStateCosConfig.Builder domain(String domain)

Sets the value of CosBackendConfig.getDomain()

Parameters:

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

Returns:

this

encrypt

@Stability(Experimental)
public DataTerraformRemoteStateCosConfig.Builder encrypt(Boolean encrypt)

Sets the value of CosBackendConfig.getEncrypt()

Parameters:

encrypt - (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.

Returns:

this

endpoint

@Stability(Experimental)
public DataTerraformRemoteStateCosConfig.Builder endpoint(String endpoint)

Sets the value of CosBackendConfig.getEndpoint()

Parameters:

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

Returns:

this

key

@Stability(Experimental)
public DataTerraformRemoteStateCosConfig.Builder key(String key)

Sets the value of CosBackendConfig.getKey()

Parameters:

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

Returns:

this

prefix

@Stability(Experimental)
public DataTerraformRemoteStateCosConfig.Builder prefix(String prefix)

Sets the value of CosBackendConfig.getPrefix()

Parameters:

prefix - (Optional) The directory for saving the state file in bucket. Default to "env:".

Returns:

this

region

@Stability(Experimental)
public DataTerraformRemoteStateCosConfig.Builder region(String region)

Sets the value of CosBackendConfig.getRegion()

Parameters:

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

Returns:

this

secretId

@Stability(Experimental)
public DataTerraformRemoteStateCosConfig.Builder secretId(String secretId)

Sets the value of CosBackendConfig.getSecretId()

Parameters:

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

Returns:

this

secretKey

@Stability(Experimental)
public DataTerraformRemoteStateCosConfig.Builder secretKey(String secretKey)

Sets the value of CosBackendConfig.getSecretKey()

Parameters:

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

Returns:

this

securityToken

@Stability(Experimental)
public DataTerraformRemoteStateCosConfig.Builder securityToken(String securityToken)

Sets the value of CosBackendConfig.getSecurityToken()

Parameters:

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

Returns:

this

build

@Stability(Experimental)
public DataTerraformRemoteStateCosConfig build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of DataTerraformRemoteStateCosConfig

Throws:

NullPointerException - if any required attribute was not provided