software.amazon.awscdk.services.wafv2

Interface CfnLoggingConfiguration.FieldToMatchProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnLoggingConfiguration.FieldToMatchProperty.Jsii$Proxy

Enclosing class:

CfnLoggingConfiguration

@Stability(value=Stable)
public static interface CfnLoggingConfiguration.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.

JSON specification 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 jsonBody;
 Object method;
 Object queryString;
 Object singleHeader;
 Object uriPath;
 FieldToMatchProperty fieldToMatchProperty = FieldToMatchProperty.builder()
         .jsonBody(jsonBody)
         .method(method)
         .queryString(queryString)
         .singleHeader(singleHeader)
         .uriPath(uriPath)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnLoggingConfiguration.FieldToMatchProperty.Builder	builder()
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	getUriPath() Inspect the request URI path.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

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 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.

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

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 CfnLoggingConfiguration.FieldToMatchProperty.Builder builder()

Returns:

a CfnLoggingConfiguration.FieldToMatchProperty.Builder of CfnLoggingConfiguration.FieldToMatchProperty