spannerDatabase.typescript.md

spannerDatabase Submodule

Constructs

SpannerDatabase

Represents a {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/spanner_database google_spanner_database}.

Initializers

import { spannerDatabase } from '@cdktf/provider-google'

new spannerDatabase.SpannerDatabase(scope: Construct, id: string, config: SpannerDatabaseConfig)

Name	Type	Description
scope	constructs.Construct	The scope in which to define this construct.
id	string	The scoped construct ID.
config	SpannerDatabaseConfig	No description.

---

scope^Required

• Type: constructs.Construct

The scope in which to define this construct.

---

id^Required

• Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

---

config^Required

• Type: SpannerDatabaseConfig

---

Methods

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.

---

toString

public toString(): string

Returns a string representation of this construct.

addOverride

public addOverride(path: string, value: any): void

path^Required

• Type: string

---

value^Required

• Type: any

---

overrideLogicalId

public overrideLogicalId(newLogicalId: string): void

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

newLogicalId^Required

• Type: string

The new logical ID to use for this stack element.

---

resetOverrideLogicalId

public resetOverrideLogicalId(): void

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

toHclTerraform

public toHclTerraform(): any

toMetadata

public toMetadata(): any

toTerraform

public toTerraform(): any

Adds this resource to the terraform JSON output.

addMoveTarget

public addMoveTarget(moveTarget: string): void

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

moveTarget^Required

• Type: string

The string move target that will correspond to this resource.

---

getAnyMapAttribute

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

terraformAttribute^Required

• Type: string

---

getBooleanAttribute

public getBooleanAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

getBooleanMapAttribute

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

terraformAttribute^Required

• Type: string

---

getListAttribute

public getListAttribute(terraformAttribute: string): string[]

terraformAttribute^Required

• Type: string

---

getNumberAttribute

public getNumberAttribute(terraformAttribute: string): number

terraformAttribute^Required

• Type: string

---

getNumberListAttribute

public getNumberListAttribute(terraformAttribute: string): number[]

terraformAttribute^Required

• Type: string

---

getNumberMapAttribute

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

terraformAttribute^Required

• Type: string

---

getStringAttribute

public getStringAttribute(terraformAttribute: string): string

terraformAttribute^Required

• Type: string

---

getStringMapAttribute

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

terraformAttribute^Required

• Type: string

---

hasResourceMove

public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById

importFrom

public importFrom(id: string, provider?: TerraformProvider): void

id^Required

• Type: string

---

provider^Optional

• Type: cdktf.TerraformProvider

---

interpolationForAttribute

public interpolationForAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

moveFromId

public moveFromId(id: string): void

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.

id^Required

• Type: string

Full id of resource being moved from, e.g. "aws_s3_bucket.example".

---

moveTo

public moveTo(moveTarget: string, index?: string | number): void

Moves this resource to the target resource given by moveTarget.

moveTarget^Required

• Type: string

The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.

---

index^Optional

• Type: string | number

Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.

---

moveToId

public moveToId(id: string): void

Moves this resource to the resource corresponding to "id".

id^Required

• Type: string

Full id of resource to move to, e.g. "aws_s3_bucket.example".

---

putEncryptionConfig

public putEncryptionConfig(value: SpannerDatabaseEncryptionConfig): void

value^Required

• Type: SpannerDatabaseEncryptionConfig

---

putTimeouts

public putTimeouts(value: SpannerDatabaseTimeouts): void

value^Required

• Type: SpannerDatabaseTimeouts

---

resetDatabaseDialect

public resetDatabaseDialect(): void

resetDdl

public resetDdl(): void

resetDefaultTimeZone

public resetDefaultTimeZone(): void

resetDeletionProtection

public resetDeletionProtection(): void

resetEnableDropProtection

public resetEnableDropProtection(): void

resetEncryptionConfig

public resetEncryptionConfig(): void

resetId

public resetId(): void

resetProject

public resetProject(): void

resetTimeouts

public resetTimeouts(): void

resetVersionRetentionPeriod

public resetVersionRetentionPeriod(): void

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isTerraformElement	No description.
isTerraformResource	No description.
generateConfigForImport	Generates CDKTF code for importing a SpannerDatabase resource upon running "cdktf plan ".

---

isConstruct

import { spannerDatabase } from '@cdktf/provider-google'

spannerDatabase.SpannerDatabase.isConstruct(x: any)

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: any

Any object.

---

isTerraformElement

import { spannerDatabase } from '@cdktf/provider-google'

