com.amazonaws.services.elasticloadbalancing

Interface AmazonElasticLoadBalancing

All Known Subinterfaces:

AmazonElasticLoadBalancingAsync

All Known Implementing Classes:

AbstractAmazonElasticLoadBalancing, AbstractAmazonElasticLoadBalancingAsync, AmazonElasticLoadBalancingAsyncClient, AmazonElasticLoadBalancingClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonElasticLoadBalancing

Interface for accessing Elastic Load Balancing.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonElasticLoadBalancing instead.

Elastic Load Balancing

A load balancer distributes incoming traffic across your EC2 instances. This enables you to increase the availability of your application. The load balancer also monitors the health of its registered instances and ensures that it routes traffic only to healthy instances. You configure your load balancer to accept incoming traffic by specifying one or more listeners, which are configured with a protocol and port number for connections from clients to the load balancer and a protocol and port number for connections from the load balancer to the instances.

Elastic Load Balancing supports two types of load balancers: Classic Load Balancers and Application Load Balancers (new). A Classic Load Balancer makes routing and load balancing decisions either at the transport layer (TCP/SSL) or the application layer (HTTP/HTTPS), and supports either EC2-Classic or a VPC. An Application Load Balancer makes routing and load balancing decisions at the application layer (HTTP/HTTPS), supports path-based routing, and can route requests to one or more ports on each EC2 instance or container instance in your virtual private cloud (VPC). For more information, see the Elastic Load Balancing User Guide.

This reference covers the 2012-06-01 API, which supports Classic Load Balancers. The 2015-12-01 API supports Application Load Balancers.

