cmek_config

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

Overview

Name	cmek_config
Type	Resource
Id	google.cloudscheduler.cmek_config

Fields

The following fields are returned by SELECT queries:

get_cmek_config

Name	Datatype	Description
name	string	Identifier. The config resource name which includes the project and location and must end in 'cmekConfig', in the format projects/PROJECT_ID/locations/LOCATION_ID/cmekConfig`
kmsKeyName	string	Optional. Resource name of the Cloud KMS key, of the form projects/PROJECT_ID/locations/LOCATION_ID/keyRings/KEY_RING_ID/cryptoKeys/KEY_ID, that will be used to encrypt Jobs in the region. Setting this as blank will turn off CMEK encryption.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_cmek_config	select	projectsId, locationsId		Gets the Scheduler config in the project/region.
update_cmek_config	update	projectsId, locationsId	updateMask	Initializes or Updates the a scheduler config.

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
locationsId	string
projectsId	string
updateMask	string (google-fieldmask)

SELECT examples

get_cmek_config

Gets the Scheduler config in the project/region.

SELECT
name,
kmsKeyName
FROM google.cloudscheduler.cmek_config
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
;

UPDATE examples

update_cmek_config

Initializes or Updates the a scheduler config.

UPDATE google.cloudscheduler.cmek_config
SET 
data__name = '{{ name }}',
data__kmsKeyName = '{{ kmsKeyName }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
done,
error,
metadata,
response;