Java: GcsBackend - CDK Terrain (CDKTN)

Initializers

import io.cdktn.cdktn.GcsBackend;

GcsBackend.Builder.create(Construct scope)
    .bucket(java.lang.String)
//  .accessToken(java.lang.String)
//  .credentials(java.lang.String)
//  .encryptionKey(java.lang.String)
//  .impersonateServiceAccount(java.lang.String)
//  .impersonateServiceAccountDelegates(java.util.List<java.lang.String>)
//  .kmsEncryptionKey(java.lang.String)
//  .prefix(java.lang.String)
//  .storeageCustomEndpoint(java.lang.String)
    .build();

Name	Type	Description
`scope`	`software.constructs.Construct`	No description.
`bucket`	`java.lang.String`	(Required) The name of the GCS bucket.
`accessToken`	`java.lang.String`	(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.
`credentials`	`java.lang.String`	(Optional) Local path to Google Cloud Platform account credentials in JSON format.
`encryptionKey`	`java.lang.String`	(Optional) A 32 byte base64 encoded ‘customer supplied encryption key’ used to encrypt all state.
`impersonateServiceAccount`	`java.lang.String`	(Optional) The service account to impersonate for accessing the State Bucket.
`impersonateServiceAccountDelegates`	`java.util.List< java.lang.String >`	(Optional) The delegation chain for an impersonating a service account.
`kmsEncryptionKey`	`java.lang.String`	(Optional) A Cloud KMS key (‘customer-managed encryption key’) used when reading and writing state files in the bucket.
`prefix`	`java.lang.String`	(Optional) GCS prefix inside the bucket.
`storeageCustomEndpoint`	`java.lang.String`	(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).

`scope`^Required

Type: software.constructs.Construct

`bucket`^Required

Type: java.lang.String

(Required) The name of the GCS bucket. This name must be globally unique.

`accessToken`^Optional

Type: java.lang.String

(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.

`credentials`^Optional

Type: java.lang.String

(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.

`encryptionKey`^Optional

Type: java.lang.String

(Optional) A 32 byte base64 encoded ‘customer supplied encryption key’ used to encrypt all state.

`impersonateServiceAccount`^Optional

Type: java.lang.String

(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.

`impersonateServiceAccountDelegates`^Optional

Type: java.util.List< java.lang.String >

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

`kmsEncryptionKey`^Optional

Type: java.lang.String

(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 Customer-managed Encryption Keys.

`prefix`^Optional

Type: java.lang.String

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

`storeageCustomEndpoint`^Optional

Type: java.lang.String

(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). See here for more details

Methods

Name	Description
`toString`	Returns a string representation of this construct.
`with`	Applies one or more mixins to this construct.
`addOverride`	No description.
`overrideLogicalId`	Overrides the auto-generated logical ID with a specific ID.
`resetOverrideLogicalId`	Resets a previously passed logical Id to use the auto-generated logical id again.
`toHclTerraform`	No description.
`toMetadata`	No description.
`toTerraform`	Adds this resource to the terraform JSON output.
`getRemoteStateDataSource`	Creates a TerraformRemoteState resource that accesses this backend.

`toString`

public java.lang.String toString()

Returns a string representation of this construct.

`with`

public IConstruct with(IMixin... mixins)

Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

`mixins`^Required

Type: software.constructs.IMixin…

The mixins to apply.

`addOverride`

public void addOverride(java.lang.String path, java.lang.Object value)

`path`^Required

Type: java.lang.String

`value`^Required

Type: java.lang.Object

`overrideLogicalId`

public void overrideLogicalId(java.lang.String newLogicalId)

Overrides the auto-generated logical ID with a specific ID.

`newLogicalId`^Required

Type: java.lang.String

The new logical ID to use for this stack element.

`resetOverrideLogicalId`

public void resetOverrideLogicalId()

Resets a previously passed logical Id to use the auto-generated logical id again.

`toHclTerraform`

public java.lang.Object toHclTerraform()

`toMetadata`

public java.lang.Object toMetadata()

`toTerraform`

public java.lang.Object toTerraform()

Adds this resource to the terraform JSON output.

`getRemoteStateDataSource`

public TerraformRemoteState getRemoteStateDataSource(Construct scope, java.lang.String name, java.lang.String _fromStack)

Creates a TerraformRemoteState resource that accesses this backend.

`scope`^Required

Type: software.constructs.Construct

`name`^Required

Type: java.lang.String

`_fromStack`^Required

Type: java.lang.String

Static Functions

Name	Description
`isConstruct`	Checks if `x` is a construct.
`isTerraformElement`	No description.
`isBackend`	No description.

`isConstruct`

import io.cdktn.cdktn.GcsBackend;

GcsBackend.isConstruct(java.lang.Object x)

Checks if x is a construct. Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

`x`^Required

Type: java.lang.Object

Any object.

`isTerraformElement`

import io.cdktn.cdktn.GcsBackend;

GcsBackend.isTerraformElement(java.lang.Object x)

`x`^Required

Type: java.lang.Object

`isBackend`

import io.cdktn.cdktn.GcsBackend;

GcsBackend.isBackend(java.lang.Object x)

`x`^Required

Type: java.lang.Object

Properties

Name	Type	Description
`node`	`software.constructs.Node`	The tree node.
`cdktfStack`	`TerraformStack`	No description.
`fqn`	`java.lang.String`	No description.
`friendlyUniqueId`	`java.lang.String`	No description.

`node`^Required

public Node getNode();

Type: software.constructs.Node

The tree node.

`cdktfStack`^Required

public TerraformStack getCdktfStack();

Type: TerraformStack

`fqn`^Required

public java.lang.String getFqn();

Type: java.lang.String

`friendlyUniqueId`^Required

public java.lang.String getFriendlyUniqueId();

Type: java.lang.String

​Initializers

​scopeRequired

​bucketRequired

​accessTokenOptional

​credentialsOptional

​encryptionKeyOptional

​impersonateServiceAccountOptional

​impersonateServiceAccountDelegatesOptional

​kmsEncryptionKeyOptional

​prefixOptional

​storeageCustomEndpointOptional

​Methods

​toString

​with

​mixinsRequired

​addOverride

​pathRequired

​valueRequired

​overrideLogicalId

​newLogicalIdRequired

​resetOverrideLogicalId

​toHclTerraform

​toMetadata

​toTerraform

​getRemoteStateDataSource

​scopeRequired

​nameRequired

​_fromStackRequired

​Static Functions

​isConstruct

​xRequired

​isTerraformElement

​xRequired

​isBackend

​xRequired

​Properties

​nodeRequired

​cdktfStackRequired

​fqnRequired

​friendlyUniqueIdRequired

Initializers

`scope`^Required

`bucket`^Required

`accessToken`^Optional

`credentials`^Optional

`encryptionKey`^Optional

`impersonateServiceAccount`^Optional

`impersonateServiceAccountDelegates`^Optional

`kmsEncryptionKey`^Optional

`prefix`^Optional

`storeageCustomEndpoint`^Optional

Methods

`toString`

`with`

`mixins`^Required

`addOverride`

`path`^Required

`value`^Required

`overrideLogicalId`

`newLogicalId`^Required

`resetOverrideLogicalId`

`toHclTerraform`

`toMetadata`

`toTerraform`

`getRemoteStateDataSource`

`scope`^Required

`name`^Required

`_fromStack`^Required

Static Functions

`isConstruct`

`x`^Required

`isTerraformElement`

`x`^Required

`isBackend`

`x`^Required

Properties

`node`^Required

`cdktfStack`^Required

`fqn`^Required

`friendlyUniqueId`^Required