@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class MapFilter extends Object implements Serializable, Cloneable, StructuredPojo
A map filter for filtering Security Hub findings. Each map filter provides the field to check for, the value to check for, and the comparison operator.
Constructor and Description |
---|
MapFilter() |
Modifier and Type | Method and Description |
---|---|
MapFilter |
clone() |
boolean |
equals(Object obj) |
String |
getComparison()
The condition to apply to the key value when filtering Security Hub findings with a map filter.
|
String |
getKey()
The key of the map filter.
|
String |
getValue()
The value for the key in the map filter.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setComparison(String comparison)
The condition to apply to the key value when filtering Security Hub findings with a map filter.
|
void |
setKey(String key)
The key of the map filter.
|
void |
setValue(String value)
The value for the key in the map filter.
|
String |
toString()
Returns a string representation of this object.
|
MapFilter |
withComparison(MapFilterComparison comparison)
The condition to apply to the key value when filtering Security Hub findings with a map filter.
|
MapFilter |
withComparison(String comparison)
The condition to apply to the key value when filtering Security Hub findings with a map filter.
|
MapFilter |
withKey(String key)
The key of the map filter.
|
MapFilter |
withValue(String value)
The value for the key in the map filter.
|
public void setKey(String key)
The key of the map filter. For example, for ResourceTags
, Key
identifies the name of
the tag. For UserDefinedFields
, Key
is the name of the field.
key
- The key of the map filter. For example, for ResourceTags
, Key
identifies the
name of the tag. For UserDefinedFields
, Key
is the name of the field.public String getKey()
The key of the map filter. For example, for ResourceTags
, Key
identifies the name of
the tag. For UserDefinedFields
, Key
is the name of the field.
ResourceTags
, Key
identifies the
name of the tag. For UserDefinedFields
, Key
is the name of the field.public MapFilter withKey(String key)
The key of the map filter. For example, for ResourceTags
, Key
identifies the name of
the tag. For UserDefinedFields
, Key
is the name of the field.
key
- The key of the map filter. For example, for ResourceTags
, Key
identifies the
name of the tag. For UserDefinedFields
, Key
is the name of the field.public void setValue(String value)
The value for the key in the map filter. Filter values are case sensitive. For example, one of the values for a
tag called Department
might be Security
. If you provide security
as the
filter value, then there's no match.
value
- The value for the key in the map filter. Filter values are case sensitive. For example, one of the values
for a tag called Department
might be Security
. If you provide
security
as the filter value, then there's no match.public String getValue()
The value for the key in the map filter. Filter values are case sensitive. For example, one of the values for a
tag called Department
might be Security
. If you provide security
as the
filter value, then there's no match.
Department
might be Security
. If you provide
security
as the filter value, then there's no match.public MapFilter withValue(String value)
The value for the key in the map filter. Filter values are case sensitive. For example, one of the values for a
tag called Department
might be Security
. If you provide security
as the
filter value, then there's no match.
value
- The value for the key in the map filter. Filter values are case sensitive. For example, one of the values
for a tag called Department
might be Security
. If you provide
security
as the filter value, then there's no match.public void setComparison(String comparison)
The condition to apply to the key value when filtering Security Hub findings with a map filter.
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 the
ResourceTags
field, the filter Department CONTAINS Security
matches findings that
include the value Security
for the Department
tag. In the same example, a finding with
a value of Security team
for the Department
tag is a match.
To search for values that exactly match the filter value, use EQUALS
. For example, for the
ResourceTags
field, the filter Department EQUALS Security
matches findings that have
the value Security
for the Department
tag.
CONTAINS
and EQUALS
filters on the same field are joined by OR
. A finding
matches if it matches any one of those filters. For example, the filters
Department CONTAINS Security OR Department CONTAINS Finance
match a finding that includes either
Security
, 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 the
ResourceTags
field, the filter Department NOT_CONTAINS Finance
matches findings that
exclude the value Finance
for the Department
tag.
To search for values other than the filter value, use NOT_EQUALS
. For example, for the
ResourceTags
field, the filter Department NOT_EQUALS Finance
matches findings that
don’t have the value Finance
for the Department
tag.
NOT_CONTAINS
and NOT_EQUALS
filters on the same field are joined by AND
. A
finding matches only if it matches all of those filters. For example, the filters
Department NOT_CONTAINS Security AND Department NOT_CONTAINS Finance
match a finding that excludes
both the Security
and Finance
values.
CONTAINS
filters can only be used with other CONTAINS
filters.
NOT_CONTAINS
filters can only be used with other NOT_CONTAINS
filters.
You can’t have both a CONTAINS
filter and a NOT_CONTAINS
filter on the same field.
Similarly, you can’t have both an EQUALS
filter and a NOT_EQUALS
filter on the same
field. Combining filters in this way returns an error.
CONTAINS
and NOT_CONTAINS
operators can be used only with automation rules. For more
information, see Automation rules in the
Security Hub User Guide.
comparison
- The condition to apply to the key value when filtering Security Hub findings with a map filter.
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 the
ResourceTags
field, the filter Department CONTAINS Security
matches findings
that include the value Security
for the Department
tag. In the same example, a
finding with a value of Security team
for the Department
tag is a match.
To search for values that exactly match the filter value, use EQUALS
. For example, for the
ResourceTags
field, the filter Department EQUALS Security
matches findings that
have the value Security
for the Department
tag.
CONTAINS
and EQUALS
filters on the same field are joined by OR
. A
finding matches if it matches any one of those filters. For example, the filters
Department CONTAINS Security OR Department CONTAINS Finance
match a finding that includes
either Security
, 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 the
ResourceTags
field, the filter Department NOT_CONTAINS Finance
matches findings
that exclude the value Finance
for the Department
tag.
To search for values other than the filter value, use NOT_EQUALS
. For example, for the
ResourceTags
field, the filter Department NOT_EQUALS Finance
matches findings
that don’t have the value Finance
for the Department
tag.
NOT_CONTAINS
and NOT_EQUALS
filters on the same field are joined by
AND
. A finding matches only if it matches all of those filters. For example, the filters
Department NOT_CONTAINS Security AND Department NOT_CONTAINS Finance
match a finding that
excludes both the Security
and Finance
values.
CONTAINS
filters can only be used with other CONTAINS
filters.
NOT_CONTAINS
filters can only be used with other NOT_CONTAINS
filters.
You can’t have both a CONTAINS
filter and a NOT_CONTAINS
filter on the same
field. Similarly, you can’t have both an EQUALS
filter and a NOT_EQUALS
filter
on the same field. Combining filters in this way returns an error.
CONTAINS
and NOT_CONTAINS
operators can be used only with automation rules. For
more information, see Automation rules
in the Security Hub User Guide.
MapFilterComparison
public String getComparison()
The condition to apply to the key value when filtering Security Hub findings with a map filter.
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 the
ResourceTags
field, the filter Department CONTAINS Security
matches findings that
include the value Security
for the Department
tag. In the same example, a finding with
a value of Security team
for the Department
tag is a match.
To search for values that exactly match the filter value, use EQUALS
. For example, for the
ResourceTags
field, the filter Department EQUALS Security
matches findings that have
the value Security
for the Department
tag.
CONTAINS
and EQUALS
filters on the same field are joined by OR
. A finding
matches if it matches any one of those filters. For example, the filters
Department CONTAINS Security OR Department CONTAINS Finance
match a finding that includes either
Security
, 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 the
ResourceTags
field, the filter Department NOT_CONTAINS Finance
matches findings that
exclude the value Finance
for the Department
tag.
To search for values other than the filter value, use NOT_EQUALS
. For example, for the
ResourceTags
field, the filter Department NOT_EQUALS Finance
matches findings that
don’t have the value Finance
for the Department
tag.
NOT_CONTAINS
and NOT_EQUALS
filters on the same field are joined by AND
. A
finding matches only if it matches all of those filters. For example, the filters
Department NOT_CONTAINS Security AND Department NOT_CONTAINS Finance
match a finding that excludes
both the Security
and Finance
values.
CONTAINS
filters can only be used with other CONTAINS
filters.
NOT_CONTAINS
filters can only be used with other NOT_CONTAINS
filters.
You can’t have both a CONTAINS
filter and a NOT_CONTAINS
filter on the same field.
Similarly, you can’t have both an EQUALS
filter and a NOT_EQUALS
filter on the same
field. Combining filters in this way returns an error.
CONTAINS
and NOT_CONTAINS
operators can be used only with automation rules. For more
information, see Automation rules in the
Security Hub User Guide.
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 the
ResourceTags
field, the filter Department CONTAINS Security
matches findings
that include the value Security
for the Department
tag. In the same example, a
finding with a value of Security team
for the Department
tag is a match.
To search for values that exactly match the filter value, use EQUALS
. For example, for the
ResourceTags
field, the filter Department EQUALS Security
matches findings that
have the value Security
for the Department
tag.
CONTAINS
and EQUALS
filters on the same field are joined by OR
. A
finding matches if it matches any one of those filters. For example, the filters
Department CONTAINS Security OR Department CONTAINS Finance
match a finding that includes
either Security
, 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 the
ResourceTags
field, the filter Department NOT_CONTAINS Finance
matches findings
that exclude the value Finance
for the Department
tag.
To search for values other than the filter value, use NOT_EQUALS
. For example, for the
ResourceTags
field, the filter Department NOT_EQUALS Finance
matches findings
that don’t have the value Finance
for the Department
tag.
NOT_CONTAINS
and NOT_EQUALS
filters on the same field are joined by
AND
. A finding matches only if it matches all of those filters. For example, the filters
Department NOT_CONTAINS Security AND Department NOT_CONTAINS Finance
match a finding that
excludes both the Security
and Finance
values.
CONTAINS
filters can only be used with other CONTAINS
filters.
NOT_CONTAINS
filters can only be used with other NOT_CONTAINS
filters.
You can’t have both a CONTAINS
filter and a NOT_CONTAINS
filter on the same
field. Similarly, you can’t have both an EQUALS
filter and a NOT_EQUALS
filter
on the same field. Combining filters in this way returns an error.
CONTAINS
and NOT_CONTAINS
operators can be used only with automation rules. For
more information, see Automation
rules in the Security Hub User Guide.
MapFilterComparison
public MapFilter withComparison(String comparison)
The condition to apply to the key value when filtering Security Hub findings with a map filter.
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 the
ResourceTags
field, the filter Department CONTAINS Security
matches findings that
include the value Security
for the Department
tag. In the same example, a finding with
a value of Security team
for the Department
tag is a match.
To search for values that exactly match the filter value, use EQUALS
. For example, for the
ResourceTags
field, the filter Department EQUALS Security
matches findings that have
the value Security
for the Department
tag.
CONTAINS
and EQUALS
filters on the same field are joined by OR
. A finding
matches if it matches any one of those filters. For example, the filters
Department CONTAINS Security OR Department CONTAINS Finance
match a finding that includes either
Security
, 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 the
ResourceTags
field, the filter Department NOT_CONTAINS Finance
matches findings that
exclude the value Finance
for the Department
tag.
To search for values other than the filter value, use NOT_EQUALS
. For example, for the
ResourceTags
field, the filter Department NOT_EQUALS Finance
matches findings that
don’t have the value Finance
for the Department
tag.
NOT_CONTAINS
and NOT_EQUALS
filters on the same field are joined by AND
. A
finding matches only if it matches all of those filters. For example, the filters
Department NOT_CONTAINS Security AND Department NOT_CONTAINS Finance
match a finding that excludes
both the Security
and Finance
values.
CONTAINS
filters can only be used with other CONTAINS
filters.
NOT_CONTAINS
filters can only be used with other NOT_CONTAINS
filters.
You can’t have both a CONTAINS
filter and a NOT_CONTAINS
filter on the same field.
Similarly, you can’t have both an EQUALS
filter and a NOT_EQUALS
filter on the same
field. Combining filters in this way returns an error.
CONTAINS
and NOT_CONTAINS
operators can be used only with automation rules. For more
information, see Automation rules in the
Security Hub User Guide.
comparison
- The condition to apply to the key value when filtering Security Hub findings with a map filter.
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 the
ResourceTags
field, the filter Department CONTAINS Security
matches findings
that include the value Security
for the Department
tag. In the same example, a
finding with a value of Security team
for the Department
tag is a match.
To search for values that exactly match the filter value, use EQUALS
. For example, for the
ResourceTags
field, the filter Department EQUALS Security
matches findings that
have the value Security
for the Department
tag.
CONTAINS
and EQUALS
filters on the same field are joined by OR
. A
finding matches if it matches any one of those filters. For example, the filters
Department CONTAINS Security OR Department CONTAINS Finance
match a finding that includes
either Security
, 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 the
ResourceTags
field, the filter Department NOT_CONTAINS Finance
matches findings
that exclude the value Finance
for the Department
tag.
To search for values other than the filter value, use NOT_EQUALS
. For example, for the
ResourceTags
field, the filter Department NOT_EQUALS Finance
matches findings
that don’t have the value Finance
for the Department
tag.
NOT_CONTAINS
and NOT_EQUALS
filters on the same field are joined by
AND
. A finding matches only if it matches all of those filters. For example, the filters
Department NOT_CONTAINS Security AND Department NOT_CONTAINS Finance
match a finding that
excludes both the Security
and Finance
values.
CONTAINS
filters can only be used with other CONTAINS
filters.
NOT_CONTAINS
filters can only be used with other NOT_CONTAINS
filters.
You can’t have both a CONTAINS
filter and a NOT_CONTAINS
filter on the same
field. Similarly, you can’t have both an EQUALS
filter and a NOT_EQUALS
filter
on the same field. Combining filters in this way returns an error.
CONTAINS
and NOT_CONTAINS
operators can be used only with automation rules. For
more information, see Automation rules
in the Security Hub User Guide.
MapFilterComparison
public MapFilter withComparison(MapFilterComparison comparison)
The condition to apply to the key value when filtering Security Hub findings with a map filter.
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 the
ResourceTags
field, the filter Department CONTAINS Security
matches findings that
include the value Security
for the Department
tag. In the same example, a finding with
a value of Security team
for the Department
tag is a match.
To search for values that exactly match the filter value, use EQUALS
. For example, for the
ResourceTags
field, the filter Department EQUALS Security
matches findings that have
the value Security
for the Department
tag.
CONTAINS
and EQUALS
filters on the same field are joined by OR
. A finding
matches if it matches any one of those filters. For example, the filters
Department CONTAINS Security OR Department CONTAINS Finance
match a finding that includes either
Security
, 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 the
ResourceTags
field, the filter Department NOT_CONTAINS Finance
matches findings that
exclude the value Finance
for the Department
tag.
To search for values other than the filter value, use NOT_EQUALS
. For example, for the
ResourceTags
field, the filter Department NOT_EQUALS Finance
matches findings that
don’t have the value Finance
for the Department
tag.
NOT_CONTAINS
and NOT_EQUALS
filters on the same field are joined by AND
. A
finding matches only if it matches all of those filters. For example, the filters
Department NOT_CONTAINS Security AND Department NOT_CONTAINS Finance
match a finding that excludes
both the Security
and Finance
values.
CONTAINS
filters can only be used with other CONTAINS
filters.
NOT_CONTAINS
filters can only be used with other NOT_CONTAINS
filters.
You can’t have both a CONTAINS
filter and a NOT_CONTAINS
filter on the same field.
Similarly, you can’t have both an EQUALS
filter and a NOT_EQUALS
filter on the same
field. Combining filters in this way returns an error.
CONTAINS
and NOT_CONTAINS
operators can be used only with automation rules. For more
information, see Automation rules in the
Security Hub User Guide.
comparison
- The condition to apply to the key value when filtering Security Hub findings with a map filter.
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 the
ResourceTags
field, the filter Department CONTAINS Security
matches findings
that include the value Security
for the Department
tag. In the same example, a
finding with a value of Security team
for the Department
tag is a match.
To search for values that exactly match the filter value, use EQUALS
. For example, for the
ResourceTags
field, the filter Department EQUALS Security
matches findings that
have the value Security
for the Department
tag.
CONTAINS
and EQUALS
filters on the same field are joined by OR
. A
finding matches if it matches any one of those filters. For example, the filters
Department CONTAINS Security OR Department CONTAINS Finance
match a finding that includes
either Security
, 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 the
ResourceTags
field, the filter Department NOT_CONTAINS Finance
matches findings
that exclude the value Finance
for the Department
tag.
To search for values other than the filter value, use NOT_EQUALS
. For example, for the
ResourceTags
field, the filter Department NOT_EQUALS Finance
matches findings
that don’t have the value Finance
for the Department
tag.
NOT_CONTAINS
and NOT_EQUALS
filters on the same field are joined by
AND
. A finding matches only if it matches all of those filters. For example, the filters
Department NOT_CONTAINS Security AND Department NOT_CONTAINS Finance
match a finding that
excludes both the Security
and Finance
values.
CONTAINS
filters can only be used with other CONTAINS
filters.
NOT_CONTAINS
filters can only be used with other NOT_CONTAINS
filters.
You can’t have both a CONTAINS
filter and a NOT_CONTAINS
filter on the same
field. Similarly, you can’t have both an EQUALS
filter and a NOT_EQUALS
filter
on the same field. Combining filters in this way returns an error.
CONTAINS
and NOT_CONTAINS
operators can be used only with automation rules. For
more information, see Automation rules
in the Security Hub User Guide.
MapFilterComparison
public String toString()
toString
in class Object
Object.toString()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.