`firestoreDatabase` Submodule

Constructs

FirestoreDatabase

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

Initializers

import "github.com/cdktf/cdktf-provider-google-go/google/v14/firestoredatabase"

firestoredatabase.NewFirestoreDatabase(scope Construct, id *string, config FirestoreDatabaseConfig) FirestoreDatabase

Name	Type	Description
`scope`	`github.com/aws/constructs-go/constructs/v10.Construct`	The scope in which to define this construct.
`id`	`*string`	The scoped construct ID.
`config`	`FirestoreDatabaseConfig`	No description.

`scope`^Required

Type: github.com/aws/constructs-go/constructs/v10.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.
`ResetDeleteProtectionState`	No description.
`ResetDeletionPolicy`	No description.
`ResetId`	No description.
`ResetPointInTimeRecoveryEnablement`	No description.
`ResetProject`	No description.
`ResetTimeouts`	No description.

`ToString`

func ToString() *string

Returns a string representation of this construct.

`AddOverride`

func AddOverride(path *string, value interface{})

`path`^Required

Type: *string

`value`^Required

Type: interface{}

`OverrideLogicalId`

func OverrideLogicalId(newLogicalId *string)

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`

func ResetOverrideLogicalId()

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

`ToHclTerraform`

func ToHclTerraform() interface{}

`ToMetadata`

func ToMetadata() interface{}

`ToTerraform`

func ToTerraform() interface{}

Adds this resource to the terraform JSON output.

`AddMoveTarget`

func AddMoveTarget(moveTarget *string)

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`

func GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}

`terraformAttribute`^Required

Type: *string

`GetBooleanAttribute`

func GetBooleanAttribute(terraformAttribute *string) IResolvable

`terraformAttribute`^Required

Type: *string

`GetBooleanMapAttribute`

func GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool

`terraformAttribute`^Required

Type: *string

`GetListAttribute`

func GetListAttribute(terraformAttribute *string) *[]*string

`terraformAttribute`^Required

Type: *string

`GetNumberAttribute`

func GetNumberAttribute(terraformAttribute *string) *f64

`terraformAttribute`^Required

Type: *string

`GetNumberListAttribute`

func GetNumberListAttribute(terraformAttribute *string) *[]*f64

`terraformAttribute`^Required

Type: *string

`GetNumberMapAttribute`

func GetNumberMapAttribute(terraformAttribute *string) *map[string]*f64

`terraformAttribute`^Required

Type: *string

`GetStringAttribute`

func GetStringAttribute(terraformAttribute *string) *string

`terraformAttribute`^Required

Type: *string

`GetStringMapAttribute`

func GetStringMapAttribute(terraformAttribute *string) *map[string]*string

`terraformAttribute`^Required

Type: *string

`HasResourceMove`

func HasResourceMove() interface{}

`ImportFrom`

func ImportFrom(id *string, provider TerraformProvider)

`id`^Required

Type: *string

`provider`^Optional

Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider

`InterpolationForAttribute`

func InterpolationForAttribute(terraformAttribute *string) IResolvable

`terraformAttribute`^Required

Type: *string

`MoveFromId`

func MoveFromId(id *string)

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`

func MoveTo(moveTarget *string, index interface{})

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: interface{}

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

`MoveToId`

func MoveToId(id *string)

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`

func PutCmekConfig(value FirestoreDatabaseCmekConfig)

`value`^Required

Type: FirestoreDatabaseCmekConfig

`PutTimeouts`

func PutTimeouts(value FirestoreDatabaseTimeouts)

`value`^Required

Type: FirestoreDatabaseTimeouts

`ResetAppEngineIntegrationMode`

func ResetAppEngineIntegrationMode()

`ResetCmekConfig`

func ResetCmekConfig()

`ResetConcurrencyMode`

func ResetConcurrencyMode()

`ResetDeleteProtectionState`

func ResetDeleteProtectionState()

`ResetDeletionPolicy`

func ResetDeletionPolicy()

`ResetId`

func ResetId()

`ResetPointInTimeRecoveryEnablement`

func ResetPointInTimeRecoveryEnablement()

`ResetProject`

func ResetProject()

`ResetTimeouts`

func ResetTimeouts()

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 "github.com/cdktf/cdktf-provider-google-go/google/v14/firestoredatabase"

