REST Resource: projects.locations.keyHandles

Resource: KeyHandle

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

JSON representation
{
  "name": string,
  "kmsKey": string,
  "resourceTypeSelector": string
}
Fields
name

string

Identifier. Name of the KeyHandle resource, e.g. projects/{PROJECT_ID}/locations/{LOCATION}/keyHandles/{KEY_HANDLE_ID}.

kmsKey

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.

resourceTypeSelector

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.

Methods

create

Creates a new KeyHandle, triggering the provisioning of a new CryptoKey for CMEK use with the given resource type in the configured key project and the same location.

get

Returns the KeyHandle.

list

Lists KeyHandles.