ekm_config

Creates, updates, deletes, gets or lists an ekm_config resource.

Overview

Name	ekm_config
Type	Resource
Id	google.cloudkms.ekm_config

Fields

The following fields are returned by SELECT queries:

get_ekm_config

Successful response

Name	Datatype	Description
name	string	Output only. The resource name for the EkmConfig in the format projects/*/locations/*/ekmConfig.
defaultEkmConnection	string	Optional. Resource name of the default EkmConnection. Setting this field to the empty string removes the default.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_ekm_config	select	projectsId, locationsId		Returns the EkmConfig singleton resource for a given project and location.
update_ekm_config	update	projectsId, locationsId	updateMask	Updates the EkmConfig singleton resource for a given project and location.

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_ekm_config

Returns the EkmConfig singleton resource for a given project and location.

SELECT
name,
defaultEkmConnection
FROM google.cloudkms.ekm_config
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required;

UPDATE examples

update_ekm_config

Updates the EkmConfig singleton resource for a given project and location.

UPDATE google.cloudkms.ekm_config
SET 
data__defaultEkmConnection = '{{ defaultEkmConnection }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
defaultEkmConnection;