Package software.amazon.awssdk.services.waf.model

Class SizeConstraint

java.lang.Object
software.amazon.awssdk.services.waf.model.SizeConstraint
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<SizeConstraint.Builder,SizeConstraint>
@Generated("software.amazon.awssdk:codegen") public final class SizeConstraint extends Object implements SdkPojo, Serializable, ToCopyableBuilder<SizeConstraint.Builder,SizeConstraint>

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:

  • Method Details

    • fieldToMatch

      public final FieldToMatch fieldToMatch()

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

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

    • textTransformation

      public final TextTransformation 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.

      If the service returns an enum value that is not available in the current SDK version, textTransformation will return TextTransformation.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from textTransformationAsString().

      Returns:
      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.

      See Also:

    • textTransformationAsString

      public final String textTransformationAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, textTransformation will return TextTransformation.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from textTransformationAsString().

      Returns:
      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.

      See Also:

    • comparisonOperator

      public final ComparisonOperator 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

      If the service returns an enum value that is not available in the current SDK version, comparisonOperator will return ComparisonOperator.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from comparisonOperatorAsString().

      Returns:
      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

      See Also:

    • comparisonOperatorAsString

      public final String comparisonOperatorAsString()

      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

      If the service returns an enum value that is not available in the current SDK version, comparisonOperator will return ComparisonOperator.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from comparisonOperatorAsString().

      Returns:
      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

      See Also:

    • size

      public final Long 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.

      Returns:
      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.

    • toBuilder

      public SizeConstraint.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<SizeConstraint.Builder,SizeConstraint>
      Returns:
      a builder for type T

    • builder

      public static SizeConstraint.Builder builder()

    • serializableBuilderClass

      public static Class<? extends SizeConstraint.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.