com.amazonaws.services.elasticloadbalancing.model

Class Listener

java.lang.Object

com.amazonaws.services.elasticloadbalancing.model.Listener

All Implemented Interfaces:

Serializable

public class Listener
extends Object
implements Serializable

The Listener data type.

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

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

Methods inherited from class java.lang.Object

clone, 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 - Specifies the load balancer transport protocol to use for routing - HTTP, HTTPS, TCP or SSL. This property cannot be modified for the life of the load balancer.

loadBalancerPort - Specifies the port on which the load balancer is listening - 25, 80, 443, 465, 587, or 1024-65535. This property cannot be modified for the life of the load balancer.

instancePort - Specifies the port on which the instance server is listening - 25, 80, 443, 465, 587, or 1024-65535. This property cannot be modified for the life of the load balancer.

Method Detail

getProtocol

public String getProtocol()

Specifies the load balancer transport protocol to use for routing - HTTP, HTTPS, TCP or SSL. This property cannot be modified for the life of the load balancer.

Returns:

Specifies the load balancer transport protocol to use for routing - HTTP, HTTPS, TCP or SSL. This property cannot be modified for the life of the load balancer.

setProtocol

public void setProtocol(String protocol)

Specifies the load balancer transport protocol to use for routing - HTTP, HTTPS, TCP or SSL. This property cannot be modified for the life of the load balancer.

Parameters:

protocol - Specifies the load balancer transport protocol to use for routing - HTTP, HTTPS, TCP or SSL. This property cannot be modified for the life of the load balancer.

withProtocol

public Listener withProtocol(String protocol)

Specifies the load balancer transport protocol to use for routing - HTTP, HTTPS, TCP or SSL. This property cannot be modified for the life of the load balancer.

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

Parameters:

protocol - Specifies the load balancer transport protocol to use for routing - HTTP, HTTPS, TCP or SSL. This property cannot be modified for the life of the load balancer.

Returns:

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

getLoadBalancerPort

public Integer getLoadBalancerPort()

Specifies the port on which the load balancer is listening - 25, 80, 443, 465, 587, or 1024-65535. This property cannot be modified for the life of the load balancer.

Returns:

Specifies the port on which the load balancer is listening - 25, 80, 443, 465, 587, or 1024-65535. This property cannot be modified for the life of the load balancer.

setLoadBalancerPort

public void setLoadBalancerPort(Integer loadBalancerPort)

Specifies the port on which the load balancer is listening - 25, 80, 443, 465, 587, or 1024-65535. This property cannot be modified for the life of the load balancer.

Parameters:

loadBalancerPort - Specifies the port on which the load balancer is listening - 25, 80, 443, 465, 587, or 1024-65535. This property cannot be modified for the life of the load balancer.

withLoadBalancerPort

public Listener withLoadBalancerPort(Integer loadBalancerPort)

Specifies the port on which the load balancer is listening - 25, 80, 443, 465, 587, or 1024-65535. This property cannot be modified for the life of the load balancer.

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

Parameters:

loadBalancerPort - Specifies the port on which the load balancer is listening - 25, 80, 443, 465, 587, or 1024-65535. This property cannot be modified for the life of the load balancer.

Returns:

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

getInstanceProtocol

public String getInstanceProtocol()

Specifies the protocol to use for routing traffic to back-end instances - HTTP, HTTPS, TCP, or SSL. This property cannot be modified for the life of the load balancer. If the front-end protocol is HTTP or HTTPS, InstanceProtocol has to be at the same protocol layer, i.e., HTTP or HTTPS. Likewise, if the front-end protocol is TCP or SSL, InstanceProtocol has to be TCP or SSL. If there is another listener with the same InstancePort whose InstanceProtocol is secure, i.e., HTTPS or SSL, the listener's InstanceProtocol has to be secure, i.e., HTTPS or SSL. If there is another listener with the same InstancePort whose InstanceProtocol is HTTP or TCP, the listener's InstanceProtocol must be either HTTP or TCP.

Returns:

Specifies the protocol to use for routing traffic to back-end instances - HTTP, HTTPS, TCP, or SSL. This property cannot be modified for the life of the load balancer. If the front-end protocol is HTTP or HTTPS, InstanceProtocol has to be at the same protocol layer, i.e., HTTP or HTTPS. Likewise, if the front-end protocol is TCP or SSL, InstanceProtocol has to be TCP or SSL. If there is another listener with the same InstancePort whose InstanceProtocol is secure, i.e., HTTPS or SSL, the listener's InstanceProtocol has to be secure, i.e., HTTPS or SSL. If there is another listener with the same InstancePort whose InstanceProtocol is HTTP or TCP, the listener's InstanceProtocol must be either HTTP or TCP.

setInstanceProtocol

public void setInstanceProtocol(String instanceProtocol)

