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

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

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

Encryption configuration for the backup to create.

Inheritance

object > CreateBackupEncryptionConfig

Namespace

Google.Cloud.Spanner.Admin.Database.V1

Assembly

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

Constructors

CreateBackupEncryptionConfig()

public CreateBackupEncryptionConfig()

CreateBackupEncryptionConfig(CreateBackupEncryptionConfig)

public CreateBackupEncryptionConfig(CreateBackupEncryptionConfig other)
Parameter
Name Description
other CreateBackupEncryptionConfig

Properties

EncryptionType

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

Required. The encryption type of the backup.

Property Value
Type Description
CreateBackupEncryptionConfigTypesEncryptionType

KmsKeyName

public string KmsKeyName { get; set; }

Optional. The Cloud KMS key that will be used to protect the backup. This field should be set only when [encryption_type][google.spanner.admin.database.v1.CreateBackupEncryptionConfig.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 protect the backup. 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 backup's instance configuration. Some examples:

  • For single region instance configs, specify a single regional location KMS key.
  • For multi-regional 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 an 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