allow_lists

Creates, updates, deletes or gets an allow_list resource or lists allow_lists in a region

Overview

Name	allow_lists
Type	Resource
Description	Macie AllowList resource schema
Id	aws.macie.allow_lists

Fields

Name	Datatype	Description
name	string	Name of AllowList.
description	string	Description of AllowList.
criteria	object	AllowList criteria.
id	string	AllowList ID.
arn	string	AllowList ARN.
status	string	AllowList status.
tags	array	A collection of tags associated with a resource
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	Name, Criteria, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all allow_lists in a region.

SELECT
region,
name,
description,
criteria,
id,
arn,
status,
tags
FROM aws.macie.allow_lists
WHERE region = 'us-east-1';

Gets all properties from an individual allow_list.

SELECT
region,
name,
description,
criteria,
id,
arn,
status,
tags
FROM aws.macie.allow_lists
WHERE region = 'us-east-1' AND data__Identifier = '<Id>';

INSERT example

Use the following StackQL query and manifest file to create a new allow_list resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.macie.allow_lists (
 Name,
 Criteria,
 region
)
SELECT 
'{{ Name }}',
 '{{ Criteria }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.macie.allow_lists (
 Name,
 Description,
 Criteria,
 Tags,
 region
)
SELECT 
 '{{ Name }}',
 '{{ Description }}',
 '{{ Criteria }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: allow_list
    props:
      - name: Name
        value: '{{ Name }}'
      - name: Description
        value: '{{ Description }}'
      - name: Criteria
        value: {}
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.macie.allow_lists
WHERE data__Identifier = '<Id>'
AND region = 'us-east-1';

Permissions

To operate on the allow_lists resource, the following permissions are required:

Create

macie2:CreateAllowList,
macie2:GetAllowList,
macie2:TagResource

Read

macie2:GetAllowList

Update

macie2:UpdateAllowList,
macie2:GetAllowList,
macie2:TagResource,
macie2:UntagResource

Delete

macie2:DeleteAllowList

List

macie2:ListAllowLists