cmek_configs

Creates, updates, deletes, gets or lists a cmek_configs resource.

Overview

Name	cmek_configs
Type	Resource
Id	google.discoveryengine.cmek_configs

Fields

The following fields are returned by SELECT queries:

projects_locations_cmek_configs_get

Name	Datatype	Description
name	string	Required. The name of the CmekConfig of the form projects/{project}/locations/{location}/cmekConfig or projects/{project}/locations/{location}/cmekConfigs/{cmek_config}.
isDefault	boolean	Output only. The default CmekConfig for the Customer.
kmsKey	string	Required. KMS key resource name which will be used to encrypt resources projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}.
kmsKeyVersion	string	Output only. KMS key version resource name which will be used to encrypt resources /cryptoKeyVersions/{keyVersion}.
lastRotationTimestampMicros	string (int64)	Output only. The timestamp of the last key rotation.
notebooklmState	string	Output only. Whether the NotebookLM Corpus is ready to be used. (NOTEBOOK_LM_STATE_UNSPECIFIED, NOTEBOOK_LM_NOT_READY, NOTEBOOK_LM_READY, NOTEBOOK_LM_NOT_ENABLED)
singleRegionKeys	array	Optional. Single-regional CMEKs that are required for some VAIS features.
state	string	Output only. The states of the CmekConfig. (STATE_UNSPECIFIED, CREATING, ACTIVE, KEY_ISSUE, DELETING, DELETE_FAILED, UNUSABLE, ACTIVE_ROTATING, DELETED, EXPIRED)

projects_locations_cmek_configs_list

Name	Datatype	Description
cmekConfigs	array	All the customer's CmekConfigs.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
projects_locations_cmek_configs_get	select	projectsId, locationsId, cmekConfigsId		Gets the CmekConfig.
projects_locations_cmek_configs_list	select	projectsId, locationsId		Lists all the CmekConfigs with the project.
projects_locations_cmek_configs_patch	update	projectsId, locationsId, cmekConfigsId	setDefault	Provisions a CMEK key for use in a location of a customer's project. This method will also conduct location validation on the provided cmekConfig to make sure the key is valid and can be used in the selected location.
projects_locations_cmek_configs_delete	delete	projectsId, locationsId, cmekConfigsId		De-provisions a CmekConfig.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
cmekConfigsId	string
locationsId	string
projectsId	string
setDefault	boolean

SELECT examples

projects_locations_cmek_configs_get

Gets the CmekConfig.

SELECT
name,
isDefault,
kmsKey,
kmsKeyVersion,
lastRotationTimestampMicros,
notebooklmState,
singleRegionKeys,
state
FROM google.discoveryengine.cmek_configs
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND cmekConfigsId = '{{ cmekConfigsId }}' -- required
;

projects_locations_cmek_configs_list

Lists all the CmekConfigs with the project.

SELECT
cmekConfigs
FROM google.discoveryengine.cmek_configs
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
;

UPDATE examples

projects_locations_cmek_configs_patch

Provisions a CMEK key for use in a location of a customer's project. This method will also conduct location validation on the provided cmekConfig to make sure the key is valid and can be used in the selected location.

UPDATE google.discoveryengine.cmek_configs
SET 
data__kmsKey = '{{ kmsKey }}',
data__name = '{{ name }}',
data__singleRegionKeys = '{{ singleRegionKeys }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND cmekConfigsId = '{{ cmekConfigsId }}' --required
AND setDefault = {{ setDefault}}
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

projects_locations_cmek_configs_delete

De-provisions a CmekConfig.

DELETE FROM google.discoveryengine.cmek_configs
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND cmekConfigsId = '{{ cmekConfigsId }}' --required
;