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 distributes incoming traffic across your EC2 instances.

For information about the features of Elastic Load Balancing, see What Is Elastic Load Balancing? in the Elastic Load Balancing Developer Guide .

For information about the AWS regions supported by Elastic Load Balancing, see Regions and Endpoints - Elastic Load Balancing in the Amazon Web Services General Reference .

All Elastic Load Balancing operations are idempotent , which means that they complete at most one time. If you repeat an operation, it succeeds with a 200 OK response code.

Method Summary

Methods

Modifier and Type	Method and Description
AddTagsResult	addTags(AddTagsRequest addTagsRequest) Adds the specified tags to the specified load balancer.
ApplySecurityGroupsToLoadBalancerResult	applySecurityGroupsToLoadBalancer(ApplySecurityGroupsToLoadBalancerRequest applySecurityGroupsToLoadBalancerRequest) Associates one or more security groups with your load balancer in a virtual private cloud (VPC).
AttachLoadBalancerToSubnetsResult	attachLoadBalancerToSubnets(AttachLoadBalancerToSubnetsRequest attachLoadBalancerToSubnetsRequest) Adds one or more subnets to the set of configured subnets for the specified load balancer.
ConfigureHealthCheckResult	configureHealthCheck(ConfigureHealthCheckRequest configureHealthCheckRequest) Specifies the health check settings to use when 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 load balancer.
void	createLoadBalancerListeners(CreateLoadBalancerListenersRequest createLoadBalancerListenersRequest) Creates one or more listeners for the specified load balancer.
CreateLoadBalancerPolicyResult	createLoadBalancerPolicy(CreateLoadBalancerPolicyRequest createLoadBalancerPolicyRequest) Creates a policy with the specified attributes for the specified load balancer.
void	deleteLoadBalancer(DeleteLoadBalancerRequest deleteLoadBalancerRequest) Deletes the specified load balancer.
void	deleteLoadBalancerListeners(DeleteLoadBalancerListenersRequest deleteLoadBalancerListenersRequest) Deletes the specified listeners from the specified load balancer.
DeleteLoadBalancerPolicyResult	deleteLoadBalancerPolicy(DeleteLoadBalancerPolicyRequest deleteLoadBalancerPolicyRequest) Deletes the specified policy from the specified load balancer.
DeregisterInstancesFromLoadBalancerResult	deregisterInstancesFromLoadBalancer(DeregisterInstancesFromLoadBalancerRequest deregisterInstancesFromLoadBalancerRequest) Deregisters the specified instances from the specified load balancer.
DescribeInstanceHealthResult	describeInstanceHealth(DescribeInstanceHealthRequest describeInstanceHealthRequest) Describes the state of the specified instances with respect to the specified load balancer.
DescribeLoadBalancerAttributesResult	describeLoadBalancerAttributes(DescribeLoadBalancerAttributesRequest describeLoadBalancerAttributesRequest) Describes the attributes for the specified load balancer.
DescribeLoadBalancerPoliciesResult	describeLoadBalancerPolicies() Describes the specified policies.
DescribeLoadBalancerPoliciesResult	describeLoadBalancerPolicies(DescribeLoadBalancerPoliciesRequest describeLoadBalancerPoliciesRequest) Describes the specified policies.
DescribeLoadBalancerPolicyTypesResult	describeLoadBalancerPolicyTypes() Describes the specified load balancer policy types.
DescribeLoadBalancerPolicyTypesResult	describeLoadBalancerPolicyTypes(DescribeLoadBalancerPolicyTypesRequest describeLoadBalancerPolicyTypesRequest) Describes the specified load balancer policy types.
DescribeLoadBalancersResult	describeLoadBalancers() Describes the specified the load balancers.
DescribeLoadBalancersResult	describeLoadBalancers(DescribeLoadBalancersRequest describeLoadBalancersRequest) Describes the specified the load balancers.
DescribeTagsResult	describeTags(DescribeTagsRequest describeTagsRequest) Describes the tags associated with the specified load balancers.
DetachLoadBalancerFromSubnetsResult	detachLoadBalancerFromSubnets(DetachLoadBalancerFromSubnetsRequest detachLoadBalancerFromSubnetsRequest) Removes the specified subnets from the set of configured subnets for the load balancer.
DisableAvailabilityZonesForLoadBalancerResult	disableAvailabilityZonesForLoadBalancer(DisableAvailabilityZonesForLoadBalancerRequest disableAvailabilityZonesForLoadBalancerRequest) Removes the specified Availability Zones from the set of Availability Zones for the specified load balancer.
EnableAvailabilityZonesForLoadBalancerResult	enableAvailabilityZonesForLoadBalancer(EnableAvailabilityZonesForLoadBalancerRequest enableAvailabilityZonesForLoadBalancerRequest) Adds the specified Availability Zones to the set of Availability Zones for the specified 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 the specified load balancer.
RegisterInstancesWithLoadBalancerResult	registerInstancesWithLoadBalancer(RegisterInstancesWithLoadBalancerRequest registerInstancesWithLoadBalancerRequest) Adds the specified instances to the specified load balancer.
RemoveTagsResult	removeTags(RemoveTagsRequest removeTagsRequest) Removes one or more tags from the specified load balancer.
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 set of policies associated with the specified 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 for the specified load balancer.
void	setRegion(Region region) An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls.
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

