software.amazon.awscdk.services.macie

Class CfnFindingsFilter

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.macie.CfnFindingsFilter

All Implemented Interfaces:

IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-12-07T17:24:36.940Z")
 @Stability(value=Stable)
public class CfnFindingsFilter
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Macie::FindingsFilter`.

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 findings 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 to ensure that an AWS::Macie::Session resource is created before other Macie resources are created for an account. For example, "DependsOn": "Session" .

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;
 CfnFindingsFilter cfnFindingsFilter = CfnFindingsFilter.Builder.create(this, "MyCfnFindingsFilter")
         .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	Class and Description
static class	CfnFindingsFilter.Builder A fluent builder for CfnFindingsFilter.
static interface	CfnFindingsFilter.FindingCriteriaProperty Specifies, as a map, one or more property-based conditions that filter the results of a query for findings.
static interface	CfnFindingsFilter.FindingsFilterListItemProperty Specifies the unique identifier and custom name of a findings filter.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnFindingsFilter(Construct scope, String id, CfnFindingsFilterProps props) Create a new `AWS::Macie::FindingsFilter`.
protected	CfnFindingsFilter(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnFindingsFilter(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAction() The action to perform on findings that match the filter criteria ( `FindingCriteria` ).
String	getAttrArn() The Amazon Resource Name (ARN) of the findings filter.
IResolvable	getAttrFindingsFilterListItems() An array of `FindingsFilterListItem` objects, one for each findings filter that's associated with the account.
String	getAttrId() The unique identifier for the findings filter.
protected Map<String,Object>	getCfnProperties()
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.
Number	getPosition() The position of the findings filter in the list of saved filters on the Amazon Macie console.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAction(String value) The action to perform on findings that match the filter criteria ( `FindingCriteria` ).
void	setDescription(String value) A custom description of the findings filter.
void	setFindingCriteria(CfnFindingsFilter.FindingCriteriaProperty value) The criteria to use to filter findings.
void	setFindingCriteria(IResolvable value) The criteria to use to filter findings.
void	setName(String value) A custom name for the findings filter.
void	setPosition(Number value) The position of the findings filter in the list of saved filters on the Amazon Macie console.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnFindingsFilter

protected CfnFindingsFilter(software.amazon.jsii.JsiiObjectRef objRef)

CfnFindingsFilter

protected CfnFindingsFilter(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnFindingsFilter

@Stability(value=Stable)
public CfnFindingsFilter(@NotNull
                                                  Construct scope,
                                                  @NotNull
                                                  String id,
                                                  @NotNull
                                                  CfnFindingsFilterProps props)

Create a new `AWS::Macie::FindingsFilter`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(value=Stable)
 @NotNull
public String getAttrArn()

The Amazon Resource Name (ARN) of the findings filter.

getAttrFindingsFilterListItems

@Stability(value=Stable)
 @NotNull
public IResolvable getAttrFindingsFilterListItems()

An array of `FindingsFilterListItem` objects, one for each findings filter that's associated with the account.

getAttrId

@Stability(value=Stable)
 @NotNull
public String getAttrId()

The unique identifier for the findings filter.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getFindingCriteria

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

The criteria to use to filter findings.

setFindingCriteria

@Stability(value=Stable)
public void setFindingCriteria(@NotNull
                                                        IResolvable value)

The criteria to use to filter findings.

setFindingCriteria

@Stability(value=Stable)
public void setFindingCriteria(@NotNull
                                                        CfnFindingsFilter.FindingCriteriaProperty value)

The criteria to use to filter findings.

getName

@Stability(value=Stable)
 @NotNull
public 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 .

setName

@Stability(value=Stable)
public void setName(@NotNull
                                             String value)

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 .

getAction

@Stability(value=Stable)
 @Nullable
public 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.

setAction

@Stability(value=Stable)
public void setAction(@Nullable
                                               String value)

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.

getDescription

@Stability(value=Stable)
 @Nullable
public 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 .

setDescription

@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)

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 .

getPosition

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

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.

setPosition

@Stability(value=Stable)
public void setPosition(@Nullable
                                                 Number value)

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.