Package com.hashicorp.cdktf

Class DataTerraformRemoteStateGcsConfig.Builder

java.lang.Object

com.hashicorp.cdktf.DataTerraformRemoteStateGcsConfig.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<DataTerraformRemoteStateGcsConfig>

Enclosing interface:

DataTerraformRemoteStateGcsConfig

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

A builder for DataTerraformRemoteStateGcsConfig

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
DataTerraformRemoteStateGcsConfig.Builder	accessToken(String accessToken)	Sets the value of GcsBackendConfig.getAccessToken()
DataTerraformRemoteStateGcsConfig.Builder	bucket(String bucket)	Sets the value of GcsBackendConfig.getBucket()
DataTerraformRemoteStateGcsConfig	build()	Builds the configured instance.
DataTerraformRemoteStateGcsConfig.Builder	credentials(String credentials)	Sets the value of GcsBackendConfig.getCredentials()
DataTerraformRemoteStateGcsConfig.Builder	defaults(Map<String,? extends Object> defaults)	Sets the value of DataTerraformRemoteStateConfig.getDefaults()
DataTerraformRemoteStateGcsConfig.Builder	encryptionKey(String encryptionKey)	Sets the value of GcsBackendConfig.getEncryptionKey()
DataTerraformRemoteStateGcsConfig.Builder	impersonateServiceAccount(String impersonateServiceAccount)	Sets the value of GcsBackendConfig.getImpersonateServiceAccount()
DataTerraformRemoteStateGcsConfig.Builder	impersonateServiceAccountDelegates(List<String> impersonateServiceAccountDelegates)	Sets the value of GcsBackendConfig.getImpersonateServiceAccountDelegates()
DataTerraformRemoteStateGcsConfig.Builder	kmsEncryptionKey(String kmsEncryptionKey)	Sets the value of GcsBackendConfig.getKmsEncryptionKey()
DataTerraformRemoteStateGcsConfig.Builder	prefix(String prefix)	Sets the value of GcsBackendConfig.getPrefix()
DataTerraformRemoteStateGcsConfig.Builder	storeageCustomEndpoint(String storeageCustomEndpoint)	Sets the value of GcsBackendConfig.getStoreageCustomEndpoint()
DataTerraformRemoteStateGcsConfig.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 DataTerraformRemoteStateGcsConfig.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 DataTerraformRemoteStateGcsConfig.Builder workspace(String workspace)

Sets the value of DataTerraformRemoteStateConfig.getWorkspace()

Parameters:

workspace - the value to be set.

Returns:

this

bucket

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

Sets the value of GcsBackendConfig.getBucket()

Parameters:

bucket - (Required) The name of the GCS bucket. This parameter is required. This name must be globally unique.

Returns:

this

accessToken

@Stability(Experimental)
public DataTerraformRemoteStateGcsConfig.Builder accessToken(String accessToken)

Sets the value of GcsBackendConfig.getAccessToken()

Parameters:

accessToken - (Optional) A temporary [OAuth 2.0 access token] obtained from the Google Authorization server, i.e. the Authorization: Bearer token used to authenticate HTTP requests to GCP APIs. This is an alternative to credentials. If both are specified, access_token will be used over the credentials field.

Returns:

this

credentials

@Stability(Experimental)
public DataTerraformRemoteStateGcsConfig.Builder credentials(String credentials)

Sets the value of GcsBackendConfig.getCredentials()

Parameters:

credentials - (Optional) Local path to Google Cloud Platform account credentials in JSON format. If unset, Google Application Default Credentials are used. The provided credentials must have Storage Object Admin role on the bucket.

Warning: if using the Google Cloud Platform provider as well, it will also pick up the GOOGLE_CREDENTIALS environment variable.

Returns:

this

encryptionKey

@Stability(Experimental)
public DataTerraformRemoteStateGcsConfig.Builder encryptionKey(String encryptionKey)

Sets the value of GcsBackendConfig.getEncryptionKey()

Parameters:

encryptionKey - (Optional) A 32 byte base64 encoded 'customer supplied encryption key' used to encrypt all state.

Returns:

this

impersonateServiceAccount

@Stability(Experimental)
public DataTerraformRemoteStateGcsConfig.Builder impersonateServiceAccount(String impersonateServiceAccount)

Sets the value of GcsBackendConfig.getImpersonateServiceAccount()

Parameters:

impersonateServiceAccount - (Optional) The service account to impersonate for accessing the State Bucket. You must have roles/iam.serviceAccountTokenCreator role on that account for the impersonation to succeed. If you are using a delegation chain, you can specify that using the impersonate_service_account_delegates field. Alternatively, this can be specified using the GOOGLE_IMPERSONATE_SERVICE_ACCOUNT environment variable.

Returns:

this

impersonateServiceAccountDelegates

@Stability(Experimental)
public DataTerraformRemoteStateGcsConfig.Builder impersonateServiceAccountDelegates(List<String> impersonateServiceAccountDelegates)

Sets the value of GcsBackendConfig.getImpersonateServiceAccountDelegates()

Parameters:

impersonateServiceAccountDelegates - (Optional) The delegation chain for an impersonating a service account.

Returns:

this

kmsEncryptionKey

@Stability(Experimental)
public DataTerraformRemoteStateGcsConfig.Builder kmsEncryptionKey(String kmsEncryptionKey)

Sets the value of GcsBackendConfig.getKmsEncryptionKey()

Parameters:

kmsEncryptionKey - (Optional) A Cloud KMS key ('customer-managed encryption key') used when reading and writing state files in the bucket. Format should be projects/{{project}}/locations/{{location}}/keyRings/{{keyRing}}/cryptoKeys/{{name}}. For more information, including IAM requirements, see

invalid @link

{@link https://cloud.google.com/storage/docs/encryption/customer-managed-keys

Customer-managed Encryption Keys}.

Returns:

this

prefix

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

Sets the value of GcsBackendConfig.getPrefix()

Parameters:

prefix - (Optional) GCS prefix inside the bucket. Named states for workspaces are stored in an object called /.tfstate.

Returns:

this

storeageCustomEndpoint

@Stability(Experimental)
public DataTerraformRemoteStateGcsConfig.Builder storeageCustomEndpoint(String storeageCustomEndpoint)

Sets the value of GcsBackendConfig.getStoreageCustomEndpoint()

Parameters:

storeageCustomEndpoint - (Optional) A URL containing three parts: the protocol, the DNS name pointing to a Private Service Connect endpoint, and the path for the Cloud Storage API (/storage/v1/b).

invalid @link

{@link https://developer.hashicorp.com/terraform/language/settings/backends/gcs#storage_custom_endpoint

See here for more details}

Returns:

this

build

@Stability(Experimental)
public DataTerraformRemoteStateGcsConfig build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of DataTerraformRemoteStateGcsConfig

Throws:

NullPointerException - if any required attribute was not provided