Class: Google::Apis::LoggingV2::CmekSettings

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

Overview

Describes the customer-managed encryption key (CMEK) settings associated with a project, folder, organization, billing account, or flexible resource.Note: CMEK for the Logs Router can currently only be configured for GCP organizations. Once configured, it applies to all projects and folders in the GCP organization.See Enabling CMEK for Logs Router (https://cloud.google.com/ logging/docs/routing/managed-encryption) for more information.

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

Returns a new instance of CmekSettings.


161
162
163
# File 'generated/google/apis/logging_v2/classes.rb', line 161

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

Instance Attribute Details

#kms_key_nameString

The resource name for the configured Cloud KMS key.KMS key name format: " projects/PROJECT_ID/locations/LOCATION/keyRings/KEYRING/cryptoKeys/KEY"For example: "projects/my-project-id/locations/my-region/keyRings/key-ring-name/ cryptoKeys/key-name"To enable CMEK for the Logs Router, set this field to a valid kms_key_name for which the associated service account has the required roles/cloudkms.cryptoKeyEncrypterDecrypter role assigned for the key.The Cloud KMS key used by the Log Router can be updated by changing the kms_key_name to a new valid key name. Encryption operations that are in progress will be completed with the key that was in use when they started. Decryption operations will be completed using the key that was used at the time of encryption unless access to that key has been revoked.To disable CMEK for the Logs Router, set this field to an empty string.See Enabling CMEK for Logs Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. Corresponds to the JSON property kmsKeyName

Returns:

  • (String)

143
144
145
# File 'generated/google/apis/logging_v2/classes.rb', line 143

def kms_key_name
  @kms_key_name
end

#nameString

Output only. The resource name of the CMEK settings. Corresponds to the JSON property name

Returns:

  • (String)

148
149
150
# File 'generated/google/apis/logging_v2/classes.rb', line 148

def name
  @name
end

#service_account_idString

Output only. The service account that will be used by the Logs Router to access your Cloud KMS key.Before enabling CMEK for Logs Router, you must first assign the role roles/cloudkms.cryptoKeyEncrypterDecrypter to the service account that the Logs Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID.See Enabling CMEK for Logs Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. Corresponds to the JSON property serviceAccountId

Returns:

  • (String)

159
160
161
# File 'generated/google/apis/logging_v2/classes.rb', line 159

def 
  @service_account_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


166
167
168
169
170
# File 'generated/google/apis/logging_v2/classes.rb', line 166

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