DatabaseState class

Input properties used for looking up and filtering Database resources.

Constructors

DatabaseState({Input<String?>? appEngineIntegrationMode, Input<DatabaseCmekConfig?>? cmekConfig, Input<String?>? concurrencyMode, Input<String?>? createTime, Input<String?>? databaseEdition, Input<String?>? deleteProtectionState, Input<String?>? deletionPolicy, Input<String?>? earliestVersionTime, Input<String?>? etag, Input<String?>? firestoreDataAccessMode, Input<String?>? keyPrefix, Input<String?>? locationId, Input<String?>? mongodbCompatibleDataAccessMode, Input<String?>? name, Input<String?>? pointInTimeRecoveryEnablement, Input<String?>? project, Input<String?>? realtimeUpdatesMode, Input<Map<String, String>?>? tags, Input<String?>? type, Input<String?>? uid, Input<String?>? updateTime, Input<String?>? versionRetentionPeriod})

Creates a new DatabaseState. appEngineIntegrationMode The App Engine integration mode to use for this database. cmekConfig The CMEK (Customer Managed Encryption Key) configuration for a Firestore concurrencyMode The concurrency control mode to use for this database. createTime Output only. The timestamp at which this database was created. databaseEdition The database edition. When set to 'ENTERPRISE', then type must be set to deleteProtectionState State of delete protection for the database. deletionPolicy Whether Terraform will be prevented from destroying the resource. Defaults to ABANDON. earliestVersionTime Output only. The earliest timestamp at which older versions of the data can be read from the database. See versionRetentionPeriod above; this field is populated with now - versionRetentionPeriod. etag Output only. This checksum is computed by the server based on the value of other fields, firestoreDataAccessMode The Firestore API data access mode to use for this database. Can only be keyPrefix Output only. The keyPrefix for this database. locationId The location of the database. Available locations are listed at mongodbCompatibleDataAccessMode The MongoDB compatible API data access mode to use for this database. Can name The ID to use for the database, which will become the final pointInTimeRecoveryEnablement Whether to enable the PITR feature on this database. project The ID of the project in which the resource belongs. realtimeUpdatesMode The Realtime Updates mode to use for this database. Can only be specified tags Input only. A map of resource manager tags. Resource manager tag keys type The type of the database. uid Output only. The system-generated UUID4 for this Database. updateTime Output only. The timestamp at which this database was most recently updated. versionRetentionPeriod Output only. The period during which past versions of data are retained in the database.

const

DatabaseState.fromMap(Map<String, dynamic> map)

factory

Properties

appEngineIntegrationMode → Input<String?>?

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

final

cmekConfig → Input<DatabaseCmekConfig?>?

The CMEK (Customer Managed Encryption Key) configuration for a Firestore database. If not present, the database is secured by the default Google encryption key. Structure is documented below.

final

concurrencyMode → Input<String?>?

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

final

createTime → Input<String?>?

Output only. The timestamp at which this database was created.

final

databaseEdition → Input<String?>?

The database edition. When set to 'ENTERPRISE', then type must be set to 'FIRESTORE_NATIVE'. Possible values are: STANDARD, ENTERPRISE.

final

deleteProtectionState → Input<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, deletionPolicy must be set to DELETE. Possible values are: DELETE_PROTECTION_STATE_UNSPECIFIED, DELETE_PROTECTION_ENABLED, DELETE_PROTECTION_DISABLED.

final

deletionPolicy → Input<String?>?

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

final

earliestVersionTime → Input<String?>?

Output only. The earliest timestamp at which older versions of the data can be read from the database. See versionRetentionPeriod above; this field is populated with now - versionRetentionPeriod. This value is continuously updated, and becomes stale the moment it is queried. If you are using this value to recover data, make sure to account for the time from the moment when the value is queried to the moment when you initiate the recovery. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

final

etag → Input<String?>?

Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

final

firestoreDataAccessMode → Input<String?>?

The Firestore API data access mode to use for this database. Can only be specified for 'ENTERPRISE' edition databases. Possible values are: DATA_ACCESS_MODE_ENABLED, DATA_ACCESS_MODE_DISABLED.

final

hashCode → int

The hash code for this object.

no setter, inherited

keyPrefix → Input<String?>?

Output only. The keyPrefix for this database. This keyPrefix is used, in combination with the project id ("") to construct the application id that is returned from the Cloud Datastore APIs in Google App Engine first generation runtimes. This value may be empty in which case the appid to use for URL-encoded keys is the projectId (eg: foo instead of vfoo).

final

locationId → Input<String?>?

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

final

mongodbCompatibleDataAccessMode → Input<String?>?

The MongoDB compatible API data access mode to use for this database. Can only be specified for 'ENTERPRISE' edition databases. Possible values are: DATA_ACCESS_MODE_ENABLED, DATA_ACCESS_MODE_DISABLED.

final

name → Input<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 /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.

final

pointInTimeRecoveryEnablement → Input<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 is POINT_IN_TIME_RECOVERY_DISABLED. Possible values are: POINT_IN_TIME_RECOVERY_ENABLED, POINT_IN_TIME_RECOVERY_DISABLED.

final

project → Input<String?>?

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

final

realtimeUpdatesMode → Input<String?>?

The Realtime Updates mode to use for this database. Can only be specified for 'ENTERPRISE' edition databases. Possible values are: REALTIME_UPDATES_MODE_ENABLED, REALTIME_UPDATES_MODE_DISABLED.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

tags → Input<Map<String, String>?>?

Input only. A map of resource manager tags. Resource manager tag keys and values have the same definition as resource manager tags. Keys must be in the format tagKeys/{tag_key_id}, and values are in the format tagValues/456. The field is ignored when empty. The field is immutable and causes resource replacement when mutated. To apply tags to an existing resource, see the gcp.tags.TagValue resource.

final

type → Input<String?>?

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

final

uid → Input<String?>?

Output only. The system-generated UUID4 for this Database.

final

updateTime → Input<String?>?

Output only. The timestamp at which this database was most recently updated.

final

versionRetentionPeriod → Input<String?>?

Output only. The period during which past versions of data are retained in the database. Any read or query can specify a readTime within this window, and will read the state of the database at that time. If the PITR feature is enabled, the retention period is 7 days. Otherwise, the retention period is 1 hour. A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".

final

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toMap() → Map<String, dynamic>

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited