/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include namespace Aws { namespace Utils { namespace Json { class JsonValue; class JsonView; } // namespace Json } // namespace Utils namespace WAFRegional { namespace Model { /** *

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:

  • The part of a * web request that you want AWS WAF to inspect, such as a query string or the * value of the User-Agent header.

  • The identifier * of the pattern (a regular expression) that you want AWS WAF to look for. For * more information, see RegexPatternSet.

  • Whether to * perform any conversions on the request, such as converting it to lowercase, * before inspecting it for the specified string.

See * Also:

AWS * API Reference

*/ class RegexMatchTuple { public: AWS_WAFREGIONAL_API RegexMatchTuple(); AWS_WAFREGIONAL_API RegexMatchTuple(Aws::Utils::Json::JsonView jsonValue); AWS_WAFREGIONAL_API RegexMatchTuple& operator=(Aws::Utils::Json::JsonView jsonValue); AWS_WAFREGIONAL_API Aws::Utils::Json::JsonValue Jsonize() const; /** *

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

*/ inline const FieldToMatch& GetFieldToMatch() const{ return m_fieldToMatch; } /** *

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

*/ inline bool FieldToMatchHasBeenSet() const { return m_fieldToMatchHasBeenSet; } /** *

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

*/ inline void SetFieldToMatch(const FieldToMatch& value) { m_fieldToMatchHasBeenSet = true; m_fieldToMatch = value; } /** *

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

*/ inline void SetFieldToMatch(FieldToMatch&& value) { m_fieldToMatchHasBeenSet = true; m_fieldToMatch = std::move(value); } /** *

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

*/ inline RegexMatchTuple& WithFieldToMatch(const FieldToMatch& value) { SetFieldToMatch(value); return *this;} /** *

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

*/ inline RegexMatchTuple& WithFieldToMatch(FieldToMatch&& value) { SetFieldToMatch(std::move(value)); return *this;} /** *

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

  • *

    \n, 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.

*/ inline const TextTransformation& GetTextTransformation() const{ return m_textTransformation; } /** *

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

  • *

    \n, 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.

*/ inline bool TextTransformationHasBeenSet() const { return m_textTransformationHasBeenSet; } /** *

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

  • *

    \n, 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.

*/ inline void SetTextTransformation(const TextTransformation& value) { m_textTransformationHasBeenSet = true; m_textTransformation = value; } /** *

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

  • *

    \n, 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.

*/ inline void SetTextTransformation(TextTransformation&& value) { m_textTransformationHasBeenSet = true; m_textTransformation = std::move(value); } /** *

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

  • *

    \n, 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.

*/ inline RegexMatchTuple& WithTextTransformation(const TextTransformation& value) { SetTextTransformation(value); return *this;} /** *

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

  • *

    \n, 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.

*/ inline RegexMatchTuple& WithTextTransformation(TextTransformation&& value) { SetTextTransformation(std::move(value)); return *this;} /** *

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.

*/ inline const Aws::String& GetRegexPatternSetId() const{ return m_regexPatternSetId; } /** *

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.

*/ inline bool RegexPatternSetIdHasBeenSet() const { return m_regexPatternSetIdHasBeenSet; } /** *

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.

*/ inline void SetRegexPatternSetId(const Aws::String& value) { m_regexPatternSetIdHasBeenSet = true; m_regexPatternSetId = value; } /** *

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.

*/ inline void SetRegexPatternSetId(Aws::String&& value) { m_regexPatternSetIdHasBeenSet = true; m_regexPatternSetId = std::move(value); } /** *

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.

*/ inline void SetRegexPatternSetId(const char* value) { m_regexPatternSetIdHasBeenSet = true; m_regexPatternSetId.assign(value); } /** *

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.

*/ inline RegexMatchTuple& WithRegexPatternSetId(const Aws::String& value) { SetRegexPatternSetId(value); return *this;} /** *

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.

*/ inline RegexMatchTuple& WithRegexPatternSetId(Aws::String&& value) { SetRegexPatternSetId(std::move(value)); return *this;} /** *

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.

*/ inline RegexMatchTuple& WithRegexPatternSetId(const char* value) { SetRegexPatternSetId(value); return *this;} private: FieldToMatch m_fieldToMatch; bool m_fieldToMatchHasBeenSet = false; TextTransformation m_textTransformation; bool m_textTransformationHasBeenSet = false; Aws::String m_regexPatternSetId; bool m_regexPatternSetIdHasBeenSet = false; }; } // namespace Model } // namespace WAFRegional } // namespace Aws