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

Class CfnWebACLPropsMixin.RuleActionProperty.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.wafv2.CfnWebACLPropsMixin.RuleActionProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnWebACLPropsMixin.RuleActionProperty>

Enclosing interface:

CfnWebACLPropsMixin.RuleActionProperty

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

A builder for CfnWebACLPropsMixin.RuleActionProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnWebACLPropsMixin.RuleActionProperty.Builder	allow(CfnWebACLPropsMixin.AllowActionProperty allow)	Sets the value of CfnWebACLPropsMixin.RuleActionProperty.getAllow()
CfnWebACLPropsMixin.RuleActionProperty.Builder	allow(IResolvable allow)	Sets the value of CfnWebACLPropsMixin.RuleActionProperty.getAllow()
CfnWebACLPropsMixin.RuleActionProperty.Builder	block(CfnWebACLPropsMixin.BlockActionProperty block)	Sets the value of CfnWebACLPropsMixin.RuleActionProperty.getBlock()
CfnWebACLPropsMixin.RuleActionProperty.Builder	block(IResolvable block)	Sets the value of CfnWebACLPropsMixin.RuleActionProperty.getBlock()
CfnWebACLPropsMixin.RuleActionProperty	build()	Builds the configured instance.
CfnWebACLPropsMixin.RuleActionProperty.Builder	captcha(CfnWebACLPropsMixin.CaptchaActionProperty captcha)	Sets the value of CfnWebACLPropsMixin.RuleActionProperty.getCaptcha()
CfnWebACLPropsMixin.RuleActionProperty.Builder	captcha(IResolvable captcha)	Sets the value of CfnWebACLPropsMixin.RuleActionProperty.getCaptcha()
CfnWebACLPropsMixin.RuleActionProperty.Builder	challenge(CfnWebACLPropsMixin.ChallengeActionProperty challenge)	Sets the value of CfnWebACLPropsMixin.RuleActionProperty.getChallenge()
CfnWebACLPropsMixin.RuleActionProperty.Builder	challenge(IResolvable challenge)	Sets the value of CfnWebACLPropsMixin.RuleActionProperty.getChallenge()
CfnWebACLPropsMixin.RuleActionProperty.Builder	count(CfnWebACLPropsMixin.CountActionProperty count)	Sets the value of CfnWebACLPropsMixin.RuleActionProperty.getCount()
CfnWebACLPropsMixin.RuleActionProperty.Builder	count(IResolvable count)	Sets the value of CfnWebACLPropsMixin.RuleActionProperty.getCount()

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

allow

@Stability(Stable)
public CfnWebACLPropsMixin.RuleActionProperty.Builder allow(IResolvable allow)

Sets the value of CfnWebACLPropsMixin.RuleActionProperty.getAllow()

Parameters:

allow - Instructs AWS WAF to allow the web request.

Returns:

this

allow

@Stability(Stable)
public CfnWebACLPropsMixin.RuleActionProperty.Builder allow(CfnWebACLPropsMixin.AllowActionProperty allow)

Sets the value of CfnWebACLPropsMixin.RuleActionProperty.getAllow()

Parameters:

allow - Instructs AWS WAF to allow the web request.

Returns:

this

block

@Stability(Stable)
public CfnWebACLPropsMixin.RuleActionProperty.Builder block(IResolvable block)

Sets the value of CfnWebACLPropsMixin.RuleActionProperty.getBlock()

Parameters:

block - Instructs AWS WAF to block the web request.

Returns:

this

block

@Stability(Stable)
public CfnWebACLPropsMixin.RuleActionProperty.Builder block(CfnWebACLPropsMixin.BlockActionProperty block)

Sets the value of CfnWebACLPropsMixin.RuleActionProperty.getBlock()

Parameters:

block - Instructs AWS WAF to block the web request.

Returns:

this

captcha

@Stability(Stable)
public CfnWebACLPropsMixin.RuleActionProperty.Builder captcha(IResolvable captcha)