spannerDatabase.SpannerDatabase.isTerraformElement(x: any)

x^Required

• Type: any

---

isTerraformResource

import { spannerDatabase } from '@cdktf/provider-google'

spannerDatabase.SpannerDatabase.isTerraformResource(x: any)

x^Required

• Type: any

---

generateConfigForImport

import { spannerDatabase } from '@cdktf/provider-google'

spannerDatabase.SpannerDatabase.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

Generates CDKTF code for importing a SpannerDatabase resource upon running "cdktf plan ".

scope^Required

• Type: constructs.Construct

The scope in which to define this construct.

---

importToId^Required

• Type: string

The construct id used in the generated config for the SpannerDatabase to import.

---

importFromId^Required

• Type: string

The id of the existing SpannerDatabase that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/spanner_database#import import section} in the documentation of this resource for the id to use

---

provider^Optional

• Type: cdktf.TerraformProvider

? Optional instance of the provider where the SpannerDatabase to import is found.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
cdktfStack	cdktf.TerraformStack	No description.
fqn	string	No description.
friendlyUniqueId	string	No description.
terraformMetaArguments	{[ key: string ]: any}	No description.
terraformResourceType	string	No description.
terraformGeneratorMetadata	cdktf.TerraformProviderGeneratorMetadata	No description.
connection	cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection	No description.
count	number | cdktf.TerraformCount	No description.
dependsOn	string[]	No description.
forEach	cdktf.ITerraformIterator	No description.
lifecycle	cdktf.TerraformResourceLifecycle	No description.
provider	cdktf.TerraformProvider	No description.
provisioners	cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]	No description.
encryptionConfig	SpannerDatabaseEncryptionConfigOutputReference	No description.
state	string	No description.
timeouts	SpannerDatabaseTimeoutsOutputReference	No description.
databaseDialectInput	string	No description.
ddlInput	string[]	No description.
defaultTimeZoneInput	string	No description.
deletionProtectionInput	boolean | cdktf.IResolvable	No description.
enableDropProtectionInput	boolean | cdktf.IResolvable	No description.
encryptionConfigInput	SpannerDatabaseEncryptionConfig	No description.
idInput	string	No description.
instanceInput	string	No description.
nameInput	string	No description.
projectInput	string	No description.
timeoutsInput	cdktf.IResolvable | SpannerDatabaseTimeouts	No description.
versionRetentionPeriodInput	string	No description.
databaseDialect	string	No description.
ddl	string[]	No description.
defaultTimeZone	string	No description.
deletionProtection	boolean | cdktf.IResolvable	No description.
enableDropProtection	boolean | cdktf.IResolvable	No description.
id	string	No description.
instance	string	No description.
name	string	No description.
project	string	No description.
versionRetentionPeriod	string	No description.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

cdktfStack^Required

public readonly cdktfStack: TerraformStack;

• Type: cdktf.TerraformStack

---

fqn^Required

public readonly fqn: string;

• Type: string

---

friendlyUniqueId^Required

public readonly friendlyUniqueId: string;

• Type: string

---

terraformMetaArguments^Required

public readonly terraformMetaArguments: {[ key: string ]: any};

• Type: {[ key: string ]: any}

---

terraformResourceType^Required

public readonly terraformResourceType: string;

• Type: string

---

terraformGeneratorMetadata^Optional

public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;

• Type: cdktf.TerraformProviderGeneratorMetadata

---

connection^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

• Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

---

count^Optional

public readonly count: number | TerraformCount;

• Type: number | cdktf.TerraformCount

---

dependsOn^Optional

public readonly dependsOn: string[];

• Type: string[]

---

forEach^Optional

public readonly forEach: ITerraformIterator;

• Type: cdktf.ITerraformIterator

---

lifecycle^Optional

public readonly lifecycle: TerraformResourceLifecycle;

• Type: cdktf.TerraformResourceLifecycle

---

provider^Optional

public readonly provider: TerraformProvider;

• Type: cdktf.TerraformProvider

---

provisioners^Optional

public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];

• Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

---

encryptionConfig^Required

public readonly encryptionConfig: SpannerDatabaseEncryptionConfigOutputReference;

• Type: SpannerDatabaseEncryptionConfigOutputReference

---

state^Required

public readonly state: string;

• Type: string

---

timeouts^Required

public readonly timeouts: SpannerDatabaseTimeoutsOutputReference;

• Type: SpannerDatabaseTimeoutsOutputReference

---

databaseDialectInput^Optional

public readonly databaseDialectInput: string;

