RateBasedRule (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.services.waf.model.RateBasedRule

All Implemented Interfaces:

StructuredPojo, ToCopyableBuilder<RateBasedRule.Builder,RateBasedRule>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class RateBasedRule
extends Object
implements StructuredPojo, ToCopyableBuilder<RateBasedRule.Builder,RateBasedRule>
```
A RateBasedRule is identical to a regular Rule, with one addition: a RateBasedRule counts the number of requests that arrive from a specified IP address every five minutes. For example, based on recent requests that you've seen from an attacker, you might create a RateBasedRule that includes the following conditions:
- The requests come from 192.0.2.44.
- They contain the value BadBot in the User-Agent header.
In the rule, you also define the rate limit as 15,000.

Requests that meet both of these conditions and exceed 15,000 requests every five minutes trigger the rule's action (block or count), which is defined in the web ACL.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface RateBasedRule.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`RateBasedRule.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static RateBasedRule.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`List<Predicate>`	`matchPredicates()` The `Predicates` object contains one `Predicate` element for each ByteMatchSet, IPSet, or SqlInjectionMatchSet object that you want to include in a `RateBasedRule`.
`String`	`metricName()` A friendly name or description for the metrics for a `RateBasedRule`.
`String`	`name()` A friendly name or description for a `RateBasedRule`.
`RateKey`	`rateKey()` The field that AWS WAF uses to determine if requests are likely arriving from single source and thus subject to rate monitoring.
`String`	`rateKeyAsString()` The field that AWS WAF uses to determine if requests are likely arriving from single source and thus subject to rate monitoring.
`Long`	`rateLimit()` The maximum number of requests, which have an identical value in the field specified by the `RateKey`, allowed in a five-minute period.
`String`	`ruleId()` A unique identifier for a `RateBasedRule`.
`static Class<? extends RateBasedRule.Builder>`	`serializableBuilderClass()`
`RateBasedRule.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - ruleId
```
public String ruleId()
```
    A unique identifier for a RateBasedRule. You use RuleId to get more information about a RateBasedRule (see GetRateBasedRule), update a RateBasedRule (see UpdateRateBasedRule), insert a RateBasedRule into a WebACL or delete one from a WebACL (see UpdateWebACL), or delete a RateBasedRule from AWS WAF (see DeleteRateBasedRule).
    
    Returns:
    
    A unique identifier for a RateBasedRule. You use RuleId to get more information about a RateBasedRule (see GetRateBasedRule), update a RateBasedRule (see UpdateRateBasedRule), insert a RateBasedRule into a WebACL or delete one from a WebACL (see UpdateWebACL), or delete a RateBasedRule from AWS WAF (see DeleteRateBasedRule).
  - name
```
public String name()
```
    A friendly name or description for a RateBasedRule. You can't change the name of a RateBasedRule after you create it.
    
    Returns:
    
    A friendly name or description for a RateBasedRule. You can't change the name of a RateBasedRule after you create it.
  - metricName
```
public String metricName()
```
    A friendly name or description for the metrics for a RateBasedRule. The name can contain only alphanumeric characters (A-Z, a-z, 0-9); the name can't contain whitespace. You can't change the name of the metric after you create the RateBasedRule.
    
    Returns:
    
    A friendly name or description for the metrics for a RateBasedRule. The name can contain only alphanumeric characters (A-Z, a-z, 0-9); the name can't contain whitespace. You can't change the name of the metric after you create the RateBasedRule.
  - matchPredicates
```
public List<Predicate> matchPredicates()
```
    The Predicates object contains one Predicate element for each ByteMatchSet, IPSet, or SqlInjectionMatchSet object that you want to include in a RateBasedRule.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    The Predicates object contains one Predicate element for each ByteMatchSet, IPSet, or SqlInjectionMatchSet object that you want to include in a RateBasedRule.
  - rateKey
```
public RateKey rateKey()
```
    The field that AWS WAF uses to determine if requests are likely arriving from single source and thus subject to rate monitoring. 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.
    
    If the service returns an enum value that is not available in the current SDK version, rateKey will return RateKey.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from rateKeyAsString().
    
    Returns:
    
    The field that AWS WAF uses to determine if requests are likely arriving from single source and thus subject to rate monitoring. 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.
    
    See Also:
    
    RateKey
  - rateKeyAsString
```
public String rateKeyAsString()
```
    The field that AWS WAF uses to determine if requests are likely arriving from single source and thus subject to rate monitoring. 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.
    
    If the service returns an enum value that is not available in the current SDK version, rateKey will return RateKey.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from rateKeyAsString().
    
    Returns:
    
    The field that AWS WAF uses to determine if requests are likely arriving from single source and thus subject to rate monitoring. 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.
    
    See Also:
    
    RateKey
  - rateLimit
```
public Long rateLimit()
```
    The maximum number of requests, which have an identical value in the field specified by the RateKey, allowed in a five-minute period. 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.
    
    Returns:
    
    The maximum number of requests, which have an identical value in the field specified by the RateKey, allowed in a five-minute period. 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.
  - toBuilder
```
public RateBasedRule.Builder toBuilder()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<RateBasedRule.Builder,RateBasedRule>
    
    Returns:
    
    a builder for type T
  - builder
```
public static RateBasedRule.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends RateBasedRule.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Class RateBasedRule

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

ruleId

name

metricName

matchPredicates

rateKey

rateKeyAsString

rateLimit

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

marshall