software.amazon.awscdk.services.wafv2

Interface CfnWebACL.BodyProperty

All Known Implementing Classes:

CfnWebACL.BodyProperty.Jsii$Proxy

Enclosing class:

CfnWebACL

public static interface CfnWebACL.BodyProperty

Inspect the body of the web request. The body immediately follows the request headers.

This is used to indicate the web request component to inspect, in the FieldToMatch specification.

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.*;
 BodyProperty bodyProperty = BodyProperty.builder()
         .oversizeHandling("oversizeHandling")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnWebACL.BodyProperty.Builder	builder()
default java.lang.String	getOversizeHandling() What AWS WAF should do if the body is larger than AWS WAF can inspect.

Method Detail

getOversizeHandling

default java.lang.String getOversizeHandling()

What AWS WAF should do if the body is larger than AWS WAF can inspect.

AWS WAF does not support inspecting the entire contents of the body of a web request when the body exceeds 8 KB (8192 bytes). Only the first 8 KB of the request body are forwarded to AWS WAF by the underlying host service.

The options for oversize handling are the following:

• CONTINUE - Inspect the body normally, according to the rule inspection criteria.
• MATCH - Treat the web request as matching the rule statement. AWS WAF applies the rule action to the request.
• NO_MATCH - Treat the web request as not matching the rule statement.

You can combine the MATCH or NO_MATCH settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over 8 KB.

Default: CONTINUE

builder

static CfnWebACL.BodyProperty.Builder builder()

Returns:

a CfnWebACL.BodyProperty.Builder of CfnWebACL.BodyProperty