• Type: string

---

ddlInput^Optional

public readonly ddlInput: string[];

• Type: string[]

---

defaultTimeZoneInput^Optional

public readonly defaultTimeZoneInput: string;

• Type: string

---

deletionProtectionInput^Optional

public readonly deletionProtectionInput: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

enableDropProtectionInput^Optional

public readonly enableDropProtectionInput: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

encryptionConfigInput^Optional

public readonly encryptionConfigInput: SpannerDatabaseEncryptionConfig;

• Type: SpannerDatabaseEncryptionConfig

---

idInput^Optional

public readonly idInput: string;

• Type: string

---

instanceInput^Optional

public readonly instanceInput: string;

• Type: string

---

nameInput^Optional

public readonly nameInput: string;

• Type: string

---

projectInput^Optional

public readonly projectInput: string;

• Type: string

---

timeoutsInput^Optional

public readonly timeoutsInput: IResolvable | SpannerDatabaseTimeouts;

• Type: cdktf.IResolvable | SpannerDatabaseTimeouts

---

versionRetentionPeriodInput^Optional

public readonly versionRetentionPeriodInput: string;

• Type: string

---

databaseDialect^Required

public readonly databaseDialect: string;

• Type: string

---

ddl^Required

public readonly ddl: string[];

• Type: string[]

---

defaultTimeZone^Required

public readonly defaultTimeZone: string;

• Type: string

---

deletionProtection^Required

public readonly deletionProtection: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

enableDropProtection^Required

public readonly enableDropProtection: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

id^Required

public readonly id: string;

• Type: string

---

instance^Required

public readonly instance: string;

• Type: string

---

name^Required

public readonly name: string;

• Type: string

---

project^Required

public readonly project: string;

• Type: string

---

versionRetentionPeriod^Required

public readonly versionRetentionPeriod: string;

• Type: string

---

Constants

Name	Type	Description
tfResourceType	string	No description.

---

tfResourceType^Required

public readonly tfResourceType: string;

• Type: string

---

Structs

SpannerDatabaseConfig

Initializer

import { spannerDatabase } from '@cdktf/provider-google'

const spannerDatabaseConfig: spannerDatabase.SpannerDatabaseConfig = { ... }

Properties

Name	Type	Description
connection	cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection	No description.
count	number | cdktf.TerraformCount	No description.
dependsOn	cdktf.ITerraformDependable[]	No description.
forEach	cdktf.ITerraformIterator	No description.
lifecycle	cdktf.TerraformResourceLifecycle	No description.
provider	cdktf.TerraformProvider	No description.
provisioners	cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]	No description.
instance	string	The instance to create the database on.
name	string	A unique identifier for the database, which cannot be changed after the instance is created.
databaseDialect	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	string[]	An optional list of DDL statements to run inside the database. Statements can create tables, indexes, etc.
defaultTimeZone	string	The default time zone for the database.
deletionProtection	boolean | cdktf.IResolvable	Whether Terraform will be prevented from destroying the database.
enableDropProtection	boolean | cdktf.IResolvable	Whether drop protection is enabled for this database.
encryptionConfig	SpannerDatabaseEncryptionConfig	encryption_config block.
id	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/spanner_database#id SpannerDatabase#id}.
project	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/spanner_database#project SpannerDatabase#project}.
timeouts	SpannerDatabaseTimeouts	timeouts block.
versionRetentionPeriod	string	The retention period for the database.

---

connection^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

• Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

---

count^Optional

public readonly count: number | TerraformCount;

• Type: number | cdktf.TerraformCount

---

dependsOn^Optional

public readonly dependsOn: ITerraformDependable[];

• Type: cdktf.ITerraformDependable[]

---

forEach^Optional

public readonly forEach: ITerraformIterator;

• Type: cdktf.ITerraformIterator

---

lifecycle^Optional

public readonly lifecycle: TerraformResourceLifecycle;

• Type: cdktf.TerraformResourceLifecycle

---

provider^Optional

public readonly provider: TerraformProvider;

• Type: cdktf.TerraformProvider

---

provisioners^Optional

public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];

• Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

---

instance^Required

public readonly instance: string;

• Type: string

The instance to create the database on.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/spanner_database#instance SpannerDatabase#instance}

---

name^Required

public readonly name: string;

• Type: 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/6.37.0/docs/resources/spanner_database#name SpannerDatabase#name}

---

databaseDialect^Optional

public readonly databaseDialect: string;

