Package com.hashicorp.cdktf

Class DataTerraformRemoteStateOssConfig.Builder

java.lang.Object

com.hashicorp.cdktf.DataTerraformRemoteStateOssConfig.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<DataTerraformRemoteStateOssConfig>

Enclosing interface:

DataTerraformRemoteStateOssConfig

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

A builder for DataTerraformRemoteStateOssConfig

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
DataTerraformRemoteStateOssConfig.Builder	accessKey(String accessKey)	Sets the value of OssBackendConfig.getAccessKey()
DataTerraformRemoteStateOssConfig.Builder	acl(String acl)	Sets the value of OssBackendConfig.getAcl()
DataTerraformRemoteStateOssConfig.Builder	assumeRole(OssAssumeRole assumeRole)	Deprecated. Use flattened assume role options
DataTerraformRemoteStateOssConfig.Builder	assumeRolePolicy(String assumeRolePolicy)	Sets the value of OssBackendConfig.getAssumeRolePolicy()
DataTerraformRemoteStateOssConfig.Builder	assumeRoleRoleArn(String assumeRoleRoleArn)	Sets the value of OssBackendConfig.getAssumeRoleRoleArn()
DataTerraformRemoteStateOssConfig.Builder	assumeRoleSessionExpiration(Number assumeRoleSessionExpiration)	Sets the value of OssBackendConfig.getAssumeRoleSessionExpiration()
DataTerraformRemoteStateOssConfig.Builder	assumeRoleSessionName(String assumeRoleSessionName)	Sets the value of OssBackendConfig.getAssumeRoleSessionName()
DataTerraformRemoteStateOssConfig.Builder	bucket(String bucket)	Sets the value of OssBackendConfig.getBucket()
DataTerraformRemoteStateOssConfig	build()	Builds the configured instance.
DataTerraformRemoteStateOssConfig.Builder	defaults(Map<String,? extends Object> defaults)	Sets the value of DataTerraformRemoteStateConfig.getDefaults()
DataTerraformRemoteStateOssConfig.Builder	ecsRoleName(String ecsRoleName)	Sets the value of OssBackendConfig.getEcsRoleName()
DataTerraformRemoteStateOssConfig.Builder	encrypt(Boolean encrypt)	Sets the value of OssBackendConfig.getEncrypt()
DataTerraformRemoteStateOssConfig.Builder	endpoint(String endpoint)	Sets the value of OssBackendConfig.getEndpoint()
DataTerraformRemoteStateOssConfig.Builder	key(String key)	Sets the value of OssBackendConfig.getKey()
DataTerraformRemoteStateOssConfig.Builder	prefix(String prefix)	Sets the value of OssBackendConfig.getPrefix()
DataTerraformRemoteStateOssConfig.Builder	profile(String profile)	Sets the value of OssBackendConfig.getProfile()
DataTerraformRemoteStateOssConfig.Builder	region(String region)	Sets the value of OssBackendConfig.getRegion()
DataTerraformRemoteStateOssConfig.Builder	secretKey(String secretKey)	Sets the value of OssBackendConfig.getSecretKey()
DataTerraformRemoteStateOssConfig.Builder	securityToken(String securityToken)	Sets the value of OssBackendConfig.getSecurityToken()
DataTerraformRemoteStateOssConfig.Builder	sharedCredentialsFile(String sharedCredentialsFile)	Sets the value of OssBackendConfig.getSharedCredentialsFile()
DataTerraformRemoteStateOssConfig.Builder	stsEndpoint(String stsEndpoint)	Sets the value of OssBackendConfig.getStsEndpoint()
DataTerraformRemoteStateOssConfig.Builder	tablestoreEndpoint(String tablestoreEndpoint)	Sets the value of OssBackendConfig.getTablestoreEndpoint()
DataTerraformRemoteStateOssConfig.Builder	tablestoreTable(String tablestoreTable)	Sets the value of OssBackendConfig.getTablestoreTable()
DataTerraformRemoteStateOssConfig.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 DataTerraformRemoteStateOssConfig.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 DataTerraformRemoteStateOssConfig.Builder workspace(String workspace)

Sets the value of DataTerraformRemoteStateConfig.getWorkspace()

Parameters:

workspace - the value to be set.

Returns:

this

bucket

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

Sets the value of OssBackendConfig.getBucket()

Parameters:

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

Returns:

this

accessKey

@Stability(Experimental)
public DataTerraformRemoteStateOssConfig.Builder accessKey(String accessKey)

Sets the value of OssBackendConfig.getAccessKey()

Parameters:

accessKey - (Optional) Alibaba Cloud access key. It supports environment variables ALICLOUD_ACCESS_KEY and ALICLOUD_ACCESS_KEY_ID.

Returns:

this

acl

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

Sets the value of OssBackendConfig.getAcl()

Parameters:

acl - (Optional) Object ACL to be applied to the state file.

Returns:

this

assumeRole

@Stability(Deprecated)
@Deprecated
public DataTerraformRemoteStateOssConfig.Builder assumeRole(OssAssumeRole assumeRole)

Deprecated.

Use flattened assume role options

Sets the value of OssBackendConfig.getAssumeRole()

Parameters:

assumeRole - the value to be set.

Returns:

this

assumeRolePolicy

@Stability(Experimental)
public DataTerraformRemoteStateOssConfig.Builder assumeRolePolicy(String assumeRolePolicy)

Sets the value of OssBackendConfig.getAssumeRolePolicy()

Parameters:

assumeRolePolicy - (Optional, Available in 1.1.0+) A more restrictive policy to apply to the temporary credentials. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use this policy to grant permissions that exceed those of the role that is being assumed.

Returns:

this

assumeRoleRoleArn

@Stability(Experimental)
public DataTerraformRemoteStateOssConfig.Builder assumeRoleRoleArn(String assumeRoleRoleArn)

Sets the value of OssBackendConfig.getAssumeRoleRoleArn()

Parameters:

assumeRoleRoleArn - (Optional, Available in 1.1.0+) The ARN of the role to assume. If ARN is set to an empty string, it does not perform role switching. It supports the environment variable ALICLOUD_ASSUME_ROLE_ARN. Terraform executes configuration on account with provided credentials.

Returns:

this

assumeRoleSessionExpiration

@Stability(Experimental)
public DataTerraformRemoteStateOssConfig.Builder assumeRoleSessionExpiration(Number assumeRoleSessionExpiration)

Sets the value of OssBackendConfig.getAssumeRoleSessionExpiration()

Parameters:

assumeRoleSessionExpiration - (Optional, Available in 1.1.0+) The time after which the established session for assuming role expires. Valid value range: [900-3600] seconds. Default to 3600 (in this case Alibaba Cloud uses its own default value). It supports environment variable ALICLOUD_ASSUME_ROLE_SESSION_EXPIRATION.

Returns:

this

assumeRoleSessionName

@Stability(Experimental)
public DataTerraformRemoteStateOssConfig.Builder assumeRoleSessionName(String assumeRoleSessionName)

Sets the value of OssBackendConfig.getAssumeRoleSessionName()

Parameters:

assumeRoleSessionName - (Optional, Available in 1.1.0+) The session name to use when assuming the role. If omitted, 'terraform' is passed to the AssumeRole call as session name. It supports environment variable ALICLOUD_ASSUME_ROLE_SESSION_NAME.

Returns:

this

ecsRoleName

@Stability(Experimental)
public DataTerraformRemoteStateOssConfig.Builder ecsRoleName(String ecsRoleName)

Sets the value of OssBackendConfig.getEcsRoleName()

Parameters:

ecsRoleName - (Optional, Available in 0.12.14+) The RAM Role Name attached on a ECS instance for API operations. You can retrieve this from the 'Access Control' section of the Alibaba Cloud console.

Returns:

this

encrypt

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

Sets the value of OssBackendConfig.getEncrypt()

Parameters:

encrypt - (Optional) Whether to enable server side encryption of the state file. If it is true, OSS will use 'AES256' encryption algorithm to encrypt state file.

Returns:

this

endpoint

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

Sets the value of OssBackendConfig.getEndpoint()

Parameters:

endpoint - (Optional) A custom endpoint for the OSS API. It supports environment variables ALICLOUD_OSS_ENDPOINT and OSS_ENDPOINT.

Returns:

this

key

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

Sets the value of OssBackendConfig.getKey()

Parameters:

key - (Optional) The name of the state file. Defaults to terraform.tfstate.

Returns:

this

prefix

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

Sets the value of OssBackendConfig.getPrefix()

Parameters:

prefix - (Optional) The path directory of the state file will be stored. Default to "env:".

Returns:

this

profile

@Stability(Experimental)
public DataTerraformRemoteStateOssConfig.Builder profile(String profile)

Sets the value of OssBackendConfig.getProfile()

Parameters:

profile - (Optional, Available in 0.12.8+) This is the Alibaba Cloud profile name as set in the shared credentials file. It can also be sourced from the ALICLOUD_PROFILE environment variable.

Returns:

this

region

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

Sets the value of OssBackendConfig.getRegion()

Parameters:

region - (Optional) The region of the OSS bucket. It supports environment variables ALICLOUD_REGION and ALICLOUD_DEFAULT_REGION.

Returns:

this

secretKey

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

Sets the value of OssBackendConfig.getSecretKey()

Parameters:

secretKey - (Optional) Alibaba Cloud secret access key. It supports environment variables ALICLOUD_SECRET_KEY and ALICLOUD_ACCESS_KEY_SECRET.

Returns:

this

securityToken

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

Sets the value of OssBackendConfig.getSecurityToken()

Parameters:

securityToken - (Optional) STS access token. It supports environment variable ALICLOUD_SECURITY_TOKEN.

Returns:

this

sharedCredentialsFile

@Stability(Experimental)
public DataTerraformRemoteStateOssConfig.Builder sharedCredentialsFile(String sharedCredentialsFile)

Sets the value of OssBackendConfig.getSharedCredentialsFile()

Parameters:

sharedCredentialsFile - (Optional, Available in 0.12.8+) This is the path to the shared credentials file. It can also be sourced from the ALICLOUD_SHARED_CREDENTIALS_FILE environment variable. If this is not set and a profile is specified, ~/.aliyun/config.json will be used.

Returns:

this

stsEndpoint

@Stability(Experimental)
public DataTerraformRemoteStateOssConfig.Builder stsEndpoint(String stsEndpoint)

Sets the value of OssBackendConfig.getStsEndpoint()

Parameters:

stsEndpoint - (Optional, Available in 1.0.11+) Custom endpoint for the AliCloud Security Token Service (STS) API. It supports environment variable ALICLOUD_STS_ENDPOINT.

Returns:

this

tablestoreEndpoint

@Stability(Experimental)
public DataTerraformRemoteStateOssConfig.Builder tablestoreEndpoint(String tablestoreEndpoint)

Sets the value of OssBackendConfig.getTablestoreEndpoint()

Parameters:

tablestoreEndpoint - (Optional) A custom endpoint for the TableStore API.

Returns:

this

tablestoreTable

@Stability(Experimental)
public DataTerraformRemoteStateOssConfig.Builder tablestoreTable(String tablestoreTable)

Sets the value of OssBackendConfig.getTablestoreTable()

Parameters:

tablestoreTable - (Optional) A TableStore table for state locking and consistency. The table must have a primary key named LockID of type String.

Returns:

this

build

@Stability(Experimental)
public DataTerraformRemoteStateOssConfig build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of DataTerraformRemoteStateOssConfig

Throws:

NullPointerException - if any required attribute was not provided