public class AmazonElasticLoadBalancingClient extends AmazonWebServiceClient implements AmazonElasticLoadBalancing
Elastic Load Balancing
Elastic Load Balancing automatically distributes incoming web traffic across multiple Amazon EC2 instances.
All Elastic Load Balancing actions and commands are idempotent , which means that they complete no more than one time. If you repeat a request or a command, the action succeeds with a 200 OK response code.
For detailed information about the features of Elastic Load Balancing, see Managing Load Balancers in the Elastic Load Balancing Developer Guide .
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 the specified tags to the specified load balancer.
|
ApplySecurityGroupsToLoadBalancerResult |
applySecurityGroupsToLoadBalancer(ApplySecurityGroupsToLoadBalancerRequest applySecurityGroupsToLoadBalancerRequest)
Associates one or more security groups with your load balancer in a
virtual private cloud (VPC).
|
AttachLoadBalancerToSubnetsResult |
attachLoadBalancerToSubnets(AttachLoadBalancerToSubnetsRequest attachLoadBalancerToSubnetsRequest)
Adds one or more subnets to the set of configured subnets for the
specified load balancer.
|
ConfigureHealthCheckResult |
configureHealthCheck(ConfigureHealthCheckRequest configureHealthCheckRequest)
Specifies the health check settings to use when evaluating the health
state of your back-end instances.
|
CreateAppCookieStickinessPolicyResult |
createAppCookieStickinessPolicy(CreateAppCookieStickinessPolicyRequest createAppCookieStickinessPolicyRequest)
Generates a stickiness policy with sticky session lifetimes that
follow that of an application-generated cookie.
|
CreateLBCookieStickinessPolicyResult |
createLBCookieStickinessPolicy(CreateLBCookieStickinessPolicyRequest createLBCookieStickinessPolicyRequest)
Generates a stickiness policy with sticky session lifetimes
controlled by the lifetime of the browser (user-agent) or a specified
expiration period.
|
CreateLoadBalancerResult |
createLoadBalancer(CreateLoadBalancerRequest createLoadBalancerRequest)
Creates a load balancer.
|
void |
createLoadBalancerListeners(CreateLoadBalancerListenersRequest createLoadBalancerListenersRequest)
Creates one or more listeners for the specified load balancer.
|
CreateLoadBalancerPolicyResult |
createLoadBalancerPolicy(CreateLoadBalancerPolicyRequest createLoadBalancerPolicyRequest)
Creates a policy with the specified attributes for the specified load
balancer.
|
void |
deleteLoadBalancer(DeleteLoadBalancerRequest deleteLoadBalancerRequest)
Deletes the specified load balancer.
|
void |
deleteLoadBalancerListeners(DeleteLoadBalancerListenersRequest deleteLoadBalancerListenersRequest)
Deletes the specified listeners from the specified load balancer.
|
DeleteLoadBalancerPolicyResult |
deleteLoadBalancerPolicy(DeleteLoadBalancerPolicyRequest deleteLoadBalancerPolicyRequest)
Deletes the specified policy from the specified load balancer.
|
DeregisterInstancesFromLoadBalancerResult |
deregisterInstancesFromLoadBalancer(DeregisterInstancesFromLoadBalancerRequest deregisterInstancesFromLoadBalancerRequest)
Deregisters the specified instances from the specified load balancer.
|
DescribeInstanceHealthResult |
describeInstanceHealth(DescribeInstanceHealthRequest describeInstanceHealthRequest)
Describes the state of the specified instances registered with the
specified load balancer.
|
DescribeLoadBalancerAttributesResult |
describeLoadBalancerAttributes(DescribeLoadBalancerAttributesRequest describeLoadBalancerAttributesRequest)
Describes the attributes for the specified load balancer.
|
DescribeLoadBalancerPoliciesResult |
describeLoadBalancerPolicies()
Describes the specified policies.
|
DescribeLoadBalancerPoliciesResult |
describeLoadBalancerPolicies(DescribeLoadBalancerPoliciesRequest describeLoadBalancerPoliciesRequest)
Describes the specified policies.
|
DescribeLoadBalancerPolicyTypesResult |
describeLoadBalancerPolicyTypes()
Describes the specified load balancer policy types.
|
DescribeLoadBalancerPolicyTypesResult |
describeLoadBalancerPolicyTypes(DescribeLoadBalancerPolicyTypesRequest describeLoadBalancerPolicyTypesRequest)
Describes the specified load balancer policy types.
|
DescribeLoadBalancersResult |
describeLoadBalancers()
Describes the specified the load balancers.
|
DescribeLoadBalancersResult |
describeLoadBalancers(DescribeLoadBalancersRequest describeLoadBalancersRequest)
Describes the specified the load balancers.
|
DescribeTagsResult |
describeTags(DescribeTagsRequest describeTagsRequest)
Describes the tags associated with the specified load balancers.
|
DetachLoadBalancerFromSubnetsResult |
detachLoadBalancerFromSubnets(DetachLoadBalancerFromSubnetsRequest detachLoadBalancerFromSubnetsRequest)
Removes the specified subnets from the set of configured subnets for
the load balancer.
|
DisableAvailabilityZonesForLoadBalancerResult |
disableAvailabilityZonesForLoadBalancer(DisableAvailabilityZonesForLoadBalancerRequest disableAvailabilityZonesForLoadBalancerRequest)
Removes the specified Availability Zones from the set of Availability
Zones for the specified load balancer.
|
EnableAvailabilityZonesForLoadBalancerResult |
enableAvailabilityZonesForLoadBalancer(EnableAvailabilityZonesForLoadBalancerRequest enableAvailabilityZonesForLoadBalancerRequest)
Adds the specified Availability Zones to the set of Availability
Zones for the specified load balancer.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful, request, typically used for
debugging issues where a service isn't acting as expected.
|
ModifyLoadBalancerAttributesResult |
modifyLoadBalancerAttributes(ModifyLoadBalancerAttributesRequest modifyLoadBalancerAttributesRequest)
Modifies the attributes of the specified load balancer.
|
RegisterInstancesWithLoadBalancerResult |
registerInstancesWithLoadBalancer(RegisterInstancesWithLoadBalancerRequest registerInstancesWithLoadBalancerRequest)
Adds the specified instances to the specified load balancer.
|
RemoveTagsResult |
removeTags(RemoveTagsRequest removeTagsRequest)
Removes one or more tags from the specified load balancer.
|
void |
setLoadBalancerListenerSSLCertificate(SetLoadBalancerListenerSSLCertificateRequest setLoadBalancerListenerSSLCertificateRequest)
Sets the certificate that terminates the specified listener's SSL
connections.
|
SetLoadBalancerPoliciesForBackendServerResult |
setLoadBalancerPoliciesForBackendServer(SetLoadBalancerPoliciesForBackendServerRequest setLoadBalancerPoliciesForBackendServerRequest)
Replaces the set of policies associated with the specified port on
which the back-end server is listening with a new set of policies.
|
SetLoadBalancerPoliciesOfListenerResult |
setLoadBalancerPoliciesOfListener(SetLoadBalancerPoliciesOfListenerRequest setLoadBalancerPoliciesOfListenerRequest)
Associates, updates, or disables a policy with a listener for the
specified load balancer.
|
addRequestHandler, addRequestHandler, beforeMarshalling, configSigner, configSigner, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, endClientExecution, endClientExecution, findRequestMetricCollector, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, 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)
Describes the specified load balancer policy types.
You can use these policy types with CreateLoadBalancerPolicy to create policy configurations for 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 when evaluating the health state of your back-end instances.
For more information, see Health Checks 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 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.
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 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 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 the specified load balancer.
You can modify the load balancer attributes, such as
AccessLogs
, ConnectionDraining
, and
CrossZoneLoadBalancing
by either enabling or disabling
them. Or, you can modify the load balancer attribute
ConnectionSettings
by specifying an idle connection
timeout value for your load balancer.
For more information, see the following in the Elastic Load Balancing Developer Guide :
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 for the specified load balancer. If a listener with the specified port does not already exist, it is created; otherwise, the properties of the new listener must match the properties of the existing listener.
For more information, see Add a Listener to Your Load Balancer in the Elastic Load Balancing Developer Guide .
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 the specified listeners from the specified load balancer.
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, AWSELB
, follows
the lifetime of the application-generated cookie specified in the
policy configuration. The load balancer only inserts a new stickiness
cookie when the application response includes a new application
cookie.
If the application cookie is explicitly removed or expires, the session stops being sticky until a new application cookie is issued.
For more information, see Application-Controlled Session Stickiness in the Elastic Load Balancing Developer Guide .
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 a virtual private cloud (VPC). The specified security groups override the previously associated security groups.
For more information, see Manage Security Groups for 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)
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.
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 for the specified 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 Availability Zones from the set of Availability Zones for the specified load balancer.
There must be at least one Availability Zone registered with a load
balancer at all times. After an Availability Zone is removed, all
instances registered with the load balancer that are in the removed
Availability Zone go into the OutOfService
state. Then,
the load balancer attempts to equally balance the traffic among its
remaining Availability Zones.
For more information, see Disable an Availability Zone from a Load-Balanced Application in the Elastic Load Balancing Developer Guide .
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)
Describes the state of the specified instances registered with the specified load balancer. If no instances are specified, the call describes the state of all instances registered with the load balancer, not including any terminated instances.
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 the specified policy from the specified load balancer. This 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 the specified 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 policy with the specified attributes for the specified load balancer.
Policies are settings that are saved for your load balancer and that can be applied to the front-end listener or the back-end application server, depending on the policy type.
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 the specified Availability Zones to the set of Availability Zones for the specified load balancer.
The load balancer evenly distributes requests across all its registered Availability Zones that contain instances.
For more information, see Add Availability Zone in the Elastic Load Balancing Developer Guide .
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 you are attempting to recreate a load balancer, you must reconfigure all settings. The DNS name associated with a deleted load balancer are no longer usable. The name and associated DNS record of the deleted load balancer no longer exist and traffic sent to any of its IP addresses is no longer delivered to back-end instances.
If the load balancer does not exist or has already been deleted, the
call to DeleteLoadBalancer
still succeeds.
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 load balancer.
If the call completes 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 balancer was created. For example, the DNS name might end with either of the following:
us-east-1.elb.amazonaws.com
us-west-2.elb.amazonaws.com
For information about the AWS regions supported by Elastic Load Balancing, see Regions and Endpoints in the Amazon Web Services General Reference .
You can create up to 20 load balancers per region per account. You can request an increase for the number of load balancers for your account. For more information, see Elastic Load Balancing Limits in the Elastic Load Balancing Developer Guide .
Elastic Load Balancing supports load balancing your EC2 instances launched in either the EC2-Classic or EC2-VPC platform. For more information, see Elastic Load Balancing in EC2-Classic or Elastic Load Balancing in a VPC in the Elastic Load Balancing Developer Guide .
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 set of policies associated with the specified port on which the back-end server is listening with a new set of policies. At this time, only the back-end server authentication policy type can be applied to the back-end ports; this policy type is composed of multiple public key policies.
Each time you use
SetLoadBalancerPoliciesForBackendServer
to enable the
policies, use the PolicyNames
parameter to list the
policies that you want to enable.
You can use DescribeLoadBalancers or DescribeLoadBalancerPolicies to verify that the policy is associated with the back-end server.
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 the specified instances from the specified load balancer. After the instance is deregistered, it no longer receives traffic from the load balancer.
You can use DescribeLoadBalancers to verify that the instance is deregistered from the load balancer.
For more information, see Deregister and Register Amazon EC2 Instances in the Elastic Load Balancing Developer Guide .
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 about 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)
Describes the attributes for 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 back-end server instance for each request. When the load balancer receives a request, it first checks to see if this cookie is present in the request. If so, the load balancer sends the request to the application server specified in the cookie. If not, the load balancer sends the request to a server that is chosen based on the existing load-balancing algorithm.
A cookie is inserted into the response for binding subsequent requests from the same user to that server. The validity of the cookie is based on the cookie expiration time, which is specified in the policy configuration.
For more information, see Duration-Based Session Stickiness in the Elastic Load Balancing Developer Guide .
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 for the specified load balancer.
The load balancer evenly distributes requests across all registered subnets. For more information, see 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 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 happens
shortly afterwards. To check the state of the registered instances,
use DescribeLoadBalancers or DescribeInstanceHealth.
After the instance is registered, it starts receiving traffic and
requests from the load balancer. Any instance that is not in one of
the Availability Zones registered for the load balancer is moved to
the OutOfService
state. If an Availability Zone is added
to the load balancer later, any instances registered with the load
balancer move to the InService
state.
If you stop an instance registered with a load balancer and then start it, the IP addresses associated with the instance changes. Elastic Load Balancing cannot recognize the new IP address, which prevents it from routing traffic to the instances. We recommend that you use the following sequence: stop the instance, deregister the instance, start the instance, and then register the instance. To deregister instances from a load balancer, use DeregisterInstancesFromLoadBalancer.
For more information, see Deregister and Register EC2 Instances in the Elastic Load Balancing Developer Guide .
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)
Describes the specified the load balancers. If no load balancers are specified, the call describes all of your load balancers.
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
Describes the specified load balancer policy types.
You can use these policy types with CreateLoadBalancerPolicy to create policy configurations for 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
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.
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
Describes the specified the load balancers. If no load balancers are specified, the call describes all of your load balancers.
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 © 2015. All rights reserved.