/** * 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 WAF { 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.

Specifies a constraint on * the size of a part of the web request. AWS WAF uses the Size, * ComparisonOperator, and FieldToMatch to build an * expression in the form of "Size ComparisonOperator * size in bytes of FieldToMatch". If that expression is true, the * SizeConstraint is considered to match.

See Also:

* AWS * API Reference

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

Specifies where in a web request to look for the size constraint.

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

Specifies where in a web request to look for the size constraint.

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

Specifies where in a web request to look for the size constraint.

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

Specifies where in a web request to look for the size constraint.

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

Specifies where in a web request to look for the size constraint.

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

Specifies where in a web request to look for the size constraint.

*/ inline SizeConstraint& 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 FieldToMatch * before inspecting it for a match.

You can only specify a single type of * TextTransformation.

Note that if you choose BODY for the * value of Type, you must choose NONE for * TextTransformation because CloudFront forwards only the first 8192 * bytes for inspection.

NONE

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

CMD_LINE

*

When you're concerned that attackers are injecting an operating system * command line 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.

*/ 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 FieldToMatch * before inspecting it for a match.

You can only specify a single type of * TextTransformation.

Note that if you choose BODY for the * value of Type, you must choose NONE for * TextTransformation because CloudFront forwards only the first 8192 * bytes for inspection.

NONE

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

CMD_LINE

*

When you're concerned that attackers are injecting an operating system * command line 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.

*/ 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 FieldToMatch * before inspecting it for a match.

You can only specify a single type of * TextTransformation.

Note that if you choose BODY for the * value of Type, you must choose NONE for * TextTransformation because CloudFront forwards only the first 8192 * bytes for inspection.

NONE

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

CMD_LINE

*

When you're concerned that attackers are injecting an operating system * command line 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.

*/ 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 FieldToMatch * before inspecting it for a match.

You can only specify a single type of * TextTransformation.

Note that if you choose BODY for the * value of Type, you must choose NONE for * TextTransformation because CloudFront forwards only the first 8192 * bytes for inspection.

NONE

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

CMD_LINE

*

When you're concerned that attackers are injecting an operating system * command line 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.

*/ 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 FieldToMatch * before inspecting it for a match.

You can only specify a single type of * TextTransformation.

Note that if you choose BODY for the * value of Type, you must choose NONE for * TextTransformation because CloudFront forwards only the first 8192 * bytes for inspection.

NONE

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

CMD_LINE

*

When you're concerned that attackers are injecting an operating system * command line 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.

*/ inline SizeConstraint& 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 FieldToMatch * before inspecting it for a match.

You can only specify a single type of * TextTransformation.

Note that if you choose BODY for the * value of Type, you must choose NONE for * TextTransformation because CloudFront forwards only the first 8192 * bytes for inspection.

NONE

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

CMD_LINE

*

When you're concerned that attackers are injecting an operating system * command line 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.

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

The type of comparison you want AWS WAF to perform. AWS WAF uses this in * combination with the provided Size and FieldToMatch to * build an expression in the form of "Size * ComparisonOperator size in bytes of FieldToMatch". If * that expression is true, the SizeConstraint is considered to * match.

EQ: Used to test if the Size is equal to the * size of the FieldToMatch

NE: Used to test if the * Size is not equal to the size of the FieldToMatch

*

LE: Used to test if the Size is less than or equal to * the size of the FieldToMatch

LT: Used to test if * the Size is strictly less than the size of the * FieldToMatch

GE: Used to test if the * Size is greater than or equal to the size of the * FieldToMatch

GT: Used to test if the * Size is strictly greater than the size of the * FieldToMatch

