Google Cloud Spanner Database Administration v1 API - Class EncryptionConfig (5.0.0-beta05) 

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

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

Encryption configuration for a Cloud Spanner database.

Inheritance

object > EncryptionConfig

Namespace

Google.Cloud.Spanner.Admin.Database.V1

Assembly

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

Constructors

EncryptionConfig()

public EncryptionConfig()

EncryptionConfig(EncryptionConfig)

public EncryptionConfig(EncryptionConfig other)
Parameter
Name Description
other EncryptionConfig

Properties

KmsKeyName

public string KmsKeyName { get; set; }

The Cloud KMS key to be used for encrypting and decrypting the database. 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; }

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