Package software.amazon.awscdk.services.guardduty

Class CfnFilter.Builder

java.lang.Object

software.amazon.awscdk.services.guardduty.CfnFilter.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnFilter>

Enclosing class:

CfnFilter

@Stability(Stable)
public static final class CfnFilter.Builder
extends Object
implements software.amazon.jsii.Builder<CfnFilter>

A fluent builder for CfnFilter.

Method Summary

Modifier and Type	Method	Description
CfnFilter.Builder	action(String action)	Specifies the action that is to be applied to the findings that match the filter.
CfnFilter	build()
static CfnFilter.Builder	create(software.constructs.Construct scope, String id)
CfnFilter.Builder	description(String description)	The description of the filter.
CfnFilter.Builder	detectorId(String detectorId)	The detector ID associated with the GuardDuty account for which you want to create a filter.
CfnFilter.Builder	findingCriteria(IResolvable findingCriteria)	Represents the criteria to be used in the filter for querying findings.
CfnFilter.Builder	findingCriteria(CfnFilter.FindingCriteriaProperty findingCriteria)	Represents the criteria to be used in the filter for querying findings.
CfnFilter.Builder	name(String name)	The name of the filter.
CfnFilter.Builder	rank(Number rank)	Specifies the position of the filter in the list of current filters.
CfnFilter.Builder	tags(List<? extends CfnTag> tags)	The tags to be added to a new filter resource.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static CfnFilter.Builder create(software.constructs.Construct scope,
 String id)

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.

Returns:

a new instance of CfnFilter.Builder.

detectorId

@Stability(Stable)
public CfnFilter.Builder detectorId(String detectorId)

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.

Parameters:

detectorId - The detector ID associated with the GuardDuty account for which you want to create a filter. This parameter is required.

Returns:

this

See Also:

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

findingCriteria

@Stability(Stable)
public CfnFilter.Builder findingCriteria(IResolvable findingCriteria)

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

Parameters:

findingCriteria - Represents the criteria to be used in the filter for querying findings. This parameter is required.

Returns:

this

See Also:

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

findingCriteria

@Stability(Stable)
public CfnFilter.Builder findingCriteria(CfnFilter.FindingCriteriaProperty findingCriteria)

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

Parameters:

findingCriteria - Represents the criteria to be used in the filter for querying findings. This parameter is required.

Returns:

this

See Also:

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

name

@Stability(Stable)
public CfnFilter.Builder name(String name)

The name of the filter.

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

Parameters:

name - The name of the filter. This parameter is required.

Returns:

this

See Also:

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

action

@Stability(Stable)
public CfnFilter.Builder action(String action)

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

Parameters:

action - Specifies the action that is to be applied to the findings that match the filter. This parameter is required.

Returns:

this

See Also:

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

description

@Stability(Stable)
public CfnFilter.Builder description(String description)

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.

Parameters:

description - The description of the filter. This parameter is required.

Returns:

this

See Also:

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

rank

@Stability(Stable)
public CfnFilter.Builder rank(Number rank)

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" ] .

Parameters:

rank - Specifies the position of the filter in the list of current filters. This parameter is required.

Returns:

this

See Also:

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

tags

@Stability(Stable)
public CfnFilter.Builder tags(List<? extends CfnTag> tags)

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 .

Parameters:

tags - The tags to be added to a new filter resource. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnFilter build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnFilter>

Returns:

a newly built instance of CfnFilter.