AWS SDK for C++  1.9.41
AWS SDK for C++
Public Member Functions | List of all members
Aws::WAF::Model::RegexMatchTuple Class Reference

#include <RegexMatchTuple.h>

Public Member Functions

 RegexMatchTuple ()
 
 RegexMatchTuple (Aws::Utils::Json::JsonView jsonValue)
 
RegexMatchTupleoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const FieldToMatchGetFieldToMatch () const
 
bool FieldToMatchHasBeenSet () const
 
void SetFieldToMatch (const FieldToMatch &value)
 
void SetFieldToMatch (FieldToMatch &&value)
 
RegexMatchTupleWithFieldToMatch (const FieldToMatch &value)
 
RegexMatchTupleWithFieldToMatch (FieldToMatch &&value)
 
const TextTransformationGetTextTransformation () const
 
bool TextTransformationHasBeenSet () const
 
void SetTextTransformation (const TextTransformation &value)
 
void SetTextTransformation (TextTransformation &&value)
 
RegexMatchTupleWithTextTransformation (const TextTransformation &value)
 
RegexMatchTupleWithTextTransformation (TextTransformation &&value)
 
const Aws::StringGetRegexPatternSetId () const
 
bool RegexPatternSetIdHasBeenSet () const
 
void SetRegexPatternSetId (const Aws::String &value)
 
void SetRegexPatternSetId (Aws::String &&value)
 
void SetRegexPatternSetId (const char *value)
 
RegexMatchTupleWithRegexPatternSetId (const Aws::String &value)
 
RegexMatchTupleWithRegexPatternSetId (Aws::String &&value)
 
RegexMatchTupleWithRegexPatternSetId (const char *value)
 

Detailed Description

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

The regular expression pattern that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings. Each RegexMatchTuple object contains:

See Also:

AWS API Reference

Definition at line 50 of file RegexMatchTuple.h.

Constructor & Destructor Documentation

◆ RegexMatchTuple() [1/2]

Aws::WAF::Model::RegexMatchTuple::RegexMatchTuple ( )

◆ RegexMatchTuple() [2/2]

Aws::WAF::Model::RegexMatchTuple::RegexMatchTuple ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ FieldToMatchHasBeenSet()

bool Aws::WAF::Model::RegexMatchTuple::FieldToMatchHasBeenSet ( ) const
inline

Specifies where in a web request to look for the RegexPatternSet.

Definition at line 69 of file RegexMatchTuple.h.

◆ GetFieldToMatch()

const FieldToMatch& Aws::WAF::Model::RegexMatchTuple::GetFieldToMatch ( ) const
inline

Specifies where in a web request to look for the RegexPatternSet.

Definition at line 63 of file RegexMatchTuple.h.

◆ GetRegexPatternSetId()

const Aws::String& Aws::WAF::Model::RegexMatchTuple::GetRegexPatternSetId ( ) const
inline

The RegexPatternSetId for a RegexPatternSet. You use RegexPatternSetId to get information about a RegexPatternSet (see GetRegexPatternSet), update a RegexPatternSet (see UpdateRegexPatternSet), insert a RegexPatternSet into a RegexMatchSet or delete one from a RegexMatchSet (see UpdateRegexMatchSet), and delete an RegexPatternSet from AWS WAF (see DeleteRegexPatternSet).

RegexPatternSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets.

Definition at line 330 of file RegexMatchTuple.h.

◆ GetTextTransformation()

const TextTransformation& Aws::WAF::Model::RegexMatchTuple::GetTextTransformation ( ) const
inline

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on RegexPatternSet before inspecting a request for a match.

You can only specify a single type of TextTransformation.

CMD_LINE

