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 the 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 the web request, create a separate rule statement for each component.

Example JSON for a QueryString field to match:

"FieldToMatch": { "QueryString": {} }

Example JSON for a Method field to match specification:

"FieldToMatch": { "Method": { "Name": "DELETE" } }

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;
 FieldToMatchProperty fieldToMatchProperty = 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();
 

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 as plain text.
default Object	getCookies() Inspect the request cookies.
default Object	getHeaders() Inspect 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 as plain text.

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.

Only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. For information about how to handle oversized request bodies, see the Body object configuration.

getCookies

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

Inspect the request cookies.

You must configure scope and pattern matching filters in the Cookies object, to define the set of cookies and the parts of the cookies that AWS WAF inspects.

Only the first 8 KB (8192 bytes) of a request's cookies and only the first 200 cookies are forwarded to AWS WAF for inspection by the underlying host service. You must configure how to handle any oversize cookie content in the Cookies object. AWS WAF applies the pattern matching filters to the cookies that it receives from the underlying host service.

getHeaders

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

Inspect the request headers.

You must configure scope and pattern matching filters in the Headers object, to define the set of headers to and the parts of the headers that AWS WAF inspects.

Only the first 8 KB (8192 bytes) of a request's headers and only the first 200 headers are forwarded to AWS WAF for inspection by the underlying host service. You must configure how to handle any oversize header content in the Headers object. AWS WAF applies the pattern matching filters to the headers that it receives from the underlying host service.

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.

Only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. For information about how to handle oversized request bodies, see the JsonBody object configuration.

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.

Example JSON: "SingleHeader": { "Name": "haystack" }

Alternately, you can filter and inspect all headers with the Headers FieldToMatch setting.

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.

Example JSON: "SingleQueryArgument": { "Name": "myArgument" }

getUriPath

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

Inspect the request URI path.

This is the part of the 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