Package software.amazon.awssdk.services.elasticloadbalancingv2.model

Class SourceIpConditionConfig

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

Information about a source IP condition.

You can use this condition to route based on the IP address of the source that connects to the load balancer. If a client is behind a proxy, this is the IP address of the proxy not the IP address of the client.

For Application Load Balancers, use Values to specify CIDR ranges. For Network Load Balancers, use IpAddressType to match on the IP address type of the source traffic.

See Also:

  • Method Details

    • hasValues

      public final boolean hasValues()
      For responses, this returns true if the service returned a value for the Values 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.

    • values

      public final List<String> values()

      The source IP addresses, in CIDR format. You can use both IPv4 and IPv6 addresses. Wildcards are not supported.

      If you specify multiple addresses, the condition is satisfied if the source IP address of the request matches one of the CIDR blocks. This condition is not satisfied by the addresses in the X-Forwarded-For header. To search for addresses in the X-Forwarded-For header, use an HTTP header condition.

      The total number of values must be less than, or equal to five.

      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 hasValues() method.

      Returns:
      The source IP addresses, in CIDR format. You can use both IPv4 and IPv6 addresses. Wildcards are not supported.

      If you specify multiple addresses, the condition is satisfied if the source IP address of the request matches one of the CIDR blocks. This condition is not satisfied by the addresses in the X-Forwarded-For header. To search for addresses in the X-Forwarded-For header, use an HTTP header condition.

      The total number of values must be less than, or equal to five.

    • ipAddressType

      public final SourceIpAddressTypeEnum ipAddressType()

      The IP address type for Network Load Balancers.

      The valid values are:

      • ipv4 – IPv4 addresses only.

      • ipv6 – IPv6 addresses only.

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

      Returns:
      The IP address type for Network Load Balancers.

      The valid values are:

      • ipv4 – IPv4 addresses only.

      • ipv6 – IPv6 addresses only.

      See Also:

    • ipAddressTypeAsString

      public final String ipAddressTypeAsString()

      The IP address type for Network Load Balancers.

      The valid values are:

      • ipv4 – IPv4 addresses only.

      • ipv6 – IPv6 addresses only.

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

      Returns:
      The IP address type for Network Load Balancers.

      The valid values are:

      • ipv4 – IPv4 addresses only.

      • ipv6 – IPv6 addresses only.

      See Also:

    • toBuilder

      public SourceIpConditionConfig.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<SourceIpConditionConfig.Builder,SourceIpConditionConfig>

    • builder

      public static SourceIpConditionConfig.Builder builder()

    • serializableBuilderClass

      public static Class<? extends SourceIpConditionConfig.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)
      Specified by:
      equalsBySdkFields in interface SdkPojo

    • 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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo