com.amazonaws.services.elasticloadbalancing.model

Class DeregisterInstancesFromLoadBalancerRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.elasticloadbalancing.model.DeregisterInstancesFromLoadBalancerRequest

All Implemented Interfaces:

Serializable

public class DeregisterInstancesFromLoadBalancerRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the DeregisterInstancesFromLoadBalancer operation.

Deregisters instances from the load balancer. Once the instance is deregistered, it will stop receiving traffic from the load balancer.

In order to successfully call this API, the same account credentials as those used to create the load balancer must be provided.

For more information, see De-register and Register Amazon EC2 Instances in the Elastic Load Balancing Developer Guide .

You can use DescribeLoadBalancers to verify if the instance is deregistered from the load balancer.

See Also:

AmazonElasticLoadBalancing.deregisterInstancesFromLoadBalancer(DeregisterInstancesFromLoadBalancerRequest), Serialized Form

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
List<Instance>	getInstances() A list of EC2 instance IDs consisting of all instances to be deregistered.
String	getLoadBalancerName() The name associated with the load balancer.
int	hashCode()
void	setInstances(Collection<Instance> instances) A list of EC2 instance IDs consisting of all instances to be deregistered.
void	setLoadBalancerName(String loadBalancerName) The name associated with the load balancer.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DeregisterInstancesFromLoadBalancerRequest	withInstances(Collection<Instance> instances) A list of EC2 instance IDs consisting of all instances to be deregistered.
DeregisterInstancesFromLoadBalancerRequest	withInstances(Instance... instances) A list of EC2 instance IDs consisting of all instances to be deregistered.
DeregisterInstancesFromLoadBalancerRequest	withLoadBalancerName(String loadBalancerName) The name associated with the load balancer.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setRequestCredentials, setRequestMetricCollector, withRequestMetricCollector

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DeregisterInstancesFromLoadBalancerRequest

public DeregisterInstancesFromLoadBalancerRequest()

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

DeregisterInstancesFromLoadBalancerRequest

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

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

Parameters:

loadBalancerName - The name associated with the load balancer.

instances - A list of EC2 instance IDs consisting of all instances to be deregistered.

Method Detail

getLoadBalancerName

public String getLoadBalancerName()

The name associated with the load balancer.

Returns:

The name associated with the load balancer.

setLoadBalancerName

public void setLoadBalancerName(String loadBalancerName)

The name associated with the load balancer.

Parameters:

loadBalancerName - The name associated with the load balancer.

withLoadBalancerName

public DeregisterInstancesFromLoadBalancerRequest withLoadBalancerName(String loadBalancerName)

The name associated with the load balancer.

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

Parameters:

loadBalancerName - The name associated with the load balancer.

Returns:

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

getInstances

public List<Instance> getInstances()

A list of EC2 instance IDs consisting of all instances to be deregistered.

Returns:

A list of EC2 instance IDs consisting of all instances to be deregistered.

setInstances

public void setInstances(Collection<Instance> instances)

A list of EC2 instance IDs consisting of all instances to be deregistered.

Parameters:

instances - A list of EC2 instance IDs consisting of all instances to be deregistered.

withInstances

public DeregisterInstancesFromLoadBalancerRequest withInstances(Instance... instances)

A list of EC2 instance IDs consisting of all instances to be deregistered.

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

Parameters:

instances - A list of EC2 instance IDs consisting of all instances to be deregistered.

Returns:

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

withInstances

public DeregisterInstancesFromLoadBalancerRequest withInstances(Collection<Instance> instances)

A list of EC2 instance IDs consisting of all instances to be deregistered.

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

Parameters:

instances - A list of EC2 instance IDs consisting of all instances to be deregistered.

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