`firestoreDatabase` Submodule

Constructs

FirestoreDatabase

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

Initializers

using HashiCorp.Cdktf.Providers.Google;

new FirestoreDatabase(Construct Scope, string Id, FirestoreDatabaseConfig Config);

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.
`ResetDeleteProtectionState`	No description.
`ResetDeletionPolicy`	No description.
`ResetId`	No description.
`ResetPointInTimeRecoveryEnablement`	No description.
`ResetProject`	No description.
`ResetTimeouts`	No description.

`ToString`

private string ToString()

Returns a string representation of this construct.

`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 object HasResourceMove()

`ImportFrom`

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

`Id`^Required

Type: string

`Provider`^Optional

Type: HashiCorp.Cdktf.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, object 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: object

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

`PutCmekConfig`

private void PutCmekConfig(FirestoreDatabaseCmekConfig Value)

`Value`^Required

Type: FirestoreDatabaseCmekConfig

`PutTimeouts`

private void PutTimeouts(FirestoreDatabaseTimeouts Value)

`Value`^Required

Type: FirestoreDatabaseTimeouts

`ResetAppEngineIntegrationMode`

private void ResetAppEngineIntegrationMode()

`ResetCmekConfig`

private void ResetCmekConfig()

`ResetConcurrencyMode`

private void ResetConcurrencyMode()

`ResetDeleteProtectionState`

private void ResetDeleteProtectionState()

`ResetDeletionPolicy`

private void ResetDeletionPolicy()

`ResetId`

private void ResetId()

`ResetPointInTimeRecoveryEnablement`

private void ResetPointInTimeRecoveryEnablement()

`ResetProject`

private void ResetProject()

`ResetTimeouts`

private void 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`

using HashiCorp.Cdktf.Providers.Google;

FirestoreDatabase.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 HashiCorp.Cdktf.Providers.Google;

FirestoreDatabase.IsTerraformElement(object X);

`X`^Required

Type: object

`IsTerraformResource`

using HashiCorp.Cdktf.Providers.Google;

FirestoreDatabase.IsTerraformResource(object X);

`X`^Required

Type: object

`GenerateConfigForImport`

using HashiCorp.Cdktf.Providers.Google;

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

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.14.1/docs/resources/firestore_database#import import section} in the documentation of this resource for the id to use

`Provider`^Optional

Type: HashiCorp.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`	`HashiCorp.Cdktf.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`	`HashiCorp.Cdktf.TerraformProviderGeneratorMetadata`	No description.
`Connection`	`object`	No description.
`Count`	`object`	No description.
`DependsOn`	`string[]`	No description.
`ForEach`	`HashiCorp.Cdktf.ITerraformIterator`	No description.
`Lifecycle`	`HashiCorp.Cdktf.TerraformResourceLifecycle`	No description.
`Provider`	`HashiCorp.Cdktf.TerraformProvider`	No description.
`Provisioners`	`object[]`	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`	`object`	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

public Node Node { get; }

Type: Constructs.Node

The tree node.

`CdktfStack`^Required

public TerraformStack CdktfStack { get; }

Type: HashiCorp.Cdktf.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: HashiCorp.Cdktf.TerraformProviderGeneratorMetadata

`Connection`^Optional

public object Connection { get; }

Type: object

`Count`^Optional

public object Count { get; }

Type: object

`DependsOn`^Optional

public string[] DependsOn { get; }

Type: string[]

`ForEach`^Optional

public ITerraformIterator ForEach { get; }

Type: HashiCorp.Cdktf.ITerraformIterator

`Lifecycle`^Optional

public TerraformResourceLifecycle Lifecycle { get; }

Type: HashiCorp.Cdktf.TerraformResourceLifecycle

`Provider`^Optional

public TerraformProvider Provider { get; }

Type: HashiCorp.Cdktf.TerraformProvider

`Provisioners`^Optional

public object[] Provisioners { get; }

Type: object[]

`CmekConfig`^Required

public FirestoreDatabaseCmekConfigOutputReference CmekConfig { get; }

Type: FirestoreDatabaseCmekConfigOutputReference

`CreateTime`^Required