To get started, create a load balancer with one or more listeners using CreateLoadBalancer. Register your instances with the load balancer using RegisterInstancesWithLoadBalancer.

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
AddTagsResult	addTags(AddTagsRequest addTagsRequest) Adds the specified tags to the specified load balancer.
ApplySecurityGroupsToLoadBalancerResult	applySecurityGroupsToLoadBalancer(ApplySecurityGroupsToLoadBalancerRequest applySecurityGroupsToLoadBalancerRequest) Associates one or more security groups with your load balancer in a virtual private cloud (VPC).
AttachLoadBalancerToSubnetsResult	attachLoadBalancerToSubnets(AttachLoadBalancerToSubnetsRequest attachLoadBalancerToSubnetsRequest) Adds one or more subnets to the set of configured subnets for the specified load balancer.
ConfigureHealthCheckResult	configureHealthCheck(ConfigureHealthCheckRequest configureHealthCheckRequest) Specifies the health check settings to use when evaluating the health state of your EC2 instances.
CreateAppCookieStickinessPolicyResult	createAppCookieStickinessPolicy(CreateAppCookieStickinessPolicyRequest createAppCookieStickinessPolicyRequest) Generates a stickiness policy with sticky session lifetimes that follow that of an application-generated cookie.
CreateLBCookieStickinessPolicyResult	createLBCookieStickinessPolicy(CreateLBCookieStickinessPolicyRequest createLBCookieStickinessPolicyRequest) Generates a stickiness policy with sticky session lifetimes controlled by the lifetime of the browser (user-agent) or a specified expiration period.
CreateLoadBalancerResult	createLoadBalancer(CreateLoadBalancerRequest createLoadBalancerRequest) Creates a Classic Load Balancer.
CreateLoadBalancerListenersResult	createLoadBalancerListeners(CreateLoadBalancerListenersRequest createLoadBalancerListenersRequest) Creates one or more listeners for the specified load balancer.
CreateLoadBalancerPolicyResult	createLoadBalancerPolicy(CreateLoadBalancerPolicyRequest createLoadBalancerPolicyRequest) Creates a policy with the specified attributes for the specified load balancer.
DeleteLoadBalancerResult	deleteLoadBalancer(DeleteLoadBalancerRequest deleteLoadBalancerRequest) Deletes the specified load balancer.
DeleteLoadBalancerListenersResult	deleteLoadBalancerListeners(DeleteLoadBalancerListenersRequest deleteLoadBalancerListenersRequest) Deletes the specified listeners from the specified load balancer.
DeleteLoadBalancerPolicyResult	deleteLoadBalancerPolicy(DeleteLoadBalancerPolicyRequest deleteLoadBalancerPolicyRequest) Deletes the specified policy from the specified load balancer.
DeregisterInstancesFromLoadBalancerResult	deregisterInstancesFromLoadBalancer(DeregisterInstancesFromLoadBalancerRequest deregisterInstancesFromLoadBalancerRequest) Deregisters the specified instances from the specified load balancer.
DescribeAccountLimitsResult	describeAccountLimits(DescribeAccountLimitsRequest describeAccountLimitsRequest) Describes the current Elastic Load Balancing resource limits for your AWS account.
DescribeInstanceHealthResult	describeInstanceHealth(DescribeInstanceHealthRequest describeInstanceHealthRequest) Describes the state of the specified instances with respect to the specified load balancer.
DescribeLoadBalancerAttributesResult	describeLoadBalancerAttributes(DescribeLoadBalancerAttributesRequest describeLoadBalancerAttributesRequest) Describes the attributes for the specified load balancer.
DescribeLoadBalancerPoliciesResult	describeLoadBalancerPolicies() 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 or all 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.
void	setEndpoint(String endpoint) Deprecated. use AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for example: builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));
SetLoadBalancerListenerSSLCertificateResult	setLoadBalancerListenerSSLCertificate(SetLoadBalancerListenerSSLCertificateRequest setLoadBalancerListenerSSLCertificateRequest) Sets the certificate that terminates the specified listener's SSL connections.
SetLoadBalancerPoliciesForBackendServerResult	setLoadBalancerPoliciesForBackendServer(SetLoadBalancerPoliciesForBackendServerRequest setLoadBalancerPoliciesForBackendServerRequest) Replaces the set of policies associated with the specified port on which the EC2 instance is listening with a new set of policies.
SetLoadBalancerPoliciesOfListenerResult	setLoadBalancerPoliciesOfListener(SetLoadBalancerPoliciesOfListenerRequest setLoadBalancerPoliciesOfListenerRequest) Replaces the current set of policies for the specified load balancer port with the specified set of policies.
void	setRegion(Region region) Deprecated. use AwsClientBuilder#setRegion(String)
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
AmazonElasticLoadBalancingWaiters	waiters()

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

setEndpoint

@Deprecated
void setEndpoint(String endpoint)

Deprecated. use AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for example: builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));

Overrides the default endpoint for this client ("elasticloadbalancing.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.

Callers can pass in just the endpoint (ex: "elasticloadbalancing.amazonaws.com") or a full URL, including the protocol (ex: "elasticloadbalancing.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.

For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912

This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

Parameters:

endpoint - The endpoint (ex: "elasticloadbalancing.amazonaws.com") or a full URL, including the protocol (ex: "elasticloadbalancing.amazonaws.com") of the region specific AWS endpoint this client will communicate with.

setRegion

@Deprecated
void setRegion(Region region)

Deprecated. use AwsClientBuilder#setRegion(String)

An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.

By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the ClientConfiguration supplied at construction.

This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

Parameters:

region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions) for accessing a given region. Must not be null and must be a region where the service is available.

See Also:

Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration), Region.isServiceSupported(String)

addTags

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 Classic Load Balancer in the Classic Load Balancer Guide.

Parameters:

addTagsRequest - Contains the parameters for AddTags.

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.

See Also:

AWS API Documentation

Samples:

• To add tags to a load balancer

  This example adds the specified tags to the specified load balancer.
  

  AmazonElasticLoadBalancing client = new AmazonElasticLoadBalancingClient();
  AddTagsRequest request = new AddTagsRequest()
          .withResourceArns(
                  "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188")
          .withTags(
                  new Tag().withKey("project").withValue("lima"),
                  new Tag().withKey("department").withValue(
                          "digital-media"));
  AddTagsResult response = client.addTags(request);

applySecurityGroupsToLoadBalancer

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 Classic Load Balancer Guide.

Parameters:

applySecurityGroupsToLoadBalancerRequest - Contains the parameters for ApplySecurityGroupsToLoadBalancer.

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.

See Also:

AWS API Documentation

attachLoadBalancerToSubnets

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 Classic Load Balancer Guide.

Parameters:

attachLoadBalancerToSubnetsRequest - Contains the parameters for AttachLoaBalancerToSubnets.

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.

See Also:

AWS API Documentation

configureHealthCheck

ConfigureHealthCheckResult configureHealthCheck(ConfigureHealthCheckRequest configureHealthCheckRequest)

Specifies the health check settings to use when evaluating the health state of your EC2 instances.

For more information, see Configure Health Checks for Your Load Balancer in the Classic Load Balancer Guide.

Parameters:

configureHealthCheckRequest - Contains the parameters for ConfigureHealthCheck.

Returns:

Result of the ConfigureHealthCheck operation returned by the service.

Throws:

LoadBalancerNotFoundException - The specified load balancer does not exist.

See Also:

AWS API Documentation

createAppCookieStickinessPolicy

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 Classic Load Balancer Guide.

Parameters:

createAppCookieStickinessPolicyRequest - Contains the parameters for CreateAppCookieStickinessPolicy.

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.

See Also:

AWS API Documentation

createLBCookieStickinessPolicy

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 instance for each request. When the load balancer receives a request, it first checks to see if this cookie is present in the request. If so, the load balancer sends the request to the application server specified in the cookie. If not, the load balancer sends the request to a server that is chosen based on the existing load-balancing algorithm.

A cookie is inserted into the response for binding subsequent requests from the same user to that server. The validity of the cookie is based on the cookie expiration time, which is specified in the policy configuration.

For more information, see Duration-Based Session Stickiness in the Classic Load Balancer Guide.

Parameters:

createLBCookieStickinessPolicyRequest - Contains the parameters for CreateLBCookieStickinessPolicy.

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.

See Also:

AWS API Documentation

createLoadBalancer

CreateLoadBalancerResult createLoadBalancer(CreateLoadBalancerRequest createLoadBalancerRequest)

Creates a Classic Load Balancer.

You can add listeners, security groups, subnets, and tags when you create your load balancer, or you can add them later using CreateLoadBalancerListeners, ApplySecurityGroupsToLoadBalancer, AttachLoadBalancerToSubnets, and AddTags.

To describe your current load balancers, see DescribeLoadBalancers. When you are finished with a load balancer, you can delete it using DeleteLoadBalancer.

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

Parameters:

createLoadBalancerRequest - Contains the parameters for CreateLoadBalancer.

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 ARN does not refer to a valid SSL certificate in AWS Identity and Access Management (IAM) or AWS Certificate Manager (ACM). Note that if you recently uploaded the certificate to IAM, this error might indicate that the certificate is not fully available yet.

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.

UnsupportedProtocolException - The specified protocol or signature version is not supported.

See Also:

AWS API Documentation

Samples:

• To create an internal load balancer

  This example creates an internal load balancer and enables the Availability Zones for the specified subnets.
  

  AmazonElasticLoadBalancing client = new AmazonElasticLoadBalancingClient();
  CreateLoadBalancerRequest request = new CreateLoadBalancerRequest()
          .withName("my-load-balancer").withSubnets("subnet-b7d581c0",
                  "subnet-8360a9e7");
  CreateLoadBalancerResult response = client.createLoadBalancer(request);AmazonElasticLoadBalancing client = new AmazonElasticLoadBalancingClient();
  CreateLoadBalancerRequest request = new CreateLoadBalancerRequest()
          .withName("my-internal-load-balancer").withScheme("internal")
          .withSecurityGroups()
          .withSubnets("subnet-b7d581c0", "subnet-8360a9e7");
  CreateLoadBalancerResult response = client.createLoadBalancer(request);

