encryption_configs

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

Overview

Name	encryption_configs
Type	Resource
Id	aws.xray.encryption_configs

Fields

The following fields are returned by SELECT queries:

get_encryption_config

Name	Datatype	Description
key_id	string	The ID of the KMS key used for encryption, if applicable.
status	string	The encryption status. While the status is UPDATING, X-Ray may encrypt data with a combination of the new and old settings. (UPDATING, ACTIVE)
type	string	The type of encryption. Set to KMS for encryption with KMS keys. Set to NONE for default encryption. (NONE, KMS)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_encryption_config	select	region		Retrieves the current encryption configuration for X-Ray data.
put_encryption_config	replace	region, Type		Updates the encryption configuration for X-Ray data.

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
region	string	AWS region (default: us-east-1)

SELECT examples

get_encryption_config

Retrieves the current encryption configuration for X-Ray data.

SELECT
key_id,
status,
type
FROM aws.xray.encryption_configs
WHERE region = '{{ region }}' -- required
;

REPLACE examples

put_encryption_config

Updates the encryption configuration for X-Ray data.

REPLACE aws.xray.encryption_configs
SET 
KeyId = '{{ KeyId }}',
Type = '{{ Type }}'
WHERE 
region = '{{ region }}' --required
AND Type = '{{ Type }}' --required
RETURNING
encryption_config;