public string CreateTime { get; }

Type: string

`EarliestVersionTime`^Required

public string EarliestVersionTime { get; }

Type: string

`Etag`^Required

public string Etag { get; }

Type: string

`KeyPrefix`^Required

public string KeyPrefix { get; }

Type: string

`Timeouts`^Required

public FirestoreDatabaseTimeoutsOutputReference Timeouts { get; }

Type: FirestoreDatabaseTimeoutsOutputReference

`Uid`^Required

public string Uid { get; }

Type: string

`UpdateTime`^Required

public string UpdateTime { get; }

Type: string

`VersionRetentionPeriod`^Required

public string VersionRetentionPeriod { get; }

Type: string

`AppEngineIntegrationModeInput`^Optional

public string AppEngineIntegrationModeInput { get; }

Type: string

`CmekConfigInput`^Optional

public FirestoreDatabaseCmekConfig CmekConfigInput { get; }

Type: FirestoreDatabaseCmekConfig

`ConcurrencyModeInput`^Optional

public string ConcurrencyModeInput { get; }

Type: string

`DeleteProtectionStateInput`^Optional

public string DeleteProtectionStateInput { get; }

Type: string

`DeletionPolicyInput`^Optional

public string DeletionPolicyInput { get; }

Type: string

`IdInput`^Optional

public string IdInput { get; }

Type: string

`LocationIdInput`^Optional

public string LocationIdInput { get; }

Type: string

`NameInput`^Optional

public string NameInput { get; }

Type: string

`PointInTimeRecoveryEnablementInput`^Optional

public string PointInTimeRecoveryEnablementInput { get; }

Type: string

`ProjectInput`^Optional

public string ProjectInput { get; }

Type: string

`TimeoutsInput`^Optional

public object TimeoutsInput { get; }

Type: object

`TypeInput`^Optional

public string TypeInput { get; }

Type: string

`AppEngineIntegrationMode`^Required

public string AppEngineIntegrationMode { get; }

Type: string

`ConcurrencyMode`^Required

public string ConcurrencyMode { get; }

Type: string

`DeleteProtectionState`^Required

public string DeleteProtectionState { get; }

Type: string

`DeletionPolicy`^Required

public string DeletionPolicy { get; }

Type: string

`Id`^Required

public string Id { get; }

Type: string

`LocationId`^Required

public string LocationId { get; }

Type: string

`Name`^Required

public string Name { get; }

Type: string

`PointInTimeRecoveryEnablement`^Required

public string PointInTimeRecoveryEnablement { get; }

Type: string

`Project`^Required

public string Project { get; }

Type: string

`Type`^Required

public string Type { get; }

Type: string

Constants

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

`TfResourceType`^Required

public string TfResourceType { get; }

Type: string

Structs

FirestoreDatabaseCmekConfig

Initializer

using HashiCorp.Cdktf.Providers.Google;

new FirestoreDatabaseCmekConfig {
    string KmsKeyName
};

Properties

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

`KmsKeyName`^Required

public string KmsKeyName { get; set; }

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

FirestoreDatabaseConfig

Initializer

using HashiCorp.Cdktf.Providers.Google;

new FirestoreDatabaseConfig {
    object Connection = null,
    object Count = null,
    ITerraformDependable[] DependsOn = null,
    ITerraformIterator ForEach = null,
    TerraformResourceLifecycle Lifecycle = null,
    TerraformProvider Provider = null,
    object[] Provisioners = null,
    string LocationId,
    string Name,
    string Type,
    string AppEngineIntegrationMode = null,
    FirestoreDatabaseCmekConfig CmekConfig = null,
    string ConcurrencyMode = null,
    string DeleteProtectionState = null,
    string DeletionPolicy = null,
    string Id = null,
    string PointInTimeRecoveryEnablement = null,
    string Project = null,
    FirestoreDatabaseTimeouts Timeouts = null
};

Properties