This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

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.

setRegion

void setRegion(Region region)
               throws IllegalArgumentException

An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.

By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the ClientConfiguration supplied at construction.

This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

Parameters:

region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions) for accessing a given region.

Throws:

IllegalArgumentException - If the given region is null, or if this service isn't available in the given region. See Region.isServiceSupported(String)

See Also:

Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)

describeLoadBalancerPolicyTypes

DescribeLoadBalancerPolicyTypesResult describeLoadBalancerPolicyTypes(DescribeLoadBalancerPolicyTypesRequest describeLoadBalancerPolicyTypesRequest)
                                                                      throws AmazonServiceException,
                                                                             AmazonClientException

Describes the specified load balancer policy types.

You can use these policy types with CreateLoadBalancerPolicy to create policy configurations for a load balancer.

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

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

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

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 the specified subnets from the set of configured subnets for the load balancer.

After a subnet is removed, all EC2 instances registered with the load balancer in the removed subnet go into the OutOfService state. Then, the load balancer balances the traffic among the remaining routable subnets.

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.

addTags

AddTagsResult addTags(AddTagsRequest addTagsRequest)
                      throws AmazonServiceException,
                             AmazonClientException

Adds the specified tags to the specified load balancer. Each load balancer can have a maximum of 10 tags.

Each tag consists of a key and an optional value. If a tag with the same key is already associated with the load balancer, AddTags updates its value.

For more information, see Tag Your Load Balancer in the Elastic Load Balancing Developer Guide .

Parameters:

addTagsRequest - Container for the necessary parameters to execute the AddTags service method on AmazonElasticLoadBalancing.

Returns:

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

Throws:

TooManyTagsException

DuplicateTagKeysException

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

ModifyLoadBalancerAttributesResult modifyLoadBalancerAttributes(ModifyLoadBalancerAttributesRequest modifyLoadBalancerAttributesRequest)
                                                                throws AmazonServiceException,
                                                                       AmazonClientException

Modifies the attributes of the specified load balancer.

You can modify the load balancer attributes, such as AccessLogs , ConnectionDraining , and CrossZoneLoadBalancing by either enabling or disabling them. Or, you can modify the load balancer attribute ConnectionSettings by specifying an idle connection timeout value for your load balancer.

For more information, see the following in the Elastic Load Balancing Developer Guide :

• Cross-Zone Load Balancing
• Connection Draining
• Access Logs
• Idle Connection Timeout

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

void createLoadBalancerListeners(CreateLoadBalancerListenersRequest createLoadBalancerListenersRequest)
                                 throws AmazonServiceException,
                                        AmazonClientException

Creates one or more listeners for the specified load balancer. If a listener with the specified port does not already exist, it is 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 .

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

