Class: Google::Cloud::Spanner::Admin::Database::V1::EncryptionConfig

Inherits:

Object

Object
Google::Cloud::Spanner::Admin::Database::V1::EncryptionConfig

show all

Extended by:: Protobuf::MessageExts::ClassMethods

Includes:: Protobuf::MessageExts

Defined in:: proto_docs/google/spanner/admin/database/v1/common.rb

Overview

Encryption configuration for a Cloud Spanner database.

Instance Attribute Summary collapse

#kms_key_name ⇒ ::String
The Cloud KMS key to be used for encrypting and decrypting the database.
#kms_key_names ⇒ ::Array<::String>
Specifies the KMS configuration for the one or more keys used to encrypt the database.

Instance Attribute Details

#kms_key_name ⇒ `::String`

Returns 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>.

Returns:

(::String) —
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>.

# File 'proto_docs/google/spanner/admin/database/v1/common.rb', line 67

class EncryptionConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#kms_key_names ⇒ `::Array<::String>`

Returns 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.