Name	Type	Description
`Connection`	`object`	No description.
`Count`	`object`	No description.
`DependsOn`	`HashiCorp.Cdktf.ITerraformDependable[]`	No description.
`ForEach`	`HashiCorp.Cdktf.ITerraformIterator`	No description.
`Lifecycle`	`HashiCorp.Cdktf.TerraformResourceLifecycle`	No description.
`Provider`	`HashiCorp.Cdktf.TerraformProvider`	No description.
`Provisioners`	`object[]`	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.14.1/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.14.1/docs/resources/firestore_database#project FirestoreDatabase#project}.
`Timeouts`	`FirestoreDatabaseTimeouts`	timeouts block.

`Connection`^Optional

public object Connection { get; set; }

Type: object

`Count`^Optional

public object Count { get; set; }

Type: object

`DependsOn`^Optional

public ITerraformDependable[] DependsOn { get; set; }

Type: HashiCorp.Cdktf.ITerraformDependable[]

`ForEach`^Optional

public ITerraformIterator ForEach { get; set; }

Type: HashiCorp.Cdktf.ITerraformIterator

`Lifecycle`^Optional

public TerraformResourceLifecycle Lifecycle { get; set; }

Type: HashiCorp.Cdktf.TerraformResourceLifecycle

`Provider`^Optional

public TerraformProvider Provider { get; set; }

Type: HashiCorp.Cdktf.TerraformProvider

`Provisioners`^Optional

public object[] Provisioners { get; set; }

Type: object[]

`LocationId`^Required

public string LocationId { get; set; }

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

`Name`^Required

public string Name { get; set; }

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

`Type`^Required

public string Type { get; set; }

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

`AppEngineIntegrationMode`^Optional

public string AppEngineIntegrationMode { get; set; }

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

`CmekConfig`^Optional

public FirestoreDatabaseCmekConfig CmekConfig { get; set; }

Type: FirestoreDatabaseCmekConfig

cmek_config block.

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

`ConcurrencyMode`^Optional

public string ConcurrencyMode { get; set; }

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

`DeleteProtectionState`^Optional

public string DeleteProtectionState { get; set; }

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

`DeletionPolicy`^Optional

public string DeletionPolicy { get; set; }

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

`Id`^Optional

public string Id { get; set; }

Type: string

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

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

`Project`^Optional

public string Project { get; set; }

Type: string

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

`Timeouts`^Optional

public FirestoreDatabaseTimeouts Timeouts { get; set; }

Type: FirestoreDatabaseTimeouts

timeouts block.

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

FirestoreDatabaseTimeouts

Initializer

using HashiCorp.Cdktf.Providers.Google;

new FirestoreDatabaseTimeouts {
    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/6.14.1/docs/resources/firestore_database#create FirestoreDatabase#create}.
`Delete`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/firestore_database#delete FirestoreDatabase#delete}.
`Update`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/firestore_database#update FirestoreDatabase#update}.

`Create`^Optional

public string Create { get; set; }

Type: string

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

`Delete`^Optional

public string Delete { get; set; }

Type: string

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

`Update`^Optional

public string Update { get; set; }

Type: string

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

Classes

FirestoreDatabaseCmekConfigOutputReference

Initializers

using HashiCorp.Cdktf.Providers.Google;

new FirestoreDatabaseCmekConfigOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute);

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

`TerraformResource`^Required

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

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: HashiCorp.Cdktf.IResolveContext

`ToString`

private string ToString()

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

`ActiveKeyVersion`^Required

public string[] ActiveKeyVersion { get; }

Type: string[]

`KmsKeyNameInput`^Optional

public string KmsKeyNameInput { get; }

Type: string

`KmsKeyName`^Required

public string KmsKeyName { get; }

Type: string

`InternalValue`^Optional

public FirestoreDatabaseCmekConfig InternalValue { get; }

Type: FirestoreDatabaseCmekConfig

FirestoreDatabaseTimeoutsOutputReference

Initializers

using HashiCorp.Cdktf.Providers.Google;

new FirestoreDatabaseTimeoutsOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute);

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

`TerraformResource`^Required

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

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: HashiCorp.Cdktf.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`	`object`	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 object InternalValue { get; }

Type: object

Files

firestoreDatabase.csharp.md

Latest commit

History

firestoreDatabase.csharp.md

File metadata and controls

firestoreDatabase Submodule

Constructs