com.amazonaws.services.elasticloadbalancing
Interface AmazonElasticLoadBalancing

All Known Subinterfaces:

AmazonElasticLoadBalancingAsync

All Known Implementing Classes:

AmazonElasticLoadBalancingAsyncClient, AmazonElasticLoadBalancingClient

public interface AmazonElasticLoadBalancing

Interface for accessing AmazonElasticLoadBalancing. Elastic Load Balancing

Elastic Load Balancing is a cost-effective and easy to use web service to help you improve availability and scalability of your application. It makes it easy for you to distribute application loads between two or more EC2 instances. Elastic Load Balancing enables availability through redundancy and supports traffic growth of your application.

This guide provides detailed information about Elastic Load Balancing actions, data types, parameters, and errors.

Query requests are HTTP or HTTPS requests that use the HTTP verb GET or POST and a Query parameter named Action or Operation. Action is used throughout this documentation, although Operation is supported for backward compatibility with other AWS Query APIs.

This reference guide is based on the current WSDL, which is available at:

For detailed information on constructing a query request using the actions, data types, and parameters mentioned in this guide, go to Using the Query API in the Elastic Load Balancing Developer Guide .

For detailed information about Elastic Load Balancing features and their associated API calls, go to Using Elastic Load Balancing in the Elastic Load Balancing Developer Guide .

Method Summary

