software.amazon.awscdk.services.waf.regional

Class CfnRateBasedRule.Builder

java.lang.Object

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

Enclosing class:

CfnRateBasedRule

public static final class CfnRateBasedRule.Builder
extends java.lang.Object

A fluent builder for CfnRateBasedRule.

Method Summary

Modifier and Type	Method and Description
CfnRateBasedRule	build()
static CfnRateBasedRule.Builder	create(Construct scope, java.lang.String id)
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	matchPredicates(java.util.List<? extends java.lang.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	metricName(java.lang.String metricName) A name for the metrics for a `RateBasedRule` .
CfnRateBasedRule.Builder	name(java.lang.String name) A friendly name or description for a `RateBasedRule` .
CfnRateBasedRule.Builder	rateKey(java.lang.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(java.lang.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 Detail

create

public static CfnRateBasedRule.Builder create(Construct scope,
                                              java.lang.String id)

Parameters:

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

id - - scoped id of the resource. This parameter is required.

Returns:

a new instance of CfnRateBasedRule.PredicateProperty.Builder.

metricName

public CfnRateBasedRule.Builder metricName(java.lang.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

name

public CfnRateBasedRule.Builder name(java.lang.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

rateKey

public CfnRateBasedRule.Builder rateKey(java.lang.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

rateLimit

public CfnRateBasedRule.Builder rateLimit(java.lang.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

matchPredicates

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

matchPredicates

public CfnRateBasedRule.Builder matchPredicates(java.util.List<? extends java.lang.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

build

public CfnRateBasedRule build()