com.amazonaws.services.elasticloadbalancing.model
Class RegisterInstancesWithLoadBalancerRequest

java.lang.Object
  extended by com.amazonaws.AmazonWebServiceRequest
      extended by com.amazonaws.services.elasticloadbalancing.model.RegisterInstancesWithLoadBalancerRequest

public class RegisterInstancesWithLoadBalancerRequest
extends AmazonWebServiceRequest

Container for the parameters to the RegisterInstancesWithLoadBalancer operation.

Adds new instances to the LoadBalancer.

Once the instance is registered, it starts receiving traffic and requests from the LoadBalancer. Any instance that is not in any of the Availability Zones registered for the LoadBalancer will be moved to the OutOfService state. It will move to the InService state when the Availability Zone is added to the LoadBalancer.

NOTE: In order for this call to be successful, the client must have created the LoadBalancer. The client must provide the same account credentials as those that were used to create the LoadBalancer.

NOTE: Completion of this API does not guarantee that operation has completed. Rather, it means that the request has been registered and the changes will happen shortly.

See Also:
AmazonElasticLoadBalancing.registerInstancesWithLoadBalancer(RegisterInstancesWithLoadBalancerRequest)

Constructor Summary
RegisterInstancesWithLoadBalancerRequest()
          Default constructor for a new RegisterInstancesWithLoadBalancerRequest object.
RegisterInstancesWithLoadBalancerRequest(String loadBalancerName, List<Instance> instances)
          Constructs a new RegisterInstancesWithLoadBalancerRequest object.
 
Method Summary
 boolean equals(Object obj)
           
 List<Instance> getInstances()
          A list of instance IDs that should be registered with the LoadBalancer.
 String getLoadBalancerName()
          The name associated with the LoadBalancer.
 int hashCode()
           
 void setInstances(Collection<Instance> instances)
          A list of instance IDs that should be registered with the LoadBalancer.
 void setLoadBalancerName(String loadBalancerName)
          The name associated with the LoadBalancer.
 String toString()
          Returns a string representation of this object; useful for testing and debugging.
 RegisterInstancesWithLoadBalancerRequest withInstances(Collection<Instance> instances)
          A list of instance IDs that should be registered with the LoadBalancer.
 RegisterInstancesWithLoadBalancerRequest withInstances(Instance... instances)
          A list of instance IDs that should be registered with the LoadBalancer.
 RegisterInstancesWithLoadBalancerRequest withLoadBalancerName(String loadBalancerName)
          The name associated with the LoadBalancer.
 
Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyPrivateRequestParameters, getDelegationToken, getRequestClientOptions, getRequestCredentials, setDelegationToken, setRequestCredentials
 
Methods inherited from class java.lang.Object
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 associated with the LoadBalancer. The name must be unique within the client AWS account.
instances - A list of instance IDs that should be registered with the LoadBalancer. When the instance is stopped and then restarted, the IP addresses associated with your instance changes. Elastic Load Balancing cannot recognize the new IP address, which prevents it from routing traffic to your instances. We recommend that you de-register your Amazon EC2 instances from your load balancer after you stop your instance, and then register the load balancer with your instance after you've restarted. To de-register your instances from load balancer, use DeregisterInstancesFromLoadBalancer action.
Method Detail

getLoadBalancerName

public String getLoadBalancerName()
The name associated with the LoadBalancer. The name must be unique within the client AWS account.

Returns:
The name associated with the LoadBalancer. The name must be unique within the client AWS account.

setLoadBalancerName

public void setLoadBalancerName(String loadBalancerName)
The name associated with the LoadBalancer. The name must be unique within the client AWS account.

Parameters:
loadBalancerName - The name associated with the LoadBalancer. The name must be unique within the client AWS account.

withLoadBalancerName

public RegisterInstancesWithLoadBalancerRequest withLoadBalancerName(String loadBalancerName)
The name associated with the LoadBalancer. The name must be unique within the client AWS account.

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

Parameters:
loadBalancerName - The name associated with the LoadBalancer. The name must be unique within the client AWS account.
Returns:
A reference to this updated object so that method calls can be chained together.

getInstances