createLoadBalancerListeners

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 Listeners for Your Classic Load Balancer in the Classic Load Balancer Guide.

Parameters:

createLoadBalancerListenersRequest - Contains the parameters for CreateLoadBalancerListeners.

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 load balancer name and port, but with a different instance port, protocol, or SSL certificate.

CertificateNotFoundException - The specified ARN does not refer to a valid SSL certificate in AWS Identity and Access Management (IAM) or AWS Certificate Manager (ACM). Note that if you recently uploaded the certificate to IAM, this error might indicate that the certificate is not fully available yet.

InvalidConfigurationRequestException - The requested configuration change is not valid.

UnsupportedProtocolException - The specified protocol or signature version is not supported.

See Also:

AWS API Documentation

createLoadBalancerPolicy

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 listener or the application server, depending on the policy type.

Parameters:

createLoadBalancerPolicyRequest - Contains the parameters for CreateLoadBalancerPolicy.

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.

See Also:

AWS API Documentation

deleteLoadBalancer

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 your instances.

If the load balancer does not exist or has already been deleted, the call to DeleteLoadBalancer still succeeds.

Parameters:

deleteLoadBalancerRequest - Contains the parameters for DeleteLoadBalancer.

Returns:

Result of the DeleteLoadBalancer operation returned by the service.

See Also:

AWS API Documentation

Samples:

• To delete a load balancer

  This example deletes the specified load balancer.
  

  AmazonElasticLoadBalancing client = new AmazonElasticLoadBalancingClient();
  DeleteLoadBalancerRequest request = new DeleteLoadBalancerRequest()
          .withLoadBalancerArn("arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188");
  DeleteLoadBalancerResult response = client.deleteLoadBalancer(request);

deleteLoadBalancerListeners

DeleteLoadBalancerListenersResult deleteLoadBalancerListeners(DeleteLoadBalancerListenersRequest deleteLoadBalancerListenersRequest)

Deletes the specified listeners from the specified load balancer.

Parameters:

deleteLoadBalancerListenersRequest - Contains the parameters for DeleteLoadBalancerListeners.

Returns:

Result of the DeleteLoadBalancerListeners operation returned by the service.

Throws:

LoadBalancerNotFoundException - The specified load balancer does not exist.

See Also:

AWS API Documentation

deleteLoadBalancerPolicy

DeleteLoadBalancerPolicyResult deleteLoadBalancerPolicy(DeleteLoadBalancerPolicyRequest deleteLoadBalancerPolicyRequest)

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

Parameters:

deleteLoadBalancerPolicyRequest - Contains the parameters for DeleteLoadBalancerPolicy.

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.

See Also:

AWS API Documentation

deregisterInstancesFromLoadBalancer

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 Register or De-Register EC2 Instances in the Classic Load Balancer Guide.

Parameters:

deregisterInstancesFromLoadBalancerRequest - Contains the parameters for DeregisterInstancesFromLoadBalancer.

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.

See Also:

AWS API Documentation

describeAccountLimits

DescribeAccountLimitsResult describeAccountLimits(DescribeAccountLimitsRequest describeAccountLimitsRequest)

Describes the current Elastic Load Balancing resource limits for your AWS account.

For more information, see Limits for Your Classic Load Balancer in the Classic Load Balancer Guide.

Parameters:

describeAccountLimitsRequest -

Returns:

Result of the DescribeAccountLimits operation returned by the service.

See Also:

AWS API Documentation

describeInstanceHealth

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.

Parameters:

describeInstanceHealthRequest - Contains the parameters for DescribeInstanceHealth.

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.

See Also:

AWS API Documentation

describeLoadBalancerAttributes

DescribeLoadBalancerAttributesResult describeLoadBalancerAttributes(DescribeLoadBalancerAttributesRequest describeLoadBalancerAttributesRequest)

Describes the attributes for the specified load balancer.

Parameters:

describeLoadBalancerAttributesRequest - Contains the parameters for DescribeLoadBalancerAttributes.

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.

See Also:

AWS API Documentation

Samples:

• To describe load balancer attributes

  This example describes the attributes of the specified load balancer.
  

  AmazonElasticLoadBalancing client = new AmazonElasticLoadBalancingClient();
  DescribeLoadBalancerAttributesRequest request = new DescribeLoadBalancerAttributesRequest()
          .withLoadBalancerArn("arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188");
  DescribeLoadBalancerAttributesResult response = client
          .describeLoadBalancerAttributes(request);

describeLoadBalancerPolicies

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.

Parameters:

describeLoadBalancerPoliciesRequest - Contains the parameters for DescribeLoadBalancerPolicies.

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.

See Also:

AWS API Documentation

describeLoadBalancerPolicies

DescribeLoadBalancerPoliciesResult describeLoadBalancerPolicies()

Simplified method form for invoking the DescribeLoadBalancerPolicies operation.

See Also:

describeLoadBalancerPolicies(DescribeLoadBalancerPoliciesRequest)

describeLoadBalancerPolicyTypes

DescribeLoadBalancerPolicyTypesResult describeLoadBalancerPolicyTypes(DescribeLoadBalancerPolicyTypesRequest describeLoadBalancerPolicyTypesRequest)

Describes the specified load balancer policy types or all load balancer policy types.

The description of each type indicates how it can be used. For example, some policies can be used only with layer 7 listeners, some policies can be used only with layer 4 listeners, and some policies can be used only with your EC2 instances.

You can use CreateLoadBalancerPolicy to create a policy configuration for any of these policy types. Then, depending on the policy type, use either SetLoadBalancerPoliciesOfListener or SetLoadBalancerPoliciesForBackendServer to set the policy.

Parameters:

describeLoadBalancerPolicyTypesRequest - Contains the parameters for DescribeLoadBalancerPolicyTypes.

Returns:

Result of the DescribeLoadBalancerPolicyTypes operation returned by the service.

Throws:

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

See Also:

AWS API Documentation

describeLoadBalancerPolicyTypes

DescribeLoadBalancerPolicyTypesResult describeLoadBalancerPolicyTypes()

Simplified method form for invoking the DescribeLoadBalancerPolicyTypes operation.

See Also:

describeLoadBalancerPolicyTypes(DescribeLoadBalancerPolicyTypesRequest)

describeLoadBalancers

DescribeLoadBalancersResult describeLoadBalancers(DescribeLoadBalancersRequest describeLoadBalancersRequest)

Describes the specified the load balancers. If no load balancers are specified, the call describes all of your load balancers.

Parameters:

describeLoadBalancersRequest - Contains the parameters for DescribeLoadBalancers.

Returns:

Result of the DescribeLoadBalancers operation returned by the service.

Throws:

LoadBalancerNotFoundException - The specified load balancer does not exist.

DependencyThrottleException

See Also:

AWS API Documentation

Samples:

• To describe a load balancer

  This example describes the specified load balancer.
  

  AmazonElasticLoadBalancing client = new AmazonElasticLoadBalancingClient();
  DescribeLoadBalancersRequest request = new DescribeLoadBalancersRequest()
          .withLoadBalancerArns("arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188");
  DescribeLoadBalancersResult response = client
          .describeLoadBalancers(request);

describeLoadBalancers

DescribeLoadBalancersResult describeLoadBalancers()

Simplified method form for invoking the DescribeLoadBalancers operation.

See Also:

describeLoadBalancers(DescribeLoadBalancersRequest)

describeTags

DescribeTagsResult describeTags(DescribeTagsRequest describeTagsRequest)

Describes the tags associated with the specified load balancers.

Parameters:

describeTagsRequest - Contains the parameters for DescribeTags.

Returns:

