Interface AwsWafRegionalRateBasedRuleDetails.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<AwsWafRegionalRateBasedRuleDetails.Builder,
,AwsWafRegionalRateBasedRuleDetails> SdkBuilder<AwsWafRegionalRateBasedRuleDetails.Builder,
,AwsWafRegionalRateBasedRuleDetails> SdkPojo
- Enclosing class:
AwsWafRegionalRateBasedRuleDetails
-
Method Summary
Modifier and TypeMethodDescriptionmatchPredicates
(Collection<AwsWafRegionalRateBasedRuleMatchPredicate> matchPredicates) The predicates to include in the rate-based rule.matchPredicates
(Consumer<AwsWafRegionalRateBasedRuleMatchPredicate.Builder>... matchPredicates) The predicates to include in the rate-based rule.matchPredicates
(AwsWafRegionalRateBasedRuleMatchPredicate... matchPredicates) The predicates to include in the rate-based rule.metricName
(String metricName) The name of the metrics for the rate-based rule.The name of the rate-based rule.The field that WAF uses to determine whether requests are likely arriving from single source and are subject to rate monitoring.The maximum number of requests that have an identical value for the field specified inRateKey
that are allowed within a five-minute period.The unique identifier for the rate-based rule.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
metricName
The name of the metrics for the rate-based rule.
- Parameters:
metricName
- The name of the metrics for the rate-based rule.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
name
The name of the rate-based rule.
- Parameters:
name
- The name of the rate-based rule.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
rateKey
The field that WAF uses to determine whether requests are likely arriving from single source and are subject to rate monitoring.
- Parameters:
rateKey
- The field that WAF uses to determine whether requests are likely arriving from single source and are subject to rate monitoring.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
rateLimit
The maximum number of requests that have an identical value for the field specified in
RateKey
that are allowed within a five-minute period. If the number of requests exceedsRateLimit
and the other predicates specified in the rule are met, WAF triggers the action for the rule.- Parameters:
rateLimit
- The maximum number of requests that have an identical value for the field specified inRateKey
that are allowed within a five-minute period. If the number of requests exceedsRateLimit
and the other predicates specified in the rule are met, WAF triggers the action for the rule.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
ruleId
The unique identifier for the rate-based rule.
- Parameters:
ruleId
- The unique identifier for the rate-based rule.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
matchPredicates
AwsWafRegionalRateBasedRuleDetails.Builder matchPredicates(Collection<AwsWafRegionalRateBasedRuleMatchPredicate> matchPredicates) The predicates to include in the rate-based rule.
- Parameters:
matchPredicates
- The predicates to include in the rate-based rule.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
matchPredicates
AwsWafRegionalRateBasedRuleDetails.Builder matchPredicates(AwsWafRegionalRateBasedRuleMatchPredicate... matchPredicates) The predicates to include in the rate-based rule.
- Parameters:
matchPredicates
- The predicates to include in the rate-based rule.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
matchPredicates
AwsWafRegionalRateBasedRuleDetails.Builder matchPredicates(Consumer<AwsWafRegionalRateBasedRuleMatchPredicate.Builder>... matchPredicates) The predicates to include in the rate-based rule.
This is a convenience method that creates an instance of theAwsWafRegionalRateBasedRuleMatchPredicate.Builder
avoiding the need to create one manually viaAwsWafRegionalRateBasedRuleMatchPredicate.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tomatchPredicates(List<AwsWafRegionalRateBasedRuleMatchPredicate>)
.- Parameters:
matchPredicates
- a consumer that will call methods onAwsWafRegionalRateBasedRuleMatchPredicate.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-