interface CfnFindingsFilterProps
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.Macie.CfnFindingsFilterProps |
Java | software.amazon.awscdk.services.macie.CfnFindingsFilterProps |
Python | aws_cdk.aws_macie.CfnFindingsFilterProps |
TypeScript | @aws-cdk/aws-macie » CfnFindingsFilterProps |
Properties for defining a CfnFindingsFilter
.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as macie from '@aws-cdk/aws-macie';
const cfnFindingsFilterProps: macie.CfnFindingsFilterProps = {
findingCriteria: {
criterion: {
criterionKey: {
eq: ['eq'],
gt: 123,
gte: 123,
lt: 123,
lte: 123,
neq: ['neq'],
},
},
},
name: 'name',
// the properties below are optional
action: 'action',
description: 'description',
position: 123,
};
Properties
Name | Type | Description |
---|---|---|
finding | IResolvable | Finding | The criteria to use to filter findings. |
name | string | A custom name for the findings filter. The name can contain 3-64 characters. |
action? | string | The action to perform on findings that match the filter criteria ( FindingCriteria ). Valid values are:. |
description? | string | A custom description of the findings filter. The description can contain 1-512 characters. |
position? | number | The position of the findings filter in the list of saved filters on the Amazon Macie console. |
findingCriteria
Type:
IResolvable
|
Finding
The criteria to use to filter findings.
name
Type:
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 .
action?
Type:
string
(optional)
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.
description?
Type:
string
(optional)
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 .
position?
Type:
number
(optional)
The position of the findings filter in the list of saved filters 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.