Class: Google::Apis::BigtableadminV2::EncryptionConfig

Inherits:

Object

• Object
• Google::Apis::BigtableadminV2::EncryptionConfig

Includes:

Core::Hashable, Core::JsonObjectSupport

Defined in:

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

Overview

Cloud Key Management Service (Cloud KMS) settings for a CMEK-protected cluster.

Instance Attribute Summary

• #kms_key_name ⇒ String

  Describes the Cloud KMS encryption key that will be used to protect the destination Bigtable cluster.

Instance Method Summary

• #initialize(**args) ⇒ EncryptionConfig constructor

  A new instance of EncryptionConfig.

• #update!(**args) ⇒ Object

  Update properties of this object.

Constructor Details

#initialize(**args) ⇒ EncryptionConfig

Returns a new instance of EncryptionConfig.

# File 'lib/google/apis/bigtableadmin_v2/classes.rb', line 1068

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

Instance Attribute Details

#kms_key_name ⇒ String

Describes the Cloud KMS encryption key that will be used to protect the destination Bigtable cluster. The requirements for this key are: 1) The Cloud Bigtable service account associated with the project that contains this cluster must be granted the cloudkms.cryptoKeyEncrypterDecrypter role on the CMEK key. 2) Only regional keys can be used and the region of the CMEK key must match the region of the cluster. Values are of the form projects/ project/locations/location/keyRings/keyring/cryptoKeys/key` Corresponds to the JSON propertykmsKeyName`

Returns:

• (String)

# File 'lib/google/apis/bigtableadmin_v2/classes.rb', line 1066

def kms_key_name
  @kms_key_name
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

# File 'lib/google/apis/bigtableadmin_v2/classes.rb', line 1073

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