Specifies the protocol to use for routing traffic to back-end instances - HTTP, HTTPS, TCP, or SSL. This property cannot be modified for the life of the load balancer. If the front-end protocol is HTTP or HTTPS, InstanceProtocol has to be at the same protocol layer, i.e., HTTP or HTTPS. Likewise, if the front-end protocol is TCP or SSL, InstanceProtocol has to be TCP or SSL. If there is another listener with the same InstancePort whose InstanceProtocol is secure, i.e., HTTPS or SSL, the listener's InstanceProtocol has to be secure, i.e., HTTPS or SSL. If there is another listener with the same InstancePort whose InstanceProtocol is HTTP or TCP, the listener's InstanceProtocol must be either HTTP or TCP.

Parameters:

instanceProtocol - Specifies the protocol to use for routing traffic to back-end instances - HTTP, HTTPS, TCP, or SSL. This property cannot be modified for the life of the load balancer. If the front-end protocol is HTTP or HTTPS, InstanceProtocol has to be at the same protocol layer, i.e., HTTP or HTTPS. Likewise, if the front-end protocol is TCP or SSL, InstanceProtocol has to be TCP or SSL. If there is another listener with the same InstancePort whose InstanceProtocol is secure, i.e., HTTPS or SSL, the listener's InstanceProtocol has to be secure, i.e., HTTPS or SSL. If there is another listener with the same InstancePort whose InstanceProtocol is HTTP or TCP, the listener's InstanceProtocol must be either HTTP or TCP.

withInstanceProtocol

public Listener withInstanceProtocol(String instanceProtocol)

Specifies the protocol to use for routing traffic to back-end instances - HTTP, HTTPS, TCP, or SSL. This property cannot be modified for the life of the load balancer. If the front-end protocol is HTTP or HTTPS, InstanceProtocol has to be at the same protocol layer, i.e., HTTP or HTTPS. Likewise, if the front-end protocol is TCP or SSL, InstanceProtocol has to be TCP or SSL. If there is another listener with the same InstancePort whose InstanceProtocol is secure, i.e., HTTPS or SSL, the listener's InstanceProtocol has to be secure, i.e., HTTPS or SSL. If there is another listener with the same InstancePort whose InstanceProtocol is HTTP or TCP, the listener's InstanceProtocol must be either HTTP or TCP.

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

Parameters:

instanceProtocol - Specifies the protocol to use for routing traffic to back-end instances - HTTP, HTTPS, TCP, or SSL. This property cannot be modified for the life of the load balancer. If the front-end protocol is HTTP or HTTPS, InstanceProtocol has to be at the same protocol layer, i.e., HTTP or HTTPS. Likewise, if the front-end protocol is TCP or SSL, InstanceProtocol has to be TCP or SSL. If there is another listener with the same InstancePort whose InstanceProtocol is secure, i.e., HTTPS or SSL, the listener's InstanceProtocol has to be secure, i.e., HTTPS or SSL. If there is another listener with the same InstancePort whose InstanceProtocol is HTTP or TCP, the listener's InstanceProtocol must be either HTTP or TCP.

Returns:

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

getInstancePort

public Integer getInstancePort()

Specifies the port on which the instance server is listening - 25, 80, 443, 465, 587, or 1024-65535. This property cannot be modified for the life of the load balancer.

Constraints:
Range: 1 - 65535

Returns:

Specifies the port on which the instance server is listening - 25, 80, 443, 465, 587, or 1024-65535. This property cannot be modified for the life of the load balancer.

setInstancePort

public void setInstancePort(Integer instancePort)

Specifies the port on which the instance server is listening - 25, 80, 443, 465, 587, or 1024-65535. This property cannot be modified for the life of the load balancer.

Constraints:
Range: 1 - 65535

Parameters:

instancePort - Specifies the port on which the instance server is listening - 25, 80, 443, 465, 587, or 1024-65535. This property cannot be modified for the life of the load balancer.

withInstancePort

public Listener withInstancePort(Integer instancePort)

Specifies the port on which the instance server is listening - 25, 80, 443, 465, 587, or 1024-65535. This property cannot be modified for the life of the load balancer.

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

Constraints:
Range: 1 - 65535

Parameters:

instancePort - Specifies the port on which the instance server is listening - 25, 80, 443, 465, 587, or 1024-65535. This property cannot be modified for the life of the load balancer.

Returns:

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

getSSLCertificateId

public String getSSLCertificateId()

The ARN string of the server certificate. To get the ARN of the server certificate, call the AWS Identity and Access Management UploadServerCertificate API.

Returns:

The ARN string of the server certificate. To get the ARN of the server certificate, call the AWS Identity and Access Management UploadServerCertificate API.

setSSLCertificateId

public void setSSLCertificateId(String sSLCertificateId)

The ARN string of the server certificate. To get the ARN of the server certificate, call the AWS Identity and Access Management UploadServerCertificate API.

Parameters:

sSLCertificateId - The ARN string of the server certificate. To get the ARN of the server certificate, call the AWS Identity and Access Management UploadServerCertificate API.

withSSLCertificateId

public Listener withSSLCertificateId(String sSLCertificateId)

The ARN string of the server certificate. To get the ARN of the server certificate, call the AWS Identity and Access Management UploadServerCertificate API.

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

Parameters:

sSLCertificateId - The ARN string of the server certificate. To get the ARN of the server certificate, call the AWS Identity and Access Management UploadServerCertificate API.

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