public class AmazonElasticLoadBalancingClient extends AmazonWebServiceClient implements AmazonElasticLoadBalancing
Elastic Load Balancing
Elastic Load Balancing is a way to automatically distribute incoming web traffic across applications that run on multiple Amazon Elastic Compute Cloud (Amazon EC2) instances.
You can create, access, and manage Elastic Load Balancing using the AWS Management Console or the Elastic Load Balancing API. For more information about Elastic Load Balancing interfaces, see Accessing Elastic Load Balancing .
This reference guide contains documentation for the Query API and the AWS command line interface commands, to manage Elastic Load Balancing.
For detailed information about Elastic Load Balancing features and their associated actions or commands, go to Managing Load Balancers 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.
Modifier and Type | Field and Description |
---|---|
protected List<com.amazonaws.transform.Unmarshaller<AmazonServiceException,Node>> |
exceptionUnmarshallers
List of exception unmarshallers for all AmazonElasticLoadBalancing exceptions.
|
client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset
Constructor and Description |
---|
AmazonElasticLoadBalancingClient()
Constructs a new client to invoke service methods on
AmazonElasticLoadBalancing.
|
AmazonElasticLoadBalancingClient(AWSCredentials awsCredentials)
Constructs a new client to invoke service methods on
AmazonElasticLoadBalancing using the specified AWS account credentials.
|
AmazonElasticLoadBalancingClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on
AmazonElasticLoadBalancing using the specified AWS account credentials
and client configuration options.
|
AmazonElasticLoadBalancingClient(AWSCredentialsProvider awsCredentialsProvider)
Constructs a new client to invoke service methods on
AmazonElasticLoadBalancing using the specified AWS account credentials provider.
|
AmazonElasticLoadBalancingClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on
AmazonElasticLoadBalancing using the specified AWS account credentials
provider and client configuration options.
|
AmazonElasticLoadBalancingClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
RequestMetricCollector requestMetricCollector)
Constructs a new client to invoke service methods on
AmazonElasticLoadBalancing using the specified AWS account credentials
provider, client configuration options, and request metric collector.
|
AmazonElasticLoadBalancingClient(ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on
AmazonElasticLoadBalancing.
|
Modifier and Type | Method and Description |
---|---|
AddTagsResult |
addTags(AddTagsRequest addTagsRequest)
Adds one or more tags for the specified load balancer.
|
ApplySecurityGroupsToLoadBalancerResult |
applySecurityGroupsToLoadBalancer(ApplySecurityGroupsToLoadBalancerRequest applySecurityGroupsToLoadBalancerRequest)
Associates one or more security groups with your load balancer in
Amazon Virtual Private Cloud (Amazon VPC).
|
AttachLoadBalancerToSubnetsResult |
attachLoadBalancerToSubnets(AttachLoadBalancerToSubnetsRequest attachLoadBalancerToSubnetsRequest)
Adds one or more subnets to the set of configured subnets in the
Amazon Virtual Private Cloud (Amazon VPC) for the load balancer.
|
ConfigureHealthCheckResult |
configureHealthCheck(ConfigureHealthCheckRequest configureHealthCheckRequest)
Specifies the health check settings to use for evaluating the health
state of your back-end instances.
|
CreateAppCookieStickinessPolicyResult |
createAppCookieStickinessPolicy(CreateAppCookieStickinessPolicyRequest createAppCookieStickinessPolicyRequest)
Generates a stickiness policy with sticky session lifetimes that
follow that of an application-generated cookie.
|
CreateLBCookieStickinessPolicyResult |
createLBCookieStickinessPolicy(CreateLBCookieStickinessPolicyRequest createLBCookieStickinessPolicyRequest)
Generates a stickiness policy with sticky session lifetimes
controlled by the lifetime of the browser (user-agent) or a specified
expiration period.
|
CreateLoadBalancerResult |
createLoadBalancer(CreateLoadBalancerRequest createLoadBalancerRequest)
Creates a new load balancer.
|
void |
createLoadBalancerListeners(CreateLoadBalancerListenersRequest createLoadBalancerListenersRequest)
Creates one or more listeners on a load balancer for the specified
port.
|
CreateLoadBalancerPolicyResult |
createLoadBalancerPolicy(CreateLoadBalancerPolicyRequest createLoadBalancerPolicyRequest)
Creates a new policy that contains the necessary attributes depending
on the policy type.
|
void |
deleteLoadBalancer(DeleteLoadBalancerRequest deleteLoadBalancerRequest)
Deletes the specified load balancer.
|
void |
deleteLoadBalancerListeners(DeleteLoadBalancerListenersRequest deleteLoadBalancerListenersRequest)
Deletes listeners from the load balancer for the specified port.
|
DeleteLoadBalancerPolicyResult |
deleteLoadBalancerPolicy(DeleteLoadBalancerPolicyRequest deleteLoadBalancerPolicyRequest)
Deletes a policy from the load balancer.
|
DeregisterInstancesFromLoadBalancerResult |
deregisterInstancesFromLoadBalancer(DeregisterInstancesFromLoadBalancerRequest deregisterInstancesFromLoadBalancerRequest)
Deregisters instances from the load balancer.
|
DescribeInstanceHealthResult |
describeInstanceHealth(DescribeInstanceHealthRequest describeInstanceHealthRequest)
Returns the current state of the specified instances registered with
the specified load balancer.
|
DescribeLoadBalancerAttributesResult |
describeLoadBalancerAttributes(DescribeLoadBalancerAttributesRequest describeLoadBalancerAttributesRequest)
Returns detailed information about all of the attributes associated
with the specified load balancer.
|
DescribeLoadBalancerPoliciesResult |
describeLoadBalancerPolicies()
Returns detailed descriptions of the policies.
|
DescribeLoadBalancerPoliciesResult |
describeLoadBalancerPolicies(DescribeLoadBalancerPoliciesRequest describeLoadBalancerPoliciesRequest)
Returns detailed descriptions of the policies.
|
DescribeLoadBalancerPolicyTypesResult |
describeLoadBalancerPolicyTypes()
Returns meta-information on the specified load balancer policies
defined by the Elastic Load Balancing service.
|
DescribeLoadBalancerPolicyTypesResult |
describeLoadBalancerPolicyTypes(DescribeLoadBalancerPolicyTypesRequest describeLoadBalancerPolicyTypesRequest)
Returns meta-information on the specified load balancer policies
defined by the Elastic Load Balancing service.
|
DescribeLoadBalancersResult |
describeLoadBalancers()
Returns detailed configuration information for all the load balancers
created for the account.
|
DescribeLoadBalancersResult |
describeLoadBalancers(DescribeLoadBalancersRequest describeLoadBalancersRequest)
Returns detailed configuration information for all the load balancers
created for the account.
|
DescribeTagsResult |
describeTags(DescribeTagsRequest describeTagsRequest)
Describes the tags associated with one or more load balancers.
|
DetachLoadBalancerFromSubnetsResult |
detachLoadBalancerFromSubnets(DetachLoadBalancerFromSubnetsRequest detachLoadBalancerFromSubnetsRequest)
Removes subnets from the set of configured subnets in the Amazon
Virtual Private Cloud (Amazon VPC) for the load balancer.
|
DisableAvailabilityZonesForLoadBalancerResult |
disableAvailabilityZonesForLoadBalancer(DisableAvailabilityZonesForLoadBalancerRequest disableAvailabilityZonesForLoadBalancerRequest)
Removes the specified EC2 Availability Zones from the set of
configured Availability Zones for the load balancer.
|
EnableAvailabilityZonesForLoadBalancerResult |
enableAvailabilityZonesForLoadBalancer(EnableAvailabilityZonesForLoadBalancerRequest enableAvailabilityZonesForLoadBalancerRequest)
Adds one or more EC2 Availability Zones to the load balancer.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful, request, typically used for
debugging issues where a service isn't acting as expected.
|
ModifyLoadBalancerAttributesResult |
modifyLoadBalancerAttributes(ModifyLoadBalancerAttributesRequest modifyLoadBalancerAttributesRequest)
Modifies the attributes of a specified load balancer.
|
RegisterInstancesWithLoadBalancerResult |
registerInstancesWithLoadBalancer(RegisterInstancesWithLoadBalancerRequest registerInstancesWithLoadBalancerRequest)
Adds new instances to the load balancer.
|
RemoveTagsResult |
removeTags(RemoveTagsRequest removeTagsRequest)
Removes one or more tags from the specified load balancer.
|
void |
setLoadBalancerListenerSSLCertificate(SetLoadBalancerListenerSSLCertificateRequest setLoadBalancerListenerSSLCertificateRequest)
Sets the certificate that terminates the specified listener's SSL
connections.
|
SetLoadBalancerPoliciesForBackendServerResult |
setLoadBalancerPoliciesForBackendServer(SetLoadBalancerPoliciesForBackendServerRequest setLoadBalancerPoliciesForBackendServerRequest)
Replaces the current set of policies associated with a port on which
the back-end server is listening with a new set of policies.
|
SetLoadBalancerPoliciesOfListenerResult |
setLoadBalancerPoliciesOfListener(SetLoadBalancerPoliciesOfListenerRequest setLoadBalancerPoliciesOfListenerRequest)
Associates, updates, or disables a policy with a listener on the load
balancer.
|
addRequestHandler, addRequestHandler, configSigner, configSigner, convertToHttpRequest, createExecutionContext, createExecutionContext, createExecutionContext, endClientExecution, endClientExecution, findRequestMetricCollector, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, removeRequestHandler, removeRequestHandler, requestMetricCollector, setConfiguration, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withTimeOffset
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
setEndpoint, setRegion, shutdown
protected final List<com.amazonaws.transform.Unmarshaller<AmazonServiceException,Node>> exceptionUnmarshallers
public AmazonElasticLoadBalancingClient()
All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChain
public AmazonElasticLoadBalancingClient(ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
clientConfiguration
- The client configuration options controlling how this
client connects to AmazonElasticLoadBalancing
(ex: proxy settings, retry counts, etc.).DefaultAWSCredentialsProviderChain
public AmazonElasticLoadBalancingClient(AWSCredentials awsCredentials)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials
- The AWS credentials (access key ID and secret key) to use
when authenticating with AWS services.public AmazonElasticLoadBalancingClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials
- The AWS credentials (access key ID and secret key) to use
when authenticating with AWS services.clientConfiguration
- The client configuration options controlling how this
client connects to AmazonElasticLoadBalancing
(ex: proxy settings, retry counts, etc.).public AmazonElasticLoadBalancingClient(AWSCredentialsProvider awsCredentialsProvider)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials
to authenticate requests with AWS services.public AmazonElasticLoadBalancingClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials
to authenticate requests with AWS services.clientConfiguration
- The client configuration options controlling how this
client connects to AmazonElasticLoadBalancing
(ex: proxy settings, retry counts, etc.).public AmazonElasticLoadBalancingClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials
to authenticate requests with AWS services.clientConfiguration
- The client configuration options controlling how this
client connects to AmazonElasticLoadBalancing
(ex: proxy settings, retry counts, etc.).requestMetricCollector
- optional request metric collectorpublic DescribeLoadBalancerPolicyTypesResult describeLoadBalancerPolicyTypes(DescribeLoadBalancerPolicyTypesRequest describeLoadBalancerPolicyTypesRequest)
Returns meta-information on the specified load balancer policies defined by the Elastic Load Balancing service. The policy types that are returned from this action can be used in a CreateLoadBalancerPolicy action to instantiate specific policy configurations that will be applied to a load balancer.
describeLoadBalancerPolicyTypes
in interface AmazonElasticLoadBalancing
describeLoadBalancerPolicyTypesRequest
- Container for the
necessary parameters to execute the DescribeLoadBalancerPolicyTypes
service method on AmazonElasticLoadBalancing.PolicyTypeNotFoundException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonElasticLoadBalancing indicating
either a problem with the data in the request, or a server side issue.public ConfigureHealthCheckResult configureHealthCheck(ConfigureHealthCheckRequest configureHealthCheckRequest)
Specifies the health check settings to use for evaluating the health state of your back-end instances.
For more information, see Health Check in the Elastic Load Balancing Developer Guide .
configureHealthCheck
in interface AmazonElasticLoadBalancing
configureHealthCheckRequest
- Container for the necessary
parameters to execute the ConfigureHealthCheck service method on
AmazonElasticLoadBalancing.LoadBalancerNotFoundException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonElasticLoadBalancing indicating
either a problem with the data in the request, or a server side issue.public DetachLoadBalancerFromSubnetsResult detachLoadBalancerFromSubnets(DetachLoadBalancerFromSubnetsRequest detachLoadBalancerFromSubnetsRequest)
Removes subnets from the set of configured subnets in the Amazon Virtual Private Cloud (Amazon VPC) for the load balancer.
After a subnet is removed all of the EC2 instances registered with the load balancer that are in the removed subnet will go into the OutOfService state. When a subnet is removed, the load balancer will balance the traffic among the remaining routable subnets for the load balancer.
detachLoadBalancerFromSubnets
in interface AmazonElasticLoadBalancing
detachLoadBalancerFromSubnetsRequest
- Container for the
necessary parameters to execute the DetachLoadBalancerFromSubnets
service method on AmazonElasticLoadBalancing.InvalidConfigurationRequestException
LoadBalancerNotFoundException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonElasticLoadBalancing indicating
either a problem with the data in the request, or a server side issue.public AddTagsResult addTags(AddTagsRequest addTagsRequest)
Adds one or more tags for the specified load balancer. Each load balancer can have a maximum of 10 tags. Each tag consists of a key and an optional value.
Tag keys must be unique for each load balancer. If a tag with the same key is already associated with the load balancer, this action will update the value of the key.
For more information, see Tagging in the Elastic Load Balancing Developer Guide .
addTags
in interface AmazonElasticLoadBalancing
addTagsRequest
- Container for the necessary parameters to
execute the AddTags service method on AmazonElasticLoadBalancing.TooManyTagsException
DuplicateTagKeysException
LoadBalancerNotFoundException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonElasticLoadBalancing indicating
either a problem with the data in the request, or a server side issue.public ModifyLoadBalancerAttributesResult modifyLoadBalancerAttributes(ModifyLoadBalancerAttributesRequest modifyLoadBalancerAttributesRequest)
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. 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:
modifyLoadBalancerAttributes
in interface AmazonElasticLoadBalancing
modifyLoadBalancerAttributesRequest
- Container for the necessary
parameters to execute the ModifyLoadBalancerAttributes service method
on AmazonElasticLoadBalancing.InvalidConfigurationRequestException
LoadBalancerAttributeNotFoundException
LoadBalancerNotFoundException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonElasticLoadBalancing indicating
either a problem with the data in the request, or a server side issue.public void createLoadBalancerListeners(CreateLoadBalancerListenersRequest createLoadBalancerListenersRequest)
Creates one or more listeners on a load balancer for the specified port. If a listener with the given port does not already exist, it will be created; otherwise, the properties of the new listener must match the properties of the existing listener.
For more information, see Add a Listener to Your Load Balancer in the Elastic Load Balancing Developer Guide .
createLoadBalancerListeners
in interface AmazonElasticLoadBalancing
createLoadBalancerListenersRequest
- Container for the necessary
parameters to execute the CreateLoadBalancerListeners service method
on AmazonElasticLoadBalancing.InvalidConfigurationRequestException
DuplicateListenerException
CertificateNotFoundException
LoadBalancerNotFoundException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonElasticLoadBalancing indicating
either a problem with the data in the request, or a server side issue.public void deleteLoadBalancerListeners(DeleteLoadBalancerListenersRequest deleteLoadBalancerListenersRequest)
Deletes listeners from the load balancer for the specified port.
deleteLoadBalancerListeners
in interface AmazonElasticLoadBalancing
deleteLoadBalancerListenersRequest
- Container for the necessary
parameters to execute the DeleteLoadBalancerListeners service method
on AmazonElasticLoadBalancing.LoadBalancerNotFoundException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonElasticLoadBalancing indicating
either a problem with the data in the request, or a server side issue.public CreateAppCookieStickinessPolicyResult createAppCookieStickinessPolicy(CreateAppCookieStickinessPolicyRequest createAppCookieStickinessPolicyRequest)
Generates a stickiness policy with sticky session lifetimes that follow that of an application-generated cookie. This policy can be associated only with HTTP/HTTPS listeners.
This policy is similar to the policy created by CreateLBCookieStickinessPolicy, except that the lifetime of the special Elastic Load Balancing cookie follows the lifetime of the application-generated cookie specified in the policy configuration. The load balancer only inserts a new stickiness cookie when the application response includes a new application cookie.
If the application cookie is explicitly removed or expires, the session stops being sticky until a new application cookie is issued.
NOTE: An application client must receive and send two cookies: the application-generated cookie and the special Elastic Load Balancing cookie named AWSELB. This is the default behavior for many common web browsers.
For more information, see Enabling Application-Controlled Session Stickiness in the Elastic Load Balancing Developer Guide .
createAppCookieStickinessPolicy
in interface AmazonElasticLoadBalancing
createAppCookieStickinessPolicyRequest
- Container for the
necessary parameters to execute the CreateAppCookieStickinessPolicy
service method on AmazonElasticLoadBalancing.InvalidConfigurationRequestException
DuplicatePolicyNameException
TooManyPoliciesException
LoadBalancerNotFoundException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonElasticLoadBalancing indicating
either a problem with the data in the request, or a server side issue.public ApplySecurityGroupsToLoadBalancerResult applySecurityGroupsToLoadBalancer(ApplySecurityGroupsToLoadBalancerRequest applySecurityGroupsToLoadBalancerRequest)
Associates one or more security groups with your load balancer in Amazon Virtual Private Cloud (Amazon VPC). The provided security group IDs will override any currently applied security groups.
For more information, see Manage Security Groups in Amazon VPC in the Elastic Load Balancing Developer Guide .
applySecurityGroupsToLoadBalancer
in interface AmazonElasticLoadBalancing
applySecurityGroupsToLoadBalancerRequest
- Container for the
necessary parameters to execute the ApplySecurityGroupsToLoadBalancer
service method on AmazonElasticLoadBalancing.InvalidConfigurationRequestException
InvalidSecurityGroupException
LoadBalancerNotFoundException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonElasticLoadBalancing indicating
either a problem with the data in the request, or a server side issue.public DescribeLoadBalancerPoliciesResult describeLoadBalancerPolicies(DescribeLoadBalancerPoliciesRequest describeLoadBalancerPoliciesRequest)
Returns detailed descriptions of the policies. If you specify a load
balancer name, the action returns the descriptions of all the policies
created for the load balancer. If you specify a policy name associated
with your load balancer, the action returns the description of that
policy. If you don't specify a load balancer name, the action returns
descriptions of the specified sample policies, or descriptions of all
the sample policies. The names of the sample policies have the
ELBSample-
prefix.
describeLoadBalancerPolicies
in interface AmazonElasticLoadBalancing
describeLoadBalancerPoliciesRequest
- Container for the necessary
parameters to execute the DescribeLoadBalancerPolicies service method
on AmazonElasticLoadBalancing.PolicyNotFoundException
LoadBalancerNotFoundException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonElasticLoadBalancing indicating
either a problem with the data in the request, or a server side issue.public SetLoadBalancerPoliciesOfListenerResult setLoadBalancerPoliciesOfListener(SetLoadBalancerPoliciesOfListenerRequest setLoadBalancerPoliciesOfListenerRequest)
Associates, updates, or disables a policy with a listener on the load balancer. You can associate multiple policies with a listener.
setLoadBalancerPoliciesOfListener
in interface AmazonElasticLoadBalancing
setLoadBalancerPoliciesOfListenerRequest
- Container for the
necessary parameters to execute the SetLoadBalancerPoliciesOfListener
service method on AmazonElasticLoadBalancing.PolicyNotFoundException
InvalidConfigurationRequestException
LoadBalancerNotFoundException
ListenerNotFoundException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonElasticLoadBalancing indicating
either a problem with the data in the request, or a server side issue.public DisableAvailabilityZonesForLoadBalancerResult disableAvailabilityZonesForLoadBalancer(DisableAvailabilityZonesForLoadBalancerRequest disableAvailabilityZonesForLoadBalancerRequest)
Removes the specified EC2 Availability Zones from the set of configured Availability Zones for the load balancer.
There must be at least one Availability Zone registered with a load balancer at all times. Once an Availability Zone is removed, all the instances registered with the load balancer that are in the removed Availability Zone go into the OutOfService state. Upon Availability Zone removal, the load balancer attempts to equally balance the traffic among its remaining usable Availability Zones. Trying to remove an Availability Zone that was not associated with the load balancer does nothing.
For more information, see Disable an Availability Zone from a Load-Balanced Application in the Elastic Load Balancing Developer Guide .
disableAvailabilityZonesForLoadBalancer
in interface AmazonElasticLoadBalancing
disableAvailabilityZonesForLoadBalancerRequest
- Container for
the necessary parameters to execute the
DisableAvailabilityZonesForLoadBalancer service method on
AmazonElasticLoadBalancing.InvalidConfigurationRequestException
LoadBalancerNotFoundException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonElasticLoadBalancing indicating
either a problem with the data in the request, or a server side issue.public DescribeInstanceHealthResult describeInstanceHealth(DescribeInstanceHealthRequest describeInstanceHealthRequest)
Returns the current state of the specified instances registered with the specified load balancer. If no instances are specified, the state of all the instances registered with the load balancer is returned.
NOTE: You must provide the same account credentials as those that were used to create the load balancer.
describeInstanceHealth
in interface AmazonElasticLoadBalancing
describeInstanceHealthRequest
- Container for the necessary
parameters to execute the DescribeInstanceHealth service method on
AmazonElasticLoadBalancing.LoadBalancerNotFoundException
InvalidInstanceException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonElasticLoadBalancing indicating
either a problem with the data in the request, or a server side issue.public DeleteLoadBalancerPolicyResult deleteLoadBalancerPolicy(DeleteLoadBalancerPolicyRequest deleteLoadBalancerPolicyRequest)
Deletes a policy from the load balancer. The specified policy must not be enabled for any listeners.
deleteLoadBalancerPolicy
in interface AmazonElasticLoadBalancing
deleteLoadBalancerPolicyRequest
- Container for the necessary
parameters to execute the DeleteLoadBalancerPolicy service method on
AmazonElasticLoadBalancing.InvalidConfigurationRequestException
LoadBalancerNotFoundException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonElasticLoadBalancing indicating
either a problem with the data in the request, or a server side issue.public DescribeTagsResult describeTags(DescribeTagsRequest describeTagsRequest)
Describes the tags associated with one or more load balancers.
describeTags
in interface AmazonElasticLoadBalancing
describeTagsRequest
- Container for the necessary parameters to
execute the DescribeTags service method on AmazonElasticLoadBalancing.LoadBalancerNotFoundException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonElasticLoadBalancing indicating
either a problem with the data in the request, or a server side issue.public CreateLoadBalancerPolicyResult createLoadBalancerPolicy(CreateLoadBalancerPolicyRequest createLoadBalancerPolicyRequest)
Creates a new policy that contains the necessary attributes depending on the policy type. Policies are settings that are saved for your load balancer and that can be applied to the front-end listener, or the back-end application server, depending on your policy type.
createLoadBalancerPolicy
in interface AmazonElasticLoadBalancing
createLoadBalancerPolicyRequest
- Container for the necessary
parameters to execute the CreateLoadBalancerPolicy service method on
AmazonElasticLoadBalancing.PolicyTypeNotFoundException
InvalidConfigurationRequestException
DuplicatePolicyNameException
TooManyPoliciesException
LoadBalancerNotFoundException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonElasticLoadBalancing indicating
either a problem with the data in the request, or a server side issue.public RemoveTagsResult removeTags(RemoveTagsRequest removeTagsRequest)
Removes one or more tags from the specified load balancer.
removeTags
in interface AmazonElasticLoadBalancing
removeTagsRequest
- Container for the necessary parameters to
execute the RemoveTags service method on AmazonElasticLoadBalancing.LoadBalancerNotFoundException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonElasticLoadBalancing indicating
either a problem with the data in the request, or a server side issue.public EnableAvailabilityZonesForLoadBalancerResult enableAvailabilityZonesForLoadBalancer(EnableAvailabilityZonesForLoadBalancerRequest enableAvailabilityZonesForLoadBalancerRequest)
Adds one or more EC2 Availability Zones to the load balancer.
The load balancer evenly distributes requests across all its registered Availability Zones that contain instances.
NOTE: The new EC2 Availability Zones to be added must be in the same EC2 Region as the Availability Zones for which the load balancer was created.
For more information, see Expand a Load Balanced Application to an Additional Availability Zone in the Elastic Load Balancing Developer Guide .
enableAvailabilityZonesForLoadBalancer
in interface AmazonElasticLoadBalancing
enableAvailabilityZonesForLoadBalancerRequest
- Container for the
necessary parameters to execute the
EnableAvailabilityZonesForLoadBalancer service method on
AmazonElasticLoadBalancing.LoadBalancerNotFoundException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonElasticLoadBalancing indicating
either a problem with the data in the request, or a server side issue.public void deleteLoadBalancer(DeleteLoadBalancerRequest deleteLoadBalancerRequest)
Deletes the specified load balancer.
If attempting to recreate the load balancer, you must reconfigure all the settings. The DNS name associated with a deleted load balancer will no longer be usable. Once deleted, the name and associated DNS record of the load balancer no longer exist and traffic sent to any of its IP addresses will no longer be delivered to back-end instances.
To successfully call this API, you must provide the same account credentials as were used to create the load balancer.
NOTE: By design, if the load balancer does not exist or has already been deleted, a call to DeleteLoadBalancer action still succeeds.
deleteLoadBalancer
in interface AmazonElasticLoadBalancing
deleteLoadBalancerRequest
- Container for the necessary
parameters to execute the DeleteLoadBalancer service method on
AmazonElasticLoadBalancing.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonElasticLoadBalancing indicating
either a problem with the data in the request, or a server side issue.public CreateLoadBalancerResult createLoadBalancer(CreateLoadBalancerRequest createLoadBalancerRequest)
Creates a new load balancer.
After the call has completed successfully, a new load balancer is created with a unique Domain Name Service (DNS) name. The DNS name includes the name of the AWS region in which the load balance was created. For example, if your load balancer was created in the United States, the DNS name might end with either of the following:
For information about the AWS regions supported by Elastic Load Balancing, see Regions and Endpoints .
You can create up to 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:
For information on creating and managing your load balancers in EC2-Classic, see Deploy Elastic Load Balancing in Amazon EC2-Classic .
For information on creating and managing your load balancers in EC2-VPC, see Deploy Elastic Load Balancing in Amazon VPC .
createLoadBalancer
in interface AmazonElasticLoadBalancing
createLoadBalancerRequest
- Container for the necessary
parameters to execute the CreateLoadBalancer service method on
AmazonElasticLoadBalancing.InvalidSubnetException
TooManyTagsException
InvalidConfigurationRequestException
DuplicateTagKeysException
InvalidSecurityGroupException
CertificateNotFoundException
InvalidSchemeException
DuplicateLoadBalancerNameException
TooManyLoadBalancersException
SubnetNotFoundException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonElasticLoadBalancing indicating
either a problem with the data in the request, or a server side issue.public SetLoadBalancerPoliciesForBackendServerResult setLoadBalancerPoliciesForBackendServer(SetLoadBalancerPoliciesForBackendServerRequest setLoadBalancerPoliciesForBackendServerRequest)
Replaces the current set of policies associated with a port on which the back-end server is listening with a new set of policies. After the policies have been created using CreateLoadBalancerPolicy, they can be applied here as a list. At this time, only the back-end server authentication policy type can be applied to the back-end ports; this policy type is composed of multiple public key policies.
NOTE: The SetLoadBalancerPoliciesForBackendServer replaces the current set of policies associated with the specified instance port. Every time you use this action to enable the policies, use the PolicyNames parameter to list all the policies you want to enable.
You can use DescribeLoadBalancers or DescribeLoadBalancerPolicies action to verify that the policy has been associated with the back-end server.
setLoadBalancerPoliciesForBackendServer
in interface AmazonElasticLoadBalancing
setLoadBalancerPoliciesForBackendServerRequest
- Container for
the necessary parameters to execute the
SetLoadBalancerPoliciesForBackendServer service method on
AmazonElasticLoadBalancing.PolicyNotFoundException
InvalidConfigurationRequestException
LoadBalancerNotFoundException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonElasticLoadBalancing indicating
either a problem with the data in the request, or a server side issue.public DeregisterInstancesFromLoadBalancerResult deregisterInstancesFromLoadBalancer(DeregisterInstancesFromLoadBalancerRequest deregisterInstancesFromLoadBalancerRequest)
Deregisters instances from the load balancer. Once the instance is deregistered, it will stop receiving traffic from the load balancer.
In order to successfully call this API, the same account credentials as those used to create the load balancer must be provided.
For more information, see De-register and Register Amazon EC2 Instances in the Elastic Load Balancing Developer Guide .
You can use DescribeLoadBalancers to verify if the instance is deregistered from the load balancer.
deregisterInstancesFromLoadBalancer
in interface AmazonElasticLoadBalancing
deregisterInstancesFromLoadBalancerRequest
- Container for the
necessary parameters to execute the
DeregisterInstancesFromLoadBalancer service method on
AmazonElasticLoadBalancing.LoadBalancerNotFoundException
InvalidInstanceException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonElasticLoadBalancing indicating
either a problem with the data in the request, or a server side issue.public void setLoadBalancerListenerSSLCertificate(SetLoadBalancerListenerSSLCertificateRequest setLoadBalancerListenerSSLCertificateRequest)
Sets the certificate that terminates the specified listener's SSL connections. The specified certificate replaces any prior certificate that was used on the same load balancer and port.
For more information on updating your SSL certificate, see Updating an SSL Certificate for a Load Balancer in the Elastic Load Balancing Developer Guide .
setLoadBalancerListenerSSLCertificate
in interface AmazonElasticLoadBalancing
setLoadBalancerListenerSSLCertificateRequest
- Container for the
necessary parameters to execute the
SetLoadBalancerListenerSSLCertificate service method on
AmazonElasticLoadBalancing.InvalidConfigurationRequestException
CertificateNotFoundException
LoadBalancerNotFoundException
ListenerNotFoundException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonElasticLoadBalancing indicating
either a problem with the data in the request, or a server side issue.public DescribeLoadBalancerAttributesResult describeLoadBalancerAttributes(DescribeLoadBalancerAttributesRequest describeLoadBalancerAttributesRequest)
Returns detailed information about all of the attributes associated with the specified load balancer.
describeLoadBalancerAttributes
in interface AmazonElasticLoadBalancing
describeLoadBalancerAttributesRequest
- Container for the
necessary parameters to execute the DescribeLoadBalancerAttributes
service method on AmazonElasticLoadBalancing.LoadBalancerAttributeNotFoundException
LoadBalancerNotFoundException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonElasticLoadBalancing indicating
either a problem with the data in the request, or a server side issue.public CreateLBCookieStickinessPolicyResult createLBCookieStickinessPolicy(CreateLBCookieStickinessPolicyRequest createLBCookieStickinessPolicyRequest)
Generates a stickiness policy with sticky session lifetimes controlled by the lifetime of the browser (user-agent) or a specified expiration period. This policy can be associated only with HTTP/HTTPS listeners.
When a load balancer implements this policy, the load balancer uses a special cookie to track the backend server instance for each request. When the load balancer receives a request, it first checks to see if this cookie is present in the request. If so, the load balancer sends the request to the application server specified in the cookie. If not, the load balancer sends the request to a server that is chosen based on the existing load balancing algorithm.
A cookie is inserted into the response for binding subsequent requests from the same user to that server. The validity of the cookie is based on the cookie expiration time, which is specified in the policy configuration.
For more information, see Enabling Duration-Based Session Stickiness in the Elastic Load Balancing Developer Guide .
createLBCookieStickinessPolicy
in interface AmazonElasticLoadBalancing
createLBCookieStickinessPolicyRequest
- Container for the
necessary parameters to execute the CreateLBCookieStickinessPolicy
service method on AmazonElasticLoadBalancing.InvalidConfigurationRequestException
DuplicatePolicyNameException
TooManyPoliciesException
LoadBalancerNotFoundException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonElasticLoadBalancing indicating
either a problem with the data in the request, or a server side issue.public AttachLoadBalancerToSubnetsResult attachLoadBalancerToSubnets(AttachLoadBalancerToSubnetsRequest attachLoadBalancerToSubnetsRequest)
Adds one or more subnets to the set of configured subnets in the Amazon Virtual Private Cloud (Amazon VPC) for the load balancer.
The load balancers evenly distribute requests across all of the registered subnets. For more information, see Deploy Elastic Load Balancing in Amazon VPC in the Elastic Load Balancing Developer Guide .
attachLoadBalancerToSubnets
in interface AmazonElasticLoadBalancing
attachLoadBalancerToSubnetsRequest
- Container for the necessary
parameters to execute the AttachLoadBalancerToSubnets service method
on AmazonElasticLoadBalancing.InvalidSubnetException
InvalidConfigurationRequestException
LoadBalancerNotFoundException
SubnetNotFoundException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonElasticLoadBalancing indicating
either a problem with the data in the request, or a server side issue.public RegisterInstancesWithLoadBalancerResult registerInstancesWithLoadBalancer(RegisterInstancesWithLoadBalancerRequest registerInstancesWithLoadBalancerRequest)
Adds new instances to the load balancer.
Once the instance is registered, it starts receiving traffic and requests from the load balancer. Any instance that is not in any of the Availability Zones registered for the load balancer will be moved to the OutOfService state. It will move to the InService state when the Availability Zone is added to the load balancer.
When an instance registered with a load balancer is stopped and then restarted, the IP addresses associated with the instance changes. Elastic Load Balancing cannot recognize the new IP address, which prevents it from routing traffic to the instances. We recommend that you de-register your Amazon EC2 instances from your load balancer after you stop your instance, and then register the load balancer with your instance after you've restarted. To de-register your instances from load balancer, use DeregisterInstancesFromLoadBalancer action.
For more information, see De-register and Register Amazon EC2 Instances in the Elastic Load Balancing Developer Guide .
NOTE: In order for this call to be successful, you must provide the same account credentials as those that were used to create the load balancer.
NOTE: Completion of this API does not guarantee that operation has completed. Rather, it means that the request has been registered and the changes will happen shortly.
You can use DescribeLoadBalancers or DescribeInstanceHealth action to check the state of the newly registered instances.
registerInstancesWithLoadBalancer
in interface AmazonElasticLoadBalancing
registerInstancesWithLoadBalancerRequest
- Container for the
necessary parameters to execute the RegisterInstancesWithLoadBalancer
service method on AmazonElasticLoadBalancing.LoadBalancerNotFoundException
InvalidInstanceException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonElasticLoadBalancing indicating
either a problem with the data in the request, or a server side issue.public DescribeLoadBalancersResult describeLoadBalancers(DescribeLoadBalancersRequest describeLoadBalancersRequest)
Returns detailed configuration information for all the load balancers created for the account. If you specify load balancer names, the action returns configuration information of the specified load balancers.
NOTE: In order to retrieve this information, you must provide the same account credentials that was used to create the load balancer.
describeLoadBalancers
in interface AmazonElasticLoadBalancing
describeLoadBalancersRequest
- Container for the necessary
parameters to execute the DescribeLoadBalancers service method on
AmazonElasticLoadBalancing.LoadBalancerNotFoundException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonElasticLoadBalancing indicating
either a problem with the data in the request, or a server side issue.public DescribeLoadBalancerPolicyTypesResult describeLoadBalancerPolicyTypes() throws AmazonServiceException, AmazonClientException
Returns meta-information on the specified load balancer policies defined by the Elastic Load Balancing service. The policy types that are returned from this action can be used in a CreateLoadBalancerPolicy action to instantiate specific policy configurations that will be applied to a load balancer.
describeLoadBalancerPolicyTypes
in interface AmazonElasticLoadBalancing
PolicyTypeNotFoundException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonElasticLoadBalancing indicating
either a problem with the data in the request, or a server side issue.public DescribeLoadBalancerPoliciesResult describeLoadBalancerPolicies() throws AmazonServiceException, AmazonClientException
Returns detailed descriptions of the policies. If you specify a load
balancer name, the action returns the descriptions of all the policies
created for the load balancer. If you specify a policy name associated
with your load balancer, the action returns the description of that
policy. If you don't specify a load balancer name, the action returns
descriptions of the specified sample policies, or descriptions of all
the sample policies. The names of the sample policies have the
ELBSample-
prefix.
describeLoadBalancerPolicies
in interface AmazonElasticLoadBalancing
PolicyNotFoundException
LoadBalancerNotFoundException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonElasticLoadBalancing indicating
either a problem with the data in the request, or a server side issue.public DescribeLoadBalancersResult describeLoadBalancers() throws AmazonServiceException, AmazonClientException
Returns detailed configuration information for all the load balancers created for the account. If you specify load balancer names, the action returns configuration information of the specified load balancers.
NOTE: In order to retrieve this information, you must provide the same account credentials that was used to create the load balancer.
describeLoadBalancers
in interface AmazonElasticLoadBalancing
LoadBalancerNotFoundException
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonElasticLoadBalancing indicating
either a problem with the data in the request, or a server side issue.public 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 the request.
getCachedResponseMetadata
in interface AmazonElasticLoadBalancing
request
- The originally executed requestCopyright © 2014. All rights reserved.