software.amazon.awscdk.services.guardduty

Interface CfnFilterProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnFilterProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-12-07T17:24:35.411Z")
 @Stability(value=Stable)
public interface CfnFilterProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `CfnFilter`.

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.guardduty.*;
 Object criterion;
 CfnFilterProps cfnFilterProps = CfnFilterProps.builder()
         .action("action")
         .description("description")
         .detectorId("detectorId")
         .findingCriteria(FindingCriteriaProperty.builder()
                 .criterion(criterion)
                 .itemType(ConditionProperty.builder()
                         .eq(List.of("eq"))
                         .equalTo(List.of("equalTo"))
                         .greaterThan(123)
                         .greaterThanOrEqual(123)
                         .gt(123)
                         .gte(123)
                         .lessThan(123)
                         .lessThanOrEqual(123)
                         .lt(123)
                         .lte(123)
                         .neq(List.of("neq"))
                         .notEquals(List.of("notEquals"))
                         .build())
                 .build())
         .name("name")
         .rank(123)
         // the properties below are optional
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnFilterProps.Builder	builder()
String	getAction() Specifies the action that is to be applied to the findings that match the filter.
String	getDescription() The description of the filter.
String	getDetectorId() The ID of the detector belonging to the GuardDuty account that you want to create a filter for.
Object	getFindingCriteria() Represents the criteria to be used in the filter for querying findings.
String	getName() The name of the filter.
Number	getRank() Specifies the position of the filter in the list of current filters.
default List<CfnTag>	getTags() The tags to be added to a new filter resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAction

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

Specifies the action that is to be applied to the findings that match the filter.

getDescription

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

The description of the filter.

getDetectorId

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

The ID of the detector belonging to the GuardDuty account that you want to create a filter for.

getFindingCriteria

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

Represents the criteria to be used in the filter for querying findings.

getName

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

The name of the filter.

Minimum length of 3. Maximum length of 64. Valid characters include alphanumeric characters, dot (.), underscore (_), and dash (-). Spaces are not allowed.

getRank

@Stability(value=Stable)
 @NotNull
Number getRank()

Specifies the position of the filter in the list of current filters.

Also specifies the order in which this filter is applied to the findings.

By default, filters may not be created in the same order as they are ranked. To ensure filters are created in the correct order, you can use the optional DependsOn attribute with the following syntax: "DependsOn":[ "ObjectName" ] . You can find more information on using this attribute here .

getTags

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

The tags to be added to a new filter resource.

Each tag consists of a key and an optional value, both of which you define.

For more information, see Tag .

builder

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

Returns:

a CfnFilterProps.Builder of CfnFilterProps