public List<Instance> getInstances()
A list of instance IDs that should be registered with the LoadBalancer. When the instance is stopped and then restarted, the IP addresses associated with your instance changes. Elastic Load Balancing cannot recognize the new IP address, which prevents it from routing traffic to your instances. We recommend that you de-register your Amazon EC2 instances from your load balancer after you stop your instance, and then register the load balancer with your instance after you've restarted. To de-register your instances from load balancer, use DeregisterInstancesFromLoadBalancer action.

Returns:
A list of instance IDs that should be registered with the LoadBalancer. When the instance is stopped and then restarted, the IP addresses associated with your instance changes. Elastic Load Balancing cannot recognize the new IP address, which prevents it from routing traffic to your instances. We recommend that you de-register your Amazon EC2 instances from your load balancer after you stop your instance, and then register the load balancer with your instance after you've restarted. To de-register your instances from load balancer, use DeregisterInstancesFromLoadBalancer action.

setInstances

public void setInstances(Collection<Instance> instances)
A list of instance IDs that should be registered with the LoadBalancer. When the instance is stopped and then restarted, the IP addresses associated with your instance changes. Elastic Load Balancing cannot recognize the new IP address, which prevents it from routing traffic to your instances. We recommend that you de-register your Amazon EC2 instances from your load balancer after you stop your instance, and then register the load balancer with your instance after you've restarted. To de-register your instances from load balancer, use DeregisterInstancesFromLoadBalancer action.

Parameters:
instances - A list of instance IDs that should be registered with the LoadBalancer. When the instance is stopped and then restarted, the IP addresses associated with your instance changes. Elastic Load Balancing cannot recognize the new IP address, which prevents it from routing traffic to your instances. We recommend that you de-register your Amazon EC2 instances from your load balancer after you stop your instance, and then register the load balancer with your instance after you've restarted. To de-register your instances from load balancer, use DeregisterInstancesFromLoadBalancer action.

withInstances

public RegisterInstancesWithLoadBalancerRequest withInstances(Instance... instances)
A list of instance IDs that should be registered with the LoadBalancer. When the instance is stopped and then restarted, the IP addresses associated with your instance changes. Elastic Load Balancing cannot recognize the new IP address, which prevents it from routing traffic to your instances. We recommend that you de-register your Amazon EC2 instances from your load balancer after you stop your instance, and then register the load balancer with your instance after you've restarted. To de-register your instances from load balancer, use DeregisterInstancesFromLoadBalancer action.

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

Parameters:
instances - A list of instance IDs that should be registered with the LoadBalancer. When the instance is stopped and then restarted, the IP addresses associated with your instance changes. Elastic Load Balancing cannot recognize the new IP address, which prevents it from routing traffic to your instances. We recommend that you de-register your Amazon EC2 instances from your load balancer after you stop your instance, and then register the load balancer with your instance after you've restarted. To de-register your instances from load balancer, use DeregisterInstancesFromLoadBalancer action.
Returns:
A reference to this updated object so that method calls can be chained together.

withInstances

public RegisterInstancesWithLoadBalancerRequest withInstances(Collection<Instance> instances)
A list of instance IDs that should be registered with the LoadBalancer. When the instance is stopped and then restarted, the IP addresses associated with your instance changes. Elastic Load Balancing cannot recognize the new IP address, which prevents it from routing traffic to your instances. We recommend that you de-register your Amazon EC2 instances from your load balancer after you stop your instance, and then register the load balancer with your instance after you've restarted. To de-register your instances from load balancer, use DeregisterInstancesFromLoadBalancer action.

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

Parameters:
instances - A list of instance IDs that should be registered with the LoadBalancer. When the instance is stopped and then restarted, the IP addresses associated with your instance changes. Elastic Load Balancing cannot recognize the new IP address, which prevents it from routing traffic to your instances. We recommend that you de-register your Amazon EC2 instances from your load balancer after you stop your instance, and then register the load balancer with your instance after you've restarted. To de-register your instances from load balancer, use DeregisterInstancesFromLoadBalancer action.
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


Copyright © 2010 Amazon Web Services, Inc. All Rights Reserved.