automated_discovery_configurations

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

Overview

Name	automated_discovery_configurations
Type	Resource
Id	aws.macie2.automated_discovery_configurations

Fields

The following fields are returned by SELECT queries:

get_automated_discovery_configuration

Name	Datatype	Description
auto_enable_organization_members	string	Specifies whether automated sensitive data discovery is enabled automatically for accounts in the organization. Possible values are: ALL, enable it for all existing accounts and new member accounts; NEW, enable it only for new member accounts; and, NONE, don't enable it for any accounts. (ALL, NEW, NONE)
classification_scope_id	string	The unique identifier for the classification scope that's used when performing automated sensitive data discovery. The classification scope specifies S3 buckets to exclude from analyses. (pattern: <code>^[0-9a-z]*$</code>)
disabled_at	string (date-time)	The date and time, in UTC and extended ISO 8601 format, when automated sensitive data discovery was most recently disabled. This value is null if automated sensitive data discovery is currently enabled.
first_enabled_at	string (date-time)	The date and time, in UTC and extended ISO 8601 format, when automated sensitive data discovery was initially enabled. This value is null if automated sensitive data discovery has never been enabled.
last_updated_at	string (date-time)	The date and time, in UTC and extended ISO 8601 format, when the configuration settings or status of automated sensitive data discovery was most recently changed.
sensitivity_inspection_template_id	string	The unique identifier for the sensitivity inspection template that's used when performing automated sensitive data discovery. The template specifies which allow lists, custom data identifiers, and managed data identifiers to use when analyzing data.
status	string	The current status of automated sensitive data discovery for the organization or account. Possible values are: ENABLED, use the specified settings to perform automated sensitive data discovery activities; and, DISABLED, don't perform automated sensitive data discovery activities. (ENABLED, DISABLED)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_automated_discovery_configuration	select	region		Retrieves the configuration settings and status of automated sensitive data discovery for an organization or standalone account.
update_automated_discovery_configuration	update	region, status		Changes the configuration settings and status of automated sensitive data discovery for an organization or standalone account.

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_automated_discovery_configuration

Retrieves the configuration settings and status of automated sensitive data discovery for an organization or standalone account.

SELECT
auto_enable_organization_members,
classification_scope_id,
disabled_at,
first_enabled_at,
last_updated_at,
sensitivity_inspection_template_id,
status
FROM aws.macie2.automated_discovery_configurations
WHERE region = '{{ region }}' -- required
;

UPDATE examples

update_automated_discovery_configuration

Changes the configuration settings and status of automated sensitive data discovery for an organization or standalone account.

UPDATE aws.macie2.automated_discovery_configurations
SET 
autoEnableOrganizationMembers = '{{ autoEnableOrganizationMembers }}',
status = '{{ status }}'
WHERE 
region = '{{ region }}' --required
AND status = '{{ status }}' --required;