com.amazonaws.services.elasticloadbalancing.model

Class Listener

java.lang.Object

com.amazonaws.services.elasticloadbalancing.model.Listener

All Implemented Interfaces:

Serializable, Cloneable

public class Listener
extends Object
implements Serializable, Cloneable

Information about a listener.

For information about the protocols and the ports supported by Elastic Load Balancing, see Listener Configurations for Elastic Load Balancing in the Elastic Load Balancing Developer Guide .

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Listener() Default constructor for a new Listener object.
Listener(String protocol, Integer loadBalancerPort, Integer instancePort) Constructs a new Listener object.

Method Summary

Methods

Modifier and Type	Method and Description
Listener	clone()
boolean	equals(Object obj)
Integer	getInstancePort() The port on which the instance server is listening - 25, 80, 443, 465, 587, or 1024-65535.
String	getInstanceProtocol() The protocol to use for routing traffic to back-end instances: HTTP, HTTPS, TCP, or SSL.
Integer	getLoadBalancerPort() The port on which the load balancer is listening: 25, 80, 443, 465, 587, or 1024-65535.
String	getProtocol() The load balancer transport protocol to use for routing: HTTP, HTTPS, TCP, or SSL.
String	getSSLCertificateId() The Amazon Resource Name (ARN) of the server certificate.
int	hashCode()
void	setInstancePort(Integer instancePort) The port on which the instance server is listening - 25, 80, 443, 465, 587, or 1024-65535.
void	setInstanceProtocol(String instanceProtocol) The protocol to use for routing traffic to back-end instances: HTTP, HTTPS, TCP, or SSL.
void	setLoadBalancerPort(Integer loadBalancerPort) The port on which the load balancer is listening: 25, 80, 443, 465, 587, or 1024-65535.
void	setProtocol(String protocol) The load balancer transport protocol to use for routing: HTTP, HTTPS, TCP, or SSL.
void	setSSLCertificateId(String sSLCertificateId) The Amazon Resource Name (ARN) of the server certificate.
String	toString() Returns a string representation of this object; useful for testing and debugging.
Listener	withInstancePort(Integer instancePort) The port on which the instance server is listening - 25, 80, 443, 465, 587, or 1024-65535.
Listener	withInstanceProtocol(String instanceProtocol) The protocol to use for routing traffic to back-end instances: HTTP, HTTPS, TCP, or SSL.
Listener	withLoadBalancerPort(Integer loadBalancerPort) The port on which the load balancer is listening: 25, 80, 443, 465, 587, or 1024-65535.
Listener	withProtocol(String protocol) The load balancer transport protocol to use for routing: HTTP, HTTPS, TCP, or SSL.
Listener	withSSLCertificateId(String sSLCertificateId) The Amazon Resource Name (ARN) of the server certificate.

Methods inherited from class java.lang.Object

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

Constructor Detail

Listener

public Listener()

Default constructor for a new Listener object. Callers should use the setter or fluent setter (with...) methods to initialize this object after creating it.

Listener

public Listener(String protocol,
        Integer loadBalancerPort,
        Integer instancePort)

Constructs a new Listener object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

Parameters:

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

loadBalancerPort - The port on which the load balancer is listening: 25, 80, 443, 465, 587, or 1024-65535.

instancePort - The port on which the instance server is listening - 25, 80, 443, 465, 587, or 1024-65535.

Method Detail

getProtocol

public String getProtocol()

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.

setProtocol

public void setProtocol(String protocol)

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

Parameters:

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

withProtocol

public Listener withProtocol(String protocol)

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

Returns a reference to this object so that method calls can be chained together.

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

getLoadBalancerPort

public Integer getLoadBalancerPort()

The port on which the load balancer is listening: 25, 80, 443, 465, 587, or 1024-65535.

Returns:

The port on which the load balancer is listening: 25, 80, 443, 465, 587, or 1024-65535.

setLoadBalancerPort

public void setLoadBalancerPort(Integer loadBalancerPort)

The port on which the load balancer is listening: 25, 80, 443, 465, 587, or 1024-65535.

Parameters:

loadBalancerPort - The port on which the load balancer is listening: 25, 80, 443, 465, 587, or 1024-65535.

withLoadBalancerPort

public Listener withLoadBalancerPort(Integer loadBalancerPort)

The port on which the load balancer is listening: 25, 80, 443, 465, 587, or 1024-65535.

Returns a reference to this object so that method calls can be chained together.

Parameters:

loadBalancerPort - The port on which the load balancer is listening: 25, 80, 443, 465, 587, or 1024-65535.

Returns:

A reference to this updated object so that method calls can be chained together.

getInstanceProtocol

public String getInstanceProtocol()

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

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

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 back-end instances: HTTP, HTTPS, TCP, or SSL.

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

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.

setInstanceProtocol

public void setInstanceProtocol(String instanceProtocol)

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

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

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.

Parameters:

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

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

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.

withInstanceProtocol

public Listener withInstanceProtocol(String instanceProtocol)

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

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

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 a reference to this object so that method calls can be chained together.

Parameters:

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

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

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:

A reference to this updated object so that method calls can be chained together.

getInstancePort

public Integer getInstancePort()

The port on which the instance server is listening - 25, 80, 443, 465, 587, or 1024-65535.

Constraints:
Range: 1 - 65535

Returns:

The port on which the instance server is listening - 25, 80, 443, 465, 587, or 1024-65535.

setInstancePort

public void setInstancePort(Integer instancePort)

The port on which the instance server is listening - 25, 80, 443, 465, 587, or 1024-65535.

Constraints:
Range: 1 - 65535

Parameters:

instancePort - The port on which the instance server is listening - 25, 80, 443, 465, 587, or 1024-65535.

withInstancePort

public Listener withInstancePort(Integer instancePort)

The port on which the instance server is listening - 25, 80, 443, 465, 587, or 1024-65535.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Range: 1 - 65535

Parameters:

instancePort - The port on which the instance server is listening - 25, 80, 443, 465, 587, or 1024-65535.

Returns:

A reference to this updated object so that method calls can be chained together.

getSSLCertificateId

public String getSSLCertificateId()

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

Returns:

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

setSSLCertificateId

public void setSSLCertificateId(String sSLCertificateId)

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

Parameters:

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

withSSLCertificateId

public Listener withSSLCertificateId(String sSLCertificateId)

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

Returns a reference to this object so that method calls can be chained together.

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public Listener clone()

Overrides:

clone in class Object