Database class

Create a database.

Constructors

Database(String name, {DatabaseArgs? args, CustomResourceOptions? options})
Creates a new Database. name The Pulumi resource name. args Arguments used to configure this Database. The set of arguments for Database. options Resource options controlling this resource's behavior.

Properties

appEngineIntegrationMode ↔ Output<String>
The App Engine integration mode to use for this database.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
concurrencyMode ↔ Output<String>
The concurrency control mode to use for this database.
latefinal
createTime ↔ Output<String>
The timestamp at which this database was created. Databases created before 2016 do not populate create_time.
latefinal
databaseId ↔ Output<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.
latefinal
deleteProtectionState ↔ Output<String>
State of delete protection for the database.
latefinal
earliestVersionTime ↔ Output<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.
latefinal
etag ↔ Output<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.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
keyPrefix ↔ Output<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 vfoo).
latefinal
location ↔ Output<String>
The location of the database. Available locations are listed at https://cloud.google.com/firestore/docs/locations.
latefinal
name ↔ Output<String>
The resource name of the Database. Format: projects/{project}/databases/{database}
latefinal
pointInTimeRecoveryEnablement ↔ Output<String>
Whether to enable the PITR feature on this database.
latefinal
project ↔ Output<String>
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
type ↔ Output<String>
The type of the database. See https://cloud.google.com/datastore/docs/firestore-or-datastore for information about how to choose.
latefinal
uid ↔ Output<String>
The system-generated UUID4 for this Database.
latefinal
updateTime ↔ Output<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.
latefinal
urn ↔ Output<String>
latefinalinherited
versionRetentionPeriod ↔ Output<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.
latefinal

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited