Package 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.104.0 (build e79254c)",
           date="2024-12-06T14:43:20.000Z")
@Stability(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()
         .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")
         // the properties below are optional
         .action("action")
         .description("description")
         .rank(123)
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-filter.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnFilterProps.Builder	builder()
default String	getAction()	Specifies the action that is to be applied to the findings that match the filter.
default String	getDescription()	The description of the filter.
String	getDetectorId()	The detector ID associated with the GuardDuty account for which you want to create a filter.
Object	getFindingCriteria()	Represents the criteria to be used in the filter for querying findings.
String	getName()	The name of the filter.
default 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 Details

getDetectorId

@Stability(Stable)
@NotNull
String getDetectorId()

The detector ID associated with the GuardDuty account for which you want to create a filter.

To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-filter.html#cfn-guardduty-filter-detectorid

getFindingCriteria

@Stability(Stable)
@NotNull
Object getFindingCriteria()

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

See Also:

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

getName

@Stability(Stable)
@NotNull
String getName()

The name of the filter.

Valid characters include period (.), underscore (_), dash (-), and alphanumeric characters. A whitespace is considered to be an invalid character.

See Also:

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

getAction

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

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

See Also:

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

getDescription

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

The description of the filter.

Valid characters include alphanumeric characters, and special characters such as hyphen, period, colon, underscore, parentheses ( { } , [ ] , and ( ) ), forward slash, horizontal tab, vertical tab, newline, form feed, return, and whitespace.

See Also:

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

getRank

@Stability(Stable)
@Nullable
default 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. The minimum value for this property is 1 and the maximum is 100.

By default, filters may not be created in the same order as they are ranked. To ensure that the filters are created in the expected order, you can use an optional attribute, DependsOn , with the following syntax: "DependsOn":[ "ObjectName" ] .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-filter.html#cfn-guardduty-filter-rank

getTags

@Stability(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 .

See Also:

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

builder

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

Returns:

a CfnFilterProps.Builder of CfnFilterProps