Package software.amazon.awssdk.services.securityhub.model

Interface AwsWafRateBasedRuleDetails.Builder

All Superinterfaces:

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

Enclosing class:

AwsWafRateBasedRuleDetails

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

Method Summary

Modifier and Type	Method	Description
AwsWafRateBasedRuleDetails.Builder	matchPredicates(Collection<AwsWafRateBasedRuleMatchPredicate> matchPredicates)	The predicates to include in the rate-based rule.
AwsWafRateBasedRuleDetails.Builder	matchPredicates(Consumer<AwsWafRateBasedRuleMatchPredicate.Builder>... matchPredicates)	The predicates to include in the rate-based rule.
AwsWafRateBasedRuleDetails.Builder	matchPredicates(AwsWafRateBasedRuleMatchPredicate... matchPredicates)	The predicates to include in the rate-based rule.
AwsWafRateBasedRuleDetails.Builder	metricName(String metricName)	The name of the metrics for the rate-based rule.
AwsWafRateBasedRuleDetails.Builder	name(String name)	The name of the rate-based rule.
AwsWafRateBasedRuleDetails.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.
AwsWafRateBasedRuleDetails.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.
AwsWafRateBasedRuleDetails.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, sdkFieldNameToField, sdkFields

Method Detail

metricName

AwsWafRateBasedRuleDetails.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

AwsWafRateBasedRuleDetails.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

AwsWafRateBasedRuleDetails.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

AwsWafRateBasedRuleDetails.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

AwsWafRateBasedRuleDetails.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

AwsWafRateBasedRuleDetails.Builder matchPredicates(Collection<AwsWafRateBasedRuleMatchPredicate> 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

AwsWafRateBasedRuleDetails.Builder matchPredicates(AwsWafRateBasedRuleMatchPredicate... 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

AwsWafRateBasedRuleDetails.Builder matchPredicates(Consumer<AwsWafRateBasedRuleMatchPredicate.Builder>... matchPredicates)

The predicates to include in the rate-based rule.

This is a convenience method that creates an instance of the AwsWafRateBasedRuleMatchPredicate.Builder avoiding the need to create one manually via AwsWafRateBasedRuleMatchPredicate.builder().

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

Parameters:

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

Returns:

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

See Also:

#matchPredicates(java.util.Collection)