Class: Google::Apis::SpannerV1::InstanceEncryptionConfig

Inherits:

Object

• Object
• Google::Apis::SpannerV1::InstanceEncryptionConfig

Includes:

Core::Hashable, Core::JsonObjectSupport

Defined in:

lib/google/apis/spanner_v1/classes.rb,
lib/google/apis/spanner_v1/representations.rb,
lib/google/apis/spanner_v1/representations.rb

Overview

Encryption configuration for a Cloud Spanner database.

Instance Attribute Summary

• #kms_key_name ⇒ String

  Optional.

• #kms_key_names ⇒ Array<String>

  Optional.

Instance Method Summary

• #initialize(**args) ⇒ InstanceEncryptionConfig constructor

  A new instance of InstanceEncryptionConfig.

• #update!(**args) ⇒ Object

  Update properties of this object.

Constructor Details

#initialize(**args) ⇒ InstanceEncryptionConfig

Returns a new instance of InstanceEncryptionConfig.

# File 'lib/google/apis/spanner_v1/classes.rb', line 3425

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#kms_key_name ⇒ String

Optional. This field is maintained for backwards compatibility. For new callers, we recommend using kms_key_names to specify the KMS key. Only use kms_key_name if the location of the KMS key matches the database instance's configuration (location) exactly. For example, if the KMS location is in us- central1 or nam3, then the database instance must also be in us-central1 or nam3. The Cloud KMS key that is used to encrypt and decrypt the restored database. Values are of the form projects//locations//keyRings//cryptoKeys/. Corresponds to the JSON property kmsKeyName

Returns:

• (String)

# File 'lib/google/apis/spanner_v1/classes.rb', line 3407

def kms_key_name
  @kms_key_name
end

#kms_key_names ⇒ Array<String>

Optional. Specifies the KMS configuration for one or more keys used to encrypt the database. Values are of the form projects//locations//keyRings// cryptoKeys/. The keys referenced by kms_key_names must fully cover all regions of the database's instance configuration. Some examples: * For regional (single-region) instance configurations, specify a regional location KMS key. * For multi-region instance configurations of type GOOGLE_MANAGED, either specify a multi-region location KMS key or multiple regional location KMS keys that cover all regions in the instance configuration. * For an instance configuration of type USER_MANAGED, specify only regional location KMS keys to cover each region in the instance configuration. Multi-region location KMS keys aren't supported for USER_MANAGED type instance configurations. Corresponds to the JSON property kmsKeyNames

Returns:

• (Array<String>)

# File 'lib/google/apis/spanner_v1/classes.rb', line 3423

def kms_key_names
  @kms_key_names
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

# File 'lib/google/apis/spanner_v1/classes.rb', line 3430

def update!(**args)
  @kms_key_name = args[:kms_key_name] if args.key?(:kms_key_name)
  @kms_key_names = args[:kms_key_names] if args.key?(:kms_key_names)
end