com.amazonaws.services.elasticloadbalancing

Class AmazonElasticLoadBalancingClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.elasticloadbalancing.AmazonElasticLoadBalancingClient

All Implemented Interfaces:

AmazonElasticLoadBalancing

Direct Known Subclasses:

AmazonElasticLoadBalancingAsyncClient

@ThreadSafe
public class AmazonElasticLoadBalancingClient
extends AmazonWebServiceClient
implements AmazonElasticLoadBalancing

Client for accessing Elastic Load Balancing. All service calls made using this client are blocking, and will not return until the service call completes.

Elastic Load Balancing

Elastic Load Balancing distributes incoming traffic across your EC2 instances.

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

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

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

Field Summary

Fields

Modifier and Type	Field and Description
protected static ClientConfigurationFactory	configFactory Client configuration factory providing ClientConfigurations tailored to this client
protected List<com.amazonaws.transform.Unmarshaller<AmazonServiceException,Node>>	exceptionUnmarshallers List of exception unmarshallers for all Elastic Load Balancing exceptions.

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

Constructor Summary

Constructors

Constructor and Description
AmazonElasticLoadBalancingClient() Constructs a new client to invoke service methods on Elastic Load Balancing.
AmazonElasticLoadBalancingClient(AWSCredentials awsCredentials) Constructs a new client to invoke service methods on Elastic Load Balancing using the specified AWS account credentials.
AmazonElasticLoadBalancingClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on Elastic Load Balancing using the specified AWS account credentials and client configuration options.
AmazonElasticLoadBalancingClient(AWSCredentialsProvider awsCredentialsProvider) Constructs a new client to invoke service methods on Elastic Load Balancing using the specified AWS account credentials provider.
AmazonElasticLoadBalancingClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on Elastic Load Balancing 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 Elastic Load Balancing 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 Elastic Load Balancing.

Method Summary

Methods

Modifier and Type	Method and Description
AddTagsResult	addTags(AddTagsRequest addTagsRequest) Adds the specified tags to the specified load balancer.
ApplySecurityGroupsToLoadBalancerResult	applySecurityGroupsToLoadBalancer(ApplySecurityGroupsToLoadBalancerRequest applySecurityGroupsToLoadBalancerRequest) Associates one or more security groups with your load balancer in a virtual private cloud (VPC).
AttachLoadBalancerToSubnetsResult	attachLoadBalancerToSubnets(AttachLoadBalancerToSubnetsRequest attachLoadBalancerToSubnetsRequest) Adds one or more subnets to the set of configured subnets for the specified load balancer.
ConfigureHealthCheckResult	configureHealthCheck(ConfigureHealthCheckRequest configureHealthCheckRequest) Specifies the health check settings to use when evaluating the health state of your back-end instances.
CreateAppCookieStickinessPolicyResult	createAppCookieStickinessPolicy(CreateAppCookieStickinessPolicyRequest createAppCookieStickinessPolicyRequest) Generates a stickiness policy with sticky session lifetimes that follow that of an application-generated cookie.
CreateLBCookieStickinessPolicyResult	createLBCookieStickinessPolicy(CreateLBCookieStickinessPolicyRequest createLBCookieStickinessPolicyRequest) Generates a stickiness policy with sticky session lifetimes controlled by the lifetime of the browser (user-agent) or a specified expiration period.
CreateLoadBalancerResult	createLoadBalancer(CreateLoadBalancerRequest createLoadBalancerRequest) Creates a load balancer.
CreateLoadBalancerListenersResult	createLoadBalancerListeners(CreateLoadBalancerListenersRequest createLoadBalancerListenersRequest) Creates one or more listeners for the specified load balancer.
CreateLoadBalancerPolicyResult	createLoadBalancerPolicy(CreateLoadBalancerPolicyRequest createLoadBalancerPolicyRequest) Creates a policy with the specified attributes for the specified load balancer.
DeleteLoadBalancerResult	deleteLoadBalancer(DeleteLoadBalancerRequest deleteLoadBalancerRequest) Deletes the specified load balancer.
DeleteLoadBalancerListenersResult	deleteLoadBalancerListeners(DeleteLoadBalancerListenersRequest deleteLoadBalancerListenersRequest) Deletes the specified listeners from the specified load balancer.
DeleteLoadBalancerPolicyResult	deleteLoadBalancerPolicy(DeleteLoadBalancerPolicyRequest deleteLoadBalancerPolicyRequest) Deletes the specified policy from the specified load balancer.
DeregisterInstancesFromLoadBalancerResult	deregisterInstancesFromLoadBalancer(DeregisterInstancesFromLoadBalancerRequest deregisterInstancesFromLoadBalancerRequest) Deregisters the specified instances from the specified load balancer.
DescribeInstanceHealthResult	describeInstanceHealth(DescribeInstanceHealthRequest describeInstanceHealthRequest) Describes the state of the specified instances with respect to the specified load balancer.
DescribeLoadBalancerAttributesResult	describeLoadBalancerAttributes(DescribeLoadBalancerAttributesRequest describeLoadBalancerAttributesRequest) Describes the attributes for the specified load balancer.
DescribeLoadBalancerPoliciesResult	describeLoadBalancerPolicies() Simplified method form for invoking the DescribeLoadBalancerPolicies operation.
DescribeLoadBalancerPoliciesResult	describeLoadBalancerPolicies(DescribeLoadBalancerPoliciesRequest describeLoadBalancerPoliciesRequest) Describes the specified policies.
DescribeLoadBalancerPolicyTypesResult	describeLoadBalancerPolicyTypes() Simplified method form for invoking the DescribeLoadBalancerPolicyTypes operation.
DescribeLoadBalancerPolicyTypesResult	describeLoadBalancerPolicyTypes(DescribeLoadBalancerPolicyTypesRequest describeLoadBalancerPolicyTypesRequest) Describes the specified load balancer policy types.
DescribeLoadBalancersResult	describeLoadBalancers() Simplified method form for invoking the DescribeLoadBalancers operation.
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.
SetLoadBalancerListenerSSLCertificateResult	setLoadBalancerListenerSSLCertificate(SetLoadBalancerListenerSSLCertificateRequest setLoadBalancerListenerSSLCertificateRequest) Sets the certificate that terminates the specified listener's SSL connections.
SetLoadBalancerPoliciesForBackendServerResult	setLoadBalancerPoliciesForBackendServer(SetLoadBalancerPoliciesForBackendServerRequest setLoadBalancerPoliciesForBackendServerRequest) Replaces the set of policies associated with the specified port on which the 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.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

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, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.elasticloadbalancing.AmazonElasticLoadBalancing