ApplySecurityGroupsToLoadBalancerResult	applySecurityGroupsToLoadBalancer(ApplySecurityGroupsToLoadBalancerRequest applySecurityGroupsToLoadBalancerRequest) Associates one or more security groups with your LoadBalancer in VPC.
AttachLoadBalancerToSubnetsResult	attachLoadBalancerToSubnets(AttachLoadBalancerToSubnetsRequest attachLoadBalancerToSubnetsRequest) Adds one or more subnets to the set of configured subnets in the VPC for the LoadBalancer.
ConfigureHealthCheckResult	configureHealthCheck(ConfigureHealthCheckRequest configureHealthCheckRequest) Enables the client to define an application healthcheck for the instances.
CreateAppCookieStickinessPolicyResult	createAppCookieStickinessPolicy(CreateAppCookieStickinessPolicyRequest createAppCookieStickinessPolicyRequest) Generates a stickiness policy with sticky session lifetimes that follow that of an application-generated cookie.
CreateLBCookieStickinessPolicyResult	createLBCookieStickinessPolicy(CreateLBCookieStickinessPolicyRequest createLBCookieStickinessPolicyRequest) Generates a stickiness policy with sticky session lifetimes controlled by the lifetime of the browser (user-agent) or a specified expiration period.
CreateLoadBalancerResult	createLoadBalancer(CreateLoadBalancerRequest createLoadBalancerRequest) Creates a new LoadBalancer.
void	createLoadBalancerListeners(CreateLoadBalancerListenersRequest createLoadBalancerListenersRequest) Creates one or more listeners on a LoadBalancer for the specified port.
CreateLoadBalancerPolicyResult	createLoadBalancerPolicy(CreateLoadBalancerPolicyRequest createLoadBalancerPolicyRequest) Creates a new policy that contains the necessary attributes depending on the policy type.
void	deleteLoadBalancer(DeleteLoadBalancerRequest deleteLoadBalancerRequest) Deletes the specified LoadBalancer.
void	deleteLoadBalancerListeners(DeleteLoadBalancerListenersRequest deleteLoadBalancerListenersRequest) Deletes listeners from the LoadBalancer for the specified port.
DeleteLoadBalancerPolicyResult	deleteLoadBalancerPolicy(DeleteLoadBalancerPolicyRequest deleteLoadBalancerPolicyRequest) Deletes a policy from the LoadBalancer.
DeregisterInstancesFromLoadBalancerResult	deregisterInstancesFromLoadBalancer(DeregisterInstancesFromLoadBalancerRequest deregisterInstancesFromLoadBalancerRequest) Deregisters instances from the LoadBalancer.
DescribeInstanceHealthResult	describeInstanceHealth(DescribeInstanceHealthRequest describeInstanceHealthRequest) Returns the current state of the instances of the specified LoadBalancer.
DescribeLoadBalancerPoliciesResult	describeLoadBalancerPolicies() Returns detailed descriptions of the policies.
DescribeLoadBalancerPoliciesResult	describeLoadBalancerPolicies(DescribeLoadBalancerPoliciesRequest describeLoadBalancerPoliciesRequest) Returns detailed descriptions of the policies.
DescribeLoadBalancerPolicyTypesResult	describeLoadBalancerPolicyTypes() Returns meta-information on the specified LoadBalancer policies defined by the Elastic Load Balancing service.
DescribeLoadBalancerPolicyTypesResult	describeLoadBalancerPolicyTypes(DescribeLoadBalancerPolicyTypesRequest describeLoadBalancerPolicyTypesRequest) Returns meta-information on the specified LoadBalancer policies defined by the Elastic Load Balancing service.
DescribeLoadBalancersResult	describeLoadBalancers() Returns detailed configuration information for the specified LoadBalancers.
DescribeLoadBalancersResult	describeLoadBalancers(DescribeLoadBalancersRequest describeLoadBalancersRequest) Returns detailed configuration information for the specified LoadBalancers.
DetachLoadBalancerFromSubnetsResult	detachLoadBalancerFromSubnets(DetachLoadBalancerFromSubnetsRequest detachLoadBalancerFromSubnetsRequest) Removes subnets from the set of configured subnets in the VPC for the LoadBalancer.
DisableAvailabilityZonesForLoadBalancerResult	disableAvailabilityZonesForLoadBalancer(DisableAvailabilityZonesForLoadBalancerRequest disableAvailabilityZonesForLoadBalancerRequest) Removes the specified EC2 Availability Zones from the set of configured Availability Zones for the LoadBalancer.
EnableAvailabilityZonesForLoadBalancerResult	enableAvailabilityZonesForLoadBalancer(EnableAvailabilityZonesForLoadBalancerRequest enableAvailabilityZonesForLoadBalancerRequest) Adds one or more EC2 Availability Zones to the LoadBalancer.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
RegisterInstancesWithLoadBalancerResult	registerInstancesWithLoadBalancer(RegisterInstancesWithLoadBalancerRequest registerInstancesWithLoadBalancerRequest) Adds new instances to the LoadBalancer.
void	setEndpoint(String endpoint) Overrides the default endpoint for this client ("https://elasticloadbalancing.amazonaws.com").
void	setLoadBalancerListenerSSLCertificate(SetLoadBalancerListenerSSLCertificateRequest setLoadBalancerListenerSSLCertificateRequest) Sets the certificate that terminates the specified listener's SSL connections.
SetLoadBalancerPoliciesForBackendServerResult	setLoadBalancerPoliciesForBackendServer(SetLoadBalancerPoliciesForBackendServerRequest setLoadBalancerPoliciesForBackendServerRequest) Replaces the current set of policies associated with a port on which the back-end server is listening with a new set of policies.
SetLoadBalancerPoliciesOfListenerResult	setLoadBalancerPoliciesOfListener(SetLoadBalancerPoliciesOfListenerRequest setLoadBalancerPoliciesOfListenerRequest) Associates, updates, or disables a policy with a listener on the LoadBalancer.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.

Method Detail

setEndpoint

void setEndpoint(String endpoint)
                 throws IllegalArgumentException

Overrides the default endpoint for this client ("https://elasticloadbalancing.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.

Callers can pass in just the endpoint (ex: "elasticloadbalancing.amazonaws.com") or a full URL, including the protocol (ex: "https://elasticloadbalancing.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.

For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912

Parameters:

endpoint - The endpoint (ex: "elasticloadbalancing.amazonaws.com") or a full URL, including the protocol (ex: "https://elasticloadbalancing.amazonaws.com") of the region specific AWS endpoint this client will communicate with.

Throws:

IllegalArgumentException - If any problems are detected with the specified endpoint.

describeLoadBalancerPolicyTypes

DescribeLoadBalancerPolicyTypesResult describeLoadBalancerPolicyTypes(DescribeLoadBalancerPolicyTypesRequest describeLoadBalancerPolicyTypesRequest)
                                                                      throws AmazonServiceException,
                                                                             AmazonClientException

Returns meta-information on the specified LoadBalancer policies defined by the Elastic Load Balancing service. The policy types that are returned from this action can be used in a CreateLoadBalancerPolicy action to instantiate specific policy configurations that will be applied to an Elastic LoadBalancer.

Parameters:

describeLoadBalancerPolicyTypesRequest - Container for the necessary parameters to execute the DescribeLoadBalancerPolicyTypes service method on AmazonElasticLoadBalancing.

Returns:

The response from the DescribeLoadBalancerPolicyTypes service method, as returned by AmazonElasticLoadBalancing.

Throws:

PolicyTypeNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonElasticLoadBalancing indicating either a problem with the data in the request, or a server side issue.

configureHealthCheck

ConfigureHealthCheckResult configureHealthCheck(ConfigureHealthCheckRequest configureHealthCheckRequest)
                                                throws AmazonServiceException,
                                                       AmazonClientException

Enables the client to define an application healthcheck for the instances.

Parameters:

configureHealthCheckRequest - Container for the necessary parameters to execute the ConfigureHealthCheck service method on AmazonElasticLoadBalancing.

Returns:

The response from the ConfigureHealthCheck service method, as returned by AmazonElasticLoadBalancing.

Throws:

LoadBalancerNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonElasticLoadBalancing indicating either a problem with the data in the request, or a server side issue.

detachLoadBalancerFromSubnets

DetachLoadBalancerFromSubnetsResult detachLoadBalancerFromSubnets(DetachLoadBalancerFromSubnetsRequest detachLoadBalancerFromSubnetsRequest)
                                                                  throws AmazonServiceException,
                                                                         AmazonClientException

Removes subnets from the set of configured subnets in the VPC for the LoadBalancer.

After a subnet is removed all of the EndPoints registered with the LoadBalancer that are in the removed subnet will go into the OutOfService state. When a subnet is removed, the LoadBalancer will balance the traffic among the remaining routable subnets for the LoadBalancer.

Parameters:

detachLoadBalancerFromSubnetsRequest - Container for the necessary parameters to execute the DetachLoadBalancerFromSubnets service method on AmazonElasticLoadBalancing.

Returns:

The response from the DetachLoadBalancerFromSubnets service method, as returned by AmazonElasticLoadBalancing.

Throws:

InvalidConfigurationRequestException

LoadBalancerNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonElasticLoadBalancing indicating either a problem with the data in the request, or a server side issue.

describeLoadBalancerPolicies

DescribeLoadBalancerPoliciesResult describeLoadBalancerPolicies(DescribeLoadBalancerPoliciesRequest describeLoadBalancerPoliciesRequest)
                                                                throws AmazonServiceException,
                                                                       AmazonClientException

Returns detailed descriptions of the policies. If you specify a LoadBalancer name, the operation returns either the descriptions of the specified policies, or descriptions of all the policies created for the LoadBalancer. If you don't specify a LoadBalancer name, the operation returns descriptions of the specified sample policies, or descriptions of all the sample policies. The names of the sample policies have the ELBSample- prefix.

Parameters:

describeLoadBalancerPoliciesRequest - Container for the necessary parameters to execute the DescribeLoadBalancerPolicies service method on AmazonElasticLoadBalancing.

Returns:

The response from the DescribeLoadBalancerPolicies service method, as returned by AmazonElasticLoadBalancing.

Throws:

PolicyNotFoundException

LoadBalancerNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonElasticLoadBalancing indicating either a problem with the data in the request, or a server side issue.

setLoadBalancerPoliciesOfListener

SetLoadBalancerPoliciesOfListenerResult setLoadBalancerPoliciesOfListener(SetLoadBalancerPoliciesOfListenerRequest setLoadBalancerPoliciesOfListenerRequest)
                                                                          throws AmazonServiceException,
                                                                                 AmazonClientException

Associates, updates, or disables a policy with a listener on the LoadBalancer. You can associate multiple policies with a listener.

Parameters:

setLoadBalancerPoliciesOfListenerRequest - Container for the necessary parameters to execute the SetLoadBalancerPoliciesOfListener service method on AmazonElasticLoadBalancing.

Returns:

The response from the SetLoadBalancerPoliciesOfListener service method, as returned by AmazonElasticLoadBalancing.

Throws:

PolicyNotFoundException

InvalidConfigurationRequestException

LoadBalancerNotFoundException

ListenerNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonElasticLoadBalancing indicating either a problem with the data in the request, or a server side issue.

disableAvailabilityZonesForLoadBalancer

DisableAvailabilityZonesForLoadBalancerResult disableAvailabilityZonesForLoadBalancer(DisableAvailabilityZonesForLoadBalancerRequest disableAvailabilityZonesForLoadBalancerRequest)
                                                                                      throws AmazonServiceException,
                                                                                             AmazonClientException

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 client 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 client must have created the LoadBalancer. The client must provide the same account credentials as those that were used to create the LoadBalancer.

Parameters:

disableAvailabilityZonesForLoadBalancerRequest - Container for the necessary parameters to execute the DisableAvailabilityZonesForLoadBalancer service method on AmazonElasticLoadBalancing.

Returns:

The response from the DisableAvailabilityZonesForLoadBalancer service method, as returned by AmazonElasticLoadBalancing.

Throws:

InvalidConfigurationRequestException

LoadBalancerNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonElasticLoadBalancing indicating either a problem with the data in the request, or a server side issue.

describeInstanceHealth

DescribeInstanceHealthResult describeInstanceHealth(DescribeInstanceHealthRequest describeInstanceHealthRequest)
                                                    throws AmazonServiceException,
                                                           AmazonClientException

Returns the current state of the instances of the specified LoadBalancer. If no instances are specified, the state of all the instances for the LoadBalancer is returned.

NOTE: The client must have created the specified input LoadBalancer in order to retrieve this information; the client must provide the same account credentials as those that were used to create the LoadBalancer.

Parameters:

describeInstanceHealthRequest - Container for the necessary parameters to execute the DescribeInstanceHealth service method on AmazonElasticLoadBalancing.

Returns:

The response from the DescribeInstanceHealth service method, as returned by AmazonElasticLoadBalancing.

Throws:

LoadBalancerNotFoundException

InvalidInstanceException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonElasticLoadBalancing indicating either a problem with the data in the request, or a server side issue.

deleteLoadBalancerPolicy

DeleteLoadBalancerPolicyResult deleteLoadBalancerPolicy(DeleteLoadBalancerPolicyRequest deleteLoadBalancerPolicyRequest)
                                                        throws AmazonServiceException,
                                                               AmazonClientException

Deletes a policy from the LoadBalancer. The specified policy must not be enabled for any listeners.

Parameters:

deleteLoadBalancerPolicyRequest - Container for the necessary parameters to execute the DeleteLoadBalancerPolicy service method on AmazonElasticLoadBalancing.

Returns:

The response from the DeleteLoadBalancerPolicy service method, as returned by AmazonElasticLoadBalancing.

Throws:

InvalidConfigurationRequestException

LoadBalancerNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonElasticLoadBalancing indicating either a problem with the data in the request, or a server side issue.

createLoadBalancerPolicy

CreateLoadBalancerPolicyResult createLoadBalancerPolicy(CreateLoadBalancerPolicyRequest createLoadBalancerPolicyRequest)
                                                        throws AmazonServiceException,
                                                               AmazonClientException

Creates a new policy that contains the necessary attributes depending on the policy type. Policies are settings that are saved for your Elastic LoadBalancer and that can be applied to the front-end listener, or the back-end application server, depending on your policy type.

Parameters:

createLoadBalancerPolicyRequest - Container for the necessary parameters to execute the CreateLoadBalancerPolicy service method on AmazonElasticLoadBalancing.

Returns:

The response from the CreateLoadBalancerPolicy service method, as returned by AmazonElasticLoadBalancing.

Throws:

PolicyTypeNotFoundException

InvalidConfigurationRequestException

DuplicatePolicyNameException

TooManyPoliciesException

LoadBalancerNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonElasticLoadBalancing indicating either a problem with the data in the request, or a server side issue.

enableAvailabilityZonesForLoadBalancer

EnableAvailabilityZonesForLoadBalancerResult enableAvailabilityZonesForLoadBalancer(EnableAvailabilityZonesForLoadBalancerRequest enableAvailabilityZonesForLoadBalancerRequest)
                                                                                    throws AmazonServiceException,
                                                                                           AmazonClientException

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 client 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:

enableAvailabilityZonesForLoadBalancerRequest - Container for the necessary parameters to execute the EnableAvailabilityZonesForLoadBalancer service method on AmazonElasticLoadBalancing.

Returns:

The response from the EnableAvailabilityZonesForLoadBalancer service method, as returned by AmazonElasticLoadBalancing.

Throws:

LoadBalancerNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonElasticLoadBalancing indicating either a problem with the data in the request, or a server side issue.

createLoadBalancerListeners

void createLoadBalancerListeners(CreateLoadBalancerListenersRequest createLoadBalancerListenersRequest)
                                 throws AmazonServiceException,
                                        AmazonClientException

Creates one or more listeners on a LoadBalancer for the specified port. If a listener with the given port does not already exist, it will be created; otherwise, the properties of the new listener must match the properties of the existing listener.

Parameters:

createLoadBalancerListenersRequest - Container for the necessary parameters to execute the CreateLoadBalancerListeners service method on AmazonElasticLoadBalancing.

Throws:

InvalidConfigurationRequestException

DuplicateListenerException

CertificateNotFoundException

LoadBalancerNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonElasticLoadBalancing indicating either a problem with the data in the request, or a server side issue.

createLoadBalancer

CreateLoadBalancerResult createLoadBalancer(CreateLoadBalancerRequest createLoadBalancerRequest)
                                            throws AmazonServiceException,
                                                   AmazonClientException

Creates a new LoadBalancer.

After the call has completed successfully, a new LoadBalancer is created; however, it will not be usable until at least one instance has been registered. When the LoadBalancer creation is completed, the client can check whether or not it is usable by using the DescribeInstanceHealth API. The LoadBalancer is usable as soon as any registered instance is InService .

NOTE: Currently, the client's quota of LoadBalancers is limited to ten per Region.

NOTE: LoadBalancer DNS names vary depending on the Region they're created in. For LoadBalancers created in the United States, the DNS name ends with: us-east-1.elb.amazonaws.com (for the US Standard Region) us-west-1.elb.amazonaws.com (for the Northern California Region) For LoadBalancers created in the EU (Ireland) Region, the DNS name ends with: eu-west-1.elb.amazonaws.com

Parameters:

createLoadBalancerRequest - Container for the necessary parameters to execute the CreateLoadBalancer service method on AmazonElasticLoadBalancing.

Returns:

The response from the CreateLoadBalancer service method, as returned by AmazonElasticLoadBalancing.

Throws:

InvalidSubnetException

InvalidConfigurationRequestException

InvalidSecurityGroupException

CertificateNotFoundException

InvalidSchemeException

DuplicateLoadBalancerNameException

TooManyLoadBalancersException

SubnetNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonElasticLoadBalancing indicating either a problem with the data in the request, or a server side issue.

deleteLoadBalancer

void deleteLoadBalancer(DeleteLoadBalancerRequest deleteLoadBalancerRequest)
                        throws AmazonServiceException,
                               AmazonClientException

Deletes the specified LoadBalancer.

If attempting to recreate the LoadBalancer, the client 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 client instances. The client will not receive the same DNS name even if a new LoadBalancer with same LoadBalancerName is created.

To successfully call this API, the client 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:

deleteLoadBalancerRequest - Container for the necessary parameters to execute the DeleteLoadBalancer service method on AmazonElasticLoadBalancing.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonElasticLoadBalancing indicating either a problem with the data in the request, or a server side issue.

setLoadBalancerPoliciesForBackendServer

SetLoadBalancerPoliciesForBackendServerResult setLoadBalancerPoliciesForBackendServer(SetLoadBalancerPoliciesForBackendServerRequest setLoadBalancerPoliciesForBackendServerRequest)
                                                                                      throws AmazonServiceException,
                                                                                             AmazonClientException

Replaces the current set of policies associated with a port on which the back-end server is listening with a new set of policies. After the policies have been created using CreateLoadBalancerPolicy, they can be applied here as a list. At this time, only the back-end server authentication policy type can be applied to the back-end ports; this policy type is composed of multiple public key policies.

Parameters:

setLoadBalancerPoliciesForBackendServerRequest - Container for the necessary parameters to execute the SetLoadBalancerPoliciesForBackendServer service method on AmazonElasticLoadBalancing.

Returns:

The response from the SetLoadBalancerPoliciesForBackendServer service method, as returned by AmazonElasticLoadBalancing.

Throws:

PolicyNotFoundException

InvalidConfigurationRequestException

LoadBalancerNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonElasticLoadBalancing indicating either a problem with the data in the request, or a server side issue.

deleteLoadBalancerListeners

void deleteLoadBalancerListeners(DeleteLoadBalancerListenersRequest deleteLoadBalancerListenersRequest)
                                 throws AmazonServiceException,
                                        AmazonClientException

Deletes listeners from the LoadBalancer for the specified port.

Parameters:

deleteLoadBalancerListenersRequest - Container for the necessary parameters to execute the DeleteLoadBalancerListeners service method on AmazonElasticLoadBalancing.

Throws:

LoadBalancerNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonElasticLoadBalancing indicating either a problem with the data in the request, or a server side issue.

deregisterInstancesFromLoadBalancer

DeregisterInstancesFromLoadBalancerResult deregisterInstancesFromLoadBalancer(DeregisterInstancesFromLoadBalancerRequest deregisterInstancesFromLoadBalancerRequest)
                                                                              throws AmazonServiceException,
                                                                                     AmazonClientException

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

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

Parameters:

deregisterInstancesFromLoadBalancerRequest - Container for the necessary parameters to execute the DeregisterInstancesFromLoadBalancer service method on AmazonElasticLoadBalancing.

Returns:

The response from the DeregisterInstancesFromLoadBalancer service method, as returned by AmazonElasticLoadBalancing.

Throws:

LoadBalancerNotFoundException

InvalidInstanceException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonElasticLoadBalancing indicating either a problem with the data in the request, or a server side issue.

setLoadBalancerListenerSSLCertificate

void setLoadBalancerListenerSSLCertificate(SetLoadBalancerListenerSSLCertificateRequest setLoadBalancerListenerSSLCertificateRequest)
                                           throws AmazonServiceException,
                                                  AmazonClientException

Sets the certificate that terminates the specified listener's SSL connections. The specified certificate replaces any prior certificate that was used on the same LoadBalancer and port.

Parameters:

setLoadBalancerListenerSSLCertificateRequest - Container for the necessary parameters to execute the SetLoadBalancerListenerSSLCertificate service method on AmazonElasticLoadBalancing.

Throws:

InvalidConfigurationRequestException

CertificateNotFoundException

LoadBalancerNotFoundException

ListenerNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonElasticLoadBalancing indicating either a problem with the data in the request, or a server side issue.

createLBCookieStickinessPolicy

CreateLBCookieStickinessPolicyResult createLBCookieStickinessPolicy(CreateLBCookieStickinessPolicyRequest createLBCookieStickinessPolicyRequest)
                                                                    throws AmazonServiceException,
                                                                           AmazonClientException

Generates a stickiness policy with sticky session lifetimes controlled by the lifetime of the browser (user-agent) or a specified expiration period. This policy can be associated only with HTTP/HTTPS listeners.

When a LoadBalancer implements this policy, the LoadBalancer uses a special cookie to track the backend server instance for each request. When the LoadBalancer receives a request, it first checks to see if this cookie is present in the request. If so, the LoadBalancer sends the request to the application server specified in the cookie. If not, the LoadBalancer sends the request to a server that is chosen based on the existing load balancing algorithm.

A cookie is inserted into the response for binding subsequent requests from the same user to that server. The validity of the cookie is based on the cookie expiration time, which is specified in the policy configuration.

Parameters:

createLBCookieStickinessPolicyRequest - Container for the necessary parameters to execute the CreateLBCookieStickinessPolicy service method on AmazonElasticLoadBalancing.

Returns:

The response from the CreateLBCookieStickinessPolicy service method, as returned by AmazonElasticLoadBalancing.

Throws:

InvalidConfigurationRequestException

DuplicatePolicyNameException

TooManyPoliciesException

LoadBalancerNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonElasticLoadBalancing indicating either a problem with the data in the request, or a server side issue.

attachLoadBalancerToSubnets

AttachLoadBalancerToSubnetsResult attachLoadBalancerToSubnets(AttachLoadBalancerToSubnetsRequest attachLoadBalancerToSubnetsRequest)
                                                              throws AmazonServiceException,
                                                                     AmazonClientException

Adds one or more subnets to the set of configured subnets in the VPC for the LoadBalancer.

The Loadbalancers evenly distribute requests across all of the registered subnets.

Parameters:

attachLoadBalancerToSubnetsRequest - Container for the necessary parameters to execute the AttachLoadBalancerToSubnets service method on AmazonElasticLoadBalancing.

Returns:

The response from the AttachLoadBalancerToSubnets service method, as returned by AmazonElasticLoadBalancing.

Throws:

InvalidSubnetException

InvalidConfigurationRequestException

LoadBalancerNotFoundException

SubnetNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonElasticLoadBalancing indicating either a problem with the data in the request, or a server side issue.

createAppCookieStickinessPolicy

CreateAppCookieStickinessPolicyResult createAppCookieStickinessPolicy(CreateAppCookieStickinessPolicyRequest createAppCookieStickinessPolicyRequest)
                                                                      throws AmazonServiceException,
                                                                             AmazonClientException

Generates a stickiness policy with sticky session lifetimes that follow that of an application-generated cookie. This policy can be associated only with HTTP/HTTPS listeners.

This policy is similar to the policy created by CreateLBCookieStickinessPolicy, except that the lifetime of the special Elastic Load Balancing cookie follows the lifetime of the application-generated cookie specified in the policy configuration. The LoadBalancer only inserts a new stickiness cookie when the application response includes a new application cookie.

If the application cookie is explicitly removed or expires, the session stops being sticky until a new application cookie is issued.

NOTE: An application client must receive and send two cookies: the application-generated cookie and the special Elastic Load Balancing cookie named AWSELB. This is the default behavior for many common web browsers.

Parameters:

createAppCookieStickinessPolicyRequest - Container for the necessary parameters to execute the CreateAppCookieStickinessPolicy service method on AmazonElasticLoadBalancing.

Returns:

The response from the CreateAppCookieStickinessPolicy service method, as returned by AmazonElasticLoadBalancing.

Throws:

InvalidConfigurationRequestException

DuplicatePolicyNameException

TooManyPoliciesException

LoadBalancerNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonElasticLoadBalancing indicating either a problem with the data in the request, or a server side issue.

registerInstancesWithLoadBalancer

RegisterInstancesWithLoadBalancerResult registerInstancesWithLoadBalancer(RegisterInstancesWithLoadBalancerRequest registerInstancesWithLoadBalancerRequest)
                                                                          throws AmazonServiceException,
                                                                                 AmazonClientException

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.

Parameters:

registerInstancesWithLoadBalancerRequest - Container for the necessary parameters to execute the RegisterInstancesWithLoadBalancer service method on AmazonElasticLoadBalancing.

Returns:

The response from the RegisterInstancesWithLoadBalancer service method, as returned by AmazonElasticLoadBalancing.

Throws:

LoadBalancerNotFoundException

InvalidInstanceException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonElasticLoadBalancing indicating either a problem with the data in the request, or a server side issue.

applySecurityGroupsToLoadBalancer

ApplySecurityGroupsToLoadBalancerResult applySecurityGroupsToLoadBalancer(ApplySecurityGroupsToLoadBalancerRequest applySecurityGroupsToLoadBalancerRequest)
                                                                          throws AmazonServiceException,
                                                                                 AmazonClientException

Associates one or more security groups with your LoadBalancer in VPC. The provided security group IDs will override any currently applied security groups.

Parameters:

applySecurityGroupsToLoadBalancerRequest - Container for the necessary parameters to execute the ApplySecurityGroupsToLoadBalancer service method on AmazonElasticLoadBalancing.

Returns:

The response from the ApplySecurityGroupsToLoadBalancer service method, as returned by AmazonElasticLoadBalancing.

Throws:

InvalidConfigurationRequestException

InvalidSecurityGroupException

LoadBalancerNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonElasticLoadBalancing indicating either a problem with the data in the request, or a server side issue.

describeLoadBalancers

DescribeLoadBalancersResult describeLoadBalancers(DescribeLoadBalancersRequest describeLoadBalancersRequest)
                                                  throws AmazonServiceException,
                                                         AmazonClientException

Returns detailed configuration information for the specified LoadBalancers. If no LoadBalancers are specified, the operation returns configuration information for all LoadBalancers created by the caller.

NOTE: The client must have created the specified input LoadBalancers in order to retrieve this information; the client must provide the same account credentials as those that were used to create the LoadBalancer.

Parameters:

describeLoadBalancersRequest - Container for the necessary parameters to execute the DescribeLoadBalancers service method on AmazonElasticLoadBalancing.

Returns:

The response from the DescribeLoadBalancers service method, as returned by AmazonElasticLoadBalancing.

Throws:

LoadBalancerNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonElasticLoadBalancing indicating either a problem with the data in the request, or a server side issue.

describeLoadBalancerPolicyTypes

DescribeLoadBalancerPolicyTypesResult describeLoadBalancerPolicyTypes()
                                                                      throws AmazonServiceException,
                                                                             AmazonClientException

Returns meta-information on the specified LoadBalancer policies defined by the Elastic Load Balancing service. The policy types that are returned from this action can be used in a CreateLoadBalancerPolicy action to instantiate specific policy configurations that will be applied to an Elastic LoadBalancer.

Returns:

The response from the DescribeLoadBalancerPolicyTypes service method, as returned by AmazonElasticLoadBalancing.

Throws:

PolicyTypeNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonElasticLoadBalancing indicating either a problem with the data in the request, or a server side issue.

describeLoadBalancerPolicies

DescribeLoadBalancerPoliciesResult describeLoadBalancerPolicies()
                                                                throws AmazonServiceException,
                                                                       AmazonClientException

Returns detailed descriptions of the policies. If you specify a LoadBalancer name, the operation returns either the descriptions of the specified policies, or descriptions of all the policies created for the LoadBalancer. If you don't specify a LoadBalancer name, the operation returns descriptions of the specified sample policies, or descriptions of all the sample policies. The names of the sample policies have the ELBSample- prefix.

Returns:

The response from the DescribeLoadBalancerPolicies service method, as returned by AmazonElasticLoadBalancing.

Throws:

PolicyNotFoundException

LoadBalancerNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonElasticLoadBalancing indicating either a problem with the data in the request, or a server side issue.

describeLoadBalancers

DescribeLoadBalancersResult describeLoadBalancers()
                                                  throws AmazonServiceException,
                                                         AmazonClientException

Returns detailed configuration information for the specified LoadBalancers. If no LoadBalancers are specified, the operation returns configuration information for all LoadBalancers created by the caller.

NOTE: The client must have created the specified input LoadBalancers in order to retrieve this information; the client must provide the same account credentials as those that were used to create the LoadBalancer.

Returns:

The response from the DescribeLoadBalancers service method, as returned by AmazonElasticLoadBalancing.

Throws:

LoadBalancerNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonElasticLoadBalancing indicating either a problem with the data in the request, or a server side issue.

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.