Google Cloud Native v0.31.1, Jul 20 23

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

Google Cloud Native v0.31.1 published on Thursday, Jul 20, 2023 by Pulumi

pulumi/pulumi-google-native

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.31.1 published on Thursday, Jul 20, 2023 by Pulumi

pulumi/pulumi-google-native

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

new Database(name: string, args: DatabaseArgs, opts?: CustomResourceOptions);

@overload
def Database(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             create_statement: Optional[str] = None,
             database_dialect: Optional[DatabaseDatabaseDialect] = None,
             encryption_config: Optional[EncryptionConfigArgs] = None,
             extra_statements: Optional[Sequence[str]] = None,
             instance_id: Optional[str] = None,
             project: Optional[str] = None,
             proto_descriptors: 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: google-native:spanner/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:

CreateStatement 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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.
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.
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.
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.
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.
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.
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 string: Name of the backup.
CreateTime string: The time the CreateBackup request was received.
SourceDatabase string: Name of the database the backup was created from.
VersionTime 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 string: Name of the backup.
CreateTime string: The time the CreateBackup request was received.
SourceDatabase string: Name of the database the backup was created from.
VersionTime 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 String: Name of the backup.
createTime String: The time the CreateBackup request was received.
sourceDatabase String: Name of the database the backup was created from.
versionTime 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 string: Name of the backup.
createTime string: The time the CreateBackup request was received.
sourceDatabase string: Name of the database the backup was created from.
versionTime 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 str: Name of the backup.
create_time str: The time the CreateBackup request was received.
source_database str: Name of the database the backup was created from.
version_time 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 String: Name of the backup.
createTime String: The time the CreateBackup request was received.
sourceDatabase String: Name of the database the backup was created from.
versionTime 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_UNSPECIFIED
Default value. This value will create a database with the GOOGLE_STANDARD_SQL dialect.
GoogleStandardSql: GOOGLE_STANDARD_SQL
GoogleSQL supported SQL.
Postgresql: POSTGRESQL
PostgreSQL supported SQL.

DatabaseDatabaseDialectDatabaseDialectUnspecified: DATABASE_DIALECT_UNSPECIFIED
Default value. This value will create a database with the GOOGLE_STANDARD_SQL dialect.
DatabaseDatabaseDialectGoogleStandardSql: GOOGLE_STANDARD_SQL
GoogleSQL supported SQL.
DatabaseDatabaseDialectPostgresql: POSTGRESQL
PostgreSQL supported SQL.

DatabaseDialectUnspecified: DATABASE_DIALECT_UNSPECIFIED
Default value. This value will create a database with the GOOGLE_STANDARD_SQL dialect.
GoogleStandardSql: GOOGLE_STANDARD_SQL
GoogleSQL supported SQL.
Postgresql: POSTGRESQL
PostgreSQL supported SQL.

DatabaseDialectUnspecified: DATABASE_DIALECT_UNSPECIFIED
Default value. This value will create a database with the GOOGLE_STANDARD_SQL dialect.
GoogleStandardSql: GOOGLE_STANDARD_SQL
GoogleSQL supported SQL.
Postgresql: POSTGRESQL
PostgreSQL supported SQL.

DATABASE_DIALECT_UNSPECIFIED: DATABASE_DIALECT_UNSPECIFIED
Default value. This value will create a database with the GOOGLE_STANDARD_SQL dialect.
GOOGLE_STANDARD_SQL: GOOGLE_STANDARD_SQL
GoogleSQL supported SQL.
POSTGRESQL: POSTGRESQL
PostgreSQL supported SQL.

"DATABASE_DIALECT_UNSPECIFIED": DATABASE_DIALECT_UNSPECIFIED
Default value. This value will create a database with the GOOGLE_STANDARD_SQL dialect.
"GOOGLE_STANDARD_SQL": GOOGLE_STANDARD_SQL
GoogleSQL supported SQL.
"POSTGRESQL": POSTGRESQL
PostgreSQL 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 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/.

EncryptionInfoResponse, EncryptionInfoResponseArgs

EncryptionStatus 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 string: The type of encryption.
KmsKeyVersion string: A Cloud KMS key version that is being used to protect the database or backup.

EncryptionStatus 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 string: The type of encryption.
KmsKeyVersion string: A Cloud KMS key version that is being used to protect the database or backup.

encryptionStatus 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 String: The type of encryption.
kmsKeyVersion String: A Cloud KMS key version that is being used to protect the database or backup.

encryptionStatus 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 string: The type of encryption.
kmsKeyVersion string: A Cloud KMS key version that is being used to protect the database or backup.

encryption_status 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 str: The type of encryption.
kms_key_version str: A Cloud KMS key version that is being used to protect the database or backup.

encryptionStatus 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 String: The type of encryption.
kmsKeyVersion String: A Cloud KMS key version that is being used to protect the database or backup.

RestoreInfoResponse, RestoreInfoResponseArgs

BackupInfo Pulumi.GoogleNative.Spanner.V1.Inputs.BackupInfoResponse: Information about the backup used to restore the database. The backup may no longer exist.
SourceType string: The type of the restore source.

BackupInfo BackupInfoResponse: Information about the backup used to restore the database. The backup may no longer exist.
SourceType string: The type of the restore source.

backupInfo BackupInfoResponse: Information about the backup used to restore the database. The backup may no longer exist.
sourceType String: The type of the restore source.

backupInfo BackupInfoResponse: Information about the backup used to restore the database. The backup may no longer exist.
sourceType string: The type of the restore source.

backup_info BackupInfoResponse: Information about the backup used to restore the database. The backup may no longer exist.
source_type str: The type of the restore source.

backupInfo Property Map: Information about the backup used to restore the database. The backup may no longer exist.
sourceType String: The type of the restore source.

StatusResponse, StatusResponseArgs

Code int: The status code, which should be an enum value of google.rpc.Code.
Details 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 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 int: The status code, which should be an enum value of google.rpc.Code.
Details []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 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 Integer: The status code, which should be an enum value of google.rpc.Code.
details 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 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 number: The status code, which should be an enum value of google.rpc.Code.
details {[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 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 int: The status code, which should be an enum value of google.rpc.Code.
details 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 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 Number: The status code, which should be an enum value of google.rpc.Code.
details 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 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.31.1 published on Thursday, Jul 20, 2023 by Pulumi

pulumi/pulumi-google-native

google-native.spanner/v1.Database

On this page

On this page

Create Database Resource

Database Resource Properties

Inputs

Outputs

Supporting Types

BackupInfoResponse, BackupInfoResponseArgs

DatabaseDatabaseDialect, DatabaseDatabaseDialectArgs

EncryptionConfig, EncryptionConfigArgs

EncryptionConfigResponse, EncryptionConfigResponseArgs

EncryptionInfoResponse, EncryptionInfoResponseArgs

RestoreInfoResponse, RestoreInfoResponseArgs

StatusResponse, StatusResponseArgs

Package Details

On this page

On this page