public interface AmazonElasticLoadBalancing
A load balancer can distribute incoming traffic across your EC2 instances. This enables you to increase the availability of your application. The load balancer also monitors the health of its registered instances and ensures that it routes traffic only to healthy instances. You configure your load balancer to accept incoming traffic by specifying one or more listeners, which are configured with a protocol and port number for connections from clients to the load balancer and a protocol and port number for connections from the load balancer to the instances.
Elastic Load Balancing supports three types of load balancers: Application Load Balancers, Network Load Balancers, and Classic Load Balancers. You can select a load balancer based on your application needs. For more information, see the Elastic Load Balancing User Guide.
This reference covers the 2012-06-01 API, which supports Classic Load Balancers. The 2015-12-01 API supports Application Load Balancers and Network Load Balancers.
To get started, create a load balancer with one or more listeners using CreateLoadBalancer. Register your instances with the load balancer using RegisterInstancesWithLoadBalancer.
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.
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 EC2 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 Classic Load Balancer.
|
CreateLoadBalancerListenersResult |
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.
|
DeleteLoadBalancerResult |
deleteLoadBalancer(DeleteLoadBalancerRequest deleteLoadBalancerRequest)
Deletes the specified load balancer.
|
DeleteLoadBalancerListenersResult |
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.
|
DescribeAccountLimitsResult |
describeAccountLimits(DescribeAccountLimitsRequest describeAccountLimitsRequest)
Describes the current Elastic Load Balancing resource limits for your AWS
account.
|
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 or all load balancer
policy types.
|
DescribeLoadBalancerPolicyTypesResult |
describeLoadBalancerPolicyTypes(DescribeLoadBalancerPolicyTypesRequest describeLoadBalancerPolicyTypesRequest)
Describes the specified load balancer policy types or all 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 in EC2-Classic or a default VPC.
|
EnableAvailabilityZonesForLoadBalancerResult |
enableAvailabilityZonesForLoadBalancer(EnableAvailabilityZonesForLoadBalancerRequest enableAvailabilityZonesForLoadBalancerRequest)
Adds the specified Availability Zones to the set of Availability Zones
for the specified load balancer in EC2-Classic or a default VPC.
|
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").
|
SetLoadBalancerListenerSSLCertificateResult |
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 EC2 instance is listening with a new set of policies.
|
SetLoadBalancerPoliciesOfListenerResult |
setLoadBalancerPoliciesOfListener(SetLoadBalancerPoliciesOfListenerRequest setLoadBalancerPoliciesOfListenerRequest)
Replaces the current set of policies for the specified load balancer port
with the specified set of policies.
|
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.
|
void setEndpoint(String endpoint) throws IllegalArgumentException
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.
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.IllegalArgumentException
- If any problems are detected with the
specified endpoint.void setRegion(Region region) throws IllegalArgumentException
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.
region
- The region this client will communicate with. See
Region.getRegion(com.amazonaws.regions.Regions)
for
accessing a given region.IllegalArgumentException
- If the given region is null,
or if this service isn't available in the given region. See
Region.isServiceSupported(String)
Region.getRegion(com.amazonaws.regions.Regions)
,
Region.createClient(Class,
com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
AddTagsResult addTags(AddTagsRequest addTagsRequest) throws AmazonClientException, AmazonServiceException
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 Classic Load Balancer in the Classic Load Balancers Guide.
addTagsRequest
- Contains the parameters for AddTags.
LoadBalancerNotFoundException
TooManyTagsException
DuplicateTagKeysException
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 Amazon
Elastic Load Balancing indicating either a problem with the
data in the request, or a server side issue.ApplySecurityGroupsToLoadBalancerResult applySecurityGroupsToLoadBalancer(ApplySecurityGroupsToLoadBalancerRequest applySecurityGroupsToLoadBalancerRequest) throws AmazonClientException, AmazonServiceException
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 Classic Load Balancers Guide.
applySecurityGroupsToLoadBalancerRequest
- Contains the parameters for ApplySecurityGroupsToLoadBalancer.
LoadBalancerNotFoundException
InvalidConfigurationRequestException
InvalidSecurityGroupException
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 Amazon
Elastic Load Balancing indicating either a problem with the
data in the request, or a server side issue.AttachLoadBalancerToSubnetsResult attachLoadBalancerToSubnets(AttachLoadBalancerToSubnetsRequest attachLoadBalancerToSubnetsRequest) throws AmazonClientException, AmazonServiceException
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 Classic Load Balancers Guide.
attachLoadBalancerToSubnetsRequest
- Contains the parameters for AttachLoaBalancerToSubnets.
LoadBalancerNotFoundException
InvalidConfigurationRequestException
SubnetNotFoundException
InvalidSubnetException
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 Amazon
Elastic Load Balancing indicating either a problem with the
data in the request, or a server side issue.ConfigureHealthCheckResult configureHealthCheck(ConfigureHealthCheckRequest configureHealthCheckRequest) throws AmazonClientException, AmazonServiceException
Specifies the health check settings to use when evaluating the health state of your EC2 instances.
For more information, see Configure Health Checks for Your Load Balancer in the Classic Load Balancers Guide.
configureHealthCheckRequest
- Contains the parameters for ConfigureHealthCheck.
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 Amazon
Elastic Load Balancing indicating either a problem with the
data in the request, or a server side issue.CreateAppCookieStickinessPolicyResult createAppCookieStickinessPolicy(CreateAppCookieStickinessPolicyRequest createAppCookieStickinessPolicyRequest) throws AmazonClientException, AmazonServiceException
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 Classic Load Balancers Guide.
createAppCookieStickinessPolicyRequest
- Contains the parameters for CreateAppCookieStickinessPolicy.
LoadBalancerNotFoundException
DuplicatePolicyNameException
TooManyPoliciesException
InvalidConfigurationRequestException
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 Amazon
Elastic Load Balancing indicating either a problem with the
data in the request, or a server side issue.CreateLBCookieStickinessPolicyResult createLBCookieStickinessPolicy(CreateLBCookieStickinessPolicyRequest createLBCookieStickinessPolicyRequest) throws AmazonClientException, AmazonServiceException
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 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 Classic Load Balancers Guide.
createLBCookieStickinessPolicyRequest
- Contains the parameters for CreateLBCookieStickinessPolicy.
LoadBalancerNotFoundException
DuplicatePolicyNameException
TooManyPoliciesException
InvalidConfigurationRequestException
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 Amazon
Elastic Load Balancing indicating either a problem with the
data in the request, or a server side issue.CreateLoadBalancerResult createLoadBalancer(CreateLoadBalancerRequest createLoadBalancerRequest) throws AmazonClientException, AmazonServiceException
Creates a Classic Load Balancer.
You can add listeners, security groups, subnets, and tags when you create your load balancer, or you can add them later using CreateLoadBalancerListeners, ApplySecurityGroupsToLoadBalancer, AttachLoadBalancerToSubnets, and AddTags.
To describe your current load balancers, see DescribeLoadBalancers. When you are finished with a load balancer, you can delete it using DeleteLoadBalancer.
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 Limits for Your Classic Load Balancer in the Classic Load Balancers Guide.
createLoadBalancerRequest
- Contains the parameters for CreateLoadBalancer.
DuplicateLoadBalancerNameException
TooManyLoadBalancersException
CertificateNotFoundException
InvalidConfigurationRequestException
SubnetNotFoundException
InvalidSubnetException
InvalidSecurityGroupException
InvalidSchemeException
TooManyTagsException
DuplicateTagKeysException
UnsupportedProtocolException
OperationNotPermittedException
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 Amazon
Elastic Load Balancing indicating either a problem with the
data in the request, or a server side issue.CreateLoadBalancerListenersResult createLoadBalancerListeners(CreateLoadBalancerListenersRequest createLoadBalancerListenersRequest) throws AmazonClientException, AmazonServiceException
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 Listeners for Your Classic Load Balancer in the Classic Load Balancers Guide.
createLoadBalancerListenersRequest
- Contains the parameters for CreateLoadBalancerListeners.
LoadBalancerNotFoundException
DuplicateListenerException
CertificateNotFoundException
InvalidConfigurationRequestException
UnsupportedProtocolException
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 Amazon
Elastic Load Balancing indicating either a problem with the
data in the request, or a server side issue.CreateLoadBalancerPolicyResult createLoadBalancerPolicy(CreateLoadBalancerPolicyRequest createLoadBalancerPolicyRequest) throws AmazonClientException, AmazonServiceException
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 listener or the application server, depending on the policy type.
createLoadBalancerPolicyRequest
- Contains the parameters for CreateLoadBalancerPolicy.
LoadBalancerNotFoundException
PolicyTypeNotFoundException
DuplicatePolicyNameException
TooManyPoliciesException
InvalidConfigurationRequestException
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 Amazon
Elastic Load Balancing indicating either a problem with the
data in the request, or a server side issue.DeleteLoadBalancerResult deleteLoadBalancer(DeleteLoadBalancerRequest deleteLoadBalancerRequest) throws AmazonClientException, AmazonServiceException
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 your instances.
If the load balancer does not exist or has already been deleted, the call
to DeleteLoadBalancer
still succeeds.
deleteLoadBalancerRequest
- Contains the parameters for DeleteLoadBalancer.
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 Amazon
Elastic Load Balancing indicating either a problem with the
data in the request, or a server side issue.DeleteLoadBalancerListenersResult deleteLoadBalancerListeners(DeleteLoadBalancerListenersRequest deleteLoadBalancerListenersRequest) throws AmazonClientException, AmazonServiceException
Deletes the specified listeners from the specified load balancer.
deleteLoadBalancerListenersRequest
- Contains the parameters for DeleteLoadBalancerListeners.
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 Amazon
Elastic Load Balancing indicating either a problem with the
data in the request, or a server side issue.DeleteLoadBalancerPolicyResult deleteLoadBalancerPolicy(DeleteLoadBalancerPolicyRequest deleteLoadBalancerPolicyRequest) throws AmazonClientException, AmazonServiceException
Deletes the specified policy from the specified load balancer. This policy must not be enabled for any listeners.
deleteLoadBalancerPolicyRequest
- Contains the parameters for DeleteLoadBalancerPolicy.
LoadBalancerNotFoundException
InvalidConfigurationRequestException
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 Amazon
Elastic Load Balancing indicating either a problem with the
data in the request, or a server side issue.DeregisterInstancesFromLoadBalancerResult deregisterInstancesFromLoadBalancer(DeregisterInstancesFromLoadBalancerRequest deregisterInstancesFromLoadBalancerRequest) throws AmazonClientException, AmazonServiceException
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 Register or De-Register EC2 Instances in the Classic Load Balancers Guide.
deregisterInstancesFromLoadBalancerRequest
- Contains the parameters for DeregisterInstancesFromLoadBalancer.
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 Amazon
Elastic Load Balancing indicating either a problem with the
data in the request, or a server side issue.DescribeAccountLimitsResult describeAccountLimits(DescribeAccountLimitsRequest describeAccountLimitsRequest) throws AmazonClientException, AmazonServiceException
Describes the current Elastic Load Balancing resource limits for your AWS account.
For more information, see Limits for Your Classic Load Balancer in the Classic Load Balancers Guide.
describeAccountLimitsRequest
- 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 Amazon
Elastic Load Balancing indicating either a problem with the
data in the request, or a server side issue.DescribeInstanceHealthResult describeInstanceHealth(DescribeInstanceHealthRequest describeInstanceHealthRequest) throws AmazonClientException, AmazonServiceException
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.
describeInstanceHealthRequest
- Contains the parameters for DescribeInstanceHealth.
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 Amazon
Elastic Load Balancing indicating either a problem with the
data in the request, or a server side issue.DescribeLoadBalancerAttributesResult describeLoadBalancerAttributes(DescribeLoadBalancerAttributesRequest describeLoadBalancerAttributesRequest) throws AmazonClientException, AmazonServiceException
Describes the attributes for the specified load balancer.
describeLoadBalancerAttributesRequest
- Contains the parameters for DescribeLoadBalancerAttributes.
LoadBalancerNotFoundException
LoadBalancerAttributeNotFoundException
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 Amazon
Elastic Load Balancing indicating either a problem with the
data in the request, or a server side issue.DescribeLoadBalancerPoliciesResult describeLoadBalancerPolicies(DescribeLoadBalancerPoliciesRequest describeLoadBalancerPoliciesRequest) throws AmazonClientException, AmazonServiceException
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.
describeLoadBalancerPoliciesRequest
- Contains the parameters for DescribeLoadBalancerPolicies.
LoadBalancerNotFoundException
PolicyNotFoundException
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 Amazon
Elastic Load Balancing indicating either a problem with the
data in the request, or a server side issue.DescribeLoadBalancerPolicyTypesResult describeLoadBalancerPolicyTypes(DescribeLoadBalancerPolicyTypesRequest describeLoadBalancerPolicyTypesRequest) throws AmazonClientException, AmazonServiceException
Describes the specified load balancer policy types or all load balancer policy types.
The description of each type indicates how it can be used. For example, some policies can be used only with layer 7 listeners, some policies can be used only with layer 4 listeners, and some policies can be used only with your EC2 instances.
You can use CreateLoadBalancerPolicy to create a policy configuration for any of these policy types. Then, depending on the policy type, use either SetLoadBalancerPoliciesOfListener or SetLoadBalancerPoliciesForBackendServer to set the policy.
describeLoadBalancerPolicyTypesRequest
- Contains the parameters for DescribeLoadBalancerPolicyTypes.
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 Amazon
Elastic Load Balancing indicating either a problem with the
data in the request, or a server side issue.DescribeLoadBalancersResult describeLoadBalancers(DescribeLoadBalancersRequest describeLoadBalancersRequest) throws AmazonClientException, AmazonServiceException
Describes the specified the load balancers. If no load balancers are specified, the call describes all of your load balancers.
describeLoadBalancersRequest
- Contains the parameters for DescribeLoadBalancers.
LoadBalancerNotFoundException
DependencyThrottleException
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 Amazon
Elastic Load Balancing indicating either a problem with the
data in the request, or a server side issue.DescribeTagsResult describeTags(DescribeTagsRequest describeTagsRequest) throws AmazonClientException, AmazonServiceException
Describes the tags associated with the specified load balancers.
describeTagsRequest
- Contains the parameters for DescribeTags.
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 Amazon
Elastic Load Balancing indicating either a problem with the
data in the request, or a server side issue.DetachLoadBalancerFromSubnetsResult detachLoadBalancerFromSubnets(DetachLoadBalancerFromSubnetsRequest detachLoadBalancerFromSubnetsRequest) throws AmazonClientException, AmazonServiceException
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.
detachLoadBalancerFromSubnetsRequest
- Contains the parameters for DetachLoadBalancerFromSubnets.
LoadBalancerNotFoundException
InvalidConfigurationRequestException
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 Amazon
Elastic Load Balancing indicating either a problem with the
data in the request, or a server side issue.DisableAvailabilityZonesForLoadBalancerResult disableAvailabilityZonesForLoadBalancer(DisableAvailabilityZonesForLoadBalancerRequest disableAvailabilityZonesForLoadBalancerRequest) throws AmazonClientException, AmazonServiceException
Removes the specified Availability Zones from the set of Availability Zones for the specified load balancer in EC2-Classic or a default VPC.
For load balancers in a non-default VPC, use DetachLoadBalancerFromSubnets.
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 Add or Remove Availability Zones in the Classic Load Balancers Guide.
disableAvailabilityZonesForLoadBalancerRequest
- Contains the parameters for DisableAvailabilityZonesForLoadBalancer.
LoadBalancerNotFoundException
InvalidConfigurationRequestException
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 Amazon
Elastic Load Balancing indicating either a problem with the
data in the request, or a server side issue.EnableAvailabilityZonesForLoadBalancerResult enableAvailabilityZonesForLoadBalancer(EnableAvailabilityZonesForLoadBalancerRequest enableAvailabilityZonesForLoadBalancerRequest) throws AmazonClientException, AmazonServiceException
Adds the specified Availability Zones to the set of Availability Zones for the specified load balancer in EC2-Classic or a default VPC.
For load balancers in a non-default VPC, use AttachLoadBalancerToSubnets.
The load balancer evenly distributes requests across all its registered Availability Zones that contain instances. For more information, see Add or Remove Availability Zones in the Classic Load Balancers Guide.
enableAvailabilityZonesForLoadBalancerRequest
- Contains the parameters for EnableAvailabilityZonesForLoadBalancer.
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 Amazon
Elastic Load Balancing indicating either a problem with the
data in the request, or a server side issue.ModifyLoadBalancerAttributesResult modifyLoadBalancerAttributes(ModifyLoadBalancerAttributesRequest modifyLoadBalancerAttributesRequest) throws AmazonClientException, AmazonServiceException
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 Classic Load Balancers Guide:
modifyLoadBalancerAttributesRequest
- Contains the parameters for ModifyLoadBalancerAttributes.
LoadBalancerNotFoundException
LoadBalancerAttributeNotFoundException
InvalidConfigurationRequestException
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 Amazon
Elastic Load Balancing indicating either a problem with the
data in the request, or a server side issue.RegisterInstancesWithLoadBalancerResult registerInstancesWithLoadBalancer(RegisterInstancesWithLoadBalancerRequest registerInstancesWithLoadBalancerRequest) throws AmazonClientException, AmazonServiceException
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.
To deregister instances from a load balancer, use DeregisterInstancesFromLoadBalancer.
For more information, see Register or De-Register EC2 Instances in the Classic Load Balancers Guide.
registerInstancesWithLoadBalancerRequest
- Contains the parameters for RegisterInstancesWithLoadBalancer.
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 Amazon
Elastic Load Balancing indicating either a problem with the
data in the request, or a server side issue.RemoveTagsResult removeTags(RemoveTagsRequest removeTagsRequest) throws AmazonClientException, AmazonServiceException
Removes one or more tags from the specified load balancer.
removeTagsRequest
- Contains the parameters for RemoveTags.
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 Amazon
Elastic Load Balancing indicating either a problem with the
data in the request, or a server side issue.SetLoadBalancerListenerSSLCertificateResult setLoadBalancerListenerSSLCertificate(SetLoadBalancerListenerSSLCertificateRequest setLoadBalancerListenerSSLCertificateRequest) throws AmazonClientException, AmazonServiceException
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 Replace the SSL Certificate for Your Load Balancer in the Classic Load Balancers Guide.
setLoadBalancerListenerSSLCertificateRequest
- Contains the parameters for SetLoadBalancerListenerSSLCertificate.
CertificateNotFoundException
LoadBalancerNotFoundException
ListenerNotFoundException
InvalidConfigurationRequestException
UnsupportedProtocolException
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 Amazon
Elastic Load Balancing indicating either a problem with the
data in the request, or a server side issue.SetLoadBalancerPoliciesForBackendServerResult setLoadBalancerPoliciesForBackendServer(SetLoadBalancerPoliciesForBackendServerRequest setLoadBalancerPoliciesForBackendServerRequest) throws AmazonClientException, AmazonServiceException
Replaces the set of policies associated with the specified port on which the EC2 instance is listening with a new set of policies. At this time, only the back-end server authentication policy type can be applied to the instance 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 EC2 instance.
For more information about enabling back-end instance authentication, see Configure Back-end Instance Authentication in the Classic Load Balancers Guide. For more information about Proxy Protocol, see Configure Proxy Protocol Support in the Classic Load Balancers Guide.
setLoadBalancerPoliciesForBackendServerRequest
- Contains the parameters for SetLoadBalancerPoliciesForBackendServer.
LoadBalancerNotFoundException
PolicyNotFoundException
InvalidConfigurationRequestException
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 Amazon
Elastic Load Balancing indicating either a problem with the
data in the request, or a server side issue.SetLoadBalancerPoliciesOfListenerResult setLoadBalancerPoliciesOfListener(SetLoadBalancerPoliciesOfListenerRequest setLoadBalancerPoliciesOfListenerRequest) throws AmazonClientException, AmazonServiceException
Replaces the current set of policies for the specified load balancer port with the specified set of policies.
To enable back-end server authentication, use SetLoadBalancerPoliciesForBackendServer.
For more information about setting policies, see Update the SSL Negotiation Configuration, Duration-Based Session Stickiness, and Application-Controlled Session Stickiness in the Classic Load Balancers Guide.
setLoadBalancerPoliciesOfListenerRequest
- Contains the parameters for SetLoadBalancePoliciesOfListener.
LoadBalancerNotFoundException
PolicyNotFoundException
ListenerNotFoundException
InvalidConfigurationRequestException
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 Amazon
Elastic Load Balancing indicating either a problem with the
data in the request, or a server side issue.DescribeLoadBalancerPolicyTypesResult describeLoadBalancerPolicyTypes() throws AmazonClientException, AmazonServiceException
Describes the specified load balancer policy types or all load balancer policy types.
The description of each type indicates how it can be used. For example, some policies can be used only with layer 7 listeners, some policies can be used only with layer 4 listeners, and some policies can be used only with your EC2 instances.
You can use CreateLoadBalancerPolicy to create a policy configuration for any of these policy types. Then, depending on the policy type, use either SetLoadBalancerPoliciesOfListener or SetLoadBalancerPoliciesForBackendServer to set the policy.
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 Amazon
Elastic Load Balancing indicating either a problem with the
data in the request, or a server side issue.DescribeLoadBalancerPoliciesResult describeLoadBalancerPolicies() throws AmazonClientException, AmazonServiceException
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.
LoadBalancerNotFoundException
PolicyNotFoundException
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 Amazon
Elastic Load Balancing indicating either a problem with the
data in the request, or a server side issue.DescribeLoadBalancersResult describeLoadBalancers() throws AmazonClientException, AmazonServiceException
Describes the specified the load balancers. If no load balancers are specified, the call describes all of your load balancers.
LoadBalancerNotFoundException
DependencyThrottleException
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 Amazon
Elastic Load Balancing indicating either a problem with the
data in the request, or a server side issue.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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.
request
- The originally executed request.Copyright © 2018. All rights reserved.