Class RateLimitForwardedIP

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:

  • Method Details

    • toBuilder

      public RateLimitForwardedIP.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<RateLimitForwardedIP.Builder,RateLimitForwardedIP>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.