libZSservicesZSamazonka-securityhubZSamazonka-securityhub
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.SecurityHub.Types.MapFilter

Description

 
Synopsis

Documentation

data MapFilter Source #

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.

Constructors

MapFilter' 

Fields

  • value :: Maybe Text

    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.

  • comparison :: Maybe MapFilterComparison

    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.

  • key :: Maybe Text

    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.

Instances

Instances details
Eq MapFilter Source # 
Instance details

Defined in Amazonka.SecurityHub.Types.MapFilter

Read MapFilter Source # 
Instance details

Defined in Amazonka.SecurityHub.Types.MapFilter

Show MapFilter Source # 
Instance details

Defined in Amazonka.SecurityHub.Types.MapFilter

Generic MapFilter Source # 
Instance details

Defined in Amazonka.SecurityHub.Types.MapFilter

Associated Types

type Rep MapFilter :: Type -> Type #

NFData MapFilter Source # 
Instance details

Defined in Amazonka.SecurityHub.Types.MapFilter

Methods

rnf :: MapFilter -> () #

Hashable MapFilter Source # 
Instance details

Defined in Amazonka.SecurityHub.Types.MapFilter

ToJSON MapFilter Source # 
Instance details

Defined in Amazonka.SecurityHub.Types.MapFilter

FromJSON MapFilter Source # 
Instance details

Defined in Amazonka.SecurityHub.Types.MapFilter

type Rep MapFilter Source # 
Instance details

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.

mapFilter_key :: Lens' MapFilter (Maybe Text) Source #

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.