AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::Macie::FindingsFilter

CfnFindingsFilter

The `AWS::Macie::FindingsFilter` resource specifies a findings filter. In Amazon Macie , a *findings filter* , also referred to as a *filter rule* , is a set of custom criteria that specifies which findings to include or exclude from the results of a query for findings. The criteria can help you identify and focus on findings that have specific characteristics, such as severity, type, or the name of an affected AWS resource. You can also configure a findings filter to suppress (automatically archive) findings that match the filter's criteria. For more information, see [Filtering Macie findings](https://docs.aws.amazon.com/macie/latest/user/findings-filter-overview.html) in the *Amazon Macie User Guide* . An `AWS::Macie::Session` resource must exist for an AWS account before you can create an `AWS::Macie::FindingsFilter` resource for the account. Use a [DependsOn attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) to ensure that an `AWS::Macie::Session` resource is created before other Macie resources are created for an account. For example, `"DependsOn": "Session"` .

Import

import { CfnFindingsFilter } from 'aws-cdk-lib/aws-macie';

Or use the module namespace:

import * as macie from 'aws-cdk-lib/aws-macie';
// macie.CfnFindingsFilter

Properties

Configuration passed to the constructor as CfnFindingsFilterProps.

findingCriteriaRequired
IResolvable | FindingCriteriaProperty

The criteria to use to filter findings.

nameRequired
string

A custom name for the findings filter. The name can contain 3-64 characters. Avoid including sensitive data in the name. Users of the account might be able to see the name, depending on the actions that they're allowed to perform in Amazon Macie .

actionOptional
string

The action to perform on findings that match the filter criteria ( `FindingCriteria` ). Valid values are:. - `ARCHIVE` - Suppress (automatically archive) the findings. - `NOOP` - Don't perform any action on the findings.

descriptionOptional
string

A custom description of the findings filter. The description can contain 1-512 characters. Avoid including sensitive data in the description. Users of the account might be able to see the description, depending on the actions that they're allowed to perform in Amazon Macie .

positionOptional
number

The position of the findings filter in the list of saved filter rules on the Amazon Macie console. This value also determines the order in which the filter is applied to findings, relative to other filters that are also applied to findings.

tagsOptional
CfnTag[]

An array of key-value pairs to apply to the findings filter. For more information, see [Resource tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

AWS::Macie::FindingsFilterView in CloudFormation Explorer

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-macie
CFN TypeAWS::Macie::FindingsFilter
Properties6

Related Constructs

Explore This Service

External Links