When you're concerned that attackers are injecting an operating system commandline command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:

  • Delete the following characters: \ " ' ^

  • Delete spaces before the following characters: / (

  • Replace the following characters with a space: , ;

  • Replace multiple spaces with one space

  • Convert uppercase letters (A-Z) to lowercase (a-z)

COMPRESS_WHITE_SPACE

Use this option to replace the following characters with a space character (decimal 32):

  • \f, formfeed, decimal 12

  • \t, tab, decimal 9


  • , newline, decimal 10

  • \r, carriage return, decimal 13

  • \v, vertical tab, decimal 11

  • non-breaking space, decimal 160

COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

HTML_ENTITY_DECODE

Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:

  • Replaces (ampersand)quot; with "

  • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

  • Replaces (ampersand)lt; with a "less than" symbol

  • Replaces (ampersand)gt; with >

  • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters

  • Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters

LOWERCASE

Use this option to convert uppercase letters (A-Z) to lowercase (a-z).

URL_DECODE

Use this option to decode a URL-encoded value.

NONE

Specify NONE if you don't want to perform any text transformations.

Definition at line 131 of file RegexMatchTuple.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::WAF::Model::RegexMatchTuple::Jsonize ( ) const

◆ operator=()

RegexMatchTuple& Aws::WAF::Model::RegexMatchTuple::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ RegexPatternSetIdHasBeenSet()

bool Aws::WAF::Model::RegexMatchTuple::RegexPatternSetIdHasBeenSet ( ) const
inline

The RegexPatternSetId for a RegexPatternSet. You use RegexPatternSetId to get information about a RegexPatternSet (see GetRegexPatternSet), update a RegexPatternSet (see UpdateRegexPatternSet), insert a RegexPatternSet into a RegexMatchSet or delete one from a RegexMatchSet (see UpdateRegexMatchSet), and delete an RegexPatternSet from AWS WAF (see DeleteRegexPatternSet).

RegexPatternSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets.

Definition at line 343 of file RegexMatchTuple.h.

◆ SetFieldToMatch() [1/2]

void Aws::WAF::Model::RegexMatchTuple::SetFieldToMatch ( const FieldToMatch value)
inline

Specifies where in a web request to look for the RegexPatternSet.

Definition at line 75 of file RegexMatchTuple.h.

◆ SetFieldToMatch() [2/2]

void Aws::WAF::Model::RegexMatchTuple::SetFieldToMatch ( FieldToMatch &&  value)
inline

Specifies where in a web request to look for the RegexPatternSet.

Definition at line 81 of file RegexMatchTuple.h.

◆ SetRegexPatternSetId() [1/3]

void Aws::WAF::Model::RegexMatchTuple::SetRegexPatternSetId ( Aws::String &&  value)
inline

The RegexPatternSetId for a RegexPatternSet. You use RegexPatternSetId to get information about a RegexPatternSet (see GetRegexPatternSet), update a RegexPatternSet (see UpdateRegexPatternSet), insert a RegexPatternSet into a RegexMatchSet or delete one from a RegexMatchSet (see UpdateRegexMatchSet), and delete an RegexPatternSet from AWS WAF (see DeleteRegexPatternSet).

RegexPatternSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets.

Definition at line 369 of file RegexMatchTuple.h.

◆ SetRegexPatternSetId() [2/3]

void Aws::WAF::Model::RegexMatchTuple::SetRegexPatternSetId ( const Aws::String value)
inline

The RegexPatternSetId for a RegexPatternSet. You use RegexPatternSetId to get information about a RegexPatternSet (see GetRegexPatternSet), update a RegexPatternSet (see UpdateRegexPatternSet), insert a RegexPatternSet into a RegexMatchSet or delete one from a RegexMatchSet (see UpdateRegexMatchSet), and delete an RegexPatternSet from AWS WAF (see DeleteRegexPatternSet).

RegexPatternSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets.

Definition at line 356 of file RegexMatchTuple.h.

◆ SetRegexPatternSetId() [3/3]

void Aws::WAF::Model::RegexMatchTuple::SetRegexPatternSetId ( const char *  value)
inline

The RegexPatternSetId for a RegexPatternSet. You use RegexPatternSetId to get information about a RegexPatternSet (see GetRegexPatternSet), update a RegexPatternSet (see UpdateRegexPatternSet), insert a RegexPatternSet into a RegexMatchSet or delete one from a RegexMatchSet (see UpdateRegexMatchSet), and delete an RegexPatternSet from AWS WAF (see DeleteRegexPatternSet).

RegexPatternSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets.

Definition at line 382 of file RegexMatchTuple.h.

◆ SetTextTransformation() [1/2]

void Aws::WAF::Model::RegexMatchTuple::SetTextTransformation ( const TextTransformation value)
inline

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on RegexPatternSet before inspecting a request for a match.

You can only specify a single type of TextTransformation.

CMD_LINE

When you're concerned that attackers are injecting an operating system commandline command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:

  • Delete the following characters: \ " ' ^

  • Delete spaces before the following characters: / (

  • Replace the following characters with a space: , ;

  • Replace multiple spaces with one space

  • Convert uppercase letters (A-Z) to lowercase (a-z)

COMPRESS_WHITE_SPACE

Use this option to replace the following characters with a space character (decimal 32):

  • \f, formfeed, decimal 12

  • \t, tab, decimal 9


  • , newline, decimal 10

  • \r, carriage return, decimal 13

  • \v, vertical tab, decimal 11

  • non-breaking space, decimal 160

COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

HTML_ENTITY_DECODE

Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:

  • Replaces (ampersand)quot; with "

  • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

  • Replaces (ampersand)lt; with a "less than" symbol

  • Replaces (ampersand)gt; with >

  • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters

  • Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters

LOWERCASE

Use this option to convert uppercase letters (A-Z) to lowercase (a-z).

URL_DECODE

Use this option to decode a URL-encoded value.

NONE

Specify NONE if you don't want to perform any text transformations.

Definition at line 205 of file RegexMatchTuple.h.

◆ SetTextTransformation() [2/2]

void Aws::WAF::Model::RegexMatchTuple::SetTextTransformation ( TextTransformation &&  value)
inline

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on RegexPatternSet before inspecting a request for a match.

You can only specify a single type of TextTransformation.

CMD_LINE

When you're concerned that attackers are injecting an operating system commandline command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:

  • Delete the following characters: \ " ' ^

  • Delete spaces before the following characters: / (

  • Replace the following characters with a space: , ;

  • Replace multiple spaces with one space

  • Convert uppercase letters (A-Z) to lowercase (a-z)

COMPRESS_WHITE_SPACE

Use this option to replace the following characters with a space character (decimal 32):

  • \f, formfeed, decimal 12

  • \t, tab, decimal 9


  • , newline, decimal 10

  • \r, carriage return, decimal 13

  • \v, vertical tab, decimal 11

  • non-breaking space, decimal 160

COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

HTML_ENTITY_DECODE

Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:

  • Replaces (ampersand)quot; with "

  • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

  • Replaces (ampersand)lt; with a "less than" symbol

  • Replaces (ampersand)gt; with >

  • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters

  • Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters

LOWERCASE

Use this option to convert uppercase letters (A-Z) to lowercase (a-z).

URL_DECODE

Use this option to decode a URL-encoded value.

NONE

Specify NONE if you don't want to perform any text transformations.

Definition at line 242 of file RegexMatchTuple.h.

◆ TextTransformationHasBeenSet()

bool Aws::WAF::Model::RegexMatchTuple::TextTransformationHasBeenSet ( ) const
inline

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on RegexPatternSet before inspecting a request for a match.

You can only specify a single type of TextTransformation.

CMD_LINE

When you're concerned that attackers are injecting an operating system commandline command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:

  • Delete the following characters: \ " ' ^

  • Delete spaces before the following characters: / (

  • Replace the following characters with a space: , ;

  • Replace multiple spaces with one space

  • Convert uppercase letters (A-Z) to lowercase (a-z)

COMPRESS_WHITE_SPACE

Use this option to replace the following characters with a space character (decimal 32):

  • \f, formfeed, decimal 12

  • \t, tab, decimal 9


  • , newline, decimal 10

  • \r, carriage return, decimal 13

  • \v, vertical tab, decimal 11

  • non-breaking space, decimal 160

COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

HTML_ENTITY_DECODE

Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:

  • Replaces (ampersand)quot; with "

  • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

  • Replaces (ampersand)lt; with a "less than" symbol

  • Replaces (ampersand)gt; with >

  • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters

  • Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters

LOWERCASE

Use this option to convert uppercase letters (A-Z) to lowercase (a-z).

URL_DECODE

Use this option to decode a URL-encoded value.

NONE

Specify NONE if you don't want to perform any text transformations.

Definition at line 168 of file RegexMatchTuple.h.

◆ WithFieldToMatch() [1/2]

RegexMatchTuple& Aws::WAF::Model::RegexMatchTuple::WithFieldToMatch ( const FieldToMatch value)
inline

Specifies where in a web request to look for the RegexPatternSet.

Definition at line 87 of file RegexMatchTuple.h.

◆ WithFieldToMatch() [2/2]

RegexMatchTuple& Aws::WAF::Model::RegexMatchTuple::WithFieldToMatch ( FieldToMatch &&  value)
inline

Specifies where in a web request to look for the RegexPatternSet.

Definition at line 93 of file RegexMatchTuple.h.

◆ WithRegexPatternSetId() [1/3]

RegexMatchTuple& Aws::WAF::Model::RegexMatchTuple::WithRegexPatternSetId ( Aws::String &&  value)
inline

The RegexPatternSetId for a RegexPatternSet. You use RegexPatternSetId to get information about a RegexPatternSet (see GetRegexPatternSet), update a RegexPatternSet (see UpdateRegexPatternSet), insert a RegexPatternSet into a RegexMatchSet or delete one from a RegexMatchSet (see UpdateRegexMatchSet), and delete an RegexPatternSet from AWS WAF (see DeleteRegexPatternSet).

RegexPatternSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets.

Definition at line 408 of file RegexMatchTuple.h.

◆ WithRegexPatternSetId() [2/3]

RegexMatchTuple& Aws::WAF::Model::RegexMatchTuple::WithRegexPatternSetId ( const Aws::String value)
inline

The RegexPatternSetId for a RegexPatternSet. You use RegexPatternSetId to get information about a RegexPatternSet (see GetRegexPatternSet), update a RegexPatternSet (see UpdateRegexPatternSet), insert a RegexPatternSet into a RegexMatchSet or delete one from a RegexMatchSet (see UpdateRegexMatchSet), and delete an RegexPatternSet from AWS WAF (see DeleteRegexPatternSet).

RegexPatternSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets.

Definition at line 395 of file RegexMatchTuple.h.

◆ WithRegexPatternSetId() [3/3]

RegexMatchTuple& Aws::WAF::Model::RegexMatchTuple::WithRegexPatternSetId ( const char *  value)
inline

The RegexPatternSetId for a RegexPatternSet. You use RegexPatternSetId to get information about a RegexPatternSet (see GetRegexPatternSet), update a RegexPatternSet (see UpdateRegexPatternSet), insert a RegexPatternSet into a RegexMatchSet or delete one from a RegexMatchSet (see UpdateRegexMatchSet), and delete an RegexPatternSet from AWS WAF (see DeleteRegexPatternSet).

RegexPatternSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets.

Definition at line 421 of file RegexMatchTuple.h.

◆ WithTextTransformation() [1/2]

RegexMatchTuple& Aws::WAF::Model::RegexMatchTuple::WithTextTransformation ( const TextTransformation value)
inline

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on RegexPatternSet before inspecting a request for a match.

You can only specify a single type of TextTransformation.

CMD_LINE

When you're concerned that attackers are injecting an operating system commandline command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:

  • Delete the following characters: \ " ' ^

  • Delete spaces before the following characters: / (

  • Replace the following characters with a space: , ;

  • Replace multiple spaces with one space

  • Convert uppercase letters (A-Z) to lowercase (a-z)

COMPRESS_WHITE_SPACE

Use this option to replace the following characters with a space character (decimal 32):

  • \f, formfeed, decimal 12

  • \t, tab, decimal 9


  • , newline, decimal 10

  • \r, carriage return, decimal 13

  • \v, vertical tab, decimal 11

  • non-breaking space, decimal 160

COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

HTML_ENTITY_DECODE

Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:

  • Replaces (ampersand)quot; with "

  • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

  • Replaces (ampersand)lt; with a "less than" symbol

  • Replaces (ampersand)gt; with >

  • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters

  • Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters

LOWERCASE

Use this option to convert uppercase letters (A-Z) to lowercase (a-z).

URL_DECODE

Use this option to decode a URL-encoded value.

NONE

Specify NONE if you don't want to perform any text transformations.

Definition at line 279 of file RegexMatchTuple.h.

◆ WithTextTransformation() [2/2]

RegexMatchTuple& Aws::WAF::Model::RegexMatchTuple::WithTextTransformation ( TextTransformation &&  value)
inline

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on RegexPatternSet before inspecting a request for a match.

You can only specify a single type of TextTransformation.

CMD_LINE

When you're concerned that attackers are injecting an operating system commandline command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:

  • Delete the following characters: \ " ' ^

  • Delete spaces before the following characters: / (

  • Replace the following characters with a space: , ;

  • Replace multiple spaces with one space

  • Convert uppercase letters (A-Z) to lowercase (a-z)

COMPRESS_WHITE_SPACE

Use this option to replace the following characters with a space character (decimal 32):

  • \f, formfeed, decimal 12

  • \t, tab, decimal 9


  • , newline, decimal 10

  • \r, carriage return, decimal 13

  • \v, vertical tab, decimal 11

  • non-breaking space, decimal 160

COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

HTML_ENTITY_DECODE

Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:

  • Replaces (ampersand)quot; with "

  • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

  • Replaces (ampersand)lt; with a "less than" symbol

  • Replaces (ampersand)gt; with >

  • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters

  • Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters

LOWERCASE

Use this option to convert uppercase letters (A-Z) to lowercase (a-z).

URL_DECODE

Use this option to decode a URL-encoded value.

NONE

Specify NONE if you don't want to perform any text transformations.

Definition at line 316 of file RegexMatchTuple.h.


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