Skip to main content

Documentation Index

Fetch the complete documentation index at: https://cdktn.io/docs/llms.txt

Use this file to discover all available pages before exploring further.

​
Initializers 

import io.cdktn.cdktn.DataTerraformRemoteStateGcs;

DataTerraformRemoteStateGcs.Builder.create(Construct scope, java.lang.String id)
//  .defaults(java.util.Map<java.lang.String, java.lang.Object>)
//  .workspace(java.lang.String)
    .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();
NameTypeDescription
scopesoftware.constructs.ConstructNo description.
idjava.lang.StringNo description.
defaultsjava.util.Map< java.lang.String, java.lang.Object >No description.
workspacejava.lang.StringNo description.
bucketjava.lang.String(Required) The name of the GCS bucket.
accessTokenjava.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.
credentialsjava.lang.String(Optional) Local path to Google Cloud Platform account credentials in JSON format.
encryptionKeyjava.lang.String(Optional) A 32 byte base64 encoded ‘customer supplied encryption key’ used to encrypt all state.
impersonateServiceAccountjava.lang.String(Optional) The service account to impersonate for accessing the State Bucket.
impersonateServiceAccountDelegatesjava.util.List< java.lang.String >(Optional) The delegation chain for an impersonating a service account.
kmsEncryptionKeyjava.lang.String(Optional) A Cloud KMS key (‘customer-managed encryption key’) used when reading and writing state files in the bucket.
prefixjava.lang.String(Optional) GCS prefix inside the bucket.
storeageCustomEndpointjava.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).

​
scopeRequired

  • Type: software.constructs.Construct

​
idRequired

  • Type: java.lang.String

​
defaultsOptional

  • Type: java.util.Map< java.lang.String, java.lang.Object >

​
workspaceOptional

  • Type: java.lang.String

​
bucketRequired

  • Type: java.lang.String
(Required) The name of the GCS bucket. This name must be globally unique.

​
accessTokenOptional

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

​
credentialsOptional

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

​
encryptionKeyOptional

  • Type: java.lang.String
(Optional) A 32 byte base64 encoded ‘customer supplied encryption key’ used to encrypt all state.

​
impersonateServiceAccountOptional

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

​
impersonateServiceAccountDelegatesOptional

  • Type: java.util.List< java.lang.String >
(Optional) The delegation chain for an impersonating a service account.

​
kmsEncryptionKeyOptional

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

​
prefixOptional

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

​
storeageCustomEndpointOptional

  • 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

NameDescription
toStringReturns a string representation of this construct.
addOverrideNo description.
overrideLogicalIdOverrides the auto-generated logical ID with a specific ID.
resetOverrideLogicalIdResets a previously passed logical Id to use the auto-generated logical id again.
toHclTerraformAdds this resource to the terraform JSON output.
toMetadataNo description.
toTerraformAdds this resource to the terraform JSON output.
getNo description.
getBooleanNo description.
getListNo description.
getNumberNo description.
getStringNo description.

​
toString 

public java.lang.String toString()
Returns a string representation of this construct.

​
addOverride 

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

​
pathRequired

  • Type: java.lang.String

​
valueRequired

  • Type: java.lang.Object

​
overrideLogicalId 

public void overrideLogicalId(java.lang.String newLogicalId)
Overrides the auto-generated logical ID with a specific ID.

​
newLogicalIdRequired

  • 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()
Adds this resource to the terraform JSON output.

​
toMetadata 

public java.lang.Object toMetadata()

​
toTerraform 

public java.lang.Object toTerraform()
Adds this resource to the terraform JSON output.

​
get 

public IResolvable get(java.lang.String output)

​
outputRequired

  • Type: java.lang.String

​
getBoolean 

public IResolvable getBoolean(java.lang.String output)

​
outputRequired

  • Type: java.lang.String

​
getList 

public java.util.List<java.lang.String> getList(java.lang.String output)

​
outputRequired

  • Type: java.lang.String

​
getNumber 

public java.lang.Number getNumber(java.lang.String output)

​
outputRequired

  • Type: java.lang.String

​
getString 

public java.lang.String getString(java.lang.String output)

​
outputRequired

  • Type: java.lang.String

​
Static Functions

NameDescription
isConstructChecks if x is a construct.
isTerraformElementNo description.

​
isConstruct 

import io.cdktn.cdktn.DataTerraformRemoteStateGcs;

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

​
xRequired

  • Type: java.lang.Object
Any object.

​
isTerraformElement 

import io.cdktn.cdktn.DataTerraformRemoteStateGcs;

DataTerraformRemoteStateGcs.isTerraformElement(java.lang.Object x)

​
xRequired

  • Type: java.lang.Object

​
Properties

NameTypeDescription
nodesoftware.constructs.NodeThe tree node.
cdktfStackTerraformStackNo description.
fqnjava.lang.StringNo description.
friendlyUniqueIdjava.lang.StringNo description.

​
nodeRequired 

public Node getNode();
  • Type: software.constructs.Node
The tree node.

​
cdktfStackRequired 

public TerraformStack getCdktfStack();

​
fqnRequired 

public java.lang.String getFqn();
  • Type: java.lang.String

​
friendlyUniqueIdRequired 

public java.lang.String getFriendlyUniqueId();
  • Type: java.lang.String

​
Constants

NameTypeDescription
tfResourceTypejava.lang.StringNo description.

​
tfResourceTypeRequired 

public java.lang.String getTfResourceType();
  • Type: java.lang.String