1. Packages
  2. Google Cloud Native
  3. API Docs
  4. firestore
  5. firestore/v1
  6. Database

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

google-native.firestore/v1.Database

Explore with Pulumi AI

google-native logo

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

    Create a database.

    Create Database Resource

    new Database(name: string, args: DatabaseArgs, opts?: CustomResourceOptions);
    @overload
    def Database(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 app_engine_integration_mode: Optional[DatabaseAppEngineIntegrationMode] = None,
                 concurrency_mode: Optional[DatabaseConcurrencyMode] = None,
                 database_id: Optional[str] = None,
                 delete_protection_state: Optional[DatabaseDeleteProtectionState] = None,
                 etag: Optional[str] = None,
                 location: Optional[str] = None,
                 name: Optional[str] = None,
                 point_in_time_recovery_enablement: Optional[DatabasePointInTimeRecoveryEnablement] = None,
                 project: Optional[str] = None,
                 type: Optional[DatabaseType] = None)
    @overload
    def Database(resource_name: str,
                 args: DatabaseArgs,
                 opts: Optional[ResourceOptions] = None)
    func NewDatabase(ctx *Context, name string, args DatabaseArgs, opts ...ResourceOption) (*Database, error)
    public Database(string name, DatabaseArgs args, CustomResourceOptions? opts = null)
    public Database(String name, DatabaseArgs args)
    public Database(String name, DatabaseArgs args, CustomResourceOptions options)
    
    type: google-native:firestore/v1:Database
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args DatabaseArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args DatabaseArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args DatabaseArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DatabaseArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DatabaseArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Database Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Database resource accepts the following input properties:

    DatabaseId string

    Required. 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-/ 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.

    AppEngineIntegrationMode Pulumi.GoogleNative.Firestore.V1.DatabaseAppEngineIntegrationMode

    The App Engine integration mode to use for this database.

    ConcurrencyMode Pulumi.GoogleNative.Firestore.V1.DatabaseConcurrencyMode

    The concurrency control mode to use for this database.

    DeleteProtectionState Pulumi.GoogleNative.Firestore.V1.DatabaseDeleteProtectionState

    State of delete protection for the database.

    Etag string

    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.

    Location string

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

    Name string

    The resource name of the Database. Format: projects/{project}/databases/{database}

    PointInTimeRecoveryEnablement Pulumi.GoogleNative.Firestore.V1.DatabasePointInTimeRecoveryEnablement

    Whether to enable the PITR feature on this database.

    Project string
    Type Pulumi.GoogleNative.Firestore.V1.DatabaseType

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

    DatabaseId string

    Required. 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-/ 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.

    AppEngineIntegrationMode DatabaseAppEngineIntegrationMode

    The App Engine integration mode to use for this database.

    ConcurrencyMode DatabaseConcurrencyMode

    The concurrency control mode to use for this database.

    DeleteProtectionState DatabaseDeleteProtectionState

    State of delete protection for the database.

    Etag string

    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.

    Location string

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

    Name string

    The resource name of the Database. Format: projects/{project}/databases/{database}

    PointInTimeRecoveryEnablement DatabasePointInTimeRecoveryEnablement

    Whether to enable the PITR feature on this database.

    Project string
    Type DatabaseType

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

    databaseId String

    Required. 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-/ 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.

    appEngineIntegrationMode DatabaseAppEngineIntegrationMode

    The App Engine integration mode to use for this database.

    concurrencyMode DatabaseConcurrencyMode

    The concurrency control mode to use for this database.

    deleteProtectionState DatabaseDeleteProtectionState

    State of delete protection for the database.

    etag String

    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.

    location String

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

    name String

    The resource name of the Database. Format: projects/{project}/databases/{database}

    pointInTimeRecoveryEnablement DatabasePointInTimeRecoveryEnablement

    Whether to enable the PITR feature on this database.

    project String
    type DatabaseType

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

    databaseId string

    Required. 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-/ 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.

    appEngineIntegrationMode DatabaseAppEngineIntegrationMode

    The App Engine integration mode to use for this database.

    concurrencyMode DatabaseConcurrencyMode

    The concurrency control mode to use for this database.

    deleteProtectionState DatabaseDeleteProtectionState

    State of delete protection for the database.

    etag string

    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.

    location string

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

    name string

    The resource name of the Database. Format: projects/{project}/databases/{database}

    pointInTimeRecoveryEnablement DatabasePointInTimeRecoveryEnablement

    Whether to enable the PITR feature on this database.

    project string
    type DatabaseType

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

    database_id str

    Required. 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-/ 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.

    app_engine_integration_mode DatabaseAppEngineIntegrationMode

    The App Engine integration mode to use for this database.

    concurrency_mode DatabaseConcurrencyMode

    The concurrency control mode to use for this database.

    delete_protection_state DatabaseDeleteProtectionState

    State of delete protection for the database.

    etag str

    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.

    location str

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

    name str

    The resource name of the Database. Format: projects/{project}/databases/{database}

    point_in_time_recovery_enablement DatabasePointInTimeRecoveryEnablement

    Whether to enable the PITR feature on this database.

    project str
    type DatabaseType

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

    databaseId String

    Required. 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-/ 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.

    appEngineIntegrationMode "APP_ENGINE_INTEGRATION_MODE_UNSPECIFIED" | "ENABLED" | "DISABLED"

    The App Engine integration mode to use for this database.

    concurrencyMode "CONCURRENCY_MODE_UNSPECIFIED" | "OPTIMISTIC" | "PESSIMISTIC" | "OPTIMISTIC_WITH_ENTITY_GROUPS"

    The concurrency control mode to use for this database.

    deleteProtectionState "DELETE_PROTECTION_STATE_UNSPECIFIED" | "DELETE_PROTECTION_DISABLED" | "DELETE_PROTECTION_ENABLED"

    State of delete protection for the database.

    etag String

    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.

    location String

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

    name String

    The resource name of the Database. Format: projects/{project}/databases/{database}

    pointInTimeRecoveryEnablement "POINT_IN_TIME_RECOVERY_ENABLEMENT_UNSPECIFIED" | "POINT_IN_TIME_RECOVERY_ENABLED" | "POINT_IN_TIME_RECOVERY_DISABLED"

    Whether to enable the PITR feature on this database.

    project String
    type "DATABASE_TYPE_UNSPECIFIED" | "FIRESTORE_NATIVE" | "DATASTORE_MODE"

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

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Database resource produces the following output properties:

    CreateTime string

    The timestamp at which this database was created. Databases created before 2016 do not populate create_time.

    EarliestVersionTime string

    The earliest timestamp at which older versions of the data can be read from the database. See [version_retention_period] above; this field is populated with now - version_retention_period. 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.

    Id string

    The provider-assigned unique ID for this managed resource.

    KeyPrefix string

    The key_prefix for this database. This key_prefix 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 project_id (eg: foo instead of v~foo).

    Uid string

    The system-generated UUID4 for this Database.

    UpdateTime string

    The timestamp at which this database was most recently updated. Note this only includes updates to the database resource and not data contained by the database.

    VersionRetentionPeriod string

    The period during which past versions of data are retained in the database. Any read or query can specify a read_time 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.

    CreateTime string

    The timestamp at which this database was created. Databases created before 2016 do not populate create_time.

    EarliestVersionTime string

    The earliest timestamp at which older versions of the data can be read from the database. See [version_retention_period] above; this field is populated with now - version_retention_period. 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.

    Id string

    The provider-assigned unique ID for this managed resource.

    KeyPrefix string

    The key_prefix for this database. This key_prefix 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 project_id (eg: foo instead of v~foo).

    Uid string

    The system-generated UUID4 for this Database.

    UpdateTime string

    The timestamp at which this database was most recently updated. Note this only includes updates to the database resource and not data contained by the database.

    VersionRetentionPeriod string

    The period during which past versions of data are retained in the database. Any read or query can specify a read_time 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.

    createTime String

    The timestamp at which this database was created. Databases created before 2016 do not populate create_time.

    earliestVersionTime String

    The earliest timestamp at which older versions of the data can be read from the database. See [version_retention_period] above; this field is populated with now - version_retention_period. 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.

    id String

    The provider-assigned unique ID for this managed resource.

    keyPrefix String

    The key_prefix for this database. This key_prefix 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 project_id (eg: foo instead of v~foo).

    uid String

    The system-generated UUID4 for this Database.

    updateTime String

    The timestamp at which this database was most recently updated. Note this only includes updates to the database resource and not data contained by the database.

    versionRetentionPeriod String

    The period during which past versions of data are retained in the database. Any read or query can specify a read_time 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.

    createTime string

    The timestamp at which this database was created. Databases created before 2016 do not populate create_time.

    earliestVersionTime string

    The earliest timestamp at which older versions of the data can be read from the database. See [version_retention_period] above; this field is populated with now - version_retention_period. 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.

    id string

    The provider-assigned unique ID for this managed resource.

    keyPrefix string

    The key_prefix for this database. This key_prefix 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 project_id (eg: foo instead of v~foo).

    uid string

    The system-generated UUID4 for this Database.

    updateTime string

    The timestamp at which this database was most recently updated. Note this only includes updates to the database resource and not data contained by the database.

    versionRetentionPeriod string

    The period during which past versions of data are retained in the database. Any read or query can specify a read_time 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.

    create_time str

    The timestamp at which this database was created. Databases created before 2016 do not populate create_time.

    earliest_version_time str

    The earliest timestamp at which older versions of the data can be read from the database. See [version_retention_period] above; this field is populated with now - version_retention_period. 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.

    id str

    The provider-assigned unique ID for this managed resource.

    key_prefix str

    The key_prefix for this database. This key_prefix 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 project_id (eg: foo instead of v~foo).

    uid str

    The system-generated UUID4 for this Database.

    update_time str

    The timestamp at which this database was most recently updated. Note this only includes updates to the database resource and not data contained by the database.

    version_retention_period str

    The period during which past versions of data are retained in the database. Any read or query can specify a read_time 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.

    createTime String

    The timestamp at which this database was created. Databases created before 2016 do not populate create_time.

    earliestVersionTime String

    The earliest timestamp at which older versions of the data can be read from the database. See [version_retention_period] above; this field is populated with now - version_retention_period. 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.

    id String

    The provider-assigned unique ID for this managed resource.

    keyPrefix String

    The key_prefix for this database. This key_prefix 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 project_id (eg: foo instead of v~foo).

    uid String

    The system-generated UUID4 for this Database.

    updateTime String

    The timestamp at which this database was most recently updated. Note this only includes updates to the database resource and not data contained by the database.

    versionRetentionPeriod String

    The period during which past versions of data are retained in the database. Any read or query can specify a read_time 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.

    Supporting Types

    DatabaseAppEngineIntegrationMode, DatabaseAppEngineIntegrationModeArgs

    AppEngineIntegrationModeUnspecified
    APP_ENGINE_INTEGRATION_MODE_UNSPECIFIED

    Not used.

    Enabled
    ENABLED

    If an App Engine application exists in the same region as this database, App Engine configuration will impact this database. This includes disabling of the application & database, as well as disabling writes to the database.

    Disabled
    DISABLED

    App Engine has no effect on the ability of this database to serve requests. This is the default setting for databases created with the Firestore API.

    DatabaseAppEngineIntegrationModeAppEngineIntegrationModeUnspecified
    APP_ENGINE_INTEGRATION_MODE_UNSPECIFIED

    Not used.

    DatabaseAppEngineIntegrationModeEnabled
    ENABLED

    If an App Engine application exists in the same region as this database, App Engine configuration will impact this database. This includes disabling of the application & database, as well as disabling writes to the database.

    DatabaseAppEngineIntegrationModeDisabled
    DISABLED

    App Engine has no effect on the ability of this database to serve requests. This is the default setting for databases created with the Firestore API.

    AppEngineIntegrationModeUnspecified
    APP_ENGINE_INTEGRATION_MODE_UNSPECIFIED

    Not used.

    Enabled
    ENABLED

    If an App Engine application exists in the same region as this database, App Engine configuration will impact this database. This includes disabling of the application & database, as well as disabling writes to the database.

    Disabled
    DISABLED

    App Engine has no effect on the ability of this database to serve requests. This is the default setting for databases created with the Firestore API.

    AppEngineIntegrationModeUnspecified
    APP_ENGINE_INTEGRATION_MODE_UNSPECIFIED

    Not used.

    Enabled
    ENABLED

    If an App Engine application exists in the same region as this database, App Engine configuration will impact this database. This includes disabling of the application & database, as well as disabling writes to the database.

    Disabled
    DISABLED

    App Engine has no effect on the ability of this database to serve requests. This is the default setting for databases created with the Firestore API.

    APP_ENGINE_INTEGRATION_MODE_UNSPECIFIED
    APP_ENGINE_INTEGRATION_MODE_UNSPECIFIED

    Not used.

    ENABLED
    ENABLED

    If an App Engine application exists in the same region as this database, App Engine configuration will impact this database. This includes disabling of the application & database, as well as disabling writes to the database.

    DISABLED
    DISABLED

    App Engine has no effect on the ability of this database to serve requests. This is the default setting for databases created with the Firestore API.

    "APP_ENGINE_INTEGRATION_MODE_UNSPECIFIED"
    APP_ENGINE_INTEGRATION_MODE_UNSPECIFIED

    Not used.

    "ENABLED"
    ENABLED

    If an App Engine application exists in the same region as this database, App Engine configuration will impact this database. This includes disabling of the application & database, as well as disabling writes to the database.

    "DISABLED"
    DISABLED

    App Engine has no effect on the ability of this database to serve requests. This is the default setting for databases created with the Firestore API.

    DatabaseConcurrencyMode, DatabaseConcurrencyModeArgs

    ConcurrencyModeUnspecified
    CONCURRENCY_MODE_UNSPECIFIED

    Not used.

    Optimistic
    OPTIMISTIC

    Use optimistic concurrency control by default. This mode is available for Cloud Firestore databases.

    Pessimistic
    PESSIMISTIC

    Use pessimistic concurrency control by default. This mode is available for Cloud Firestore databases. This is the default setting for Cloud Firestore.

    OptimisticWithEntityGroups
    OPTIMISTIC_WITH_ENTITY_GROUPS

    Use optimistic concurrency control with entity groups by default. This is the only available mode for Cloud Datastore. This mode is also available for Cloud Firestore with Datastore Mode but is not recommended.

    DatabaseConcurrencyModeConcurrencyModeUnspecified
    CONCURRENCY_MODE_UNSPECIFIED

    Not used.

    DatabaseConcurrencyModeOptimistic
    OPTIMISTIC

    Use optimistic concurrency control by default. This mode is available for Cloud Firestore databases.

    DatabaseConcurrencyModePessimistic
    PESSIMISTIC

    Use pessimistic concurrency control by default. This mode is available for Cloud Firestore databases. This is the default setting for Cloud Firestore.

    DatabaseConcurrencyModeOptimisticWithEntityGroups
    OPTIMISTIC_WITH_ENTITY_GROUPS

    Use optimistic concurrency control with entity groups by default. This is the only available mode for Cloud Datastore. This mode is also available for Cloud Firestore with Datastore Mode but is not recommended.

    ConcurrencyModeUnspecified
    CONCURRENCY_MODE_UNSPECIFIED

    Not used.

    Optimistic
    OPTIMISTIC

    Use optimistic concurrency control by default. This mode is available for Cloud Firestore databases.

    Pessimistic
    PESSIMISTIC

    Use pessimistic concurrency control by default. This mode is available for Cloud Firestore databases. This is the default setting for Cloud Firestore.

    OptimisticWithEntityGroups
    OPTIMISTIC_WITH_ENTITY_GROUPS

    Use optimistic concurrency control with entity groups by default. This is the only available mode for Cloud Datastore. This mode is also available for Cloud Firestore with Datastore Mode but is not recommended.

    ConcurrencyModeUnspecified
    CONCURRENCY_MODE_UNSPECIFIED

    Not used.

    Optimistic
    OPTIMISTIC

    Use optimistic concurrency control by default. This mode is available for Cloud Firestore databases.

    Pessimistic
    PESSIMISTIC

    Use pessimistic concurrency control by default. This mode is available for Cloud Firestore databases. This is the default setting for Cloud Firestore.

    OptimisticWithEntityGroups
    OPTIMISTIC_WITH_ENTITY_GROUPS

    Use optimistic concurrency control with entity groups by default. This is the only available mode for Cloud Datastore. This mode is also available for Cloud Firestore with Datastore Mode but is not recommended.

    CONCURRENCY_MODE_UNSPECIFIED
    CONCURRENCY_MODE_UNSPECIFIED

    Not used.

    OPTIMISTIC
    OPTIMISTIC

    Use optimistic concurrency control by default. This mode is available for Cloud Firestore databases.

    PESSIMISTIC
    PESSIMISTIC

    Use pessimistic concurrency control by default. This mode is available for Cloud Firestore databases. This is the default setting for Cloud Firestore.

    OPTIMISTIC_WITH_ENTITY_GROUPS
    OPTIMISTIC_WITH_ENTITY_GROUPS

    Use optimistic concurrency control with entity groups by default. This is the only available mode for Cloud Datastore. This mode is also available for Cloud Firestore with Datastore Mode but is not recommended.

    "CONCURRENCY_MODE_UNSPECIFIED"
    CONCURRENCY_MODE_UNSPECIFIED

    Not used.

    "OPTIMISTIC"
    OPTIMISTIC

    Use optimistic concurrency control by default. This mode is available for Cloud Firestore databases.

    "PESSIMISTIC"
    PESSIMISTIC

    Use pessimistic concurrency control by default. This mode is available for Cloud Firestore databases. This is the default setting for Cloud Firestore.

    "OPTIMISTIC_WITH_ENTITY_GROUPS"
    OPTIMISTIC_WITH_ENTITY_GROUPS

    Use optimistic concurrency control with entity groups by default. This is the only available mode for Cloud Datastore. This mode is also available for Cloud Firestore with Datastore Mode but is not recommended.

    DatabaseDeleteProtectionState, DatabaseDeleteProtectionStateArgs

    DeleteProtectionStateUnspecified
    DELETE_PROTECTION_STATE_UNSPECIFIED

    The default value. Delete protection type is not specified

    DeleteProtectionDisabled
    DELETE_PROTECTION_DISABLED

    Delete protection is disabled

    DeleteProtectionEnabled
    DELETE_PROTECTION_ENABLED

    Delete protection is enabled

    DatabaseDeleteProtectionStateDeleteProtectionStateUnspecified
    DELETE_PROTECTION_STATE_UNSPECIFIED

    The default value. Delete protection type is not specified

    DatabaseDeleteProtectionStateDeleteProtectionDisabled
    DELETE_PROTECTION_DISABLED

    Delete protection is disabled

    DatabaseDeleteProtectionStateDeleteProtectionEnabled
    DELETE_PROTECTION_ENABLED

    Delete protection is enabled

    DeleteProtectionStateUnspecified
    DELETE_PROTECTION_STATE_UNSPECIFIED

    The default value. Delete protection type is not specified

    DeleteProtectionDisabled
    DELETE_PROTECTION_DISABLED

    Delete protection is disabled

    DeleteProtectionEnabled
    DELETE_PROTECTION_ENABLED

    Delete protection is enabled

    DeleteProtectionStateUnspecified
    DELETE_PROTECTION_STATE_UNSPECIFIED

    The default value. Delete protection type is not specified

    DeleteProtectionDisabled
    DELETE_PROTECTION_DISABLED

    Delete protection is disabled

    DeleteProtectionEnabled
    DELETE_PROTECTION_ENABLED

    Delete protection is enabled

    DELETE_PROTECTION_STATE_UNSPECIFIED
    DELETE_PROTECTION_STATE_UNSPECIFIED

    The default value. Delete protection type is not specified

    DELETE_PROTECTION_DISABLED
    DELETE_PROTECTION_DISABLED

    Delete protection is disabled

    DELETE_PROTECTION_ENABLED
    DELETE_PROTECTION_ENABLED

    Delete protection is enabled

    "DELETE_PROTECTION_STATE_UNSPECIFIED"
    DELETE_PROTECTION_STATE_UNSPECIFIED

    The default value. Delete protection type is not specified

    "DELETE_PROTECTION_DISABLED"
    DELETE_PROTECTION_DISABLED

    Delete protection is disabled

    "DELETE_PROTECTION_ENABLED"
    DELETE_PROTECTION_ENABLED

    Delete protection is enabled

    DatabasePointInTimeRecoveryEnablement, DatabasePointInTimeRecoveryEnablementArgs

    PointInTimeRecoveryEnablementUnspecified
    POINT_IN_TIME_RECOVERY_ENABLEMENT_UNSPECIFIED

    Not used.

    PointInTimeRecoveryEnabled
    POINT_IN_TIME_RECOVERY_ENABLED

    Reads are supported on selected versions of the data from within the past 7 days: * Reads against any timestamp within the past hour * Reads against 1-minute snapshots beyond 1 hour and within 7 days version_retention_period and earliest_version_time can be used to determine the supported versions.

    PointInTimeRecoveryDisabled
    POINT_IN_TIME_RECOVERY_DISABLED

    Reads are supported on any version of the data from within the past 1 hour.

    DatabasePointInTimeRecoveryEnablementPointInTimeRecoveryEnablementUnspecified
    POINT_IN_TIME_RECOVERY_ENABLEMENT_UNSPECIFIED

    Not used.

    DatabasePointInTimeRecoveryEnablementPointInTimeRecoveryEnabled
    POINT_IN_TIME_RECOVERY_ENABLED

    Reads are supported on selected versions of the data from within the past 7 days: * Reads against any timestamp within the past hour * Reads against 1-minute snapshots beyond 1 hour and within 7 days version_retention_period and earliest_version_time can be used to determine the supported versions.

    DatabasePointInTimeRecoveryEnablementPointInTimeRecoveryDisabled
    POINT_IN_TIME_RECOVERY_DISABLED

    Reads are supported on any version of the data from within the past 1 hour.

    PointInTimeRecoveryEnablementUnspecified
    POINT_IN_TIME_RECOVERY_ENABLEMENT_UNSPECIFIED

    Not used.

    PointInTimeRecoveryEnabled
    POINT_IN_TIME_RECOVERY_ENABLED

    Reads are supported on selected versions of the data from within the past 7 days: * Reads against any timestamp within the past hour * Reads against 1-minute snapshots beyond 1 hour and within 7 days version_retention_period and earliest_version_time can be used to determine the supported versions.

    PointInTimeRecoveryDisabled
    POINT_IN_TIME_RECOVERY_DISABLED

    Reads are supported on any version of the data from within the past 1 hour.

    PointInTimeRecoveryEnablementUnspecified
    POINT_IN_TIME_RECOVERY_ENABLEMENT_UNSPECIFIED

    Not used.

    PointInTimeRecoveryEnabled
    POINT_IN_TIME_RECOVERY_ENABLED

    Reads are supported on selected versions of the data from within the past 7 days: * Reads against any timestamp within the past hour * Reads against 1-minute snapshots beyond 1 hour and within 7 days version_retention_period and earliest_version_time can be used to determine the supported versions.

    PointInTimeRecoveryDisabled
    POINT_IN_TIME_RECOVERY_DISABLED

    Reads are supported on any version of the data from within the past 1 hour.

    POINT_IN_TIME_RECOVERY_ENABLEMENT_UNSPECIFIED
    POINT_IN_TIME_RECOVERY_ENABLEMENT_UNSPECIFIED

    Not used.

    POINT_IN_TIME_RECOVERY_ENABLED
    POINT_IN_TIME_RECOVERY_ENABLED

    Reads are supported on selected versions of the data from within the past 7 days: * Reads against any timestamp within the past hour * Reads against 1-minute snapshots beyond 1 hour and within 7 days version_retention_period and earliest_version_time can be used to determine the supported versions.

    POINT_IN_TIME_RECOVERY_DISABLED
    POINT_IN_TIME_RECOVERY_DISABLED

    Reads are supported on any version of the data from within the past 1 hour.

    "POINT_IN_TIME_RECOVERY_ENABLEMENT_UNSPECIFIED"
    POINT_IN_TIME_RECOVERY_ENABLEMENT_UNSPECIFIED

    Not used.

    "POINT_IN_TIME_RECOVERY_ENABLED"
    POINT_IN_TIME_RECOVERY_ENABLED

    Reads are supported on selected versions of the data from within the past 7 days: * Reads against any timestamp within the past hour * Reads against 1-minute snapshots beyond 1 hour and within 7 days version_retention_period and earliest_version_time can be used to determine the supported versions.

    "POINT_IN_TIME_RECOVERY_DISABLED"
    POINT_IN_TIME_RECOVERY_DISABLED

    Reads are supported on any version of the data from within the past 1 hour.

    DatabaseType, DatabaseTypeArgs

    DatabaseTypeUnspecified
    DATABASE_TYPE_UNSPECIFIED

    The default value. This value is used if the database type is omitted.

    FirestoreNative
    FIRESTORE_NATIVE

    Firestore Native Mode

    DatastoreMode
    DATASTORE_MODE

    Firestore in Datastore Mode.

    DatabaseTypeDatabaseTypeUnspecified
    DATABASE_TYPE_UNSPECIFIED

    The default value. This value is used if the database type is omitted.

    DatabaseTypeFirestoreNative
    FIRESTORE_NATIVE

    Firestore Native Mode

    DatabaseTypeDatastoreMode
    DATASTORE_MODE

    Firestore in Datastore Mode.

    DatabaseTypeUnspecified
    DATABASE_TYPE_UNSPECIFIED

    The default value. This value is used if the database type is omitted.

    FirestoreNative
    FIRESTORE_NATIVE

    Firestore Native Mode

    DatastoreMode
    DATASTORE_MODE

    Firestore in Datastore Mode.

    DatabaseTypeUnspecified
    DATABASE_TYPE_UNSPECIFIED

    The default value. This value is used if the database type is omitted.

    FirestoreNative
    FIRESTORE_NATIVE

    Firestore Native Mode

    DatastoreMode
    DATASTORE_MODE

    Firestore in Datastore Mode.

    DATABASE_TYPE_UNSPECIFIED
    DATABASE_TYPE_UNSPECIFIED

    The default value. This value is used if the database type is omitted.

    FIRESTORE_NATIVE
    FIRESTORE_NATIVE

    Firestore Native Mode

    DATASTORE_MODE
    DATASTORE_MODE

    Firestore in Datastore Mode.

    "DATABASE_TYPE_UNSPECIFIED"
    DATABASE_TYPE_UNSPECIFIED

    The default value. This value is used if the database type is omitted.

    "FIRESTORE_NATIVE"
    FIRESTORE_NATIVE

    Firestore Native Mode

    "DATASTORE_MODE"
    DATASTORE_MODE

    Firestore in Datastore Mode.

    Package Details

    Repository
    Google Cloud Native pulumi/pulumi-google-native
    License
    Apache-2.0
    google-native logo

    Google Cloud Native is in preview. Google Cloud Classic is fully supported.

    Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi