Interface CfnRateBasedRuleProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnRateBasedRuleProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.102.0 (build e354887)",
date="2024-08-23T05:56:24.793Z")
@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:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnRateBasedRuleProps
static final class
An implementation forCfnRateBasedRuleProps
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
default Object
ThePredicates
object contains onePredicate
element for eachByteMatchSet
,IPSet
, orSqlInjectionMatchSet>
object that you want to include in aRateBasedRule
.A name for the metrics for aRateBasedRule
.getName()
A friendly name or description for aRateBasedRule
.The field that AWS WAF uses to determine if requests are likely arriving from single source and thus subject to rate monitoring.The maximum number of requests, which have an identical value in the field specified by theRateKey
, allowed in a five-minute period.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getMetricName
A name for the metrics for aRateBasedRule
.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:
-
getName
A friendly name or description for aRateBasedRule
.You can't change the name of a
RateBasedRule
after you create it.- See Also:
-
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
isIP
.IP
indicates that requests arriving from the same IP address are subject to theRateLimit
that is specified in theRateBasedRule
.- See Also:
-
getRateLimit
The maximum number of requests, which have an identical value in the field specified by theRateKey
, 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:
-
getMatchPredicates
ThePredicates
object contains onePredicate
element for eachByteMatchSet
,IPSet
, orSqlInjectionMatchSet>
object that you want to include in aRateBasedRule
.- See Also:
-
builder
- Returns:
- a
CfnRateBasedRuleProps.Builder
ofCfnRateBasedRuleProps
-