Class CfnByteMatchSet.FieldToMatchProperty.Builder
java.lang.Object
software.amazon.awscdk.services.waf.regional.CfnByteMatchSet.FieldToMatchProperty.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnByteMatchSet.FieldToMatchProperty>
- Enclosing interface:
CfnByteMatchSet.FieldToMatchProperty
@Stability(Stable)
public static final class CfnByteMatchSet.FieldToMatchProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnByteMatchSet.FieldToMatchProperty>
A builder for
CfnByteMatchSet.FieldToMatchProperty
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds the configured instance.Sets the value ofCfnByteMatchSet.FieldToMatchProperty.getData()
Sets the value ofCfnByteMatchSet.FieldToMatchProperty.getType()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
type
Sets the value ofCfnByteMatchSet.FieldToMatchProperty.getType()
- Parameters:
type
- The part of the web request that you want AWS WAF to search for a specified string. This parameter is required. Parts of a request that you can search include the following:HEADER
: A specified request header, for example, the value of theUser-Agent
orReferer
header. If you chooseHEADER
for the type, specify the name of the header inData
.METHOD
: The HTTP method, which indicated 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 first8192
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 forSINGLE_QUERY_ARG
is 30 characters.ALL_QUERY_ARGS
: Similar toSINGLE_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 inTargetString
.
- Returns:
this
-
data
Sets the value ofCfnByteMatchSet.FieldToMatchProperty.getData()
- Parameters:
data
- When the value ofType
isHEADER
, enter the name of the header that you want AWS WAF to search, for example,User-Agent
orReferer
. The name of the header is not case sensitive.When the value of
Type
isSINGLE_QUERY_ARG
, enter the name of the parameter that you want AWS WAF to search, for example,UserName
orSalesRegion
. The parameter name is not case sensitive.If the value of
Type
is any other value, omitData
.- Returns:
this
-
build
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnByteMatchSet.FieldToMatchProperty>
- Returns:
- a new instance of
CfnByteMatchSet.FieldToMatchProperty
- Throws:
NullPointerException
- if any required attribute was not provided
-