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	awscc.macie.allow_lists

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
id	string	AllowList ID.
region	string	AWS region.

For more information, see AWS::Macie::AllowList.

Methods

Name	Resource	Accessible by	Required Params
create_resource	allow_lists	INSERT	Name, Criteria, region
delete_resource	allow_lists	DELETE	Identifier, region
update_resource	allow_lists	UPDATE	Identifier, PatchDocument, region
list_resources	allow_lists_list_only	SELECT	region
get_resource	allow_lists	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual allow_list.

SELECT
  region,
  name,
  description,
  criteria,
  id,
  arn,
  status,
  tags
FROM awscc.macie.allow_lists
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ id }}';

list (identifiers only)

Lists all allow_lists in a region.

SELECT
  region,
  id
FROM awscc.macie.allow_lists_list_only
WHERE
  region = 'us-east-1';

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 awscc.macie.allow_lists (
  Name,
  Criteria,
  region
)
SELECT
  '{{ name }}',
  '{{ criteria }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.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 }}'

UPDATE example

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

/*+ update */
UPDATE awscc.macie.allow_lists
SET PatchDocument = string('{{ {
    "Name": name,
    "Description": description,
    "Criteria": criteria,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ id }}';

DELETE example

/*+ delete */
DELETE FROM awscc.macie.allow_lists
WHERE
  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