Package software.amazon.awscdk.services.macie

Interface CfnFindingsFilterProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnFindingsFilterProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.97.0 (build 729de35)",
           date="2024-04-24T21:00:32.342Z")
@Stability(Stable)
public interface CfnFindingsFilterProps
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.macie.*;
 CfnFindingsFilterProps cfnFindingsFilterProps = CfnFindingsFilterProps.builder()
         .findingCriteria(FindingCriteriaProperty.builder()
                 .criterion(Map.of(
                         "criterionKey", CriterionAdditionalPropertiesProperty.builder()
                                 .eq(List.of("eq"))
                                 .gt(123)
                                 .gte(123)
                                 .lt(123)
                                 .lte(123)
                                 .neq(List.of("neq"))
                                 .build()))
                 .build())
         .name("name")
         // the properties below are optional
         .action("action")
         .description("description")
         .position(123)
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnFindingsFilterProps.Builder	A builder for CfnFindingsFilterProps
static final class	CfnFindingsFilterProps.Jsii$Proxy	An implementation for CfnFindingsFilterProps

Method Summary

Modifier and Type	Method	Description
static CfnFindingsFilterProps.Builder	builder()
default String	getAction()	The action to perform on findings that match the filter criteria ( FindingCriteria ).
default String	getDescription()	A custom description of the findings filter.
Object	getFindingCriteria()	The criteria to use to filter findings.
String	getName()	A custom name for the findings filter.
default Number	getPosition()	The position of the findings filter in the list of saved filter rules on the Amazon Macie console.
default List<CfnTag>	getTags()	An array of key-value pairs to apply to the findings filter.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getFindingCriteria

@Stability(Stable)
@NotNull
Object getFindingCriteria()

The criteria to use to filter findings.

See Also:

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

getName

@Stability(Stable)
@NotNull
String getName()

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 .

See Also:

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

getAction

@Stability(Stable)
@Nullable
default String getAction()

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.

See Also:

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

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

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 .

See Also:

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

getPosition

@Stability(Stable)
@Nullable
default Number getPosition()

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.

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

An array of key-value pairs to apply to the findings filter.

For more information, see Resource tag .

See Also:

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

builder

@Stability(Stable)
static CfnFindingsFilterProps.Builder builder()

Returns:

a CfnFindingsFilterProps.Builder of CfnFindingsFilterProps