You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::SecurityHub::Types::MapFilter
- Inherits:
-
Struct
- Object
- Struct
- Aws::SecurityHub::Types::MapFilter
- Defined in:
- (unknown)
Overview
When passing MapFilter as input to an Aws::Client method, you can use a vanilla Hash:
{
key: "NonEmptyString",
value: "NonEmptyString",
comparison: "EQUALS", # accepts EQUALS, NOT_EQUALS
}
A map filter for querying findings. Each map filter provides the field to check, the value to look for, and the comparison operator.
Instance Attribute Summary collapse
-
#comparison ⇒ String
The condition to apply to the key value when querying for findings with a map filter.
-
#key ⇒ String
The key of the map filter.
-
#value ⇒ String
The value for the key in the map filter.
Instance Attribute Details
#comparison ⇒ String
The condition to apply to the key value when querying for findings with a map filter.
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 tag
Department.
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 do not have the value Finance for the
tag Department.
EQUALS filters on the same field are joined by OR. A finding matches
if it matches any one of those filters.
NOT_EQUALS filters on the same field are joined by AND. A finding
matches only if it matches all of those filters.
You cannot have both an EQUALS filter and a NOT_EQUALS filter on the
same field.
Possible values:
- EQUALS
- NOT_EQUALS
#key ⇒ String
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.
#value ⇒ String
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 is no match.