AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Class: Aws::SecurityHub::Types::MapFilter

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb

Overview

Note:

When making an API call, you may pass MapFilter data as a 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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#comparisonString

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.

Returns:

  • (String)


29034
29035
29036
29037
29038
29039
29040
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 29034

class MapFilter < Struct.new(
  :key,
  :value,
  :comparison)
  SENSITIVE = []
  include Aws::Structure
end

#keyString

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.

Returns:

  • (String)


29034
29035
29036
29037
29038
29039
29040
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 29034

class MapFilter < Struct.new(
  :key,
  :value,
  :comparison)
  SENSITIVE = []
  include Aws::Structure
end

#valueString

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.

Returns:

  • (String)


29034
29035
29036
29037
29038
29039
29040
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 29034

class MapFilter < Struct.new(
  :key,
  :value,
  :comparison)
  SENSITIVE = []
  include Aws::Structure
end