Cloud Spanner Database Admin V1 API - Class Google::Cloud::Spanner::Admin::Database::V1::EncryptionConfig (v1.3.0)

Reference documentation and code samples for the Cloud Spanner Database Admin V1 API class Google::Cloud::Spanner::Admin::Database::V1::EncryptionConfig.

Encryption configuration for a Cloud Spanner database.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#kms_key_name

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

#kms_key_name=

def kms_key_name=(value) -> ::String
Parameter
  • value (::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>.
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>.

#kms_key_names

def kms_key_names() -> ::Array<::String>
Returns
  • (::Array<::String>) —

    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.

#kms_key_names=

def kms_key_names=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) —

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

    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.