void deleteLoadBalancerListeners(DeleteLoadBalancerListenersRequest deleteLoadBalancerListenersRequest)
                                 throws AmazonServiceException,
                                        AmazonClientException

Deletes the specified listeners from the specified load balancer.

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

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, AWSELB , 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.

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

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

ApplySecurityGroupsToLoadBalancerResult applySecurityGroupsToLoadBalancer(ApplySecurityGroupsToLoadBalancerRequest applySecurityGroupsToLoadBalancerRequest)
                                                                          throws AmazonServiceException,
                                                                                 AmazonClientException

Associates one or more security groups with your load balancer in a virtual private cloud (VPC). The specified security groups override the previously associated security groups.

For more information, see Security Groups for Load Balancers in a VPC in the Elastic Load Balancing Developer Guide .

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

DescribeLoadBalancerPoliciesResult describeLoadBalancerPolicies(DescribeLoadBalancerPoliciesRequest describeLoadBalancerPoliciesRequest)
                                                                throws AmazonServiceException,
                                                                       AmazonClientException

Describes the specified policies.

If you specify a load balancer name, the action returns the descriptions of all 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 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 for the specified load balancer. 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 Availability Zones from the set of Availability Zones for the specified load balancer.

There must be at least one Availability Zone registered with a load balancer at all times. After an Availability Zone is removed, all instances registered with the load balancer that are in the removed Availability Zone go into the OutOfService state. Then, the load balancer attempts to equally balance the traffic among its remaining Availability Zones.

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

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

Describes the state of the specified instances with respect to the specified load balancer. If no instances are specified, the call describes the state of all instances that are currently registered with the load balancer. If instances are specified, their state is returned even if they are no longer registered with the load balancer. The state of terminated instances is not returned.

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 the specified policy from the specified load balancer. This 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.

describeTags

DescribeTagsResult describeTags(DescribeTagsRequest describeTagsRequest)
                                throws AmazonServiceException,
                                       AmazonClientException

Describes the tags associated with the specified load balancers.

Parameters:

describeTagsRequest - Container for the necessary parameters to execute the DescribeTags service method on AmazonElasticLoadBalancing.

Returns:

The response from the DescribeTags 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.

createLoadBalancerPolicy

CreateLoadBalancerPolicyResult createLoadBalancerPolicy(CreateLoadBalancerPolicyRequest createLoadBalancerPolicyRequest)
                                                        throws AmazonServiceException,
                                                               AmazonClientException

Creates a policy with the specified attributes for the specified load balancer.

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

removeTags

RemoveTagsResult removeTags(RemoveTagsRequest removeTagsRequest)
                            throws AmazonServiceException,
                                   AmazonClientException

Removes one or more tags from the specified load balancer.

Parameters:

removeTagsRequest - Container for the necessary parameters to execute the RemoveTags service method on AmazonElasticLoadBalancing.

Returns:

The response from the RemoveTags 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.

enableAvailabilityZonesForLoadBalancer

EnableAvailabilityZonesForLoadBalancerResult enableAvailabilityZonesForLoadBalancer(EnableAvailabilityZonesForLoadBalancerRequest enableAvailabilityZonesForLoadBalancerRequest)
                                                                                    throws AmazonServiceException,
                                                                                           AmazonClientException

Adds the specified Availability Zones to the set of Availability Zones for the specified load balancer.

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

For more information, see Add Availability Zone in the Elastic Load Balancing Developer Guide .

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

void deleteLoadBalancer(DeleteLoadBalancerRequest deleteLoadBalancerRequest)
                        throws AmazonServiceException,
                               AmazonClientException

Deletes the specified load balancer.

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

If the load balancer does not exist or has already been deleted, the call to 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.

createLoadBalancer

CreateLoadBalancerResult createLoadBalancer(CreateLoadBalancerRequest createLoadBalancerRequest)
                                            throws AmazonServiceException,
                                                   AmazonClientException

Creates a load balancer.

If the call completes successfully, a new load balancer is created with a unique Domain Name Service (DNS) name. The load balancer receives incoming traffic and routes it to the registered instances. For more information, see How Elastic Load Balancing Works in the Elastic Load Balancing Developer Guide .

