Package software.amazon.awscdk.cfnpropertymixins.services.wafv2

Class CfnRuleGroupPropsMixin.ByteMatchStatementProperty.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.wafv2.CfnRuleGroupPropsMixin.ByteMatchStatementProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnRuleGroupPropsMixin.ByteMatchStatementProperty>

Enclosing interface:

CfnRuleGroupPropsMixin.ByteMatchStatementProperty

@Stability(Stable)
public static final class CfnRuleGroupPropsMixin.ByteMatchStatementProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnRuleGroupPropsMixin.ByteMatchStatementProperty>

A builder for CfnRuleGroupPropsMixin.ByteMatchStatementProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnRuleGroupPropsMixin.ByteMatchStatementProperty	build()	Builds the configured instance.
CfnRuleGroupPropsMixin.ByteMatchStatementProperty.Builder	fieldToMatch(CfnRuleGroupPropsMixin.FieldToMatchProperty fieldToMatch)	Sets the value of CfnRuleGroupPropsMixin.ByteMatchStatementProperty.getFieldToMatch()
CfnRuleGroupPropsMixin.ByteMatchStatementProperty.Builder	fieldToMatch(IResolvable fieldToMatch)	Sets the value of CfnRuleGroupPropsMixin.ByteMatchStatementProperty.getFieldToMatch()
CfnRuleGroupPropsMixin.ByteMatchStatementProperty.Builder	positionalConstraint(String positionalConstraint)	Sets the value of CfnRuleGroupPropsMixin.ByteMatchStatementProperty.getPositionalConstraint()
CfnRuleGroupPropsMixin.ByteMatchStatementProperty.Builder	searchString(String searchString)	Sets the value of CfnRuleGroupPropsMixin.ByteMatchStatementProperty.getSearchString()
CfnRuleGroupPropsMixin.ByteMatchStatementProperty.Builder	searchStringBase64(String searchStringBase64)	Sets the value of CfnRuleGroupPropsMixin.ByteMatchStatementProperty.getSearchStringBase64()
CfnRuleGroupPropsMixin.ByteMatchStatementProperty.Builder	textTransformations(List<? extends Object> textTransformations)	Sets the value of CfnRuleGroupPropsMixin.ByteMatchStatementProperty.getTextTransformations()
CfnRuleGroupPropsMixin.ByteMatchStatementProperty.Builder	textTransformations(IResolvable textTransformations)	Sets the value of CfnRuleGroupPropsMixin.ByteMatchStatementProperty.getTextTransformations()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

fieldToMatch

@Stability(Stable)
public CfnRuleGroupPropsMixin.ByteMatchStatementProperty.Builder fieldToMatch(IResolvable fieldToMatch)

Sets the value of CfnRuleGroupPropsMixin.ByteMatchStatementProperty.getFieldToMatch()

Parameters:

fieldToMatch - The part of the web request that you want AWS WAF to inspect.

Returns:

this

fieldToMatch

@Stability(Stable)
public CfnRuleGroupPropsMixin.ByteMatchStatementProperty.Builder fieldToMatch(CfnRuleGroupPropsMixin.FieldToMatchProperty fieldToMatch)

Sets the value of CfnRuleGroupPropsMixin.ByteMatchStatementProperty.getFieldToMatch()

Parameters:

fieldToMatch - The part of the web request that you want AWS WAF to inspect.

Returns:

this

positionalConstraint

@Stability(Stable)
public CfnRuleGroupPropsMixin.ByteMatchStatementProperty.Builder positionalConstraint(String positionalConstraint)

Sets the value of CfnRuleGroupPropsMixin.ByteMatchStatementProperty.getPositionalConstraint()

Parameters:

positionalConstraint - The area within the portion of the web request that you want AWS WAF to search for SearchString . Valid values include the following:

CONTAINS

The specified part of the web request must include the value of SearchString , but the location doesn't matter.

CONTAINS_WORD

The specified part of the web request must include the value of SearchString , and SearchString must contain only alphanumeric characters or underscore (A-Z, a-z, 0-9, or _). In addition, SearchString must be a word, which means that both of the following are true:

• SearchString is at the beginning of the specified part of the web request or is preceded by a character other than an alphanumeric character or underscore (_). Examples include the value of a header and ;BadBot .
• SearchString is at the end of the specified part of the web request or is followed by a character other than an alphanumeric character or underscore (_), for example, BadBot; and -BadBot; .

EXACTLY

The value of the specified part of the web request must exactly match the value of SearchString .

STARTS_WITH

The value of SearchString must appear at the beginning of the specified part of the web request.

ENDS_WITH

The value of SearchString must appear at the end of the specified part of the web request.

Returns:

this

searchString

@Stability(Stable)
public CfnRuleGroupPropsMixin.ByteMatchStatementProperty.Builder searchString(String searchString)

Sets the value of CfnRuleGroupPropsMixin.ByteMatchStatementProperty.getSearchString()

Parameters:

searchString - A string value that you want AWS WAF to search for. AWS WAF searches only in the part of web requests that you designate for inspection in FieldToMatch . The maximum length of the value is 200 bytes. For alphabetic characters A-Z and a-z, the value is case sensitive.

Don't encode this string. Provide the value that you want AWS WAF to search for. AWS CloudFormation automatically base64 encodes the value for you.

For example, suppose the value of Type is HEADER and the value of Data is User-Agent . If you want to search the User-Agent header for the value BadBot , you provide the string BadBot in the value of SearchString .

You must specify either SearchString or SearchStringBase64 in a ByteMatchStatement .

Returns:

this

searchStringBase64

@Stability(Stable)
public CfnRuleGroupPropsMixin.ByteMatchStatementProperty.Builder searchStringBase64(String searchStringBase64)

Sets the value of CfnRuleGroupPropsMixin.ByteMatchStatementProperty.getSearchStringBase64()

Parameters:

searchStringBase64 - String to search for in a web request component, base64-encoded. If you don't want to encode the string, specify the unencoded value in SearchString instead.

You must specify either SearchString or SearchStringBase64 in a ByteMatchStatement .

Returns:

this

textTransformations

@Stability(Stable)
public CfnRuleGroupPropsMixin.ByteMatchStatementProperty.Builder textTransformations(IResolvable textTransformations)

Sets the value of CfnRuleGroupPropsMixin.ByteMatchStatementProperty.getTextTransformations()

Parameters:

textTransformations - Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content of the request component identified by FieldToMatch , starting from the lowest priority setting, before inspecting the content for a match.

Returns:

this

textTransformations

@Stability(Stable)
public CfnRuleGroupPropsMixin.ByteMatchStatementProperty.Builder textTransformations(List<? extends Object> textTransformations)

Sets the value of CfnRuleGroupPropsMixin.ByteMatchStatementProperty.getTextTransformations()

Parameters:

textTransformations - Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content of the request component identified by FieldToMatch , starting from the lowest priority setting, before inspecting the content for a match.

Returns:

this

build

@Stability(Stable)
public CfnRuleGroupPropsMixin.ByteMatchStatementProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnRuleGroupPropsMixin.ByteMatchStatementProperty>

Returns:

a new instance of CfnRuleGroupPropsMixin.ByteMatchStatementProperty

Throws:

NullPointerException - if any required attribute was not provided