Interface ElasticLoadBalancingAsyncClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.The asynchronous client performs non-blocking I/O when configured with any
invalid reference
SdkAsyncHttpClient
A load balancer can distribute 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 three types of load balancers: Application Load Balancers, Network Load Balancers, and Classic Load Balancers. You can select a load balancer based on your application needs. 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 and Network 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
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptiondefault CompletableFuture
<AddTagsResponse> addTags
(Consumer<AddTagsRequest.Builder> addTagsRequest) Adds the specified tags to the specified load balancer.default CompletableFuture
<AddTagsResponse> addTags
(AddTagsRequest addTagsRequest) Adds the specified tags to the specified load balancer.applySecurityGroupsToLoadBalancer
(Consumer<ApplySecurityGroupsToLoadBalancerRequest.Builder> applySecurityGroupsToLoadBalancerRequest) Associates one or more security groups with your load balancer in a virtual private cloud (VPC).applySecurityGroupsToLoadBalancer
(ApplySecurityGroupsToLoadBalancerRequest applySecurityGroupsToLoadBalancerRequest) Associates one or more security groups with your load balancer in a virtual private cloud (VPC).attachLoadBalancerToSubnets
(Consumer<AttachLoadBalancerToSubnetsRequest.Builder> attachLoadBalancerToSubnetsRequest) Adds one or more subnets to the set of configured subnets for the specified load balancer.attachLoadBalancerToSubnets
(AttachLoadBalancerToSubnetsRequest attachLoadBalancerToSubnetsRequest) Adds one or more subnets to the set of configured subnets for the specified load balancer.builder()
Create a builder that can be used to configure and create aElasticLoadBalancingAsyncClient
.configureHealthCheck
(Consumer<ConfigureHealthCheckRequest.Builder> configureHealthCheckRequest) Specifies the health check settings to use when evaluating the health state of your EC2 instances.configureHealthCheck
(ConfigureHealthCheckRequest configureHealthCheckRequest) Specifies the health check settings to use when evaluating the health state of your EC2 instances.create()
Create aElasticLoadBalancingAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.createAppCookieStickinessPolicy
(Consumer<CreateAppCookieStickinessPolicyRequest.Builder> createAppCookieStickinessPolicyRequest) Generates a stickiness policy with sticky session lifetimes that follow that of an application-generated cookie.createAppCookieStickinessPolicy
(CreateAppCookieStickinessPolicyRequest createAppCookieStickinessPolicyRequest) Generates a stickiness policy with sticky session lifetimes that follow that of an application-generated cookie.createLBCookieStickinessPolicy
(Consumer<CreateLbCookieStickinessPolicyRequest.Builder> createLbCookieStickinessPolicyRequest) Generates a stickiness policy with sticky session lifetimes controlled by the lifetime of the browser (user-agent) or a specified expiration period.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.createLoadBalancer
(Consumer<CreateLoadBalancerRequest.Builder> createLoadBalancerRequest) Creates a Classic Load Balancer.createLoadBalancer
(CreateLoadBalancerRequest createLoadBalancerRequest) Creates a Classic Load Balancer.createLoadBalancerListeners
(Consumer<CreateLoadBalancerListenersRequest.Builder> createLoadBalancerListenersRequest) Creates one or more listeners for the specified load balancer.createLoadBalancerListeners
(CreateLoadBalancerListenersRequest createLoadBalancerListenersRequest) Creates one or more listeners for the specified load balancer.createLoadBalancerPolicy
(Consumer<CreateLoadBalancerPolicyRequest.Builder> createLoadBalancerPolicyRequest) Creates a policy with the specified attributes for the specified load balancer.createLoadBalancerPolicy
(CreateLoadBalancerPolicyRequest createLoadBalancerPolicyRequest) Creates a policy with the specified attributes for the specified load balancer.deleteLoadBalancer
(Consumer<DeleteLoadBalancerRequest.Builder> deleteLoadBalancerRequest) Deletes the specified load balancer.deleteLoadBalancer
(DeleteLoadBalancerRequest deleteLoadBalancerRequest) Deletes the specified load balancer.deleteLoadBalancerListeners
(Consumer<DeleteLoadBalancerListenersRequest.Builder> deleteLoadBalancerListenersRequest) Deletes the specified listeners from the specified load balancer.deleteLoadBalancerListeners
(DeleteLoadBalancerListenersRequest deleteLoadBalancerListenersRequest) Deletes the specified listeners from the specified load balancer.deleteLoadBalancerPolicy
(Consumer<DeleteLoadBalancerPolicyRequest.Builder> deleteLoadBalancerPolicyRequest) Deletes the specified policy from the specified load balancer.deleteLoadBalancerPolicy
(DeleteLoadBalancerPolicyRequest deleteLoadBalancerPolicyRequest) Deletes the specified policy from the specified load balancer.deregisterInstancesFromLoadBalancer
(Consumer<DeregisterInstancesFromLoadBalancerRequest.Builder> deregisterInstancesFromLoadBalancerRequest) Deregisters the specified instances from the specified load balancer.deregisterInstancesFromLoadBalancer
(DeregisterInstancesFromLoadBalancerRequest deregisterInstancesFromLoadBalancerRequest) Deregisters the specified instances from the specified load balancer.Describes the current Elastic Load Balancing resource limits for your AWS account.describeAccountLimits
(Consumer<DescribeAccountLimitsRequest.Builder> describeAccountLimitsRequest) Describes the current Elastic Load Balancing resource limits for your AWS account.describeAccountLimits
(DescribeAccountLimitsRequest describeAccountLimitsRequest) Describes the current Elastic Load Balancing resource limits for your AWS account.describeInstanceHealth
(Consumer<DescribeInstanceHealthRequest.Builder> describeInstanceHealthRequest) Describes the state of the specified instances with respect to the specified load balancer.describeInstanceHealth
(DescribeInstanceHealthRequest describeInstanceHealthRequest) Describes the state of the specified instances with respect to the specified load balancer.describeLoadBalancerAttributes
(Consumer<DescribeLoadBalancerAttributesRequest.Builder> describeLoadBalancerAttributesRequest) Describes the attributes for the specified load balancer.describeLoadBalancerAttributes
(DescribeLoadBalancerAttributesRequest describeLoadBalancerAttributesRequest) Describes the attributes for the specified load balancer.Describes the specified policies.describeLoadBalancerPolicies
(Consumer<DescribeLoadBalancerPoliciesRequest.Builder> describeLoadBalancerPoliciesRequest) Describes the specified policies.describeLoadBalancerPolicies
(DescribeLoadBalancerPoliciesRequest describeLoadBalancerPoliciesRequest) Describes the specified policies.Describes the specified load balancer policy types or all load balancer policy types.describeLoadBalancerPolicyTypes
(Consumer<DescribeLoadBalancerPolicyTypesRequest.Builder> describeLoadBalancerPolicyTypesRequest) Describes the specified load balancer policy types or all load balancer policy types.describeLoadBalancerPolicyTypes
(DescribeLoadBalancerPolicyTypesRequest describeLoadBalancerPolicyTypesRequest) Describes the specified load balancer policy types or all load balancer policy types.Describes the specified the load balancers.describeLoadBalancers
(Consumer<DescribeLoadBalancersRequest.Builder> describeLoadBalancersRequest) Describes the specified the load balancers.describeLoadBalancers
(DescribeLoadBalancersRequest describeLoadBalancersRequest) Describes the specified the load balancers.default DescribeLoadBalancersPublisher
This is a variant ofdescribeLoadBalancers(software.amazon.awssdk.services.elasticloadbalancing.model.DescribeLoadBalancersRequest)
operation.default DescribeLoadBalancersPublisher
describeLoadBalancersPaginator
(Consumer<DescribeLoadBalancersRequest.Builder> describeLoadBalancersRequest) This is a variant ofdescribeLoadBalancers(software.amazon.awssdk.services.elasticloadbalancing.model.DescribeLoadBalancersRequest)
operation.default DescribeLoadBalancersPublisher
describeLoadBalancersPaginator
(DescribeLoadBalancersRequest describeLoadBalancersRequest) This is a variant ofdescribeLoadBalancers(software.amazon.awssdk.services.elasticloadbalancing.model.DescribeLoadBalancersRequest)
operation.default CompletableFuture
<DescribeTagsResponse> describeTags
(Consumer<DescribeTagsRequest.Builder> describeTagsRequest) Describes the tags associated with the specified load balancers.default CompletableFuture
<DescribeTagsResponse> describeTags
(DescribeTagsRequest describeTagsRequest) Describes the tags associated with the specified load balancers.detachLoadBalancerFromSubnets
(Consumer<DetachLoadBalancerFromSubnetsRequest.Builder> detachLoadBalancerFromSubnetsRequest) Removes the specified subnets from the set of configured subnets for the load balancer.detachLoadBalancerFromSubnets
(DetachLoadBalancerFromSubnetsRequest detachLoadBalancerFromSubnetsRequest) Removes the specified subnets from the set of configured subnets for the load balancer.disableAvailabilityZonesForLoadBalancer
(Consumer<DisableAvailabilityZonesForLoadBalancerRequest.Builder> disableAvailabilityZonesForLoadBalancerRequest) Removes the specified Availability Zones from the set of Availability Zones for the specified load balancer in EC2-Classic or a default VPC.disableAvailabilityZonesForLoadBalancer
(DisableAvailabilityZonesForLoadBalancerRequest disableAvailabilityZonesForLoadBalancerRequest) Removes the specified Availability Zones from the set of Availability Zones for the specified load balancer in EC2-Classic or a default VPC.enableAvailabilityZonesForLoadBalancer
(Consumer<EnableAvailabilityZonesForLoadBalancerRequest.Builder> enableAvailabilityZonesForLoadBalancerRequest) Adds the specified Availability Zones to the set of Availability Zones for the specified load balancer in EC2-Classic or a default VPC.enableAvailabilityZonesForLoadBalancer
(EnableAvailabilityZonesForLoadBalancerRequest enableAvailabilityZonesForLoadBalancerRequest) Adds the specified Availability Zones to the set of Availability Zones for the specified load balancer in EC2-Classic or a default VPC.modifyLoadBalancerAttributes
(Consumer<ModifyLoadBalancerAttributesRequest.Builder> modifyLoadBalancerAttributesRequest) Modifies the attributes of the specified load balancer.modifyLoadBalancerAttributes
(ModifyLoadBalancerAttributesRequest modifyLoadBalancerAttributesRequest) Modifies the attributes of the specified load balancer.registerInstancesWithLoadBalancer
(Consumer<RegisterInstancesWithLoadBalancerRequest.Builder> registerInstancesWithLoadBalancerRequest) Adds the specified instances to the specified load balancer.registerInstancesWithLoadBalancer
(RegisterInstancesWithLoadBalancerRequest registerInstancesWithLoadBalancerRequest) Adds the specified instances to the specified load balancer.default CompletableFuture
<RemoveTagsResponse> removeTags
(Consumer<RemoveTagsRequest.Builder> removeTagsRequest) Removes one or more tags from the specified load balancer.default CompletableFuture
<RemoveTagsResponse> removeTags
(RemoveTagsRequest removeTagsRequest) Removes one or more tags from the specified load balancer.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationsetLoadBalancerListenerSSLCertificate
(Consumer<SetLoadBalancerListenerSslCertificateRequest.Builder> setLoadBalancerListenerSslCertificateRequest) Sets the certificate that terminates the specified listener's SSL connections.setLoadBalancerListenerSSLCertificate
(SetLoadBalancerListenerSslCertificateRequest setLoadBalancerListenerSslCertificateRequest) Sets the certificate that terminates the specified listener's SSL connections.setLoadBalancerPoliciesForBackendServer
(Consumer<SetLoadBalancerPoliciesForBackendServerRequest.Builder> setLoadBalancerPoliciesForBackendServerRequest) Replaces the set of policies associated with the specified port on which the EC2 instance is listening with a new set of policies.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.setLoadBalancerPoliciesOfListener
(Consumer<SetLoadBalancerPoliciesOfListenerRequest.Builder> setLoadBalancerPoliciesOfListenerRequest) Replaces the current set of policies for the specified load balancer port with the specified set of policies.setLoadBalancerPoliciesOfListener
(SetLoadBalancerPoliciesOfListenerRequest setLoadBalancerPoliciesOfListenerRequest) Replaces the current set of policies for the specified load balancer port with the specified set of policies.default ElasticLoadBalancingAsyncWaiter
waiter()
Create an instance ofElasticLoadBalancingAsyncWaiter
using this client.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
addTags
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 Balancers Guide.
- Parameters:
addTagsRequest
- Contains the parameters for AddTags.- Returns:
- A Java Future containing the result of the AddTags operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticLoadBalancingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
addTags
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 Balancers Guide.
This is a convenience which creates an instance of the
AddTagsRequest.Builder
avoiding the need to create one manually viaAddTagsRequest.builder()
- Parameters:
addTagsRequest
- AConsumer
that will call methods onAddTagsRequest.Builder
to create a request. Contains the parameters for AddTags.- Returns:
- A Java Future containing the result of the AddTags operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticLoadBalancingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
applySecurityGroupsToLoadBalancer
default CompletableFuture<ApplySecurityGroupsToLoadBalancerResponse> 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 Balancers Guide.
- Parameters:
applySecurityGroupsToLoadBalancerRequest
- Contains the parameters for ApplySecurityGroupsToLoadBalancer.- Returns:
- A Java Future containing the result of the ApplySecurityGroupsToLoadBalancer operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticLoadBalancingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
applySecurityGroupsToLoadBalancer
default CompletableFuture<ApplySecurityGroupsToLoadBalancerResponse> applySecurityGroupsToLoadBalancer(Consumer<ApplySecurityGroupsToLoadBalancerRequest.Builder> 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 Balancers Guide.
This is a convenience which creates an instance of the
ApplySecurityGroupsToLoadBalancerRequest.Builder
avoiding the need to create one manually viaApplySecurityGroupsToLoadBalancerRequest.builder()
- Parameters:
applySecurityGroupsToLoadBalancerRequest
- AConsumer
that will call methods onApplySecurityGroupsToLoadBalancerRequest.Builder
to create a request. Contains the parameters for ApplySecurityGroupsToLoadBalancer.- Returns:
- A Java Future containing the result of the ApplySecurityGroupsToLoadBalancer operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticLoadBalancingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
attachLoadBalancerToSubnets
default CompletableFuture<AttachLoadBalancerToSubnetsResponse> 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 Balancers Guide.
- Parameters:
attachLoadBalancerToSubnetsRequest
- Contains the parameters for AttachLoaBalancerToSubnets.- Returns:
- A Java Future containing the result of the AttachLoadBalancerToSubnets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticLoadBalancingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
attachLoadBalancerToSubnets
default CompletableFuture<AttachLoadBalancerToSubnetsResponse> attachLoadBalancerToSubnets(Consumer<AttachLoadBalancerToSubnetsRequest.Builder> 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 Balancers Guide.
This is a convenience which creates an instance of the
AttachLoadBalancerToSubnetsRequest.Builder
avoiding the need to create one manually viaAttachLoadBalancerToSubnetsRequest.builder()
- Parameters:
attachLoadBalancerToSubnetsRequest
- AConsumer
that will call methods onAttachLoadBalancerToSubnetsRequest.Builder
to create a request. Contains the parameters for AttachLoaBalancerToSubnets.- Returns:
- A Java Future containing the result of the AttachLoadBalancerToSubnets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticLoadBalancingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
configureHealthCheck
default CompletableFuture<ConfigureHealthCheckResponse> 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 Balancers Guide.
- Parameters:
configureHealthCheckRequest
- Contains the parameters for ConfigureHealthCheck.- Returns:
- A Java Future containing the result of the ConfigureHealthCheck operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- LoadBalancerNotFoundException The specified load balancer does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticLoadBalancingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
configureHealthCheck
default CompletableFuture<ConfigureHealthCheckResponse> configureHealthCheck(Consumer<ConfigureHealthCheckRequest.Builder> 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 Balancers Guide.
This is a convenience which creates an instance of the
ConfigureHealthCheckRequest.Builder
avoiding the need to create one manually viaConfigureHealthCheckRequest.builder()
- Parameters:
configureHealthCheckRequest
- AConsumer
that will call methods onConfigureHealthCheckRequest.Builder
to create a request. Contains the parameters for ConfigureHealthCheck.- Returns:
- A Java Future containing the result of the ConfigureHealthCheck operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- LoadBalancerNotFoundException The specified load balancer does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticLoadBalancingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createAppCookieStickinessPolicy
default CompletableFuture<CreateAppCookieStickinessPolicyResponse> 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 Balancers Guide.
- Parameters:
createAppCookieStickinessPolicyRequest
- Contains the parameters for CreateAppCookieStickinessPolicy.- Returns:
- A Java Future containing the result of the CreateAppCookieStickinessPolicy operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticLoadBalancingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createAppCookieStickinessPolicy
default CompletableFuture<CreateAppCookieStickinessPolicyResponse> createAppCookieStickinessPolicy(Consumer<CreateAppCookieStickinessPolicyRequest.Builder> 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 Balancers Guide.
This is a convenience which creates an instance of the
CreateAppCookieStickinessPolicyRequest.Builder
avoiding the need to create one manually viaCreateAppCookieStickinessPolicyRequest.builder()
- Parameters:
createAppCookieStickinessPolicyRequest
- AConsumer
that will call methods onCreateAppCookieStickinessPolicyRequest.Builder
to create a request. Contains the parameters for CreateAppCookieStickinessPolicy.- Returns:
- A Java Future containing the result of the CreateAppCookieStickinessPolicy operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticLoadBalancingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createLBCookieStickinessPolicy
default CompletableFuture<CreateLbCookieStickinessPolicyResponse> 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 Balancers Guide.
- Parameters:
createLbCookieStickinessPolicyRequest
- Contains the parameters for CreateLBCookieStickinessPolicy.- Returns:
- A Java Future containing the result of the CreateLBCookieStickinessPolicy operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticLoadBalancingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createLBCookieStickinessPolicy
default CompletableFuture<CreateLbCookieStickinessPolicyResponse> createLBCookieStickinessPolicy(Consumer<CreateLbCookieStickinessPolicyRequest.Builder> 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 Balancers Guide.
This is a convenience which creates an instance of the
CreateLbCookieStickinessPolicyRequest.Builder
avoiding the need to create one manually viaCreateLbCookieStickinessPolicyRequest.builder()
- Parameters:
createLbCookieStickinessPolicyRequest
- AConsumer
that will call methods onCreateLbCookieStickinessPolicyRequest.Builder
to create a request. Contains the parameters for CreateLBCookieStickinessPolicy.- Returns:
- A Java Future containing the result of the CreateLBCookieStickinessPolicy operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticLoadBalancingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createLoadBalancer
default CompletableFuture<CreateLoadBalancerResponse> 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 Balancers Guide.
- Parameters:
createLoadBalancerRequest
- Contains the parameters for CreateLoadBalancer.- Returns:
- A Java Future containing the result of the CreateLoadBalancer operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- OperationNotPermittedException This operation is not allowed.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticLoadBalancingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createLoadBalancer
default CompletableFuture<CreateLoadBalancerResponse> createLoadBalancer(Consumer<CreateLoadBalancerRequest.Builder> 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 Balancers Guide.
This is a convenience which creates an instance of the
CreateLoadBalancerRequest.Builder
avoiding the need to create one manually viaCreateLoadBalancerRequest.builder()
- Parameters:
createLoadBalancerRequest
- AConsumer
that will call methods onCreateLoadBalancerRequest.Builder
to create a request. Contains the parameters for CreateLoadBalancer.- Returns:
- A Java Future containing the result of the CreateLoadBalancer operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- OperationNotPermittedException This operation is not allowed.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticLoadBalancingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createLoadBalancerListeners
default CompletableFuture<CreateLoadBalancerListenersResponse> 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 Balancers Guide.
- Parameters:
createLoadBalancerListenersRequest
- Contains the parameters for CreateLoadBalancerListeners.- Returns:
- A Java Future containing the result of the CreateLoadBalancerListeners operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticLoadBalancingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createLoadBalancerListeners
default CompletableFuture<CreateLoadBalancerListenersResponse> createLoadBalancerListeners(Consumer<CreateLoadBalancerListenersRequest.Builder> 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 Balancers Guide.
This is a convenience which creates an instance of the
CreateLoadBalancerListenersRequest.Builder
avoiding the need to create one manually viaCreateLoadBalancerListenersRequest.builder()
- Parameters:
createLoadBalancerListenersRequest
- AConsumer
that will call methods onCreateLoadBalancerListenersRequest.Builder
to create a request. Contains the parameters for CreateLoadBalancerListeners.- Returns:
- A Java Future containing the result of the CreateLoadBalancerListeners operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticLoadBalancingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createLoadBalancerPolicy
default CompletableFuture<CreateLoadBalancerPolicyResponse> 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:
- A Java Future containing the result of the CreateLoadBalancerPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticLoadBalancingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createLoadBalancerPolicy
default CompletableFuture<CreateLoadBalancerPolicyResponse> createLoadBalancerPolicy(Consumer<CreateLoadBalancerPolicyRequest.Builder> 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.
This is a convenience which creates an instance of the
CreateLoadBalancerPolicyRequest.Builder
avoiding the need to create one manually viaCreateLoadBalancerPolicyRequest.builder()
- Parameters:
createLoadBalancerPolicyRequest
- AConsumer
that will call methods onCreateLoadBalancerPolicyRequest.Builder
to create a request. Contains the parameters for CreateLoadBalancerPolicy.- Returns:
- A Java Future containing the result of the CreateLoadBalancerPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticLoadBalancingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteLoadBalancer
default CompletableFuture<DeleteLoadBalancerResponse> 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:
- A Java Future containing the result of the DeleteLoadBalancer operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticLoadBalancingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteLoadBalancer
default CompletableFuture<DeleteLoadBalancerResponse> deleteLoadBalancer(Consumer<DeleteLoadBalancerRequest.Builder> 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.
This is a convenience which creates an instance of the
DeleteLoadBalancerRequest.Builder
avoiding the need to create one manually viaDeleteLoadBalancerRequest.builder()
- Parameters:
deleteLoadBalancerRequest
- AConsumer
that will call methods onDeleteLoadBalancerRequest.Builder
to create a request. Contains the parameters for DeleteLoadBalancer.- Returns:
- A Java Future containing the result of the DeleteLoadBalancer operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticLoadBalancingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteLoadBalancerListeners
default CompletableFuture<DeleteLoadBalancerListenersResponse> deleteLoadBalancerListeners(DeleteLoadBalancerListenersRequest deleteLoadBalancerListenersRequest) Deletes the specified listeners from the specified load balancer.
- Parameters:
deleteLoadBalancerListenersRequest
- Contains the parameters for DeleteLoadBalancerListeners.- Returns:
- A Java Future containing the result of the DeleteLoadBalancerListeners operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- LoadBalancerNotFoundException The specified load balancer does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticLoadBalancingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteLoadBalancerListeners
default CompletableFuture<DeleteLoadBalancerListenersResponse> deleteLoadBalancerListeners(Consumer<DeleteLoadBalancerListenersRequest.Builder> deleteLoadBalancerListenersRequest) Deletes the specified listeners from the specified load balancer.
This is a convenience which creates an instance of the
DeleteLoadBalancerListenersRequest.Builder
avoiding the need to create one manually viaDeleteLoadBalancerListenersRequest.builder()
- Parameters:
deleteLoadBalancerListenersRequest
- AConsumer
that will call methods onDeleteLoadBalancerListenersRequest.Builder
to create a request. Contains the parameters for DeleteLoadBalancerListeners.- Returns:
- A Java Future containing the result of the DeleteLoadBalancerListeners operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- LoadBalancerNotFoundException The specified load balancer does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticLoadBalancingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteLoadBalancerPolicy
default CompletableFuture<DeleteLoadBalancerPolicyResponse> 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:
- A Java Future containing the result of the DeleteLoadBalancerPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- LoadBalancerNotFoundException The specified load balancer does not exist.
- InvalidConfigurationRequestException The requested configuration change is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticLoadBalancingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteLoadBalancerPolicy
default CompletableFuture<DeleteLoadBalancerPolicyResponse> deleteLoadBalancerPolicy(Consumer<DeleteLoadBalancerPolicyRequest.Builder> deleteLoadBalancerPolicyRequest) Deletes the specified policy from the specified load balancer. This policy must not be enabled for any listeners.
This is a convenience which creates an instance of the
DeleteLoadBalancerPolicyRequest.Builder
avoiding the need to create one manually viaDeleteLoadBalancerPolicyRequest.builder()
- Parameters:
deleteLoadBalancerPolicyRequest
- AConsumer
that will call methods onDeleteLoadBalancerPolicyRequest.Builder
to create a request. Contains the parameters for DeleteLoadBalancerPolicy.- Returns:
- A Java Future containing the result of the DeleteLoadBalancerPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- LoadBalancerNotFoundException The specified load balancer does not exist.
- InvalidConfigurationRequestException The requested configuration change is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticLoadBalancingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deregisterInstancesFromLoadBalancer
default CompletableFuture<DeregisterInstancesFromLoadBalancerResponse> 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 Balancers Guide.
- Parameters:
deregisterInstancesFromLoadBalancerRequest
- Contains the parameters for DeregisterInstancesFromLoadBalancer.- Returns:
- A Java Future containing the result of the DeregisterInstancesFromLoadBalancer operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- LoadBalancerNotFoundException The specified load balancer does not exist.
- InvalidInstanceException The specified endpoint is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticLoadBalancingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deregisterInstancesFromLoadBalancer
default CompletableFuture<DeregisterInstancesFromLoadBalancerResponse> deregisterInstancesFromLoadBalancer(Consumer<DeregisterInstancesFromLoadBalancerRequest.Builder> 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 Balancers Guide.
This is a convenience which creates an instance of the
DeregisterInstancesFromLoadBalancerRequest.Builder
avoiding the need to create one manually viaDeregisterInstancesFromLoadBalancerRequest.builder()
- Parameters:
deregisterInstancesFromLoadBalancerRequest
- AConsumer
that will call methods onDeregisterInstancesFromLoadBalancerRequest.Builder
to create a request. Contains the parameters for DeregisterInstancesFromLoadBalancer.- Returns:
- A Java Future containing the result of the DeregisterInstancesFromLoadBalancer operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- LoadBalancerNotFoundException The specified load balancer does not exist.
- InvalidInstanceException The specified endpoint is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticLoadBalancingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeAccountLimits
default CompletableFuture<DescribeAccountLimitsResponse> 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 Balancers Guide.
- Parameters:
describeAccountLimitsRequest
-- Returns:
- A Java Future containing the result of the DescribeAccountLimits operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticLoadBalancingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeAccountLimits
default CompletableFuture<DescribeAccountLimitsResponse> describeAccountLimits(Consumer<DescribeAccountLimitsRequest.Builder> 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 Balancers Guide.
This is a convenience which creates an instance of the
DescribeAccountLimitsRequest.Builder
avoiding the need to create one manually viaDescribeAccountLimitsRequest.builder()
- Parameters:
describeAccountLimitsRequest
- AConsumer
that will call methods onDescribeAccountLimitsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeAccountLimits operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticLoadBalancingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeAccountLimits
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 Balancers Guide.
- Returns:
- A Java Future containing the result of the DescribeAccountLimits operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticLoadBalancingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeInstanceHealth
default CompletableFuture<DescribeInstanceHealthResponse> 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:
- A Java Future containing the result of the DescribeInstanceHealth operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- LoadBalancerNotFoundException The specified load balancer does not exist.
- InvalidInstanceException The specified endpoint is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticLoadBalancingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeInstanceHealth
default CompletableFuture<DescribeInstanceHealthResponse> describeInstanceHealth(Consumer<DescribeInstanceHealthRequest.Builder> 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.
This is a convenience which creates an instance of the
DescribeInstanceHealthRequest.Builder
avoiding the need to create one manually viaDescribeInstanceHealthRequest.builder()
- Parameters:
describeInstanceHealthRequest
- AConsumer
that will call methods onDescribeInstanceHealthRequest.Builder
to create a request. Contains the parameters for DescribeInstanceHealth.- Returns:
- A Java Future containing the result of the DescribeInstanceHealth operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- LoadBalancerNotFoundException The specified load balancer does not exist.
- InvalidInstanceException The specified endpoint is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticLoadBalancingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeLoadBalancerAttributes
default CompletableFuture<DescribeLoadBalancerAttributesResponse> describeLoadBalancerAttributes(DescribeLoadBalancerAttributesRequest describeLoadBalancerAttributesRequest) Describes the attributes for the specified load balancer.
- Parameters:
describeLoadBalancerAttributesRequest
- Contains the parameters for DescribeLoadBalancerAttributes.- Returns:
- A Java Future containing the result of the DescribeLoadBalancerAttributes operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- LoadBalancerNotFoundException The specified load balancer does not exist.
- LoadBalancerAttributeNotFoundException The specified load balancer attribute does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticLoadBalancingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeLoadBalancerAttributes
default CompletableFuture<DescribeLoadBalancerAttributesResponse> describeLoadBalancerAttributes(Consumer<DescribeLoadBalancerAttributesRequest.Builder> describeLoadBalancerAttributesRequest) Describes the attributes for the specified load balancer.
This is a convenience which creates an instance of the
DescribeLoadBalancerAttributesRequest.Builder
avoiding the need to create one manually viaDescribeLoadBalancerAttributesRequest.builder()
- Parameters:
describeLoadBalancerAttributesRequest
- AConsumer
that will call methods onDescribeLoadBalancerAttributesRequest.Builder
to create a request. Contains the parameters for DescribeLoadBalancerAttributes.- Returns:
- A Java Future containing the result of the DescribeLoadBalancerAttributes operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- LoadBalancerNotFoundException The specified load balancer does not exist.
- LoadBalancerAttributeNotFoundException The specified load balancer attribute does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticLoadBalancingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeLoadBalancerPolicies
default CompletableFuture<DescribeLoadBalancerPoliciesResponse> 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:
- A Java Future containing the result of the DescribeLoadBalancerPolicies operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- LoadBalancerNotFoundException The specified load balancer does not exist.
- PolicyNotFoundException One or more of the specified policies do not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticLoadBalancingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeLoadBalancerPolicies
default CompletableFuture<DescribeLoadBalancerPoliciesResponse> describeLoadBalancerPolicies(Consumer<DescribeLoadBalancerPoliciesRequest.Builder> 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.
This is a convenience which creates an instance of the
DescribeLoadBalancerPoliciesRequest.Builder
avoiding the need to create one manually viaDescribeLoadBalancerPoliciesRequest.builder()
- Parameters:
describeLoadBalancerPoliciesRequest
- AConsumer
that will call methods onDescribeLoadBalancerPoliciesRequest.Builder
to create a request. Contains the parameters for DescribeLoadBalancerPolicies.- Returns:
- A Java Future containing the result of the DescribeLoadBalancerPolicies operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- LoadBalancerNotFoundException The specified load balancer does not exist.
- PolicyNotFoundException One or more of the specified policies do not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticLoadBalancingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeLoadBalancerPolicies
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.- Returns:
- A Java Future containing the result of the DescribeLoadBalancerPolicies operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- LoadBalancerNotFoundException The specified load balancer does not exist.
- PolicyNotFoundException One or more of the specified policies do not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticLoadBalancingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeLoadBalancerPolicyTypes
default CompletableFuture<DescribeLoadBalancerPolicyTypesResponse> 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:
- A Java Future containing the result of the DescribeLoadBalancerPolicyTypes operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- PolicyTypeNotFoundException One or more of the specified policy types do not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticLoadBalancingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeLoadBalancerPolicyTypes
default CompletableFuture<DescribeLoadBalancerPolicyTypesResponse> describeLoadBalancerPolicyTypes(Consumer<DescribeLoadBalancerPolicyTypesRequest.Builder> 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.
This is a convenience which creates an instance of the
DescribeLoadBalancerPolicyTypesRequest.Builder
avoiding the need to create one manually viaDescribeLoadBalancerPolicyTypesRequest.builder()
- Parameters:
describeLoadBalancerPolicyTypesRequest
- AConsumer
that will call methods onDescribeLoadBalancerPolicyTypesRequest.Builder
to create a request. Contains the parameters for DescribeLoadBalancerPolicyTypes.- Returns:
- A Java Future containing the result of the DescribeLoadBalancerPolicyTypes operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- PolicyTypeNotFoundException One or more of the specified policy types do not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticLoadBalancingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeLoadBalancerPolicyTypes
default CompletableFuture<DescribeLoadBalancerPolicyTypesResponse> describeLoadBalancerPolicyTypes()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.
- Returns:
- A Java Future containing the result of the DescribeLoadBalancerPolicyTypes operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- PolicyTypeNotFoundException One or more of the specified policy types do not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticLoadBalancingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeLoadBalancers
default CompletableFuture<DescribeLoadBalancersResponse> 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:
- A Java Future containing the result of the DescribeLoadBalancers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- LoadBalancerNotFoundException The specified load balancer does not exist.
- DependencyThrottleException A request made by Elastic Load Balancing to another service exceeds the maximum request rate permitted for your account.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticLoadBalancingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeLoadBalancers
default CompletableFuture<DescribeLoadBalancersResponse> describeLoadBalancers(Consumer<DescribeLoadBalancersRequest.Builder> describeLoadBalancersRequest) Describes the specified the load balancers. If no load balancers are specified, the call describes all of your load balancers.
This is a convenience which creates an instance of the
DescribeLoadBalancersRequest.Builder
avoiding the need to create one manually viaDescribeLoadBalancersRequest.builder()
- Parameters:
describeLoadBalancersRequest
- AConsumer
that will call methods onDescribeLoadBalancersRequest.Builder
to create a request. Contains the parameters for DescribeLoadBalancers.- Returns:
- A Java Future containing the result of the DescribeLoadBalancers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- LoadBalancerNotFoundException The specified load balancer does not exist.
- DependencyThrottleException A request made by Elastic Load Balancing to another service exceeds the maximum request rate permitted for your account.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticLoadBalancingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeLoadBalancers
Describes the specified the load balancers. If no load balancers are specified, the call describes all of your load balancers.
- Returns:
- A Java Future containing the result of the DescribeLoadBalancers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- LoadBalancerNotFoundException The specified load balancer does not exist.
- DependencyThrottleException A request made by Elastic Load Balancing to another service exceeds the maximum request rate permitted for your account.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticLoadBalancingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeLoadBalancersPaginator
This is a variant of
describeLoadBalancers(software.amazon.awssdk.services.elasticloadbalancing.model.DescribeLoadBalancersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.elasticloadbalancing.paginators.DescribeLoadBalancersPublisher publisher = client.describeLoadBalancersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.elasticloadbalancing.paginators.DescribeLoadBalancersPublisher publisher = client.describeLoadBalancersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticloadbalancing.model.DescribeLoadBalancersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.elasticloadbalancing.model.DescribeLoadBalancersResponse response) { //... }; });
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeLoadBalancers(software.amazon.awssdk.services.elasticloadbalancing.model.DescribeLoadBalancersRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- LoadBalancerNotFoundException The specified load balancer does not exist.
- DependencyThrottleException A request made by Elastic Load Balancing to another service exceeds the maximum request rate permitted for your account.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticLoadBalancingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeLoadBalancersPaginator
default DescribeLoadBalancersPublisher describeLoadBalancersPaginator(DescribeLoadBalancersRequest describeLoadBalancersRequest) This is a variant of
describeLoadBalancers(software.amazon.awssdk.services.elasticloadbalancing.model.DescribeLoadBalancersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.elasticloadbalancing.paginators.DescribeLoadBalancersPublisher publisher = client.describeLoadBalancersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.elasticloadbalancing.paginators.DescribeLoadBalancersPublisher publisher = client.describeLoadBalancersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticloadbalancing.model.DescribeLoadBalancersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.elasticloadbalancing.model.DescribeLoadBalancersResponse response) { //... }; });
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeLoadBalancers(software.amazon.awssdk.services.elasticloadbalancing.model.DescribeLoadBalancersRequest)
operation.- Parameters:
describeLoadBalancersRequest
- Contains the parameters for DescribeLoadBalancers.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- LoadBalancerNotFoundException The specified load balancer does not exist.
- DependencyThrottleException A request made by Elastic Load Balancing to another service exceeds the maximum request rate permitted for your account.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticLoadBalancingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeLoadBalancersPaginator
default DescribeLoadBalancersPublisher describeLoadBalancersPaginator(Consumer<DescribeLoadBalancersRequest.Builder> describeLoadBalancersRequest) This is a variant of
describeLoadBalancers(software.amazon.awssdk.services.elasticloadbalancing.model.DescribeLoadBalancersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.elasticloadbalancing.paginators.DescribeLoadBalancersPublisher publisher = client.describeLoadBalancersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.elasticloadbalancing.paginators.DescribeLoadBalancersPublisher publisher = client.describeLoadBalancersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticloadbalancing.model.DescribeLoadBalancersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.elasticloadbalancing.model.DescribeLoadBalancersResponse response) { //... }; });
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeLoadBalancers(software.amazon.awssdk.services.elasticloadbalancing.model.DescribeLoadBalancersRequest)
operation.
This is a convenience which creates an instance of the
DescribeLoadBalancersRequest.Builder
avoiding the need to create one manually viaDescribeLoadBalancersRequest.builder()
- Parameters:
describeLoadBalancersRequest
- AConsumer
that will call methods onDescribeLoadBalancersRequest.Builder
to create a request. Contains the parameters for DescribeLoadBalancers.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- LoadBalancerNotFoundException The specified load balancer does not exist.
- DependencyThrottleException A request made by Elastic Load Balancing to another service exceeds the maximum request rate permitted for your account.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticLoadBalancingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeTags
default CompletableFuture<DescribeTagsResponse> describeTags(DescribeTagsRequest describeTagsRequest) Describes the tags associated with the specified load balancers.
- Parameters:
describeTagsRequest
- Contains the parameters for DescribeTags.- Returns:
- A Java Future containing the result of the DescribeTags operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- LoadBalancerNotFoundException The specified load balancer does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticLoadBalancingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeTags
default CompletableFuture<DescribeTagsResponse> describeTags(Consumer<DescribeTagsRequest.Builder> describeTagsRequest) Describes the tags associated with the specified load balancers.
This is a convenience which creates an instance of the
DescribeTagsRequest.Builder
avoiding the need to create one manually viaDescribeTagsRequest.builder()
- Parameters:
describeTagsRequest
- AConsumer
that will call methods onDescribeTagsRequest.Builder
to create a request. Contains the parameters for DescribeTags.- Returns:
- A Java Future containing the result of the DescribeTags operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- LoadBalancerNotFoundException The specified load balancer does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticLoadBalancingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
detachLoadBalancerFromSubnets
default CompletableFuture<DetachLoadBalancerFromSubnetsResponse> 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:
- A Java Future containing the result of the DetachLoadBalancerFromSubnets operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- LoadBalancerNotFoundException The specified load balancer does not exist.
- InvalidConfigurationRequestException The requested configuration change is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticLoadBalancingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
detachLoadBalancerFromSubnets
default CompletableFuture<DetachLoadBalancerFromSubnetsResponse> detachLoadBalancerFromSubnets(Consumer<DetachLoadBalancerFromSubnetsRequest.Builder> 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.
This is a convenience which creates an instance of the
DetachLoadBalancerFromSubnetsRequest.Builder
avoiding the need to create one manually viaDetachLoadBalancerFromSubnetsRequest.builder()
- Parameters:
detachLoadBalancerFromSubnetsRequest
- AConsumer
that will call methods onDetachLoadBalancerFromSubnetsRequest.Builder
to create a request. Contains the parameters for DetachLoadBalancerFromSubnets.- Returns:
- A Java Future containing the result of the DetachLoadBalancerFromSubnets operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- LoadBalancerNotFoundException The specified load balancer does not exist.
- InvalidConfigurationRequestException The requested configuration change is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticLoadBalancingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
disableAvailabilityZonesForLoadBalancer
default CompletableFuture<DisableAvailabilityZonesForLoadBalancerResponse> disableAvailabilityZonesForLoadBalancer(DisableAvailabilityZonesForLoadBalancerRequest disableAvailabilityZonesForLoadBalancerRequest) Removes the specified Availability Zones from the set of Availability Zones for the specified load balancer in EC2-Classic or a default VPC.
For load balancers in a non-default VPC, use DetachLoadBalancerFromSubnets.
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 Balancers Guide.
- Parameters:
disableAvailabilityZonesForLoadBalancerRequest
- Contains the parameters for DisableAvailabilityZonesForLoadBalancer.- Returns:
- A Java Future containing the result of the DisableAvailabilityZonesForLoadBalancer operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- LoadBalancerNotFoundException The specified load balancer does not exist.
- InvalidConfigurationRequestException The requested configuration change is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticLoadBalancingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
disableAvailabilityZonesForLoadBalancer
default CompletableFuture<DisableAvailabilityZonesForLoadBalancerResponse> disableAvailabilityZonesForLoadBalancer(Consumer<DisableAvailabilityZonesForLoadBalancerRequest.Builder> disableAvailabilityZonesForLoadBalancerRequest) Removes the specified Availability Zones from the set of Availability Zones for the specified load balancer in EC2-Classic or a default VPC.
For load balancers in a non-default VPC, use DetachLoadBalancerFromSubnets.
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 Balancers Guide.
This is a convenience which creates an instance of the
DisableAvailabilityZonesForLoadBalancerRequest.Builder
avoiding the need to create one manually viaDisableAvailabilityZonesForLoadBalancerRequest.builder()
- Parameters:
disableAvailabilityZonesForLoadBalancerRequest
- AConsumer
that will call methods onDisableAvailabilityZonesForLoadBalancerRequest.Builder
to create a request. Contains the parameters for DisableAvailabilityZonesForLoadBalancer.- Returns:
- A Java Future containing the result of the DisableAvailabilityZonesForLoadBalancer operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- LoadBalancerNotFoundException The specified load balancer does not exist.
- InvalidConfigurationRequestException The requested configuration change is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticLoadBalancingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
enableAvailabilityZonesForLoadBalancer
default CompletableFuture<EnableAvailabilityZonesForLoadBalancerResponse> enableAvailabilityZonesForLoadBalancer(EnableAvailabilityZonesForLoadBalancerRequest enableAvailabilityZonesForLoadBalancerRequest) Adds the specified Availability Zones to the set of Availability Zones for the specified load balancer in EC2-Classic or a default VPC.
For load balancers in a non-default VPC, use AttachLoadBalancerToSubnets.
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 Balancers Guide.
- Parameters:
enableAvailabilityZonesForLoadBalancerRequest
- Contains the parameters for EnableAvailabilityZonesForLoadBalancer.- Returns:
- A Java Future containing the result of the EnableAvailabilityZonesForLoadBalancer operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- LoadBalancerNotFoundException The specified load balancer does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticLoadBalancingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
enableAvailabilityZonesForLoadBalancer
default CompletableFuture<EnableAvailabilityZonesForLoadBalancerResponse> enableAvailabilityZonesForLoadBalancer(Consumer<EnableAvailabilityZonesForLoadBalancerRequest.Builder> enableAvailabilityZonesForLoadBalancerRequest) Adds the specified Availability Zones to the set of Availability Zones for the specified load balancer in EC2-Classic or a default VPC.
For load balancers in a non-default VPC, use AttachLoadBalancerToSubnets.
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 Balancers Guide.
This is a convenience which creates an instance of the
EnableAvailabilityZonesForLoadBalancerRequest.Builder
avoiding the need to create one manually viaEnableAvailabilityZonesForLoadBalancerRequest.builder()
- Parameters:
enableAvailabilityZonesForLoadBalancerRequest
- AConsumer
that will call methods onEnableAvailabilityZonesForLoadBalancerRequest.Builder
to create a request. Contains the parameters for EnableAvailabilityZonesForLoadBalancer.- Returns:
- A Java Future containing the result of the EnableAvailabilityZonesForLoadBalancer operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- LoadBalancerNotFoundException The specified load balancer does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticLoadBalancingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
modifyLoadBalancerAttributes
default CompletableFuture<ModifyLoadBalancerAttributesResponse> modifyLoadBalancerAttributes(ModifyLoadBalancerAttributesRequest modifyLoadBalancerAttributesRequest) Modifies the attributes of the specified load balancer.
You can modify the load balancer attributes, such as
AccessLogs
,ConnectionDraining
, andCrossZoneLoadBalancing
by either enabling or disabling them. Or, you can modify the load balancer attributeConnectionSettings
by specifying an idle connection timeout value for your load balancer.For more information, see the following in the Classic Load Balancers Guide:
- Parameters:
modifyLoadBalancerAttributesRequest
- Contains the parameters for ModifyLoadBalancerAttributes.- Returns:
- A Java Future containing the result of the ModifyLoadBalancerAttributes operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticLoadBalancingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
modifyLoadBalancerAttributes
default CompletableFuture<ModifyLoadBalancerAttributesResponse> modifyLoadBalancerAttributes(Consumer<ModifyLoadBalancerAttributesRequest.Builder> modifyLoadBalancerAttributesRequest) Modifies the attributes of the specified load balancer.
You can modify the load balancer attributes, such as
AccessLogs
,ConnectionDraining
, andCrossZoneLoadBalancing
by either enabling or disabling them. Or, you can modify the load balancer attributeConnectionSettings
by specifying an idle connection timeout value for your load balancer.For more information, see the following in the Classic Load Balancers Guide:
This is a convenience which creates an instance of the
ModifyLoadBalancerAttributesRequest.Builder
avoiding the need to create one manually viaModifyLoadBalancerAttributesRequest.builder()
- Parameters:
modifyLoadBalancerAttributesRequest
- AConsumer
that will call methods onModifyLoadBalancerAttributesRequest.Builder
to create a request. Contains the parameters for ModifyLoadBalancerAttributes.- Returns:
- A Java Future containing the result of the ModifyLoadBalancerAttributes operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticLoadBalancingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
registerInstancesWithLoadBalancer
default CompletableFuture<RegisterInstancesWithLoadBalancerResponse> 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 theInService
state.To deregister instances from a load balancer, use DeregisterInstancesFromLoadBalancer.
For more information, see Register or De-Register EC2 Instances in the Classic Load Balancers Guide.
- Parameters:
registerInstancesWithLoadBalancerRequest
- Contains the parameters for RegisterInstancesWithLoadBalancer.- Returns:
- A Java Future containing the result of the RegisterInstancesWithLoadBalancer operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- LoadBalancerNotFoundException The specified load balancer does not exist.
- InvalidInstanceException The specified endpoint is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticLoadBalancingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
registerInstancesWithLoadBalancer
default CompletableFuture<RegisterInstancesWithLoadBalancerResponse> registerInstancesWithLoadBalancer(Consumer<RegisterInstancesWithLoadBalancerRequest.Builder> 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 theInService
state.To deregister instances from a load balancer, use DeregisterInstancesFromLoadBalancer.
For more information, see Register or De-Register EC2 Instances in the Classic Load Balancers Guide.
This is a convenience which creates an instance of the
RegisterInstancesWithLoadBalancerRequest.Builder
avoiding the need to create one manually viaRegisterInstancesWithLoadBalancerRequest.builder()
- Parameters:
registerInstancesWithLoadBalancerRequest
- AConsumer
that will call methods onRegisterInstancesWithLoadBalancerRequest.Builder
to create a request. Contains the parameters for RegisterInstancesWithLoadBalancer.- Returns:
- A Java Future containing the result of the RegisterInstancesWithLoadBalancer operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- LoadBalancerNotFoundException The specified load balancer does not exist.
- InvalidInstanceException The specified endpoint is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticLoadBalancingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
removeTags
Removes one or more tags from the specified load balancer.
- Parameters:
removeTagsRequest
- Contains the parameters for RemoveTags.- Returns:
- A Java Future containing the result of the RemoveTags operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- LoadBalancerNotFoundException The specified load balancer does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticLoadBalancingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
removeTags
default CompletableFuture<RemoveTagsResponse> removeTags(Consumer<RemoveTagsRequest.Builder> removeTagsRequest) Removes one or more tags from the specified load balancer.
This is a convenience which creates an instance of the
RemoveTagsRequest.Builder
avoiding the need to create one manually viaRemoveTagsRequest.builder()
- Parameters:
removeTagsRequest
- AConsumer
that will call methods onRemoveTagsRequest.Builder
to create a request. Contains the parameters for RemoveTags.- Returns:
- A Java Future containing the result of the RemoveTags operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- LoadBalancerNotFoundException The specified load balancer does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticLoadBalancingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
setLoadBalancerListenerSSLCertificate
default CompletableFuture<SetLoadBalancerListenerSslCertificateResponse> 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 Balancers Guide.
- Parameters:
setLoadBalancerListenerSslCertificateRequest
- Contains the parameters for SetLoadBalancerListenerSSLCertificate.- Returns:
- A Java Future containing the result of the SetLoadBalancerListenerSSLCertificate operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticLoadBalancingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
setLoadBalancerListenerSSLCertificate
default CompletableFuture<SetLoadBalancerListenerSslCertificateResponse> setLoadBalancerListenerSSLCertificate(Consumer<SetLoadBalancerListenerSslCertificateRequest.Builder> 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 Balancers Guide.
This is a convenience which creates an instance of the
SetLoadBalancerListenerSslCertificateRequest.Builder
avoiding the need to create one manually viaSetLoadBalancerListenerSslCertificateRequest.builder()
- Parameters:
setLoadBalancerListenerSslCertificateRequest
- AConsumer
that will call methods onSetLoadBalancerListenerSslCertificateRequest.Builder
to create a request. Contains the parameters for SetLoadBalancerListenerSSLCertificate.- Returns:
- A Java Future containing the result of the SetLoadBalancerListenerSSLCertificate operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticLoadBalancingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
setLoadBalancerPoliciesForBackendServer
default CompletableFuture<SetLoadBalancerPoliciesForBackendServerResponse> 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 thePolicyNames
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 Balancers Guide. For more information about Proxy Protocol, see Configure Proxy Protocol Support in the Classic Load Balancers Guide.
- Parameters:
setLoadBalancerPoliciesForBackendServerRequest
- Contains the parameters for SetLoadBalancerPoliciesForBackendServer.- Returns:
- A Java Future containing the result of the SetLoadBalancerPoliciesForBackendServer operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticLoadBalancingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
setLoadBalancerPoliciesForBackendServer
default CompletableFuture<SetLoadBalancerPoliciesForBackendServerResponse> setLoadBalancerPoliciesForBackendServer(Consumer<SetLoadBalancerPoliciesForBackendServerRequest.Builder> 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 thePolicyNames
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 Balancers Guide. For more information about Proxy Protocol, see Configure Proxy Protocol Support in the Classic Load Balancers Guide.
This is a convenience which creates an instance of the
SetLoadBalancerPoliciesForBackendServerRequest.Builder
avoiding the need to create one manually viaSetLoadBalancerPoliciesForBackendServerRequest.builder()
- Parameters:
setLoadBalancerPoliciesForBackendServerRequest
- AConsumer
that will call methods onSetLoadBalancerPoliciesForBackendServerRequest.Builder
to create a request. Contains the parameters for SetLoadBalancerPoliciesForBackendServer.- Returns:
- A Java Future containing the result of the SetLoadBalancerPoliciesForBackendServer operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticLoadBalancingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
setLoadBalancerPoliciesOfListener
default CompletableFuture<SetLoadBalancerPoliciesOfListenerResponse> 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 Balancers Guide.
- Parameters:
setLoadBalancerPoliciesOfListenerRequest
- Contains the parameters for SetLoadBalancePoliciesOfListener.- Returns:
- A Java Future containing the result of the SetLoadBalancerPoliciesOfListener operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticLoadBalancingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
setLoadBalancerPoliciesOfListener
default CompletableFuture<SetLoadBalancerPoliciesOfListenerResponse> setLoadBalancerPoliciesOfListener(Consumer<SetLoadBalancerPoliciesOfListenerRequest.Builder> 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 Balancers Guide.
This is a convenience which creates an instance of the
SetLoadBalancerPoliciesOfListenerRequest.Builder
avoiding the need to create one manually viaSetLoadBalancerPoliciesOfListenerRequest.builder()
- Parameters:
setLoadBalancerPoliciesOfListenerRequest
- AConsumer
that will call methods onSetLoadBalancerPoliciesOfListenerRequest.Builder
to create a request. Contains the parameters for SetLoadBalancePoliciesOfListener.- Returns:
- A Java Future containing the result of the SetLoadBalancerPoliciesOfListener operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticLoadBalancingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
waiter
Create an instance ofElasticLoadBalancingAsyncWaiter
using this client.Waiters created via this method are managed by the SDK and resources will be released when the service client is closed.
- Returns:
- an instance of
ElasticLoadBalancingAsyncWaiter
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-
create
Create aElasticLoadBalancingAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aElasticLoadBalancingAsyncClient
.
-