Method: updateCmekSettings

Updates the Logs Router CMEK settings for the given 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.

v2.updateCmekSettings will fail if 1) kmsKeyName is invalid, or 2) the associated service account does not have the required roles/cloudkms.cryptoKeyEncrypterDecrypter role assigned for the key, or 3) access to the key is disabled.

See Enabling CMEK for Logs Router for more information.

HTTP request

PATCH https://logging.googleapis.com/v2/{name=*/*}/cmekSettings

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The resource name for the CMEK settings to update.

"projects/[PROJECT_ID]/cmekSettings"
"organizations/[ORGANIZATION_ID]/cmekSettings"
"billingAccounts/[BILLING_ACCOUNT_ID]/cmekSettings"
"folders/[FOLDER_ID]/cmekSettings"

Example: "organizations/12345/cmekSettings".

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.

Authorization requires the following IAM permission on the specified resource name:

  • logging.cmekSettings.get

Query parameters

Parameters
updateMask

string (FieldMask format)

Optional. Field mask identifying which fields from cmekSettings should be updated. A field will be overwritten if and only if it is in the update mask. Output only fields cannot be updated.

See FieldMask for more information.

Example: "updateMask=kmsKeyName"

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

Request body

The request body contains an instance of CmekSettings.

Response body

If successful, the response body contains an instance of CmekSettings.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/logging.admin
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.