Package software.amazon.awssdk.services.elasticloadbalancing.model

Class Listener

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Listener.Builder

Method Summary

Modifier and Type	Method	Description
static Listener.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	instancePort()	The port on which the instance is listening.
String	instanceProtocol()	The protocol to use for routing traffic to instances: HTTP, HTTPS, TCP, or SSL.
Integer	loadBalancerPort()	The port on which the load balancer is listening.
String	protocol()	The load balancer transport protocol to use for routing: HTTP, HTTPS, TCP, or SSL.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends Listener.Builder>	serializableBuilderClass()
String	sslCertificateId()	The Amazon Resource Name (ARN) of the server certificate.
Listener.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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()

Specified by:

toBuilder in interface ToCopyableBuilder<Listener.Builder,Listener>

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)

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