com.amazonaws.services.elasticloadbalancing
Class AmazonElasticLoadBalancingClient

java.lang.Object
  extended by com.amazonaws.AmazonWebServiceClient
      extended by com.amazonaws.services.elasticloadbalancing.AmazonElasticLoadBalancingClient
All Implemented Interfaces:
AmazonElasticLoadBalancing
Direct Known Subclasses:
AmazonElasticLoadBalancingAsyncClient

public class AmazonElasticLoadBalancingClient
extends AmazonWebServiceClient
implements AmazonElasticLoadBalancing

Client for accessing AmazonElasticLoadBalancing. All service calls made using this client are blocking, and will not return until the service call completes.

Elastic Load Balancing

Elastic Load Balancing is a cost-effective and easy to use web service to help you improve the availability and scalability of your application running on Amazon Elastic Cloud Compute (Amazon EC2). It makes it easy for you to distribute application loads between two or more EC2 instances. Elastic Load Balancing supports the growth in traffic of your application by enabling availability through redundancy.

This guide provides detailed information about Elastic Load Balancing actions, data types, and parameters that can be used for sending a query request. 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.

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 actions, go to Using Elastic Load Balancing in the Elastic Load Balancing Developer Guide .

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

Endpoints

The examples in this guide assume that your load balancers are created in the US East (Northern Virginia) region and use us-east-1 as the endpoint.

You can create your load balancers in other AWS regions. For information about regions and endpoints supported by Elastic Load Balancing, see Regions and Endpoints in the Amazon Web Services General Reference.

See our blog to learn more about Managing Credentials in Mobile Applications.


Constructor Summary
AmazonElasticLoadBalancingClient()
          Constructs a new client to invoke service methods on AmazonElasticLoadBalancing.
AmazonElasticLoadBalancingClient(AWSCredentials awsCredentials)
          Constructs a new client to invoke service methods on AmazonElasticLoadBalancing using the specified AWS account credentials.
AmazonElasticLoadBalancingClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
          Constructs a new client to invoke service methods on AmazonElasticLoadBalancing using the specified AWS account credentials and client configuration options.
AmazonElasticLoadBalancingClient(AWSCredentialsProvider awsCredentialsProvider)
          Constructs a new client to invoke service methods on AmazonElasticLoadBalancing using the specified AWS account credentials provider.
AmazonElasticLoadBalancingClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
          Constructs a new client to invoke service methods on AmazonElasticLoadBalancing using the specified AWS account credentials provider and client configuration options.
AmazonElasticLoadBalancingClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, com.amazonaws.metrics.RequestMetricCollector requestMetricCollector)
          Constructs a new client to invoke service methods on AmazonElasticLoadBalancing using the specified AWS account credentials provider, client configuration options, and request metric collector.
AmazonElasticLoadBalancingClient(ClientConfiguration clientConfiguration)
          Constructs a new client to invoke service methods on AmazonElasticLoadBalancing.
 
Method Summary
 ApplySecurityGroupsToLoadBalancerResult applySecurityGroupsToLoadBalancer(ApplySecurityGroupsToLoadBalancerRequest applySecurityGroupsToLoadBalancerRequest)
           Associates one or more security groups with your load balancer in Amazon Virtual Private Cloud (Amazon VPC).
 AttachLoadBalancerToSubnetsResult attachLoadBalancerToSubnets(AttachLoadBalancerToSubnetsRequest attachLoadBalancerToSubnetsRequest)
           Adds one or more subnets to the set of configured subnets in the Amazon Virtual Private Cloud (Amazon VPC) for the load balancer.
 ConfigureHealthCheckResult configureHealthCheck(ConfigureHealthCheckRequest configureHealthCheckRequest)
           Specifies the health check settings to use for evaluating the health state of your back-end 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 load balancer.
 void createLoadBalancerListeners(CreateLoadBalancerListenersRequest createLoadBalancerListenersRequest)
           Creates one or more listeners on a load balancer 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 load balancer.
 void deleteLoadBalancerListeners(DeleteLoadBalancerListenersRequest deleteLoadBalancerListenersRequest)
           Deletes listeners from the load balancer for the specified port.
 DeleteLoadBalancerPolicyResult deleteLoadBalancerPolicy(DeleteLoadBalancerPolicyRequest deleteLoadBalancerPolicyRequest)
           Deletes a policy from the load balancer.
 DeregisterInstancesFromLoadBalancerResult deregisterInstancesFromLoadBalancer(DeregisterInstancesFromLoadBalancerRequest deregisterInstancesFromLoadBalancerRequest)
           Deregisters instances from the load balancer.
 DescribeInstanceHealthResult describeInstanceHealth(DescribeInstanceHealthRequest describeInstanceHealthRequest)
           Returns the current state of the specified instances registered with the specified load balancer.
 DescribeLoadBalancerAttributesResult describeLoadBalancerAttributes(DescribeLoadBalancerAttributesRequest describeLoadBalancerAttributesRequest)
           Returns detailed information about all of the attributes associated with the specified load balancer.
 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 load balancer policies defined by the Elastic Load Balancing service.
 DescribeLoadBalancerPolicyTypesResult describeLoadBalancerPolicyTypes(DescribeLoadBalancerPolicyTypesRequest describeLoadBalancerPolicyTypesRequest)
           Returns meta-information on the specified load balancer policies defined by the Elastic Load Balancing service.
 DescribeLoadBalancersResult describeLoadBalancers()
           Returns detailed configuration information for all the load balancers created for the account.
 DescribeLoadBalancersResult describeLoadBalancers(DescribeLoadBalancersRequest describeLoadBalancersRequest)
           Returns detailed configuration information for all the load balancers created for the account.
 DetachLoadBalancerFromSubnetsResult detachLoadBalancerFromSubnets(DetachLoadBalancerFromSubnetsRequest detachLoadBalancerFromSubnetsRequest)
           Removes subnets from the set of configured subnets in the Amazon Virtual Private Cloud (Amazon VPC) for the load balancer.
 DisableAvailabilityZonesForLoadBalancerResult disableAvailabilityZonesForLoadBalancer(DisableAvailabilityZonesForLoadBalancerRequest disableAvailabilityZonesForLoadBalancerRequest)
           Removes the specified EC2 Availability Zones from the set of configured Availability Zones for the load balancer.
 EnableAvailabilityZonesForLoadBalancerResult enableAvailabilityZonesForLoadBalancer(EnableAvailabilityZonesForLoadBalancerRequest enableAvailabilityZonesForLoadBalancerRequest)
           Adds one or more EC2 Availability Zones to the load balancer.
 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.
 ModifyLoadBalancerAttributesResult modifyLoadBalancerAttributes(ModifyLoadBalancerAttributesRequest modifyLoadBalancerAttributesRequest)
           Modifies the attributes of a specified load balancer.
 RegisterInstancesWithLoadBalancerResult registerInstancesWithLoadBalancer(RegisterInstancesWithLoadBalancerRequest registerInstancesWithLoadBalancerRequest)
           Adds new instances to the load balancer.
 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 load balancer.
 
Methods inherited from class com.amazonaws.AmazonWebServiceClient
addRequestHandler, addRequestHandler, getRequestMetricsCollector, getServiceName, getTimeOffset, removeRequestHandler, removeRequestHandler, setConfiguration, setEndpoint, setEndpoint, setRegion, setTimeOffset, shutdown, withTimeOffset
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.amazonaws.services.elasticloadbalancing.AmazonElasticLoadBalancing
setEndpoint, setRegion, shutdown
 

Constructor Detail

AmazonElasticLoadBalancingClient

public AmazonElasticLoadBalancingClient()
Constructs a new client to invoke service methods on AmazonElasticLoadBalancing. A credentials provider chain will be used that searches for credentials in this order:

All service calls made using this new client object are blocking, and will not return until the service call completes.

See Also:
DefaultAWSCredentialsProviderChain

AmazonElasticLoadBalancingClient

public AmazonElasticLoadBalancingClient(ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on AmazonElasticLoadBalancing. A credentials provider chain will be used that searches for credentials in this order:

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:
clientConfiguration - The client configuration options controlling how this client connects to AmazonElasticLoadBalancing (ex: proxy settings, retry counts, etc.).
See Also:
DefaultAWSCredentialsProviderChain

AmazonElasticLoadBalancingClient

public AmazonElasticLoadBalancingClient(AWSCredentials awsCredentials)
Constructs a new client to invoke service methods on AmazonElasticLoadBalancing using the specified AWS account credentials.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:
awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

AmazonElasticLoadBalancingClient

public AmazonElasticLoadBalancingClient(AWSCredentials awsCredentials,
                                        ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on AmazonElasticLoadBalancing using the specified AWS account credentials and client configuration options.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:
awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.
clientConfiguration - The client configuration options controlling how this client connects to AmazonElasticLoadBalancing (ex: proxy settings, retry counts, etc.).

AmazonElasticLoadBalancingClient

public AmazonElasticLoadBalancingClient(AWSCredentialsProvider awsCredentialsProvider)
Constructs a new client to invoke service methods on AmazonElasticLoadBalancing using the specified AWS account credentials provider.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

AmazonElasticLoadBalancingClient

public AmazonElasticLoadBalancingClient(AWSCredentialsProvider awsCredentialsProvider,
                                        ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on AmazonElasticLoadBalancing using the specified AWS account credentials provider and client configuration options.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
clientConfiguration - The client configuration options controlling how this client connects to AmazonElasticLoadBalancing (ex: proxy settings, retry counts, etc.).

AmazonElasticLoadBalancingClient

public AmazonElasticLoadBalancingClient(AWSCredentialsProvider awsCredentialsProvider,
                                        ClientConfiguration clientConfiguration,
                                        com.amazonaws.metrics.RequestMetricCollector requestMetricCollector)
Constructs a new client to invoke service methods on AmazonElasticLoadBalancing using the specified AWS account credentials provider, client configuration options, and request metric collector.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
clientConfiguration - The client configuration options controlling how this client connects to AmazonElasticLoadBalancing (ex: proxy settings, retry counts, etc.).
requestMetricCollector - optional request metric collector
Method Detail

describeLoadBalancerPolicyTypes

public DescribeLoadBalancerPolicyTypesResult describeLoadBalancerPolicyTypes(DescribeLoadBalancerPolicyTypesRequest describeLoadBalancerPolicyTypesRequest)

Returns meta-information on the specified load balancer 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 a load balancer.

Specified by:
describeLoadBalancerPolicyTypes in interface AmazonElasticLoadBalancing
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

public ConfigureHealthCheckResult configureHealthCheck(ConfigureHealthCheckRequest configureHealthCheckRequest)

Specifies the health check settings to use for evaluating the health state of your back-end instances.

For more information, see Health Check in the Elastic Load Balancing Developer Guide .

Specified by:
configureHealthCheck in interface AmazonElasticLoadBalancing
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

public DetachLoadBalancerFromSubnetsResult detachLoadBalancerFromSubnets(DetachLoadBalancerFromSubnetsRequest detachLoadBalancerFromSubnetsRequest)

Removes subnets from the set of configured subnets in the Amazon Virtual Private Cloud (Amazon VPC) for the load balancer.

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

Specified by:
detachLoadBalancerFromSubnets in interface AmazonElasticLoadBalancing
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.

modifyLoadBalancerAttributes

public ModifyLoadBalancerAttributesResult modifyLoadBalancerAttributes(ModifyLoadBalancerAttributesRequest modifyLoadBalancerAttributesRequest)

Modifies the attributes of a specified load balancer.

Specified by:
modifyLoadBalancerAttributes in interface AmazonElasticLoadBalancing
Parameters:
modifyLoadBalancerAttributesRequest - Container for the necessary parameters to execute the ModifyLoadBalancerAttributes service method on AmazonElasticLoadBalancing.
Returns:
The response from the ModifyLoadBalancerAttributes service method, as returned by AmazonElasticLoadBalancing.
Throws:
InvalidConfigurationRequestException
LoadBalancerAttributeNotFoundException
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

public void createLoadBalancerListeners(CreateLoadBalancerListenersRequest createLoadBalancerListenersRequest)

Creates one or more listeners on a load balancer 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.

For more information, see Add a Listener to Your Load Balancer in the Elastic Load Balancing Developer Guide .

Specified by:
createLoadBalancerListeners in interface AmazonElasticLoadBalancing
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.

deleteLoadBalancerListeners

public void deleteLoadBalancerListeners(DeleteLoadBalancerListenersRequest deleteLoadBalancerListenersRequest)

Deletes listeners from the load balancer for the specified port.

Specified by:
deleteLoadBalancerListeners in interface AmazonElasticLoadBalancing
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.

createAppCookieStickinessPolicy

public CreateAppCookieStickinessPolicyResult createAppCookieStickinessPolicy(CreateAppCookieStickinessPolicyRequest createAppCookieStickinessPolicyRequest)

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 load balancer 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.

For more information, see Enabling Application-Controlled Session Stickiness in the Elastic Load Balancing Developer Guide .

Specified by:
createAppCookieStickinessPolicy in interface AmazonElasticLoadBalancing
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.

applySecurityGroupsToLoadBalancer

public ApplySecurityGroupsToLoadBalancerResult applySecurityGroupsToLoadBalancer(ApplySecurityGroupsToLoadBalancerRequest applySecurityGroupsToLoadBalancerRequest)

Associates one or more security groups with your load balancer in Amazon Virtual Private Cloud (Amazon VPC). The provided security group IDs will override any currently applied security groups.

For more information, see Manage Security Groups in Amazon VPC in the Elastic Load Balancing Developer Guide .

Specified by:
applySecurityGroupsToLoadBalancer in interface AmazonElasticLoadBalancing
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.

describeLoadBalancerPolicies

public DescribeLoadBalancerPoliciesResult describeLoadBalancerPolicies(DescribeLoadBalancerPoliciesRequest describeLoadBalancerPoliciesRequest)

Returns detailed descriptions of the policies. If you specify a load balancer name, the action returns the descriptions of all the policies created for the load balancer. If you specify a policy name associated with your load balancer, the action returns the description of that policy. If you don't specify a load balancer name, the action returns descriptions of the specified sample policies, or descriptions of all the sample policies. The names of the sample policies have the ELBSample- prefix.

Specified by:
describeLoadBalancerPolicies in interface AmazonElasticLoadBalancing
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

public SetLoadBalancerPoliciesOfListenerResult setLoadBalancerPoliciesOfListener(SetLoadBalancerPoliciesOfListenerRequest setLoadBalancerPoliciesOfListenerRequest)

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

Specified by:
setLoadBalancerPoliciesOfListener in interface AmazonElasticLoadBalancing
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

public DisableAvailabilityZonesForLoadBalancerResult disableAvailabilityZonesForLoadBalancer(DisableAvailabilityZonesForLoadBalancerRequest disableAvailabilityZonesForLoadBalancerRequest)

Removes the specified EC2 Availability Zones from the set of configured Availability Zones for the load balancer.

There must be at least one Availability Zone registered with a load balancer at all times. Once an Availability Zone is removed, all the instances registered with the load balancer that are in the removed Availability Zone go into the OutOfService state. Upon Availability Zone removal, the load balancer attempts to equally balance the traffic among its remaining usable Availability Zones. Trying to remove an Availability Zone that was not associated with the load balancer does nothing.

For more information, see Disable an Availability Zone from a Load-Balanced Application in the Elastic Load Balancing Developer Guide .

Specified by:
disableAvailabilityZonesForLoadBalancer in interface AmazonElasticLoadBalancing
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

public DescribeInstanceHealthResult describeInstanceHealth(DescribeInstanceHealthRequest describeInstanceHealthRequest)

Returns the current state of the specified instances registered with the specified load balancer. If no instances are specified, the state of all the instances registered with the load balancer is returned.

NOTE: You must provide the same account credentials as those that were used to create the load balancer.

Specified by:
describeInstanceHealth in interface AmazonElasticLoadBalancing
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

public DeleteLoadBalancerPolicyResult deleteLoadBalancerPolicy(DeleteLoadBalancerPolicyRequest deleteLoadBalancerPolicyRequest)

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

Specified by:
deleteLoadBalancerPolicy in interface AmazonElasticLoadBalancing
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

public CreateLoadBalancerPolicyResult createLoadBalancerPolicy(CreateLoadBalancerPolicyRequest createLoadBalancerPolicyRequest)

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

Specified by:
createLoadBalancerPolicy in interface AmazonElasticLoadBalancing
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

public EnableAvailabilityZonesForLoadBalancerResult enableAvailabilityZonesForLoadBalancer(EnableAvailabilityZonesForLoadBalancerRequest enableAvailabilityZonesForLoadBalancerRequest)

Adds one or more EC2 Availability Zones to the load balancer.

The load balancer evenly distributes requests across all its registered Availability Zones that contain instances.

NOTE: The new EC2 Availability Zones to be added must be in the same EC2 Region as the Availability Zones for which the load balancer was created.

For more information, see Expand a Load Balanced Application to an Additional Availability Zone in the Elastic Load Balancing Developer Guide .

Specified by:
enableAvailabilityZonesForLoadBalancer in interface AmazonElasticLoadBalancing
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.

deleteLoadBalancer

public void deleteLoadBalancer(DeleteLoadBalancerRequest deleteLoadBalancerRequest)

Deletes the specified load balancer.

If attempting to recreate the load balancer, you must reconfigure all the settings. The DNS name associated with a deleted load balancer will no longer be usable. Once deleted, the name and associated DNS record of the load balancer no longer exist and traffic sent to any of its IP addresses will no longer be delivered to back-end instances.

To successfully call this API, you must provide the same account credentials as were used to create the load balancer.

NOTE: By design, if the load balancer does not exist or has already been deleted, a call to DeleteLoadBalancer action still succeeds.

Specified by:
deleteLoadBalancer in interface AmazonElasticLoadBalancing
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.

createLoadBalancer

public CreateLoadBalancerResult createLoadBalancer(CreateLoadBalancerRequest createLoadBalancerRequest)

Creates a new load balancer.

After the call has completed successfully, a new load balancer is created with a unique Domain Name Service (DNS) name. The DNS name includes the name of the AWS region in which the load balance was created. For example, if your load balancer was created in the United States, the DNS name might end with either of the following:

For information about the AWS regions supported by Elastic Load Balancing, see Regions and Endpoints .

You can create up to 10 load balancers per region per account.

Elastic Load Balancing supports load balancing your Amazon EC2 instances launched within any one of the following platforms:

Specified by:
createLoadBalancer in interface AmazonElasticLoadBalancing
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.

setLoadBalancerPoliciesForBackendServer

public 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. 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.

NOTE: The SetLoadBalancerPoliciesForBackendServer replaces the current set of policies associated with the specified instance port. Every time you use this action to enable the policies, use the PolicyNames parameter to list all the policies you want to enable.

You can use DescribeLoadBalancers or DescribeLoadBalancerPolicies action to verify that the policy has been associated with the back-end server.

Specified by:
setLoadBalancerPoliciesForBackendServer in interface AmazonElasticLoadBalancing
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.

deregisterInstancesFromLoadBalancer

public DeregisterInstancesFromLoadBalancerResult deregisterInstancesFromLoadBalancer(DeregisterInstancesFromLoadBalancerRequest deregisterInstancesFromLoadBalancerRequest)

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.

Specified by:
deregisterInstancesFromLoadBalancer in interface AmazonElasticLoadBalancing
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

public void setLoadBalancerListenerSSLCertificate(SetLoadBalancerListenerSSLCertificateRequest setLoadBalancerListenerSSLCertificateRequest)

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

For more information on updating your SSL certificate, see Updating an SSL Certificate for a Load Balancer in the Elastic Load Balancing Developer Guide .

Specified by:
setLoadBalancerListenerSSLCertificate in interface AmazonElasticLoadBalancing
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.

describeLoadBalancerAttributes

public DescribeLoadBalancerAttributesResult describeLoadBalancerAttributes(DescribeLoadBalancerAttributesRequest describeLoadBalancerAttributesRequest)

Returns detailed information about all of the attributes associated with the specified load balancer.

Specified by:
describeLoadBalancerAttributes in interface AmazonElasticLoadBalancing
Parameters:
describeLoadBalancerAttributesRequest - Container for the necessary parameters to execute the DescribeLoadBalancerAttributes service method on AmazonElasticLoadBalancing.
Returns:
The response from the DescribeLoadBalancerAttributes service method, as returned by AmazonElasticLoadBalancing.
Throws:
LoadBalancerAttributeNotFoundException
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.

createLBCookieStickinessPolicy

public 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. This policy can be associated only with HTTP/HTTPS listeners.

When a load balancer implements this policy, the load balancer uses a special cookie to track the backend server instance for each request. When the load balancer receives a request, it first checks to see if this cookie is present in the request. If so, the load balancer sends the request to the application server specified in the cookie. If not, the load balancer 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.

For more information, see Enabling Duration-Based Session Stickiness in the Elastic Load Balancing Developer Guide .

Specified by:
createLBCookieStickinessPolicy in interface AmazonElasticLoadBalancing
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

public AttachLoadBalancerToSubnetsResult attachLoadBalancerToSubnets(AttachLoadBalancerToSubnetsRequest attachLoadBalancerToSubnetsRequest)

Adds one or more subnets to the set of configured subnets in the Amazon Virtual Private Cloud (Amazon VPC) for the load balancer.

The load balancers evenly distribute requests across all of the registered subnets. For more information, see Deploy Elastic Load Balancing in Amazon VPC in the Elastic Load Balancing Developer Guide .

Specified by:
attachLoadBalancerToSubnets in interface AmazonElasticLoadBalancing
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.

registerInstancesWithLoadBalancer

public RegisterInstancesWithLoadBalancerResult registerInstancesWithLoadBalancer(RegisterInstancesWithLoadBalancerRequest registerInstancesWithLoadBalancerRequest)

Adds new instances to the load balancer.

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

When an instance registered with a load balancer is stopped and then restarted, the IP addresses associated with the instance changes. Elastic Load Balancing cannot recognize the new IP address, which prevents it from routing traffic to the 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.

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

NOTE: In order for this call to be successful, you must provide the same account credentials as those that were used to create the load balancer.

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.

You can use DescribeLoadBalancers or DescribeInstanceHealth action to check the state of the newly registered instances.

Specified by:
registerInstancesWithLoadBalancer in interface AmazonElasticLoadBalancing
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.

describeLoadBalancers

public DescribeLoadBalancersResult describeLoadBalancers(DescribeLoadBalancersRequest describeLoadBalancersRequest)

Returns detailed configuration information for all the load balancers created for the account. If you specify load balancer names, the action returns configuration information of the specified load balancers.

NOTE: In order to retrieve this information, you must provide the same account credentials that was used to create the load balancer.

Specified by:
describeLoadBalancers in interface AmazonElasticLoadBalancing
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

public DescribeLoadBalancerPolicyTypesResult describeLoadBalancerPolicyTypes()
                                                                      throws AmazonServiceException,
                                                                             AmazonClientException

Returns meta-information on the specified load balancer 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 a load balancer.

Specified by:
describeLoadBalancerPolicyTypes in interface 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.

describeLoadBalancerPolicies

public DescribeLoadBalancerPoliciesResult describeLoadBalancerPolicies()
                                                                throws AmazonServiceException,
                                                                       AmazonClientException

Returns detailed descriptions of the policies. If you specify a load balancer name, the action returns the descriptions of all the policies created for the load balancer. If you specify a policy name associated with your load balancer, the action returns the description of that policy. If you don't specify a load balancer name, the action returns descriptions of the specified sample policies, or descriptions of all the sample policies. The names of the sample policies have the ELBSample- prefix.

Specified by:
describeLoadBalancerPolicies in interface 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.

describeLoadBalancers

public DescribeLoadBalancersResult describeLoadBalancers()
                                                  throws AmazonServiceException,
                                                         AmazonClientException

Returns detailed configuration information for all the load balancers created for the account. If you specify load balancer names, the action returns configuration information of the specified load balancers.

NOTE: In order to retrieve this information, you must provide the same account credentials that was used to create the load balancer.

Specified by:
describeLoadBalancers in interface 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.

getCachedResponseMetadata

public 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 the request.

Specified by:
getCachedResponseMetadata in interface AmazonElasticLoadBalancing
Parameters:
request - The originally executed request
Returns:
The response metadata for the specified request, or null if none is available.


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