findings_filters

Creates, updates, deletes or gets a findings_filter resource or lists findings_filters in a region

Overview

Name	findings_filters
Type	Resource
Description	Macie FindingsFilter resource schema.
Id	aws.macie.findings_filters

Fields

Name	Datatype	Description
name	string	Findings filter name
description	string	Findings filter description
finding_criteria	object	Findings filter criteria.
action	string	Findings filter action.
position	integer	Findings filter position.
id	string	Findings filter ID.
arn	string	Findings filter ARN.
tags	array	A collection of tags associated with a resource
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	Name, FindingCriteria, 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 findings_filters in a region.

SELECT
region,
name,
description,
finding_criteria,
action,
position,
id,
arn,
tags
FROM aws.macie.findings_filters
WHERE region = 'us-east-1';

Gets all properties from an individual findings_filter.

SELECT
region,
name,
description,
finding_criteria,
action,
position,
id,
arn,
tags
FROM aws.macie.findings_filters
WHERE region = 'us-east-1' AND data__Identifier = '<Id>';

INSERT example

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

Required Properties

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

All Properties

/*+ create */
INSERT INTO aws.macie.findings_filters (
 Name,
 Description,
 FindingCriteria,
 Action,
 Position,
 Tags,
 region
)
SELECT 
 '{{ Name }}',
 '{{ Description }}',
 '{{ FindingCriteria }}',
 '{{ Action }}',
 '{{ Position }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: findings_filter
    props:
      - name: Name
        value: '{{ Name }}'
      - name: Description
        value: '{{ Description }}'
      - name: FindingCriteria
        value:
          Criterion: {}
      - name: Action
        value: '{{ Action }}'
      - name: Position
        value: '{{ Position }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

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

Permissions

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

Create

macie2:GetFindingsFilter,
macie2:CreateFindingsFilter,
macie2:TagResource

Read

macie2:GetFindingsFilter

Update

macie2:GetFindingsFilter,
macie2:UpdateFindingsFilter,
macie2:TagResource,
macie2:UntagResource

Delete

macie2:DeleteFindingsFilter

List

macie2:ListFindingsFilters