software.amazon.awscdk.services.wafv2

Interface CfnRuleGroup.FieldToMatchProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnRuleGroup.FieldToMatchProperty.Jsii$Proxy

Enclosing class:

CfnRuleGroup

@Stability(value=Stable)
public static interface CfnRuleGroup.FieldToMatchProperty
extends software.amazon.jsii.JsiiSerializable

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

Include the single FieldToMatch type that you want to inspect, with additional specifications as needed, according to the type. You specify a single request component in FieldToMatch for each rule statement that requires it. To inspect more than one component of a web request, create a separate rule statement for each component.

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 body;
 Object method;
 Object queryString;
 Object singleHeader;
 Object singleQueryArgument;
 Object uriPath;
 FieldToMatchProperty fieldToMatchProperty = FieldToMatchProperty.builder()
         .allQueryArguments(allQueryArguments)
         .body(body)
         .jsonBody(JsonBodyProperty.builder()
                 .matchPattern(JsonMatchPatternProperty.builder()
                         .all(all)
                         .includedPaths(List.of("includedPaths"))
                         .build())
                 .matchScope("matchScope")
                 // the properties below are optional
                 .invalidFallbackBehavior("invalidFallbackBehavior")
                 .build())
         .method(method)
         .queryString(queryString)
         .singleHeader(singleHeader)
         .singleQueryArgument(singleQueryArgument)
         .uriPath(uriPath)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnRuleGroup.FieldToMatchProperty.Builder	builder()
default Object	getAllQueryArguments() Inspect all query arguments.
default Object	getBody() Inspect the request body, which immediately follows the request headers.
default Object	getJsonBody() Inspect the request body as JSON.
default Object	getMethod() Inspect the HTTP method.
default Object	getQueryString() Inspect the query string.
default Object	getSingleHeader() Inspect a single header.
default Object	getSingleQueryArgument() Inspect a single query argument.
default Object	getUriPath() Inspect the request URI path.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAllQueryArguments

@Stability(value=Stable)
 @Nullable
default Object getAllQueryArguments()

Inspect all query arguments.

getBody

@Stability(value=Stable)
 @Nullable
default Object getBody()

Inspect the request body, which immediately follows the request headers.

This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.

Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as the ByteMatchStatement or RegexPatternSetReferenceStatement , with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.

getJsonBody

@Stability(value=Stable)
 @Nullable
default Object getJsonBody()

Inspect the request body as JSON.

The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.

Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as the ByteMatchStatement or RegexPatternSetReferenceStatement , with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.

getMethod

@Stability(value=Stable)
 @Nullable
default Object getMethod()

Inspect the HTTP method.

The method indicates the type of operation that the request is asking the origin to perform.

getQueryString

@Stability(value=Stable)
 @Nullable
default Object getQueryString()

Inspect the query string.

This is the part of a URL that appears after a ? character, if any.

getSingleHeader

@Stability(value=Stable)
 @Nullable
default Object getSingleHeader()

Inspect a single header.

Provide the name of the header to inspect, for example, User-Agent or Referer . This setting isn't case sensitive.

getSingleQueryArgument

@Stability(value=Stable)
 @Nullable
default Object getSingleQueryArgument()

Inspect a single query argument.

Provide the name of the query argument to inspect, such as UserName or SalesRegion . The name can be up to 30 characters long and isn't case sensitive.

getUriPath

@Stability(value=Stable)
 @Nullable
default Object getUriPath()

Inspect the request URI path.

This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg .

builder

@Stability(value=Stable)
static CfnRuleGroup.FieldToMatchProperty.Builder builder()

Returns:

a CfnRuleGroup.FieldToMatchProperty.Builder of CfnRuleGroup.FieldToMatchProperty