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

Class CfnRuleGroupPropsMixin.RuleProperty.Builder

java.lang.Object

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

All Implemented Interfaces:

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

Enclosing interface:

CfnRuleGroupPropsMixin.RuleProperty

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

A builder for CfnRuleGroupPropsMixin.RuleProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnRuleGroupPropsMixin.RuleProperty.Builder	action(CfnRuleGroupPropsMixin.RuleActionProperty action)	Sets the value of CfnRuleGroupPropsMixin.RuleProperty.getAction()
CfnRuleGroupPropsMixin.RuleProperty.Builder	action(IResolvable action)	Sets the value of CfnRuleGroupPropsMixin.RuleProperty.getAction()
CfnRuleGroupPropsMixin.RuleProperty	build()	Builds the configured instance.
CfnRuleGroupPropsMixin.RuleProperty.Builder	captchaConfig(CfnRuleGroupPropsMixin.CaptchaConfigProperty captchaConfig)	Sets the value of CfnRuleGroupPropsMixin.RuleProperty.getCaptchaConfig()
CfnRuleGroupPropsMixin.RuleProperty.Builder	captchaConfig(IResolvable captchaConfig)	Sets the value of CfnRuleGroupPropsMixin.RuleProperty.getCaptchaConfig()
CfnRuleGroupPropsMixin.RuleProperty.Builder	challengeConfig(CfnRuleGroupPropsMixin.ChallengeConfigProperty challengeConfig)	Sets the value of CfnRuleGroupPropsMixin.RuleProperty.getChallengeConfig()
CfnRuleGroupPropsMixin.RuleProperty.Builder	challengeConfig(IResolvable challengeConfig)	Sets the value of CfnRuleGroupPropsMixin.RuleProperty.getChallengeConfig()
CfnRuleGroupPropsMixin.RuleProperty.Builder	name(String name)	Sets the value of CfnRuleGroupPropsMixin.RuleProperty.getName()
CfnRuleGroupPropsMixin.RuleProperty.Builder	priority(Number priority)	Sets the value of CfnRuleGroupPropsMixin.RuleProperty.getPriority()
CfnRuleGroupPropsMixin.RuleProperty.Builder	ruleLabels(List<? extends Object> ruleLabels)	Sets the value of CfnRuleGroupPropsMixin.RuleProperty.getRuleLabels()
CfnRuleGroupPropsMixin.RuleProperty.Builder	ruleLabels(IResolvable ruleLabels)	Sets the value of CfnRuleGroupPropsMixin.RuleProperty.getRuleLabels()
CfnRuleGroupPropsMixin.RuleProperty.Builder	statement(CfnRuleGroupPropsMixin.StatementProperty statement)	Sets the value of CfnRuleGroupPropsMixin.RuleProperty.getStatement()
CfnRuleGroupPropsMixin.RuleProperty.Builder	statement(IResolvable statement)	Sets the value of CfnRuleGroupPropsMixin.RuleProperty.getStatement()
CfnRuleGroupPropsMixin.RuleProperty.Builder	visibilityConfig(CfnRuleGroupPropsMixin.VisibilityConfigProperty visibilityConfig)	Sets the value of CfnRuleGroupPropsMixin.RuleProperty.getVisibilityConfig()
CfnRuleGroupPropsMixin.RuleProperty.Builder	visibilityConfig(IResolvable visibilityConfig)	Sets the value of CfnRuleGroupPropsMixin.RuleProperty.getVisibilityConfig()

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

action

@Stability(Stable)
public CfnRuleGroupPropsMixin.RuleProperty.Builder action(IResolvable action)

Sets the value of CfnRuleGroupPropsMixin.RuleProperty.getAction()

Parameters:

action - The action that AWS WAF should take on a web request when it matches the rule statement. Settings at the web ACL level can override the rule action setting.

Returns:

this

action

@Stability(Stable)
public CfnRuleGroupPropsMixin.RuleProperty.Builder action(CfnRuleGroupPropsMixin.RuleActionProperty action)

Sets the value of CfnRuleGroupPropsMixin.RuleProperty.getAction()

Parameters:

action - The action that AWS WAF should take on a web request when it matches the rule statement. Settings at the web ACL level can override the rule action setting.

Returns:

this

captchaConfig

@Stability(Stable)
public CfnRuleGroupPropsMixin.RuleProperty.Builder captchaConfig(IResolvable captchaConfig)

Sets the value of CfnRuleGroupPropsMixin.RuleProperty.getCaptchaConfig()

Parameters:

captchaConfig - Specifies how AWS WAF should handle CAPTCHA evaluations. If you don't specify this, AWS WAF uses the CAPTCHA configuration that's defined for the web ACL.

Returns:

this

captchaConfig

@Stability(Stable)
public CfnRuleGroupPropsMixin.RuleProperty.Builder captchaConfig(CfnRuleGroupPropsMixin.CaptchaConfigProperty captchaConfig)

Sets the value of CfnRuleGroupPropsMixin.RuleProperty.getCaptchaConfig()

Parameters:

captchaConfig - Specifies how AWS WAF should handle CAPTCHA evaluations. If you don't specify this, AWS WAF uses the CAPTCHA configuration that's defined for the web ACL.

Returns:

this

challengeConfig

@Stability(Stable)
public CfnRuleGroupPropsMixin.RuleProperty.Builder challengeConfig(IResolvable challengeConfig)

Sets the value of CfnRuleGroupPropsMixin.RuleProperty.getChallengeConfig()

Parameters:

challengeConfig - Specifies how AWS WAF should handle Challenge evaluations. If you don't specify this, AWS WAF uses the challenge configuration that's defined for the web ACL.

Returns:

this

challengeConfig

@Stability(Stable)
public CfnRuleGroupPropsMixin.RuleProperty.Builder challengeConfig(CfnRuleGroupPropsMixin.ChallengeConfigProperty challengeConfig)

Sets the value of CfnRuleGroupPropsMixin.RuleProperty.getChallengeConfig()

Parameters:

challengeConfig - Specifies how AWS WAF should handle Challenge evaluations. If you don't specify this, AWS WAF uses the challenge configuration that's defined for the web ACL.

Returns:

this

name

@Stability(Stable)
public CfnRuleGroupPropsMixin.RuleProperty.Builder name(String name)

Sets the value of CfnRuleGroupPropsMixin.RuleProperty.getName()

Parameters:

name - The name of the rule. If you change the name of a Rule after you create it and you want the rule's metric name to reflect the change, update the metric name in the rule's VisibilityConfig settings. AWS WAF doesn't automatically update the metric name when you update the rule name.

Returns:

this

priority

@Stability(Stable)
public CfnRuleGroupPropsMixin.RuleProperty.Builder priority(Number priority)

Sets the value of CfnRuleGroupPropsMixin.RuleProperty.getPriority()

Parameters:

priority - If you define more than one Rule in a WebACL , AWS WAF evaluates each request against the Rules in order based on the value of Priority . AWS WAF processes rules with lower priority first. The priorities don't need to be consecutive, but they must all be different.

Returns:

this

ruleLabels

@Stability(Stable)
public CfnRuleGroupPropsMixin.RuleProperty.Builder ruleLabels(IResolvable ruleLabels)

Sets the value of CfnRuleGroupPropsMixin.RuleProperty.getRuleLabels()

Parameters:

ruleLabels - Labels to apply to web requests that match the rule match statement. AWS WAF applies fully qualified labels to matching web requests. A fully qualified label is the concatenation of a label namespace and a rule label. The rule's rule group or web ACL defines the label namespace.

Any rule that isn't a rule group reference statement or managed rule group statement can add labels to matching web requests.

Rules that run after this rule in the web ACL can match against these labels using a LabelMatchStatement .

For each label, provide a case-sensitive string containing optional namespaces and a label name, according to the following guidelines:

• Separate each component of the label with a colon.
• Each namespace or name can have up to 128 characters.
• You can specify up to 5 namespaces in a label.
• Don't use the following reserved words in your label specification: aws , waf , managed , rulegroup , webacl , regexpatternset , or ipset .

For example, myLabelName or nameSpace1:nameSpace2:myLabelName .

Returns:

this

ruleLabels

@Stability(Stable)
public CfnRuleGroupPropsMixin.RuleProperty.Builder ruleLabels(List<? extends Object> ruleLabels)

Sets the value of CfnRuleGroupPropsMixin.RuleProperty.getRuleLabels()

Parameters:

ruleLabels - Labels to apply to web requests that match the rule match statement. AWS WAF applies fully qualified labels to matching web requests. A fully qualified label is the concatenation of a label namespace and a rule label. The rule's rule group or web ACL defines the label namespace.

Any rule that isn't a rule group reference statement or managed rule group statement can add labels to matching web requests.

Rules that run after this rule in the web ACL can match against these labels using a LabelMatchStatement .

For each label, provide a case-sensitive string containing optional namespaces and a label name, according to the following guidelines:

• Separate each component of the label with a colon.
• Each namespace or name can have up to 128 characters.
• You can specify up to 5 namespaces in a label.
• Don't use the following reserved words in your label specification: aws , waf , managed , rulegroup , webacl , regexpatternset , or ipset .

For example, myLabelName or nameSpace1:nameSpace2:myLabelName .

Returns:

this

statement

@Stability(Stable)
public CfnRuleGroupPropsMixin.RuleProperty.Builder statement(IResolvable statement)

Sets the value of CfnRuleGroupPropsMixin.RuleProperty.getStatement()

Parameters:

statement - The AWS WAF processing statement for the rule, for example ByteMatchStatement or SizeConstraintStatement .

Returns:

this

statement

@Stability(Stable)
public CfnRuleGroupPropsMixin.RuleProperty.Builder statement(CfnRuleGroupPropsMixin.StatementProperty statement)

Sets the value of CfnRuleGroupPropsMixin.RuleProperty.getStatement()

Parameters:

statement - The AWS WAF processing statement for the rule, for example ByteMatchStatement or SizeConstraintStatement .

Returns:

this

visibilityConfig

@Stability(Stable)
public CfnRuleGroupPropsMixin.RuleProperty.Builder visibilityConfig(IResolvable visibilityConfig)

Sets the value of CfnRuleGroupPropsMixin.RuleProperty.getVisibilityConfig()

Parameters:

visibilityConfig - Defines and enables Amazon CloudWatch metrics and web request sample collection. If you change the name of a Rule after you create it and you want the rule's metric name to reflect the change, update the metric name as well. AWS WAF doesn't automatically update the metric name.

Returns:

this

visibilityConfig

@Stability(Stable)
public CfnRuleGroupPropsMixin.RuleProperty.Builder visibilityConfig(CfnRuleGroupPropsMixin.VisibilityConfigProperty visibilityConfig)

Sets the value of CfnRuleGroupPropsMixin.RuleProperty.getVisibilityConfig()

Parameters:

visibilityConfig - Defines and enables Amazon CloudWatch metrics and web request sample collection. If you change the name of a Rule after you create it and you want the rule's metric name to reflect the change, update the metric name as well. AWS WAF doesn't automatically update the metric name.

Returns:

this

build

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

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnRuleGroupPropsMixin.RuleProperty

Throws:

NullPointerException - if any required attribute was not provided