Package software.amazon.awscdk.services.macie

Class CfnFindingsFilter

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.macie.CfnFindingsFilter
All Implemented Interfaces:
IInspectable, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.97.0 (build 729de35)", date="2024-04-18T17:54:19.667Z") @Stability(Stable) public class CfnFindingsFilter extends CfnResource implements IInspectable, ITaggableV2
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.*;
 CfnFindingsFilter cfnFindingsFilter = CfnFindingsFilter.Builder.create(this, "MyCfnFindingsFilter")
         .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:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnFindingsFilter

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

    • CfnFindingsFilter

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

    • CfnFindingsFilter

      @Stability(Stable) public CfnFindingsFilter(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnFindingsFilterProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(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(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(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the findings filter.

    • getAttrFindingsFilterListItems

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

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()
      The unique identifier for the findings filter.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getFindingCriteria

      @Stability(Stable) @NotNull public Object getFindingCriteria()
      The criteria to use to filter findings.

    • setFindingCriteria

      @Stability(Stable) public void setFindingCriteria(@NotNull IResolvable value)
      The criteria to use to filter findings.

    • setFindingCriteria

      @Stability(Stable) public void setFindingCriteria(@NotNull CfnFindingsFilter.FindingCriteriaProperty value)
      The criteria to use to filter findings.

    • getName

      @Stability(Stable) @NotNull public String getName()
      A custom name for the findings filter.

      The name can contain 3-64 characters.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      A custom name for the findings filter.

      The name can contain 3-64 characters.

    • getAction

      @Stability(Stable) @Nullable public String getAction()
      The action to perform on findings that match the filter criteria ( FindingCriteria ).

      Valid values are:.

    • setAction

      @Stability(Stable) public void setAction(@Nullable String value)
      The action to perform on findings that match the filter criteria ( FindingCriteria ).

      Valid values are:.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      A custom description of the findings filter.

      The description can contain 1-512 characters.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      A custom description of the findings filter.

      The description can contain 1-512 characters.

    • getPosition

      @Stability(Stable) @Nullable public Number getPosition()
      The position of the findings filter in the list of saved filter rules on the Amazon Macie console.

    • setPosition

      @Stability(Stable) public void setPosition(@Nullable Number value)
      The position of the findings filter in the list of saved filter rules on the Amazon Macie console.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      An array of key-value pairs to apply to the findings filter.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      An array of key-value pairs to apply to the findings filter.