Class CfnFilter.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnFilter>
- Enclosing class:
CfnFilter
CfnFilter
.-
Method Summary
Modifier and TypeMethodDescriptionSpecifies the action that is to be applied to the findings that match the filter.build()
static CfnFilter.Builder
description
(String description) The description of the filter.detectorId
(String detectorId) The ID of the detector belonging to the GuardDuty account that you want to create a filter for.findingCriteria
(IResolvable findingCriteria) Represents the criteria to be used in the filter for querying findings.findingCriteria
(CfnFilter.FindingCriteriaProperty findingCriteria) Represents the criteria to be used in the filter for querying findings.The name of the filter.Specifies the position of the filter in the list of current filters.The tags to be added to a new filter resource.
-
Method Details
-
create
- Parameters:
scope
-- scope in which this resource is defined.
id
-- scoped id of the resource.
- Returns:
- a new instance of
CfnFilter.Builder
.
-
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
-
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
-
detectorId
The ID of the detector belonging to the GuardDuty account that you want to create a filter for.- Parameters:
detectorId
- The ID of the detector belonging to the GuardDuty account that you want to create a filter for. This parameter is required.- Returns:
this
-
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
-
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
-
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
-
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
-
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
-
build
-