Represents a {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.50.0/docs/resources/google_spanner_database google_spanner_database}.
import com.hashicorp.cdktf.providers.google_beta.google_spanner_database.GoogleSpannerDatabase;
GoogleSpannerDatabase.Builder.create(Construct scope, java.lang.String id)
// .connection(SSHProvisionerConnection|WinrmProvisionerConnection)
// .count(java.lang.Number|TerraformCount)
// .dependsOn(java.util.List<ITerraformDependable>)
// .forEach(ITerraformIterator)
// .lifecycle(TerraformResourceLifecycle)
// .provider(TerraformProvider)
// .provisioners(java.util.List<FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner>)
.instance(java.lang.String)
.name(java.lang.String)
// .databaseDialect(java.lang.String)
// .ddl(java.util.List<java.lang.String>)
// .defaultTimeZone(java.lang.String)
// .deletionProtection(java.lang.Boolean|IResolvable)
// .enableDropProtection(java.lang.Boolean|IResolvable)
// .encryptionConfig(GoogleSpannerDatabaseEncryptionConfig)
// .id(java.lang.String)
// .project(java.lang.String)
// .timeouts(GoogleSpannerDatabaseTimeouts)
// .versionRetentionPeriod(java.lang.String)
.build();| Name | Type | Description |
|---|---|---|
scope |
software.constructs.Construct |
The scope in which to define this construct. |
id |
java.lang.String |
The scoped construct ID. |
connection |
com.hashicorp.cdktf.SSHProvisionerConnection|com.hashicorp.cdktf.WinrmProvisionerConnection |
No description. |
count |
java.lang.Number|com.hashicorp.cdktf.TerraformCount |
No description. |
dependsOn |
java.util.List<com.hashicorp.cdktf.ITerraformDependable> |
No description. |
forEach |
com.hashicorp.cdktf.ITerraformIterator |
No description. |
lifecycle |
com.hashicorp.cdktf.TerraformResourceLifecycle |
No description. |
provider |
com.hashicorp.cdktf.TerraformProvider |
No description. |
provisioners |
java.util.List<com.hashicorp.cdktf.FileProvisioner|com.hashicorp.cdktf.LocalExecProvisioner|com.hashicorp.cdktf.RemoteExecProvisioner> |
No description. |
instance |
java.lang.String |
The instance to create the database on. |
name |
java.lang.String |
A unique identifier for the database, which cannot be changed after the instance is created. |
databaseDialect |
java.lang.String |
The dialect of the Cloud Spanner Database. If it is not provided, "GOOGLE_STANDARD_SQL" will be used. Possible values: ["GOOGLE_STANDARD_SQL", "POSTGRESQL"]. |
ddl |
java.util.List<java.lang.String> |
An optional list of DDL statements to run inside the database. Statements can create tables, indexes, etc. |
defaultTimeZone |
java.lang.String |
The default time zone for the database. |
deletionProtection |
java.lang.Boolean|com.hashicorp.cdktf.IResolvable |
Whether Terraform will be prevented from destroying the database. |
enableDropProtection |
java.lang.Boolean|com.hashicorp.cdktf.IResolvable |
Whether drop protection is enabled for this database. |
encryptionConfig |
GoogleSpannerDatabaseEncryptionConfig |
encryption_config block. |
id |
java.lang.String |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.50.0/docs/resources/google_spanner_database#id GoogleSpannerDatabase#id}. |
project |
java.lang.String |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.50.0/docs/resources/google_spanner_database#project GoogleSpannerDatabase#project}. |
timeouts |
GoogleSpannerDatabaseTimeouts |
timeouts block. |
versionRetentionPeriod |
java.lang.String |
The retention period for the database. |
- Type: software.constructs.Construct
The scope in which to define this construct.
- Type: java.lang.String
The scoped construct ID.
Must be unique amongst siblings in the same scope
- Type: com.hashicorp.cdktf.SSHProvisionerConnection|com.hashicorp.cdktf.WinrmProvisionerConnection
- Type: java.lang.Number|com.hashicorp.cdktf.TerraformCount
- Type: java.util.List<com.hashicorp.cdktf.ITerraformDependable>
- Type: com.hashicorp.cdktf.ITerraformIterator
- Type: com.hashicorp.cdktf.TerraformResourceLifecycle
- Type: com.hashicorp.cdktf.TerraformProvider
- Type: java.util.List<com.hashicorp.cdktf.FileProvisioner|com.hashicorp.cdktf.LocalExecProvisioner|com.hashicorp.cdktf.RemoteExecProvisioner>
- Type: java.lang.String
The instance to create the database on.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.50.0/docs/resources/google_spanner_database#instance GoogleSpannerDatabase#instance}
- Type: java.lang.String
A unique identifier for the database, which cannot be changed after the instance is created.
Values are of the form '[a-z][-_a-z0-9]*[a-z0-9]'.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.50.0/docs/resources/google_spanner_database#name GoogleSpannerDatabase#name}
- Type: java.lang.String
The dialect of the Cloud Spanner Database. If it is not provided, "GOOGLE_STANDARD_SQL" will be used. Possible values: ["GOOGLE_STANDARD_SQL", "POSTGRESQL"].
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.50.0/docs/resources/google_spanner_database#database_dialect GoogleSpannerDatabase#database_dialect}
- Type: java.util.List<java.lang.String>
An optional list of DDL statements to run inside the database. Statements can create tables, indexes, etc.
During creation these statements execute atomically with the creation of the database and if there is an error in any statement, the database is not created.
Terraform does not perform drift detection on this field and assumes that the values recorded in state are accurate. Limited updates to this field are supported, and newly appended DDL statements can be executed in an update. However, modifications to prior statements will create a plan that marks the resource for recreation.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.50.0/docs/resources/google_spanner_database#ddl GoogleSpannerDatabase#ddl}
- Type: java.lang.String
The default time zone for the database.
The default time zone must be a valid name from the tz database. Default value is "America/Los_angeles".
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.50.0/docs/resources/google_spanner_database#default_time_zone GoogleSpannerDatabase#default_time_zone}
- Type: java.lang.Boolean|com.hashicorp.cdktf.IResolvable
Whether Terraform will be prevented from destroying the database.
Defaults to true. When a'terraform destroy' or 'terraform apply' would delete the database, the command will fail if this field is not set to false in Terraform state. When the field is set to true or unset in Terraform state, a 'terraform apply' or 'terraform destroy' that would delete the database will fail. When the field is set to false, deleting the database is allowed.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.50.0/docs/resources/google_spanner_database#deletion_protection GoogleSpannerDatabase#deletion_protection}
- Type: java.lang.Boolean|com.hashicorp.cdktf.IResolvable
Whether drop protection is enabled for this database.
Defaults to false. Drop protection is different from the "deletion_protection" attribute in the following ways: (1) "deletion_protection" only protects the database from deletions in Terraform. whereas setting “enableDropProtection” to true protects the database from deletions in all interfaces. (2) Setting "enableDropProtection" to true also prevents the deletion of the parent instance containing the database. "deletion_protection" attribute does not provide protection against the deletion of the parent instance.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.50.0/docs/resources/google_spanner_database#enable_drop_protection GoogleSpannerDatabase#enable_drop_protection}
encryption_config block.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.50.0/docs/resources/google_spanner_database#encryption_config GoogleSpannerDatabase#encryption_config}
- Type: java.lang.String
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.50.0/docs/resources/google_spanner_database#id GoogleSpannerDatabase#id}.
Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.
- Type: java.lang.String
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.50.0/docs/resources/google_spanner_database#project GoogleSpannerDatabase#project}.
timeouts block.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.50.0/docs/resources/google_spanner_database#timeouts GoogleSpannerDatabase#timeouts}
- Type: java.lang.String
The retention period for the database.
The retention period must be between 1 hour and 7 days, and can be specified in days, hours, minutes, or seconds. For example, the values 1d, 24h, 1440m, and 86400s are equivalent. Default value is 1h. If this property is used, you must avoid adding new DDL statements to 'ddl' that update the database's version_retention_period.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.50.0/docs/resources/google_spanner_database#version_retention_period GoogleSpannerDatabase#version_retention_period}
| Name | Description |
|---|---|
toString |
Returns a string representation of 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. |
addMoveTarget |
Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. |
getAnyMapAttribute |
No description. |
getBooleanAttribute |
No description. |
getBooleanMapAttribute |
No description. |
getListAttribute |
No description. |
getNumberAttribute |
No description. |
getNumberListAttribute |
No description. |
getNumberMapAttribute |
No description. |
getStringAttribute |
No description. |
getStringMapAttribute |
No description. |
hasResourceMove |
No description. |
importFrom |
No description. |
interpolationForAttribute |
No description. |
moveFromId |
Move the resource corresponding to "id" to this resource. |
moveTo |
Moves this resource to the target resource given by moveTarget. |
moveToId |
Moves this resource to the resource corresponding to "id". |
putEncryptionConfig |
No description. |
putTimeouts |
No description. |
resetDatabaseDialect |
No description. |
resetDdl |
No description. |
resetDefaultTimeZone |
No description. |
resetDeletionProtection |
No description. |
resetEnableDropProtection |
No description. |
resetEncryptionConfig |
No description. |
resetId |
No description. |
resetProject |
No description. |
resetTimeouts |
No description. |
resetVersionRetentionPeriod |
No description. |
public java.lang.String toString()Returns a string representation of this construct.
public void addOverride(java.lang.String path, java.lang.Object value)- Type: java.lang.String
- Type: java.lang.Object
public void overrideLogicalId(java.lang.String newLogicalId)Overrides the auto-generated logical ID with a specific ID.
- Type: java.lang.String
The new logical ID to use for this stack element.
public void resetOverrideLogicalId()Resets a previously passed logical Id to use the auto-generated logical id again.
public java.lang.Object toHclTerraform()public java.lang.Object toMetadata()public java.lang.Object toTerraform()Adds this resource to the terraform JSON output.
public void addMoveTarget(java.lang.String moveTarget)Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
- Type: java.lang.String
The string move target that will correspond to this resource.
public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)- Type: java.lang.String
public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)- Type: java.lang.String
public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)- Type: java.lang.String
public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)- Type: java.lang.String
public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)- Type: java.lang.String
public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)- Type: java.lang.String
public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)- Type: java.lang.String
public java.lang.String getStringAttribute(java.lang.String terraformAttribute)- Type: java.lang.String
public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)- Type: java.lang.String
public TerraformResourceMoveByTarget|TerraformResourceMoveById hasResourceMove()public void importFrom(java.lang.String id)
public void importFrom(java.lang.String id, TerraformProvider provider)- Type: java.lang.String
- Type: com.hashicorp.cdktf.TerraformProvider
public IResolvable interpolationForAttribute(java.lang.String terraformAttribute)- Type: java.lang.String
public void moveFromId(java.lang.String id)Move the resource corresponding to "id" to this resource.
Note that the resource being moved from must be marked as moved using it's instance function.
- Type: java.lang.String
Full id of resource being moved from, e.g. "aws_s3_bucket.example".
public void moveTo(java.lang.String moveTarget)
public void moveTo(java.lang.String moveTarget, java.lang.String|java.lang.Number index)Moves this resource to the target resource given by moveTarget.
- Type: java.lang.String
The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.
- Type: java.lang.String|java.lang.Number
Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.
public void moveToId(java.lang.String id)Moves this resource to the resource corresponding to "id".
- Type: java.lang.String
Full id of resource to move to, e.g. "aws_s3_bucket.example".
public void putEncryptionConfig(GoogleSpannerDatabaseEncryptionConfig value)public void putTimeouts(GoogleSpannerDatabaseTimeouts value)public void resetDatabaseDialect()public void resetDdl()public void resetDefaultTimeZone()public void resetDeletionProtection()public void resetEnableDropProtection()public void resetEncryptionConfig()public void resetId()public void resetProject()public void resetTimeouts()public void resetVersionRetentionPeriod()| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isTerraformElement |
No description. |
isTerraformResource |
No description. |
generateConfigForImport |
Generates CDKTF code for importing a GoogleSpannerDatabase resource upon running "cdktf plan ". |
import com.hashicorp.cdktf.providers.google_beta.google_spanner_database.GoogleSpannerDatabase;
GoogleSpannerDatabase.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.
- Type: java.lang.Object
Any object.
import com.hashicorp.cdktf.providers.google_beta.google_spanner_database.GoogleSpannerDatabase;
GoogleSpannerDatabase.isTerraformElement(java.lang.Object x)- Type: java.lang.Object
import com.hashicorp.cdktf.providers.google_beta.google_spanner_database.GoogleSpannerDatabase;
GoogleSpannerDatabase.isTerraformResource(java.lang.Object x)- Type: java.lang.Object
import com.hashicorp.cdktf.providers.google_beta.google_spanner_database.GoogleSpannerDatabase;
GoogleSpannerDatabase.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),GoogleSpannerDatabase.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider)Generates CDKTF code for importing a GoogleSpannerDatabase resource upon running "cdktf plan ".
- Type: software.constructs.Construct
The scope in which to define this construct.
- Type: java.lang.String
The construct id used in the generated config for the GoogleSpannerDatabase to import.
- Type: java.lang.String
The id of the existing GoogleSpannerDatabase that should be imported.
Refer to the {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.50.0/docs/resources/google_spanner_database#import import section} in the documentation of this resource for the id to use
- Type: com.hashicorp.cdktf.TerraformProvider
? Optional instance of the provider where the GoogleSpannerDatabase to import is found.
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
cdktfStack |
com.hashicorp.cdktf.TerraformStack |
No description. |
fqn |
java.lang.String |
No description. |
friendlyUniqueId |
java.lang.String |
No description. |
terraformMetaArguments |
java.util.Map<java.lang.String, java.lang.Object> |
No description. |
terraformResourceType |
java.lang.String |
No description. |
terraformGeneratorMetadata |
com.hashicorp.cdktf.TerraformProviderGeneratorMetadata |
No description. |
connection |
com.hashicorp.cdktf.SSHProvisionerConnection|com.hashicorp.cdktf.WinrmProvisionerConnection |
No description. |
count |
java.lang.Number|com.hashicorp.cdktf.TerraformCount |
No description. |
dependsOn |
java.util.List<java.lang.String> |
No description. |
forEach |
com.hashicorp.cdktf.ITerraformIterator |
No description. |
lifecycle |
com.hashicorp.cdktf.TerraformResourceLifecycle |
No description. |
provider |
com.hashicorp.cdktf.TerraformProvider |
No description. |
provisioners |
java.util.List<com.hashicorp.cdktf.FileProvisioner|com.hashicorp.cdktf.LocalExecProvisioner|com.hashicorp.cdktf.RemoteExecProvisioner> |
No description. |
encryptionConfig |
GoogleSpannerDatabaseEncryptionConfigOutputReference |
No description. |
state |
java.lang.String |
No description. |
timeouts |
GoogleSpannerDatabaseTimeoutsOutputReference |
No description. |
databaseDialectInput |
java.lang.String |
No description. |
ddlInput |
java.util.List<java.lang.String> |
No description. |
defaultTimeZoneInput |
java.lang.String |
No description. |
deletionProtectionInput |
java.lang.Boolean|com.hashicorp.cdktf.IResolvable |
No description. |
enableDropProtectionInput |
java.lang.Boolean|com.hashicorp.cdktf.IResolvable |
No description. |
encryptionConfigInput |
GoogleSpannerDatabaseEncryptionConfig |
No description. |
idInput |
java.lang.String |
No description. |
instanceInput |
java.lang.String |
No description. |
nameInput |
java.lang.String |
No description. |
projectInput |
java.lang.String |
No description. |
timeoutsInput |
com.hashicorp.cdktf.IResolvable|GoogleSpannerDatabaseTimeouts |
No description. |
versionRetentionPeriodInput |
java.lang.String |
No description. |
databaseDialect |
java.lang.String |
No description. |
ddl |
java.util.List<java.lang.String> |
No description. |
defaultTimeZone |
java.lang.String |
No description. |
deletionProtection |
java.lang.Boolean|com.hashicorp.cdktf.IResolvable |
No description. |
enableDropProtection |
java.lang.Boolean|com.hashicorp.cdktf.IResolvable |
No description. |
id |
java.lang.String |
No description. |
instance |
java.lang.String |
No description. |
name |
java.lang.String |
No description. |
project |
java.lang.String |
No description. |
versionRetentionPeriod |
java.lang.String |
No description. |
public Node getNode();- Type: software.constructs.Node
The tree node.
public TerraformStack getCdktfStack();- Type: com.hashicorp.cdktf.TerraformStack
public java.lang.String getFqn();- Type: java.lang.String
public java.lang.String getFriendlyUniqueId();- Type: java.lang.String
public java.util.Map<java.lang.String, java.lang.Object> getTerraformMetaArguments();- Type: java.util.Map<java.lang.String, java.lang.Object>
public java.lang.String getTerraformResourceType();- Type: java.lang.String
public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata();- Type: com.hashicorp.cdktf.TerraformProviderGeneratorMetadata
public SSHProvisionerConnection|WinrmProvisionerConnection getConnection();- Type: com.hashicorp.cdktf.SSHProvisionerConnection|com.hashicorp.cdktf.WinrmProvisionerConnection
public java.lang.Number|TerraformCount getCount();- Type: java.lang.Number|com.hashicorp.cdktf.TerraformCount
public java.util.List<java.lang.String> getDependsOn();- Type: java.util.List<java.lang.String>
public ITerraformIterator getForEach();- Type: com.hashicorp.cdktf.ITerraformIterator
public TerraformResourceLifecycle getLifecycle();- Type: com.hashicorp.cdktf.TerraformResourceLifecycle
public TerraformProvider getProvider();- Type: com.hashicorp.cdktf.TerraformProvider
public java.util.List<FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner> getProvisioners();- Type: java.util.List<com.hashicorp.cdktf.FileProvisioner|com.hashicorp.cdktf.LocalExecProvisioner|com.hashicorp.cdktf.RemoteExecProvisioner>
public GoogleSpannerDatabaseEncryptionConfigOutputReference getEncryptionConfig();public java.lang.String getState();- Type: java.lang.String
public GoogleSpannerDatabaseTimeoutsOutputReference getTimeouts();public java.lang.String getDatabaseDialectInput();- Type: java.lang.String
public java.util.List<java.lang.String> getDdlInput();- Type: java.util.List<java.lang.String>
public java.lang.String getDefaultTimeZoneInput();- Type: java.lang.String
public java.lang.Boolean|IResolvable getDeletionProtectionInput();- Type: java.lang.Boolean|com.hashicorp.cdktf.IResolvable
public java.lang.Boolean|IResolvable getEnableDropProtectionInput();- Type: java.lang.Boolean|com.hashicorp.cdktf.IResolvable
public GoogleSpannerDatabaseEncryptionConfig getEncryptionConfigInput();public java.lang.String getIdInput();- Type: java.lang.String
public java.lang.String getInstanceInput();- Type: java.lang.String
public java.lang.String getNameInput();- Type: java.lang.String
public java.lang.String getProjectInput();- Type: java.lang.String
public IResolvable|GoogleSpannerDatabaseTimeouts getTimeoutsInput();- Type: com.hashicorp.cdktf.IResolvable|GoogleSpannerDatabaseTimeouts
public java.lang.String getVersionRetentionPeriodInput();- Type: java.lang.String
public java.lang.String getDatabaseDialect();- Type: java.lang.String
public java.util.List<java.lang.String> getDdl();- Type: java.util.List<java.lang.String>
public java.lang.String getDefaultTimeZone();- Type: java.lang.String
public java.lang.Boolean|IResolvable getDeletionProtection();- Type: java.lang.Boolean|com.hashicorp.cdktf.IResolvable
public java.lang.Boolean|IResolvable getEnableDropProtection();- Type: java.lang.Boolean|com.hashicorp.cdktf.IResolvable
public java.lang.String getId();- Type: java.lang.String
public java.lang.String getInstance();- Type: java.lang.String
public java.lang.String getName();- Type: java.lang.String
public java.lang.String getProject();- Type: java.lang.String
public java.lang.String getVersionRetentionPeriod();- Type: java.lang.String
| Name | Type | Description |
|---|---|---|
tfResourceType |
java.lang.String |
No description. |
public java.lang.String getTfResourceType();- Type: java.lang.String
import com.hashicorp.cdktf.providers.google_beta.google_spanner_database.GoogleSpannerDatabaseConfig;
GoogleSpannerDatabaseConfig.builder()
// .connection(SSHProvisionerConnection|WinrmProvisionerConnection)
// .count(java.lang.Number|TerraformCount)
// .dependsOn(java.util.List<ITerraformDependable>)
// .forEach(ITerraformIterator)
// .lifecycle(TerraformResourceLifecycle)
// .provider(TerraformProvider)
// .provisioners(java.util.List<FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner>)
.instance(java.lang.String)
.name(java.lang.String)
// .databaseDialect(java.lang.String)
// .ddl(java.util.List<java.lang.String>)
// .defaultTimeZone(java.lang.String)
// .deletionProtection(java.lang.Boolean|IResolvable)
// .enableDropProtection(java.lang.Boolean|IResolvable)
// .encryptionConfig(GoogleSpannerDatabaseEncryptionConfig)
// .id(java.lang.String)
// .project(java.lang.String)
// .timeouts(GoogleSpannerDatabaseTimeouts)
// .versionRetentionPeriod(java.lang.String)
.build();| Name | Type | Description |
|---|---|---|
connection |
com.hashicorp.cdktf.SSHProvisionerConnection|com.hashicorp.cdktf.WinrmProvisionerConnection |
No description. |
count |
java.lang.Number|com.hashicorp.cdktf.TerraformCount |
No description. |
dependsOn |
java.util.List<com.hashicorp.cdktf.ITerraformDependable> |
No description. |
forEach |
com.hashicorp.cdktf.ITerraformIterator |
No description. |
lifecycle |
com.hashicorp.cdktf.TerraformResourceLifecycle |
No description. |
provider |
com.hashicorp.cdktf.TerraformProvider |
No description. |
provisioners |
java.util.List<com.hashicorp.cdktf.FileProvisioner|com.hashicorp.cdktf.LocalExecProvisioner|com.hashicorp.cdktf.RemoteExecProvisioner> |
No description. |
instance |
java.lang.String |
The instance to create the database on. |
name |
java.lang.String |
A unique identifier for the database, which cannot be changed after the instance is created. |
databaseDialect |
java.lang.String |
The dialect of the Cloud Spanner Database. If it is not provided, "GOOGLE_STANDARD_SQL" will be used. Possible values: ["GOOGLE_STANDARD_SQL", "POSTGRESQL"]. |
ddl |
java.util.List<java.lang.String> |
An optional list of DDL statements to run inside the database. Statements can create tables, indexes, etc. |
defaultTimeZone |
java.lang.String |
The default time zone for the database. |
deletionProtection |
java.lang.Boolean|com.hashicorp.cdktf.IResolvable |
Whether Terraform will be prevented from destroying the database. |
enableDropProtection |
java.lang.Boolean|com.hashicorp.cdktf.IResolvable |
Whether drop protection is enabled for this database. |
encryptionConfig |
GoogleSpannerDatabaseEncryptionConfig |
encryption_config block. |
id |
java.lang.String |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.50.0/docs/resources/google_spanner_database#id GoogleSpannerDatabase#id}. |
project |
java.lang.String |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.50.0/docs/resources/google_spanner_database#project GoogleSpannerDatabase#project}. |
timeouts |
GoogleSpannerDatabaseTimeouts |
timeouts block. |
versionRetentionPeriod |
java.lang.String |
The retention period for the database. |
public SSHProvisionerConnection|WinrmProvisionerConnection getConnection();- Type: com.hashicorp.cdktf.SSHProvisionerConnection|com.hashicorp.cdktf.WinrmProvisionerConnection
public java.lang.Number|TerraformCount getCount();- Type: java.lang.Number|com.hashicorp.cdktf.TerraformCount
public java.util.List<ITerraformDependable> getDependsOn();- Type: java.util.List<com.hashicorp.cdktf.ITerraformDependable>
public ITerraformIterator getForEach();- Type: com.hashicorp.cdktf.ITerraformIterator
public TerraformResourceLifecycle getLifecycle();- Type: com.hashicorp.cdktf.TerraformResourceLifecycle
public TerraformProvider getProvider();- Type: com.hashicorp.cdktf.TerraformProvider
public java.util.List<FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner> getProvisioners();- Type: java.util.List<com.hashicorp.cdktf.FileProvisioner|com.hashicorp.cdktf.LocalExecProvisioner|com.hashicorp.cdktf.RemoteExecProvisioner>
public java.lang.String getInstance();- Type: java.lang.String
The instance to create the database on.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.50.0/docs/resources/google_spanner_database#instance GoogleSpannerDatabase#instance}
public java.lang.String getName();- Type: java.lang.String
A unique identifier for the database, which cannot be changed after the instance is created.
Values are of the form '[a-z][-_a-z0-9]*[a-z0-9]'.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.50.0/docs/resources/google_spanner_database#name GoogleSpannerDatabase#name}
public java.lang.String getDatabaseDialect();- Type: java.lang.String
The dialect of the Cloud Spanner Database. If it is not provided, "GOOGLE_STANDARD_SQL" will be used. Possible values: ["GOOGLE_STANDARD_SQL", "POSTGRESQL"].
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.50.0/docs/resources/google_spanner_database#database_dialect GoogleSpannerDatabase#database_dialect}
public java.util.List<java.lang.String> getDdl();- Type: java.util.List<java.lang.String>
An optional list of DDL statements to run inside the database. Statements can create tables, indexes, etc.
During creation these statements execute atomically with the creation of the database and if there is an error in any statement, the database is not created.
Terraform does not perform drift detection on this field and assumes that the values recorded in state are accurate. Limited updates to this field are supported, and newly appended DDL statements can be executed in an update. However, modifications to prior statements will create a plan that marks the resource for recreation.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.50.0/docs/resources/google_spanner_database#ddl GoogleSpannerDatabase#ddl}
public java.lang.String getDefaultTimeZone();- Type: java.lang.String
The default time zone for the database.
The default time zone must be a valid name from the tz database. Default value is "America/Los_angeles".
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.50.0/docs/resources/google_spanner_database#default_time_zone GoogleSpannerDatabase#default_time_zone}
public java.lang.Boolean|IResolvable getDeletionProtection();- Type: java.lang.Boolean|com.hashicorp.cdktf.IResolvable
Whether Terraform will be prevented from destroying the database.
Defaults to true. When a'terraform destroy' or 'terraform apply' would delete the database, the command will fail if this field is not set to false in Terraform state. When the field is set to true or unset in Terraform state, a 'terraform apply' or 'terraform destroy' that would delete the database will fail. When the field is set to false, deleting the database is allowed.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.50.0/docs/resources/google_spanner_database#deletion_protection GoogleSpannerDatabase#deletion_protection}
public java.lang.Boolean|IResolvable getEnableDropProtection();- Type: java.lang.Boolean|com.hashicorp.cdktf.IResolvable
Whether drop protection is enabled for this database.
Defaults to false. Drop protection is different from the "deletion_protection" attribute in the following ways: (1) "deletion_protection" only protects the database from deletions in Terraform. whereas setting “enableDropProtection” to true protects the database from deletions in all interfaces. (2) Setting "enableDropProtection" to true also prevents the deletion of the parent instance containing the database. "deletion_protection" attribute does not provide protection against the deletion of the parent instance.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.50.0/docs/resources/google_spanner_database#enable_drop_protection GoogleSpannerDatabase#enable_drop_protection}
public GoogleSpannerDatabaseEncryptionConfig getEncryptionConfig();encryption_config block.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.50.0/docs/resources/google_spanner_database#encryption_config GoogleSpannerDatabase#encryption_config}
public java.lang.String getId();- Type: java.lang.String
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.50.0/docs/resources/google_spanner_database#id GoogleSpannerDatabase#id}.
Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.
public java.lang.String getProject();- Type: java.lang.String
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.50.0/docs/resources/google_spanner_database#project GoogleSpannerDatabase#project}.
public GoogleSpannerDatabaseTimeouts getTimeouts();timeouts block.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.50.0/docs/resources/google_spanner_database#timeouts GoogleSpannerDatabase#timeouts}
public java.lang.String getVersionRetentionPeriod();- Type: java.lang.String
The retention period for the database.
The retention period must be between 1 hour and 7 days, and can be specified in days, hours, minutes, or seconds. For example, the values 1d, 24h, 1440m, and 86400s are equivalent. Default value is 1h. If this property is used, you must avoid adding new DDL statements to 'ddl' that update the database's version_retention_period.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.50.0/docs/resources/google_spanner_database#version_retention_period GoogleSpannerDatabase#version_retention_period}
import com.hashicorp.cdktf.providers.google_beta.google_spanner_database.GoogleSpannerDatabaseEncryptionConfig;
GoogleSpannerDatabaseEncryptionConfig.builder()
// .kmsKeyName(java.lang.String)
// .kmsKeyNames(java.util.List<java.lang.String>)
.build();| Name | Type | Description |
|---|---|---|
kmsKeyName |
java.lang.String |
Fully qualified name of the KMS key to use to encrypt this database. |
kmsKeyNames |
java.util.List<java.lang.String> |
Fully qualified name of the KMS keys to use to encrypt this database. |
public java.lang.String getKmsKeyName();- Type: java.lang.String
Fully qualified name of the KMS key to use to encrypt this database.
This key must exist in the same location as the Spanner Database.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.50.0/docs/resources/google_spanner_database#kms_key_name GoogleSpannerDatabase#kms_key_name}
public java.util.List<java.lang.String> getKmsKeyNames();- Type: java.util.List<java.lang.String>
Fully qualified name of the KMS keys to use to encrypt this database.
The keys must exist in the same locations as the Spanner Database.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.50.0/docs/resources/google_spanner_database#kms_key_names GoogleSpannerDatabase#kms_key_names}
import com.hashicorp.cdktf.providers.google_beta.google_spanner_database.GoogleSpannerDatabaseTimeouts;
GoogleSpannerDatabaseTimeouts.builder()
// .create(java.lang.String)
// .delete(java.lang.String)
// .update(java.lang.String)
.build();| Name | Type | Description |
|---|---|---|
create |
java.lang.String |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.50.0/docs/resources/google_spanner_database#create GoogleSpannerDatabase#create}. |
delete |
java.lang.String |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.50.0/docs/resources/google_spanner_database#delete GoogleSpannerDatabase#delete}. |
update |
java.lang.String |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.50.0/docs/resources/google_spanner_database#update GoogleSpannerDatabase#update}. |
public java.lang.String getCreate();- Type: java.lang.String
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.50.0/docs/resources/google_spanner_database#create GoogleSpannerDatabase#create}.
public java.lang.String getDelete();- Type: java.lang.String
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.50.0/docs/resources/google_spanner_database#delete GoogleSpannerDatabase#delete}.
public java.lang.String getUpdate();- Type: java.lang.String
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.50.0/docs/resources/google_spanner_database#update GoogleSpannerDatabase#update}.
import com.hashicorp.cdktf.providers.google_beta.google_spanner_database.GoogleSpannerDatabaseEncryptionConfigOutputReference;
new GoogleSpannerDatabaseEncryptionConfigOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute);| Name | Type | Description |
|---|---|---|
terraformResource |
com.hashicorp.cdktf.IInterpolatingParent |
The parent resource. |
terraformAttribute |
java.lang.String |
The attribute on the parent resource this class is referencing. |
- Type: com.hashicorp.cdktf.IInterpolatingParent
The parent resource.
- Type: java.lang.String
The attribute on the parent resource this class is referencing.
| Name | Description |
|---|---|
computeFqn |
No description. |
getAnyMapAttribute |
No description. |
getBooleanAttribute |
No description. |
getBooleanMapAttribute |
No description. |
getListAttribute |
No description. |
getNumberAttribute |
No description. |
getNumberListAttribute |
No description. |
getNumberMapAttribute |
No description. |
getStringAttribute |
No description. |
getStringMapAttribute |
No description. |
interpolationForAttribute |
No description. |
resolve |
Produce the Token's value at resolution time. |
toString |
Return a string representation of this resolvable object. |
resetKmsKeyName |
No description. |
resetKmsKeyNames |
No description. |
public java.lang.String computeFqn()public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)- Type: java.lang.String
public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)- Type: java.lang.String
public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)- Type: java.lang.String
public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)- Type: java.lang.String
public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)- Type: java.lang.String
public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)- Type: java.lang.String
public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)- Type: java.lang.String
public java.lang.String getStringAttribute(java.lang.String terraformAttribute)- Type: java.lang.String
public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)- Type: java.lang.String
public IResolvable interpolationForAttribute(java.lang.String property)- Type: java.lang.String
public java.lang.Object resolve(IResolveContext _context)Produce the Token's value at resolution time.
- Type: com.hashicorp.cdktf.IResolveContext
public java.lang.String toString()Return a string representation of this resolvable object.
Returns a reversible string representation.
public void resetKmsKeyName()public void resetKmsKeyNames()| Name | Type | Description |
|---|---|---|
creationStack |
java.util.List<java.lang.String> |
The creation stack of this resolvable which will be appended to errors thrown during resolution. |
fqn |
java.lang.String |
No description. |
kmsKeyNameInput |
java.lang.String |
No description. |
kmsKeyNamesInput |
java.util.List<java.lang.String> |
No description. |
kmsKeyName |
java.lang.String |
No description. |
kmsKeyNames |
java.util.List<java.lang.String> |
No description. |
internalValue |
GoogleSpannerDatabaseEncryptionConfig |
No description. |
public java.util.List<java.lang.String> getCreationStack();- Type: java.util.List<java.lang.String>
The creation stack of this resolvable which will be appended to errors thrown during resolution.
If this returns an empty array the stack will not be attached.
public java.lang.String getFqn();- Type: java.lang.String
public java.lang.String getKmsKeyNameInput();- Type: java.lang.String
public java.util.List<java.lang.String> getKmsKeyNamesInput();- Type: java.util.List<java.lang.String>
public java.lang.String getKmsKeyName();- Type: java.lang.String
public java.util.List<java.lang.String> getKmsKeyNames();- Type: java.util.List<java.lang.String>
public GoogleSpannerDatabaseEncryptionConfig getInternalValue();import com.hashicorp.cdktf.providers.google_beta.google_spanner_database.GoogleSpannerDatabaseTimeoutsOutputReference;
new GoogleSpannerDatabaseTimeoutsOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute);| Name | Type | Description |
|---|---|---|
terraformResource |
com.hashicorp.cdktf.IInterpolatingParent |
The parent resource. |
terraformAttribute |
java.lang.String |
The attribute on the parent resource this class is referencing. |
- Type: com.hashicorp.cdktf.IInterpolatingParent
The parent resource.
- Type: java.lang.String
The attribute on the parent resource this class is referencing.
| Name | Description |
|---|---|
computeFqn |
No description. |
getAnyMapAttribute |
No description. |
getBooleanAttribute |
No description. |
getBooleanMapAttribute |
No description. |
getListAttribute |
No description. |
getNumberAttribute |
No description. |
getNumberListAttribute |
No description. |
getNumberMapAttribute |
No description. |
getStringAttribute |
No description. |
getStringMapAttribute |
No description. |
interpolationForAttribute |
No description. |
resolve |
Produce the Token's value at resolution time. |
toString |
Return a string representation of this resolvable object. |
resetCreate |
No description. |
resetDelete |
No description. |
resetUpdate |
No description. |
public java.lang.String computeFqn()public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)- Type: java.lang.String
public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)- Type: java.lang.String
public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)- Type: java.lang.String
public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)- Type: java.lang.String
public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)- Type: java.lang.String
public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)- Type: java.lang.String
public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)- Type: java.lang.String
public java.lang.String getStringAttribute(java.lang.String terraformAttribute)- Type: java.lang.String
public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)- Type: java.lang.String
public IResolvable interpolationForAttribute(java.lang.String property)- Type: java.lang.String
public java.lang.Object resolve(IResolveContext _context)Produce the Token's value at resolution time.
- Type: com.hashicorp.cdktf.IResolveContext
public java.lang.String toString()Return a string representation of this resolvable object.
Returns a reversible string representation.
public void resetCreate()public void resetDelete()public void resetUpdate()| Name | Type | Description |
|---|---|---|
creationStack |
java.util.List<java.lang.String> |
The creation stack of this resolvable which will be appended to errors thrown during resolution. |
fqn |
java.lang.String |
No description. |
createInput |
java.lang.String |
No description. |
deleteInput |
java.lang.String |
No description. |
updateInput |
java.lang.String |
No description. |
create |
java.lang.String |
No description. |
delete |
java.lang.String |
No description. |
update |
java.lang.String |
No description. |
internalValue |
com.hashicorp.cdktf.IResolvable|GoogleSpannerDatabaseTimeouts |
No description. |
public java.util.List<java.lang.String> getCreationStack();- Type: java.util.List<java.lang.String>
The creation stack of this resolvable which will be appended to errors thrown during resolution.
If this returns an empty array the stack will not be attached.
public java.lang.String getFqn();- Type: java.lang.String
public java.lang.String getCreateInput();- Type: java.lang.String
public java.lang.String getDeleteInput();- Type: java.lang.String
public java.lang.String getUpdateInput();- Type: java.lang.String
public java.lang.String getCreate();- Type: java.lang.String
public java.lang.String getDelete();- Type: java.lang.String
public java.lang.String getUpdate();- Type: java.lang.String
public IResolvable|GoogleSpannerDatabaseTimeouts getInternalValue();- Type: com.hashicorp.cdktf.IResolvable|GoogleSpannerDatabaseTimeouts