com.hashicorp.cdktf

Class CosBackendProps.Builder

java.lang.Object

com.hashicorp.cdktf.CosBackendProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CosBackendProps>

Enclosing interface:

CosBackendProps

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

A builder for CosBackendProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CosBackendProps.Builder	acl(String acl) Sets the value of CosBackendProps.getAcl()
CosBackendProps.Builder	bucket(String bucket) Sets the value of CosBackendProps.getBucket()
CosBackendProps	build() Builds the configured instance.
CosBackendProps.Builder	encrypt(Boolean encrypt) Sets the value of CosBackendProps.getEncrypt()
CosBackendProps.Builder	key(String key) Sets the value of CosBackendProps.getKey()
CosBackendProps.Builder	prefix(String prefix) Sets the value of CosBackendProps.getPrefix()
CosBackendProps.Builder	region(String region) Sets the value of CosBackendProps.getRegion()
CosBackendProps.Builder	secretId(String secretId) Sets the value of CosBackendProps.getSecretId()
CosBackendProps.Builder	secretKey(String secretKey) Sets the value of CosBackendProps.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 CosBackendProps.Builder bucket(String bucket)

Sets the value of CosBackendProps.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 CosBackendProps.Builder acl(String acl)

Sets the value of CosBackendProps.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 CosBackendProps.Builder encrypt(Boolean encrypt)

Sets the value of CosBackendProps.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 CosBackendProps.Builder key(String key)

Sets the value of CosBackendProps.getKey()

Parameters:

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

Returns:

this

prefix

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

Sets the value of CosBackendProps.getPrefix()

Parameters:

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

Returns:

this

region

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

Sets the value of CosBackendProps.getRegion()

Parameters:

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

Returns:

this

secretId

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

Sets the value of CosBackendProps.getSecretId()

Parameters:

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

Returns:

this

secretKey

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

Sets the value of CosBackendProps.getSecretKey()

Parameters:

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

Returns:

this

build

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

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CosBackendProps

Throws:

NullPointerException - if any required attribute was not provided