Copyright | (c) 2013-2021 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Synopsis
Documentation
A map filter for querying findings. Each map filter provides the field to check, the value to look for, and the comparison operator.
See: newMapFilter
smart constructor.
MapFilter' | |
|
Instances
Eq MapFilter Source # | |
Read MapFilter Source # | |
Show MapFilter Source # | |
Generic MapFilter Source # | |
NFData MapFilter Source # | |
Defined in Amazonka.SecurityHub.Types.MapFilter | |
Hashable MapFilter Source # | |
Defined in Amazonka.SecurityHub.Types.MapFilter | |
ToJSON MapFilter Source # | |
Defined in Amazonka.SecurityHub.Types.MapFilter | |
FromJSON MapFilter Source # | |
type Rep MapFilter Source # | |
Defined in Amazonka.SecurityHub.Types.MapFilter type Rep MapFilter = D1 ('MetaData "MapFilter" "Amazonka.SecurityHub.Types.MapFilter" "libZSservicesZSamazonka-securityhubZSamazonka-securityhub" 'False) (C1 ('MetaCons "MapFilter'" 'PrefixI 'True) (S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "comparison") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MapFilterComparison)) :*: S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) |
newMapFilter :: MapFilter Source #
Create a value of MapFilter
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:value:MapFilter'
, mapFilter_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 is no match.
$sel:comparison:MapFilter'
, mapFilter_comparison
- 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.
$sel:key:MapFilter'
, mapFilter_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.
mapFilter_value :: Lens' MapFilter (Maybe Text) Source #
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.
mapFilter_comparison :: Lens' MapFilter (Maybe MapFilterComparison) Source #
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.