@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonElasticLoadBalancingClient extends AmazonWebServiceClient implements AmazonElasticLoadBalancing
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.
LOGGING_AWS_REQUEST_METRIC
ENDPOINT_PREFIX
Constructor and Description |
---|
AmazonElasticLoadBalancingClient()
Deprecated.
|
AmazonElasticLoadBalancingClient(AWSCredentials awsCredentials)
Deprecated.
use
AwsClientBuilder.withCredentials(AWSCredentialsProvider) for
example:
AmazonElasticLoadBalancingClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build(); |
AmazonElasticLoadBalancingClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration)
|
AmazonElasticLoadBalancingClient(AWSCredentialsProvider awsCredentialsProvider)
Deprecated.
|
AmazonElasticLoadBalancingClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
|
AmazonElasticLoadBalancingClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
RequestMetricCollector requestMetricCollector)
|
AmazonElasticLoadBalancingClient(ClientConfiguration clientConfiguration)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
AddTagsResult |
addTags(AddTagsRequest request)
Adds the specified tags to the specified load balancer.
|
ApplySecurityGroupsToLoadBalancerResult |
applySecurityGroupsToLoadBalancer(ApplySecurityGroupsToLoadBalancerRequest request)
Associates one or more security groups with your load balancer in a virtual private cloud (VPC).
|
AttachLoadBalancerToSubnetsResult |
attachLoadBalancerToSubnets(AttachLoadBalancerToSubnetsRequest request)
Adds one or more subnets to the set of configured subnets for the specified load balancer.
|
static AmazonElasticLoadBalancingClientBuilder |
builder() |
ConfigureHealthCheckResult |
configureHealthCheck(ConfigureHealthCheckRequest request)
Specifies the health check settings to use when evaluating the health state of your EC2 instances.
|
CreateAppCookieStickinessPolicyResult |
createAppCookieStickinessPolicy(CreateAppCookieStickinessPolicyRequest request)
Generates a stickiness policy with sticky session lifetimes that follow that of an application-generated cookie.
|
CreateLBCookieStickinessPolicyResult |
createLBCookieStickinessPolicy(CreateLBCookieStickinessPolicyRequest request)
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 request)
Creates a Classic Load Balancer.
|
CreateLoadBalancerListenersResult |
createLoadBalancerListeners(CreateLoadBalancerListenersRequest request)
Creates one or more listeners for the specified load balancer.
|
CreateLoadBalancerPolicyResult |
createLoadBalancerPolicy(CreateLoadBalancerPolicyRequest request)
Creates a policy with the specified attributes for the specified load balancer.
|
DeleteLoadBalancerResult |
deleteLoadBalancer(DeleteLoadBalancerRequest request)
Deletes the specified load balancer.
|
DeleteLoadBalancerListenersResult |
deleteLoadBalancerListeners(DeleteLoadBalancerListenersRequest request)
Deletes the specified listeners from the specified load balancer.
|
DeleteLoadBalancerPolicyResult |
deleteLoadBalancerPolicy(DeleteLoadBalancerPolicyRequest request)
Deletes the specified policy from the specified load balancer.
|
DeregisterInstancesFromLoadBalancerResult |
deregisterInstancesFromLoadBalancer(DeregisterInstancesFromLoadBalancerRequest request)
Deregisters the specified instances from the specified load balancer.
|
DescribeAccountLimitsResult |
describeAccountLimits(DescribeAccountLimitsRequest request)
Describes the current Elastic Load Balancing resource limits for your AWS account.
|
DescribeInstanceHealthResult |
describeInstanceHealth(DescribeInstanceHealthRequest request)
Describes the state of the specified instances with respect to the specified load balancer.
|
DescribeLoadBalancerAttributesResult |
describeLoadBalancerAttributes(DescribeLoadBalancerAttributesRequest request)
Describes the attributes for the specified load balancer.
|
DescribeLoadBalancerPoliciesResult |
describeLoadBalancerPolicies()
Simplified method form for invoking the DescribeLoadBalancerPolicies operation.
|
DescribeLoadBalancerPoliciesResult |
describeLoadBalancerPolicies(DescribeLoadBalancerPoliciesRequest request)
Describes the specified policies.
|
DescribeLoadBalancerPolicyTypesResult |
describeLoadBalancerPolicyTypes()
Simplified method form for invoking the DescribeLoadBalancerPolicyTypes operation.
|
DescribeLoadBalancerPolicyTypesResult |
describeLoadBalancerPolicyTypes(DescribeLoadBalancerPolicyTypesRequest request)
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 request)
Describes the specified the load balancers.
|
DescribeTagsResult |
describeTags(DescribeTagsRequest request)
Describes the tags associated with the specified load balancers.
|
DetachLoadBalancerFromSubnetsResult |
detachLoadBalancerFromSubnets(DetachLoadBalancerFromSubnetsRequest request)
Removes the specified subnets from the set of configured subnets for the load balancer.
|
DisableAvailabilityZonesForLoadBalancerResult |
disableAvailabilityZonesForLoadBalancer(DisableAvailabilityZonesForLoadBalancerRequest request)
Removes the specified Availability Zones from the set of Availability Zones for the specified load balancer.
|
EnableAvailabilityZonesForLoadBalancerResult |
enableAvailabilityZonesForLoadBalancer(EnableAvailabilityZonesForLoadBalancerRequest request)
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 request)
Modifies the attributes of the specified load balancer.
|
RegisterInstancesWithLoadBalancerResult |
registerInstancesWithLoadBalancer(RegisterInstancesWithLoadBalancerRequest request)
Adds the specified instances to the specified load balancer.
|
RemoveTagsResult |
removeTags(RemoveTagsRequest request)
Removes one or more tags from the specified load balancer.
|
SetLoadBalancerListenerSSLCertificateResult |
setLoadBalancerListenerSSLCertificate(SetLoadBalancerListenerSSLCertificateRequest request)
Sets the certificate that terminates the specified listener's SSL connections.
|
SetLoadBalancerPoliciesForBackendServerResult |
setLoadBalancerPoliciesForBackendServer(SetLoadBalancerPoliciesForBackendServerRequest request)
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 request)
Replaces the current set of policies for the specified load balancer port with the specified set of policies.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held
open.
|
AmazonElasticLoadBalancingWaiters |
waiters() |
addRequestHandler, addRequestHandler, configureRegion, getEndpointPrefix, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
setEndpoint, setRegion
@Deprecated public AmazonElasticLoadBalancingClient()
AmazonElasticLoadBalancingClientBuilder.defaultClient()
All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChain
@Deprecated public AmazonElasticLoadBalancingClient(ClientConfiguration clientConfiguration)
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
clientConfiguration
- The client configuration options controlling how this client connects to Elastic Load Balancing (ex: proxy
settings, retry counts, etc.).DefaultAWSCredentialsProviderChain
@Deprecated public AmazonElasticLoadBalancingClient(AWSCredentials awsCredentials)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
for
example:
AmazonElasticLoadBalancingClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials
- The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.@Deprecated public AmazonElasticLoadBalancingClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials
- The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.clientConfiguration
- The client configuration options controlling how this client connects to Elastic Load Balancing (ex: proxy
settings, retry counts, etc.).@Deprecated public AmazonElasticLoadBalancingClient(AWSCredentialsProvider awsCredentialsProvider)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.@Deprecated public AmazonElasticLoadBalancingClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration
- The client configuration options controlling how this client connects to Elastic Load Balancing (ex: proxy
settings, retry counts, etc.).@Deprecated public AmazonElasticLoadBalancingClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
and
AwsClientBuilder.withMetricsCollector(RequestMetricCollector)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration
- The client configuration options controlling how this client connects to Elastic Load Balancing (ex: proxy
settings, retry counts, etc.).requestMetricCollector
- optional request metric collectorpublic static AmazonElasticLoadBalancingClientBuilder builder()
public AddTagsResult addTags(AddTagsRequest request)
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.
addTags
in interface AmazonElasticLoadBalancing
addTagsRequest
- Contains the parameters for AddTags.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.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);
public ApplySecurityGroupsToLoadBalancerResult applySecurityGroupsToLoadBalancer(ApplySecurityGroupsToLoadBalancerRequest request)
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.
applySecurityGroupsToLoadBalancer
in interface AmazonElasticLoadBalancing
applySecurityGroupsToLoadBalancerRequest
- Contains the parameters for ApplySecurityGroupsToLoadBalancer.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.public AttachLoadBalancerToSubnetsResult attachLoadBalancerToSubnets(AttachLoadBalancerToSubnetsRequest request)
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.
attachLoadBalancerToSubnets
in interface AmazonElasticLoadBalancing
attachLoadBalancerToSubnetsRequest
- Contains the parameters for AttachLoaBalancerToSubnets.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.public ConfigureHealthCheckResult configureHealthCheck(ConfigureHealthCheckRequest request)
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.
configureHealthCheck
in interface AmazonElasticLoadBalancing
configureHealthCheckRequest
- Contains the parameters for ConfigureHealthCheck.LoadBalancerNotFoundException
- The specified load balancer does not exist.public CreateAppCookieStickinessPolicyResult createAppCookieStickinessPolicy(CreateAppCookieStickinessPolicyRequest request)
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.
createAppCookieStickinessPolicy
in interface AmazonElasticLoadBalancing
createAppCookieStickinessPolicyRequest
- Contains the parameters for CreateAppCookieStickinessPolicy.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.public CreateLBCookieStickinessPolicyResult createLBCookieStickinessPolicy(CreateLBCookieStickinessPolicyRequest request)
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.
createLBCookieStickinessPolicy
in interface AmazonElasticLoadBalancing
createLBCookieStickinessPolicyRequest
- Contains the parameters for CreateLBCookieStickinessPolicy.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.public CreateLoadBalancerResult createLoadBalancer(CreateLoadBalancerRequest request)
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.
createLoadBalancer
in interface AmazonElasticLoadBalancing
createLoadBalancerRequest
- Contains the parameters for CreateLoadBalancer.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.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);
public CreateLoadBalancerListenersResult createLoadBalancerListeners(CreateLoadBalancerListenersRequest request)
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.
createLoadBalancerListeners
in interface AmazonElasticLoadBalancing
createLoadBalancerListenersRequest
- Contains the parameters for CreateLoadBalancerListeners.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.public CreateLoadBalancerPolicyResult createLoadBalancerPolicy(CreateLoadBalancerPolicyRequest request)
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.
createLoadBalancerPolicy
in interface AmazonElasticLoadBalancing
createLoadBalancerPolicyRequest
- Contains the parameters for CreateLoadBalancerPolicy.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.public DeleteLoadBalancerResult deleteLoadBalancer(DeleteLoadBalancerRequest request)
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.
deleteLoadBalancer
in interface AmazonElasticLoadBalancing
deleteLoadBalancerRequest
- Contains the parameters for DeleteLoadBalancer.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);
public DeleteLoadBalancerListenersResult deleteLoadBalancerListeners(DeleteLoadBalancerListenersRequest request)
Deletes the specified listeners from the specified load balancer.
deleteLoadBalancerListeners
in interface AmazonElasticLoadBalancing
deleteLoadBalancerListenersRequest
- Contains the parameters for DeleteLoadBalancerListeners.LoadBalancerNotFoundException
- The specified load balancer does not exist.public DeleteLoadBalancerPolicyResult deleteLoadBalancerPolicy(DeleteLoadBalancerPolicyRequest request)
Deletes the specified policy from the specified load balancer. This policy must not be enabled for any listeners.
deleteLoadBalancerPolicy
in interface AmazonElasticLoadBalancing
deleteLoadBalancerPolicyRequest
- Contains the parameters for DeleteLoadBalancerPolicy.LoadBalancerNotFoundException
- The specified load balancer does not exist.InvalidConfigurationRequestException
- The requested configuration change is not valid.public DeregisterInstancesFromLoadBalancerResult deregisterInstancesFromLoadBalancer(DeregisterInstancesFromLoadBalancerRequest request)
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.
deregisterInstancesFromLoadBalancer
in interface AmazonElasticLoadBalancing
deregisterInstancesFromLoadBalancerRequest
- Contains the parameters for DeregisterInstancesFromLoadBalancer.LoadBalancerNotFoundException
- The specified load balancer does not exist.InvalidInstanceException
- The specified endpoint is not valid.public DescribeAccountLimitsResult describeAccountLimits(DescribeAccountLimitsRequest request)
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.
describeAccountLimits
in interface AmazonElasticLoadBalancing
describeAccountLimitsRequest
- public DescribeInstanceHealthResult describeInstanceHealth(DescribeInstanceHealthRequest request)
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.
describeInstanceHealth
in interface AmazonElasticLoadBalancing
describeInstanceHealthRequest
- Contains the parameters for DescribeInstanceHealth.LoadBalancerNotFoundException
- The specified load balancer does not exist.InvalidInstanceException
- The specified endpoint is not valid.public DescribeLoadBalancerAttributesResult describeLoadBalancerAttributes(DescribeLoadBalancerAttributesRequest request)
Describes the attributes for the specified load balancer.
describeLoadBalancerAttributes
in interface AmazonElasticLoadBalancing
describeLoadBalancerAttributesRequest
- Contains the parameters for DescribeLoadBalancerAttributes.LoadBalancerNotFoundException
- The specified load balancer does not exist.LoadBalancerAttributeNotFoundException
- The specified load balancer attribute does not exist.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);
public DescribeLoadBalancerPoliciesResult describeLoadBalancerPolicies(DescribeLoadBalancerPoliciesRequest request)
Describes the specified policies.
If you specify a load balancer name, the action returns the descriptions of all policies created for the load
balancer. If you specify a policy name associated with your load balancer, the action returns the description of
that policy. If you don't specify a load balancer name, the action returns descriptions of the specified sample
policies, or descriptions of all sample policies. The names of the sample policies have the
ELBSample-
prefix.
describeLoadBalancerPolicies
in interface AmazonElasticLoadBalancing
describeLoadBalancerPoliciesRequest
- Contains the parameters for DescribeLoadBalancerPolicies.LoadBalancerNotFoundException
- The specified load balancer does not exist.PolicyNotFoundException
- One or more of the specified policies do not exist.public DescribeLoadBalancerPoliciesResult describeLoadBalancerPolicies()
AmazonElasticLoadBalancing
describeLoadBalancerPolicies
in interface AmazonElasticLoadBalancing
AmazonElasticLoadBalancing.describeLoadBalancerPolicies(DescribeLoadBalancerPoliciesRequest)
public DescribeLoadBalancerPolicyTypesResult describeLoadBalancerPolicyTypes(DescribeLoadBalancerPolicyTypesRequest request)
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.
describeLoadBalancerPolicyTypes
in interface AmazonElasticLoadBalancing
describeLoadBalancerPolicyTypesRequest
- Contains the parameters for DescribeLoadBalancerPolicyTypes.PolicyTypeNotFoundException
- One or more of the specified policy types do not exist.public DescribeLoadBalancerPolicyTypesResult describeLoadBalancerPolicyTypes()
AmazonElasticLoadBalancing
describeLoadBalancerPolicyTypes
in interface AmazonElasticLoadBalancing
AmazonElasticLoadBalancing.describeLoadBalancerPolicyTypes(DescribeLoadBalancerPolicyTypesRequest)
public DescribeLoadBalancersResult describeLoadBalancers(DescribeLoadBalancersRequest request)
Describes the specified the load balancers. If no load balancers are specified, the call describes all of your load balancers.
describeLoadBalancers
in interface AmazonElasticLoadBalancing
describeLoadBalancersRequest
- Contains the parameters for DescribeLoadBalancers.LoadBalancerNotFoundException
- The specified load balancer does not exist.DependencyThrottleException
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);
public DescribeLoadBalancersResult describeLoadBalancers()
AmazonElasticLoadBalancing
describeLoadBalancers
in interface AmazonElasticLoadBalancing
AmazonElasticLoadBalancing.describeLoadBalancers(DescribeLoadBalancersRequest)
public DescribeTagsResult describeTags(DescribeTagsRequest request)
Describes the tags associated with the specified load balancers.
describeTags
in interface AmazonElasticLoadBalancing
describeTagsRequest
- Contains the parameters for DescribeTags.LoadBalancerNotFoundException
- The specified load balancer does not exist.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);
public DetachLoadBalancerFromSubnetsResult detachLoadBalancerFromSubnets(DetachLoadBalancerFromSubnetsRequest request)
Removes the specified subnets from the set of configured subnets for the load balancer.
After a subnet is removed, all EC2 instances registered with the load balancer in the removed subnet go into the
OutOfService
state. Then, the load balancer balances the traffic among the remaining routable
subnets.
detachLoadBalancerFromSubnets
in interface AmazonElasticLoadBalancing
detachLoadBalancerFromSubnetsRequest
- Contains the parameters for DetachLoadBalancerFromSubnets.LoadBalancerNotFoundException
- The specified load balancer does not exist.InvalidConfigurationRequestException
- The requested configuration change is not valid.public DisableAvailabilityZonesForLoadBalancerResult disableAvailabilityZonesForLoadBalancer(DisableAvailabilityZonesForLoadBalancerRequest request)
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.
disableAvailabilityZonesForLoadBalancer
in interface AmazonElasticLoadBalancing
disableAvailabilityZonesForLoadBalancerRequest
- Contains the parameters for DisableAvailabilityZonesForLoadBalancer.LoadBalancerNotFoundException
- The specified load balancer does not exist.InvalidConfigurationRequestException
- The requested configuration change is not valid.public EnableAvailabilityZonesForLoadBalancerResult enableAvailabilityZonesForLoadBalancer(EnableAvailabilityZonesForLoadBalancerRequest request)
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.
enableAvailabilityZonesForLoadBalancer
in interface AmazonElasticLoadBalancing
enableAvailabilityZonesForLoadBalancerRequest
- Contains the parameters for EnableAvailabilityZonesForLoadBalancer.LoadBalancerNotFoundException
- The specified load balancer does not exist.public ModifyLoadBalancerAttributesResult modifyLoadBalancerAttributes(ModifyLoadBalancerAttributesRequest request)
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:
modifyLoadBalancerAttributes
in interface AmazonElasticLoadBalancing
modifyLoadBalancerAttributesRequest
- Contains the parameters for ModifyLoadBalancerAttributes.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.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);
public RegisterInstancesWithLoadBalancerResult registerInstancesWithLoadBalancer(RegisterInstancesWithLoadBalancerRequest request)
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.
registerInstancesWithLoadBalancer
in interface AmazonElasticLoadBalancing
registerInstancesWithLoadBalancerRequest
- Contains the parameters for RegisterInstancesWithLoadBalancer.LoadBalancerNotFoundException
- The specified load balancer does not exist.InvalidInstanceException
- The specified endpoint is not valid.public RemoveTagsResult removeTags(RemoveTagsRequest request)
Removes one or more tags from the specified load balancer.
removeTags
in interface AmazonElasticLoadBalancing
removeTagsRequest
- Contains the parameters for RemoveTags.LoadBalancerNotFoundException
- The specified load balancer does not exist.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);
public SetLoadBalancerListenerSSLCertificateResult setLoadBalancerListenerSSLCertificate(SetLoadBalancerListenerSSLCertificateRequest request)
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.
setLoadBalancerListenerSSLCertificate
in interface AmazonElasticLoadBalancing
setLoadBalancerListenerSSLCertificateRequest
- Contains the parameters for SetLoadBalancerListenerSSLCertificate.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.public SetLoadBalancerPoliciesForBackendServerResult setLoadBalancerPoliciesForBackendServer(SetLoadBalancerPoliciesForBackendServerRequest request)
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.
setLoadBalancerPoliciesForBackendServer
in interface AmazonElasticLoadBalancing
setLoadBalancerPoliciesForBackendServerRequest
- Contains the parameters for SetLoadBalancerPoliciesForBackendServer.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.public SetLoadBalancerPoliciesOfListenerResult setLoadBalancerPoliciesOfListener(SetLoadBalancerPoliciesOfListenerRequest request)
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.
setLoadBalancerPoliciesOfListener
in interface AmazonElasticLoadBalancing
setLoadBalancerPoliciesOfListenerRequest
- Contains the parameters for SetLoadBalancePoliciesOfListener.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.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
getCachedResponseMetadata
in interface AmazonElasticLoadBalancing
request
- The originally executed requestpublic AmazonElasticLoadBalancingWaiters waiters()
waiters
in interface AmazonElasticLoadBalancing
public void shutdown()
AmazonWebServiceClient
shutdown
in interface AmazonElasticLoadBalancing
shutdown
in class AmazonWebServiceClient
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.