AWS SDK for C++  1.9.74
AWS SDK for C++
Public Member Functions | List of all members
Aws::SecurityHub::Model::MapFilter Class Reference

#include <MapFilter.h>

Public Member Functions

 MapFilter ()
 
 MapFilter (Aws::Utils::Json::JsonView jsonValue)
 
MapFilteroperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetKey () const
 
bool KeyHasBeenSet () const
 
void SetKey (const Aws::String &value)
 
void SetKey (Aws::String &&value)
 
void SetKey (const char *value)
 
MapFilterWithKey (const Aws::String &value)
 
MapFilterWithKey (Aws::String &&value)
 
MapFilterWithKey (const char *value)
 
const Aws::StringGetValue () const
 
bool ValueHasBeenSet () const
 
void SetValue (const Aws::String &value)
 
void SetValue (Aws::String &&value)
 
void SetValue (const char *value)
 
MapFilterWithValue (const Aws::String &value)
 
MapFilterWithValue (Aws::String &&value)
 
MapFilterWithValue (const char *value)
 
const MapFilterComparisonGetComparison () const
 
bool ComparisonHasBeenSet () const
 
void SetComparison (const MapFilterComparison &value)
 
void SetComparison (MapFilterComparison &&value)
 
MapFilterWithComparison (const MapFilterComparison &value)
 
MapFilterWithComparison (MapFilterComparison &&value)
 

Detailed Description

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

See Also:

AWS API Reference

Definition at line 34 of file MapFilter.h.

Constructor & Destructor Documentation

◆ MapFilter() [1/2]

Aws::SecurityHub::Model::MapFilter::MapFilter ( )

◆ MapFilter() [2/2]

Aws::SecurityHub::Model::MapFilter::MapFilter ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ ComparisonHasBeenSet()

bool Aws::SecurityHub::Model::MapFilter::ComparisonHasBeenSet ( ) const
inline

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.

Definition at line 201 of file MapFilter.h.

◆ GetComparison()

const MapFilterComparison& Aws::SecurityHub::Model::MapFilter::GetComparison ( ) const
inline

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.

Definition at line 182 of file MapFilter.h.

◆ GetKey()

const Aws::String& Aws::SecurityHub::Model::MapFilter::GetKey ( ) const
inline

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.

Definition at line 48 of file MapFilter.h.

◆ GetValue()

const Aws::String& Aws::SecurityHub::Model::MapFilter::GetValue ( ) const
inline

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.

Definition at line 106 of file MapFilter.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::SecurityHub::Model::MapFilter::Jsonize ( ) const

◆ KeyHasBeenSet()

bool Aws::SecurityHub::Model::MapFilter::KeyHasBeenSet ( ) const
inline

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.

Definition at line 55 of file MapFilter.h.

◆ operator=()

MapFilter& Aws::SecurityHub::Model::MapFilter::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ SetComparison() [1/2]

void Aws::SecurityHub::Model::MapFilter::SetComparison ( const MapFilterComparison value)
inline

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.

Definition at line 220 of file MapFilter.h.

◆ SetComparison() [2/2]

void Aws::SecurityHub::Model::MapFilter::SetComparison ( MapFilterComparison &&  value)
inline

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.

Definition at line 239 of file MapFilter.h.

◆ SetKey() [1/3]

void Aws::SecurityHub::Model::MapFilter::SetKey ( Aws::String &&  value)
inline

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.

Definition at line 69 of file MapFilter.h.

◆ SetKey() [2/3]

void Aws::SecurityHub::Model::MapFilter::SetKey ( const Aws::String value)
inline

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.

Definition at line 62 of file MapFilter.h.

◆ SetKey() [3/3]

void Aws::SecurityHub::Model::MapFilter::SetKey ( const char *  value)
inline

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.

Definition at line 76 of file MapFilter.h.

◆ SetValue() [1/3]

void Aws::SecurityHub::Model::MapFilter::SetValue ( Aws::String &&  value)
inline

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.

Definition at line 130 of file MapFilter.h.

◆ SetValue() [2/3]

void Aws::SecurityHub::Model::MapFilter::SetValue ( const Aws::String value)
inline

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.

Definition at line 122 of file MapFilter.h.

◆ SetValue() [3/3]

void Aws::SecurityHub::Model::MapFilter::SetValue ( const char *  value)
inline

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.

Definition at line 138 of file MapFilter.h.

◆ ValueHasBeenSet()

bool Aws::SecurityHub::Model::MapFilter::ValueHasBeenSet ( ) const
inline

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.

Definition at line 114 of file MapFilter.h.

◆ WithComparison() [1/2]

MapFilter& Aws::SecurityHub::Model::MapFilter::WithComparison ( const MapFilterComparison value)
inline

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.

Definition at line 258 of file MapFilter.h.

◆ WithComparison() [2/2]

MapFilter& Aws::SecurityHub::Model::MapFilter::WithComparison ( MapFilterComparison &&  value)
inline

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.

Definition at line 277 of file MapFilter.h.

◆ WithKey() [1/3]

MapFilter& Aws::SecurityHub::Model::MapFilter::WithKey ( Aws::String &&  value)
inline

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.

Definition at line 90 of file MapFilter.h.

◆ WithKey() [2/3]

MapFilter& Aws::SecurityHub::Model::MapFilter::WithKey ( const Aws::String value)
inline

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.

Definition at line 83 of file MapFilter.h.

◆ WithKey() [3/3]

MapFilter& Aws::SecurityHub::Model::MapFilter::WithKey ( const char *  value)
inline

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.

Definition at line 97 of file MapFilter.h.

◆ WithValue() [1/3]

MapFilter& Aws::SecurityHub::Model::MapFilter::WithValue ( Aws::String &&  value)
inline

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.

Definition at line 154 of file MapFilter.h.

◆ WithValue() [2/3]

MapFilter& Aws::SecurityHub::Model::MapFilter::WithValue ( const Aws::String value)
inline

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.

Definition at line 146 of file MapFilter.h.

◆ WithValue() [3/3]

MapFilter& Aws::SecurityHub::Model::MapFilter::WithValue ( const char *  value)
inline

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.

Definition at line 162 of file MapFilter.h.


The documentation for this class was generated from the following file: