Package software.amazon.awscdk.cfnpropertymixins.services.wafregional

Class CfnRateBasedRuleMixinProps.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.wafregional.CfnRateBasedRuleMixinProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnRateBasedRuleMixinProps>

Enclosing interface:

CfnRateBasedRuleMixinProps

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

A builder for CfnRateBasedRuleMixinProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnRateBasedRuleMixinProps	build()	Builds the configured instance.
CfnRateBasedRuleMixinProps.Builder	matchPredicates(List<? extends Object> matchPredicates)	Sets the value of CfnRateBasedRuleMixinProps.getMatchPredicates()
CfnRateBasedRuleMixinProps.Builder	matchPredicates(IResolvable matchPredicates)	Sets the value of CfnRateBasedRuleMixinProps.getMatchPredicates()
CfnRateBasedRuleMixinProps.Builder	metricName(String metricName)	Sets the value of CfnRateBasedRuleMixinProps.getMetricName()
CfnRateBasedRuleMixinProps.Builder	name(String name)	Sets the value of CfnRateBasedRuleMixinProps.getName()
CfnRateBasedRuleMixinProps.Builder	rateKey(String rateKey)	Sets the value of CfnRateBasedRuleMixinProps.getRateKey()
CfnRateBasedRuleMixinProps.Builder	rateLimit(Number rateLimit)	Sets the value of CfnRateBasedRuleMixinProps.getRateLimit()

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

matchPredicates

@Stability(Stable)
public CfnRateBasedRuleMixinProps.Builder matchPredicates(IResolvable matchPredicates)

Sets the value of CfnRateBasedRuleMixinProps.getMatchPredicates()

Parameters:

matchPredicates - The Predicates object contains one Predicate element for each ByteMatchSet , IPSet , or SqlInjectionMatchSet> object that you want to include in a RateBasedRule .

Returns:

this

matchPredicates

@Stability(Stable)
public CfnRateBasedRuleMixinProps.Builder matchPredicates(List<? extends Object> matchPredicates)

Sets the value of CfnRateBasedRuleMixinProps.getMatchPredicates()

Parameters:

matchPredicates - The Predicates object contains one Predicate element for each ByteMatchSet , IPSet , or SqlInjectionMatchSet> object that you want to include in a RateBasedRule .

Returns:

this

metricName

@Stability(Stable)
public CfnRateBasedRuleMixinProps.Builder metricName(String metricName)

Sets the value of CfnRateBasedRuleMixinProps.getMetricName()

Parameters:

metricName - A name for the metrics for a RateBasedRule . The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF , including "All" and "Default_Action." You can't change the name of the metric after you create the RateBasedRule .

Returns:

this

name

@Stability(Stable)
public CfnRateBasedRuleMixinProps.Builder name(String name)

Sets the value of CfnRateBasedRuleMixinProps.getName()

Parameters:

name - A friendly name or description for a RateBasedRule . You can't change the name of a RateBasedRule after you create it.

Returns:

this

rateKey

@Stability(Stable)
public CfnRateBasedRuleMixinProps.Builder rateKey(String rateKey)

Sets the value of CfnRateBasedRuleMixinProps.getRateKey()

Parameters:

rateKey - The field that AWS WAF uses to determine if requests are likely arriving from single source and thus subject to rate monitoring. The only valid value for RateKey is IP . IP indicates that requests arriving from the same IP address are subject to the RateLimit that is specified in the RateBasedRule .

Returns:

this

rateLimit

@Stability(Stable)
public CfnRateBasedRuleMixinProps.Builder rateLimit(Number rateLimit)

Sets the value of CfnRateBasedRuleMixinProps.getRateLimit()

Parameters:

rateLimit - The maximum number of requests, which have an identical value in the field specified by the RateKey , allowed in a five-minute period. If the number of requests exceeds the RateLimit and the other predicates specified in the rule are also met, AWS WAF triggers the action that is specified for this rule.

Returns:

this

build

@Stability(Stable)
public CfnRateBasedRuleMixinProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnRateBasedRuleMixinProps>

Returns:

a new instance of CfnRateBasedRuleMixinProps

Throws:

NullPointerException - if any required attribute was not provided