reveal_configurations

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

Overview

Name	reveal_configurations
Type	Resource
Id	aws.macie2.reveal_configurations

Fields

The following fields are returned by SELECT queries:

get_reveal_configuration

Name	Datatype	Description
configuration	object	The KMS key that's used to encrypt the sensitive data, and the status of the configuration for the Amazon Macie account.
retrieval_configuration	object	The access method and settings that are used to retrieve the sensitive data.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_reveal_configuration	select	region		Retrieves the status and configuration settings for retrieving occurrences of sensitive data reported by findings.
update_reveal_configuration	update	region, configuration		Updates the status and configuration settings for retrieving occurrences of sensitive data reported by findings.

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_reveal_configuration

Retrieves the status and configuration settings for retrieving occurrences of sensitive data reported by findings.

SELECT
configuration,
retrieval_configuration
FROM aws.macie2.reveal_configurations
WHERE region = '{{ region }}' -- required
;

UPDATE examples

update_reveal_configuration

Updates the status and configuration settings for retrieving occurrences of sensitive data reported by findings.

UPDATE aws.macie2.reveal_configurations
SET 
configuration = '{{ configuration }}',
retrievalConfiguration = '{{ retrievalConfiguration }}'
WHERE 
region = '{{ region }}' --required
AND configuration = '{{ configuration }}' --required
RETURNING
configuration,
retrieval_configuration;