Class: Google::Apis::CloudkmsV1::KeyHandle

Inherits:

Object

• Object
• Google::Apis::CloudkmsV1::KeyHandle

Includes:

Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport

Defined in:

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

Overview

Resource-oriented representation of a request to Cloud KMS Autokey and the resulting provisioning of a CryptoKey.

Instance Attribute Summary

• #kms_key ⇒ String

  Output only.

• #name ⇒ String

  Identifier.

• #resource_type_selector ⇒ String

  Required.

Instance Method Summary

• #initialize(**args) ⇒ KeyHandle constructor

  A new instance of KeyHandle.

• #update!(**args) ⇒ Object

  Update properties of this object.

Constructor Details

#initialize(**args) ⇒ KeyHandle

Returns a new instance of KeyHandle.

# File 'lib/google/apis/cloudkms_v1/classes.rb', line 2036

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

Instance Attribute Details

#kms_key ⇒ String

Output only. Name of a CryptoKey that has been provisioned for Customer Managed Encryption Key (CMEK) use in the KeyHandle project and location for the requested resource type. The CryptoKey project will reflect the value configured in the AutokeyConfig on the resource project's ancestor folder at the time of the KeyHandle creation. If more than one ancestor folder has a configured AutokeyConfig, the nearest of these configurations is used. Corresponds to the JSON property kmsKey

Returns:

• (String)

# File 'lib/google/apis/cloudkms_v1/classes.rb', line 2021

def kms_key
  @kms_key
end

#name ⇒ String

Identifier. Name of the KeyHandle resource, e.g. projects/PROJECT_ID/ locations/LOCATION/keyHandles/KEY_HANDLE_ID`. Corresponds to the JSON propertyname`

Returns:

• (String)

# File 'lib/google/apis/cloudkms_v1/classes.rb', line 2027

def name
  @name
end

#resource_type_selector ⇒ String

Required. Indicates the resource type that the resulting CryptoKey is meant to protect, e.g. SERVICE`.googleapis.com/`TYPE. See documentation for supported resource types. Corresponds to the JSON property resourceTypeSelector

Returns:

• (String)

# File 'lib/google/apis/cloudkms_v1/classes.rb', line 2034

def resource_type_selector
  @resource_type_selector
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

# File 'lib/google/apis/cloudkms_v1/classes.rb', line 2041

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