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

Class IPSetReferenceStatement

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

A rule statement used to detect web requests coming from particular IP addresses or address ranges. To use this, create an IPSet that specifies the addresses you want to detect, then use the ARN of that set in this statement. To create an IP set, see CreateIPSet.

Each IP set rule statement references an IP set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, WAF automatically updates all rules that reference it.

See Also:

  • Method Details

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) of the IPSet that this statement references.

      Returns:
      The Amazon Resource Name (ARN) of the IPSet that this statement references.

    • ipSetForwardedIPConfig

      public final IPSetForwardedIPConfig 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.

      Returns:
      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.

    • toBuilder

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

    • builder

      public static IPSetReferenceStatement.Builder builder()

    • serializableBuilderClass

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