filters

Creates, updates, deletes or gets a filter resource or lists filters in a region

Overview

Name	filters
Type	Resource
Description	Resource Type definition for AWS::GuardDuty::Filter
Id	awscc.guardduty.filters

Fields

get (all properties)

Name	Datatype	Description
action	string
description	string
detector_id	string
▶finding_criteria	object
rank	integer
name	string
▶tags	array
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
detector_id	string
name	string
region	string	AWS region.

For more information, see AWS::GuardDuty::Filter.

Methods

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

SELECT examples

get (all properties)

Gets all properties from an individual filter.

SELECT
  region,
  action,
  description,
  detector_id,
  finding_criteria,
  rank,
  name,
  tags
FROM awscc.guardduty.filters
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ detector_id }}|{{ name }}';

list (identifiers only)

Lists all filters in a region.

SELECT
  region,
  detector_id,
  name
FROM awscc.guardduty.filters_list_only
WHERE
  region = 'us-east-1';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.guardduty.filters (
  DetectorId,
  FindingCriteria,
  Name,
  region
)
SELECT
  '{{ detector_id }}',
  '{{ finding_criteria }}',
  '{{ name }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.guardduty.filters (
  Action,
  Description,
  DetectorId,
  FindingCriteria,
  Rank,
  Name,
  Tags,
  region
)
SELECT
  '{{ action }}',
  '{{ description }}',
  '{{ detector_id }}',
  '{{ finding_criteria }}',
  '{{ rank }}',
  '{{ name }}',
  '{{ tags }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: filter
    props:
      - name: action
        value: '{{ action }}'
      - name: description
        value: '{{ description }}'
      - name: detector_id
        value: '{{ detector_id }}'
      - name: finding_criteria
        value:
          criterion: {}
      - name: rank
        value: '{{ rank }}'
      - name: name
        value: '{{ name }}'
      - name: tags
        value:
          - key: '{{ key }}'
            value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.guardduty.filters
SET PatchDocument = string('{{ {
    "Action": action,
    "Description": description,
    "FindingCriteria": finding_criteria,
    "Rank": rank,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ detector_id }}|{{ name }}';

DELETE example

/*+ delete */
DELETE FROM awscc.guardduty.filters
WHERE
  Identifier = '{{ detector_id }}|{{ name }}' AND
  region = 'us-east-1';

Permissions

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

Create

guardduty:CreateFilter,
guardduty:GetFilter,
guardduty:TagResource

Read

guardduty:GetFilter,
guardduty:ListTagsForResource

Delete

guardduty:ListDetectors,
guardduty:ListFilters,
guardduty:GetFilter,
guardduty:DeleteFilter

Update

guardduty:UpdateFilter,
guardduty:GetFilter,
guardduty:ListFilters,
guardduty:TagResource,
guardduty:UntagResource

List

guardduty:ListFilters