Class IPSetForwardedIPConfig

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

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 only for IPSetReferenceStatement. For GeoMatchStatement and RateBasedStatement, use ForwardedIPConfig instead.

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:

    • position

      public final ForwardedIPPosition position()

      The position in the header to search for the IP address. The header can contain IP addresses of the original client and also of proxies. For example, the header value could be 10.1.1.1, 127.0.0.0, 10.10.10.10 where the first IP address identifies the original client and the rest identify proxies that the request went through.

      The options for this setting are the following:

      • FIRST - Inspect the first IP address in the list of IP addresses in the header. This is usually the client's original IP.

      • LAST - Inspect the last IP address in the list of IP addresses in the header.

      • ANY - Inspect all IP addresses in the header for a match. If the header contains more than 10 IP addresses, WAF inspects the last 10.

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

      Returns:
      The position in the header to search for the IP address. The header can contain IP addresses of the original client and also of proxies. For example, the header value could be 10.1.1.1, 127.0.0.0, 10.10.10.10 where the first IP address identifies the original client and the rest identify proxies that the request went through.

      The options for this setting are the following:

      • FIRST - Inspect the first IP address in the list of IP addresses in the header. This is usually the client's original IP.

      • LAST - Inspect the last IP address in the list of IP addresses in the header.

      • ANY - Inspect all IP addresses in the header for a match. If the header contains more than 10 IP addresses, WAF inspects the last 10.

      See Also:

    • positionAsString

      public final String positionAsString()

      The position in the header to search for the IP address. The header can contain IP addresses of the original client and also of proxies. For example, the header value could be 10.1.1.1, 127.0.0.0, 10.10.10.10 where the first IP address identifies the original client and the rest identify proxies that the request went through.

      The options for this setting are the following:

      • FIRST - Inspect the first IP address in the list of IP addresses in the header. This is usually the client's original IP.

      • LAST - Inspect the last IP address in the list of IP addresses in the header.

      • ANY - Inspect all IP addresses in the header for a match. If the header contains more than 10 IP addresses, WAF inspects the last 10.

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

      Returns:
      The position in the header to search for the IP address. The header can contain IP addresses of the original client and also of proxies. For example, the header value could be 10.1.1.1, 127.0.0.0, 10.10.10.10 where the first IP address identifies the original client and the rest identify proxies that the request went through.

      The options for this setting are the following:

      • FIRST - Inspect the first IP address in the list of IP addresses in the header. This is usually the client's original IP.

      • LAST - Inspect the last IP address in the list of IP addresses in the header.

      • ANY - Inspect all IP addresses in the header for a match. If the header contains more than 10 IP addresses, WAF inspects the last 10.

      See Also:

    • toBuilder

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

    • builder

      public static IPSetForwardedIPConfig.Builder builder()

    • serializableBuilderClass

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