CfnFindingsFilterProps

class aws_cdk.aws_macie.CfnFindingsFilterProps(*, finding_criteria, name, action=None, description=None, position=None)

Bases: object

Properties for defining a CfnFindingsFilter.

Parameters
  • finding_criteria (Union[FindingCriteriaProperty, Dict[str, Any], IResolvable]) – The criteria to use to filter findings.

  • name (str) – A custom name for the filter. The name must contain at least 3 characters and can contain as many as 64 characters. We strongly recommend that you avoid including any sensitive data in the name of a filter. Other users might be able to see the filter’s name, depending on the actions that they’re allowed to perform in Amazon Macie .

  • action (Optional[str]) – The action to perform on findings that meet the filter criteria ( FindingCriteria ). Valid values are:. - ARCHIVE - Suppress (automatically archive) the findings. - NOOP - Don’t perform any action on the findings.

  • description (Optional[str]) – A custom description of the filter. The description can contain as many as 512 characters. We strongly recommend that you avoid including any sensitive data in the description of a filter. Other users might be able to see the filter’s description, depending on the actions that they’re allowed to perform in Amazon Macie .

  • position (Union[int, float, None]) – The position of the 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 the findings.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-macie-findingsfilter.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_macie as macie

# criterion: Any

cfn_findings_filter_props = macie.CfnFindingsFilterProps(
    finding_criteria=macie.CfnFindingsFilter.FindingCriteriaProperty(
        criterion=criterion
    ),
    name="name",

    # the properties below are optional
    action="action",
    description="description",
    position=123
)

Attributes

action

.

  • ARCHIVE - Suppress (automatically archive) the findings.

  • NOOP - Don’t perform any action on the findings.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-macie-findingsfilter.html#cfn-macie-findingsfilter-action

Type

The action to perform on findings that meet the filter criteria ( FindingCriteria ). Valid values are

Return type

Optional[str]

description

A custom description of the filter. The description can contain as many as 512 characters.

We strongly recommend that you avoid including any sensitive data in the description of a filter. Other users might be able to see the filter’s description, depending on the actions that they’re allowed to perform in Amazon Macie .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-macie-findingsfilter.html#cfn-macie-findingsfilter-description

Return type

Optional[str]

finding_criteria

The criteria to use to filter findings.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-macie-findingsfilter.html#cfn-macie-findingsfilter-findingcriteria

Return type

Union[FindingCriteriaProperty, IResolvable]

name

A custom name for the filter.

The name must contain at least 3 characters and can contain as many as 64 characters.

We strongly recommend that you avoid including any sensitive data in the name of a filter. Other users might be able to see the filter’s name, depending on the actions that they’re allowed to perform in Amazon Macie .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-macie-findingsfilter.html#cfn-macie-findingsfilter-name

Return type

str

position

The position of the 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 the findings.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-macie-findingsfilter.html#cfn-macie-findingsfilter-position

Return type

Union[int, float, None]