Package software.amazon.awscdk.services.waf.regional

Interface CfnSizeConstraintSet.FieldToMatchProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnSizeConstraintSet.FieldToMatchProperty.Jsii$Proxy

Enclosing class:

CfnSizeConstraintSet

@Stability(Stable)
public static interface CfnSizeConstraintSet.FieldToMatchProperty
extends software.amazon.jsii.JsiiSerializable

The part of a web request that you want AWS WAF to inspect, such as a specific header or a query string.

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.waf.regional.*;
 FieldToMatchProperty fieldToMatchProperty = FieldToMatchProperty.builder()
         .type("type")
         // the properties below are optional
         .data("data")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnSizeConstraintSet.FieldToMatchProperty.Builder	builder()
default String	getData()	When the value of Type is HEADER , enter the name of the header that you want AWS WAF to search, for example, User-Agent or Referer .
String	getType()	The part of the web request that you want AWS WAF to search for a specified string.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getType

@Stability(Stable)
@NotNull
String getType()

The part of the web request that you want AWS WAF to search for a specified string.

Parts of a request that you can search include the following:

• HEADER : A specified request header, for example, the value of the User-Agent or Referer header. If you choose HEADER for the type, specify the name of the header in Data .
• METHOD : The HTTP method, which indicates the type of operation that the request is asking the origin to perform.
• QUERY_STRING : A query string, which is the part of a URL that appears after a ? character, if any.
• URI : The part of a web request that identifies a resource, for example, /images/daily-ad.jpg .
• BODY : 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. The request body immediately follows the request headers. Note that only the first 8192 bytes of the request body are forwarded to AWS WAF for inspection. To allow or block requests based on the length of the body, you can create a size constraint set.
• SINGLE_QUERY_ARG : The parameter in the query string that you will inspect, such as UserName or SalesRegion . The maximum length for SINGLE_QUERY_ARG is 30 characters.
• ALL_QUERY_ARGS : Similar to SINGLE_QUERY_ARG , but rather than inspecting a single parameter, AWS WAF will inspect all parameters within the query for the value or regex pattern that you specify in TargetString .

getData

@Stability(Stable)
@Nullable
default String getData()

When the value of Type is HEADER , enter the name of the header that you want AWS WAF to search, for example, User-Agent or Referer .

The name of the header is not case sensitive.

When the value of Type is SINGLE_QUERY_ARG , enter the name of the parameter that you want AWS WAF to search, for example, UserName or SalesRegion . The parameter name is not case sensitive.

If the value of Type is any other value, omit Data .

builder

@Stability(Stable)
static CfnSizeConstraintSet.FieldToMatchProperty.Builder builder()

Returns:

a CfnSizeConstraintSet.FieldToMatchProperty.Builder of CfnSizeConstraintSet.FieldToMatchProperty