Class CfnAutomationRule.MapFilterProperty.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnAutomationRule.MapFilterProperty>
- Enclosing interface:
CfnAutomationRule.MapFilterProperty
CfnAutomationRule.MapFilterProperty
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds the configured instance.comparison
(String comparison) Sets the value ofCfnAutomationRule.MapFilterProperty.getComparison()
Sets the value ofCfnAutomationRule.MapFilterProperty.getKey()
Sets the value ofCfnAutomationRule.MapFilterProperty.getValue()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
comparison
Sets the value ofCfnAutomationRule.MapFilterProperty.getComparison()
- Parameters:
comparison
- The condition to apply to the key value when filtering Security Hub findings with a map filter. This parameter is required. To search for values that have the filter value, use one of the following comparison operators:- To search for values that include the filter value, use
CONTAINS
. For example, for theResourceTags
field, the filterDepartment CONTAINS Security
matches findings that include the valueSecurity
for theDepartment
tag. In the same example, a finding with a value ofSecurity team
for theDepartment
tag is a match. - To search for values that exactly match the filter value, use
EQUALS
. For example, for theResourceTags
field, the filterDepartment EQUALS Security
matches findings that have the valueSecurity
for theDepartment
tag.
CONTAINS
andEQUALS
filters on the same field are joined byOR
. A finding matches if it matches any one of those filters. For example, the filtersDepartment CONTAINS Security OR Department CONTAINS Finance
match a finding that includes eitherSecurity
,Finance
, or both values.To search for values that don't have the filter value, use one of the following comparison operators:
- To search for values that exclude the filter value, use
NOT_CONTAINS
. For example, for theResourceTags
field, the filterDepartment NOT_CONTAINS Finance
matches findings that exclude the valueFinance
for theDepartment
tag. - To search for values other than the filter value, use
NOT_EQUALS
. For example, for theResourceTags
field, the filterDepartment NOT_EQUALS Finance
matches findings that don’t have the valueFinance
for theDepartment
tag.
NOT_CONTAINS
andNOT_EQUALS
filters on the same field are joined byAND
. A finding matches only if it matches all of those filters. For example, the filtersDepartment NOT_CONTAINS Security AND Department NOT_CONTAINS Finance
match a finding that excludes both theSecurity
andFinance
values.CONTAINS
filters can only be used with otherCONTAINS
filters.NOT_CONTAINS
filters can only be used with otherNOT_CONTAINS
filters.You can’t have both a
CONTAINS
filter and aNOT_CONTAINS
filter on the same field. Similarly, you can’t have both anEQUALS
filter and aNOT_EQUALS
filter on the same field. Combining filters in this way returns an error.CONTAINS
andNOT_CONTAINS
operators can be used only with automation rules. For more information, see Automation rules in the AWS Security Hub User Guide .- To search for values that include the filter value, use
- Returns:
this
-
key
Sets the value ofCfnAutomationRule.MapFilterProperty.getKey()
- Parameters:
key
- The key of the map filter. This parameter is required. For example, forResourceTags
,Key
identifies the name of the tag. ForUserDefinedFields
,Key
is the name of the field.- Returns:
this
-
value
Sets the value ofCfnAutomationRule.MapFilterProperty.getValue()
- Parameters:
value
- The value for the key in the map filter. This parameter is required. Filter values are case sensitive. For example, one of the values for a tag calledDepartment
might beSecurity
. If you providesecurity
as the filter value, then there's no match.- Returns:
this
-
build
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnAutomationRule.MapFilterProperty>
- Returns:
- a new instance of
CfnAutomationRule.MapFilterProperty
- Throws:
NullPointerException
- if any required attribute was not provided
-