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

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
id	string	Findings filter ID.
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	findings_filters	INSERT	Name, FindingCriteria, region
delete_resource	findings_filters	DELETE	Identifier, region
update_resource	findings_filters	UPDATE	Identifier, PatchDocument, region
list_resources	findings_filters_list_only	SELECT	region
get_resource	findings_filters	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual findings_filter.

SELECT
  region,
  name,
  description,
  finding_criteria,
  action,
  position,
  id,
  arn,
  tags
FROM awscc.macie.findings_filters
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ id }}';

list (identifiers only)

Lists all findings_filters in a region.

SELECT
  region,
  id
FROM awscc.macie.findings_filters_list_only
WHERE
  region = '{{ region }}';

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 awscc.macie.findings_filters (
  Name,
  FindingCriteria,
  region
)
SELECT
  '{{ name }}',
  '{{ finding_criteria }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.macie.findings_filters (
  Name,
  Description,
  FindingCriteria,
  Action,
  Position,
  Tags,
  region
)
SELECT
  '{{ name }}',
  '{{ description }}',
  '{{ finding_criteria }}',
  '{{ action }}',
  '{{ position }}',
  '{{ tags }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

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: finding_criteria
      value:
        criterion: {}
    - name: action
      value: '{{ action }}'
    - name: position
      value: '{{ position }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.macie.findings_filters
SET PatchDocument = string('{{ {
    "Name": name,
    "Description": description,
    "FindingCriteria": finding_criteria,
    "Action": action,
    "Position": position,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ id }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.macie.findings_filters
WHERE
  Identifier = '{{ id }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

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