com.amazonaws.services.elasticloadbalancing.model

Class RegisterInstancesWithLoadBalancerRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.elasticloadbalancing.model.RegisterInstancesWithLoadBalancerRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class RegisterInstancesWithLoadBalancerRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the RegisterInstancesWithLoadBalancer operation.

Adds the specified instances to the specified load balancer.

The instance must be a running instance in the same network as the load balancer (EC2-Classic or the same VPC). If you have EC2-Classic instances and a load balancer in a VPC with ClassicLink enabled, you can link the EC2-Classic instances to that VPC and then register the linked EC2-Classic instances with the load balancer in the VPC.

Note that RegisterInstanceWithLoadBalancer completes when the request has been registered. Instance registration happens shortly afterwards. To check the state of the registered instances, use DescribeLoadBalancers or DescribeInstanceHealth.

After the instance is registered, it starts receiving traffic and requests from the load balancer. Any instance that is not in one of the Availability Zones registered for the load balancer is moved to the OutOfService state. If an Availability Zone is added to the load balancer later, any instances registered with the load balancer move to the InService state.

If you stop an instance registered with a load balancer and then start it, the IP addresses associated with the instance changes. Elastic Load Balancing cannot recognize the new IP address, which prevents it from routing traffic to the instances. We recommend that you use the following sequence: stop the instance, deregister the instance, start the instance, and then register the instance. To deregister instances from a load balancer, use DeregisterInstancesFromLoadBalancer.

For more information, see Deregister and Register EC2 Instances in the Elastic Load Balancing Developer Guide .

See Also:

AmazonElasticLoadBalancing.registerInstancesWithLoadBalancer(RegisterInstancesWithLoadBalancerRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
RegisterInstancesWithLoadBalancerRequest() Default constructor for a new RegisterInstancesWithLoadBalancerRequest object.
RegisterInstancesWithLoadBalancerRequest(String loadBalancerName, List<Instance> instances) Constructs a new RegisterInstancesWithLoadBalancerRequest object.

Method Summary

Methods

Modifier and Type	Method and Description
RegisterInstancesWithLoadBalancerRequest	clone()
boolean	equals(Object obj)
List<Instance>	getInstances() The IDs of the instances.
String	getLoadBalancerName() The name of the load balancer.
int	hashCode()
void	setInstances(Collection<Instance> instances) The IDs of the instances.
void	setLoadBalancerName(String loadBalancerName) The name of the load balancer.
String	toString() Returns a string representation of this object; useful for testing and debugging.
RegisterInstancesWithLoadBalancerRequest	withInstances(Collection<Instance> instances) The IDs of the instances.
RegisterInstancesWithLoadBalancerRequest	withInstances(Instance... instances) The IDs of the instances.
RegisterInstancesWithLoadBalancerRequest	withLoadBalancerName(String loadBalancerName) The name of the load balancer.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

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

Constructor Detail

RegisterInstancesWithLoadBalancerRequest

public RegisterInstancesWithLoadBalancerRequest()

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

RegisterInstancesWithLoadBalancerRequest

public RegisterInstancesWithLoadBalancerRequest(String loadBalancerName,
                                        List<Instance> instances)

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

Parameters:

loadBalancerName - The name of the load balancer.

instances - The IDs of the instances.

Method Detail

getLoadBalancerName

public String getLoadBalancerName()

The name of the load balancer.

Returns:

The name of the load balancer.

setLoadBalancerName

public void setLoadBalancerName(String loadBalancerName)

The name of the load balancer.

Parameters:

loadBalancerName - The name of the load balancer.

withLoadBalancerName

public RegisterInstancesWithLoadBalancerRequest withLoadBalancerName(String loadBalancerName)

The name of the load balancer.

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

Parameters:

loadBalancerName - The name of the load balancer.

Returns:

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

getInstances

public List<Instance> getInstances()

The IDs of the instances.

Returns:

The IDs of the instances.

setInstances

public void setInstances(Collection<Instance> instances)

The IDs of the instances.

Parameters:

instances - The IDs of the instances.

withInstances

public RegisterInstancesWithLoadBalancerRequest withInstances(Instance... instances)

The IDs of the instances.

NOTE: This method appends the values to the existing list (if any). Use setInstances(java.util.Collection) or withInstances(java.util.Collection) if you want to override the existing values.

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

Parameters:

instances - The IDs of the instances.

Returns:

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

withInstances

public RegisterInstancesWithLoadBalancerRequest withInstances(Collection<Instance> instances)

The IDs of the instances.

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

Parameters:

instances - The IDs of the instances.

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

Overrides:

clone in class AmazonWebServiceRequest