Package software.amazon.awscdk.services.wafv2

Class CfnRuleGroup.RuleActionProperty.Builder

java.lang.Object

software.amazon.awscdk.services.wafv2.CfnRuleGroup.RuleActionProperty.Builder

All Implemented Interfaces:

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

Enclosing interface:

CfnRuleGroup.RuleActionProperty

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

A builder for CfnRuleGroup.RuleActionProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnRuleGroup.RuleActionProperty.Builder	allow(Object allow)	Sets the value of CfnRuleGroup.RuleActionProperty.getAllow()
CfnRuleGroup.RuleActionProperty.Builder	block(Object block)	Sets the value of CfnRuleGroup.RuleActionProperty.getBlock()
CfnRuleGroup.RuleActionProperty	build()	Builds the configured instance.
CfnRuleGroup.RuleActionProperty.Builder	captcha(Object captcha)	Sets the value of CfnRuleGroup.RuleActionProperty.getCaptcha()
CfnRuleGroup.RuleActionProperty.Builder	challenge(Object challenge)	Sets the value of CfnRuleGroup.RuleActionProperty.getChallenge()
CfnRuleGroup.RuleActionProperty.Builder	count(Object count)	Sets the value of CfnRuleGroup.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 CfnRuleGroup.RuleActionProperty.Builder allow(Object allow)

Sets the value of CfnRuleGroup.RuleActionProperty.getAllow()

Parameters:

allow - Instructs AWS WAF to allow the web request.

Returns:

this

block

@Stability(Stable)
public CfnRuleGroup.RuleActionProperty.Builder block(Object block)

Sets the value of CfnRuleGroup.RuleActionProperty.getBlock()

Parameters:

block - Instructs AWS WAF to block the web request.

Returns:

this

captcha

@Stability(Stable)
public CfnRuleGroup.RuleActionProperty.Builder captcha(Object captcha)

Sets the value of CfnRuleGroup.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 CfnRuleGroup.RuleActionProperty.Builder challenge(Object challenge)

Sets the value of CfnRuleGroup.RuleActionProperty.getChallenge()

Parameters:

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

Returns:

this

count

@Stability(Stable)
public CfnRuleGroup.RuleActionProperty.Builder count(Object count)

Sets the value of CfnRuleGroup.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 CfnRuleGroup.RuleActionProperty build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnRuleGroup.RuleActionProperty

Throws:

NullPointerException - if any required attribute was not provided