Struct aws_sdk_securityhub::model::MapFilter

#[non_exhaustive]
pub struct MapFilter {
    pub key: Option<String>,
    pub value: Option<String>,
    pub comparison: Option<MapFilterComparison>,
}

A map filter for querying findings. Each map filter provides the field to check, the value to look for, and the comparison operator.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

key: Option<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: Option<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.

comparison: Option<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.

Implementations

impl MapFilter

pub fn key(&self) -> Option<&str>

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.

pub fn value(&self) -> Option<&str>

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.

pub fn comparison(&self) -> Option<&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.

impl MapFilter

pub fn builder() -> Builder

Creates a new builder-style object to manufacture MapFilter

Trait Implementations

impl Clone for MapFilter

fn clone(&self) -> MapFilter

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for MapFilter

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq<MapFilter> for MapFilter

fn eq(&self, other: &MapFilter) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &MapFilter) -> bool

This method tests for !=.

impl StructuralPartialEq for MapFilter