Package software.amazon.awscdk.services.waf.regional

Class CfnRateBasedRule.Builder

java.lang.Object

software.amazon.awscdk.services.waf.regional.CfnRateBasedRule.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnRateBasedRule>

Enclosing class:

CfnRateBasedRule

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

A fluent builder for CfnRateBasedRule.

Method Summary

Modifier and Type	Method	Description
CfnRateBasedRule	build()
static CfnRateBasedRule.Builder	create(software.constructs.Construct scope, String id)
CfnRateBasedRule.Builder	matchPredicates(List<? extends Object> matchPredicates)	The Predicates object contains one Predicate element for each ByteMatchSet , IPSet , or SqlInjectionMatchSet> object that you want to include in a RateBasedRule .
CfnRateBasedRule.Builder	matchPredicates(IResolvable matchPredicates)	The Predicates object contains one Predicate element for each ByteMatchSet , IPSet , or SqlInjectionMatchSet> object that you want to include in a RateBasedRule .
CfnRateBasedRule.Builder	metricName(String metricName)	A name for the metrics for a RateBasedRule .
CfnRateBasedRule.Builder	name(String name)	A friendly name or description for a RateBasedRule .
CfnRateBasedRule.Builder	rateKey(String rateKey)	The field that AWS WAF uses to determine if requests are likely arriving from single source and thus subject to rate monitoring.
CfnRateBasedRule.Builder	rateLimit(Number rateLimit)	The maximum number of requests, which have an identical value in the field specified by the RateKey , allowed in a five-minute period.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static CfnRateBasedRule.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnRateBasedRule.Builder.

metricName

@Stability(Stable)
public CfnRateBasedRule.Builder metricName(String 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 .

Parameters:

metricName - A name for the metrics for a RateBasedRule . This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-ratebasedrule.html#cfn-wafregional-ratebasedrule-metricname

name

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

A friendly name or description for a RateBasedRule .

You can't change the name of a RateBasedRule after you create it.

Parameters:

name - A friendly name or description for a RateBasedRule . This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-ratebasedrule.html#cfn-wafregional-ratebasedrule-name

rateKey

@Stability(Stable)
public CfnRateBasedRule.Builder rateKey(String 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 .

Parameters:

rateKey - The field that AWS WAF uses to determine if requests are likely arriving from single source and thus subject to rate monitoring. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-ratebasedrule.html#cfn-wafregional-ratebasedrule-ratekey

rateLimit

@Stability(Stable)
public CfnRateBasedRule.Builder rateLimit(Number 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.

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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-ratebasedrule.html#cfn-wafregional-ratebasedrule-ratelimit

matchPredicates

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

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

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-ratebasedrule.html#cfn-wafregional-ratebasedrule-matchpredicates

matchPredicates

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

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

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-ratebasedrule.html#cfn-wafregional-ratebasedrule-matchpredicates

build

@Stability(Stable)
public CfnRateBasedRule build()

Specified by:

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

Returns:

a newly built instance of CfnRateBasedRule.