firestoredatabase.FirestoreDatabase_IsConstruct(x interface{}) *bool

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: interface{}

Any object.

`IsTerraformElement`

import "github.com/cdktf/cdktf-provider-google-go/google/v14/firestoredatabase"

firestoredatabase.FirestoreDatabase_IsTerraformElement(x interface{}) *bool

`x`^Required

Type: interface{}

`IsTerraformResource`

import "github.com/cdktf/cdktf-provider-google-go/google/v14/firestoredatabase"

firestoredatabase.FirestoreDatabase_IsTerraformResource(x interface{}) *bool

`x`^Required

Type: interface{}

`GenerateConfigForImport`

import "github.com/cdktf/cdktf-provider-google-go/google/v14/firestoredatabase"

firestoredatabase.FirestoreDatabase_GenerateConfigForImport(scope Construct, importToId *string, importFromId *string, provider TerraformProvider) ImportableResource

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

`scope`^Required

Type: github.com/aws/constructs-go/constructs/v10.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.15.0/docs/resources/firestore_database#import import section} in the documentation of this resource for the id to use

`provider`^Optional

Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider

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

Properties

Name	Type	Description
`Node`	`github.com/aws/constructs-go/constructs/v10.Node`	The tree node.
`CdktfStack`	`github.com/hashicorp/terraform-cdk-go/cdktf.TerraformStack`	No description.
`Fqn`	`*string`	No description.
`FriendlyUniqueId`	`*string`	No description.
`TerraformMetaArguments`	`*map[string]interface{}`	No description.
`TerraformResourceType`	`*string`	No description.
`TerraformGeneratorMetadata`	`github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProviderGeneratorMetadata`	No description.
`Connection`	`interface{}`	No description.
`Count`	`interface{}`	No description.
`DependsOn`	`[]string`	No description.
`ForEach`	`github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator`	No description.
`Lifecycle`	`github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle`	No description.
`Provider`	`github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider`	No description.
`Provisioners`	`*[]interface{}`	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.
`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`	`interface{}`	No description.
`TypeInput`	`*string`	No description.
`AppEngineIntegrationMode`	`*string`	No description.
`ConcurrencyMode`	`*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

func Node() Node

Type: github.com/aws/constructs-go/constructs/v10.Node

The tree node.

`CdktfStack`^Required

func CdktfStack() TerraformStack

Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformStack

`Fqn`^Required

func Fqn() *string

Type: *string

`FriendlyUniqueId`^Required

func FriendlyUniqueId() *string

Type: *string

`TerraformMetaArguments`^Required

func TerraformMetaArguments() *map[string]interface{}

Type: *map[string]interface{}

`TerraformResourceType`^Required

func TerraformResourceType() *string

Type: *string

`TerraformGeneratorMetadata`^Optional

func TerraformGeneratorMetadata() TerraformProviderGeneratorMetadata

Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProviderGeneratorMetadata

`Connection`^Optional

func Connection() interface{}

Type: interface{}

`Count`^Optional

func Count() interface{}

Type: interface{}

`DependsOn`^Optional

func DependsOn() *[]*string

Type: *[]*string

`ForEach`^Optional

func ForEach() ITerraformIterator

Type: github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator

`Lifecycle`^Optional

func Lifecycle() TerraformResourceLifecycle

Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle

`Provider`^Optional

func Provider() TerraformProvider

Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider

`Provisioners`^Optional

func Provisioners() *[]interface{}

Type: *[]interface{}

`CmekConfig`^Required

func CmekConfig() FirestoreDatabaseCmekConfigOutputReference

Type: FirestoreDatabaseCmekConfigOutputReference

`CreateTime`^Required

func CreateTime() *string

Type: *string

`EarliestVersionTime`^Required

func EarliestVersionTime() *string

Type: *string

`Etag`^Required

func Etag() *string

Type: *string

`KeyPrefix`^Required

func KeyPrefix() *string

Type: *string

`Timeouts`^Required

func Timeouts() FirestoreDatabaseTimeoutsOutputReference

Type: FirestoreDatabaseTimeoutsOutputReference

`Uid`^Required

func Uid() *string

Type: *string

`UpdateTime`^Required

func UpdateTime() *string

Type: *string

`VersionRetentionPeriod`^Required

func VersionRetentionPeriod() *string

Type: *string

`AppEngineIntegrationModeInput`^Optional

func AppEngineIntegrationModeInput() *string

Type: *string

`CmekConfigInput`^Optional

func CmekConfigInput() FirestoreDatabaseCmekConfig

Type: FirestoreDatabaseCmekConfig

`ConcurrencyModeInput`^Optional

func ConcurrencyModeInput() *string

Type: *string

`DeleteProtectionStateInput`^Optional

func DeleteProtectionStateInput() *string

Type: *string

`DeletionPolicyInput`^Optional

func DeletionPolicyInput() *string

Type: *string

`IdInput`^Optional

func IdInput() *string

Type: *string

`LocationIdInput`^Optional

func LocationIdInput() *string

Type: *string

`NameInput`^Optional

func NameInput() *string

Type: *string

`PointInTimeRecoveryEnablementInput`^Optional

func PointInTimeRecoveryEnablementInput() *string

Type: *string

`ProjectInput`^Optional

func ProjectInput() *string

Type: *string

`TimeoutsInput`^Optional

func TimeoutsInput() interface{}

Type: interface{}

`TypeInput`^Optional

func TypeInput() *string

Type: *string

`AppEngineIntegrationMode`^Required

func AppEngineIntegrationMode() *string

Type: *string

`ConcurrencyMode`^Required

func ConcurrencyMode() *string

Type: *string

`DeleteProtectionState`^Required

func DeleteProtectionState() *string

Type: *string

`DeletionPolicy`^Required

func DeletionPolicy() *string

Type: *string

`Id`^Required

func Id() *string

Type: *string

`LocationId`^Required

func LocationId() *string

Type: *string

`Name`^Required

func Name() *string

Type: *string

`PointInTimeRecoveryEnablement`^Required

func PointInTimeRecoveryEnablement() *string

Type: *string

`Project`^Required

func Project() *string

Type: *string

`Type`^Required

func Type() *string

Type: *string

Constants

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

`TfResourceType`^Required

func TfResourceType() *string

Type: *string

Structs

FirestoreDatabaseCmekConfig

Initializer

import "github.com/cdktf/cdktf-provider-google-go/google/v14/firestoredatabase"

&firestoredatabase.FirestoreDatabaseCmekConfig {
	KmsKeyName: *string,
}

Properties

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

`KmsKeyName`^Required

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.15.0/docs/resources/firestore_database#kms_key_name FirestoreDatabase#kms_key_name}

FirestoreDatabaseConfig

Initializer

import "github.com/cdktf/cdktf-provider-google-go/google/v14/firestoredatabase"

&firestoredatabase.FirestoreDatabaseConfig {
	Connection: interface{},
	Count: interface{},
	DependsOn: *[]github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformDependable,
	ForEach: github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator,
	Lifecycle: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle,
	Provider: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider,
	Provisioners: *[]interface{},
	LocationId: *string,
	Name: *string,
	Type: *string,
	AppEngineIntegrationMode: *string,
	CmekConfig: github.com/cdktf/cdktf-provider-google-go/google/v14.firestoreDatabase.FirestoreDatabaseCmekConfig,
	ConcurrencyMode: *string,
	DeleteProtectionState: *string,
	DeletionPolicy: *string,
	Id: *string,
	PointInTimeRecoveryEnablement: *string,
	Project: *string,
	Timeouts: github.com/cdktf/cdktf-provider-google-go/google/v14.firestoreDatabase.FirestoreDatabaseTimeouts,
}

Properties

Name	Type	Description
`Connection`	`interface{}`	No description.
`Count`	`interface{}`	No description.
`DependsOn`	`*[]github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformDependable`	No description.
`ForEach`	`github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator`	No description.
`Lifecycle`	`github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle`	No description.
`Provider`	`github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider`	No description.
`Provisioners`	`*[]interface{}`	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"].
`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.15.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.15.0/docs/resources/firestore_database#project FirestoreDatabase#project}.
`Timeouts`	`FirestoreDatabaseTimeouts`	timeouts block.