Sets the value of CfnWebACLPropsMixin.RuleActionProperty.getCaptcha()

Parameters:

captcha - Specifies that AWS WAF should run a CAPTCHA check against the request:.

• If the request includes a valid, unexpired CAPTCHA token, AWS WAF allows the web request inspection to proceed to the next rule, similar to a CountAction .
• If the request doesn't include a valid, unexpired CAPTCHA token, AWS WAF discontinues the web ACL evaluation of the request and blocks it from going to its intended destination.

AWS WAF generates a response that it sends back to the client, which includes the following:

• The header x-amzn-waf-action with a value of captcha .
• The HTTP status code 405 Method Not Allowed .
• If the request contains an Accept header with a value of text/html , the response includes a CAPTCHA challenge.

You can configure the expiration time in the CaptchaConfig ImmunityTimeProperty setting at the rule and web ACL level. The rule setting overrides the web ACL setting.

This action option is available for rules. It isn't available for web ACL default actions.

Returns:

this

captcha

@Stability(Stable)
public CfnWebACLPropsMixin.RuleActionProperty.Builder captcha(CfnWebACLPropsMixin.CaptchaActionProperty captcha)

Sets the value of CfnWebACLPropsMixin.RuleActionProperty.getCaptcha()

Parameters:

captcha - Specifies that AWS WAF should run a CAPTCHA check against the request:.

• If the request includes a valid, unexpired CAPTCHA token, AWS WAF allows the web request inspection to proceed to the next rule, similar to a CountAction .
• If the request doesn't include a valid, unexpired CAPTCHA token, AWS WAF discontinues the web ACL evaluation of the request and blocks it from going to its intended destination.

AWS WAF generates a response that it sends back to the client, which includes the following:

• The header x-amzn-waf-action with a value of captcha .
• The HTTP status code 405 Method Not Allowed .
• If the request contains an Accept header with a value of text/html , the response includes a CAPTCHA challenge.

You can configure the expiration time in the CaptchaConfig ImmunityTimeProperty setting at the rule and web ACL level. The rule setting overrides the web ACL setting.

This action option is available for rules. It isn't available for web ACL default actions.

Returns:

this

challenge

@Stability(Stable)
public CfnWebACLPropsMixin.RuleActionProperty.Builder challenge(IResolvable challenge)

Sets the value of CfnWebACLPropsMixin.RuleActionProperty.getChallenge()

Parameters:

challenge - Instructs AWS WAF to run a Challenge check against the web request.

Returns:

this

challenge

@Stability(Stable)
public CfnWebACLPropsMixin.RuleActionProperty.Builder challenge(CfnWebACLPropsMixin.ChallengeActionProperty challenge)

Sets the value of CfnWebACLPropsMixin.RuleActionProperty.getChallenge()

Parameters:

challenge - Instructs AWS WAF to run a Challenge check against the web request.

Returns:

this

count

@Stability(Stable)
public CfnWebACLPropsMixin.RuleActionProperty.Builder count(IResolvable count)

Sets the value of CfnWebACLPropsMixin.RuleActionProperty.getCount()

Parameters:

count - Instructs AWS WAF to count the web request and then continue evaluating the request using the remaining rules in the web ACL.

Returns:

this

count

@Stability(Stable)
public CfnWebACLPropsMixin.RuleActionProperty.Builder count(CfnWebACLPropsMixin.CountActionProperty count)

Sets the value of CfnWebACLPropsMixin.RuleActionProperty.getCount()

Parameters:

count - Instructs AWS WAF to count the web request and then continue evaluating the request using the remaining rules in the web ACL.

Returns:

this

build

@Stability(Stable)
public CfnWebACLPropsMixin.RuleActionProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnWebACLPropsMixin.RuleActionProperty>

Returns:

a new instance of CfnWebACLPropsMixin.RuleActionProperty

Throws:

NullPointerException - if any required attribute was not provided