`spannerDatabase` Submodule

Constructs

SpannerDatabase

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

Initializers

using Io.Cdktn.Providers.Google;

new SpannerDatabase(Construct Scope, string Id, SpannerDatabaseConfig Config);

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.
`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.
`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.
`ResetDeletionPolicy`	No description.
`ResetDeletionProtection`	No description.
`ResetEnableDropProtection`	No description.
`ResetEncryptionConfig`	No description.
`ResetId`	No description.
`ResetProject`	No description.
`ResetTimeouts`	No description.
`ResetVersionRetentionPeriod`	No description.

`ToString`

private string ToString()

Returns a string representation of this construct.

`With`

private IConstruct With(params 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: params Constructs.IMixin[]

The mixins to apply.

`AddOverride`

private void AddOverride(string Path, object Value)

`Path`^Required

Type: string

`Value`^Required

Type: object

`OverrideLogicalId`

private void OverrideLogicalId(string NewLogicalId)

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`

private void ResetOverrideLogicalId()

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

`ToHclTerraform`

private object ToHclTerraform()

`ToMetadata`

private object ToMetadata()

`ToTerraform`

private object ToTerraform()

Adds this resource to the terraform JSON output.

`AddMoveTarget`

private void AddMoveTarget(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.

`MoveTarget`^Required

Type: string

The string move target that will correspond to this resource.

`GetAnyMapAttribute`

private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetBooleanAttribute`

private IResolvable GetBooleanAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetBooleanMapAttribute`

private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetListAttribute`

private string[] GetListAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetNumberAttribute`

private double GetNumberAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetNumberListAttribute`

private double[] GetNumberListAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetNumberMapAttribute`

private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetStringAttribute`

private string GetStringAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetStringMapAttribute`

private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`HasResourceMove`

private TerraformResourceMoveByTarget|TerraformResourceMoveById HasResourceMove()

`ImportFrom`

private void ImportFrom(string Id, TerraformProvider Provider = null)

`Id`^Required

Type: string

`Provider`^Optional

Type: Io.Cdktn.TerraformProvider

`InterpolationForAttribute`

private IResolvable InterpolationForAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`MoveFromId`

private void MoveFromId(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.

`Id`^Required

Type: string

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

`MoveTo`

private void MoveTo(string MoveTarget, string|double Index = null)

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|double

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

`MoveToId`

private void MoveToId(string Id)

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`

private void PutEncryptionConfig(SpannerDatabaseEncryptionConfig Value)

`Value`^Required

Type: SpannerDatabaseEncryptionConfig

`PutTimeouts`

private void PutTimeouts(SpannerDatabaseTimeouts Value)

`Value`^Required

Type: SpannerDatabaseTimeouts

`ResetDatabaseDialect`

private void ResetDatabaseDialect()

`ResetDdl`

private void ResetDdl()

`ResetDefaultTimeZone`

private void ResetDefaultTimeZone()

`ResetDeletionPolicy`

private void ResetDeletionPolicy()

`ResetDeletionProtection`

private void ResetDeletionProtection()

`ResetEnableDropProtection`

private void ResetEnableDropProtection()

`ResetEncryptionConfig`

private void ResetEncryptionConfig()

`ResetId`

private void ResetId()

`ResetProject`

private void ResetProject()

`ResetTimeouts`

private void ResetTimeouts()

`ResetVersionRetentionPeriod`

private void ResetVersionRetentionPeriod()

Static Functions

Name	Description
`IsConstruct`	Checks if `x` is a construct.
`IsTerraformElement`	No description.
`IsTerraformResource`	No description.
`GenerateConfigForImport`	Generates CDKTN code for importing a SpannerDatabase resource upon running "cdktn plan ".

`IsConstruct`

using Io.Cdktn.Providers.Google;

SpannerDatabase.IsConstruct(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: object

Any object.

`IsTerraformElement`

using Io.Cdktn.Providers.Google;

SpannerDatabase.IsTerraformElement(object X);

`X`^Required

Type: object

`IsTerraformResource`

using Io.Cdktn.Providers.Google;

SpannerDatabase.IsTerraformResource(object X);

`X`^Required

Type: object

`GenerateConfigForImport`

using Io.Cdktn.Providers.Google;

SpannerDatabase.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null);

Generates CDKTN code for importing a SpannerDatabase resource upon running "cdktn 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/7.36.0/docs/resources/spanner_database#import import section} in the documentation of this resource for the id to use

`Provider`^Optional

Type: Io.Cdktn.TerraformProvider

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

Properties

Name	Type	Description
`Node`	`Constructs.Node`	The tree node.
`CdktfStack`	`Io.Cdktn.TerraformStack`	No description.
`Fqn`	`string`	No description.
`FriendlyUniqueId`	`string`	No description.
`TerraformMetaArguments`	`System.Collections.Generic.IDictionary<string, object>`	No description.
`TerraformResourceType`	`string`	No description.
`TerraformGeneratorMetadata`	`Io.Cdktn.TerraformProviderGeneratorMetadata`	No description.
`Connection`	`Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection`	No description.
`Count`	`double\|Io.Cdktn.TerraformCount`	No description.
`DependsOn`	`string[]`	No description.
`ForEach`	`Io.Cdktn.ITerraformIterator`	No description.
`Lifecycle`	`Io.Cdktn.TerraformResourceLifecycle`	No description.
`Provider`	`Io.Cdktn.TerraformProvider`	No description.
`Provisioners`	`Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.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.
`DeletionPolicyInput`	`string`	No description.
`DeletionProtectionInput`	`bool\|Io.Cdktn.IResolvable`	No description.
`EnableDropProtectionInput`	`bool\|Io.Cdktn.IResolvable`	No description.
`EncryptionConfigInput`	`SpannerDatabaseEncryptionConfig`	No description.
`IdInput`	`string`	No description.
`InstanceInput`	`string`	No description.
`NameInput`	`string`	No description.
`ProjectInput`	`string`	No description.
`TimeoutsInput`	`Io.Cdktn.IResolvable\|SpannerDatabaseTimeouts`	No description.
`VersionRetentionPeriodInput`	`string`	No description.
`DatabaseDialect`	`string`	No description.
`Ddl`	`string[]`	No description.
`DefaultTimeZone`	`string`	No description.
`DeletionPolicy`	`string`	No description.
`DeletionProtection`	`bool\|Io.Cdktn.IResolvable`	No description.
`EnableDropProtection`	`bool\|Io.Cdktn.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 Node Node { get; }

Type: Constructs.Node

The tree node.

`CdktfStack`^Required

public TerraformStack CdktfStack { get; }

Type: Io.Cdktn.TerraformStack

`Fqn`^Required

public string Fqn { get; }

Type: string

`FriendlyUniqueId`^Required

public string FriendlyUniqueId { get; }

Type: string

`TerraformMetaArguments`^Required

public System.Collections.Generic.IDictionary<string, object> TerraformMetaArguments { get; }

Type: System.Collections.Generic.IDictionary<string, object>

`TerraformResourceType`^Required

public string TerraformResourceType { get; }

Type: string

`TerraformGeneratorMetadata`^Optional

public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; }

Type: Io.Cdktn.TerraformProviderGeneratorMetadata

`Connection`^Optional

public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; }

Type: Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection

`Count`^Optional

public double|TerraformCount Count { get; }

Type: double|Io.Cdktn.TerraformCount

`DependsOn`^Optional

public string[] DependsOn { get; }

Type: string[]

`ForEach`^Optional

public ITerraformIterator ForEach { get; }

Type: Io.Cdktn.ITerraformIterator

`Lifecycle`^Optional

public TerraformResourceLifecycle Lifecycle { get; }

Type: Io.Cdktn.TerraformResourceLifecycle

`Provider`^Optional

public TerraformProvider Provider { get; }

Type: Io.Cdktn.TerraformProvider

`Provisioners`^Optional

public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; }

Type: Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[]

`EncryptionConfig`^Required

public SpannerDatabaseEncryptionConfigOutputReference EncryptionConfig { get; }

Type: SpannerDatabaseEncryptionConfigOutputReference

`State`^Required

public string State { get; }

Type: string

`Timeouts`^Required

public SpannerDatabaseTimeoutsOutputReference Timeouts { get; }

Type: SpannerDatabaseTimeoutsOutputReference

`DatabaseDialectInput`^Optional

public string DatabaseDialectInput { get; }

Type: string

`DdlInput`^Optional

public string[] DdlInput { get; }

Type: string[]

`DefaultTimeZoneInput`^Optional

public string DefaultTimeZoneInput { get; }

Type: string

`DeletionPolicyInput`^Optional

public string DeletionPolicyInput { get; }

Type: string

`DeletionProtectionInput`^Optional

public bool|IResolvable DeletionProtectionInput { get; }

Type: bool|Io.Cdktn.IResolvable

`EnableDropProtectionInput`^Optional

public bool|IResolvable EnableDropProtectionInput { get; }

Type: bool|Io.Cdktn.IResolvable

`EncryptionConfigInput`^Optional

public SpannerDatabaseEncryptionConfig EncryptionConfigInput { get; }

Type: SpannerDatabaseEncryptionConfig

`IdInput`^Optional

public string IdInput { get; }

Type: string

`InstanceInput`^Optional

public string InstanceInput { get; }

Type: string

`NameInput`^Optional

public string NameInput { get; }

Type: string

`ProjectInput`^Optional

public string ProjectInput { get; }

Type: string

`TimeoutsInput`^Optional

public IResolvable|SpannerDatabaseTimeouts TimeoutsInput { get; }

Type: Io.Cdktn.IResolvable|SpannerDatabaseTimeouts

`VersionRetentionPeriodInput`^Optional

public string VersionRetentionPeriodInput { get; }

Type: string

`DatabaseDialect`^Required

public string DatabaseDialect { get; }

Type: string

`Ddl`^Required

public string[] Ddl { get; }

Type: string[]

`DefaultTimeZone`^Required

public string DefaultTimeZone { get; }

Type: string

`DeletionPolicy`^Required

public string DeletionPolicy { get; }

Type: string

`DeletionProtection`^Required

public bool|IResolvable DeletionProtection { get; }

Type: bool|Io.Cdktn.IResolvable

`EnableDropProtection`^Required

public bool|IResolvable EnableDropProtection { get; }

Type: bool|Io.Cdktn.IResolvable

`Id`^Required

public string Id { get; }

Type: string

`Instance`^Required

public string Instance { get; }

Type: string

`Name`^Required

public string Name { get; }

Type: string

`Project`^Required

public string Project { get; }

Type: string

`VersionRetentionPeriod`^Required

public string VersionRetentionPeriod { get; }

Type: string

Constants

Name	Type	Description
`TfResourceType`	`string`	No description.

`TfResourceType`^Required

public string TfResourceType { get; }

Type: string

Structs

SpannerDatabaseConfig

Initializer

using Io.Cdktn.Providers.Google;

new SpannerDatabaseConfig {
    SSHProvisionerConnection|WinrmProvisionerConnection Connection = null,
    double|TerraformCount Count = null,
    ITerraformDependable[] DependsOn = null,
    ITerraformIterator ForEach = null,
    TerraformResourceLifecycle Lifecycle = null,
    TerraformProvider Provider = null,
    (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners = null,
    string Instance,
    string Name,
    string DatabaseDialect = null,
    string[] Ddl = null,
    string DefaultTimeZone = null,
    string DeletionPolicy = null,
    bool|IResolvable DeletionProtection = null,
    bool|IResolvable EnableDropProtection = null,
    SpannerDatabaseEncryptionConfig EncryptionConfig = null,
    string Id = null,
    string Project = null,
    SpannerDatabaseTimeouts Timeouts = null,
    string VersionRetentionPeriod = null
};

Properties

Name	Type	Description
`Connection`	`Io.Cdktn.SSHProvisionerConnection\|Io.Cdktn.WinrmProvisionerConnection`	No description.
`Count`	`double\|Io.Cdktn.TerraformCount`	No description.
`DependsOn`	`Io.Cdktn.ITerraformDependable[]`	No description.
`ForEach`	`Io.Cdktn.ITerraformIterator`	No description.
`Lifecycle`	`Io.Cdktn.TerraformResourceLifecycle`	No description.
`Provider`	`Io.Cdktn.TerraformProvider`	No description.
`Provisioners`	`Io.Cdktn.FileProvisioner\|Io.Cdktn.LocalExecProvisioner\|Io.Cdktn.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.
`DeletionPolicy`	`string`	Whether Terraform will be prevented from destroying the instance.
`DeletionProtection`	`bool\|Io.Cdktn.IResolvable`	Whether Terraform will be prevented from destroying the database.
`EnableDropProtection`	`bool\|Io.Cdktn.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/7.36.0/docs/resources/spanner_database#id SpannerDatabase#id}.
`Project`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.36.0/docs/resources/spanner_database#project SpannerDatabase#project}.
`Timeouts`	`SpannerDatabaseTimeouts`	timeouts block.
`VersionRetentionPeriod`	`string`	The retention period for the database.

`Connection`^Optional

public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; }

