Interface SizeConstraint.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<SizeConstraint.Builder,
,SizeConstraint> SdkBuilder<SizeConstraint.Builder,
,SizeConstraint> SdkPojo
- Enclosing class:
SizeConstraint
-
Method Summary
Modifier and TypeMethodDescriptioncomparisonOperator
(String comparisonOperator) The type of comparison you want AWS WAF to perform.comparisonOperator
(ComparisonOperator comparisonOperator) The type of comparison you want AWS WAF to perform.default SizeConstraint.Builder
fieldToMatch
(Consumer<FieldToMatch.Builder> fieldToMatch) Specifies where in a web request to look for the size constraint.fieldToMatch
(FieldToMatch fieldToMatch) Specifies where in a web request to look for the size constraint.The size in bytes that you want AWS WAF to compare against the size of the specifiedFieldToMatch
.textTransformation
(String textTransformation) Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF.textTransformation
(TextTransformation textTransformation) Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
fieldToMatch
Specifies where in a web request to look for the size constraint.
- Parameters:
fieldToMatch
- Specifies where in a web request to look for the size constraint.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
fieldToMatch
Specifies where in a web request to look for the size constraint.
This is a convenience method that creates an instance of theFieldToMatch.Builder
avoiding the need to create one manually viaFieldToMatch.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tofieldToMatch(FieldToMatch)
.- Parameters:
fieldToMatch
- a consumer that will call methods onFieldToMatch.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 ofType
, you must chooseNONE
forTextTransformation
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.
- Parameters:
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 onFieldToMatch
before inspecting it for a match.You can only specify a single type of TextTransformation.
Note that if you choose
BODY
for the value ofType
, you must chooseNONE
forTextTransformation
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
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 ofType
, you must chooseNONE
forTextTransformation
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.
- Parameters:
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 onFieldToMatch
before inspecting it for a match.You can only specify a single type of TextTransformation.
Note that if you choose
BODY
for the value ofType
, you must chooseNONE
forTextTransformation
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
comparisonOperator
The type of comparison you want AWS WAF to perform. AWS WAF uses this in combination with the provided
Size
andFieldToMatch
to build an expression in the form of "Size
ComparisonOperator
size in bytes ofFieldToMatch
". If that expression is true, theSizeConstraint
is considered to match.EQ: Used to test if the
Size
is equal to the size of theFieldToMatch
NE: Used to test if the
Size
is not equal to the size of theFieldToMatch
LE: Used to test if the
Size
is less than or equal to the size of theFieldToMatch
LT: Used to test if the
Size
is strictly less than the size of theFieldToMatch
GE: Used to test if the
Size
is greater than or equal to the size of theFieldToMatch
GT: Used to test if the
Size
is strictly greater than the size of theFieldToMatch
- Parameters:
comparisonOperator
- The type of comparison you want AWS WAF to perform. AWS WAF uses this in combination with the providedSize
andFieldToMatch
to build an expression in the form of "Size
ComparisonOperator
size in bytes ofFieldToMatch
". If that expression is true, theSizeConstraint
is considered to match.EQ: Used to test if the
Size
is equal to the size of theFieldToMatch
NE: Used to test if the
Size
is not equal to the size of theFieldToMatch
LE: Used to test if the
Size
is less than or equal to the size of theFieldToMatch
LT: Used to test if the
Size
is strictly less than the size of theFieldToMatch
GE: Used to test if the
Size
is greater than or equal to the size of theFieldToMatch
GT: Used to test if the
Size
is strictly greater than the size of theFieldToMatch
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
comparisonOperator
The type of comparison you want AWS WAF to perform. AWS WAF uses this in combination with the provided
Size
andFieldToMatch
to build an expression in the form of "Size
ComparisonOperator
size in bytes ofFieldToMatch
". If that expression is true, theSizeConstraint
is considered to match.EQ: Used to test if the
Size
is equal to the size of theFieldToMatch
NE: Used to test if the
Size
is not equal to the size of theFieldToMatch
LE: Used to test if the
Size
is less than or equal to the size of theFieldToMatch
LT: Used to test if the
Size
is strictly less than the size of theFieldToMatch
GE: Used to test if the
Size
is greater than or equal to the size of theFieldToMatch
GT: Used to test if the
Size
is strictly greater than the size of theFieldToMatch
- Parameters:
comparisonOperator
- The type of comparison you want AWS WAF to perform. AWS WAF uses this in combination with the providedSize
andFieldToMatch
to build an expression in the form of "Size
ComparisonOperator
size in bytes ofFieldToMatch
". If that expression is true, theSizeConstraint
is considered to match.EQ: Used to test if the
Size
is equal to the size of theFieldToMatch
NE: Used to test if the
Size
is not equal to the size of theFieldToMatch
LE: Used to test if the
Size
is less than or equal to the size of theFieldToMatch
LT: Used to test if the
Size
is strictly less than the size of theFieldToMatch
GE: Used to test if the
Size
is greater than or equal to the size of theFieldToMatch
GT: Used to test if the
Size
is strictly greater than the size of theFieldToMatch
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 withComparisonOperator
andFieldToMatch
to build an expression in the form of "Size
ComparisonOperator
size in bytes ofFieldToMatch
". If that expression is true, theSizeConstraint
is considered to match.Valid values for size are 0 - 21474836480 bytes (0 - 20 GB).
If you specify
URI
for the value ofType
, the / in the URI counts as one character. For example, the URI/logo.jpg
is nine characters long.- Parameters:
size
- The size in bytes that you want AWS WAF to compare against the size of the specifiedFieldToMatch
. AWS WAF uses this in combination withComparisonOperator
andFieldToMatch
to build an expression in the form of "Size
ComparisonOperator
size in bytes ofFieldToMatch
". If that expression is true, theSizeConstraint
is considered to match.Valid values for size are 0 - 21474836480 bytes (0 - 20 GB).
If you specify
URI
for the value ofType
, the / in the URI counts as one character. For example, the URI/logo.jpg
is nine characters long.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-