1. Packages
  2. Google Cloud Native
  3. API Docs
  4. spanner
  5. spanner/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.spanner/v1.Database

Explore with Pulumi AI

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

Creates a new Cloud Spanner database and starts to prepare it for serving. The returned long-running operation will have a name of the format /operations/ and can be used to track preparation of the database. The metadata field type is CreateDatabaseMetadata. The response field type is Database, if successful. Auto-naming is currently not supported for this resource.

Create Database Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Database(name: string, args: DatabaseArgs, opts?: CustomResourceOptions);
@overload
def Database(resource_name: str,
             args: DatabaseArgs,
             opts: Optional[ResourceOptions] = None)

@overload
def Database(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             create_statement: Optional[str] = None,
             instance_id: Optional[str] = None,
             database_dialect: Optional[DatabaseDatabaseDialect] = None,
             encryption_config: Optional[EncryptionConfigArgs] = None,
             extra_statements: Optional[Sequence[str]] = None,
             project: Optional[str] = None,
             proto_descriptors: Optional[str] = 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:spanner/v1:Database
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. DatabaseArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. 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 This property is required. string
The unique name of the resource.
args This property is required. DatabaseArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. DatabaseArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. DatabaseArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var exampledatabaseResourceResourceFromSpannerv1 = new GoogleNative.Spanner.V1.Database("exampledatabaseResourceResourceFromSpannerv1", new()
{
    CreateStatement = "string",
    InstanceId = "string",
    DatabaseDialect = GoogleNative.Spanner.V1.DatabaseDatabaseDialect.DatabaseDialectUnspecified,
    EncryptionConfig = new GoogleNative.Spanner.V1.Inputs.EncryptionConfigArgs
    {
        KmsKeyName = "string",
    },
    ExtraStatements = new[]
    {
        "string",
    },
    Project = "string",
    ProtoDescriptors = "string",
});
Copy
example, err := spanner.NewDatabase(ctx, "exampledatabaseResourceResourceFromSpannerv1", &spanner.DatabaseArgs{
	CreateStatement: pulumi.String("string"),
	InstanceId:      pulumi.String("string"),
	DatabaseDialect: spanner.DatabaseDatabaseDialectDatabaseDialectUnspecified,
	EncryptionConfig: &spanner.EncryptionConfigArgs{
		KmsKeyName: pulumi.String("string"),
	},
	ExtraStatements: pulumi.StringArray{
		pulumi.String("string"),
	},
	Project:          pulumi.String("string"),
	ProtoDescriptors: pulumi.String("string"),
})
Copy
var exampledatabaseResourceResourceFromSpannerv1 = new Database("exampledatabaseResourceResourceFromSpannerv1", DatabaseArgs.builder()
    .createStatement("string")
    .instanceId("string")
    .databaseDialect("DATABASE_DIALECT_UNSPECIFIED")
    .encryptionConfig(EncryptionConfigArgs.builder()
        .kmsKeyName("string")
        .build())
    .extraStatements("string")
    .project("string")
    .protoDescriptors("string")
    .build());
Copy
exampledatabase_resource_resource_from_spannerv1 = google_native.spanner.v1.Database("exampledatabaseResourceResourceFromSpannerv1",
    create_statement="string",
    instance_id="string",
    database_dialect=google_native.spanner.v1.DatabaseDatabaseDialect.DATABASE_DIALECT_UNSPECIFIED,
    encryption_config={
        "kms_key_name": "string",
    },
    extra_statements=["string"],
    project="string",
    proto_descriptors="string")
Copy
const exampledatabaseResourceResourceFromSpannerv1 = new google_native.spanner.v1.Database("exampledatabaseResourceResourceFromSpannerv1", {
    createStatement: "string",
    instanceId: "string",
    databaseDialect: google_native.spanner.v1.DatabaseDatabaseDialect.DatabaseDialectUnspecified,
    encryptionConfig: {
        kmsKeyName: "string",
    },
    extraStatements: ["string"],
    project: "string",
    protoDescriptors: "string",
});
Copy
type: google-native:spanner/v1:Database
properties:
    createStatement: string
    databaseDialect: DATABASE_DIALECT_UNSPECIFIED
    encryptionConfig:
        kmsKeyName: string
    extraStatements:
        - string
    instanceId: string
    project: string
    protoDescriptors: string
Copy

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

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Database resource accepts the following input properties:

CreateStatement This property is required. string
A CREATE DATABASE statement, which specifies the ID of the new database. The database ID must conform to the regular expression a-z*[a-z0-9] and be between 2 and 30 characters in length. If the database ID is a reserved word or if it contains a hyphen, the database ID must be enclosed in backticks (`).
InstanceId
This property is required.
Changes to this property will trigger replacement.
string
DatabaseDialect Pulumi.GoogleNative.Spanner.V1.DatabaseDatabaseDialect
Optional. The dialect of the Cloud Spanner Database.
EncryptionConfig Pulumi.GoogleNative.Spanner.V1.Inputs.EncryptionConfig
Optional. The encryption configuration for the database. If this field is not specified, Cloud Spanner will encrypt/decrypt all data at rest using Google default encryption.
ExtraStatements List<string>
Optional. A list of DDL statements to run inside the newly created database. Statements can create tables, indexes, etc. These statements execute atomically with the creation of the database: if there is an error in any statement, the database is not created.
Project Changes to this property will trigger replacement. string
ProtoDescriptors string
Optional. Proto descriptors used by CREATE/ALTER PROTO BUNDLE statements in 'extra_statements' above. Contains a protobuf-serialized google.protobuf.FileDescriptorSet. To generate it, install and run protoc with --include_imports and --descriptor_set_out. For example, to generate for moon/shot/app.proto, run """ $protoc --proto_path=/app_path --proto_path=/lib_path \ --include_imports \ --descriptor_set_out=descriptors.data \ moon/shot/app.proto """ For more details, see protobuffer self description.
CreateStatement This property is required. string
A CREATE DATABASE statement, which specifies the ID of the new database. The database ID must conform to the regular expression a-z*[a-z0-9] and be between 2 and 30 characters in length. If the database ID is a reserved word or if it contains a hyphen, the database ID must be enclosed in backticks (`).
InstanceId
This property is required.
Changes to this property will trigger replacement.
string
DatabaseDialect DatabaseDatabaseDialect
Optional. The dialect of the Cloud Spanner Database.
EncryptionConfig EncryptionConfigArgs
Optional. The encryption configuration for the database. If this field is not specified, Cloud Spanner will encrypt/decrypt all data at rest using Google default encryption.
ExtraStatements []string
Optional. A list of DDL statements to run inside the newly created database. Statements can create tables, indexes, etc. These statements execute atomically with the creation of the database: if there is an error in any statement, the database is not created.
Project Changes to this property will trigger replacement. string
ProtoDescriptors string
Optional. Proto descriptors used by CREATE/ALTER PROTO BUNDLE statements in 'extra_statements' above. Contains a protobuf-serialized google.protobuf.FileDescriptorSet. To generate it, install and run protoc with --include_imports and --descriptor_set_out. For example, to generate for moon/shot/app.proto, run """ $protoc --proto_path=/app_path --proto_path=/lib_path \ --include_imports \ --descriptor_set_out=descriptors.data \ moon/shot/app.proto """ For more details, see protobuffer self description.
createStatement This property is required. String
A CREATE DATABASE statement, which specifies the ID of the new database. The database ID must conform to the regular expression a-z*[a-z0-9] and be between 2 and 30 characters in length. If the database ID is a reserved word or if it contains a hyphen, the database ID must be enclosed in backticks (`).
instanceId
This property is required.
Changes to this property will trigger replacement.
String
databaseDialect DatabaseDatabaseDialect
Optional. The dialect of the Cloud Spanner Database.
encryptionConfig EncryptionConfig
Optional. The encryption configuration for the database. If this field is not specified, Cloud Spanner will encrypt/decrypt all data at rest using Google default encryption.
extraStatements List<String>
Optional. A list of DDL statements to run inside the newly created database. Statements can create tables, indexes, etc. These statements execute atomically with the creation of the database: if there is an error in any statement, the database is not created.
project Changes to this property will trigger replacement. String
protoDescriptors String
Optional. Proto descriptors used by CREATE/ALTER PROTO BUNDLE statements in 'extra_statements' above. Contains a protobuf-serialized google.protobuf.FileDescriptorSet. To generate it, install and run protoc with --include_imports and --descriptor_set_out. For example, to generate for moon/shot/app.proto, run """ $protoc --proto_path=/app_path --proto_path=/lib_path \ --include_imports \ --descriptor_set_out=descriptors.data \ moon/shot/app.proto """ For more details, see protobuffer self description.
createStatement This property is required. string
A CREATE DATABASE statement, which specifies the ID of the new database. The database ID must conform to the regular expression a-z*[a-z0-9] and be between 2 and 30 characters in length. If the database ID is a reserved word or if it contains a hyphen, the database ID must be enclosed in backticks (`).
instanceId
This property is required.
Changes to this property will trigger replacement.
string
databaseDialect DatabaseDatabaseDialect
Optional. The dialect of the Cloud Spanner Database.
encryptionConfig EncryptionConfig
Optional. The encryption configuration for the database. If this field is not specified, Cloud Spanner will encrypt/decrypt all data at rest using Google default encryption.
extraStatements string[]
Optional. A list of DDL statements to run inside the newly created database. Statements can create tables, indexes, etc. These statements execute atomically with the creation of the database: if there is an error in any statement, the database is not created.
project Changes to this property will trigger replacement. string
protoDescriptors string
Optional. Proto descriptors used by CREATE/ALTER PROTO BUNDLE statements in 'extra_statements' above. Contains a protobuf-serialized google.protobuf.FileDescriptorSet. To generate it, install and run protoc with --include_imports and --descriptor_set_out. For example, to generate for moon/shot/app.proto, run """ $protoc --proto_path=/app_path --proto_path=/lib_path \ --include_imports \ --descriptor_set_out=descriptors.data \ moon/shot/app.proto """ For more details, see protobuffer self description.
create_statement This property is required. str
A CREATE DATABASE statement, which specifies the ID of the new database. The database ID must conform to the regular expression a-z*[a-z0-9] and be between 2 and 30 characters in length. If the database ID is a reserved word or if it contains a hyphen, the database ID must be enclosed in backticks (`).
instance_id
This property is required.
Changes to this property will trigger replacement.
str
database_dialect DatabaseDatabaseDialect
Optional. The dialect of the Cloud Spanner Database.
encryption_config EncryptionConfigArgs
Optional. The encryption configuration for the database. If this field is not specified, Cloud Spanner will encrypt/decrypt all data at rest using Google default encryption.
extra_statements Sequence[str]
Optional. A list of DDL statements to run inside the newly created database. Statements can create tables, indexes, etc. These statements execute atomically with the creation of the database: if there is an error in any statement, the database is not created.
project Changes to this property will trigger replacement. str
proto_descriptors str
Optional. Proto descriptors used by CREATE/ALTER PROTO BUNDLE statements in 'extra_statements' above. Contains a protobuf-serialized google.protobuf.FileDescriptorSet. To generate it, install and run protoc with --include_imports and --descriptor_set_out. For example, to generate for moon/shot/app.proto, run """ $protoc --proto_path=/app_path --proto_path=/lib_path \ --include_imports \ --descriptor_set_out=descriptors.data \ moon/shot/app.proto """ For more details, see protobuffer self description.
createStatement This property is required. String
A CREATE DATABASE statement, which specifies the ID of the new database. The database ID must conform to the regular expression a-z*[a-z0-9] and be between 2 and 30 characters in length. If the database ID is a reserved word or if it contains a hyphen, the database ID must be enclosed in backticks (`).
instanceId
This property is required.
Changes to this property will trigger replacement.
String
databaseDialect "DATABASE_DIALECT_UNSPECIFIED" | "GOOGLE_STANDARD_SQL" | "POSTGRESQL"
Optional. The dialect of the Cloud Spanner Database.
encryptionConfig Property Map
Optional. The encryption configuration for the database. If this field is not specified, Cloud Spanner will encrypt/decrypt all data at rest using Google default encryption.
extraStatements List<String>
Optional. A list of DDL statements to run inside the newly created database. Statements can create tables, indexes, etc. These statements execute atomically with the creation of the database: if there is an error in any statement, the database is not created.
project Changes to this property will trigger replacement. String
protoDescriptors String
Optional. Proto descriptors used by CREATE/ALTER PROTO BUNDLE statements in 'extra_statements' above. Contains a protobuf-serialized google.protobuf.FileDescriptorSet. To generate it, install and run protoc with --include_imports and --descriptor_set_out. For example, to generate for moon/shot/app.proto, run """ $protoc --proto_path=/app_path --proto_path=/lib_path \ --include_imports \ --descriptor_set_out=descriptors.data \ moon/shot/app.proto """ For more details, see protobuffer self description.

Outputs

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

CreateTime string
If exists, the time at which the database creation started.
DefaultLeader string
The read-write region which contains the database's leader replicas. This is the same as the value of default_leader database option set using DatabaseAdmin.CreateDatabase or DatabaseAdmin.UpdateDatabaseDdl. If not explicitly set, this is empty.
EarliestVersionTime string
Earliest timestamp at which older versions of the data can be read. This value is continuously updated by Cloud Spanner 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.
EnableDropProtection bool
Whether drop protection is enabled for this database. Defaults to false, if not set. For more details, please see how to prevent accidental database deletion.
EncryptionInfo List<Pulumi.GoogleNative.Spanner.V1.Outputs.EncryptionInfoResponse>
For databases that are using customer managed encryption, this field contains the encryption information for the database, such as all Cloud KMS key versions that are in use. The encryption_status' field inside of each EncryptionInfo` is not populated. For databases that are using Google default or other types of encryption, this field is empty. This field is propagated lazily from the backend. There might be a delay from when a key version is being used and when it appears in this field.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the database. Values are of the form projects//instances//databases/, where `` is as specified in the CREATE DATABASE statement. This name can be passed to other API methods to identify the database.
Reconciling bool
If true, the database is being updated. If false, there are no ongoing update operations for the database.
RestoreInfo Pulumi.GoogleNative.Spanner.V1.Outputs.RestoreInfoResponse
Applicable only for restored databases. Contains information about the restore source.
State string
The current database state.
VersionRetentionPeriod string
The period in which Cloud Spanner retains all versions of data for the database. This is the same as the value of version_retention_period database option set using UpdateDatabaseDdl. Defaults to 1 hour, if not set.
CreateTime string
If exists, the time at which the database creation started.
DefaultLeader string
The read-write region which contains the database's leader replicas. This is the same as the value of default_leader database option set using DatabaseAdmin.CreateDatabase or DatabaseAdmin.UpdateDatabaseDdl. If not explicitly set, this is empty.
EarliestVersionTime string
Earliest timestamp at which older versions of the data can be read. This value is continuously updated by Cloud Spanner 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.
EnableDropProtection bool
Whether drop protection is enabled for this database. Defaults to false, if not set. For more details, please see how to prevent accidental database deletion.
EncryptionInfo []EncryptionInfoResponse
For databases that are using customer managed encryption, this field contains the encryption information for the database, such as all Cloud KMS key versions that are in use. The encryption_status' field inside of each EncryptionInfo` is not populated. For databases that are using Google default or other types of encryption, this field is empty. This field is propagated lazily from the backend. There might be a delay from when a key version is being used and when it appears in this field.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the database. Values are of the form projects//instances//databases/, where `` is as specified in the CREATE DATABASE statement. This name can be passed to other API methods to identify the database.
Reconciling bool
If true, the database is being updated. If false, there are no ongoing update operations for the database.
RestoreInfo RestoreInfoResponse
Applicable only for restored databases. Contains information about the restore source.
State string
The current database state.
VersionRetentionPeriod string
The period in which Cloud Spanner retains all versions of data for the database. This is the same as the value of version_retention_period database option set using UpdateDatabaseDdl. Defaults to 1 hour, if not set.
createTime String
If exists, the time at which the database creation started.
defaultLeader String
The read-write region which contains the database's leader replicas. This is the same as the value of default_leader database option set using DatabaseAdmin.CreateDatabase or DatabaseAdmin.UpdateDatabaseDdl. If not explicitly set, this is empty.
earliestVersionTime String
Earliest timestamp at which older versions of the data can be read. This value is continuously updated by Cloud Spanner 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.
enableDropProtection Boolean
Whether drop protection is enabled for this database. Defaults to false, if not set. For more details, please see how to prevent accidental database deletion.
encryptionInfo List<EncryptionInfoResponse>
For databases that are using customer managed encryption, this field contains the encryption information for the database, such as all Cloud KMS key versions that are in use. The encryption_status' field inside of each EncryptionInfo` is not populated. For databases that are using Google default or other types of encryption, this field is empty. This field is propagated lazily from the backend. There might be a delay from when a key version is being used and when it appears in this field.
id String
The provider-assigned unique ID for this managed resource.
name String
The name of the database. Values are of the form projects//instances//databases/, where `` is as specified in the CREATE DATABASE statement. This name can be passed to other API methods to identify the database.
reconciling Boolean
If true, the database is being updated. If false, there are no ongoing update operations for the database.
restoreInfo RestoreInfoResponse
Applicable only for restored databases. Contains information about the restore source.
state String
The current database state.
versionRetentionPeriod String
The period in which Cloud Spanner retains all versions of data for the database. This is the same as the value of version_retention_period database option set using UpdateDatabaseDdl. Defaults to 1 hour, if not set.
createTime string
If exists, the time at which the database creation started.
defaultLeader string
The read-write region which contains the database's leader replicas. This is the same as the value of default_leader database option set using DatabaseAdmin.CreateDatabase or DatabaseAdmin.UpdateDatabaseDdl. If not explicitly set, this is empty.
earliestVersionTime string
Earliest timestamp at which older versions of the data can be read. This value is continuously updated by Cloud Spanner 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.
enableDropProtection boolean
Whether drop protection is enabled for this database. Defaults to false, if not set. For more details, please see how to prevent accidental database deletion.
encryptionInfo EncryptionInfoResponse[]
For databases that are using customer managed encryption, this field contains the encryption information for the database, such as all Cloud KMS key versions that are in use. The encryption_status' field inside of each EncryptionInfo` is not populated. For databases that are using Google default or other types of encryption, this field is empty. This field is propagated lazily from the backend. There might be a delay from when a key version is being used and when it appears in this field.
id string
The provider-assigned unique ID for this managed resource.
name string
The name of the database. Values are of the form projects//instances//databases/, where `` is as specified in the CREATE DATABASE statement. This name can be passed to other API methods to identify the database.
reconciling boolean
If true, the database is being updated. If false, there are no ongoing update operations for the database.
restoreInfo RestoreInfoResponse
Applicable only for restored databases. Contains information about the restore source.
state string
The current database state.
versionRetentionPeriod string
The period in which Cloud Spanner retains all versions of data for the database. This is the same as the value of version_retention_period database option set using UpdateDatabaseDdl. Defaults to 1 hour, if not set.
create_time str
If exists, the time at which the database creation started.
default_leader str
The read-write region which contains the database's leader replicas. This is the same as the value of default_leader database option set using DatabaseAdmin.CreateDatabase or DatabaseAdmin.UpdateDatabaseDdl. If not explicitly set, this is empty.
earliest_version_time str
Earliest timestamp at which older versions of the data can be read. This value is continuously updated by Cloud Spanner 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.
enable_drop_protection bool
Whether drop protection is enabled for this database. Defaults to false, if not set. For more details, please see how to prevent accidental database deletion.
encryption_info Sequence[EncryptionInfoResponse]
For databases that are using customer managed encryption, this field contains the encryption information for the database, such as all Cloud KMS key versions that are in use. The encryption_status' field inside of each EncryptionInfo` is not populated. For databases that are using Google default or other types of encryption, this field is empty. This field is propagated lazily from the backend. There might be a delay from when a key version is being used and when it appears in this field.
id str
The provider-assigned unique ID for this managed resource.
name str
The name of the database. Values are of the form projects//instances//databases/, where `` is as specified in the CREATE DATABASE statement. This name can be passed to other API methods to identify the database.
reconciling bool
If true, the database is being updated. If false, there are no ongoing update operations for the database.
restore_info RestoreInfoResponse
Applicable only for restored databases. Contains information about the restore source.
state str
The current database state.
version_retention_period str
The period in which Cloud Spanner retains all versions of data for the database. This is the same as the value of version_retention_period database option set using UpdateDatabaseDdl. Defaults to 1 hour, if not set.
createTime String
If exists, the time at which the database creation started.
defaultLeader String
The read-write region which contains the database's leader replicas. This is the same as the value of default_leader database option set using DatabaseAdmin.CreateDatabase or DatabaseAdmin.UpdateDatabaseDdl. If not explicitly set, this is empty.
earliestVersionTime String
Earliest timestamp at which older versions of the data can be read. This value is continuously updated by Cloud Spanner 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.
enableDropProtection Boolean
Whether drop protection is enabled for this database. Defaults to false, if not set. For more details, please see how to prevent accidental database deletion.
encryptionInfo List<Property Map>
For databases that are using customer managed encryption, this field contains the encryption information for the database, such as all Cloud KMS key versions that are in use. The encryption_status' field inside of each EncryptionInfo` is not populated. For databases that are using Google default or other types of encryption, this field is empty. This field is propagated lazily from the backend. There might be a delay from when a key version is being used and when it appears in this field.
id String
The provider-assigned unique ID for this managed resource.
name String
The name of the database. Values are of the form projects//instances//databases/, where `` is as specified in the CREATE DATABASE statement. This name can be passed to other API methods to identify the database.
reconciling Boolean
If true, the database is being updated. If false, there are no ongoing update operations for the database.
restoreInfo Property Map
Applicable only for restored databases. Contains information about the restore source.
state String
The current database state.
versionRetentionPeriod String
The period in which Cloud Spanner retains all versions of data for the database. This is the same as the value of version_retention_period database option set using UpdateDatabaseDdl. Defaults to 1 hour, if not set.

Supporting Types

BackupInfoResponse
, BackupInfoResponseArgs

Backup This property is required. string
Name of the backup.
CreateTime This property is required. string
The time the CreateBackup request was received.
SourceDatabase This property is required. string
Name of the database the backup was created from.
VersionTime This property is required. string
The backup contains an externally consistent copy of source_database at the timestamp specified by version_time. If the CreateBackup request did not specify version_time, the version_time of the backup is equivalent to the create_time.
Backup This property is required. string
Name of the backup.
CreateTime This property is required. string
The time the CreateBackup request was received.
SourceDatabase This property is required. string
Name of the database the backup was created from.
VersionTime This property is required. string
The backup contains an externally consistent copy of source_database at the timestamp specified by version_time. If the CreateBackup request did not specify version_time, the version_time of the backup is equivalent to the create_time.
backup This property is required. String
Name of the backup.
createTime This property is required. String
The time the CreateBackup request was received.
sourceDatabase This property is required. String
Name of the database the backup was created from.
versionTime This property is required. String
The backup contains an externally consistent copy of source_database at the timestamp specified by version_time. If the CreateBackup request did not specify version_time, the version_time of the backup is equivalent to the create_time.
backup This property is required. string
Name of the backup.
createTime This property is required. string
The time the CreateBackup request was received.
sourceDatabase This property is required. string
Name of the database the backup was created from.
versionTime This property is required. string
The backup contains an externally consistent copy of source_database at the timestamp specified by version_time. If the CreateBackup request did not specify version_time, the version_time of the backup is equivalent to the create_time.
backup This property is required. str
Name of the backup.
create_time This property is required. str
The time the CreateBackup request was received.
source_database This property is required. str
Name of the database the backup was created from.
version_time This property is required. str
The backup contains an externally consistent copy of source_database at the timestamp specified by version_time. If the CreateBackup request did not specify version_time, the version_time of the backup is equivalent to the create_time.
backup This property is required. String
Name of the backup.
createTime This property is required. String
The time the CreateBackup request was received.
sourceDatabase This property is required. String
Name of the database the backup was created from.
versionTime This property is required. String
The backup contains an externally consistent copy of source_database at the timestamp specified by version_time. If the CreateBackup request did not specify version_time, the version_time of the backup is equivalent to the create_time.

DatabaseDatabaseDialect
, DatabaseDatabaseDialectArgs

DatabaseDialectUnspecified
DATABASE_DIALECT_UNSPECIFIEDDefault value. This value will create a database with the GOOGLE_STANDARD_SQL dialect.
GoogleStandardSql
GOOGLE_STANDARD_SQLGoogleSQL supported SQL.
Postgresql
POSTGRESQLPostgreSQL supported SQL.
DatabaseDatabaseDialectDatabaseDialectUnspecified
DATABASE_DIALECT_UNSPECIFIEDDefault value. This value will create a database with the GOOGLE_STANDARD_SQL dialect.
DatabaseDatabaseDialectGoogleStandardSql
GOOGLE_STANDARD_SQLGoogleSQL supported SQL.
DatabaseDatabaseDialectPostgresql
POSTGRESQLPostgreSQL supported SQL.
DatabaseDialectUnspecified
DATABASE_DIALECT_UNSPECIFIEDDefault value. This value will create a database with the GOOGLE_STANDARD_SQL dialect.
GoogleStandardSql
GOOGLE_STANDARD_SQLGoogleSQL supported SQL.
Postgresql
POSTGRESQLPostgreSQL supported SQL.
DatabaseDialectUnspecified
DATABASE_DIALECT_UNSPECIFIEDDefault value. This value will create a database with the GOOGLE_STANDARD_SQL dialect.
GoogleStandardSql
GOOGLE_STANDARD_SQLGoogleSQL supported SQL.
Postgresql
POSTGRESQLPostgreSQL supported SQL.
DATABASE_DIALECT_UNSPECIFIED
DATABASE_DIALECT_UNSPECIFIEDDefault value. This value will create a database with the GOOGLE_STANDARD_SQL dialect.
GOOGLE_STANDARD_SQL
GOOGLE_STANDARD_SQLGoogleSQL supported SQL.
POSTGRESQL
POSTGRESQLPostgreSQL supported SQL.
"DATABASE_DIALECT_UNSPECIFIED"
DATABASE_DIALECT_UNSPECIFIEDDefault value. This value will create a database with the GOOGLE_STANDARD_SQL dialect.
"GOOGLE_STANDARD_SQL"
GOOGLE_STANDARD_SQLGoogleSQL supported SQL.
"POSTGRESQL"
POSTGRESQLPostgreSQL supported SQL.

EncryptionConfig
, EncryptionConfigArgs

KmsKeyName string
The Cloud KMS key to be used for encrypting and decrypting the database. Values are of the form projects//locations//keyRings//cryptoKeys/.
KmsKeyName string
The Cloud KMS key to be used for encrypting and decrypting the database. Values are of the form projects//locations//keyRings//cryptoKeys/.
kmsKeyName String
The Cloud KMS key to be used for encrypting and decrypting the database. Values are of the form projects//locations//keyRings//cryptoKeys/.
kmsKeyName string
The Cloud KMS key to be used for encrypting and decrypting the database. Values are of the form projects//locations//keyRings//cryptoKeys/.
kms_key_name str
The Cloud KMS key to be used for encrypting and decrypting the database. Values are of the form projects//locations//keyRings//cryptoKeys/.
kmsKeyName String
The Cloud KMS key to be used for encrypting and decrypting the database. Values are of the form projects//locations//keyRings//cryptoKeys/.

EncryptionConfigResponse
, EncryptionConfigResponseArgs

KmsKeyName This property is required. string
The Cloud KMS key to be used for encrypting and decrypting the database. Values are of the form projects//locations//keyRings//cryptoKeys/.
KmsKeyName This property is required. string
The Cloud KMS key to be used for encrypting and decrypting the database. Values are of the form projects//locations//keyRings//cryptoKeys/.
kmsKeyName This property is required. String
The Cloud KMS key to be used for encrypting and decrypting the database. Values are of the form projects//locations//keyRings//cryptoKeys/.
kmsKeyName This property is required. string
The Cloud KMS key to be used for encrypting and decrypting the database. Values are of the form projects//locations//keyRings//cryptoKeys/.
kms_key_name This property is required. str
The Cloud KMS key to be used for encrypting and decrypting the database. Values are of the form projects//locations//keyRings//cryptoKeys/.
kmsKeyName This property is required. String
The Cloud KMS key to be used for encrypting and decrypting the database. Values are of the form projects//locations//keyRings//cryptoKeys/.

EncryptionInfoResponse
, EncryptionInfoResponseArgs

EncryptionStatus This property is required. Pulumi.GoogleNative.Spanner.V1.Inputs.StatusResponse
If present, the status of a recent encrypt/decrypt call on underlying data for this database or backup. Regardless of status, data is always encrypted at rest.
EncryptionType This property is required. string
The type of encryption.
KmsKeyVersion This property is required. string
A Cloud KMS key version that is being used to protect the database or backup.
EncryptionStatus This property is required. StatusResponse
If present, the status of a recent encrypt/decrypt call on underlying data for this database or backup. Regardless of status, data is always encrypted at rest.
EncryptionType This property is required. string
The type of encryption.
KmsKeyVersion This property is required. string
A Cloud KMS key version that is being used to protect the database or backup.
encryptionStatus This property is required. StatusResponse
If present, the status of a recent encrypt/decrypt call on underlying data for this database or backup. Regardless of status, data is always encrypted at rest.
encryptionType This property is required. String
The type of encryption.
kmsKeyVersion This property is required. String
A Cloud KMS key version that is being used to protect the database or backup.
encryptionStatus This property is required. StatusResponse
If present, the status of a recent encrypt/decrypt call on underlying data for this database or backup. Regardless of status, data is always encrypted at rest.
encryptionType This property is required. string
The type of encryption.
kmsKeyVersion This property is required. string
A Cloud KMS key version that is being used to protect the database or backup.
encryption_status This property is required. StatusResponse
If present, the status of a recent encrypt/decrypt call on underlying data for this database or backup. Regardless of status, data is always encrypted at rest.
encryption_type This property is required. str
The type of encryption.
kms_key_version This property is required. str
A Cloud KMS key version that is being used to protect the database or backup.
encryptionStatus This property is required. Property Map
If present, the status of a recent encrypt/decrypt call on underlying data for this database or backup. Regardless of status, data is always encrypted at rest.
encryptionType This property is required. String
The type of encryption.
kmsKeyVersion This property is required. String
A Cloud KMS key version that is being used to protect the database or backup.

RestoreInfoResponse
, RestoreInfoResponseArgs

BackupInfo This property is required. Pulumi.GoogleNative.Spanner.V1.Inputs.BackupInfoResponse
Information about the backup used to restore the database. The backup may no longer exist.
SourceType This property is required. string
The type of the restore source.
BackupInfo This property is required. BackupInfoResponse
Information about the backup used to restore the database. The backup may no longer exist.
SourceType This property is required. string
The type of the restore source.
backupInfo This property is required. BackupInfoResponse
Information about the backup used to restore the database. The backup may no longer exist.
sourceType This property is required. String
The type of the restore source.
backupInfo This property is required. BackupInfoResponse
Information about the backup used to restore the database. The backup may no longer exist.
sourceType This property is required. string
The type of the restore source.
backup_info This property is required. BackupInfoResponse
Information about the backup used to restore the database. The backup may no longer exist.
source_type This property is required. str
The type of the restore source.
backupInfo This property is required. Property Map
Information about the backup used to restore the database. The backup may no longer exist.
sourceType This property is required. String
The type of the restore source.

StatusResponse
, StatusResponseArgs

Code This property is required. int
The status code, which should be an enum value of google.rpc.Code.
Details This property is required. List<ImmutableDictionary<string, string>>
A list of messages that carry the error details. There is a common set of message types for APIs to use.
Message This property is required. string
A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
Code This property is required. int
The status code, which should be an enum value of google.rpc.Code.
Details This property is required. []map[string]string
A list of messages that carry the error details. There is a common set of message types for APIs to use.
Message This property is required. string
A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
code This property is required. Integer
The status code, which should be an enum value of google.rpc.Code.
details This property is required. List<Map<String,String>>
A list of messages that carry the error details. There is a common set of message types for APIs to use.
message This property is required. String
A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
code This property is required. number
The status code, which should be an enum value of google.rpc.Code.
details This property is required. {[key: string]: string}[]
A list of messages that carry the error details. There is a common set of message types for APIs to use.
message This property is required. string
A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
code This property is required. int
The status code, which should be an enum value of google.rpc.Code.
details This property is required. Sequence[Mapping[str, str]]
A list of messages that carry the error details. There is a common set of message types for APIs to use.
message This property is required. str
A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
code This property is required. Number
The status code, which should be an enum value of google.rpc.Code.
details This property is required. List<Map<String>>
A list of messages that carry the error details. There is a common set of message types for APIs to use.
message This property is required. String
A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

Package Details

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

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