com.amazonaws.services.elasticloadbalancing.AmazonElasticLoadBalancing Maven / Gradle / Ivy
Show all versions of aws-sdk-android Show documentation
/*
* Copyright 2010-2015 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
package com.amazonaws.services.elasticloadbalancing;
import com.amazonaws.*;
import com.amazonaws.regions.*;
import com.amazonaws.services.elasticloadbalancing.model.*;
/**
* Interface for accessing AmazonElasticLoadBalancing.
* 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.
*
*/
public interface AmazonElasticLoadBalancing {
/**
* 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
* {@link 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.
*
* @param 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.
*/
public void setEndpoint(String endpoint) throws java.lang.IllegalArgumentException;
/**
* An alternative to {@link AmazonElasticLoadBalancing#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 {@link 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.
*
* @param region
* The region this client will communicate with. See
* {@link Region#getRegion(com.amazonaws.regions.Regions)} for
* accessing a given region.
* @throws java.lang.IllegalArgumentException
* If the given region is null, or if this service isn't
* available in the given region. See
* {@link Region#isServiceSupported(String)}
* @see Region#getRegion(com.amazonaws.regions.Regions)
* @see Region#createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
*/
public void setRegion(Region region) throws java.lang.IllegalArgumentException;
/**
*
* 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.
*
*
* @param describeLoadBalancerPolicyTypesRequest Container for the
* necessary parameters to execute the DescribeLoadBalancerPolicyTypes
* service method on AmazonElasticLoadBalancing.
*
* @return The response from the DescribeLoadBalancerPolicyTypes service
* method, as returned by AmazonElasticLoadBalancing.
*
* @throws PolicyTypeNotFoundException
*
* @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.
* @throws AmazonServiceException
* If an error response is returned by AmazonElasticLoadBalancing indicating
* either a problem with the data in the request, or a server side issue.
*/
public DescribeLoadBalancerPolicyTypesResult describeLoadBalancerPolicyTypes(DescribeLoadBalancerPolicyTypesRequest describeLoadBalancerPolicyTypesRequest)
throws AmazonServiceException, AmazonClientException;
/**
*
* 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 .
*
*
* @param configureHealthCheckRequest Container for the necessary
* parameters to execute the ConfigureHealthCheck service method on
* AmazonElasticLoadBalancing.
*
* @return The response from the ConfigureHealthCheck service method, as
* returned by AmazonElasticLoadBalancing.
*
* @throws LoadBalancerNotFoundException
*
* @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.
* @throws AmazonServiceException
* If an error response is returned by AmazonElasticLoadBalancing indicating
* either a problem with the data in the request, or a server side issue.
*/
public ConfigureHealthCheckResult configureHealthCheck(ConfigureHealthCheckRequest configureHealthCheckRequest)
throws AmazonServiceException, AmazonClientException;
/**
*
* 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.
*
*
* @param detachLoadBalancerFromSubnetsRequest Container for the
* necessary parameters to execute the DetachLoadBalancerFromSubnets
* service method on AmazonElasticLoadBalancing.
*
* @return The response from the DetachLoadBalancerFromSubnets service
* method, as returned by AmazonElasticLoadBalancing.
*
* @throws InvalidConfigurationRequestException
* @throws LoadBalancerNotFoundException
*
* @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.
* @throws AmazonServiceException
* If an error response is returned by AmazonElasticLoadBalancing indicating
* either a problem with the data in the request, or a server side issue.
*/
public DetachLoadBalancerFromSubnetsResult detachLoadBalancerFromSubnets(DetachLoadBalancerFromSubnetsRequest detachLoadBalancerFromSubnetsRequest)
throws AmazonServiceException, AmazonClientException;
/**
*
* Modifies the attributes of a specified load balancer.
*
*
* You can modify the load balancer attributes, such as
* AccessLogs , ConnectionDraining , and
* CrossZoneLoadBalancing by either enabling or disabling
* them.
*
*
* For information on cross-zone load balancing, see Request
* Routing and for information on connection draining, see
* Connection Draining in the
* Concepts section of the Elastic Load Balancer Developer Guide . For information on access logs, see Access Logs
* .
*
*
* @param modifyLoadBalancerAttributesRequest Container for the necessary
* parameters to execute the ModifyLoadBalancerAttributes service method
* on AmazonElasticLoadBalancing.
*
* @return The response from the ModifyLoadBalancerAttributes service
* method, as returned by AmazonElasticLoadBalancing.
*
* @throws InvalidConfigurationRequestException
* @throws LoadBalancerAttributeNotFoundException
* @throws LoadBalancerNotFoundException
*
* @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.
* @throws AmazonServiceException
* If an error response is returned by AmazonElasticLoadBalancing indicating
* either a problem with the data in the request, or a server side issue.
*/
public ModifyLoadBalancerAttributesResult modifyLoadBalancerAttributes(ModifyLoadBalancerAttributesRequest modifyLoadBalancerAttributesRequest)
throws AmazonServiceException, AmazonClientException;
/**
*
* 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 .
*
*
* @param createLoadBalancerListenersRequest Container for the necessary
* parameters to execute the CreateLoadBalancerListeners service method
* on AmazonElasticLoadBalancing.
*
*
* @throws InvalidConfigurationRequestException
* @throws DuplicateListenerException
* @throws CertificateNotFoundException
* @throws LoadBalancerNotFoundException
*
* @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.
* @throws AmazonServiceException
* If an error response is returned by AmazonElasticLoadBalancing indicating
* either a problem with the data in the request, or a server side issue.
*/
public void createLoadBalancerListeners(CreateLoadBalancerListenersRequest createLoadBalancerListenersRequest)
throws AmazonServiceException, AmazonClientException;
/**
*
* Deletes listeners from the load balancer for the specified port.
*
*
* @param deleteLoadBalancerListenersRequest Container for the necessary
* parameters to execute the DeleteLoadBalancerListeners service method
* on AmazonElasticLoadBalancing.
*
*
* @throws LoadBalancerNotFoundException
*
* @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.
* @throws AmazonServiceException
* If an error response is returned by AmazonElasticLoadBalancing indicating
* either a problem with the data in the request, or a server side issue.
*/
public void deleteLoadBalancerListeners(DeleteLoadBalancerListenersRequest deleteLoadBalancerListenersRequest)
throws AmazonServiceException, AmazonClientException;
/**
*
* Generates a stickiness policy with sticky session lifetimes that
* follow that of an application-generated cookie. This policy can be
* associated only with HTTP/HTTPS listeners.
*
*
* This policy is similar to the policy created by
* CreateLBCookieStickinessPolicy, except that the lifetime of the
* special Elastic Load Balancing cookie follows the lifetime of the
* application-generated cookie specified in the policy configuration.
* The 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 .
*
*
* @param createAppCookieStickinessPolicyRequest Container for the
* necessary parameters to execute the CreateAppCookieStickinessPolicy
* service method on AmazonElasticLoadBalancing.
*
* @return The response from the CreateAppCookieStickinessPolicy service
* method, as returned by AmazonElasticLoadBalancing.
*
* @throws InvalidConfigurationRequestException
* @throws DuplicatePolicyNameException
* @throws TooManyPoliciesException
* @throws LoadBalancerNotFoundException
*
* @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.
* @throws AmazonServiceException
* If an error response is returned by AmazonElasticLoadBalancing indicating
* either a problem with the data in the request, or a server side issue.
*/
public CreateAppCookieStickinessPolicyResult createAppCookieStickinessPolicy(CreateAppCookieStickinessPolicyRequest createAppCookieStickinessPolicyRequest)
throws AmazonServiceException, AmazonClientException;
/**
*
* 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 .
*
*
* @param applySecurityGroupsToLoadBalancerRequest Container for the
* necessary parameters to execute the ApplySecurityGroupsToLoadBalancer
* service method on AmazonElasticLoadBalancing.
*
* @return The response from the ApplySecurityGroupsToLoadBalancer
* service method, as returned by AmazonElasticLoadBalancing.
*
* @throws InvalidConfigurationRequestException
* @throws InvalidSecurityGroupException
* @throws LoadBalancerNotFoundException
*
* @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.
* @throws AmazonServiceException
* If an error response is returned by AmazonElasticLoadBalancing indicating
* either a problem with the data in the request, or a server side issue.
*/
public ApplySecurityGroupsToLoadBalancerResult applySecurityGroupsToLoadBalancer(ApplySecurityGroupsToLoadBalancerRequest applySecurityGroupsToLoadBalancerRequest)
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.
*
*
* @param describeLoadBalancerPoliciesRequest Container for the necessary
* parameters to execute the DescribeLoadBalancerPolicies service method
* on AmazonElasticLoadBalancing.
*
* @return The response from the DescribeLoadBalancerPolicies service
* method, as returned by AmazonElasticLoadBalancing.
*
* @throws PolicyNotFoundException
* @throws LoadBalancerNotFoundException
*
* @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.
* @throws AmazonServiceException
* If an error response is returned by AmazonElasticLoadBalancing indicating
* either a problem with the data in the request, or a server side issue.
*/
public DescribeLoadBalancerPoliciesResult describeLoadBalancerPolicies(DescribeLoadBalancerPoliciesRequest describeLoadBalancerPoliciesRequest)
throws AmazonServiceException, AmazonClientException;
/**
*
* Associates, updates, or disables a policy with a listener on the load
* balancer. You can associate multiple policies with a listener.
*
*
* @param setLoadBalancerPoliciesOfListenerRequest Container for the
* necessary parameters to execute the SetLoadBalancerPoliciesOfListener
* service method on AmazonElasticLoadBalancing.
*
* @return The response from the SetLoadBalancerPoliciesOfListener
* service method, as returned by AmazonElasticLoadBalancing.
*
* @throws PolicyNotFoundException
* @throws InvalidConfigurationRequestException
* @throws LoadBalancerNotFoundException
* @throws ListenerNotFoundException
*
* @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.
* @throws AmazonServiceException
* If an error response is returned by AmazonElasticLoadBalancing indicating
* either a problem with the data in the request, or a server side issue.
*/
public SetLoadBalancerPoliciesOfListenerResult setLoadBalancerPoliciesOfListener(SetLoadBalancerPoliciesOfListenerRequest setLoadBalancerPoliciesOfListenerRequest)
throws AmazonServiceException, AmazonClientException;
/**
*
* 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 .
*
*
* @param disableAvailabilityZonesForLoadBalancerRequest Container for
* the necessary parameters to execute the
* DisableAvailabilityZonesForLoadBalancer service method on
* AmazonElasticLoadBalancing.
*
* @return The response from the DisableAvailabilityZonesForLoadBalancer
* service method, as returned by AmazonElasticLoadBalancing.
*
* @throws InvalidConfigurationRequestException
* @throws LoadBalancerNotFoundException
*
* @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.
* @throws AmazonServiceException
* If an error response is returned by AmazonElasticLoadBalancing indicating
* either a problem with the data in the request, or a server side issue.
*/
public DisableAvailabilityZonesForLoadBalancerResult disableAvailabilityZonesForLoadBalancer(DisableAvailabilityZonesForLoadBalancerRequest disableAvailabilityZonesForLoadBalancerRequest)
throws AmazonServiceException, AmazonClientException;
/**
*
* 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.
*
*
* @param describeInstanceHealthRequest Container for the necessary
* parameters to execute the DescribeInstanceHealth service method on
* AmazonElasticLoadBalancing.
*
* @return The response from the DescribeInstanceHealth service method,
* as returned by AmazonElasticLoadBalancing.
*
* @throws LoadBalancerNotFoundException
* @throws InvalidInstanceException
*
* @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.
* @throws AmazonServiceException
* If an error response is returned by AmazonElasticLoadBalancing indicating
* either a problem with the data in the request, or a server side issue.
*/
public DescribeInstanceHealthResult describeInstanceHealth(DescribeInstanceHealthRequest describeInstanceHealthRequest)
throws AmazonServiceException, AmazonClientException;
/**
*
* Deletes a policy from the load balancer. The specified policy must
* not be enabled for any listeners.
*
*
* @param deleteLoadBalancerPolicyRequest Container for the necessary
* parameters to execute the DeleteLoadBalancerPolicy service method on
* AmazonElasticLoadBalancing.
*
* @return The response from the DeleteLoadBalancerPolicy service method,
* as returned by AmazonElasticLoadBalancing.
*
* @throws InvalidConfigurationRequestException
* @throws LoadBalancerNotFoundException
*
* @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.
* @throws AmazonServiceException
* If an error response is returned by AmazonElasticLoadBalancing indicating
* either a problem with the data in the request, or a server side issue.
*/
public DeleteLoadBalancerPolicyResult deleteLoadBalancerPolicy(DeleteLoadBalancerPolicyRequest deleteLoadBalancerPolicyRequest)
throws AmazonServiceException, AmazonClientException;
/**
*
* Creates a new policy that contains the necessary attributes depending
* on the policy type. Policies are settings that are saved for your load
* balancer and that can be applied to the front-end listener, or the
* back-end application server, depending on your policy type.
*
*
* @param createLoadBalancerPolicyRequest Container for the necessary
* parameters to execute the CreateLoadBalancerPolicy service method on
* AmazonElasticLoadBalancing.
*
* @return The response from the CreateLoadBalancerPolicy service method,
* as returned by AmazonElasticLoadBalancing.
*
* @throws PolicyTypeNotFoundException
* @throws InvalidConfigurationRequestException
* @throws DuplicatePolicyNameException
* @throws TooManyPoliciesException
* @throws LoadBalancerNotFoundException
*
* @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.
* @throws AmazonServiceException
* If an error response is returned by AmazonElasticLoadBalancing indicating
* either a problem with the data in the request, or a server side issue.
*/
public CreateLoadBalancerPolicyResult createLoadBalancerPolicy(CreateLoadBalancerPolicyRequest createLoadBalancerPolicyRequest)
throws AmazonServiceException, AmazonClientException;
/**
*
* 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 .
*
*
* @param enableAvailabilityZonesForLoadBalancerRequest Container for the
* necessary parameters to execute the
* EnableAvailabilityZonesForLoadBalancer service method on
* AmazonElasticLoadBalancing.
*
* @return The response from the EnableAvailabilityZonesForLoadBalancer
* service method, as returned by AmazonElasticLoadBalancing.
*
* @throws LoadBalancerNotFoundException
*
* @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.
* @throws AmazonServiceException
* If an error response is returned by AmazonElasticLoadBalancing indicating
* either a problem with the data in the request, or a server side issue.
*/
public EnableAvailabilityZonesForLoadBalancerResult enableAvailabilityZonesForLoadBalancer(EnableAvailabilityZonesForLoadBalancerRequest enableAvailabilityZonesForLoadBalancerRequest)
throws AmazonServiceException, AmazonClientException;
/**
*
* 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.
*
*
* @param 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.
* @throws AmazonServiceException
* If an error response is returned by AmazonElasticLoadBalancing indicating
* either a problem with the data in the request, or a server side issue.
*/
public void deleteLoadBalancer(DeleteLoadBalancerRequest deleteLoadBalancerRequest)
throws AmazonServiceException, AmazonClientException;
/**
*
* 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:
*
*
*
* - us-east-1.elb.amazonaws.com (for the Northern Virginia
* Region)
* - us-west-1.elb.amazonaws.com (for the Northern California
* Region)
*
*
*
* For information about the AWS regions supported by Elastic Load
* Balancing, see
* Regions and Endpoints
* .
*
*
* You can create up to 20 load balancers per region per account.
*
*
* Elastic Load Balancing supports load balancing your Amazon EC2
* instances launched within any one of the following platforms:
*
*
*
* - EC2-Classic
* For information on creating and managing your load balancers in
* EC2-Classic, see
* Deploy Elastic Load Balancing in Amazon EC2-Classic
* .
*
*
* - EC2-VPC
* For information on creating and managing your load balancers in
* EC2-VPC, see
* Deploy Elastic Load Balancing in Amazon VPC
* .
*
*
*
*
*
* @param createLoadBalancerRequest Container for the necessary
* parameters to execute the CreateLoadBalancer service method on
* AmazonElasticLoadBalancing.
*
* @return The response from the CreateLoadBalancer service method, as
* returned by AmazonElasticLoadBalancing.
*
* @throws InvalidSubnetException
* @throws InvalidConfigurationRequestException
* @throws InvalidSecurityGroupException
* @throws CertificateNotFoundException
* @throws InvalidSchemeException
* @throws DuplicateLoadBalancerNameException
* @throws TooManyLoadBalancersException
* @throws SubnetNotFoundException
*
* @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.
* @throws AmazonServiceException
* If an error response is returned by AmazonElasticLoadBalancing indicating
* either a problem with the data in the request, or a server side issue.
*/
public CreateLoadBalancerResult createLoadBalancer(CreateLoadBalancerRequest createLoadBalancerRequest)
throws AmazonServiceException, AmazonClientException;
/**
*
* Replaces the current set of policies associated with a port on which
* the back-end server is listening with a new set of policies. After the
* policies have been created using CreateLoadBalancerPolicy, they can be
* applied here as a list. At this time, only the back-end server
* authentication policy type can be applied to the back-end ports; this
* policy type is composed of multiple public key policies.
*
*
* 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.
*
*
* @param setLoadBalancerPoliciesForBackendServerRequest Container for
* the necessary parameters to execute the
* SetLoadBalancerPoliciesForBackendServer service method on
* AmazonElasticLoadBalancing.
*
* @return The response from the SetLoadBalancerPoliciesForBackendServer
* service method, as returned by AmazonElasticLoadBalancing.
*
* @throws PolicyNotFoundException
* @throws InvalidConfigurationRequestException
* @throws LoadBalancerNotFoundException
*
* @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.
* @throws AmazonServiceException
* If an error response is returned by AmazonElasticLoadBalancing indicating
* either a problem with the data in the request, or a server side issue.
*/
public SetLoadBalancerPoliciesForBackendServerResult setLoadBalancerPoliciesForBackendServer(SetLoadBalancerPoliciesForBackendServerRequest setLoadBalancerPoliciesForBackendServerRequest)
throws AmazonServiceException, AmazonClientException;
/**
*
* 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.
*
*
* @param deregisterInstancesFromLoadBalancerRequest Container for the
* necessary parameters to execute the
* DeregisterInstancesFromLoadBalancer service method on
* AmazonElasticLoadBalancing.
*
* @return The response from the DeregisterInstancesFromLoadBalancer
* service method, as returned by AmazonElasticLoadBalancing.
*
* @throws LoadBalancerNotFoundException
* @throws InvalidInstanceException
*
* @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.
* @throws AmazonServiceException
* If an error response is returned by AmazonElasticLoadBalancing indicating
* either a problem with the data in the request, or a server side issue.
*/
public DeregisterInstancesFromLoadBalancerResult deregisterInstancesFromLoadBalancer(DeregisterInstancesFromLoadBalancerRequest deregisterInstancesFromLoadBalancerRequest)
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 on updating your SSL certificate, see
* Updating an SSL Certificate for a Load Balancer
* in the Elastic Load Balancing Developer Guide .
*
*
* @param setLoadBalancerListenerSSLCertificateRequest Container for the
* necessary parameters to execute the
* SetLoadBalancerListenerSSLCertificate service method on
* AmazonElasticLoadBalancing.
*
*
* @throws InvalidConfigurationRequestException
* @throws CertificateNotFoundException
* @throws LoadBalancerNotFoundException
* @throws ListenerNotFoundException
*
* @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.
* @throws AmazonServiceException
* If an error response is returned by AmazonElasticLoadBalancing indicating
* either a problem with the data in the request, or a server side issue.
*/
public void setLoadBalancerListenerSSLCertificate(SetLoadBalancerListenerSSLCertificateRequest setLoadBalancerListenerSSLCertificateRequest)
throws AmazonServiceException, AmazonClientException;
/**
*
* Returns detailed information about all of the attributes associated
* with the specified load balancer.
*
*
* @param describeLoadBalancerAttributesRequest Container for the
* necessary parameters to execute the DescribeLoadBalancerAttributes
* service method on AmazonElasticLoadBalancing.
*
* @return The response from the DescribeLoadBalancerAttributes service
* method, as returned by AmazonElasticLoadBalancing.
*
* @throws LoadBalancerAttributeNotFoundException
* @throws LoadBalancerNotFoundException
*
* @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.
* @throws AmazonServiceException
* If an error response is returned by AmazonElasticLoadBalancing indicating
* either a problem with the data in the request, or a server side issue.
*/
public DescribeLoadBalancerAttributesResult describeLoadBalancerAttributes(DescribeLoadBalancerAttributesRequest describeLoadBalancerAttributesRequest)
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 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 .
*
*
* @param createLBCookieStickinessPolicyRequest Container for the
* necessary parameters to execute the CreateLBCookieStickinessPolicy
* service method on AmazonElasticLoadBalancing.
*
* @return The response from the CreateLBCookieStickinessPolicy service
* method, as returned by AmazonElasticLoadBalancing.
*
* @throws InvalidConfigurationRequestException
* @throws DuplicatePolicyNameException
* @throws TooManyPoliciesException
* @throws LoadBalancerNotFoundException
*
* @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.
* @throws AmazonServiceException
* If an error response is returned by AmazonElasticLoadBalancing indicating
* either a problem with the data in the request, or a server side issue.
*/
public CreateLBCookieStickinessPolicyResult createLBCookieStickinessPolicy(CreateLBCookieStickinessPolicyRequest createLBCookieStickinessPolicyRequest)
throws AmazonServiceException, AmazonClientException;
/**
*
* 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 .
*
*
* @param attachLoadBalancerToSubnetsRequest Container for the necessary
* parameters to execute the AttachLoadBalancerToSubnets service method
* on AmazonElasticLoadBalancing.
*
* @return The response from the AttachLoadBalancerToSubnets service
* method, as returned by AmazonElasticLoadBalancing.
*
* @throws InvalidSubnetException
* @throws InvalidConfigurationRequestException
* @throws LoadBalancerNotFoundException
* @throws SubnetNotFoundException
*
* @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.
* @throws AmazonServiceException
* If an error response is returned by AmazonElasticLoadBalancing indicating
* either a problem with the data in the request, or a server side issue.
*/
public AttachLoadBalancerToSubnetsResult attachLoadBalancerToSubnets(AttachLoadBalancerToSubnetsRequest attachLoadBalancerToSubnetsRequest)
throws AmazonServiceException, AmazonClientException;
/**
*
* 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.
*
*
* @param registerInstancesWithLoadBalancerRequest Container for the
* necessary parameters to execute the RegisterInstancesWithLoadBalancer
* service method on AmazonElasticLoadBalancing.
*
* @return The response from the RegisterInstancesWithLoadBalancer
* service method, as returned by AmazonElasticLoadBalancing.
*
* @throws LoadBalancerNotFoundException
* @throws InvalidInstanceException
*
* @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.
* @throws AmazonServiceException
* If an error response is returned by AmazonElasticLoadBalancing indicating
* either a problem with the data in the request, or a server side issue.
*/
public RegisterInstancesWithLoadBalancerResult registerInstancesWithLoadBalancer(RegisterInstancesWithLoadBalancerRequest registerInstancesWithLoadBalancerRequest)
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.
*
*
* @param describeLoadBalancersRequest Container for the necessary
* parameters to execute the DescribeLoadBalancers service method on
* AmazonElasticLoadBalancing.
*
* @return The response from the DescribeLoadBalancers service method, as
* returned by AmazonElasticLoadBalancing.
*
* @throws LoadBalancerNotFoundException
*
* @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.
* @throws AmazonServiceException
* If an error response is returned by AmazonElasticLoadBalancing indicating
* either a problem with the data in the request, or a server side issue.
*/
public DescribeLoadBalancersResult describeLoadBalancers(DescribeLoadBalancersRequest describeLoadBalancersRequest)
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.
*
*
* @return The response from the DescribeLoadBalancerPolicyTypes service
* method, as returned by AmazonElasticLoadBalancing.
*
* @throws PolicyTypeNotFoundException
*
* @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.
* @throws AmazonServiceException
* If an error response is returned by AmazonElasticLoadBalancing indicating
* either a problem with the data in the request, or a server side issue.
*/
public DescribeLoadBalancerPolicyTypesResult describeLoadBalancerPolicyTypes() 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.
*
*
* @return The response from the DescribeLoadBalancerPolicies service
* method, as returned by AmazonElasticLoadBalancing.
*
* @throws PolicyNotFoundException
* @throws LoadBalancerNotFoundException
*
* @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.
* @throws AmazonServiceException
* If an error response is returned by AmazonElasticLoadBalancing indicating
* either a problem with the data in the request, or a server side issue.
*/
public DescribeLoadBalancerPoliciesResult describeLoadBalancerPolicies() 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.
*
*
* @return The response from the DescribeLoadBalancers service method, as
* returned by AmazonElasticLoadBalancing.
*
* @throws LoadBalancerNotFoundException
*
* @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.
* @throws AmazonServiceException
* If an error response is returned by AmazonElasticLoadBalancing indicating
* either a problem with the data in the request, or a server side issue.
*/
public DescribeLoadBalancersResult describeLoadBalancers() throws AmazonServiceException, AmazonClientException;
/**
* 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.
*/
public void shutdown();
/**
* 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.
*
* @param request
* The originally executed request.
*
* @return The response metadata for the specified request, or null if none
* is available.
*/
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request);
}