org.jclouds.elb.features

Interface LoadBalancerApi

public interface LoadBalancerApi

Provides access to Amazon ELB via the Query API

Author:

Adrian Cole

See Also:

doc, LoadBalancerAsyncApi

Method Summary

Methods

Modifier and Type	Method and Description
String	createListeningInAvailabilityZones(String name, Iterable<Listener> listeners, Iterable<String> availabilityZones)
String	createListeningInAvailabilityZones(String name, Listener listeners, Iterable<String> availabilityZones)
String	createListeningInSubnetAssignedToSecurityGroups(String name, String subnetId, Iterable<String> securityGroupIds)
String	createListeningInSubnetsAssignedToSecurityGroups(String name, Iterable<String> subnetIds, Iterable<String> securityGroupIds)
void	delete(String name) Deletes the specified LoadBalancer.
LoadBalancer	get(String name) Retrieves information about the specified loadBalancer.
PagedIterable<LoadBalancer>	list() Lists the loadBalancers all load balancers
IterableWithMarker<LoadBalancer>	list(ListLoadBalancersOptions options) Returns detailed configuration information for the specified LoadBalancers.

Method Detail

createListeningInAvailabilityZones

String createListeningInAvailabilityZones(String name,
                                        Iterable<Listener> listeners,
                                        Iterable<String> availabilityZones)

createListeningInAvailabilityZones

String createListeningInAvailabilityZones(String name,
                                        Listener listeners,
                                        Iterable<String> availabilityZones)

createListeningInSubnetAssignedToSecurityGroups

String createListeningInSubnetAssignedToSecurityGroups(String name,
                                                     String subnetId,
                                                     Iterable<String> securityGroupIds)

createListeningInSubnetsAssignedToSecurityGroups

String createListeningInSubnetsAssignedToSecurityGroups(String name,
                                                      Iterable<String> subnetIds,
                                                      Iterable<String> securityGroupIds)

get

@Nullable
LoadBalancer get(String name)

Retrieves information about the specified loadBalancer.

Parameters:

name - Name of the loadBalancer to get information about.

Returns:

null if not found

list

IterableWithMarker<LoadBalancer> list(ListLoadBalancersOptions options)

Returns detailed configuration information for the specified LoadBalancers. If there are none, the action returns an empty list.
You can paginate the results using the parameter

Parameters:

options - the options describing the loadBalancers query

Returns:

the response object

list

PagedIterable<LoadBalancer> list()

Lists the loadBalancers all load balancers

Returns:

the response object

delete

void delete(String name)

Deletes the specified LoadBalancer.

If attempting to recreate the LoadBalancer, the api must reconfigure all the settings. The DNS name associated with a deleted LoadBalancer will no longer be usable. Once deleted, the name and associated DNS record of the LoadBalancer no longer exist and traffic sent to any of its IP addresses will no longer be delivered to api instances. The api will not receive the same DNS name even if a new LoadBalancer with same LoadBalancerName is created.

To successfully call this API, the api must provide the same account credentials as were used to create the LoadBalancer.

Note

By design, if the LoadBalancer does not exist or has already been deleted, DeleteLoadBalancer still succeeds.

Parameters:

name - Name of the load balancer