@Generated(value="software.amazon.awssdk:codegen") public interface ElasticLoadBalancingV2AsyncClient extends SdkClient
builder()
method.
A load balancer distributes incoming traffic across targets, such as your EC2 instances. This enables you to increase the availability of your application. The load balancer also monitors the health of its registered targets and ensures that it routes traffic only to healthy targets. 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. You configure a target group with a protocol and port number for connections from the load balancer to the targets, and with health check settings to be used when checking the health status of the targets.
Elastic Load Balancing supports the following types of load balancers: Application Load Balancers, Network Load Balancers, and Classic Load Balancers.
An Application Load Balancer makes routing and load balancing decisions at the application layer (HTTP/HTTPS). A Network Load Balancer makes routing and load balancing decisions at the transport layer (TCP). Both Application Load Balancers and Network Load Balancers can route requests to one or more ports on each EC2 instance or container instance in your virtual private cloud (VPC).
A Classic Load Balancer makes routing and load balancing decisions either at the transport layer (TCP/SSL) or the application layer (HTTP/HTTPS), and supports either EC2-Classic or a VPC. For more information, see the Elastic Load Balancing User Guide.
This reference covers the 2015-12-01 API, which supports Application Load Balancers and Network Load Balancers. The 2012-06-01 API supports Classic Load Balancers.
To get started, complete the following tasks:
Create a load balancer using CreateLoadBalancer.
Create a target group using CreateTargetGroup.
Register targets for the target group using RegisterTargets.
Create one or more listeners for your load balancer using CreateListener.
To delete a load balancer and its related resources, complete the following tasks:
Delete the load balancer using DeleteLoadBalancer.
Delete the target group using DeleteTargetGroup.
All Elastic Load Balancing operations are idempotent, which means that they complete at most one time. If you repeat an operation, it succeeds.
Modifier and Type | Field and Description |
---|---|
static String |
SERVICE_NAME |
Modifier and Type | Method and Description |
---|---|
default CompletableFuture<AddListenerCertificatesResponse> |
addListenerCertificates(AddListenerCertificatesRequest addListenerCertificatesRequest)
Adds the specified certificate to the specified secure listener.
|
default CompletableFuture<AddListenerCertificatesResponse> |
addListenerCertificates(Consumer<AddListenerCertificatesRequest.Builder> addListenerCertificatesRequest)
Adds the specified certificate to the specified secure listener.
|
default CompletableFuture<AddTagsResponse> |
addTags(AddTagsRequest addTagsRequest)
Adds the specified tags to the specified Elastic Load Balancing resource.
|
default CompletableFuture<AddTagsResponse> |
addTags(Consumer<AddTagsRequest.Builder> addTagsRequest)
Adds the specified tags to the specified Elastic Load Balancing resource.
|
static ElasticLoadBalancingV2AsyncClientBuilder |
builder()
Create a builder that can be used to configure and create a
ElasticLoadBalancingV2AsyncClient . |
static ElasticLoadBalancingV2AsyncClient |
create()
Create a
ElasticLoadBalancingV2AsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider . |
default CompletableFuture<CreateListenerResponse> |
createListener(Consumer<CreateListenerRequest.Builder> createListenerRequest)
Creates a listener for the specified Application Load Balancer or Network Load Balancer.
|
default CompletableFuture<CreateListenerResponse> |
createListener(CreateListenerRequest createListenerRequest)
Creates a listener for the specified Application Load Balancer or Network Load Balancer.
|
default CompletableFuture<CreateLoadBalancerResponse> |
createLoadBalancer(Consumer<CreateLoadBalancerRequest.Builder> createLoadBalancerRequest)
Creates an Application Load Balancer or a Network Load Balancer.
|
default CompletableFuture<CreateLoadBalancerResponse> |
createLoadBalancer(CreateLoadBalancerRequest createLoadBalancerRequest)
Creates an Application Load Balancer or a Network Load Balancer.
|
default CompletableFuture<CreateRuleResponse> |
createRule(Consumer<CreateRuleRequest.Builder> createRuleRequest)
Creates a rule for the specified listener.
|
default CompletableFuture<CreateRuleResponse> |
createRule(CreateRuleRequest createRuleRequest)
Creates a rule for the specified listener.
|
default CompletableFuture<CreateTargetGroupResponse> |
createTargetGroup(Consumer<CreateTargetGroupRequest.Builder> createTargetGroupRequest)
Creates a target group.
|
default CompletableFuture<CreateTargetGroupResponse> |
createTargetGroup(CreateTargetGroupRequest createTargetGroupRequest)
Creates a target group.
|
default CompletableFuture<DeleteListenerResponse> |
deleteListener(Consumer<DeleteListenerRequest.Builder> deleteListenerRequest)
Deletes the specified listener.
|
default CompletableFuture<DeleteListenerResponse> |
deleteListener(DeleteListenerRequest deleteListenerRequest)
Deletes the specified listener.
|
default CompletableFuture<DeleteLoadBalancerResponse> |
deleteLoadBalancer(Consumer<DeleteLoadBalancerRequest.Builder> deleteLoadBalancerRequest)
Deletes the specified Application Load Balancer or Network Load Balancer and its attached listeners.
|
default CompletableFuture<DeleteLoadBalancerResponse> |
deleteLoadBalancer(DeleteLoadBalancerRequest deleteLoadBalancerRequest)
Deletes the specified Application Load Balancer or Network Load Balancer and its attached listeners.
|
default CompletableFuture<DeleteRuleResponse> |
deleteRule(Consumer<DeleteRuleRequest.Builder> deleteRuleRequest)
Deletes the specified rule.
|
default CompletableFuture<DeleteRuleResponse> |
deleteRule(DeleteRuleRequest deleteRuleRequest)
Deletes the specified rule.
|
default CompletableFuture<DeleteTargetGroupResponse> |
deleteTargetGroup(Consumer<DeleteTargetGroupRequest.Builder> deleteTargetGroupRequest)
Deletes the specified target group.
|
default CompletableFuture<DeleteTargetGroupResponse> |
deleteTargetGroup(DeleteTargetGroupRequest deleteTargetGroupRequest)
Deletes the specified target group.
|
default CompletableFuture<DeregisterTargetsResponse> |
deregisterTargets(Consumer<DeregisterTargetsRequest.Builder> deregisterTargetsRequest)
Deregisters the specified targets from the specified target group.
|
default CompletableFuture<DeregisterTargetsResponse> |
deregisterTargets(DeregisterTargetsRequest deregisterTargetsRequest)
Deregisters the specified targets from the specified target group.
|
default CompletableFuture<DescribeAccountLimitsResponse> |
describeAccountLimits()
Describes the current Elastic Load Balancing resource limits for your AWS account.
|
default CompletableFuture<DescribeAccountLimitsResponse> |
describeAccountLimits(Consumer<DescribeAccountLimitsRequest.Builder> describeAccountLimitsRequest)
Describes the current Elastic Load Balancing resource limits for your AWS account.
|
default CompletableFuture<DescribeAccountLimitsResponse> |
describeAccountLimits(DescribeAccountLimitsRequest describeAccountLimitsRequest)
Describes the current Elastic Load Balancing resource limits for your AWS account.
|
default CompletableFuture<DescribeListenerCertificatesResponse> |
describeListenerCertificates(Consumer<DescribeListenerCertificatesRequest.Builder> describeListenerCertificatesRequest)
Describes the certificates for the specified secure listener.
|
default CompletableFuture<DescribeListenerCertificatesResponse> |
describeListenerCertificates(DescribeListenerCertificatesRequest describeListenerCertificatesRequest)
Describes the certificates for the specified secure listener.
|
default CompletableFuture<DescribeListenersResponse> |
describeListeners(Consumer<DescribeListenersRequest.Builder> describeListenersRequest)
Describes the specified listeners or the listeners for the specified Application Load Balancer or Network Load
Balancer.
|
default CompletableFuture<DescribeListenersResponse> |
describeListeners(DescribeListenersRequest describeListenersRequest)
Describes the specified listeners or the listeners for the specified Application Load Balancer or Network Load
Balancer.
|
default DescribeListenersPublisher |
describeListenersPaginator(Consumer<DescribeListenersRequest.Builder> describeListenersRequest)
Describes the specified listeners or the listeners for the specified Application Load Balancer or Network Load
Balancer.
|
default DescribeListenersPublisher |
describeListenersPaginator(DescribeListenersRequest describeListenersRequest)
Describes the specified listeners or the listeners for the specified Application Load Balancer or Network Load
Balancer.
|
default CompletableFuture<DescribeLoadBalancerAttributesResponse> |
describeLoadBalancerAttributes(Consumer<DescribeLoadBalancerAttributesRequest.Builder> describeLoadBalancerAttributesRequest)
Describes the attributes for the specified Application Load Balancer or Network Load Balancer.
|
default CompletableFuture<DescribeLoadBalancerAttributesResponse> |
describeLoadBalancerAttributes(DescribeLoadBalancerAttributesRequest describeLoadBalancerAttributesRequest)
Describes the attributes for the specified Application Load Balancer or Network Load Balancer.
|
default CompletableFuture<DescribeLoadBalancersResponse> |
describeLoadBalancers()
Describes the specified load balancers or all of your load balancers.
|
default CompletableFuture<DescribeLoadBalancersResponse> |
describeLoadBalancers(Consumer<DescribeLoadBalancersRequest.Builder> describeLoadBalancersRequest)
Describes the specified load balancers or all of your load balancers.
|
default CompletableFuture<DescribeLoadBalancersResponse> |
describeLoadBalancers(DescribeLoadBalancersRequest describeLoadBalancersRequest)
Describes the specified load balancers or all of your load balancers.
|
default DescribeLoadBalancersPublisher |
describeLoadBalancersPaginator()
Describes the specified load balancers or all of your load balancers.
|
default DescribeLoadBalancersPublisher |
describeLoadBalancersPaginator(Consumer<DescribeLoadBalancersRequest.Builder> describeLoadBalancersRequest)
Describes the specified load balancers or all of your load balancers.
|
default DescribeLoadBalancersPublisher |
describeLoadBalancersPaginator(DescribeLoadBalancersRequest describeLoadBalancersRequest)
Describes the specified load balancers or all of your load balancers.
|
default CompletableFuture<DescribeRulesResponse> |
describeRules(Consumer<DescribeRulesRequest.Builder> describeRulesRequest)
Describes the specified rules or the rules for the specified listener.
|
default CompletableFuture<DescribeRulesResponse> |
describeRules(DescribeRulesRequest describeRulesRequest)
Describes the specified rules or the rules for the specified listener.
|
default CompletableFuture<DescribeSslPoliciesResponse> |
describeSSLPolicies()
Describes the specified policies or all policies used for SSL negotiation.
|
default CompletableFuture<DescribeSslPoliciesResponse> |
describeSSLPolicies(Consumer<DescribeSslPoliciesRequest.Builder> describeSslPoliciesRequest)
Describes the specified policies or all policies used for SSL negotiation.
|
default CompletableFuture<DescribeSslPoliciesResponse> |
describeSSLPolicies(DescribeSslPoliciesRequest describeSslPoliciesRequest)
Describes the specified policies or all policies used for SSL negotiation.
|
default CompletableFuture<DescribeTagsResponse> |
describeTags(Consumer<DescribeTagsRequest.Builder> describeTagsRequest)
Describes the tags for the specified resources.
|
default CompletableFuture<DescribeTagsResponse> |
describeTags(DescribeTagsRequest describeTagsRequest)
Describes the tags for the specified resources.
|
default CompletableFuture<DescribeTargetGroupAttributesResponse> |
describeTargetGroupAttributes(Consumer<DescribeTargetGroupAttributesRequest.Builder> describeTargetGroupAttributesRequest)
Describes the attributes for the specified target group.
|
default CompletableFuture<DescribeTargetGroupAttributesResponse> |
describeTargetGroupAttributes(DescribeTargetGroupAttributesRequest describeTargetGroupAttributesRequest)
Describes the attributes for the specified target group.
|
default CompletableFuture<DescribeTargetGroupsResponse> |
describeTargetGroups()
Describes the specified target groups or all of your target groups.
|
default CompletableFuture<DescribeTargetGroupsResponse> |
describeTargetGroups(Consumer<DescribeTargetGroupsRequest.Builder> describeTargetGroupsRequest)
Describes the specified target groups or all of your target groups.
|
default CompletableFuture<DescribeTargetGroupsResponse> |
describeTargetGroups(DescribeTargetGroupsRequest describeTargetGroupsRequest)
Describes the specified target groups or all of your target groups.
|
default DescribeTargetGroupsPublisher |
describeTargetGroupsPaginator()
Describes the specified target groups or all of your target groups.
|
default DescribeTargetGroupsPublisher |
describeTargetGroupsPaginator(Consumer<DescribeTargetGroupsRequest.Builder> describeTargetGroupsRequest)
Describes the specified target groups or all of your target groups.
|
default DescribeTargetGroupsPublisher |
describeTargetGroupsPaginator(DescribeTargetGroupsRequest describeTargetGroupsRequest)
Describes the specified target groups or all of your target groups.
|
default CompletableFuture<DescribeTargetHealthResponse> |
describeTargetHealth(Consumer<DescribeTargetHealthRequest.Builder> describeTargetHealthRequest)
Describes the health of the specified targets or all of your targets.
|
default CompletableFuture<DescribeTargetHealthResponse> |
describeTargetHealth(DescribeTargetHealthRequest describeTargetHealthRequest)
Describes the health of the specified targets or all of your targets.
|
default CompletableFuture<ModifyListenerResponse> |
modifyListener(Consumer<ModifyListenerRequest.Builder> modifyListenerRequest)
Modifies the specified properties of the specified listener.
|
default CompletableFuture<ModifyListenerResponse> |
modifyListener(ModifyListenerRequest modifyListenerRequest)
Modifies the specified properties of the specified listener.
|
default CompletableFuture<ModifyLoadBalancerAttributesResponse> |
modifyLoadBalancerAttributes(Consumer<ModifyLoadBalancerAttributesRequest.Builder> modifyLoadBalancerAttributesRequest)
Modifies the specified attributes of the specified Application Load Balancer or Network Load Balancer.
|
default CompletableFuture<ModifyLoadBalancerAttributesResponse> |
modifyLoadBalancerAttributes(ModifyLoadBalancerAttributesRequest modifyLoadBalancerAttributesRequest)
Modifies the specified attributes of the specified Application Load Balancer or Network Load Balancer.
|
default CompletableFuture<ModifyRuleResponse> |
modifyRule(Consumer<ModifyRuleRequest.Builder> modifyRuleRequest)
Modifies the specified rule.
|
default CompletableFuture<ModifyRuleResponse> |
modifyRule(ModifyRuleRequest modifyRuleRequest)
Modifies the specified rule.
|
default CompletableFuture<ModifyTargetGroupResponse> |
modifyTargetGroup(Consumer<ModifyTargetGroupRequest.Builder> modifyTargetGroupRequest)
Modifies the health checks used when evaluating the health state of the targets in the specified target group.
|
default CompletableFuture<ModifyTargetGroupResponse> |
modifyTargetGroup(ModifyTargetGroupRequest modifyTargetGroupRequest)
Modifies the health checks used when evaluating the health state of the targets in the specified target group.
|
default CompletableFuture<ModifyTargetGroupAttributesResponse> |
modifyTargetGroupAttributes(Consumer<ModifyTargetGroupAttributesRequest.Builder> modifyTargetGroupAttributesRequest)
Modifies the specified attributes of the specified target group.
|
default CompletableFuture<ModifyTargetGroupAttributesResponse> |
modifyTargetGroupAttributes(ModifyTargetGroupAttributesRequest modifyTargetGroupAttributesRequest)
Modifies the specified attributes of the specified target group.
|
default CompletableFuture<RegisterTargetsResponse> |
registerTargets(Consumer<RegisterTargetsRequest.Builder> registerTargetsRequest)
Registers the specified targets with the specified target group.
|
default CompletableFuture<RegisterTargetsResponse> |
registerTargets(RegisterTargetsRequest registerTargetsRequest)
Registers the specified targets with the specified target group.
|
default CompletableFuture<RemoveListenerCertificatesResponse> |
removeListenerCertificates(Consumer<RemoveListenerCertificatesRequest.Builder> removeListenerCertificatesRequest)
Removes the specified certificate from the specified secure listener.
|
default CompletableFuture<RemoveListenerCertificatesResponse> |
removeListenerCertificates(RemoveListenerCertificatesRequest removeListenerCertificatesRequest)
Removes the specified certificate from the specified secure listener.
|
default CompletableFuture<RemoveTagsResponse> |
removeTags(Consumer<RemoveTagsRequest.Builder> removeTagsRequest)
Removes the specified tags from the specified Elastic Load Balancing resource.
|
default CompletableFuture<RemoveTagsResponse> |
removeTags(RemoveTagsRequest removeTagsRequest)
Removes the specified tags from the specified Elastic Load Balancing resource.
|
default CompletableFuture<SetIpAddressTypeResponse> |
setIpAddressType(Consumer<SetIpAddressTypeRequest.Builder> setIpAddressTypeRequest)
Sets the type of IP addresses used by the subnets of the specified Application Load Balancer or Network Load
Balancer.
|
default CompletableFuture<SetIpAddressTypeResponse> |
setIpAddressType(SetIpAddressTypeRequest setIpAddressTypeRequest)
Sets the type of IP addresses used by the subnets of the specified Application Load Balancer or Network Load
Balancer.
|
default CompletableFuture<SetRulePrioritiesResponse> |
setRulePriorities(Consumer<SetRulePrioritiesRequest.Builder> setRulePrioritiesRequest)
Sets the priorities of the specified rules.
|
default CompletableFuture<SetRulePrioritiesResponse> |
setRulePriorities(SetRulePrioritiesRequest setRulePrioritiesRequest)
Sets the priorities of the specified rules.
|
default CompletableFuture<SetSecurityGroupsResponse> |
setSecurityGroups(Consumer<SetSecurityGroupsRequest.Builder> setSecurityGroupsRequest)
Associates the specified security groups with the specified Application Load Balancer.
|
default CompletableFuture<SetSecurityGroupsResponse> |
setSecurityGroups(SetSecurityGroupsRequest setSecurityGroupsRequest)
Associates the specified security groups with the specified Application Load Balancer.
|
default CompletableFuture<SetSubnetsResponse> |
setSubnets(Consumer<SetSubnetsRequest.Builder> setSubnetsRequest)
Enables the Availability Zone for the specified subnets for the specified Application Load Balancer.
|
default CompletableFuture<SetSubnetsResponse> |
setSubnets(SetSubnetsRequest setSubnetsRequest)
Enables the Availability Zone for the specified subnets for the specified Application Load Balancer.
|
serviceName
close
static final String SERVICE_NAME
static ElasticLoadBalancingV2AsyncClient create()
ElasticLoadBalancingV2AsyncClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from the
DefaultCredentialsProvider
.static ElasticLoadBalancingV2AsyncClientBuilder builder()
ElasticLoadBalancingV2AsyncClient
.default CompletableFuture<AddListenerCertificatesResponse> addListenerCertificates(AddListenerCertificatesRequest addListenerCertificatesRequest)
Adds the specified certificate to the specified secure listener.
If the certificate was already added, the call is successful but the certificate is not added again.
To list the certificates for your listener, use DescribeListenerCertificates. To remove certificates from your listener, use RemoveListenerCertificates.
addListenerCertificatesRequest
- default CompletableFuture<AddListenerCertificatesResponse> addListenerCertificates(Consumer<AddListenerCertificatesRequest.Builder> addListenerCertificatesRequest)
Adds the specified certificate to the specified secure listener.
If the certificate was already added, the call is successful but the certificate is not added again.
To list the certificates for your listener, use DescribeListenerCertificates. To remove certificates from your listener, use RemoveListenerCertificates.
This is a convenience which creates an instance of the AddListenerCertificatesRequest.Builder
avoiding
the need to create one manually via AddListenerCertificatesRequest.builder()
addListenerCertificatesRequest
- A Consumer
that will call methods on AddListenerCertificatesInput.Builder
to create a
request.default CompletableFuture<AddTagsResponse> addTags(AddTagsRequest addTagsRequest)
Adds the specified tags to the specified Elastic Load Balancing resource. You can tag your Application Load Balancers, Network Load Balancers, and your target groups.
Each tag consists of a key and an optional value. If a resource already has a tag with the same key,
AddTags
updates its value.
To list the current tags for your resources, use DescribeTags. To remove tags from your resources, use RemoveTags.
addTagsRequest
- default CompletableFuture<AddTagsResponse> addTags(Consumer<AddTagsRequest.Builder> addTagsRequest)
Adds the specified tags to the specified Elastic Load Balancing resource. You can tag your Application Load Balancers, Network Load Balancers, and your target groups.
Each tag consists of a key and an optional value. If a resource already has a tag with the same key,
AddTags
updates its value.
To list the current tags for your resources, use DescribeTags. To remove tags from your resources, use RemoveTags.
This is a convenience which creates an instance of the AddTagsRequest.Builder
avoiding the need to create
one manually via AddTagsRequest.builder()
addTagsRequest
- A Consumer
that will call methods on AddTagsInput.Builder
to create a request.default CompletableFuture<CreateListenerResponse> createListener(CreateListenerRequest createListenerRequest)
Creates a listener for the specified Application Load Balancer or Network Load Balancer.
To update a listener, use ModifyListener. When you are finished with a listener, you can delete it using DeleteListener. If you are finished with both the listener and the load balancer, you can delete them both using DeleteLoadBalancer.
This operation is idempotent, which means that it completes at most one time. If you attempt to create multiple listeners with the same settings, each call succeeds.
For more information, see Listeners for Your Application Load Balancers in the Application Load Balancers Guide and Listeners for Your Network Load Balancers in the Network Load Balancers Guide.
createListenerRequest
- default CompletableFuture<CreateListenerResponse> createListener(Consumer<CreateListenerRequest.Builder> createListenerRequest)
Creates a listener for the specified Application Load Balancer or Network Load Balancer.
To update a listener, use ModifyListener. When you are finished with a listener, you can delete it using DeleteListener. If you are finished with both the listener and the load balancer, you can delete them both using DeleteLoadBalancer.
This operation is idempotent, which means that it completes at most one time. If you attempt to create multiple listeners with the same settings, each call succeeds.
For more information, see Listeners for Your Application Load Balancers in the Application Load Balancers Guide and Listeners for Your Network Load Balancers in the Network Load Balancers Guide.
This is a convenience which creates an instance of the CreateListenerRequest.Builder
avoiding the need to
create one manually via CreateListenerRequest.builder()
createListenerRequest
- A Consumer
that will call methods on CreateListenerInput.Builder
to create a request.default CompletableFuture<CreateLoadBalancerResponse> createLoadBalancer(CreateLoadBalancerRequest createLoadBalancerRequest)
Creates an Application Load Balancer or a Network Load Balancer.
When you create a load balancer, you can specify security groups, subnets, IP address type, and tags. Otherwise, you could do so later using SetSecurityGroups, SetSubnets, SetIpAddressType, and AddTags.
To create listeners for your load balancer, use CreateListener. To describe your current load balancers, see DescribeLoadBalancers. When you are finished with a load balancer, you can delete it using DeleteLoadBalancer.
For limit information, see Limits for Your Application Load Balancer in the Application Load Balancers Guide and Limits for Your Network Load Balancer in the Network Load Balancers Guide.
This operation is idempotent, which means that it completes at most one time. If you attempt to create multiple load balancers with the same settings, each call succeeds.
For more information, see Application Load Balancers in the Application Load Balancers Guide and Network Load Balancers in the Network Load Balancers Guide.
createLoadBalancerRequest
- default CompletableFuture<CreateLoadBalancerResponse> createLoadBalancer(Consumer<CreateLoadBalancerRequest.Builder> createLoadBalancerRequest)
Creates an Application Load Balancer or a Network Load Balancer.
When you create a load balancer, you can specify security groups, subnets, IP address type, and tags. Otherwise, you could do so later using SetSecurityGroups, SetSubnets, SetIpAddressType, and AddTags.
To create listeners for your load balancer, use CreateListener. To describe your current load balancers, see DescribeLoadBalancers. When you are finished with a load balancer, you can delete it using DeleteLoadBalancer.
For limit information, see Limits for Your Application Load Balancer in the Application Load Balancers Guide and Limits for Your Network Load Balancer in the Network Load Balancers Guide.
This operation is idempotent, which means that it completes at most one time. If you attempt to create multiple load balancers with the same settings, each call succeeds.
For more information, see Application Load Balancers in the Application Load Balancers Guide and Network Load Balancers in the Network Load Balancers Guide.
This is a convenience which creates an instance of the CreateLoadBalancerRequest.Builder
avoiding the
need to create one manually via CreateLoadBalancerRequest.builder()
createLoadBalancerRequest
- A Consumer
that will call methods on CreateLoadBalancerInput.Builder
to create a request.default CompletableFuture<CreateRuleResponse> createRule(CreateRuleRequest createRuleRequest)
Creates a rule for the specified listener. The listener must be associated with an Application Load Balancer.
Rules are evaluated in priority order, from the lowest value to the highest value. When the condition for a rule is met, the specified action is taken. If no conditions are met, the action for the default rule is taken. For more information, see Listener Rules in the Application Load Balancers Guide.
To view your current rules, use DescribeRules. To update a rule, use ModifyRule. To set the priorities of your rules, use SetRulePriorities. To delete a rule, use DeleteRule.
createRuleRequest
- default CompletableFuture<CreateRuleResponse> createRule(Consumer<CreateRuleRequest.Builder> createRuleRequest)
Creates a rule for the specified listener. The listener must be associated with an Application Load Balancer.
Rules are evaluated in priority order, from the lowest value to the highest value. When the condition for a rule is met, the specified action is taken. If no conditions are met, the action for the default rule is taken. For more information, see Listener Rules in the Application Load Balancers Guide.
To view your current rules, use DescribeRules. To update a rule, use ModifyRule. To set the priorities of your rules, use SetRulePriorities. To delete a rule, use DeleteRule.
This is a convenience which creates an instance of the CreateRuleRequest.Builder
avoiding the need to
create one manually via CreateRuleRequest.builder()
createRuleRequest
- A Consumer
that will call methods on CreateRuleInput.Builder
to create a request.default CompletableFuture<CreateTargetGroupResponse> createTargetGroup(CreateTargetGroupRequest createTargetGroupRequest)
Creates a target group.
To register targets with the target group, use RegisterTargets. To update the health check settings for the target group, use ModifyTargetGroup. To monitor the health of targets in the target group, use DescribeTargetHealth.
To route traffic to the targets in a target group, specify the target group in an action using CreateListener or CreateRule.
To delete a target group, use DeleteTargetGroup.
This operation is idempotent, which means that it completes at most one time. If you attempt to create multiple target groups with the same settings, each call succeeds.
For more information, see Target Groups for Your Application Load Balancers in the Application Load Balancers Guide or Target Groups for Your Network Load Balancers in the Network Load Balancers Guide.
createTargetGroupRequest
- default CompletableFuture<CreateTargetGroupResponse> createTargetGroup(Consumer<CreateTargetGroupRequest.Builder> createTargetGroupRequest)
Creates a target group.
To register targets with the target group, use RegisterTargets. To update the health check settings for the target group, use ModifyTargetGroup. To monitor the health of targets in the target group, use DescribeTargetHealth.
To route traffic to the targets in a target group, specify the target group in an action using CreateListener or CreateRule.
To delete a target group, use DeleteTargetGroup.
This operation is idempotent, which means that it completes at most one time. If you attempt to create multiple target groups with the same settings, each call succeeds.
For more information, see Target Groups for Your Application Load Balancers in the Application Load Balancers Guide or Target Groups for Your Network Load Balancers in the Network Load Balancers Guide.
This is a convenience which creates an instance of the CreateTargetGroupRequest.Builder
avoiding the need
to create one manually via CreateTargetGroupRequest.builder()
createTargetGroupRequest
- A Consumer
that will call methods on CreateTargetGroupInput.Builder
to create a request.default CompletableFuture<DeleteListenerResponse> deleteListener(DeleteListenerRequest deleteListenerRequest)
Deletes the specified listener.
Alternatively, your listener is deleted when you delete the load balancer it is attached to using DeleteLoadBalancer.
deleteListenerRequest
- default CompletableFuture<DeleteListenerResponse> deleteListener(Consumer<DeleteListenerRequest.Builder> deleteListenerRequest)
Deletes the specified listener.
Alternatively, your listener is deleted when you delete the load balancer it is attached to using DeleteLoadBalancer.
This is a convenience which creates an instance of the DeleteListenerRequest.Builder
avoiding the need to
create one manually via DeleteListenerRequest.builder()
deleteListenerRequest
- A Consumer
that will call methods on DeleteListenerInput.Builder
to create a request.default CompletableFuture<DeleteLoadBalancerResponse> deleteLoadBalancer(DeleteLoadBalancerRequest deleteLoadBalancerRequest)
Deletes the specified Application Load Balancer or Network Load Balancer and its attached listeners.
You can't delete a load balancer if deletion protection is enabled. If the load balancer does not exist or has already been deleted, the call succeeds.
Deleting a load balancer does not affect its registered targets. For example, your EC2 instances continue to run and are still registered to their target groups. If you no longer need these EC2 instances, you can stop or terminate them.
deleteLoadBalancerRequest
- default CompletableFuture<DeleteLoadBalancerResponse> deleteLoadBalancer(Consumer<DeleteLoadBalancerRequest.Builder> deleteLoadBalancerRequest)
Deletes the specified Application Load Balancer or Network Load Balancer and its attached listeners.
You can't delete a load balancer if deletion protection is enabled. If the load balancer does not exist or has already been deleted, the call succeeds.
Deleting a load balancer does not affect its registered targets. For example, your EC2 instances continue to run and are still registered to their target groups. If you no longer need these EC2 instances, you can stop or terminate them.
This is a convenience which creates an instance of the DeleteLoadBalancerRequest.Builder
avoiding the
need to create one manually via DeleteLoadBalancerRequest.builder()
deleteLoadBalancerRequest
- A Consumer
that will call methods on DeleteLoadBalancerInput.Builder
to create a request.default CompletableFuture<DeleteRuleResponse> deleteRule(DeleteRuleRequest deleteRuleRequest)
Deletes the specified rule.
deleteRuleRequest
- default CompletableFuture<DeleteRuleResponse> deleteRule(Consumer<DeleteRuleRequest.Builder> deleteRuleRequest)
Deletes the specified rule.
This is a convenience which creates an instance of the DeleteRuleRequest.Builder
avoiding the need to
create one manually via DeleteRuleRequest.builder()
deleteRuleRequest
- A Consumer
that will call methods on DeleteRuleInput.Builder
to create a request.default CompletableFuture<DeleteTargetGroupResponse> deleteTargetGroup(DeleteTargetGroupRequest deleteTargetGroupRequest)
Deletes the specified target group.
You can delete a target group if it is not referenced by any actions. Deleting a target group also deletes any associated health checks.
deleteTargetGroupRequest
- default CompletableFuture<DeleteTargetGroupResponse> deleteTargetGroup(Consumer<DeleteTargetGroupRequest.Builder> deleteTargetGroupRequest)
Deletes the specified target group.
You can delete a target group if it is not referenced by any actions. Deleting a target group also deletes any associated health checks.
This is a convenience which creates an instance of the DeleteTargetGroupRequest.Builder
avoiding the need
to create one manually via DeleteTargetGroupRequest.builder()
deleteTargetGroupRequest
- A Consumer
that will call methods on DeleteTargetGroupInput.Builder
to create a request.default CompletableFuture<DeregisterTargetsResponse> deregisterTargets(DeregisterTargetsRequest deregisterTargetsRequest)
Deregisters the specified targets from the specified target group. After the targets are deregistered, they no longer receive traffic from the load balancer.
deregisterTargetsRequest
- default CompletableFuture<DeregisterTargetsResponse> deregisterTargets(Consumer<DeregisterTargetsRequest.Builder> deregisterTargetsRequest)
Deregisters the specified targets from the specified target group. After the targets are deregistered, they no longer receive traffic from the load balancer.
This is a convenience which creates an instance of the DeregisterTargetsRequest.Builder
avoiding the need
to create one manually via DeregisterTargetsRequest.builder()
deregisterTargetsRequest
- A Consumer
that will call methods on DeregisterTargetsInput.Builder
to create a request.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 Application Load Balancers in the Application Load Balancer Guide or Limits for Your Network Load Balancers in the Network Load Balancers Guide.
describeAccountLimitsRequest
- 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 Application Load Balancers in the Application Load Balancer Guide or Limits for Your Network Load Balancers in the Network Load Balancers Guide.
This is a convenience which creates an instance of the DescribeAccountLimitsRequest.Builder
avoiding the
need to create one manually via DescribeAccountLimitsRequest.builder()
describeAccountLimitsRequest
- A Consumer
that will call methods on DescribeAccountLimitsInput.Builder
to create a
request.default CompletableFuture<DescribeAccountLimitsResponse> describeAccountLimits()
Describes the current Elastic Load Balancing resource limits for your AWS account.
For more information, see Limits for Your Application Load Balancers in the Application Load Balancer Guide or Limits for Your Network Load Balancers in the Network Load Balancers Guide.
default CompletableFuture<DescribeListenerCertificatesResponse> describeListenerCertificates(DescribeListenerCertificatesRequest describeListenerCertificatesRequest)
Describes the certificates for the specified secure listener.
describeListenerCertificatesRequest
- default CompletableFuture<DescribeListenerCertificatesResponse> describeListenerCertificates(Consumer<DescribeListenerCertificatesRequest.Builder> describeListenerCertificatesRequest)
Describes the certificates for the specified secure listener.
This is a convenience which creates an instance of the DescribeListenerCertificatesRequest.Builder
avoiding the need to create one manually via DescribeListenerCertificatesRequest.builder()
describeListenerCertificatesRequest
- A Consumer
that will call methods on DescribeListenerCertificatesInput.Builder
to create a
request.default CompletableFuture<DescribeListenersResponse> describeListeners(DescribeListenersRequest describeListenersRequest)
Describes the specified listeners or the listeners for the specified Application Load Balancer or Network Load Balancer. You must specify either a load balancer or one or more listeners.
describeListenersRequest
- default CompletableFuture<DescribeListenersResponse> describeListeners(Consumer<DescribeListenersRequest.Builder> describeListenersRequest)
Describes the specified listeners or the listeners for the specified Application Load Balancer or Network Load Balancer. You must specify either a load balancer or one or more listeners.
This is a convenience which creates an instance of the DescribeListenersRequest.Builder
avoiding the need
to create one manually via DescribeListenersRequest.builder()
describeListenersRequest
- A Consumer
that will call methods on DescribeListenersInput.Builder
to create a request.default DescribeListenersPublisher describeListenersPaginator(DescribeListenersRequest describeListenersRequest)
Describes the specified listeners or the listeners for the specified Application Load Balancer or Network Load Balancer. You must specify either a load balancer or one or more listeners.
This is a variant of
describeListeners(software.amazon.awssdk.services.elasticloadbalancingv2.model.DescribeListenersRequest)
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 new Subscription
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 forEach helper method
software.amazon.awssdk.services.elasticloadbalancingv2.paginators.DescribeListenersPublisher publisher = client.describeListenersPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.elasticloadbalancingv2.paginators.DescribeListenersPublisher publisher = client.describeListenersPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticloadbalancingv2.model.DescribeListenersResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.elasticloadbalancingv2.model.DescribeListenersResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
describeListeners(software.amazon.awssdk.services.elasticloadbalancingv2.model.DescribeListenersRequest)
operation.
describeListenersRequest
- default DescribeListenersPublisher describeListenersPaginator(Consumer<DescribeListenersRequest.Builder> describeListenersRequest)
Describes the specified listeners or the listeners for the specified Application Load Balancer or Network Load Balancer. You must specify either a load balancer or one or more listeners.
This is a variant of
describeListeners(software.amazon.awssdk.services.elasticloadbalancingv2.model.DescribeListenersRequest)
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 new Subscription
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 forEach helper method
software.amazon.awssdk.services.elasticloadbalancingv2.paginators.DescribeListenersPublisher publisher = client.describeListenersPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.elasticloadbalancingv2.paginators.DescribeListenersPublisher publisher = client.describeListenersPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticloadbalancingv2.model.DescribeListenersResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.elasticloadbalancingv2.model.DescribeListenersResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
describeListeners(software.amazon.awssdk.services.elasticloadbalancingv2.model.DescribeListenersRequest)
operation.
This is a convenience which creates an instance of the DescribeListenersRequest.Builder
avoiding the need
to create one manually via DescribeListenersRequest.builder()
describeListenersRequest
- A Consumer
that will call methods on DescribeListenersInput.Builder
to create a request.default CompletableFuture<DescribeLoadBalancerAttributesResponse> describeLoadBalancerAttributes(DescribeLoadBalancerAttributesRequest describeLoadBalancerAttributesRequest)
Describes the attributes for the specified Application Load Balancer or Network Load Balancer.
describeLoadBalancerAttributesRequest
- default CompletableFuture<DescribeLoadBalancerAttributesResponse> describeLoadBalancerAttributes(Consumer<DescribeLoadBalancerAttributesRequest.Builder> describeLoadBalancerAttributesRequest)
Describes the attributes for the specified Application Load Balancer or Network Load Balancer.
This is a convenience which creates an instance of the DescribeLoadBalancerAttributesRequest.Builder
avoiding the need to create one manually via DescribeLoadBalancerAttributesRequest.builder()
describeLoadBalancerAttributesRequest
- A Consumer
that will call methods on DescribeLoadBalancerAttributesInput.Builder
to create
a request.default CompletableFuture<DescribeLoadBalancersResponse> describeLoadBalancers(DescribeLoadBalancersRequest describeLoadBalancersRequest)
Describes the specified load balancers or all of your load balancers.
To describe the listeners for a load balancer, use DescribeListeners. To describe the attributes for a load balancer, use DescribeLoadBalancerAttributes.
describeLoadBalancersRequest
- default CompletableFuture<DescribeLoadBalancersResponse> describeLoadBalancers(Consumer<DescribeLoadBalancersRequest.Builder> describeLoadBalancersRequest)
Describes the specified load balancers or all of your load balancers.
To describe the listeners for a load balancer, use DescribeListeners. To describe the attributes for a load balancer, use DescribeLoadBalancerAttributes.
This is a convenience which creates an instance of the DescribeLoadBalancersRequest.Builder
avoiding the
need to create one manually via DescribeLoadBalancersRequest.builder()
describeLoadBalancersRequest
- A Consumer
that will call methods on DescribeLoadBalancersInput.Builder
to create a
request.default CompletableFuture<DescribeLoadBalancersResponse> describeLoadBalancers()
Describes the specified load balancers or all of your load balancers.
To describe the listeners for a load balancer, use DescribeListeners. To describe the attributes for a load balancer, use DescribeLoadBalancerAttributes.
default DescribeLoadBalancersPublisher describeLoadBalancersPaginator()
Describes the specified load balancers or all of your load balancers.
To describe the listeners for a load balancer, use DescribeListeners. To describe the attributes for a load balancer, use DescribeLoadBalancerAttributes.
This is a variant of
describeLoadBalancers(software.amazon.awssdk.services.elasticloadbalancingv2.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 new Subscription
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 forEach helper method
software.amazon.awssdk.services.elasticloadbalancingv2.paginators.DescribeLoadBalancersPublisher publisher = client.describeLoadBalancersPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.elasticloadbalancingv2.paginators.DescribeLoadBalancersPublisher publisher = client.describeLoadBalancersPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticloadbalancingv2.model.DescribeLoadBalancersResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.elasticloadbalancingv2.model.DescribeLoadBalancersResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
describeLoadBalancers(software.amazon.awssdk.services.elasticloadbalancingv2.model.DescribeLoadBalancersRequest)
operation.
default DescribeLoadBalancersPublisher describeLoadBalancersPaginator(DescribeLoadBalancersRequest describeLoadBalancersRequest)
Describes the specified load balancers or all of your load balancers.
To describe the listeners for a load balancer, use DescribeListeners. To describe the attributes for a load balancer, use DescribeLoadBalancerAttributes.
This is a variant of
describeLoadBalancers(software.amazon.awssdk.services.elasticloadbalancingv2.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 new Subscription
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 forEach helper method
software.amazon.awssdk.services.elasticloadbalancingv2.paginators.DescribeLoadBalancersPublisher publisher = client.describeLoadBalancersPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.elasticloadbalancingv2.paginators.DescribeLoadBalancersPublisher publisher = client.describeLoadBalancersPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticloadbalancingv2.model.DescribeLoadBalancersResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.elasticloadbalancingv2.model.DescribeLoadBalancersResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
describeLoadBalancers(software.amazon.awssdk.services.elasticloadbalancingv2.model.DescribeLoadBalancersRequest)
operation.
describeLoadBalancersRequest
- default DescribeLoadBalancersPublisher describeLoadBalancersPaginator(Consumer<DescribeLoadBalancersRequest.Builder> describeLoadBalancersRequest)
Describes the specified load balancers or all of your load balancers.
To describe the listeners for a load balancer, use DescribeListeners. To describe the attributes for a load balancer, use DescribeLoadBalancerAttributes.
This is a variant of
describeLoadBalancers(software.amazon.awssdk.services.elasticloadbalancingv2.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 new Subscription
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 forEach helper method
software.amazon.awssdk.services.elasticloadbalancingv2.paginators.DescribeLoadBalancersPublisher publisher = client.describeLoadBalancersPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.elasticloadbalancingv2.paginators.DescribeLoadBalancersPublisher publisher = client.describeLoadBalancersPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticloadbalancingv2.model.DescribeLoadBalancersResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.elasticloadbalancingv2.model.DescribeLoadBalancersResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
describeLoadBalancers(software.amazon.awssdk.services.elasticloadbalancingv2.model.DescribeLoadBalancersRequest)
operation.
This is a convenience which creates an instance of the DescribeLoadBalancersRequest.Builder
avoiding the
need to create one manually via DescribeLoadBalancersRequest.builder()
describeLoadBalancersRequest
- A Consumer
that will call methods on DescribeLoadBalancersInput.Builder
to create a
request.default CompletableFuture<DescribeRulesResponse> describeRules(DescribeRulesRequest describeRulesRequest)
Describes the specified rules or the rules for the specified listener. You must specify either a listener or one or more rules.
describeRulesRequest
- default CompletableFuture<DescribeRulesResponse> describeRules(Consumer<DescribeRulesRequest.Builder> describeRulesRequest)
Describes the specified rules or the rules for the specified listener. You must specify either a listener or one or more rules.
This is a convenience which creates an instance of the DescribeRulesRequest.Builder
avoiding the need to
create one manually via DescribeRulesRequest.builder()
describeRulesRequest
- A Consumer
that will call methods on DescribeRulesInput.Builder
to create a request.default CompletableFuture<DescribeSslPoliciesResponse> describeSSLPolicies(DescribeSslPoliciesRequest describeSslPoliciesRequest)
Describes the specified policies or all policies used for SSL negotiation.
For more information, see Security Policies in the Application Load Balancers Guide.
describeSslPoliciesRequest
- default CompletableFuture<DescribeSslPoliciesResponse> describeSSLPolicies(Consumer<DescribeSslPoliciesRequest.Builder> describeSslPoliciesRequest)
Describes the specified policies or all policies used for SSL negotiation.
For more information, see Security Policies in the Application Load Balancers Guide.
This is a convenience which creates an instance of the DescribeSslPoliciesRequest.Builder
avoiding the
need to create one manually via DescribeSslPoliciesRequest.builder()
describeSslPoliciesRequest
- A Consumer
that will call methods on DescribeSSLPoliciesInput.Builder
to create a request.default CompletableFuture<DescribeSslPoliciesResponse> describeSSLPolicies()
Describes the specified policies or all policies used for SSL negotiation.
For more information, see Security Policies in the Application Load Balancers Guide.
default CompletableFuture<DescribeTagsResponse> describeTags(DescribeTagsRequest describeTagsRequest)
Describes the tags for the specified resources. You can describe the tags for one or more Application Load Balancers, Network Load Balancers, and target groups.
describeTagsRequest
- default CompletableFuture<DescribeTagsResponse> describeTags(Consumer<DescribeTagsRequest.Builder> describeTagsRequest)
Describes the tags for the specified resources. You can describe the tags for one or more Application Load Balancers, Network Load Balancers, and target groups.
This is a convenience which creates an instance of the DescribeTagsRequest.Builder
avoiding the need to
create one manually via DescribeTagsRequest.builder()
describeTagsRequest
- A Consumer
that will call methods on DescribeTagsInput.Builder
to create a request.default CompletableFuture<DescribeTargetGroupAttributesResponse> describeTargetGroupAttributes(DescribeTargetGroupAttributesRequest describeTargetGroupAttributesRequest)
Describes the attributes for the specified target group.
describeTargetGroupAttributesRequest
- default CompletableFuture<DescribeTargetGroupAttributesResponse> describeTargetGroupAttributes(Consumer<DescribeTargetGroupAttributesRequest.Builder> describeTargetGroupAttributesRequest)
Describes the attributes for the specified target group.
This is a convenience which creates an instance of the DescribeTargetGroupAttributesRequest.Builder
avoiding the need to create one manually via DescribeTargetGroupAttributesRequest.builder()
describeTargetGroupAttributesRequest
- A Consumer
that will call methods on DescribeTargetGroupAttributesInput.Builder
to create
a request.default CompletableFuture<DescribeTargetGroupsResponse> describeTargetGroups(DescribeTargetGroupsRequest describeTargetGroupsRequest)
Describes the specified target groups or all of your target groups. By default, all target groups are described. Alternatively, you can specify one of the following to filter the results: the ARN of the load balancer, the names of one or more target groups, or the ARNs of one or more target groups.
To describe the targets for a target group, use DescribeTargetHealth. To describe the attributes of a target group, use DescribeTargetGroupAttributes.
describeTargetGroupsRequest
- default CompletableFuture<DescribeTargetGroupsResponse> describeTargetGroups(Consumer<DescribeTargetGroupsRequest.Builder> describeTargetGroupsRequest)
Describes the specified target groups or all of your target groups. By default, all target groups are described. Alternatively, you can specify one of the following to filter the results: the ARN of the load balancer, the names of one or more target groups, or the ARNs of one or more target groups.
To describe the targets for a target group, use DescribeTargetHealth. To describe the attributes of a target group, use DescribeTargetGroupAttributes.
This is a convenience which creates an instance of the DescribeTargetGroupsRequest.Builder
avoiding the
need to create one manually via DescribeTargetGroupsRequest.builder()
describeTargetGroupsRequest
- A Consumer
that will call methods on DescribeTargetGroupsInput.Builder
to create a
request.default CompletableFuture<DescribeTargetGroupsResponse> describeTargetGroups()
Describes the specified target groups or all of your target groups. By default, all target groups are described. Alternatively, you can specify one of the following to filter the results: the ARN of the load balancer, the names of one or more target groups, or the ARNs of one or more target groups.
To describe the targets for a target group, use DescribeTargetHealth. To describe the attributes of a target group, use DescribeTargetGroupAttributes.
default DescribeTargetGroupsPublisher describeTargetGroupsPaginator()
Describes the specified target groups or all of your target groups. By default, all target groups are described. Alternatively, you can specify one of the following to filter the results: the ARN of the load balancer, the names of one or more target groups, or the ARNs of one or more target groups.
To describe the targets for a target group, use DescribeTargetHealth. To describe the attributes of a target group, use DescribeTargetGroupAttributes.
This is a variant of
describeTargetGroups(software.amazon.awssdk.services.elasticloadbalancingv2.model.DescribeTargetGroupsRequest)
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 new Subscription
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 forEach helper method
software.amazon.awssdk.services.elasticloadbalancingv2.paginators.DescribeTargetGroupsPublisher publisher = client.describeTargetGroupsPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.elasticloadbalancingv2.paginators.DescribeTargetGroupsPublisher publisher = client.describeTargetGroupsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticloadbalancingv2.model.DescribeTargetGroupsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.elasticloadbalancingv2.model.DescribeTargetGroupsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
describeTargetGroups(software.amazon.awssdk.services.elasticloadbalancingv2.model.DescribeTargetGroupsRequest)
operation.
default DescribeTargetGroupsPublisher describeTargetGroupsPaginator(DescribeTargetGroupsRequest describeTargetGroupsRequest)
Describes the specified target groups or all of your target groups. By default, all target groups are described. Alternatively, you can specify one of the following to filter the results: the ARN of the load balancer, the names of one or more target groups, or the ARNs of one or more target groups.
To describe the targets for a target group, use DescribeTargetHealth. To describe the attributes of a target group, use DescribeTargetGroupAttributes.
This is a variant of
describeTargetGroups(software.amazon.awssdk.services.elasticloadbalancingv2.model.DescribeTargetGroupsRequest)
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 new Subscription
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 forEach helper method
software.amazon.awssdk.services.elasticloadbalancingv2.paginators.DescribeTargetGroupsPublisher publisher = client.describeTargetGroupsPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.elasticloadbalancingv2.paginators.DescribeTargetGroupsPublisher publisher = client.describeTargetGroupsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticloadbalancingv2.model.DescribeTargetGroupsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.elasticloadbalancingv2.model.DescribeTargetGroupsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
describeTargetGroups(software.amazon.awssdk.services.elasticloadbalancingv2.model.DescribeTargetGroupsRequest)
operation.
describeTargetGroupsRequest
- default DescribeTargetGroupsPublisher describeTargetGroupsPaginator(Consumer<DescribeTargetGroupsRequest.Builder> describeTargetGroupsRequest)
Describes the specified target groups or all of your target groups. By default, all target groups are described. Alternatively, you can specify one of the following to filter the results: the ARN of the load balancer, the names of one or more target groups, or the ARNs of one or more target groups.
To describe the targets for a target group, use DescribeTargetHealth. To describe the attributes of a target group, use DescribeTargetGroupAttributes.
This is a variant of
describeTargetGroups(software.amazon.awssdk.services.elasticloadbalancingv2.model.DescribeTargetGroupsRequest)
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 new Subscription
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 forEach helper method
software.amazon.awssdk.services.elasticloadbalancingv2.paginators.DescribeTargetGroupsPublisher publisher = client.describeTargetGroupsPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.elasticloadbalancingv2.paginators.DescribeTargetGroupsPublisher publisher = client.describeTargetGroupsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticloadbalancingv2.model.DescribeTargetGroupsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.elasticloadbalancingv2.model.DescribeTargetGroupsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
describeTargetGroups(software.amazon.awssdk.services.elasticloadbalancingv2.model.DescribeTargetGroupsRequest)
operation.
This is a convenience which creates an instance of the DescribeTargetGroupsRequest.Builder
avoiding the
need to create one manually via DescribeTargetGroupsRequest.builder()
describeTargetGroupsRequest
- A Consumer
that will call methods on DescribeTargetGroupsInput.Builder
to create a
request.default CompletableFuture<DescribeTargetHealthResponse> describeTargetHealth(DescribeTargetHealthRequest describeTargetHealthRequest)
Describes the health of the specified targets or all of your targets.
describeTargetHealthRequest
- default CompletableFuture<DescribeTargetHealthResponse> describeTargetHealth(Consumer<DescribeTargetHealthRequest.Builder> describeTargetHealthRequest)
Describes the health of the specified targets or all of your targets.
This is a convenience which creates an instance of the DescribeTargetHealthRequest.Builder
avoiding the
need to create one manually via DescribeTargetHealthRequest.builder()
describeTargetHealthRequest
- A Consumer
that will call methods on DescribeTargetHealthInput.Builder
to create a
request.default CompletableFuture<ModifyListenerResponse> modifyListener(ModifyListenerRequest modifyListenerRequest)
Modifies the specified properties of the specified listener.
Any properties that you do not specify retain their current values. However, changing the protocol from HTTPS to HTTP removes the security policy and SSL certificate properties. If you change the protocol from HTTP to HTTPS, you must add the security policy and server certificate.
modifyListenerRequest
- default CompletableFuture<ModifyListenerResponse> modifyListener(Consumer<ModifyListenerRequest.Builder> modifyListenerRequest)
Modifies the specified properties of the specified listener.
Any properties that you do not specify retain their current values. However, changing the protocol from HTTPS to HTTP removes the security policy and SSL certificate properties. If you change the protocol from HTTP to HTTPS, you must add the security policy and server certificate.
This is a convenience which creates an instance of the ModifyListenerRequest.Builder
avoiding the need to
create one manually via ModifyListenerRequest.builder()
modifyListenerRequest
- A Consumer
that will call methods on ModifyListenerInput.Builder
to create a request.default CompletableFuture<ModifyLoadBalancerAttributesResponse> modifyLoadBalancerAttributes(ModifyLoadBalancerAttributesRequest modifyLoadBalancerAttributesRequest)
Modifies the specified attributes of the specified Application Load Balancer or Network Load Balancer.
If any of the specified attributes can't be modified as requested, the call fails. Any existing attributes that you do not modify retain their current values.
modifyLoadBalancerAttributesRequest
- default CompletableFuture<ModifyLoadBalancerAttributesResponse> modifyLoadBalancerAttributes(Consumer<ModifyLoadBalancerAttributesRequest.Builder> modifyLoadBalancerAttributesRequest)
Modifies the specified attributes of the specified Application Load Balancer or Network Load Balancer.
If any of the specified attributes can't be modified as requested, the call fails. Any existing attributes that you do not modify retain their current values.
This is a convenience which creates an instance of the ModifyLoadBalancerAttributesRequest.Builder
avoiding the need to create one manually via ModifyLoadBalancerAttributesRequest.builder()
modifyLoadBalancerAttributesRequest
- A Consumer
that will call methods on ModifyLoadBalancerAttributesInput.Builder
to create a
request.default CompletableFuture<ModifyRuleResponse> modifyRule(ModifyRuleRequest modifyRuleRequest)
Modifies the specified rule.
Any existing properties that you do not modify retain their current values.
To modify the default action, use ModifyListener.
modifyRuleRequest
- default CompletableFuture<ModifyRuleResponse> modifyRule(Consumer<ModifyRuleRequest.Builder> modifyRuleRequest)
Modifies the specified rule.
Any existing properties that you do not modify retain their current values.
To modify the default action, use ModifyListener.
This is a convenience which creates an instance of the ModifyRuleRequest.Builder
avoiding the need to
create one manually via ModifyRuleRequest.builder()
modifyRuleRequest
- A Consumer
that will call methods on ModifyRuleInput.Builder
to create a request.default CompletableFuture<ModifyTargetGroupResponse> modifyTargetGroup(ModifyTargetGroupRequest modifyTargetGroupRequest)
Modifies the health checks used when evaluating the health state of the targets in the specified target group.
To monitor the health of the targets, use DescribeTargetHealth.
modifyTargetGroupRequest
- default CompletableFuture<ModifyTargetGroupResponse> modifyTargetGroup(Consumer<ModifyTargetGroupRequest.Builder> modifyTargetGroupRequest)
Modifies the health checks used when evaluating the health state of the targets in the specified target group.
To monitor the health of the targets, use DescribeTargetHealth.
This is a convenience which creates an instance of the ModifyTargetGroupRequest.Builder
avoiding the need
to create one manually via ModifyTargetGroupRequest.builder()
modifyTargetGroupRequest
- A Consumer
that will call methods on ModifyTargetGroupInput.Builder
to create a request.default CompletableFuture<ModifyTargetGroupAttributesResponse> modifyTargetGroupAttributes(ModifyTargetGroupAttributesRequest modifyTargetGroupAttributesRequest)
Modifies the specified attributes of the specified target group.
modifyTargetGroupAttributesRequest
- default CompletableFuture<ModifyTargetGroupAttributesResponse> modifyTargetGroupAttributes(Consumer<ModifyTargetGroupAttributesRequest.Builder> modifyTargetGroupAttributesRequest)
Modifies the specified attributes of the specified target group.
This is a convenience which creates an instance of the ModifyTargetGroupAttributesRequest.Builder
avoiding the need to create one manually via ModifyTargetGroupAttributesRequest.builder()
modifyTargetGroupAttributesRequest
- A Consumer
that will call methods on ModifyTargetGroupAttributesInput.Builder
to create a
request.default CompletableFuture<RegisterTargetsResponse> registerTargets(RegisterTargetsRequest registerTargetsRequest)
Registers the specified targets with the specified target group.
You can register targets by instance ID or by IP address. If the target is an EC2 instance, it must be in the
running
state when you register it.
By default, the load balancer routes requests to registered targets using the protocol and port for the target group. Alternatively, you can override the port for a target when you register it. You can register each EC2 instance or IP address with the same target group multiple times using different ports.
With a Network Load Balancer, you cannot register instances by instance ID if they have the following instance types: C1, CC1, CC2, CG1, CG2, CR1, CS1, G1, G2, HI1, HS1, M1, M2, M3, and T1. You can register instances of these types by IP address.
To remove a target from a target group, use DeregisterTargets.
registerTargetsRequest
- default CompletableFuture<RegisterTargetsResponse> registerTargets(Consumer<RegisterTargetsRequest.Builder> registerTargetsRequest)
Registers the specified targets with the specified target group.
You can register targets by instance ID or by IP address. If the target is an EC2 instance, it must be in the
running
state when you register it.
By default, the load balancer routes requests to registered targets using the protocol and port for the target group. Alternatively, you can override the port for a target when you register it. You can register each EC2 instance or IP address with the same target group multiple times using different ports.
With a Network Load Balancer, you cannot register instances by instance ID if they have the following instance types: C1, CC1, CC2, CG1, CG2, CR1, CS1, G1, G2, HI1, HS1, M1, M2, M3, and T1. You can register instances of these types by IP address.
To remove a target from a target group, use DeregisterTargets.
This is a convenience which creates an instance of the RegisterTargetsRequest.Builder
avoiding the need
to create one manually via RegisterTargetsRequest.builder()
registerTargetsRequest
- A Consumer
that will call methods on RegisterTargetsInput.Builder
to create a request.default CompletableFuture<RemoveListenerCertificatesResponse> removeListenerCertificates(RemoveListenerCertificatesRequest removeListenerCertificatesRequest)
Removes the specified certificate from the specified secure listener.
You can't remove the default certificate for a listener. To replace the default certificate, call ModifyListener.
To list the certificates for your listener, use DescribeListenerCertificates.
removeListenerCertificatesRequest
- default CompletableFuture<RemoveListenerCertificatesResponse> removeListenerCertificates(Consumer<RemoveListenerCertificatesRequest.Builder> removeListenerCertificatesRequest)
Removes the specified certificate from the specified secure listener.
You can't remove the default certificate for a listener. To replace the default certificate, call ModifyListener.
To list the certificates for your listener, use DescribeListenerCertificates.
This is a convenience which creates an instance of the RemoveListenerCertificatesRequest.Builder
avoiding
the need to create one manually via RemoveListenerCertificatesRequest.builder()
removeListenerCertificatesRequest
- A Consumer
that will call methods on RemoveListenerCertificatesInput.Builder
to create a
request.default CompletableFuture<RemoveTagsResponse> removeTags(RemoveTagsRequest removeTagsRequest)
Removes the specified tags from the specified Elastic Load Balancing resource.
To list the current tags for your resources, use DescribeTags.
removeTagsRequest
- default CompletableFuture<RemoveTagsResponse> removeTags(Consumer<RemoveTagsRequest.Builder> removeTagsRequest)
Removes the specified tags from the specified Elastic Load Balancing resource.
To list the current tags for your resources, use DescribeTags.
This is a convenience which creates an instance of the RemoveTagsRequest.Builder
avoiding the need to
create one manually via RemoveTagsRequest.builder()
removeTagsRequest
- A Consumer
that will call methods on RemoveTagsInput.Builder
to create a request.default CompletableFuture<SetIpAddressTypeResponse> setIpAddressType(SetIpAddressTypeRequest setIpAddressTypeRequest)
Sets the type of IP addresses used by the subnets of the specified Application Load Balancer or Network Load Balancer.
Note that Network Load Balancers must use ipv4
.
setIpAddressTypeRequest
- default CompletableFuture<SetIpAddressTypeResponse> setIpAddressType(Consumer<SetIpAddressTypeRequest.Builder> setIpAddressTypeRequest)
Sets the type of IP addresses used by the subnets of the specified Application Load Balancer or Network Load Balancer.
Note that Network Load Balancers must use ipv4
.
This is a convenience which creates an instance of the SetIpAddressTypeRequest.Builder
avoiding the need
to create one manually via SetIpAddressTypeRequest.builder()
setIpAddressTypeRequest
- A Consumer
that will call methods on SetIpAddressTypeInput.Builder
to create a request.default CompletableFuture<SetRulePrioritiesResponse> setRulePriorities(SetRulePrioritiesRequest setRulePrioritiesRequest)
Sets the priorities of the specified rules.
You can reorder the rules as long as there are no priority conflicts in the new order. Any existing rules that you do not specify retain their current priority.
setRulePrioritiesRequest
- default CompletableFuture<SetRulePrioritiesResponse> setRulePriorities(Consumer<SetRulePrioritiesRequest.Builder> setRulePrioritiesRequest)
Sets the priorities of the specified rules.
You can reorder the rules as long as there are no priority conflicts in the new order. Any existing rules that you do not specify retain their current priority.
This is a convenience which creates an instance of the SetRulePrioritiesRequest.Builder
avoiding the need
to create one manually via SetRulePrioritiesRequest.builder()
setRulePrioritiesRequest
- A Consumer
that will call methods on SetRulePrioritiesInput.Builder
to create a request.default CompletableFuture<SetSecurityGroupsResponse> setSecurityGroups(SetSecurityGroupsRequest setSecurityGroupsRequest)
Associates the specified security groups with the specified Application Load Balancer. The specified security groups override the previously associated security groups.
Note that you can't specify a security group for a Network Load Balancer.
setSecurityGroupsRequest
- default CompletableFuture<SetSecurityGroupsResponse> setSecurityGroups(Consumer<SetSecurityGroupsRequest.Builder> setSecurityGroupsRequest)
Associates the specified security groups with the specified Application Load Balancer. The specified security groups override the previously associated security groups.
Note that you can't specify a security group for a Network Load Balancer.
This is a convenience which creates an instance of the SetSecurityGroupsRequest.Builder
avoiding the need
to create one manually via SetSecurityGroupsRequest.builder()
setSecurityGroupsRequest
- A Consumer
that will call methods on SetSecurityGroupsInput.Builder
to create a request.default CompletableFuture<SetSubnetsResponse> setSubnets(SetSubnetsRequest setSubnetsRequest)
Enables the Availability Zone for the specified subnets for the specified Application Load Balancer. The specified subnets replace the previously enabled subnets.
Note that you can't change the subnets for a Network Load Balancer.
setSubnetsRequest
- default CompletableFuture<SetSubnetsResponse> setSubnets(Consumer<SetSubnetsRequest.Builder> setSubnetsRequest)
Enables the Availability Zone for the specified subnets for the specified Application Load Balancer. The specified subnets replace the previously enabled subnets.
Note that you can't change the subnets for a Network Load Balancer.
This is a convenience which creates an instance of the SetSubnetsRequest.Builder
avoiding the need to
create one manually via SetSubnetsRequest.builder()
setSubnetsRequest
- A Consumer
that will call methods on SetSubnetsInput.Builder
to create a request.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.