encryption_configs

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

Overview

Name	encryption_configs
Type	Resource
Id	google.dataplex.encryption_configs

Fields

The following fields are returned by SELECT queries:

organizations_locations_encryption_configs_get

Successful response

Name	Datatype	Description
name	string	Identifier. The resource name of the EncryptionConfig. Format: organizations/{organization}/locations/{location}/encryptionConfigs/{encryption_config} Global location is not supported.
createTime	string (google-datetime)	Output only. The time when the Encryption configuration was created.
encryptionState	string	Output only. The state of encryption of the databases.
etag	string	Etag of the EncryptionConfig. This is a strong etag.
failureDetails	object	Output only. Details of the failure if anything related to Cmek db fails. (id: GoogleCloudDataplexV1EncryptionConfigFailureDetails)
key	string	Optional. If a key is chosen, it means that the customer is using CMEK. If a key is not chosen, it means that the customer is using Google managed encryption.
updateTime	string (google-datetime)	Output only. The time when the Encryption configuration was last updated.

organizations_locations_encryption_configs_list

Successful response

Name	Datatype	Description
name	string	Identifier. The resource name of the EncryptionConfig. Format: organizations/{organization}/locations/{location}/encryptionConfigs/{encryption_config} Global location is not supported.
createTime	string (google-datetime)	Output only. The time when the Encryption configuration was created.
encryptionState	string	Output only. The state of encryption of the databases.
etag	string	Etag of the EncryptionConfig. This is a strong etag.
failureDetails	object	Output only. Details of the failure if anything related to Cmek db fails. (id: GoogleCloudDataplexV1EncryptionConfigFailureDetails)
key	string	Optional. If a key is chosen, it means that the customer is using CMEK. If a key is not chosen, it means that the customer is using Google managed encryption.
updateTime	string (google-datetime)	Output only. The time when the Encryption configuration was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
organizations_locations_encryption_configs_get	select	organizationsId, locationsId, encryptionConfigsId		Get an EncryptionConfig.
organizations_locations_encryption_configs_list	select	organizationsId, locationsId	pageSize, pageToken, filter, orderBy	List EncryptionConfigs.
organizations_locations_encryption_configs_create	insert	organizationsId, locationsId	encryptionConfigId	Create an EncryptionConfig.
organizations_locations_encryption_configs_patch	update	organizationsId, locationsId, encryptionConfigsId	updateMask	Update an EncryptionConfig.
organizations_locations_encryption_configs_delete	delete	organizationsId, locationsId, encryptionConfigsId	etag	Delete an EncryptionConfig.

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
encryptionConfigsId	string
locationsId	string
organizationsId	string
encryptionConfigId	string
etag	string
filter	string
orderBy	string
pageSize	integer (int32)
pageToken	string
updateMask	string (google-fieldmask)

SELECT examples

organizations_locations_encryption_configs_get

Get an EncryptionConfig.

SELECT
name,
createTime,
encryptionState,
etag,
failureDetails,
key,
updateTime
FROM google.dataplex.encryption_configs
WHERE organizationsId = '{{ organizationsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND encryptionConfigsId = '{{ encryptionConfigsId }}' -- required;

organizations_locations_encryption_configs_list

List EncryptionConfigs.

SELECT
name,
createTime,
encryptionState,
etag,
failureDetails,
key,
updateTime
FROM google.dataplex.encryption_configs
WHERE organizationsId = '{{ organizationsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}';

INSERT examples

organizations_locations_encryption_configs_create

Create an EncryptionConfig.

INSERT INTO google.dataplex.encryption_configs (
data__name,
data__key,
data__etag,
organizationsId,
locationsId,
encryptionConfigId
)
SELECT 
'{{ name }}',
'{{ key }}',
'{{ etag }}',
'{{ organizationsId }}',
'{{ locationsId }}',
'{{ encryptionConfigId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: encryption_configs
  props:
    - name: organizationsId
      value: string
      description: Required parameter for the encryption_configs resource.
    - name: locationsId
      value: string
      description: Required parameter for the encryption_configs resource.
    - name: name
      value: string
      description: >
        Identifier. The resource name of the EncryptionConfig. Format: organizations/{organization}/locations/{location}/encryptionConfigs/{encryption_config} Global location is not supported.
        
    - name: key
      value: string
      description: >
        Optional. If a key is chosen, it means that the customer is using CMEK. If a key is not chosen, it means that the customer is using Google managed encryption.
        
    - name: etag
      value: string
      description: >
        Etag of the EncryptionConfig. This is a strong etag.
        
    - name: encryptionConfigId
      value: string

UPDATE examples

organizations_locations_encryption_configs_patch

Update an EncryptionConfig.

UPDATE google.dataplex.encryption_configs
SET 
data__name = '{{ name }}',
data__key = '{{ key }}',
data__etag = '{{ etag }}'
WHERE 
organizationsId = '{{ organizationsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND encryptionConfigsId = '{{ encryptionConfigsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

organizations_locations_encryption_configs_delete

Delete an EncryptionConfig.

DELETE FROM google.dataplex.encryption_configs
WHERE organizationsId = '{{ organizationsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND encryptionConfigsId = '{{ encryptionConfigsId }}' --required
AND etag = '{{ etag }}';