com.hashicorp.cdktf

Class GcsBackendProps.Builder

java.lang.Object

com.hashicorp.cdktf.GcsBackendProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<GcsBackendProps>

Enclosing interface:

GcsBackendProps

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

A builder for GcsBackendProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
GcsBackendProps.Builder	accessToken(String accessToken) Sets the value of GcsBackendProps.getAccessToken()
GcsBackendProps.Builder	bucket(String bucket) Sets the value of GcsBackendProps.getBucket()
GcsBackendProps	build() Builds the configured instance.
GcsBackendProps.Builder	credentials(String credentials) Sets the value of GcsBackendProps.getCredentials()
GcsBackendProps.Builder	encryptionKey(String encryptionKey) Sets the value of GcsBackendProps.getEncryptionKey()
GcsBackendProps.Builder	impersonateServiceAccount(String impersonateServiceAccount) Sets the value of GcsBackendProps.getImpersonateServiceAccount()
GcsBackendProps.Builder	impersonateServiceAccountDelegates(List<String> impersonateServiceAccountDelegates) Sets the value of GcsBackendProps.getImpersonateServiceAccountDelegates()
GcsBackendProps.Builder	prefix(String prefix) Sets the value of GcsBackendProps.getPrefix()

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 GcsBackendProps.Builder bucket(String bucket)

Sets the value of GcsBackendProps.getBucket()

Parameters:

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

Returns:

this

accessToken

@Stability(value=Experimental)
public GcsBackendProps.Builder accessToken(String accessToken)

Sets the value of GcsBackendProps.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(value=Experimental)
public GcsBackendProps.Builder credentials(String credentials)

Sets the value of GcsBackendProps.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(value=Experimental)
public GcsBackendProps.Builder encryptionKey(String encryptionKey)

Sets the value of GcsBackendProps.getEncryptionKey()

Parameters:

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

Returns:

this

impersonateServiceAccount

@Stability(value=Experimental)
public GcsBackendProps.Builder impersonateServiceAccount(String impersonateServiceAccount)

Sets the value of GcsBackendProps.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(value=Experimental)
public GcsBackendProps.Builder impersonateServiceAccountDelegates(List<String> impersonateServiceAccountDelegates)

Sets the value of GcsBackendProps.getImpersonateServiceAccountDelegates()

Parameters:

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

Returns:

this

prefix

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

Sets the value of GcsBackendProps.getPrefix()

Parameters:

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

Returns:

this

build

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

Builds the configured instance.

Specified by:

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

Returns:

a new instance of GcsBackendProps

Throws:

NullPointerException - if any required attribute was not provided