software.amazon.awscdk.services.wafv2

Interface CfnWebACL.SizeConstraintStatementProperty

All Known Implementing Classes:

CfnWebACL.SizeConstraintStatementProperty.Jsii$Proxy

Enclosing class:

CfnWebACL

public static interface CfnWebACL.SizeConstraintStatementProperty

A rule statement that compares a number of bytes against the size of a request component, using a comparison operator, such as greater than (>) or less than (<).

For example, you can use a size constraint statement to look for query strings that are longer than 100 bytes.

If you configure AWS WAF to inspect the request body, AWS WAF inspects only the first 8192 bytes (8 KB). If the request body for your web requests never exceeds 8192 bytes, you could use a size constraint statement to block requests that have a request body greater than 8192 bytes.

If you choose URI for the value of Part of the request to filter on, the slash (/) in the URI counts as one character. For example, the URI /logo.jpg is nine characters long.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.wafv2.*;
 Object all;
 Object allQueryArguments;
 Object method;
 Object queryString;
 Object singleHeader;
 Object singleQueryArgument;
 Object uriPath;
 SizeConstraintStatementProperty sizeConstraintStatementProperty = SizeConstraintStatementProperty.builder()
         .comparisonOperator("comparisonOperator")
         .fieldToMatch(FieldToMatchProperty.builder()
                 .allQueryArguments(allQueryArguments)
                 .body(BodyProperty.builder()
                         .oversizeHandling("oversizeHandling")
                         .build())
                 .cookies(CookiesProperty.builder()
                         .matchPattern(CookieMatchPatternProperty.builder()
                                 .all(all)
                                 .excludedCookies(List.of("excludedCookies"))
                                 .includedCookies(List.of("includedCookies"))
                                 .build())
                         .matchScope("matchScope")
                         .oversizeHandling("oversizeHandling")
                         .build())
                 .headers(HeadersProperty.builder()
                         .matchPattern(HeaderMatchPatternProperty.builder()
                                 .all(all)
                                 .excludedHeaders(List.of("excludedHeaders"))
                                 .includedHeaders(List.of("includedHeaders"))
                                 .build())
                         .matchScope("matchScope")
                         .oversizeHandling("oversizeHandling")
                         .build())
                 .jsonBody(JsonBodyProperty.builder()
                         .matchPattern(JsonMatchPatternProperty.builder()
                                 .all(all)
                                 .includedPaths(List.of("includedPaths"))
                                 .build())
                         .matchScope("matchScope")
                         // the properties below are optional
                         .invalidFallbackBehavior("invalidFallbackBehavior")
                         .oversizeHandling("oversizeHandling")
                         .build())
                 .method(method)
                 .queryString(queryString)
                 .singleHeader(singleHeader)
                 .singleQueryArgument(singleQueryArgument)
                 .uriPath(uriPath)
                 .build())
         .size(123)
         .textTransformations(List.of(TextTransformationProperty.builder()
                 .priority(123)
                 .type("type")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnWebACL.SizeConstraintStatementProperty.Builder A builder for CfnWebACL.SizeConstraintStatementProperty
static class	CfnWebACL.SizeConstraintStatementProperty.Jsii$Proxy An implementation for CfnWebACL.SizeConstraintStatementProperty

Method Summary

Modifier and Type	Method and Description
static CfnWebACL.SizeConstraintStatementProperty.Builder	builder()
java.lang.String	getComparisonOperator() The operator to use to compare the request part to the size setting.
java.lang.Object	getFieldToMatch() The part of the web request that you want AWS WAF to inspect.
java.lang.Number	getSize() The size, in byte, to compare to the request part, after any transformations.
java.lang.Object	getTextTransformations() Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection.

Method Detail

getComparisonOperator

java.lang.String getComparisonOperator()

The operator to use to compare the request part to the size setting.

getFieldToMatch

java.lang.Object getFieldToMatch()

The part of the web request that you want AWS WAF to inspect.

getSize

java.lang.Number getSize()

The size, in byte, to compare to the request part, after any transformations.

getTextTransformations

java.lang.Object getTextTransformations()

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection.

If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content of the request component identified by FieldToMatch , starting from the lowest priority setting, before inspecting the content for a match.

builder

static CfnWebACL.SizeConstraintStatementProperty.Builder builder()

Returns:

a CfnWebACL.SizeConstraintStatementProperty.Builder of CfnWebACL.SizeConstraintStatementProperty