`Connection`^Optional

Connection interface{}

Type: interface{}

`Count`^Optional

Count interface{}

Type: interface{}

`DependsOn`^Optional

DependsOn *[]ITerraformDependable

Type: *[]github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformDependable

`ForEach`^Optional

ForEach ITerraformIterator

Type: github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator

`Lifecycle`^Optional

Lifecycle TerraformResourceLifecycle

Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle

`Provider`^Optional

Provider TerraformProvider

Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider

`Provisioners`^Optional

Provisioners *[]interface{}

Type: *[]interface{}

`LocationId`^Required

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.15.0/docs/resources/firestore_database#location_id FirestoreDatabase#location_id}

`Name`^Required

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.15.0/docs/resources/firestore_database#name FirestoreDatabase#name}

`Type`^Required

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.15.0/docs/resources/firestore_database#type FirestoreDatabase#type}

`AppEngineIntegrationMode`^Optional

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.15.0/docs/resources/firestore_database#app_engine_integration_mode FirestoreDatabase#app_engine_integration_mode}

`CmekConfig`^Optional

CmekConfig FirestoreDatabaseCmekConfig

Type: FirestoreDatabaseCmekConfig

cmek_config block.

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

`ConcurrencyMode`^Optional

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.15.0/docs/resources/firestore_database#concurrency_mode FirestoreDatabase#concurrency_mode}

