com.hashicorp.cdktf

Class CosBackendConfig.Builder

java.lang.Object

com.hashicorp.cdktf.CosBackendConfig.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CosBackendConfig>

Enclosing interface:

CosBackendConfig

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

A builder for CosBackendConfig

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CosBackendConfig.Builder	acl(String acl) Sets the value of CosBackendConfig.getAcl()
CosBackendConfig.Builder	bucket(String bucket) Sets the value of CosBackendConfig.getBucket()
CosBackendConfig	build() Builds the configured instance.
CosBackendConfig.Builder	encrypt(Boolean encrypt) Sets the value of CosBackendConfig.getEncrypt()
CosBackendConfig.Builder	key(String key) Sets the value of CosBackendConfig.getKey()
CosBackendConfig.Builder	prefix(String prefix) Sets the value of CosBackendConfig.getPrefix()
CosBackendConfig.Builder	region(String region) Sets the value of CosBackendConfig.getRegion()
CosBackendConfig.Builder	secretId(String secretId) Sets the value of CosBackendConfig.getSecretId()
CosBackendConfig.Builder	secretKey(String secretKey) Sets the value of CosBackendConfig.getSecretKey()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

bucket

@Stability(value=Experimental)
public CosBackendConfig.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

acl

@Stability(value=Experimental)
public CosBackendConfig.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

encrypt

@Stability(value=Experimental)
public CosBackendConfig.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

key

@Stability(value=Experimental)
public CosBackendConfig.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(value=Experimental)
public CosBackendConfig.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(value=Experimental)
public CosBackendConfig.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(value=Experimental)
public CosBackendConfig.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(value=Experimental)
public CosBackendConfig.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

build

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

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CosBackendConfig

Throws:

NullPointerException - if any required attribute was not provided