Class: Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2CryptoKey

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/dlp_v2beta2/classes.rb,
generated/google/apis/dlp_v2beta2/representations.rb,
generated/google/apis/dlp_v2beta2/representations.rb

Overview

This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by KMS). When using KMS to wrap/unwrap DEKs, be sure to set an appropriate IAM policy on the KMS CryptoKey (KEK) to ensure an attacker cannot unwrap the data crypto key.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ GooglePrivacyDlpV2beta2CryptoKey

Returns a new instance of GooglePrivacyDlpV2beta2CryptoKey



2311
2312
2313
 
# File 'generated/google/apis/dlp_v2beta2/classes.rb', line 2311

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

Instance Attribute Details

#kms_wrapped ⇒ Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2KmsWrappedCryptoKey

Include to use an existing data crypto key wrapped by KMS. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a kms-wrapped crypto key: dlp.kms.encrypt Corresponds to the JSON property kmsWrapped

Returns:



2297
2298
2299
 
# File 'generated/google/apis/dlp_v2beta2/classes.rb', line 2297

def kms_wrapped
  @kms_wrapped
end

#transient ⇒ Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2TransientCryptoKey

Use this to have a random data crypto key generated. It will be discarded after the request finishes. Corresponds to the JSON property transient

Returns:



2303
2304
2305
 
# File 'generated/google/apis/dlp_v2beta2/classes.rb', line 2303

def transient
  @transient
end

#unwrapped ⇒ Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2UnwrappedCryptoKey

Using raw keys is prone to security risks due to accidentally leaking the key. Choose another type of key if possible. Corresponds to the JSON property unwrapped

Returns:



2309
2310
2311
 
# File 'generated/google/apis/dlp_v2beta2/classes.rb', line 2309

def unwrapped
  @unwrapped
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2316
2317
2318
2319
2320
 
# File 'generated/google/apis/dlp_v2beta2/classes.rb', line 2316

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