Class: Google::Apis::SpannerV1::EncryptionConfig

Inherits:
Object
  • Object
show all
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 collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ EncryptionConfig

Returns a new instance of EncryptionConfig.



2422
2423
2424
# File 'lib/google/apis/spanner_v1/classes.rb', line 2422

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

Instance Attribute Details

#kms_key_nameString

The Cloud KMS key to be used for encrypting and decrypting the database. Values are of the form projects//locations//keyRings//cryptoKeys/. Corresponds to the JSON property kmsKeyName

Returns:

  • (String)


2405
2406
2407
# File 'lib/google/apis/spanner_v1/classes.rb', line 2405

def kms_key_name
  @kms_key_name
end

#kms_key_namesArray<String>

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>)


2420
2421
2422
# File 'lib/google/apis/spanner_v1/classes.rb', line 2420

def kms_key_names
  @kms_key_names
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2427
2428
2429
2430
# File 'lib/google/apis/spanner_v1/classes.rb', line 2427

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