gcp logo
Google Cloud Classic v6.52.0, Mar 22 23

gcp.firestore.Database

A Cloud Firestore Database. Currently only one database is allowed per cloud project; this database must have a database_id of ‘(default)’.

To get more information about Database, see:

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[str] = None,
             concurrency_mode: Optional[str] = None,
             location_id: Optional[str] = None,
             name: Optional[str] = None,
             project: Optional[str] = None,
             type: Optional[str] = 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: gcp:firestore: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:

LocationId string

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

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 are FIRESTORE_NATIVE and DATASTORE_MODE.

AppEngineIntegrationMode string

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

ConcurrencyMode string

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

Name 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][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.

Project string

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

LocationId string

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

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 are FIRESTORE_NATIVE and DATASTORE_MODE.

AppEngineIntegrationMode string

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

ConcurrencyMode string

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

Name 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][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.

Project string

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

locationId String

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

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 are FIRESTORE_NATIVE and DATASTORE_MODE.

appEngineIntegrationMode String

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

concurrencyMode String

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

name 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][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.

project String

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

locationId string

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

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 are FIRESTORE_NATIVE and DATASTORE_MODE.

appEngineIntegrationMode string

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

concurrencyMode string

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

name 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][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.

project string

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

location_id str

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

type str

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 and DATASTORE_MODE.

app_engine_integration_mode str

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

concurrency_mode str

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

name 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][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.

project str

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

locationId String

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

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 are FIRESTORE_NATIVE and DATASTORE_MODE.

appEngineIntegrationMode String

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

concurrencyMode String

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

name 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][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.

project String

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

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.

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.

Id string

The provider-assigned unique ID for this managed resource.

KeyPrefix 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 project_id (eg: foo instead of v~foo).

CreateTime string

The timestamp at which this database was created.

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.

Id string

The provider-assigned unique ID for this managed resource.

KeyPrefix 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 project_id (eg: foo instead of v~foo).

createTime String

The timestamp at which this database was created.

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.

id String

The provider-assigned unique ID for this managed resource.

keyPrefix 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 project_id (eg: foo instead of v~foo).

createTime string

The timestamp at which this database was created.

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.

id string

The provider-assigned unique ID for this managed resource.

keyPrefix 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 project_id (eg: foo instead of v~foo).

create_time str

The timestamp at which this database was created.

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.

id str

The provider-assigned unique ID for this managed resource.

key_prefix str

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 project_id (eg: foo instead of v~foo).

createTime String

The timestamp at which this database was created.

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.

id String

The provider-assigned unique ID for this managed resource.

keyPrefix 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 project_id (eg: foo instead of v~foo).

Look up Existing Database Resource

Get an existing Database resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: DatabaseState, opts?: CustomResourceOptions): Database
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        app_engine_integration_mode: Optional[str] = None,
        concurrency_mode: Optional[str] = None,
        create_time: Optional[str] = None,
        etag: Optional[str] = None,
        key_prefix: Optional[str] = None,
        location_id: Optional[str] = None,
        name: Optional[str] = None,
        project: Optional[str] = None,
        type: Optional[str] = None) -> Database
func GetDatabase(ctx *Context, name string, id IDInput, state *DatabaseState, opts ...ResourceOption) (*Database, error)
public static Database Get(string name, Input<string> id, DatabaseState? state, CustomResourceOptions? opts = null)
public static Database get(String name, Output<String> id, DatabaseState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
AppEngineIntegrationMode string

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

ConcurrencyMode string

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

CreateTime string

The timestamp at which this database was created.

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.

KeyPrefix 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 project_id (eg: foo instead of v~foo).

LocationId string

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

Name 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][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.

Project string

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

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 are FIRESTORE_NATIVE and DATASTORE_MODE.

AppEngineIntegrationMode string

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

ConcurrencyMode string

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

CreateTime string

The timestamp at which this database was created.

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.

KeyPrefix 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 project_id (eg: foo instead of v~foo).

LocationId string

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

Name 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][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.

Project string

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

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 are FIRESTORE_NATIVE and DATASTORE_MODE.

appEngineIntegrationMode String

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

concurrencyMode String

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

createTime String

The timestamp at which this database was created.

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.

keyPrefix 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 project_id (eg: foo instead of v~foo).

locationId String

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

name 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][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.

project String

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

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 are FIRESTORE_NATIVE and DATASTORE_MODE.

appEngineIntegrationMode string

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

concurrencyMode string

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

createTime string

The timestamp at which this database was created.

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.

keyPrefix 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 project_id (eg: foo instead of v~foo).

locationId string

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

name 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][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.

project string

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

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 are FIRESTORE_NATIVE and DATASTORE_MODE.

app_engine_integration_mode str

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

concurrency_mode str

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

create_time str

The timestamp at which this database was created.

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.

key_prefix str

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 project_id (eg: foo instead of v~foo).

location_id str

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

name 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][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.

project str

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

type str

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 and DATASTORE_MODE.

appEngineIntegrationMode String

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

concurrencyMode String

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

createTime String

The timestamp at which this database was created.

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.

keyPrefix 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 project_id (eg: foo instead of v~foo).

locationId String

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

name 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][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.

project String

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

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 are FIRESTORE_NATIVE and DATASTORE_MODE.

Import

Database can be imported using any of these accepted formats

 $ pulumi import gcp:firestore/database:Database default projects/{{project}}/databases/{{name}}
 $ pulumi import gcp:firestore/database:Database default {{project}}/{{name}}
 $ pulumi import gcp:firestore/database:Database default {{name}}

Package Details

Repository
Google Cloud (GCP) Classic pulumi/pulumi-gcp
License
Apache-2.0
Notes

This Pulumi package is based on the google-beta Terraform Provider.