`firestoreDatabase` Submodule

Constructs

FirestoreDatabase

Represents a {@link https://registry.terraform.io/providers/hashicorp/google/6.33.0/docs/resources/firestore_database google_firestore_database}.

Initializers

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

new firestoreDatabase.FirestoreDatabase(scope: Construct, id: string, config: FirestoreDatabaseConfig)

Name	Type	Description
`scope`	`constructs.Construct`	The scope in which to define this construct.
`id`	`string`	The scoped construct ID.
`config`	`FirestoreDatabaseConfig`	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: FirestoreDatabaseConfig

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".
`putCmekConfig`	No description.
`putTimeouts`	No description.
`resetAppEngineIntegrationMode`	No description.
`resetCmekConfig`	No description.
`resetConcurrencyMode`	No description.
`resetDatabaseEdition`	No description.
`resetDeleteProtectionState`	No description.
`resetDeletionPolicy`	No description.
`resetId`	No description.
`resetPointInTimeRecoveryEnablement`	No description.
`resetProject`	No description.
`resetTimeouts`	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".

`putCmekConfig`

public putCmekConfig(value: FirestoreDatabaseCmekConfig): void

`value`^Required

Type: FirestoreDatabaseCmekConfig

`putTimeouts`

public putTimeouts(value: FirestoreDatabaseTimeouts): void

`value`^Required

Type: FirestoreDatabaseTimeouts

`resetAppEngineIntegrationMode`

public resetAppEngineIntegrationMode(): void

`resetCmekConfig`

public resetCmekConfig(): void

`resetConcurrencyMode`

public resetConcurrencyMode(): void

`resetDatabaseEdition`

public resetDatabaseEdition(): void

`resetDeleteProtectionState`

public resetDeleteProtectionState(): void

`resetDeletionPolicy`

public resetDeletionPolicy(): void

`resetId`

public resetId(): void

`resetPointInTimeRecoveryEnablement`

public resetPointInTimeRecoveryEnablement(): void

`resetProject`

public resetProject(): void

`resetTimeouts`

public resetTimeouts(): 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 FirestoreDatabase resource upon running "cdktf plan ".

`isConstruct`

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

firestoreDatabase.FirestoreDatabase.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 { firestoreDatabase } from '@cdktf/provider-google'

firestoreDatabase.FirestoreDatabase.isTerraformElement(x: any)

`x`^Required

Type: any

`isTerraformResource`

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

firestoreDatabase.FirestoreDatabase.isTerraformResource(x: any)

`x`^Required

Type: any

`generateConfigForImport`

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

firestoreDatabase.FirestoreDatabase.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

Generates CDKTF code for importing a FirestoreDatabase 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 FirestoreDatabase to import.

`importFromId`^Required

Type: string

The id of the existing FirestoreDatabase that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/google/6.33.0/docs/resources/firestore_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 FirestoreDatabase 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.
`cmekConfig`	`FirestoreDatabaseCmekConfigOutputReference`	No description.
`createTime`	`string`	No description.
`earliestVersionTime`	`string`	No description.
`etag`	`string`	No description.
`keyPrefix`	`string`	No description.
`timeouts`	`FirestoreDatabaseTimeoutsOutputReference`	No description.
`uid`	`string`	No description.
`updateTime`	`string`	No description.
`versionRetentionPeriod`	`string`	No description.
`appEngineIntegrationModeInput`	`string`	No description.
`cmekConfigInput`	`FirestoreDatabaseCmekConfig`	No description.
`concurrencyModeInput`	`string`	No description.
`databaseEditionInput`	`string`	No description.
`deleteProtectionStateInput`	`string`	No description.
`deletionPolicyInput`	`string`	No description.
`idInput`	`string`	No description.
`locationIdInput`	`string`	No description.
`nameInput`	`string`	No description.
`pointInTimeRecoveryEnablementInput`	`string`	No description.
`projectInput`	`string`	No description.
`timeoutsInput`	`cdktf.IResolvable \| FirestoreDatabaseTimeouts`	No description.
`typeInput`	`string`	No description.
`appEngineIntegrationMode`	`string`	No description.
`concurrencyMode`	`string`	No description.
`databaseEdition`	`string`	No description.
`deleteProtectionState`	`string`	No description.
`deletionPolicy`	`string`	No description.
`id`	`string`	No description.
`locationId`	`string`	No description.
`name`	`string`	No description.
`pointInTimeRecoveryEnablement`	`string`	No description.
`project`	`string`	No description.
`type`	`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[]

`cmekConfig`^Required

public readonly cmekConfig: FirestoreDatabaseCmekConfigOutputReference;

Type: FirestoreDatabaseCmekConfigOutputReference

`createTime`^Required

public readonly createTime: string;

Type: string

`earliestVersionTime`^Required

public readonly earliestVersionTime: string;

Type: string

`etag`^Required

public readonly etag: string;

Type: string

`keyPrefix`^Required

public readonly keyPrefix: string;

Type: string

`timeouts`^Required

public readonly timeouts: FirestoreDatabaseTimeoutsOutputReference;

Type: FirestoreDatabaseTimeoutsOutputReference

`uid`^Required

public readonly uid: string;

Type: string

`updateTime`^Required

public readonly updateTime: string;

Type: string

`versionRetentionPeriod`^Required

public readonly versionRetentionPeriod: string;

Type: string

`appEngineIntegrationModeInput`^Optional

public readonly appEngineIntegrationModeInput: string;

Type: string

`cmekConfigInput`^Optional

public readonly cmekConfigInput: FirestoreDatabaseCmekConfig;

Type: FirestoreDatabaseCmekConfig

`concurrencyModeInput`^Optional

public readonly concurrencyModeInput: string;

Type: string

`databaseEditionInput`^Optional

public readonly databaseEditionInput: string;

Type: string

`deleteProtectionStateInput`^Optional

public readonly deleteProtectionStateInput: string;

Type: string

`deletionPolicyInput`^Optional

public readonly deletionPolicyInput: string;

Type: string

`idInput`^Optional

public readonly idInput: string;

Type: string

`locationIdInput`^Optional

public readonly locationIdInput: string;

Type: string

`nameInput`^Optional

public readonly nameInput: string;

Type: string

`pointInTimeRecoveryEnablementInput`^Optional

public readonly pointInTimeRecoveryEnablementInput: string;

Type: string

`projectInput`^Optional

public readonly projectInput: string;

Type: string

`timeoutsInput`^Optional

public readonly timeoutsInput: IResolvable | FirestoreDatabaseTimeouts;

Type: cdktf.IResolvable | FirestoreDatabaseTimeouts

`typeInput`^Optional

public readonly typeInput: string;

Type: string

`appEngineIntegrationMode`^Required

public readonly appEngineIntegrationMode: string;

Type: string

`concurrencyMode`^Required

public readonly concurrencyMode: string;

Type: string

`databaseEdition`^Required

public readonly databaseEdition: string;

Type: string

`deleteProtectionState`^Required

public readonly deleteProtectionState: string;

Type: string

`deletionPolicy`^Required

public readonly deletionPolicy: string;

Type: string

`id`^Required

public readonly id: string;

Type: string

`locationId`^Required

public readonly locationId: string;

Type: string

`name`^Required

public readonly name: string;

Type: string

`pointInTimeRecoveryEnablement`^Required

public readonly pointInTimeRecoveryEnablement: string;

Type: string

`project`^Required

public readonly project: string;

Type: string

`type`^Required

public readonly type: string;

Type: string

Constants

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

`tfResourceType`^Required

public readonly tfResourceType: string;

Type: string

Structs

FirestoreDatabaseCmekConfig

Initializer

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

const firestoreDatabaseCmekConfig: firestoreDatabase.FirestoreDatabaseCmekConfig = { ... }

Properties

Name	Type	Description
`kmsKeyName`	`string`	The resource ID of a Cloud KMS key.

`kmsKeyName`^Required

public readonly kmsKeyName: string;

Type: string

The resource ID of a Cloud KMS key.

If set, the database created will be a Customer-managed Encryption Key (CMEK) database encrypted with this key. This feature is allowlist only in initial launch.

Only keys in the same location as this database are allowed to be used for encryption. For Firestore's nam5 multi-region, this corresponds to Cloud KMS multi-region us. For Firestore's eur3 multi-region, this corresponds to Cloud KMS multi-region europe. See https://cloud.google.com/kms/docs/locations.

This value should be the KMS key resource ID in the format of 'projects/{project_id}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}'. How to retrieve this resource ID is listed at https://cloud.google.com/kms/docs/getting-resource-ids#getting_the_id_for_a_key_and_version.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.33.0/docs/resources/firestore_database#kms_key_name FirestoreDatabase#kms_key_name}

FirestoreDatabaseConfig

Initializer

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

const firestoreDatabaseConfig: firestoreDatabase.FirestoreDatabaseConfig = { ... }

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.
`locationId`	`string`	The location of the database. Available locations are listed at https://cloud.google.com/firestore/docs/locations.
`name`	`string`	The ID to use for the database, which will become the final component of the database's resource name.
`type`	`string`	The type of the database. See https://cloud.google.com/datastore/docs/firestore-or-datastore for information about how to choose. Possible values: ["FIRESTORE_NATIVE", "DATASTORE_MODE"].
`appEngineIntegrationMode`	`string`	The App Engine integration mode to use for this database. Possible values: ["ENABLED", "DISABLED"].
`cmekConfig`	`FirestoreDatabaseCmekConfig`	cmek_config block.
`concurrencyMode`	`string`	The concurrency control mode to use for this database. Possible values: ["OPTIMISTIC", "PESSIMISTIC", "OPTIMISTIC_WITH_ENTITY_GROUPS"].
`databaseEdition`	`string`	The database edition. Possible values: ["STANDARD", "ENTERPRISE"].
`deleteProtectionState`	`string`	State of delete protection for the database.
`deletionPolicy`	`string`	Deletion behavior for this database.
`id`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.33.0/docs/resources/firestore_database#id FirestoreDatabase#id}.
`pointInTimeRecoveryEnablement`	`string`	Whether to enable the PITR feature on this database.
`project`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.33.0/docs/resources/firestore_database#project FirestoreDatabase#project}.
`timeouts`	`FirestoreDatabaseTimeouts`	timeouts block.

`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[]

`locationId`^Required

public readonly locationId: string;

Type: string

The location of the database. Available locations are listed at https://cloud.google.com/firestore/docs/locations.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.33.0/docs/resources/firestore_database#location_id FirestoreDatabase#location_id}

`name`^Required

public readonly name: string;

Type: string

The ID to use for the database, which will become the final component of the database's resource name.

This value should be 4-63 characters. Valid characters are /[a-z][0-9]-/ with first character a letter and the last a letter or a number. Must not be UUID-like /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/. "(default)" database id is also valid.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.33.0/docs/resources/firestore_database#name FirestoreDatabase#name}

`type`^Required

public readonly type: string;

Type: string

The type of the database. See https://cloud.google.com/datastore/docs/firestore-or-datastore for information about how to choose. Possible values: ["FIRESTORE_NATIVE", "DATASTORE_MODE"].

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.33.0/docs/resources/firestore_database#type FirestoreDatabase#type}

`appEngineIntegrationMode`^Optional

public readonly appEngineIntegrationMode: string;

Type: string

The App Engine integration mode to use for this database. Possible values: ["ENABLED", "DISABLED"].

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.33.0/docs/resources/firestore_database#app_engine_integration_mode FirestoreDatabase#app_engine_integration_mode}

`cmekConfig`^Optional

public readonly cmekConfig: FirestoreDatabaseCmekConfig;

Type: FirestoreDatabaseCmekConfig

cmek_config block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.33.0/docs/resources/firestore_database#cmek_config FirestoreDatabase#cmek_config}

`concurrencyMode`^Optional

public readonly concurrencyMode: string;

Type: string

The concurrency control mode to use for this database. Possible values: ["OPTIMISTIC", "PESSIMISTIC", "OPTIMISTIC_WITH_ENTITY_GROUPS"].

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.33.0/docs/resources/firestore_database#concurrency_mode FirestoreDatabase#concurrency_mode}

`databaseEdition`^Optional

public readonly databaseEdition: string;

Type: string

The database edition. Possible values: ["STANDARD", "ENTERPRISE"].

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.33.0/docs/resources/firestore_database#database_edition FirestoreDatabase#database_edition}

`deleteProtectionState`^Optional

public readonly deleteProtectionState: string;

Type: string

State of delete protection for the database.

When delete protection is enabled, this database cannot be deleted. The default value is 'DELETE_PROTECTION_STATE_UNSPECIFIED', which is currently equivalent to 'DELETE_PROTECTION_DISABLED'. Note: Additionally, to delete this database using 'terraform destroy', 'deletion_policy' must be set to 'DELETE'. Possible values: ["DELETE_PROTECTION_STATE_UNSPECIFIED", "DELETE_PROTECTION_ENABLED", "DELETE_PROTECTION_DISABLED"]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.33.0/docs/resources/firestore_database#delete_protection_state FirestoreDatabase#delete_protection_state}

`deletionPolicy`^Optional

public readonly deletionPolicy: string;

Type: string

Deletion behavior for this database.

If the deletion policy is 'ABANDON', the database will be removed from Terraform state but not deleted from Google Cloud upon destruction. If the deletion policy is 'DELETE', the database will both be removed from Terraform state and deleted from Google Cloud upon destruction. The default value is 'ABANDON'. See also 'delete_protection'.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.33.0/docs/resources/firestore_database#deletion_policy FirestoreDatabase#deletion_policy}

`id`^Optional

public readonly id: string;

Type: string

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

`pointInTimeRecoveryEnablement`^Optional

public readonly pointInTimeRecoveryEnablement: string;

Type: string

Whether to enable the PITR feature on this database.

If 'POINT_IN_TIME_RECOVERY_ENABLED' is selected, reads are supported on selected versions of the data from within the past 7 days. versionRetentionPeriod and earliestVersionTime can be used to determine the supported versions. These include reads against any timestamp within the past hour and reads against 1-minute snapshots beyond 1 hour and within 7 days. If 'POINT_IN_TIME_RECOVERY_DISABLED' is selected, reads are supported on any version of the data from within the past 1 hour. Default value: "POINT_IN_TIME_RECOVERY_DISABLED" Possible values: ["POINT_IN_TIME_RECOVERY_ENABLED", "POINT_IN_TIME_RECOVERY_DISABLED"]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.33.0/docs/resources/firestore_database#point_in_time_recovery_enablement FirestoreDatabase#point_in_time_recovery_enablement}

`project`^Optional

public readonly project: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.33.0/docs/resources/firestore_database#project FirestoreDatabase#project}.

`timeouts`^Optional

public readonly timeouts: FirestoreDatabaseTimeouts;

Type: FirestoreDatabaseTimeouts

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.33.0/docs/resources/firestore_database#timeouts FirestoreDatabase#timeouts}

FirestoreDatabaseTimeouts

Initializer

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

const firestoreDatabaseTimeouts: firestoreDatabase.FirestoreDatabaseTimeouts = { ... }

Properties

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

`create`^Optional

public readonly create: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.33.0/docs/resources/firestore_database#create FirestoreDatabase#create}.

`delete`^Optional

public readonly delete: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.33.0/docs/resources/firestore_database#delete FirestoreDatabase#delete}.

`update`^Optional

public readonly update: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.33.0/docs/resources/firestore_database#update FirestoreDatabase#update}.

Classes

FirestoreDatabaseCmekConfigOutputReference

Initializers

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

new firestoreDatabase.FirestoreDatabaseCmekConfigOutputReference(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.

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

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.
`activeKeyVersion`	`string[]`	No description.
`kmsKeyNameInput`	`string`	No description.
`kmsKeyName`	`string`	No description.
`internalValue`	`FirestoreDatabaseCmekConfig`	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

`activeKeyVersion`^Required

public readonly activeKeyVersion: string[];

Type: string[]

`kmsKeyNameInput`^Optional

public readonly kmsKeyNameInput: string;

Type: string

`kmsKeyName`^Required

public readonly kmsKeyName: string;

Type: string

`internalValue`^Optional

public readonly internalValue: FirestoreDatabaseCmekConfig;

Type: FirestoreDatabaseCmekConfig

FirestoreDatabaseTimeoutsOutputReference

Initializers

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

new firestoreDatabase.FirestoreDatabaseTimeoutsOutputReference(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 \| FirestoreDatabaseTimeouts`	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 | FirestoreDatabaseTimeouts;

Type: cdktf.IResolvable | FirestoreDatabaseTimeouts

Files

firestoreDatabase.typescript.md

Latest commit

History

firestoreDatabase.typescript.md

File metadata and controls

firestoreDatabase Submodule

Constructs