public static final class CfnRateBasedRuleProps.Builder
extends java.lang.Object
CfnRateBasedRuleProps
Constructor and Description |
---|
Builder() |
Modifier and Type | Method and Description |
---|---|
CfnRateBasedRuleProps |
build()
Builds the configured instance.
|
CfnRateBasedRuleProps.Builder |
matchPredicates(IResolvable matchPredicates)
Sets the value of
CfnRateBasedRuleProps.getMatchPredicates() |
CfnRateBasedRuleProps.Builder |
matchPredicates(java.util.List<? extends java.lang.Object> matchPredicates)
Sets the value of
CfnRateBasedRuleProps.getMatchPredicates() |
CfnRateBasedRuleProps.Builder |
metricName(java.lang.String metricName)
Sets the value of
CfnRateBasedRuleProps.getMetricName() |
CfnRateBasedRuleProps.Builder |
name(java.lang.String name)
Sets the value of
CfnRateBasedRuleProps.getName() |
CfnRateBasedRuleProps.Builder |
rateKey(java.lang.String rateKey)
Sets the value of
CfnRateBasedRuleProps.getRateKey() |
CfnRateBasedRuleProps.Builder |
rateLimit(java.lang.Number rateLimit)
Sets the value of
CfnRateBasedRuleProps.getRateLimit() |
public CfnRateBasedRuleProps.Builder metricName(java.lang.String metricName)
CfnRateBasedRuleProps.getMetricName()
metricName
- A name for the metrics for a `RateBasedRule` . This parameter is required.
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
.this
public CfnRateBasedRuleProps.Builder name(java.lang.String name)
CfnRateBasedRuleProps.getName()
name
- A friendly name or description for a `RateBasedRule` . This parameter is required.
You can't change the name of a RateBasedRule
after you create it.this
public CfnRateBasedRuleProps.Builder rateKey(java.lang.String rateKey)
CfnRateBasedRuleProps.getRateKey()
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.
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
.this
public CfnRateBasedRuleProps.Builder rateLimit(java.lang.Number rateLimit)
CfnRateBasedRuleProps.getRateLimit()
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.
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.this
public CfnRateBasedRuleProps.Builder matchPredicates(IResolvable matchPredicates)
CfnRateBasedRuleProps.getMatchPredicates()
matchPredicates
- The `Predicates` object contains one `Predicate` element for each `ByteMatchSet` , `IPSet` , or `SqlInjectionMatchSet>` object that you want to include in a `RateBasedRule` .this
public CfnRateBasedRuleProps.Builder matchPredicates(java.util.List<? extends java.lang.Object> matchPredicates)
CfnRateBasedRuleProps.getMatchPredicates()
matchPredicates
- The `Predicates` object contains one `Predicate` element for each `ByteMatchSet` , `IPSet` , or `SqlInjectionMatchSet>` object that you want to include in a `RateBasedRule` .this
public CfnRateBasedRuleProps build()
CfnRateBasedRuleProps
java.lang.NullPointerException
- if any required attribute was not provided