You can create up to 20 load balancers per region per account. You can request an increase for the number of load balancers for your account. For more information, see Elastic Load Balancing Limits in the Elastic Load Balancing Developer Guide .

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

TooManyTagsException

InvalidConfigurationRequestException

DuplicateTagKeysException

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

SetLoadBalancerPoliciesForBackendServerResult setLoadBalancerPoliciesForBackendServer(SetLoadBalancerPoliciesForBackendServerRequest setLoadBalancerPoliciesForBackendServerRequest)
                                                                                      throws AmazonServiceException,
                                                                                             AmazonClientException

Replaces the set of policies associated with the specified port on which the back-end server is listening with a new set of policies. 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.

Each time you use SetLoadBalancerPoliciesForBackendServer to enable the policies, use the PolicyNames parameter to list the policies that you want to enable.

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

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

DeregisterInstancesFromLoadBalancerResult deregisterInstancesFromLoadBalancer(DeregisterInstancesFromLoadBalancerRequest deregisterInstancesFromLoadBalancerRequest)
                                                                              throws AmazonServiceException,
                                                                                     AmazonClientException

Deregisters the specified instances from the specified load balancer. After the instance is deregistered, it no longer receives traffic from the load balancer.

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

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

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

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

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

DescribeLoadBalancerAttributesResult describeLoadBalancerAttributes(DescribeLoadBalancerAttributesRequest describeLoadBalancerAttributesRequest)
                                                                    throws AmazonServiceException,
                                                                           AmazonClientException

Describes the attributes for the specified load balancer.

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

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 load balancer implements this policy, the load balancer uses a special cookie to track the back-end 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 Duration-Based Session Stickiness in the Elastic Load Balancing Developer Guide .

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 for the specified load balancer.

The load balancer evenly distributes requests across all registered subnets. For more information, see Add or Remove Subnets for Your Load Balancer in a VPC in the Elastic Load Balancing Developer Guide .

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

RegisterInstancesWithLoadBalancerResult registerInstancesWithLoadBalancer(RegisterInstancesWithLoadBalancerRequest registerInstancesWithLoadBalancerRequest)
                                                                          throws AmazonServiceException,
                                                                                 AmazonClientException

Adds the specified instances to the specified load balancer.

The instance must be a running instance in the same network as the load balancer (EC2-Classic or the same VPC). If you have EC2-Classic instances and a load balancer in a VPC with ClassicLink enabled, you can link the EC2-Classic instances to that VPC and then register the linked EC2-Classic instances with the load balancer in the VPC.

Note that RegisterInstanceWithLoadBalancer completes when the request has been registered. Instance registration takes a little time to complete. To check the state of the registered instances, use DescribeLoadBalancers or DescribeInstanceHealth.

After the instance is registered, it starts receiving traffic and requests from the load balancer. Any instance that is not in one of the Availability Zones registered for the load balancer is moved to the OutOfService state. If an Availability Zone is added to the load balancer later, any instances registered with the load balancer move to the InService state.

If you stop an instance registered with a load balancer and then start it, 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 use the following sequence: stop the instance, deregister the instance, start the instance, and then register the instance. To deregister instances from a load balancer, use DeregisterInstancesFromLoadBalancer.

For more information, see Deregister and Register EC2 Instances in the Elastic Load Balancing Developer Guide .

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

DescribeLoadBalancersResult describeLoadBalancers(DescribeLoadBalancersRequest describeLoadBalancersRequest)
                                                  throws AmazonServiceException,
                                                         AmazonClientException

Describes the specified the load balancers. If no load balancers are specified, the call describes all of your load balancers.

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

Describes the specified load balancer policy types.

You can use these policy types with CreateLoadBalancerPolicy to create policy configurations for a load balancer.

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

Describes the specified policies.

If you specify a load balancer name, the action returns the descriptions of all 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 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

Describes the specified the load balancers. If no load balancers are specified, the call describes all of your load balancers.

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.