RateLimitForwardedIP (AWS Java SDK :: Services :: WAFV2 2.30.3 API)

java.lang.Object
- software.amazon.awssdk.services.wafv2.model.RateLimitForwardedIP

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<RateLimitForwardedIP.Builder,RateLimitForwardedIP>
```
@Generated("software.amazon.awssdk:codegen")
public final class RateLimitForwardedIP
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<RateLimitForwardedIP.Builder,RateLimitForwardedIP>
```
Specifies the first IP address in an HTTP header as an aggregate key for a rate-based rule. Each distinct forwarded IP address contributes to the aggregation instance.

This setting is used only in the RateBasedStatementCustomKey specification of a rate-based rule statement. When you specify an IP or forwarded IP in the custom key settings, you must also specify at least one other key to use. You can aggregate on only the forwarded IP address by specifying FORWARDED_IP in your rate-based statement's AggregateKeyType.

This data type supports using the forwarded IP address in the web request aggregation for a rate-based rule, in RateBasedStatementCustomKey. The JSON specification for using the forwarded IP address doesn't explicitly use this data type.

JSON specification: "ForwardedIP": {}

When you use this specification, you must also configure the forwarded IP address in the rate-based statement's ForwardedIPConfig.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface RateLimitForwardedIP.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static RateLimitForwardedIP.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends RateLimitForwardedIP.Builder>`	`serializableBuilderClass()`
`RateLimitForwardedIP.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

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

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

Method Detail

toBuilder
```
public RateLimitForwardedIP.Builder toBuilder()
```
Specified by:

toBuilder in interface ToCopyableBuilder<RateLimitForwardedIP.Builder,RateLimitForwardedIP>

builder

public static RateLimitForwardedIP.Builder builder()

serializableBuilderClass

public static Class<? extends RateLimitForwardedIP.Builder> serializableBuilderClass()

hashCode
```
public final int hashCode()
```
Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:: equals in class Object

equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
Specified by:

equalsBySdkFields in interface SdkPojo

toString
```
public final String toString()
```
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields
```
public final List<SdkField<?>> sdkFields()
```
Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
Specified by:

sdkFieldNameToField in interface SdkPojo