Class: Google::Cloud::Logging::V2::CmekSettings

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/logging/v2/logging_config.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 for more information.

Instance Attribute Summary collapse

Instance Attribute Details

#kms_key_name ⇒ ::String

Returns 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 for more information.

Returns:

  • (::String) —

    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 for more information.



722
723
724
725
 
# File 'proto_docs/google/logging/v2/logging_config.rb', line 722

class CmekSettings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#name ⇒ ::String (readonly)

Returns Output only. The resource name of the CMEK settings.

Returns:

  • (::String) —

    Output only. The resource name of the CMEK settings.



722
723
724
725
 
# File 'proto_docs/google/logging/v2/logging_config.rb', line 722

class CmekSettings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#service_account_id ⇒ ::String (readonly)

Returns 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 for more information.

Returns:

  • (::String) —

    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 for more information.



722
723
724
725
 
# File 'proto_docs/google/logging/v2/logging_config.rb', line 722

class CmekSettings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end