`DeleteProtectionState`^Optional

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.15.0/docs/resources/firestore_database#delete_protection_state FirestoreDatabase#delete_protection_state}

`DeletionPolicy`^Optional

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.15.0/docs/resources/firestore_database#deletion_policy FirestoreDatabase#deletion_policy}

`Id`^Optional

Id *string

Type: *string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.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

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.15.0/docs/resources/firestore_database#point_in_time_recovery_enablement FirestoreDatabase#point_in_time_recovery_enablement}

`Project`^Optional

Project *string

Type: *string

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

`Timeouts`^Optional

Timeouts FirestoreDatabaseTimeouts

Type: FirestoreDatabaseTimeouts

timeouts block.

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

FirestoreDatabaseTimeouts

Initializer

import "github.com/cdktf/cdktf-provider-google-go/google/v14/firestoredatabase"

&firestoredatabase.FirestoreDatabaseTimeouts {
	Create: *string,
	Delete: *string,
	Update: *string,
}

Properties

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

`Create`^Optional

Create *string

Type: *string

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

`Delete`^Optional

Delete *string

Type: *string

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

`Update`^Optional

Update *string

Type: *string

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

Classes

FirestoreDatabaseCmekConfigOutputReference

Initializers

import "github.com/cdktf/cdktf-provider-google-go/google/v14/firestoredatabase"

firestoredatabase.NewFirestoreDatabaseCmekConfigOutputReference(terraformResource IInterpolatingParent, terraformAttribute *string) FirestoreDatabaseCmekConfigOutputReference

Name	Type	Description
`terraformResource`	`github.com/hashicorp/terraform-cdk-go/cdktf.IInterpolatingParent`	The parent resource.
`terraformAttribute`	`*string`	The attribute on the parent resource this class is referencing.

`terraformResource`^Required

