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

Class RateBasedStatementManagedKeysIPSet

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

The set of IP addresses that are currently blocked for a RateBasedStatement. This is only available for rate-based rules that aggregate on just the IP address, with the AggregateKeyType set to IP or FORWARDED_IP.

A rate-based rule applies its rule action to requests from IP addresses that are in the rule's managed keys list and that match the rule's scope-down statement. When a rule has no scope-down statement, it applies the action to all requests from the IP addresses that are in the list. The rule applies its rule action to rate limit the matching requests. The action is usually Block but it can be any valid rule action except for Allow.

The maximum number of IP addresses that can be rate limited by a single rate-based rule instance is 10,000. If more than 10,000 addresses exceed the rate limit, WAF limits those with the highest rates.

See Also:

  • Method Details

    • ipAddressVersion

      public final IPAddressVersion ipAddressVersion()

      The version of the IP addresses, either IPV4 or IPV6.

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

      Returns:
      The version of the IP addresses, either IPV4 or IPV6.
      See Also:

    • ipAddressVersionAsString

      public final String ipAddressVersionAsString()

      The version of the IP addresses, either IPV4 or IPV6.

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

      Returns:
      The version of the IP addresses, either IPV4 or IPV6.
      See Also:

    • hasAddresses

      public final boolean hasAddresses()
      For responses, this returns true if the service returned a value for the Addresses property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • addresses

      public final List<String> addresses()

      The IP addresses that are currently blocked.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAddresses() method.

      Returns:
      The IP addresses that are currently blocked.

    • toBuilder

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

    • builder

      public static RateBasedStatementManagedKeysIPSet.Builder builder()

    • serializableBuilderClass

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