*/ inline const ComparisonOperator& GetComparisonOperator() const{ return m_comparisonOperator; } /** *

The type of comparison you want AWS WAF to perform. AWS WAF uses this in * combination with the provided Size and FieldToMatch to * build an expression in the form of "Size * ComparisonOperator size in bytes of FieldToMatch". If * that expression is true, the SizeConstraint is considered to * match.

EQ: Used to test if the Size is equal to the * size of the FieldToMatch

NE: Used to test if the * Size is not equal to the size of the FieldToMatch

*

LE: Used to test if the Size is less than or equal to * the size of the FieldToMatch

LT: Used to test if * the Size is strictly less than the size of the * FieldToMatch

GE: Used to test if the * Size is greater than or equal to the size of the * FieldToMatch

GT: Used to test if the * Size is strictly greater than the size of the * FieldToMatch

*/ inline bool ComparisonOperatorHasBeenSet() const { return m_comparisonOperatorHasBeenSet; } /** *

The type of comparison you want AWS WAF to perform. AWS WAF uses this in * combination with the provided Size and FieldToMatch to * build an expression in the form of "Size * ComparisonOperator size in bytes of FieldToMatch". If * that expression is true, the SizeConstraint is considered to * match.

EQ: Used to test if the Size is equal to the * size of the FieldToMatch

NE: Used to test if the * Size is not equal to the size of the FieldToMatch

*

LE: Used to test if the Size is less than or equal to * the size of the FieldToMatch

LT: Used to test if * the Size is strictly less than the size of the * FieldToMatch

GE: Used to test if the * Size is greater than or equal to the size of the * FieldToMatch

GT: Used to test if the * Size is strictly greater than the size of the * FieldToMatch

*/ inline void SetComparisonOperator(const ComparisonOperator& value) { m_comparisonOperatorHasBeenSet = true; m_comparisonOperator = value; } /** *

The type of comparison you want AWS WAF to perform. AWS WAF uses this in * combination with the provided Size and FieldToMatch to * build an expression in the form of "Size * ComparisonOperator size in bytes of FieldToMatch". If * that expression is true, the SizeConstraint is considered to * match.

EQ: Used to test if the Size is equal to the * size of the FieldToMatch

NE: Used to test if the * Size is not equal to the size of the FieldToMatch

*

LE: Used to test if the Size is less than or equal to * the size of the FieldToMatch

LT: Used to test if * the Size is strictly less than the size of the * FieldToMatch

GE: Used to test if the * Size is greater than or equal to the size of the * FieldToMatch

GT: Used to test if the * Size is strictly greater than the size of the * FieldToMatch

*/ inline void SetComparisonOperator(ComparisonOperator&& value) { m_comparisonOperatorHasBeenSet = true; m_comparisonOperator = std::move(value); } /** *

The type of comparison you want AWS WAF to perform. AWS WAF uses this in * combination with the provided Size and FieldToMatch to * build an expression in the form of "Size * ComparisonOperator size in bytes of FieldToMatch". If * that expression is true, the SizeConstraint is considered to * match.

EQ: Used to test if the Size is equal to the * size of the FieldToMatch

NE: Used to test if the * Size is not equal to the size of the FieldToMatch

*

LE: Used to test if the Size is less than or equal to * the size of the FieldToMatch

LT: Used to test if * the Size is strictly less than the size of the * FieldToMatch

GE: Used to test if the * Size is greater than or equal to the size of the * FieldToMatch

GT: Used to test if the * Size is strictly greater than the size of the * FieldToMatch

*/ inline SizeConstraint& WithComparisonOperator(const ComparisonOperator& value) { SetComparisonOperator(value); return *this;} /** *

The type of comparison you want AWS WAF to perform. AWS WAF uses this in * combination with the provided Size and FieldToMatch to * build an expression in the form of "Size * ComparisonOperator size in bytes of FieldToMatch". If * that expression is true, the SizeConstraint is considered to * match.

EQ: Used to test if the Size is equal to the * size of the FieldToMatch

NE: Used to test if the * Size is not equal to the size of the FieldToMatch

*

LE: Used to test if the Size is less than or equal to * the size of the FieldToMatch

LT: Used to test if * the Size is strictly less than the size of the * FieldToMatch

GE: Used to test if the * Size is greater than or equal to the size of the * FieldToMatch

GT: Used to test if the * Size is strictly greater than the size of the * FieldToMatch

*/ inline SizeConstraint& WithComparisonOperator(ComparisonOperator&& value) { SetComparisonOperator(std::move(value)); return *this;} /** *

The size in bytes that you want AWS WAF to compare against the size of the * specified FieldToMatch. AWS WAF uses this in combination with * ComparisonOperator and FieldToMatch to build an * expression in the form of "Size ComparisonOperator * size in bytes of FieldToMatch". If that expression is true, the * SizeConstraint is considered to match.

Valid values for size * are 0 - 21474836480 bytes (0 - 20 GB).

If you specify URI * for the value of Type, the / in the URI counts as one character. * For example, the URI /logo.jpg is nine characters long.

*/ inline long long GetSize() const{ return m_size; } /** *

The size in bytes that you want AWS WAF to compare against the size of the * specified FieldToMatch. AWS WAF uses this in combination with * ComparisonOperator and FieldToMatch to build an * expression in the form of "Size ComparisonOperator * size in bytes of FieldToMatch". If that expression is true, the * SizeConstraint is considered to match.

Valid values for size * are 0 - 21474836480 bytes (0 - 20 GB).

If you specify URI * for the value of Type, the / in the URI counts as one character. * For example, the URI /logo.jpg is nine characters long.

*/ inline bool SizeHasBeenSet() const { return m_sizeHasBeenSet; } /** *

The size in bytes that you want AWS WAF to compare against the size of the * specified FieldToMatch. AWS WAF uses this in combination with * ComparisonOperator and FieldToMatch to build an * expression in the form of "Size ComparisonOperator * size in bytes of FieldToMatch". If that expression is true, the * SizeConstraint is considered to match.

Valid values for size * are 0 - 21474836480 bytes (0 - 20 GB).

If you specify URI * for the value of Type, the / in the URI counts as one character. * For example, the URI /logo.jpg is nine characters long.

*/ inline void SetSize(long long value) { m_sizeHasBeenSet = true; m_size = value; } /** *

The size in bytes that you want AWS WAF to compare against the size of the * specified FieldToMatch. AWS WAF uses this in combination with * ComparisonOperator and FieldToMatch to build an * expression in the form of "Size ComparisonOperator * size in bytes of FieldToMatch". If that expression is true, the * SizeConstraint is considered to match.

Valid values for size * are 0 - 21474836480 bytes (0 - 20 GB).

If you specify URI * for the value of Type, the / in the URI counts as one character. * For example, the URI /logo.jpg is nine characters long.

*/ inline SizeConstraint& WithSize(long long value) { SetSize(value); return *this;} private: FieldToMatch m_fieldToMatch; bool m_fieldToMatchHasBeenSet = false; TextTransformation m_textTransformation; bool m_textTransformationHasBeenSet = false; ComparisonOperator m_comparisonOperator; bool m_comparisonOperatorHasBeenSet = false; long long m_size; bool m_sizeHasBeenSet = false; }; } // namespace Model } // namespace WAF } // namespace Aws