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

Interface CfnRateBasedRuleProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnRateBasedRuleProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)",
           date="2025-10-29T11:15:50.322Z")
@Stability(Stable)
public interface CfnRateBasedRuleProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnRateBasedRule.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.waf.regional.*;
 CfnRateBasedRuleProps cfnRateBasedRuleProps = CfnRateBasedRuleProps.builder()
         .metricName("metricName")
         .name("name")
         .rateKey("rateKey")
         .rateLimit(123)
         // the properties below are optional
         .matchPredicates(List.of(PredicateProperty.builder()
                 .dataId("dataId")
                 .negated(false)
                 .type("type")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnRateBasedRuleProps.Builder	A builder for CfnRateBasedRuleProps
static final class	CfnRateBasedRuleProps.Jsii$Proxy	An implementation for CfnRateBasedRuleProps

Method Summary

Modifier and Type	Method	Description
static CfnRateBasedRuleProps.Builder	builder()
default Object	getMatchPredicates()	The Predicates object contains one Predicate element for each ByteMatchSet , IPSet , or SqlInjectionMatchSet> object that you want to include in a RateBasedRule .
String	getMetricName()	A name for the metrics for a RateBasedRule .
String	getName()	A friendly name or description for a RateBasedRule .
String	getRateKey()	The field that AWS WAF uses to determine if requests are likely arriving from single source and thus subject to rate monitoring.
Number	getRateLimit()	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 interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getMetricName

@Stability(Stable)
@NotNull
String getMetricName()

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 .

See Also:

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

getName

@Stability(Stable)
@NotNull
String getName()

A friendly name or description for a RateBasedRule .

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

See Also:

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

getRateKey

@Stability(Stable)
@NotNull
String getRateKey()

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 .

See Also:

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

getRateLimit

@Stability(Stable)
@NotNull
Number getRateLimit()

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.

See Also:

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

getMatchPredicates

@Stability(Stable)
@Nullable
default Object getMatchPredicates()

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

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnRateBasedRule.PredicateProperty>

See Also:

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

builder

@Stability(Stable)
static CfnRateBasedRuleProps.Builder builder()

Returns:

a CfnRateBasedRuleProps.Builder of CfnRateBasedRuleProps