Result of the DescribeTags operation returned by the service.

Throws:

LoadBalancerNotFoundException - The specified load balancer does not exist.

See Also:

AWS API Documentation

Samples:

• To describe the tags assigned to a load balancer

  This example describes the tags assigned to the specified load balancer.
  

  AmazonElasticLoadBalancing client = new AmazonElasticLoadBalancingClient();
  DescribeTagsRequest request = new DescribeTagsRequest()
          .withResourceArns("arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188");
  DescribeTagsResult response = client.describeTags(request);

detachLoadBalancerFromSubnets

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.

Parameters:

detachLoadBalancerFromSubnetsRequest - Contains the parameters for DetachLoadBalancerFromSubnets.

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.

See Also:

AWS API Documentation

disableAvailabilityZonesForLoadBalancer

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 Add or Remove Availability Zones in the Classic Load Balancer Guide.

Parameters:

disableAvailabilityZonesForLoadBalancerRequest - Contains the parameters for DisableAvailabilityZonesForLoadBalancer.

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.

See Also:

AWS API Documentation

enableAvailabilityZonesForLoadBalancer

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 or Remove Availability Zones in the Classic Load Balancer Guide.

Parameters:

enableAvailabilityZonesForLoadBalancerRequest - Contains the parameters for EnableAvailabilityZonesForLoadBalancer.

Returns:

Result of the EnableAvailabilityZonesForLoadBalancer operation returned by the service.

Throws:

LoadBalancerNotFoundException - The specified load balancer does not exist.

See Also:

AWS API Documentation

modifyLoadBalancerAttributes

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 Classic Load Balancer Guide:

• Cross- Zone Load Balancing

• Connection Draining

• Access Logs

• Idle Connection Timeout

Parameters:

modifyLoadBalancerAttributesRequest - Contains the parameters for ModifyLoadBalancerAttributes.

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.

See Also:

AWS API Documentation

Samples:

• To enable access logs

  This example enables access logs for the specified load balancer. Note that the S3 bucket must exist in the same region as the load balancer and must have a policy attached that grants access to the Elastic Load Balancing service.
  

  AmazonElasticLoadBalancing client = new AmazonElasticLoadBalancingClient();
  ModifyLoadBalancerAttributesRequest request = new ModifyLoadBalancerAttributesRequest()
          .withAttributes(
                  new LoadBalancerAttribute().withKey(
                          "deletion_protection.enabled")
                          .withValue("true"))
          .withLoadBalancerArn(
                  "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188");
  ModifyLoadBalancerAttributesResult response = client
          .modifyLoadBalancerAttributes(request);AmazonElasticLoadBalancing client = new AmazonElasticLoadBalancingClient();
  ModifyLoadBalancerAttributesRequest request = new ModifyLoadBalancerAttributesRequest()
          .withAttributes(
                  new LoadBalancerAttribute().withKey(
                          "idle_timeout.timeout_seconds").withValue("30"))
          .withLoadBalancerArn(
                  "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188");
  ModifyLoadBalancerAttributesResult response = client
          .modifyLoadBalancerAttributes(request);AmazonElasticLoadBalancing client = new AmazonElasticLoadBalancingClient();
  ModifyLoadBalancerAttributesRequest request = new ModifyLoadBalancerAttributesRequest()
          .withAttributes(
                  new LoadBalancerAttribute().withKey(
                          "access_logs.s3.enabled").withValue("true"),
                  new LoadBalancerAttribute().withKey(
                          "access_logs.s3.bucket").withValue(
                          "my-loadbalancer-logs"),
                  new LoadBalancerAttribute().withKey(
                          "access_logs.s3.prefix").withValue("myapp"))
          .withLoadBalancerArn(
                  "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188");
  ModifyLoadBalancerAttributesResult response = client
          .modifyLoadBalancerAttributes(request);

registerInstancesWithLoadBalancer

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.

To deregister instances from a load balancer, use DeregisterInstancesFromLoadBalancer.