Type: Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection

`Count`^Optional

public double|TerraformCount Count { get; set; }

Type: double|Io.Cdktn.TerraformCount

`DependsOn`^Optional

public ITerraformDependable[] DependsOn { get; set; }

Type: Io.Cdktn.ITerraformDependable[]

`ForEach`^Optional

public ITerraformIterator ForEach { get; set; }

Type: Io.Cdktn.ITerraformIterator

`Lifecycle`^Optional

public TerraformResourceLifecycle Lifecycle { get; set; }

Type: Io.Cdktn.TerraformResourceLifecycle

`Provider`^Optional

public TerraformProvider Provider { get; set; }

Type: Io.Cdktn.TerraformProvider

`Provisioners`^Optional

public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; }

Type: Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[]

`Instance`^Required

public string Instance { get; set; }

Type: string

The instance to create the database on.

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

`Name`^Required

public string Name { get; set; }

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/7.36.0/docs/resources/spanner_database#name SpannerDatabase#name}

`DatabaseDialect`^Optional

public string DatabaseDialect { get; set; }

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/7.36.0/docs/resources/spanner_database#database_dialect SpannerDatabase#database_dialect}

`Ddl`^Optional

public string[] Ddl { get; set; }

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/7.36.0/docs/resources/spanner_database#ddl SpannerDatabase#ddl}

`DefaultTimeZone`^Optional

public string DefaultTimeZone { get; set; }

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/7.36.0/docs/resources/spanner_database#default_time_zone SpannerDatabase#default_time_zone}

`DeletionPolicy`^Optional

public string DeletionPolicy { get; set; }

Type: string

Whether Terraform will be prevented from destroying the instance.

Defaults to "DELETE". When a 'terraform destroy' or 'terraform apply' would delete the instance, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.

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

`DeletionProtection`^Optional

public bool|IResolvable DeletionProtection { get; set; }

Type: bool|Io.Cdktn.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/7.36.0/docs/resources/spanner_database#deletion_protection SpannerDatabase#deletion_protection}

`EnableDropProtection`^Optional

public bool|IResolvable EnableDropProtection { get; set; }

Type: bool|Io.Cdktn.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/7.36.0/docs/resources/spanner_database#enable_drop_protection SpannerDatabase#enable_drop_protection}

`EncryptionConfig`^Optional

public SpannerDatabaseEncryptionConfig EncryptionConfig { get; set; }

Type: SpannerDatabaseEncryptionConfig

encryption_config block.

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

`Id`^Optional

public string Id { get; set; }

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.36.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 string Project { get; set; }

Type: string

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

`Timeouts`^Optional

public SpannerDatabaseTimeouts Timeouts { get; set; }

Type: SpannerDatabaseTimeouts

timeouts block.

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

`VersionRetentionPeriod`^Optional

public string VersionRetentionPeriod { get; set; }

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/7.36.0/docs/resources/spanner_database#version_retention_period SpannerDatabase#version_retention_period}

SpannerDatabaseEncryptionConfig

Initializer

using Io.Cdktn.Providers.Google;

new SpannerDatabaseEncryptionConfig {
    string KmsKeyName = null,
    string[] KmsKeyNames = null
};

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 string KmsKeyName { get; set; }

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/7.36.0/docs/resources/spanner_database#kms_key_name SpannerDatabase#kms_key_name}

`KmsKeyNames`^Optional

public string[] KmsKeyNames { get; set; }

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/7.36.0/docs/resources/spanner_database#kms_key_names SpannerDatabase#kms_key_names}

SpannerDatabaseTimeouts

Initializer

using Io.Cdktn.Providers.Google;

new SpannerDatabaseTimeouts {
    string Create = null,
    string Delete = null,
    string Update = null
};

Properties

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

`Create`^Optional

public string Create { get; set; }

Type: string

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

`Delete`^Optional

public string Delete { get; set; }

Type: string

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

`Update`^Optional