• Type: 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/6.37.0/docs/resources/spanner_database#database_dialect SpannerDatabase#database_dialect}

---

ddl^Optional

public readonly ddl: string[];

• Type: 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/6.37.0/docs/resources/spanner_database#ddl SpannerDatabase#ddl}

---

defaultTimeZone^Optional

public readonly defaultTimeZone: string;

• Type: 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/6.37.0/docs/resources/spanner_database#default_time_zone SpannerDatabase#default_time_zone}

---

deletionProtection^Optional

public readonly deletionProtection: boolean | IResolvable;

• Type: boolean | 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/6.37.0/docs/resources/spanner_database#deletion_protection SpannerDatabase#deletion_protection}

---

enableDropProtection^Optional

public readonly enableDropProtection: boolean | IResolvable;

• Type: boolean | 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/6.37.0/docs/resources/spanner_database#enable_drop_protection SpannerDatabase#enable_drop_protection}

---

encryptionConfig^Optional

public readonly encryptionConfig: SpannerDatabaseEncryptionConfig;

• Type: SpannerDatabaseEncryptionConfig

encryption_config block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/spanner_database#encryption_config SpannerDatabase#encryption_config}

---

id^Optional

public readonly id: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/spanner_database#id SpannerDatabase#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.

---

project^Optional

public readonly project: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/spanner_database#project SpannerDatabase#project}.

---

timeouts^Optional

public readonly timeouts: SpannerDatabaseTimeouts;

• Type: SpannerDatabaseTimeouts

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/spanner_database#timeouts SpannerDatabase#timeouts}

---

versionRetentionPeriod^Optional

public readonly versionRetentionPeriod: string;

• Type: 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/6.37.0/docs/resources/spanner_database#version_retention_period SpannerDatabase#version_retention_period}

---

SpannerDatabaseEncryptionConfig

Initializer

import { spannerDatabase } from '@cdktf/provider-google'

const spannerDatabaseEncryptionConfig: spannerDatabase.SpannerDatabaseEncryptionConfig = { ... }

Properties

Name	Type	Description
kmsKeyName	string	Fully qualified name of the KMS key to use to encrypt this database.
kmsKeyNames	string[]	Fully qualified name of the KMS keys to use to encrypt this database.

---

kmsKeyName^Optional

public readonly kmsKeyName: string;

• Type: 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/6.37.0/docs/resources/spanner_database#kms_key_name SpannerDatabase#kms_key_name}

---

kmsKeyNames^Optional

public readonly kmsKeyNames: string[];

• Type: 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/6.37.0/docs/resources/spanner_database#kms_key_names SpannerDatabase#kms_key_names}

---

SpannerDatabaseTimeouts

Initializer

import { spannerDatabase } from '@cdktf/provider-google'

const spannerDatabaseTimeouts: spannerDatabase.SpannerDatabaseTimeouts = { ... }

Properties

Name	Type	Description
create	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/spanner_database#create SpannerDatabase#create}.
delete	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/spanner_database#delete SpannerDatabase#delete}.
update	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/spanner_database#update SpannerDatabase#update}.

---

create^Optional

public readonly create: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/spanner_database#create SpannerDatabase#create}.

---

delete^Optional

public readonly delete: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/spanner_database#delete SpannerDatabase#delete}.

---

update^Optional

public readonly update: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/spanner_database#update SpannerDatabase#update}.

---

Classes

SpannerDatabaseEncryptionConfigOutputReference

Initializers

import { spannerDatabase } from '@cdktf/provider-google'

new spannerDatabase.SpannerDatabaseEncryptionConfigOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)

Name	Type	Description
terraformResource	cdktf.IInterpolatingParent	The parent resource.
terraformAttribute	string	The attribute on the parent resource this class is referencing.

---

terraformResource^Required

• Type: cdktf.IInterpolatingParent

The parent resource.

---

terraformAttribute^Required

• Type: string

The attribute on the parent resource this class is referencing.

---

Methods

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.

---

computeFqn

public computeFqn(): string

getAnyMapAttribute

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

terraformAttribute^Required

• Type: string

---

getBooleanAttribute

public getBooleanAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

getBooleanMapAttribute

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

terraformAttribute^Required

• Type: string

---

getListAttribute

public getListAttribute(terraformAttribute: string): string[]

terraformAttribute^Required

• Type: string

---

getNumberAttribute

public getNumberAttribute(terraformAttribute: string): number

terraformAttribute^Required

• Type: string

---

getNumberListAttribute

public getNumberListAttribute(terraformAttribute: string): number[]

