Google Cloud Native v0.30.0, Apr 14 23
Google Cloud Native v0.30.0, Apr 14 23
google-native.firestore/v1.Database
Explore with Pulumi AI
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,
etag: Optional[str] = None,
location: Optional[str] = None,
name: Optional[str] = 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:
- Database
Id string Required. The ID to use for the database, which will become the final component of the database's resource name. The value must be set to "(default)".
- App
Engine Pulumi.Integration Mode Google Native. Firestore. V1. Database App Engine Integration Mode The App Engine integration mode to use for this database.
- Concurrency
Mode Pulumi.Google Native. Firestore. V1. Database Concurrency Mode The concurrency control mode to use for this 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 databases are listed at https://cloud.google.com/firestore/docs/locations.
- Name string
The resource name of the Database. Format:
projects/{project}/databases/{database}
- Project string
- Type
Pulumi.
Google Native. Firestore. V1. Database Type The type of the database. See https://cloud.google.com/datastore/docs/firestore-or-datastore for information about how to choose.
- Database
Id string Required. The ID to use for the database, which will become the final component of the database's resource name. The value must be set to "(default)".
- App
Engine DatabaseIntegration Mode App Engine Integration Mode The App Engine integration mode to use for this database.
- Concurrency
Mode DatabaseConcurrency Mode The concurrency control mode to use for this 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 databases are listed at https://cloud.google.com/firestore/docs/locations.
- Name string
The resource name of the Database. Format:
projects/{project}/databases/{database}
- Project string
- Type
Database
Type The type of the database. See https://cloud.google.com/datastore/docs/firestore-or-datastore for information about how to choose.
- database
Id String Required. The ID to use for the database, which will become the final component of the database's resource name. The value must be set to "(default)".
- app
Engine DatabaseIntegration Mode App Engine Integration Mode The App Engine integration mode to use for this database.
- concurrency
Mode DatabaseConcurrency Mode The concurrency control mode to use for this 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 databases are listed at https://cloud.google.com/firestore/docs/locations.
- name String
The resource name of the Database. Format:
projects/{project}/databases/{database}
- project String
- type
Database
Type The type of the database. See https://cloud.google.com/datastore/docs/firestore-or-datastore for information about how to choose.
- database
Id string Required. The ID to use for the database, which will become the final component of the database's resource name. The value must be set to "(default)".
- app
Engine DatabaseIntegration Mode App Engine Integration Mode The App Engine integration mode to use for this database.
- concurrency
Mode DatabaseConcurrency Mode The concurrency control mode to use for this 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 databases are listed at https://cloud.google.com/firestore/docs/locations.
- name string
The resource name of the Database. Format:
projects/{project}/databases/{database}
- project string
- type
Database
Type 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. The value must be set to "(default)".
- app_
engine_ Databaseintegration_ mode App Engine Integration Mode The App Engine integration mode to use for this database.
- concurrency_
mode DatabaseConcurrency Mode The concurrency control mode to use for this 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 databases are listed at https://cloud.google.com/firestore/docs/locations.
- name str
The resource name of the Database. Format:
projects/{project}/databases/{database}
- project str
- type
Database
Type The type of the database. See https://cloud.google.com/datastore/docs/firestore-or-datastore for information about how to choose.
- database
Id String Required. The ID to use for the database, which will become the final component of the database's resource name. The value must be set to "(default)".
- app
Engine "APP_ENGINE_INTEGRATION_MODE_UNSPECIFIED" | "ENABLED" | "DISABLED"Integration Mode The App Engine integration mode to use for this database.
- concurrency
Mode "CONCURRENCY_MODE_UNSPECIFIED" | "OPTIMISTIC" | "PESSIMISTIC" | "OPTIMISTIC_WITH_ENTITY_GROUPS" The concurrency control mode to use for this 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 databases are listed at https://cloud.google.com/firestore/docs/locations.
- name String
The resource name of the Database. Format:
projects/{project}/databases/{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:
- Create
Time string The timestamp at which this database was created.
- Id string
The provider-assigned unique ID for this managed resource.
- Key
Prefix 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.
- Update
Time 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.
- Create
Time string The timestamp at which this database was created.
- Id string
The provider-assigned unique ID for this managed resource.
- Key
Prefix 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.
- Update
Time 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.
- create
Time String The timestamp at which this database was created.
- id String
The provider-assigned unique ID for this managed resource.
- key
Prefix 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.
- update
Time 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.
- create
Time string The timestamp at which this database was created.
- id string
The provider-assigned unique ID for this managed resource.
- key
Prefix 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.
- update
Time 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.
- create_
time str The timestamp at which this database was created.
- 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.
- create
Time String The timestamp at which this database was created.
- id String
The provider-assigned unique ID for this managed resource.
- key
Prefix 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.
- update
Time 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.
Supporting Types
DatabaseAppEngineIntegrationMode
- 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.
- Database
App Engine Integration Mode App Engine Integration Mode Unspecified - APP_ENGINE_INTEGRATION_MODE_UNSPECIFIED
Not used.
- Database
App Engine Integration Mode 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.
- Database
App Engine Integration Mode 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.
- 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
- 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.
- Database
Concurrency Mode Concurrency Mode Unspecified - CONCURRENCY_MODE_UNSPECIFIED
Not used.
- Database
Concurrency Mode Optimistic - OPTIMISTIC
Use optimistic concurrency control by default. This mode is available for Cloud Firestore databases.
- Database
Concurrency Mode Pessimistic - PESSIMISTIC
Use pessimistic concurrency control by default. This mode is available for Cloud Firestore databases. This is the default setting for Cloud Firestore.
- Database
Concurrency Mode 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.
- 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.
- "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.
DatabaseType
- 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 Database Type Unspecified - DATABASE_TYPE_UNSPECIFIED
The default value. This value is used if the database type is omitted.
- Database
Type Firestore Native - FIRESTORE_NATIVE
Firestore Native Mode
- Database
Type 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.
- 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.
- "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