org.jclouds.elb.features

Interface AvailabilityZoneApi

public interface AvailabilityZoneApi

Provides access to Amazon ELB via the Query API

Author:

Adrian Cole

See Also:

, AvailabilityZoneAsyncApi

Method Summary

Methods

Modifier and Type	Method and Description
Set<String>	addAvailabilityZonesToLoadBalancer(Iterable<String> zones, String loadBalancerName) Adds one or more EC2 Availability Zones to the LoadBalancer.
Set<String>	addAvailabilityZoneToLoadBalancer(String zone, String loadBalancerName)
Set<String>	removeAvailabilityZoneFromLoadBalancer(String zone, String loadBalancerName)
Set<String>	removeAvailabilityZonesFromLoadBalancer(Iterable<String> zones, String loadBalancerName) Removes the specified EC2 Availability Zones from the set of configured Availability Zones for the LoadBalancer.

Method Detail

addAvailabilityZonesToLoadBalancer

Set<String> addAvailabilityZonesToLoadBalancer(Iterable<String> zones,
                                             String loadBalancerName)

Adds one or more EC2 Availability Zones to the LoadBalancer. The LoadBalancer evenly distributes requests across all its registered Availability Zones that contain instances. As a result, the api must ensure that its LoadBalancer is appropriately scaled for each registered Availability Zone.

Note

The new EC2 Availability Zones to be added must be in the same EC2 Region as the Availability Zones for which the LoadBalancer was created.

Parameters:

zones - A list of new Availability Zones for the LoadBalancer. Each Availability Zone must be in the same Region as the LoadBalancer.

loadBalancerName - The name associated with the LoadBalancer. The name must be unique within the api AWS account.

Returns:

An updated list of Availability Zones for the LoadBalancer.

addAvailabilityZoneToLoadBalancer

Set<String> addAvailabilityZoneToLoadBalancer(String zone,
                                            String loadBalancerName)

removeAvailabilityZonesFromLoadBalancer

Set<String> removeAvailabilityZonesFromLoadBalancer(Iterable<String> zones,
                                                  String loadBalancerName)

Removes the specified EC2 Availability Zones from the set of configured Availability Zones for the LoadBalancer. There must be at least one Availability Zone registered with a LoadBalancer at all times. A api cannot remove all the Availability Zones from a LoadBalancer. Once an Availability Zone is removed, all the instances registered with the LoadBalancer that are in the removed Availability Zone go into the OutOfService state. Upon Availability Zone removal, the LoadBalancer attempts to equally balance the traffic among its remaining usable Availability Zones. Trying to remove an Availability Zone that was not associated with the LoadBalancer does nothing.

Note

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

Parameters:

zones - A list of Availability Zones to be removed from the LoadBalancer.

Note

There must be at least one Availability Zone registered with a LoadBalancer at all times. The api cannot remove all the Availability Zones from a LoadBalancer. Specified Availability Zones must be in the same Region.

loadBalancerName - The name associated with the LoadBalancer. The name must be unique within the api AWS account.

Returns:

A list of updated Availability Zones for the LoadBalancer.

removeAvailabilityZoneFromLoadBalancer

Set<String> removeAvailabilityZoneFromLoadBalancer(String zone,
                                                 String loadBalancerName)