Package software.amazon.awssdk.services.wafv2.model

Class ForwardedIPConfig

java.lang.Object
software.amazon.awssdk.services.wafv2.model.ForwardedIPConfig
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ForwardedIPConfig.Builder,ForwardedIPConfig>
@Generated("software.amazon.awssdk:codegen") public final class ForwardedIPConfig extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ForwardedIPConfig.Builder,ForwardedIPConfig>

The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.

If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

This configuration is used for GeoMatchStatement and RateBasedStatement. For IPSetReferenceStatement, use IPSetForwardedIPConfig instead.

WAF only evaluates the first IP address found in the specified HTTP header.

See Also:

  • Method Details

    • headerName

      public final String headerName()

      The name of the HTTP header to use for the IP address. For example, to use the X-Forwarded-For (XFF) header, set this to X-Forwarded-For.

      If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

      Returns:
      The name of the HTTP header to use for the IP address. For example, to use the X-Forwarded-For (XFF) header, set this to X-Forwarded-For.

      If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

    • fallbackBehavior

      public final FallbackBehavior fallbackBehavior()

      The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.

      If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

      You can specify the following fallback behaviors:

      • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

      • NO_MATCH - Treat the web request as not matching the rule statement.

      If the service returns an enum value that is not available in the current SDK version, fallbackBehavior will return FallbackBehavior.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from fallbackBehaviorAsString().

      Returns:
      The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.

      If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

      You can specify the following fallback behaviors:

      • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

      • NO_MATCH - Treat the web request as not matching the rule statement.

      See Also:

    • fallbackBehaviorAsString

      public final String fallbackBehaviorAsString()

      The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.

      If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

      You can specify the following fallback behaviors:

      • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

      • NO_MATCH - Treat the web request as not matching the rule statement.

      If the service returns an enum value that is not available in the current SDK version, fallbackBehavior will return FallbackBehavior.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from fallbackBehaviorAsString().

      Returns:
      The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.

      If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

      You can specify the following fallback behaviors:

      • MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

      • NO_MATCH - Treat the web request as not matching the rule statement.

      See Also:

    • toBuilder

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

    • builder

      public static ForwardedIPConfig.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ForwardedIPConfig.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.