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.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:40.746Z")
 @Stability(value=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.*;
 Object criterion;
 CfnFindingsFilterProps cfnFindingsFilterProps = CfnFindingsFilterProps.builder()
         .findingCriteria(FindingCriteriaProperty.builder()
                 .criterion(criterion)
                 .build())
         .name("name")
         // the properties below are optional
         .action("action")
         .description("description")
         .position(123)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnFindingsFilterProps.Builder	builder()
default String	getAction() The action to perform on findings that meet the filter criteria ( `FindingCriteria` ).
default String	getDescription() A custom description of the filter.
Object	getFindingCriteria() The criteria to use to filter findings.
String	getName() A custom name for the filter.
default Number	getPosition() The position of the filter in the list of saved filters on the Amazon Macie console.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getFindingCriteria

@Stability(value=Stable)
 @NotNull
Object getFindingCriteria()

The criteria to use to filter findings.

getName

@Stability(value=Stable)
 @NotNull
String getName()

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 .

getAction

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

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.

getDescription

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

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 .

getPosition

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

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.

builder

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

Returns:

a CfnFindingsFilterProps.Builder of CfnFindingsFilterProps