Google Cloud Spanner Database Administration v1 API - Class RestoreDatabaseEncryptionConfig (5.0.0-beta04)

public sealed class RestoreDatabaseEncryptionConfig : IMessage<RestoreDatabaseEncryptionConfig>, IEquatable<RestoreDatabaseEncryptionConfig>, IDeepCloneable<RestoreDatabaseEncryptionConfig>, IBufferMessage, IMessage

Reference documentation and code samples for the Google Cloud Spanner Database Administration v1 API class RestoreDatabaseEncryptionConfig.

Encryption configuration for the restored database.

Inheritance

object > RestoreDatabaseEncryptionConfig

Namespace

Google.Cloud.Spanner.Admin.Database.V1

Assembly

Google.Cloud.Spanner.Admin.Database.V1.dll

Constructors

RestoreDatabaseEncryptionConfig()

public RestoreDatabaseEncryptionConfig()

RestoreDatabaseEncryptionConfig(RestoreDatabaseEncryptionConfig)

public RestoreDatabaseEncryptionConfig(RestoreDatabaseEncryptionConfig other)
Parameter
Name Description
other RestoreDatabaseEncryptionConfig

Properties

EncryptionType

public RestoreDatabaseEncryptionConfig.Types.EncryptionType EncryptionType { get; set; }

Required. The encryption type of the restored database.

Property Value
Type Description
RestoreDatabaseEncryptionConfigTypesEncryptionType

KmsKeyName

public string KmsKeyName { get; set; }

Optional. The Cloud KMS key that will be used to encrypt/decrypt the restored database. This field should be set only when [encryption_type][google.spanner.admin.database.v1.RestoreDatabaseEncryptionConfig.encryption_type] is CUSTOMER_MANAGED_ENCRYPTION. Values are of the form projects/<project>/locations/<location>/keyRings/<key_ring>/cryptoKeys/<kms_key_name>.

Property Value
Type Description
string

KmsKeyNameAsCryptoKeyName

public CryptoKeyName KmsKeyNameAsCryptoKeyName { get; set; }

CryptoKeyName-typed view over the KmsKeyName resource name property.

Property Value
Type Description
CryptoKeyName

KmsKeyNames

public RepeatedField<string> KmsKeyNames { get; }

Optional. Specifies the KMS configuration for the one or more keys used to encrypt the database. Values are of the form projects/<project>/locations/<location>/keyRings/<key_ring>/cryptoKeys/<kms_key_name>.

The keys referenced by kms_key_names must fully cover all regions of the database instance configuration. Some examples:

  • For single region database instance configs, specify a single regional location KMS key.
  • For multi-regional database instance configs of type GOOGLE_MANAGED, either specify a multi-regional location KMS key or multiple regional location KMS keys that cover all regions in the instance config.
  • For a database instance config of type USER_MANAGED, please specify only regional location KMS keys to cover each region in the instance config. Multi-regional location KMS keys are not supported for USER_MANAGED instance configs.
Property Value
Type Description
RepeatedFieldstring

KmsKeyNamesAsCryptoKeyNames

public ResourceNameList<CryptoKeyName> KmsKeyNamesAsCryptoKeyNames { get; }

CryptoKeyName-typed view over the KmsKeyNames resource name property.

Property Value
Type Description
ResourceNameListCryptoKeyName