Type: github.com/hashicorp/terraform-cdk-go/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`

func ComputeFqn() *string

`GetAnyMapAttribute`

func GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}

`terraformAttribute`^Required

Type: *string

`GetBooleanAttribute`

func GetBooleanAttribute(terraformAttribute *string) IResolvable

`terraformAttribute`^Required

Type: *string

`GetBooleanMapAttribute`

func GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool

`terraformAttribute`^Required

Type: *string

`GetListAttribute`

func GetListAttribute(terraformAttribute *string) *[]*string

`terraformAttribute`^Required

Type: *string

`GetNumberAttribute`

func GetNumberAttribute(terraformAttribute *string) *f64

`terraformAttribute`^Required

Type: *string

`GetNumberListAttribute`

func GetNumberListAttribute(terraformAttribute *string) *[]*f64

`terraformAttribute`^Required

Type: *string

`GetNumberMapAttribute`

func GetNumberMapAttribute(terraformAttribute *string) *map[string]*f64

`terraformAttribute`^Required

Type: *string

`GetStringAttribute`

func GetStringAttribute(terraformAttribute *string) *string

`terraformAttribute`^Required

Type: *string

`GetStringMapAttribute`

func GetStringMapAttribute(terraformAttribute *string) *map[string]*string

`terraformAttribute`^Required

Type: *string

`InterpolationForAttribute`

func InterpolationForAttribute(property *string) IResolvable

`property`^Required

Type: *string

`Resolve`

func Resolve(_context IResolveContext) interface{}

Produce the Token's value at resolution time.

`_context`^Required

Type: github.com/hashicorp/terraform-cdk-go/cdktf.IResolveContext

`ToString`

func 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

func 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

func Fqn() *string

Type: *string

`ActiveKeyVersion`^Required

func ActiveKeyVersion() *[]*string

Type: *[]*string

`KmsKeyNameInput`^Optional

func KmsKeyNameInput() *string

Type: *string

`KmsKeyName`^Required

func KmsKeyName() *string

Type: *string

`InternalValue`^Optional

func InternalValue() FirestoreDatabaseCmekConfig

Type: FirestoreDatabaseCmekConfig

FirestoreDatabaseTimeoutsOutputReference

Initializers

import "github.com/cdktf/cdktf-provider-google-go/google/v14/firestoredatabase"

firestoredatabase.NewFirestoreDatabaseTimeoutsOutputReference(terraformResource IInterpolatingParent, terraformAttribute *string) FirestoreDatabaseTimeoutsOutputReference

Name	Type	Description
`terraformResource`	`github.com/hashicorp/terraform-cdk-go/cdktf.IInterpolatingParent`	The parent resource.
`terraformAttribute`	`*string`	The attribute on the parent resource this class is referencing.

`terraformResource`^Required

Type: github.com/hashicorp/terraform-cdk-go/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`

func ComputeFqn() *string

`GetAnyMapAttribute`

func GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}

`terraformAttribute`^Required

Type: *string

`GetBooleanAttribute`

func GetBooleanAttribute(terraformAttribute *string) IResolvable

`terraformAttribute`^Required

Type: *string

`GetBooleanMapAttribute`

func GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool

`terraformAttribute`^Required

Type: *string

`GetListAttribute`

func GetListAttribute(terraformAttribute *string) *[]*string

`terraformAttribute`^Required

Type: *string

`GetNumberAttribute`

func GetNumberAttribute(terraformAttribute *string) *f64

`terraformAttribute`^Required

Type: *string

`GetNumberListAttribute`

func GetNumberListAttribute(terraformAttribute *string) *[]*f64

`terraformAttribute`^Required

Type: *string

`GetNumberMapAttribute`

func GetNumberMapAttribute(terraformAttribute *string) *map[string]*f64

`terraformAttribute`^Required

Type: *string

`GetStringAttribute`

func GetStringAttribute(terraformAttribute *string) *string

`terraformAttribute`^Required

Type: *string

`GetStringMapAttribute`

func GetStringMapAttribute(terraformAttribute *string) *map[string]*string

`terraformAttribute`^Required

Type: *string

`InterpolationForAttribute`

func InterpolationForAttribute(property *string) IResolvable

`property`^Required

Type: *string

`Resolve`

func Resolve(_context IResolveContext) interface{}

Produce the Token's value at resolution time.

`_context`^Required

Type: github.com/hashicorp/terraform-cdk-go/cdktf.IResolveContext

`ToString`

func ToString() *string

Return a string representation of this resolvable object.

Returns a reversible string representation.

`ResetCreate`

func ResetCreate()

`ResetDelete`

func ResetDelete()

`ResetUpdate`

func 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`	`interface{}`	No description.

`CreationStack`^Required

func 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

func Fqn() *string

Type: *string

`CreateInput`^Optional

func CreateInput() *string

Type: *string

`DeleteInput`^Optional

func DeleteInput() *string

Type: *string

`UpdateInput`^Optional

func UpdateInput() *string

Type: *string

`Create`^Required

func Create() *string

Type: *string

`Delete`^Required

func Delete() *string

Type: *string

`Update`^Required

func Update() *string

Type: *string

`InternalValue`^Optional

func InternalValue() interface{}

Type: interface{}

Files

firestoreDatabase.go.md

Latest commit

History

firestoreDatabase.go.md

File metadata and controls

firestoreDatabase Submodule

Constructs