terraformAttribute^Required

• Type: string

---

getNumberMapAttribute

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

terraformAttribute^Required

• Type: string

---

getStringAttribute

public getStringAttribute(terraformAttribute: string): string

terraformAttribute^Required

• Type: string

---

getStringMapAttribute

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

terraformAttribute^Required

• Type: string

---

interpolationForAttribute

public interpolationForAttribute(property: string): IResolvable

property^Required

• Type: string

---

resolve

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_context^Required

• Type: cdktf.IResolveContext

---

toString

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetKmsKeyName

public resetKmsKeyName(): void

resetKmsKeyNames

public resetKmsKeyNames(): void

Properties

Name	Type	Description
creationStack	string[]	The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn	string	No description.
kmsKeyNameInput	string	No description.
kmsKeyNamesInput	string[]	No description.
kmsKeyName	string	No description.
kmsKeyNames	string[]	No description.
internalValue	SpannerDatabaseEncryptionConfig	No description.

---

creationStack^Required

public readonly creationStack: string[];

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

---

fqn^Required

public readonly fqn: string;

• Type: string

---

kmsKeyNameInput^Optional

public readonly kmsKeyNameInput: string;

• Type: string

---

kmsKeyNamesInput^Optional

public readonly kmsKeyNamesInput: string[];

• Type: string[]

---

kmsKeyName^Required

public readonly kmsKeyName: string;

• Type: string

---

kmsKeyNames^Required

public readonly kmsKeyNames: string[];

• Type: string[]

---

internalValue^Optional

public readonly internalValue: SpannerDatabaseEncryptionConfig;

• Type: SpannerDatabaseEncryptionConfig

---

SpannerDatabaseTimeoutsOutputReference

Initializers

import { spannerDatabase } from '@cdktf/provider-google'

new spannerDatabase.SpannerDatabaseTimeoutsOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)

Name	Type	Description
terraformResource	cdktf.IInterpolatingParent	The parent resource.
terraformAttribute	string	The attribute on the parent resource this class is referencing.

---

terraformResource^Required

• Type: cdktf.IInterpolatingParent

The parent resource.

---

terraformAttribute^Required

• Type: string

The attribute on the parent resource this class is referencing.

---

Methods

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.

---

computeFqn

public computeFqn(): string

getAnyMapAttribute

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

terraformAttribute^Required

• Type: string

---

getBooleanAttribute

public getBooleanAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

getBooleanMapAttribute

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

terraformAttribute^Required

• Type: string

---

getListAttribute

public getListAttribute(terraformAttribute: string): string[]

terraformAttribute^Required

• Type: string

---

getNumberAttribute

public getNumberAttribute(terraformAttribute: string): number

terraformAttribute^Required

• Type: string

---

getNumberListAttribute

public getNumberListAttribute(terraformAttribute: string): number[]

terraformAttribute^Required

• Type: string

---

getNumberMapAttribute

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

terraformAttribute^Required

• Type: string

---

getStringAttribute

public getStringAttribute(terraformAttribute: string): string

terraformAttribute^Required

• Type: string

---

getStringMapAttribute

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

terraformAttribute^Required

• Type: string

---

interpolationForAttribute

public interpolationForAttribute(property: string): IResolvable

property^Required

• Type: string

---

resolve

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_context^Required

• Type: cdktf.IResolveContext

---

toString

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetCreate

public resetCreate(): void

resetDelete

public resetDelete(): void

resetUpdate

public resetUpdate(): void

Properties

Name	Type	Description
creationStack	string[]	The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn	string	No description.
createInput	string	No description.
deleteInput	string	No description.
updateInput	string	No description.
create	string	No description.
delete	string	No description.
update	string	No description.
internalValue	cdktf.IResolvable | SpannerDatabaseTimeouts	No description.

---

creationStack^Required

public readonly creationStack: string[];

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

---

fqn^Required

public readonly fqn: string;

• Type: string

---

createInput^Optional

public readonly createInput: string;

• Type: string

---

deleteInput^Optional

public readonly deleteInput: string;

• Type: string

---

updateInput^Optional

public readonly updateInput: string;

• Type: string

---

create^Required

public readonly create: string;

• Type: string

---

delete^Required

public readonly delete: string;

• Type: string

---

update^Required

public readonly update: string;

• Type: string

---

internalValue^Optional

public readonly internalValue: IResolvable | SpannerDatabaseTimeouts;

• Type: cdktf.IResolvable | SpannerDatabaseTimeouts

---