allow_lists

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

Overview

Name	allow_lists
Type	Resource
Id	aws.macie2.allow_lists

Fields

The following fields are returned by SELECT queries:

get_allow_list

Name	Datatype	Description
id	string	The unique identifier for the allow list. (pattern: <code>^[a-z0-9]{22}$</code>)
name	string	The custom name of the allow list. (pattern: <code>^.+$</code>)
arn	string	The Amazon Resource Name (ARN) of the allow list. (pattern: <code>^arn:(aws|aws-cn|aws-us-gov):macie2:[a-z1-9-]{9,20}:\d{12}:allow-list/[a-z0-9]{22}$</code>)
created_at	string (date-time)	The date and time, in UTC and extended ISO 8601 format, when the allow list was created in Amazon Macie.
criteria	object	Specifies the criteria for an allow list. The criteria must specify a regular expression (regex) or an S3 object (s3WordsList). It can't specify both.
description	string	The custom description of the allow list. (pattern: <code>^[\s\S]+$</code>)
status	object	The current status of the allow list, which indicates whether Amazon Macie can access and use the list's criteria.
tags	object	A map of key-value pairs that specifies which tags (keys and values) are associated with the allow list.
updated_at	string (date-time)	The date and time, in UTC and extended ISO 8601 format, when the allow list's settings were most recently changed in Amazon Macie.

list_allow_lists

Name	Datatype	Description
id	string	The unique identifier for the allow list. (pattern: <code>^[a-z0-9]{22}$</code>)
name	string	The custom name of the allow list. (pattern: <code>^.+$</code>)
arn	string	The Amazon Resource Name (ARN) of the allow list. (pattern: <code>^arn:(aws|aws-cn|aws-us-gov):macie2:[a-z1-9-]{9,20}:\d{12}:allow-list/[a-z0-9]{22}$</code>)
created_at	string (date-time)	The date and time, in UTC and extended ISO 8601 format, when the allow list was created in Amazon Macie.
description	string	The custom description of the allow list. (pattern: <code>^[\s\S]+$</code>)
updated_at	string (date-time)	The date and time, in UTC and extended ISO 8601 format, when the allow list's settings were most recently changed in Amazon Macie.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_allow_list	select	id, region		Retrieves the settings and status of an allow list.
list_allow_lists	select	region	maxResults, nextToken	Retrieves a subset of information about all the allow lists for an account.
create_allow_list	insert	region, clientToken, criteria, name		Creates and defines the settings for an allow list.
update_allow_list	update	id, region, criteria, name		Updates the settings for an allow list.
delete_allow_list	delete	id, region	ignoreJobChecks	Deletes an allow list.

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
id	string	The unique identifier for the Amazon Macie resource that the request applies to.
region	string	AWS region (default: us-east-1)
ignoreJobChecks	string	Specifies whether to force deletion of the allow list, even if active classification jobs are configured to use the list. When you try to delete an allow list, Amazon Macie checks for classification jobs that use the list and have a status other than COMPLETE or CANCELLED. By default, Macie rejects your request if any jobs meet these criteria. To skip these checks and delete the list, set this value to true. To delete the list only if no active jobs are configured to use it, set this value to false.
maxResults	integer	The maximum number of items to include in each page of a paginated response.
nextToken	string	The nextToken string that specifies which page of results to return in a paginated response.

SELECT examples

get_allow_list

Retrieves the settings and status of an allow list.

SELECT
id,
name,
arn,
created_at,
criteria,
description,
status,
tags,
updated_at
FROM aws.macie2.allow_lists
WHERE id = '{{ id }}' -- required
AND region = '{{ region }}' -- required
;

list_allow_lists

Retrieves a subset of information about all the allow lists for an account.

SELECT
id,
name,
arn,
created_at,
description,
updated_at
FROM aws.macie2.allow_lists
WHERE region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

INSERT examples

create_allow_list

Creates and defines the settings for an allow list.

INSERT INTO aws.macie2.allow_lists (
clientToken,
criteria,
description,
name,
tags,
region
)
SELECT 
'{{ clientToken }}' /* required */,
'{{ criteria }}' /* required */,
'{{ description }}',
'{{ name }}' /* required */,
'{{ tags }}',
'{{ region }}'
RETURNING
id,
arn
;

Manifest

# Description fields are for documentation purposes
- name: allow_lists
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the allow_lists resource.
  - name: clientToken
    value: "{{ clientToken }}"
  - name: criteria
    description: |
      Specifies the criteria for an allow list. The criteria must specify a regular expression (regex) or an S3 object (s3WordsList). It can't specify both.
    value:
      regex: "{{ regex }}"
      s3WordsList:
        bucketName: "{{ bucketName }}"
        objectKey: "{{ objectKey }}"
  - name: description
    value: "{{ description }}"
  - name: name
    value: "{{ name }}"
  - name: tags
    value: "{{ tags }}"
    description: |
      A string-to-string map of key-value pairs that specifies the tags (keys and values) for an Amazon Macie resource.

UPDATE examples

update_allow_list

Updates the settings for an allow list.

UPDATE aws.macie2.allow_lists
SET 
criteria = '{{ criteria }}',
description = '{{ description }}',
name = '{{ name }}'
WHERE 
id = '{{ id }}' --required
AND region = '{{ region }}' --required
AND criteria = '{{ criteria }}' --required
AND name = '{{ name }}' --required
RETURNING
id,
arn;

DELETE examples

delete_allow_list

Deletes an allow list.

DELETE FROM aws.macie2.allow_lists
WHERE id = '{{ id }}' --required
AND region = '{{ region }}' --required
AND ignoreJobChecks = '{{ ignoreJobChecks }}'
;