Interface AwsWafRegionalRateBasedRuleDetails.Builder

All Superinterfaces:

Buildable, CopyableBuilder<AwsWafRegionalRateBasedRuleDetails.Builder,AwsWafRegionalRateBasedRuleDetails>, SdkBuilder<AwsWafRegionalRateBasedRuleDetails.Builder,AwsWafRegionalRateBasedRuleDetails>, SdkPojo

Enclosing class:

AwsWafRegionalRateBasedRuleDetails

public static interface AwsWafRegionalRateBasedRuleDetails.Builder
extends SdkPojo, CopyableBuilder<AwsWafRegionalRateBasedRuleDetails.Builder,AwsWafRegionalRateBasedRuleDetails>

Method Summary

Modifier and Type	Method	Description
AwsWafRegionalRateBasedRuleDetails.Builder	matchPredicates(Collection<AwsWafRegionalRateBasedRuleMatchPredicate> matchPredicates)	The predicates to include in the rate-based rule.
AwsWafRegionalRateBasedRuleDetails.Builder	matchPredicates(Consumer<AwsWafRegionalRateBasedRuleMatchPredicate.Builder>... matchPredicates)	The predicates to include in the rate-based rule.
AwsWafRegionalRateBasedRuleDetails.Builder	matchPredicates(AwsWafRegionalRateBasedRuleMatchPredicate... matchPredicates)	The predicates to include in the rate-based rule.
AwsWafRegionalRateBasedRuleDetails.Builder	metricName(String metricName)	The name of the metrics for the rate-based rule.
AwsWafRegionalRateBasedRuleDetails.Builder	name(String name)	The name of the rate-based rule.
AwsWafRegionalRateBasedRuleDetails.Builder	rateKey(String rateKey)	The field that WAF uses to determine whether requests are likely arriving from single source and are subject to rate monitoring.
AwsWafRegionalRateBasedRuleDetails.Builder	rateLimit(Long 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.
AwsWafRegionalRateBasedRuleDetails.Builder	ruleId(String ruleId)	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

AwsWafRegionalRateBasedRuleDetails.Builder metricName(String 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

AwsWafRegionalRateBasedRuleDetails.Builder name(String 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

AwsWafRegionalRateBasedRuleDetails.Builder rateKey(String 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

AwsWafRegionalRateBasedRuleDetails.Builder rateLimit(Long 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 exceeds RateLimit 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 in RateKey that are allowed within a five-minute period. If the number of requests exceeds RateLimit 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

AwsWafRegionalRateBasedRuleDetails.Builder ruleId(String 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 the AwsWafRegionalRateBasedRuleMatchPredicate.Builder avoiding the need to create one manually via AwsWafRegionalRateBasedRuleMatchPredicate.builder() .

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to matchPredicates(List<AwsWafRegionalRateBasedRuleMatchPredicate>).

Parameters:

matchPredicates - a consumer that will call methods on AwsWafRegionalRateBasedRuleMatchPredicate.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• matchPredicates(java.util.Collection<AwsWafRegionalRateBasedRuleMatchPredicate>)