public static final class CfnRateBasedRule.Builder
extends java.lang.Object
CfnRateBasedRule
.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.
|
public static CfnRateBasedRule.Builder create(Construct scope, java.lang.String id)
scope
- - scope in which this resource is defined. This parameter is required.id
- - scoped id of the resource. This parameter is required.CfnRateBasedRule.PredicateProperty.Builder
.public CfnRateBasedRule.Builder metricName(java.lang.String metricName)
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
.
metricName
- A name for the metrics for a `RateBasedRule` . This parameter is required.this
public CfnRateBasedRule.Builder name(java.lang.String name)
You can't change the name of a RateBasedRule
after you create it.
name
- A friendly name or description for a `RateBasedRule` . This parameter is required.this
public CfnRateBasedRule.Builder rateKey(java.lang.String rateKey)
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
.
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.this
public CfnRateBasedRule.Builder rateLimit(java.lang.Number rateLimit)
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.
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.this
public CfnRateBasedRule.Builder matchPredicates(IResolvable matchPredicates)
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.this
public CfnRateBasedRule.Builder matchPredicates(java.util.List<? extends java.lang.Object> matchPredicates)
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.this
public CfnRateBasedRule build()