encryption_keys

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

Overview

Name	encryption_keys
Type	Resource
Id	aws.inspector2.encryption_keys

Fields

The following fields are returned by SELECT queries:

get_encryption_key

Name	Datatype	Description
kms_key_id	string	A kms key ID. (pattern: <code>arn:aws(-(us-gov|cn))?:kms:([a-z0-9][-.a-z0-9]{0,62})?:[0-9]{12}?:key/(([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})|(mrk-[0-9a-zA-Z]{32}))</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_encryption_key	select	scanType, resourceType, region		Gets an encryption key.
update_encryption_key	update	region, kmsKeyId, scanType, resourceType		Updates an encryption key. A ResourceNotFoundException means that an Amazon Web Services owned key is being used for encryption.

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)
resourceType	string	The resource type the key encrypts.
scanType	string	The scan type the key encrypts.

SELECT examples

get_encryption_key

Gets an encryption key.

SELECT
kms_key_id
FROM aws.inspector2.encryption_keys
WHERE scanType = '{{ scanType }}' -- required
AND resourceType = '{{ resourceType }}' -- required
AND region = '{{ region }}' -- required
;

UPDATE examples

update_encryption_key

Updates an encryption key. A ResourceNotFoundException means that an Amazon Web Services owned key is being used for encryption.

UPDATE aws.inspector2.encryption_keys
SET 
kmsKeyId = '{{ kmsKeyId }}',
scanType = '{{ scanType }}',
resourceType = '{{ resourceType }}'
WHERE 
region = '{{ region }}' --required
AND kmsKeyId = '{{ kmsKeyId }}' --required
AND scanType = '{{ scanType }}' --required
AND resourceType = '{{ resourceType }}' --required;