@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
date="2023-01-31T18:36:50.682Z")
public interface CfnRateBasedRuleProps
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();
Modifier and Type | Interface and Description |
---|---|
static class |
CfnRateBasedRuleProps.Builder
A builder for
CfnRateBasedRuleProps |
static class |
CfnRateBasedRuleProps.Jsii$Proxy
An implementation for
CfnRateBasedRuleProps |
Modifier and Type | Method and Description |
---|---|
static CfnRateBasedRuleProps.Builder |
builder() |
default java.lang.Object |
getMatchPredicates()
The `Predicates` object contains one `Predicate` element for each `ByteMatchSet` , `IPSet` , or `SqlInjectionMatchSet>` object that you want to include in a `RateBasedRule` .
|
java.lang.String |
getMetricName()
A name for the metrics for a `RateBasedRule` .
|
java.lang.String |
getName()
A friendly name or description for a `RateBasedRule` .
|
java.lang.String |
getRateKey()
The field that AWS WAF uses to determine if requests are likely arriving from single source and thus subject to rate monitoring.
|
java.lang.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.
|
java.lang.String getMetricName()
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
.
java.lang.String getName()
You can't change the name of a RateBasedRule
after you create it.
java.lang.String getRateKey()
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
.
java.lang.Number getRateLimit()
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.
default java.lang.Object getMatchPredicates()
static CfnRateBasedRuleProps.Builder builder()
CfnRateBasedRuleProps.Builder
of CfnRateBasedRuleProps