public string Update { get; set; }

Type: string

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

Classes

SpannerDatabaseEncryptionConfigOutputReference

Initializers

using Io.Cdktn.Providers.Google;

new SpannerDatabaseEncryptionConfigOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute);

Name	Type	Description
`TerraformResource`	`Io.Cdktn.IInterpolatingParent`	The parent resource.
`TerraformAttribute`	`string`	The attribute on the parent resource this class is referencing.

`TerraformResource`^Required

Type: Io.Cdktn.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`

private string ComputeFqn()

`GetAnyMapAttribute`

private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetBooleanAttribute`

private IResolvable GetBooleanAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetBooleanMapAttribute`

private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetListAttribute`

private string[] GetListAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetNumberAttribute`

private double GetNumberAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetNumberListAttribute`

private double[] GetNumberListAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetNumberMapAttribute`

private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetStringAttribute`

private string GetStringAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetStringMapAttribute`

private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`InterpolationForAttribute`

private IResolvable InterpolationForAttribute(string Property)

`Property`^Required

Type: string

`Resolve`

private object Resolve(IResolveContext Context)

Produce the Token's value at resolution time.

`Context`^Required

Type: Io.Cdktn.IResolveContext

`ToString`

private string ToString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

`ResetKmsKeyName`

private void ResetKmsKeyName()

`ResetKmsKeyNames`

private void ResetKmsKeyNames()

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 string[] CreationStack { get; }

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 string Fqn { get; }

Type: string

`KmsKeyNameInput`^Optional

public string KmsKeyNameInput { get; }

Type: string

`KmsKeyNamesInput`^Optional

public string[] KmsKeyNamesInput { get; }

Type: string[]

`KmsKeyName`^Required

public string KmsKeyName { get; }

Type: string

`KmsKeyNames`^Required

public string[] KmsKeyNames { get; }

Type: string[]

`InternalValue`^Optional

public SpannerDatabaseEncryptionConfig InternalValue { get; }

Type: SpannerDatabaseEncryptionConfig

SpannerDatabaseTimeoutsOutputReference

Initializers

using Io.Cdktn.Providers.Google;

new SpannerDatabaseTimeoutsOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute);

Name	Type	Description
`TerraformResource`	`Io.Cdktn.IInterpolatingParent`	The parent resource.
`TerraformAttribute`	`string`	The attribute on the parent resource this class is referencing.

`TerraformResource`^Required

Type: Io.Cdktn.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`

private string ComputeFqn()

`GetAnyMapAttribute`

private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetBooleanAttribute`

private IResolvable GetBooleanAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetBooleanMapAttribute`

private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetListAttribute`

private string[] GetListAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetNumberAttribute`

private double GetNumberAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetNumberListAttribute`

private double[] GetNumberListAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetNumberMapAttribute`

private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetStringAttribute`

private string GetStringAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`GetStringMapAttribute`

private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

`InterpolationForAttribute`

private IResolvable InterpolationForAttribute(string Property)

`Property`^Required

Type: string

`Resolve`

private object Resolve(IResolveContext Context)

Produce the Token's value at resolution time.

`Context`^Required

Type: Io.Cdktn.IResolveContext

`ToString`

private string ToString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

`ResetCreate`

private void ResetCreate()

`ResetDelete`

private void ResetDelete()

`ResetUpdate`

private void ResetUpdate()

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`	`Io.Cdktn.IResolvable\|SpannerDatabaseTimeouts`	No description.

`CreationStack`^Required

public string[] CreationStack { get; }

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 string Fqn { get; }

Type: string

`CreateInput`^Optional

public string CreateInput { get; }

Type: string

`DeleteInput`^Optional

public string DeleteInput { get; }

Type: string

`UpdateInput`^Optional

public string UpdateInput { get; }

Type: string

`Create`^Required

public string Create { get; }

Type: string

`Delete`^Required

public string Delete { get; }

Type: string

`Update`^Required

public string Update { get; }

Type: string

`InternalValue`^Optional

public IResolvable|SpannerDatabaseTimeouts InternalValue { get; }

Type: Io.Cdktn.IResolvable|SpannerDatabaseTimeouts

FilesExpand file tree

spannerDatabase.csharp.md

Latest commit

History

spannerDatabase.csharp.md

File metadata and controls

spannerDatabase Submodule

Constructs