setEndpoint, setRegion, shutdown

Field Detail

configFactory

protected static final ClientConfigurationFactory configFactory

Client configuration factory providing ClientConfigurations tailored to this client

exceptionUnmarshallers

protected final List<com.amazonaws.transform.Unmarshaller<AmazonServiceException,Node>> exceptionUnmarshallers

List of exception unmarshallers for all Elastic Load Balancing exceptions.

Constructor Detail

AmazonElasticLoadBalancingClient

public AmazonElasticLoadBalancingClient()

Constructs a new client to invoke service methods on Elastic Load Balancing. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

See Also:

DefaultAWSCredentialsProviderChain

AmazonElasticLoadBalancingClient

public AmazonElasticLoadBalancingClient(ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on Elastic Load Balancing. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

clientConfiguration - The client configuration options controlling how this client connects to Elastic Load Balancing (ex: proxy settings, retry counts, etc.).

See Also:

DefaultAWSCredentialsProviderChain

AmazonElasticLoadBalancingClient

public AmazonElasticLoadBalancingClient(AWSCredentials awsCredentials)

Constructs a new client to invoke service methods on Elastic Load Balancing using the specified AWS account credentials.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

AmazonElasticLoadBalancingClient

public AmazonElasticLoadBalancingClient(AWSCredentials awsCredentials,
                                ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on Elastic Load Balancing using the specified AWS account credentials and client configuration options.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

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 Elastic Load Balancing (ex: proxy settings, retry counts, etc.).

AmazonElasticLoadBalancingClient

public AmazonElasticLoadBalancingClient(AWSCredentialsProvider awsCredentialsProvider)

Constructs a new client to invoke service methods on Elastic Load Balancing using the specified AWS account credentials provider.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

AmazonElasticLoadBalancingClient

public AmazonElasticLoadBalancingClient(AWSCredentialsProvider awsCredentialsProvider,
                                ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on Elastic Load Balancing using the specified AWS account credentials provider and client configuration options.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

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 Elastic Load Balancing (ex: proxy settings, retry counts, etc.).

AmazonElasticLoadBalancingClient

public AmazonElasticLoadBalancingClient(AWSCredentialsProvider awsCredentialsProvider,
                                ClientConfiguration clientConfiguration,
                                RequestMetricCollector requestMetricCollector)

Constructs a new client to invoke service methods on Elastic Load Balancing using the specified AWS account credentials provider, client configuration options, and request metric collector.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

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 Elastic Load Balancing (ex: proxy settings, retry counts, etc.).

requestMetricCollector - optional request metric collector

Method Detail

addTags

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 Tag Your Load Balancer in the Elastic Load Balancing Developer Guide.

Specified by:

addTags in interface AmazonElasticLoadBalancing

Parameters:

addTagsRequest -

Returns:

Result of the AddTags operation returned by the service.

Throws:

LoadBalancerNotFoundException - The specified load balancer does not exist.

TooManyTagsException - The quota for the number of tags that can be assigned to a load balancer has been reached.

DuplicateTagKeysException - A tag key was specified more than once.

applySecurityGroupsToLoadBalancer

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 Security Groups for Load Balancers in a VPC in the Elastic Load Balancing Developer Guide.

Specified by:

applySecurityGroupsToLoadBalancer in interface AmazonElasticLoadBalancing

Parameters:

applySecurityGroupsToLoadBalancerRequest -

Returns:

Result of the ApplySecurityGroupsToLoadBalancer operation returned by the service.

Throws:

LoadBalancerNotFoundException - The specified load balancer does not exist.

InvalidConfigurationRequestException - The requested configuration change is not valid.

InvalidSecurityGroupException - One or more of the specified security groups do not exist.

attachLoadBalancerToSubnets

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 Add or Remove Subnets for Your Load Balancer in a VPC in the Elastic Load Balancing Developer Guide.

Specified by:

attachLoadBalancerToSubnets in interface AmazonElasticLoadBalancing

Parameters:

attachLoadBalancerToSubnetsRequest -

Returns:

Result of the AttachLoadBalancerToSubnets operation returned by the service.

Throws:

LoadBalancerNotFoundException - The specified load balancer does not exist.

InvalidConfigurationRequestException - The requested configuration change is not valid.

SubnetNotFoundException - One or more of the specified subnets do not exist.

InvalidSubnetException - The specified VPC has no associated Internet gateway.

configureHealthCheck

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 Configure Health Checks in the Elastic Load Balancing Developer Guide.

Specified by:

configureHealthCheck in interface AmazonElasticLoadBalancing

Parameters:

configureHealthCheckRequest -

Returns:

Result of the ConfigureHealthCheck operation returned by the service.

Throws:

LoadBalancerNotFoundException - The specified load balancer does not exist.

createAppCookieStickinessPolicy

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.

Specified by:

createAppCookieStickinessPolicy in interface AmazonElasticLoadBalancing

Parameters:

createAppCookieStickinessPolicyRequest -

Returns:

Result of the CreateAppCookieStickinessPolicy operation returned by the service.

Throws:

LoadBalancerNotFoundException - The specified load balancer does not exist.

DuplicatePolicyNameException - A policy with the specified name already exists for this load balancer.

TooManyPoliciesException - The quota for the number of policies for this load balancer has been reached.

InvalidConfigurationRequestException - The requested configuration change is not valid.

createLBCookieStickinessPolicy

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.

Specified by:

createLBCookieStickinessPolicy in interface AmazonElasticLoadBalancing

Parameters:

createLBCookieStickinessPolicyRequest -

Returns:

Result of the CreateLBCookieStickinessPolicy operation returned by the service.

Throws:

LoadBalancerNotFoundException - The specified load balancer does not exist.

DuplicatePolicyNameException - A policy with the specified name already exists for this load balancer.

TooManyPoliciesException - The quota for the number of policies for this load balancer has been reached.

InvalidConfigurationRequestException - The requested configuration change is not valid.

createLoadBalancer

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 load balancer receives incoming traffic and routes it to the registered instances. For more information, see How Elastic Load Balancing Works in the Elastic Load Balancing Developer Guide.

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

Specified by:

createLoadBalancer in interface AmazonElasticLoadBalancing

Parameters:

createLoadBalancerRequest -

Returns:

Result of the CreateLoadBalancer operation returned by the service.

Throws:

DuplicateLoadBalancerNameException - The specified load balancer name already exists for this account.

TooManyLoadBalancersException - The quota for the number of load balancers has been reached.

CertificateNotFoundException - The specified SSL ID does not refer to a valid SSL certificate in AWS Identity and Access Management (IAM).

InvalidConfigurationRequestException - The requested configuration change is not valid.

SubnetNotFoundException - One or more of the specified subnets do not exist.

InvalidSubnetException - The specified VPC has no associated Internet gateway.

InvalidSecurityGroupException - One or more of the specified security groups do not exist.

InvalidSchemeException - The specified value for the schema is not valid. You can only specify a scheme for load balancers in a VPC.

TooManyTagsException - The quota for the number of tags that can be assigned to a load balancer has been reached.

DuplicateTagKeysException - A tag key was specified more than once.

createLoadBalancerListeners

public CreateLoadBalancerListenersResult 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.

Specified by:

createLoadBalancerListeners in interface AmazonElasticLoadBalancing

Parameters:

createLoadBalancerListenersRequest -

Returns:

Result of the CreateLoadBalancerListeners operation returned by the service.

Throws:

LoadBalancerNotFoundException - The specified load balancer does not exist.

DuplicateListenerException - A listener already exists for the specified LoadBalancerName and LoadBalancerPort, but with a different InstancePort, Protocol, or SSLCertificateId.

CertificateNotFoundException - The specified SSL ID does not refer to a valid SSL certificate in AWS Identity and Access Management (IAM).

InvalidConfigurationRequestException - The requested configuration change is not valid.

createLoadBalancerPolicy

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.

Specified by:

createLoadBalancerPolicy in interface AmazonElasticLoadBalancing

Parameters:

createLoadBalancerPolicyRequest -

Returns:

Result of the CreateLoadBalancerPolicy operation returned by the service.

Throws:

LoadBalancerNotFoundException - The specified load balancer does not exist.

PolicyTypeNotFoundException - One or more of the specified policy types do not exist.

DuplicatePolicyNameException - A policy with the specified name already exists for this load balancer.

TooManyPoliciesException - The quota for the number of policies for this load balancer has been reached.

InvalidConfigurationRequestException - The requested configuration change is not valid.

deleteLoadBalancer

public DeleteLoadBalancerResult 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.

Specified by:

deleteLoadBalancer in interface AmazonElasticLoadBalancing

Parameters:

deleteLoadBalancerRequest -

Returns:

Result of the DeleteLoadBalancer operation returned by the service.

deleteLoadBalancerListeners

public DeleteLoadBalancerListenersResult deleteLoadBalancerListeners(DeleteLoadBalancerListenersRequest deleteLoadBalancerListenersRequest)

Deletes the specified listeners from the specified load balancer.

Specified by:

deleteLoadBalancerListeners in interface AmazonElasticLoadBalancing

Parameters:

deleteLoadBalancerListenersRequest -

Returns:

Result of the DeleteLoadBalancerListeners operation returned by the service.

Throws:

LoadBalancerNotFoundException - The specified load balancer does not exist.

deleteLoadBalancerPolicy

public DeleteLoadBalancerPolicyResult deleteLoadBalancerPolicy(DeleteLoadBalancerPolicyRequest deleteLoadBalancerPolicyRequest)

Deletes the specified policy from the specified load balancer. This policy must not be enabled for any listeners.

Specified by:

deleteLoadBalancerPolicy in interface AmazonElasticLoadBalancing

Parameters:

deleteLoadBalancerPolicyRequest - =

Returns:

Result of the DeleteLoadBalancerPolicy operation returned by the service.

Throws:

LoadBalancerNotFoundException - The specified load balancer does not exist.

InvalidConfigurationRequestException - The requested configuration change is not valid.

deregisterInstancesFromLoadBalancer

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.

Specified by:

deregisterInstancesFromLoadBalancer in interface AmazonElasticLoadBalancing

Parameters:

deregisterInstancesFromLoadBalancerRequest -

Returns:

Result of the DeregisterInstancesFromLoadBalancer operation returned by the service.

Throws:

LoadBalancerNotFoundException - The specified load balancer does not exist.

InvalidInstanceException - The specified endpoint is not valid.

describeInstanceHealth

public DescribeInstanceHealthResult describeInstanceHealth(DescribeInstanceHealthRequest describeInstanceHealthRequest)

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

Specified by:

describeInstanceHealth in interface AmazonElasticLoadBalancing

Parameters:

describeInstanceHealthRequest -

Returns:

Result of the DescribeInstanceHealth operation returned by the service.

Throws:

LoadBalancerNotFoundException - The specified load balancer does not exist.

InvalidInstanceException - The specified endpoint is not valid.

describeLoadBalancerAttributes

public DescribeLoadBalancerAttributesResult describeLoadBalancerAttributes(DescribeLoadBalancerAttributesRequest describeLoadBalancerAttributesRequest)

Describes the attributes for the specified load balancer.

Specified by:

describeLoadBalancerAttributes in interface AmazonElasticLoadBalancing

Parameters:

describeLoadBalancerAttributesRequest -

Returns:

Result of the DescribeLoadBalancerAttributes operation returned by the service.

Throws:

LoadBalancerNotFoundException - The specified load balancer does not exist.

LoadBalancerAttributeNotFoundException - The specified load balancer attribute does not exist.

describeLoadBalancerPolicies

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.

Specified by:

describeLoadBalancerPolicies in interface AmazonElasticLoadBalancing

Parameters:

describeLoadBalancerPoliciesRequest -

Returns:

Result of the DescribeLoadBalancerPolicies operation returned by the service.

Throws:

LoadBalancerNotFoundException - The specified load balancer does not exist.

PolicyNotFoundException - One or more of the specified policies do not exist.

describeLoadBalancerPolicies

public DescribeLoadBalancerPoliciesResult describeLoadBalancerPolicies()

Description copied from interface: AmazonElasticLoadBalancing

Simplified method form for invoking the DescribeLoadBalancerPolicies operation.

Specified by:

describeLoadBalancerPolicies in interface AmazonElasticLoadBalancing

See Also:

AmazonElasticLoadBalancing.describeLoadBalancerPolicies(DescribeLoadBalancerPoliciesRequest)

describeLoadBalancerPolicyTypes

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

Specified by:

describeLoadBalancerPolicyTypes in interface AmazonElasticLoadBalancing

Parameters:

describeLoadBalancerPolicyTypesRequest -

Returns:

Result of the DescribeLoadBalancerPolicyTypes operation returned by the service.

Throws:

PolicyTypeNotFoundException - One or more of the specified policy types do not exist.

describeLoadBalancerPolicyTypes

public DescribeLoadBalancerPolicyTypesResult describeLoadBalancerPolicyTypes()

Description copied from interface: AmazonElasticLoadBalancing

Simplified method form for invoking the DescribeLoadBalancerPolicyTypes operation.

Specified by:

describeLoadBalancerPolicyTypes in interface AmazonElasticLoadBalancing

See Also:

AmazonElasticLoadBalancing.describeLoadBalancerPolicyTypes(DescribeLoadBalancerPolicyTypesRequest)

describeLoadBalancers

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.

Specified by:

describeLoadBalancers in interface AmazonElasticLoadBalancing

Parameters:

describeLoadBalancersRequest -

Returns:

Result of the DescribeLoadBalancers operation returned by the service.

Throws:

LoadBalancerNotFoundException - The specified load balancer does not exist.

describeLoadBalancers

public DescribeLoadBalancersResult describeLoadBalancers()

Description copied from interface: AmazonElasticLoadBalancing

Simplified method form for invoking the DescribeLoadBalancers operation.

Specified by:

describeLoadBalancers in interface AmazonElasticLoadBalancing

See Also:

AmazonElasticLoadBalancing.describeLoadBalancers(DescribeLoadBalancersRequest)

describeTags

public DescribeTagsResult describeTags(DescribeTagsRequest describeTagsRequest)

Describes the tags associated with the specified load balancers.

Specified by:

describeTags in interface AmazonElasticLoadBalancing

Parameters:

describeTagsRequest -

Returns:

Result of the DescribeTags operation returned by the service.

Throws:

LoadBalancerNotFoundException - The specified load balancer does not exist.

detachLoadBalancerFromSubnets

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.

Specified by:

detachLoadBalancerFromSubnets in interface AmazonElasticLoadBalancing

Parameters:

detachLoadBalancerFromSubnetsRequest -

Returns:

Result of the DetachLoadBalancerFromSubnets operation returned by the service.

Throws:

LoadBalancerNotFoundException - The specified load balancer does not exist.

InvalidConfigurationRequestException - The requested configuration change is not valid.

disableAvailabilityZonesForLoadBalancer

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.

Specified by:

disableAvailabilityZonesForLoadBalancer in interface AmazonElasticLoadBalancing

Parameters:

disableAvailabilityZonesForLoadBalancerRequest -

Returns:

Result of the DisableAvailabilityZonesForLoadBalancer operation returned by the service.

Throws:

LoadBalancerNotFoundException - The specified load balancer does not exist.

InvalidConfigurationRequestException - The requested configuration change is not valid.

enableAvailabilityZonesForLoadBalancer

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.

Specified by:

enableAvailabilityZonesForLoadBalancer in interface AmazonElasticLoadBalancing

Parameters:

enableAvailabilityZonesForLoadBalancerRequest -

Returns:

Result of the EnableAvailabilityZonesForLoadBalancer operation returned by the service.

Throws:

LoadBalancerNotFoundException - The specified load balancer does not exist.

modifyLoadBalancerAttributes

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:

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

Specified by:

modifyLoadBalancerAttributes in interface AmazonElasticLoadBalancing

Parameters:

modifyLoadBalancerAttributesRequest -

Returns:

Result of the ModifyLoadBalancerAttributes operation returned by the service.

Throws:

LoadBalancerNotFoundException - The specified load balancer does not exist.

LoadBalancerAttributeNotFoundException - The specified load balancer attribute does not exist.

InvalidConfigurationRequestException - The requested configuration change is not valid.

registerInstancesWithLoadBalancer

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 takes a little time to complete. To check the state of the registered instances, use DescribeLoadBalancers or DescribeInstanceHealth.

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

If you stop an instance registered with a load balancer and then start it, the IP addresses associated with the instance changes. Elastic Load Balancing cannot recognize the new IP address, which prevents it from routing traffic to the instances. We recommend that you use the following sequence: stop the instance, deregister the instance, start the instance, and then register the instance. To deregister instances from a load balancer, use DeregisterInstancesFromLoadBalancer.

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

Specified by:

registerInstancesWithLoadBalancer in interface AmazonElasticLoadBalancing

Parameters:

registerInstancesWithLoadBalancerRequest -

Returns:

Result of the RegisterInstancesWithLoadBalancer operation returned by the service.

Throws:

LoadBalancerNotFoundException - The specified load balancer does not exist.

InvalidInstanceException - The specified endpoint is not valid.

removeTags

public RemoveTagsResult removeTags(RemoveTagsRequest removeTagsRequest)

Removes one or more tags from the specified load balancer.

Specified by:

removeTags in interface AmazonElasticLoadBalancing

Parameters:

removeTagsRequest -

Returns:

Result of the RemoveTags operation returned by the service.

Throws:

LoadBalancerNotFoundException - The specified load balancer does not exist.

setLoadBalancerListenerSSLCertificate

public SetLoadBalancerListenerSSLCertificateResult 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.

Specified by:

setLoadBalancerListenerSSLCertificate in interface AmazonElasticLoadBalancing

Parameters:

setLoadBalancerListenerSSLCertificateRequest -

Returns:

Result of the SetLoadBalancerListenerSSLCertificate operation returned by the service.

Throws:

CertificateNotFoundException - The specified SSL ID does not refer to a valid SSL certificate in AWS Identity and Access Management (IAM).

LoadBalancerNotFoundException - The specified load balancer does not exist.

ListenerNotFoundException - The load balancer does not have a listener configured at the specified port.

InvalidConfigurationRequestException - The requested configuration change is not valid.

setLoadBalancerPoliciesForBackendServer

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.

Specified by:

setLoadBalancerPoliciesForBackendServer in interface AmazonElasticLoadBalancing

Parameters:

setLoadBalancerPoliciesForBackendServerRequest -

Returns:

Result of the SetLoadBalancerPoliciesForBackendServer operation returned by the service.

Throws:

LoadBalancerNotFoundException - The specified load balancer does not exist.

PolicyNotFoundException - One or more of the specified policies do not exist.

InvalidConfigurationRequestException - The requested configuration change is not valid.

setLoadBalancerPoliciesOfListener

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.

Specified by:

setLoadBalancerPoliciesOfListener in interface AmazonElasticLoadBalancing

Parameters:

setLoadBalancerPoliciesOfListenerRequest -

Returns:

Result of the SetLoadBalancerPoliciesOfListener operation returned by the service.

Throws:

LoadBalancerNotFoundException - The specified load balancer does not exist.

PolicyNotFoundException - One or more of the specified policies do not exist.

ListenerNotFoundException - The load balancer does not have a listener configured at the specified port.

InvalidConfigurationRequestException - The requested configuration change is not valid.

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.

Specified by:

getCachedResponseMetadata in interface AmazonElasticLoadBalancing

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.