For more information, see Register or De-Register EC2 Instances in the Classic Load Balancer Guide.

Parameters:

registerInstancesWithLoadBalancerRequest - Contains the parameters for RegisterInstancesWithLoadBalancer.

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.

See Also:

AWS API Documentation

removeTags

RemoveTagsResult removeTags(RemoveTagsRequest removeTagsRequest)

Removes one or more tags from the specified load balancer.

Parameters:

removeTagsRequest - Contains the parameters for RemoveTags.

Returns:

Result of the RemoveTags operation returned by the service.

Throws:

LoadBalancerNotFoundException - The specified load balancer does not exist.

See Also:

AWS API Documentation

Samples:

• To remove tags from a load balancer

  This example removes the specified tags from the specified load balancer.
  

  AmazonElasticLoadBalancing client = new AmazonElasticLoadBalancingClient();
  RemoveTagsRequest request = new RemoveTagsRequest()
          .withResourceArns(
                  "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188")
          .withTagKeys("project", "department");
  RemoveTagsResult response = client.removeTags(request);

setLoadBalancerListenerSSLCertificate

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 Replace the SSL Certificate for Your Load Balancer in the Classic Load Balancer Guide.

Parameters:

setLoadBalancerListenerSSLCertificateRequest - Contains the parameters for SetLoadBalancerListenerSSLCertificate.

Returns:

Result of the SetLoadBalancerListenerSSLCertificate operation returned by the service.

Throws:

CertificateNotFoundException - The specified ARN does not refer to a valid SSL certificate in AWS Identity and Access Management (IAM) or AWS Certificate Manager (ACM). Note that if you recently uploaded the certificate to IAM, this error might indicate that the certificate is not fully available yet.

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.

UnsupportedProtocolException - The specified protocol or signature version is not supported.

See Also:

AWS API Documentation

setLoadBalancerPoliciesForBackendServer

SetLoadBalancerPoliciesForBackendServerResult setLoadBalancerPoliciesForBackendServer(SetLoadBalancerPoliciesForBackendServerRequest setLoadBalancerPoliciesForBackendServerRequest)

Replaces the set of policies associated with the specified port on which the EC2 instance is listening with a new set of policies. At this time, only the back-end server authentication policy type can be applied to the instance ports; this policy type is composed of multiple public key policies.

Each time you use SetLoadBalancerPoliciesForBackendServer to enable the policies, use the PolicyNames parameter to list the policies that you want to enable.

You can use DescribeLoadBalancers or DescribeLoadBalancerPolicies to verify that the policy is associated with the EC2 instance.

For more information about enabling back-end instance authentication, see Configure Back-end Instance Authentication in the Classic Load Balancer Guide. For more information about Proxy Protocol, see Configure Proxy Protocol Support in the Classic Load Balancer Guide.

Parameters:

setLoadBalancerPoliciesForBackendServerRequest - Contains the parameters for SetLoadBalancerPoliciesForBackendServer.

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.

See Also:

AWS API Documentation

setLoadBalancerPoliciesOfListener

SetLoadBalancerPoliciesOfListenerResult setLoadBalancerPoliciesOfListener(SetLoadBalancerPoliciesOfListenerRequest setLoadBalancerPoliciesOfListenerRequest)

Replaces the current set of policies for the specified load balancer port with the specified set of policies.

To enable back-end server authentication, use SetLoadBalancerPoliciesForBackendServer.

For more information about setting policies, see Update the SSL Negotiation Configuration, Duration-Based Session Stickiness, and Application-Controlled Session Stickiness in the Classic Load Balancer Guide.

Parameters:

setLoadBalancerPoliciesOfListenerRequest - Contains the parameters for SetLoadBalancePoliciesOfListener.

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.

See Also:

AWS API Documentation

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

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 a request.

Parameters:

request - The originally executed request.

Returns:

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

waiters

AmazonElasticLoadBalancingWaiters waiters()