java.lang.Object
software.amazon.awssdk.services.elasticloadbalancing.model.Listener
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Listener.Builder,Listener>

@Generated("software.amazon.awssdk:codegen") public final class Listener extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Listener.Builder,Listener>

Information about a listener.

For information about the protocols and the ports supported by Elastic Load Balancing, see Listeners for Your Classic Load Balancer in the Classic Load Balancers Guide.

See Also:
  • Method Details

    • protocol

      public final String protocol()

      The load balancer transport protocol to use for routing: HTTP, HTTPS, TCP, or SSL.

      Returns:
      The load balancer transport protocol to use for routing: HTTP, HTTPS, TCP, or SSL.
    • loadBalancerPort

      public final Integer loadBalancerPort()

      The port on which the load balancer is listening. On EC2-VPC, you can specify any port from the range 1-65535. On EC2-Classic, you can specify any port from the following list: 25, 80, 443, 465, 587, 1024-65535.

      Returns:
      The port on which the load balancer is listening. On EC2-VPC, you can specify any port from the range 1-65535. On EC2-Classic, you can specify any port from the following list: 25, 80, 443, 465, 587, 1024-65535.
    • instanceProtocol

      public final String instanceProtocol()

      The protocol to use for routing traffic to instances: HTTP, HTTPS, TCP, or SSL.

      If the front-end protocol is TCP or SSL, the back-end protocol must be TCP or SSL. If the front-end protocol is HTTP or HTTPS, the back-end protocol must be HTTP or HTTPS.

      If there is another listener with the same InstancePort whose InstanceProtocol is secure, (HTTPS or SSL), the listener's InstanceProtocol must also be secure.

      If there is another listener with the same InstancePort whose InstanceProtocol is HTTP or TCP, the listener's InstanceProtocol must be HTTP or TCP.

      Returns:
      The protocol to use for routing traffic to instances: HTTP, HTTPS, TCP, or SSL.

      If the front-end protocol is TCP or SSL, the back-end protocol must be TCP or SSL. If the front-end protocol is HTTP or HTTPS, the back-end protocol must be HTTP or HTTPS.

      If there is another listener with the same InstancePort whose InstanceProtocol is secure, (HTTPS or SSL), the listener's InstanceProtocol must also be secure.

      If there is another listener with the same InstancePort whose InstanceProtocol is HTTP or TCP, the listener's InstanceProtocol must be HTTP or TCP.

    • instancePort

      public final Integer instancePort()

      The port on which the instance is listening.

      Returns:
      The port on which the instance is listening.
    • sslCertificateId

      public final String sslCertificateId()

      The Amazon Resource Name (ARN) of the server certificate.

      Returns:
      The Amazon Resource Name (ARN) of the server certificate.
    • toBuilder

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

      public static Listener.Builder builder()
    • serializableBuilderClass

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