Reference documentation and code samples for the Cloud Logging V2 API class Google::Cloud::Logging::V2::CmekSettings.
Describes the customer-managed encryption key (CMEK) settings associated with
a project, folder, organization, billing account, or flexible resource.
Note: CMEK for the Log Router can currently only be configured for Google
Cloud organizations. Once configured, it applies to all projects and folders
in the Google Cloud organization.
To enable CMEK for the Log Router, set this field to a valid
kms_key_name for which the associated service account has the required
cloudkms.cryptoKeyEncrypterDecrypter roles 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 or disabled by setting the key name
to an empty string. 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 Log Router, set this field to an empty string.
To enable CMEK for the Log Router, set this field to a valid
kms_key_name for which the associated service account has the required
cloudkms.cryptoKeyEncrypterDecrypter roles 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 or disabled by setting the key name
to an empty string. 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 Log Router, set this field to an empty string.
To enable CMEK for the Log Router, set this field to a valid
kms_key_name for which the associated service account has the required
cloudkms.cryptoKeyEncrypterDecrypter roles 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 or disabled by setting the key name
to an empty string. 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 Log Router, set this field to an empty string.
This is a read-only field used to convey the specific configured
CryptoKeyVersion of kms_key that has been configured. It will be
populated in cases where the CMEK settings are bound to a single key
version.
If this field is populated, the kms_key is tied to a specific
CryptoKeyVersion.
#kms_key_version_name=
defkms_key_version_name=(value)->::String
Parameter
value (::String) — The CryptoKeyVersion resource name for the configured Cloud KMS key.
This is a read-only field used to convey the specific configured
CryptoKeyVersion of kms_key that has been configured. It will be
populated in cases where the CMEK settings are bound to a single key
version.
If this field is populated, the kms_key is tied to a specific
CryptoKeyVersion.
Returns
(::String) — The CryptoKeyVersion resource name for the configured Cloud KMS key.
This is a read-only field used to convey the specific configured
CryptoKeyVersion of kms_key that has been configured. It will be
populated in cases where the CMEK settings are bound to a single key
version.
If this field is populated, the kms_key is tied to a specific
CryptoKeyVersion.
#name
defname()->::String
Returns
(::String) — Output only. The resource name of the CMEK settings.
#service_account_id
defservice_account_id()->::String
Returns
(::String) — Output only. The service account that will be used by the Log Router to
access your Cloud KMS key.
Before enabling CMEK for Log Router, you must first assign the
cloudkms.cryptoKeyEncrypterDecrypter role to the service account that
the Log Router will use to access your Cloud KMS key. Use
GetCmekSettings to
obtain the service account ID.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[],[],null,["# Cloud Logging V2 API - Class Google::Cloud::Logging::V2::CmekSettings (v1.3.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.3.0 (latest)](/ruby/docs/reference/google-cloud-logging-v2/latest/Google-Cloud-Logging-V2-CmekSettings)\n- [1.2.1](/ruby/docs/reference/google-cloud-logging-v2/1.2.1/Google-Cloud-Logging-V2-CmekSettings)\n- [1.1.0](/ruby/docs/reference/google-cloud-logging-v2/1.1.0/Google-Cloud-Logging-V2-CmekSettings)\n- [1.0.1](/ruby/docs/reference/google-cloud-logging-v2/1.0.1/Google-Cloud-Logging-V2-CmekSettings)\n- [0.13.0](/ruby/docs/reference/google-cloud-logging-v2/0.13.0/Google-Cloud-Logging-V2-CmekSettings)\n- [0.12.2](/ruby/docs/reference/google-cloud-logging-v2/0.12.2/Google-Cloud-Logging-V2-CmekSettings)\n- [0.11.0](/ruby/docs/reference/google-cloud-logging-v2/0.11.0/Google-Cloud-Logging-V2-CmekSettings)\n- [0.10.1](/ruby/docs/reference/google-cloud-logging-v2/0.10.1/Google-Cloud-Logging-V2-CmekSettings)\n- [0.9.0](/ruby/docs/reference/google-cloud-logging-v2/0.9.0/Google-Cloud-Logging-V2-CmekSettings)\n- [0.8.1](/ruby/docs/reference/google-cloud-logging-v2/0.8.1/Google-Cloud-Logging-V2-CmekSettings)\n- [0.7.0](/ruby/docs/reference/google-cloud-logging-v2/0.7.0/Google-Cloud-Logging-V2-CmekSettings)\n- [0.6.0](/ruby/docs/reference/google-cloud-logging-v2/0.6.0/Google-Cloud-Logging-V2-CmekSettings)\n- [0.5.6](/ruby/docs/reference/google-cloud-logging-v2/0.5.6/Google-Cloud-Logging-V2-CmekSettings) \nReference documentation and code samples for the Cloud Logging V2 API class Google::Cloud::Logging::V2::CmekSettings.\n\nDescribes the customer-managed encryption key (CMEK) settings associated with\na project, folder, organization, billing account, or flexible resource.\n\n\nNote: CMEK for the Log Router can currently only be configured for Google\nCloud organizations. Once configured, it applies to all projects and folders\nin the Google Cloud organization.\n\n\u003cbr /\u003e\n\nSee [Enabling CMEK for Log\nRouter](https://cloud.google.com/logging/docs/routing/managed-encryption) for\nmore information. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #kms_key_name\n\n def kms_key_name() -\u003e ::String\n\n**Returns**\n\n- (::String) --- The resource name for the configured Cloud KMS key.\n\n KMS key name format: \n\n \"projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]\"\n\n For example:\n\n `\"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key\"`\n\n To enable CMEK for the Log Router, set this field to a valid\n `kms_key_name` for which the associated service account has the required\n cloudkms.cryptoKeyEncrypterDecrypter roles assigned for the key.\n\n The Cloud KMS key used by the Log Router can be updated by changing the\n `kms_key_name` to a new valid key name or disabled by setting the key name\n to an empty string. Encryption operations that are in progress will be\n completed with the key that was in use when they started. Decryption\n operations will be completed using the key that was used at the time of\n encryption unless access to that key has been revoked.\n\n To disable CMEK for the Log Router, set this field to an empty string.\n\n See [Enabling CMEK for Log\n Router](https://cloud.google.com/logging/docs/routing/managed-encryption)\n for more information.\n\n### #kms_key_name=\n\n def kms_key_name=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- The resource name for the configured Cloud KMS key.\n\n\n KMS key name format: \n\n \"projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]\"\n\n For example:\n\n `\"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key\"`\n\n To enable CMEK for the Log Router, set this field to a valid\n `kms_key_name` for which the associated service account has the required\n cloudkms.cryptoKeyEncrypterDecrypter roles assigned for the key.\n\n The Cloud KMS key used by the Log Router can be updated by changing the\n `kms_key_name` to a new valid key name or disabled by setting the key name\n to an empty string. Encryption operations that are in progress will be\n completed with the key that was in use when they started. Decryption\n operations will be completed using the key that was used at the time of\n encryption unless access to that key has been revoked.\n\n To disable CMEK for the Log Router, set this field to an empty string.\n\n See [Enabling CMEK for Log\n Router](https://cloud.google.com/logging/docs/routing/managed-encryption)\nfor more information. \n**Returns**\n\n- (::String) --- The resource name for the configured Cloud KMS key.\n\n KMS key name format: \n\n \"projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]\"\n\n For example:\n\n `\"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key\"`\n\n To enable CMEK for the Log Router, set this field to a valid\n `kms_key_name` for which the associated service account has the required\n cloudkms.cryptoKeyEncrypterDecrypter roles assigned for the key.\n\n The Cloud KMS key used by the Log Router can be updated by changing the\n `kms_key_name` to a new valid key name or disabled by setting the key name\n to an empty string. Encryption operations that are in progress will be\n completed with the key that was in use when they started. Decryption\n operations will be completed using the key that was used at the time of\n encryption unless access to that key has been revoked.\n\n To disable CMEK for the Log Router, set this field to an empty string.\n\n See [Enabling CMEK for Log\n Router](https://cloud.google.com/logging/docs/routing/managed-encryption)\n for more information.\n\n### #kms_key_version_name\n\n def kms_key_version_name() -\u003e ::String\n\n**Returns**\n\n- (::String) --- The CryptoKeyVersion resource name for the configured Cloud KMS key.\n\n KMS key name format: \n\n \"projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]/cryptoKeyVersions/[VERSION]\"\n\n For example:\n\n `\"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key/cryptoKeyVersions/1\"`\n\n This is a read-only field used to convey the specific configured\n CryptoKeyVersion of `kms_key` that has been configured. It will be\n populated in cases where the CMEK settings are bound to a single key\n version.\n\n If this field is populated, the `kms_key` is tied to a specific\n CryptoKeyVersion.\n\n### #kms_key_version_name=\n\n def kms_key_version_name=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- The CryptoKeyVersion resource name for the configured Cloud KMS key.\n\n\n KMS key name format: \n\n \"projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]/cryptoKeyVersions/[VERSION]\"\n\n For example:\n\n `\"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key/cryptoKeyVersions/1\"`\n\n This is a read-only field used to convey the specific configured\n CryptoKeyVersion of `kms_key` that has been configured. It will be\n populated in cases where the CMEK settings are bound to a single key\n version.\n\n If this field is populated, the `kms_key` is tied to a specific\nCryptoKeyVersion. \n**Returns**\n\n- (::String) --- The CryptoKeyVersion resource name for the configured Cloud KMS key.\n\n KMS key name format: \n\n \"projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]/cryptoKeyVersions/[VERSION]\"\n\n For example:\n\n `\"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key/cryptoKeyVersions/1\"`\n\n This is a read-only field used to convey the specific configured\n CryptoKeyVersion of `kms_key` that has been configured. It will be\n populated in cases where the CMEK settings are bound to a single key\n version.\n\n If this field is populated, the `kms_key` is tied to a specific\n CryptoKeyVersion.\n\n### #name\n\n def name() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Output only. The resource name of the CMEK settings.\n\n### #service_account_id\n\n def service_account_id() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Output only. The service account that will be used by the Log Router to access your Cloud KMS key.\n\n Before enabling CMEK for Log Router, you must first assign the\n cloudkms.cryptoKeyEncrypterDecrypter role to the service account that\n the Log Router will use to access your Cloud KMS key. Use\n [GetCmekSettings](/ruby/docs/reference/google-cloud-logging-v2/latest/Google-Cloud-Logging-V2-ConfigService-Client#Google__Cloud__Logging__V2__ConfigService__Client_get_cmek_settings_instance_ \"Google::Cloud::Logging::V2::ConfigService::Client#get_cmek_settings (method)\") to\n obtain the service account ID.\n\n See [Enabling CMEK for Log\n Router](https://cloud.google.com/logging/docs/routing/managed-encryption)\n for more information."]]
