AutoCloseable@Generated("software.amazon.awssdk:codegen") public interface ElasticLoadBalancingv2Client extends AutoCloseable
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 two types of load balancers: Classic Load Balancers and Application Load Balancers. A Classic Load Balancer makes routing and load balancing decisions either at the transport layer (TCP/SSL) or the application layer (HTTP/HTTPS), and supports either EC2-Classic or a VPC. An Application Load Balancer makes routing and load balancing decisions at the application layer (HTTP/HTTPS), supports path-based routing, and can route requests to one or more ports on each EC2 instance or container instance in your virtual private cloud (VPC). For more information, see the Elastic Load Balancing User Guide.
This reference covers the 2015-12-01 API, which supports Application Load Balancers. The 2012-06-01 API supports Classic Load Balancers.
To get started, complete the following tasks:
Create an Application 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.
(Optional) Create one or more rules for content routing based on URL using CreateRule.
To delete an Application 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 | Description |
|---|---|---|
static String |
SERVICE_NAME |
| Modifier and Type | Method | Description |
|---|---|---|
default AddTagsResponse |
addTags(AddTagsRequest addTagsRequest) |
Adds the specified tags to the specified resource.
|
static ElasticLoadBalancingv2ClientBuilder |
builder() |
Create a builder that can be used to configure and create a
ElasticLoadBalancingv2Client. |
static ElasticLoadBalancingv2Client |
create() |
Create a
ElasticLoadBalancingv2Client with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CreateListenerResponse |
createListener(CreateListenerRequest createListenerRequest) |
Creates a listener for the specified Application Load Balancer.
|
default CreateLoadBalancerResponse |
createLoadBalancer(CreateLoadBalancerRequest createLoadBalancerRequest) |
Creates an Application Load Balancer.
|
default CreateRuleResponse |
createRule(CreateRuleRequest createRuleRequest) |
Creates a rule for the specified listener.
|
default CreateTargetGroupResponse |
createTargetGroup(CreateTargetGroupRequest createTargetGroupRequest) |
Creates a target group.
|
default DeleteListenerResponse |
deleteListener(DeleteListenerRequest deleteListenerRequest) |
Deletes the specified listener.
|
default DeleteLoadBalancerResponse |
deleteLoadBalancer(DeleteLoadBalancerRequest deleteLoadBalancerRequest) |
Deletes the specified Application Load Balancer and its attached listeners.
|
default DeleteRuleResponse |
deleteRule(DeleteRuleRequest deleteRuleRequest) |
Deletes the specified rule.
|
default DeleteTargetGroupResponse |
deleteTargetGroup(DeleteTargetGroupRequest deleteTargetGroupRequest) |
Deletes the specified target group.
|
default DeregisterTargetsResponse |
deregisterTargets(DeregisterTargetsRequest deregisterTargetsRequest) |
Deregisters the specified targets from the specified target group.
|
default DescribeAccountLimitsResponse |
describeAccountLimits(DescribeAccountLimitsRequest describeAccountLimitsRequest) |
Describes the current Elastic Load Balancing resource limits for your AWS account.
|
default DescribeListenersResponse |
describeListeners(DescribeListenersRequest describeListenersRequest) |
Describes the specified listeners or the listeners for the specified Application Load Balancer.
|
default DescribeLoadBalancerAttributesResponse |
describeLoadBalancerAttributes(DescribeLoadBalancerAttributesRequest describeLoadBalancerAttributesRequest) |
Describes the attributes for the specified Application Load Balancer.
|
default DescribeLoadBalancersResponse |
describeLoadBalancers(DescribeLoadBalancersRequest describeLoadBalancersRequest) |
Describes the specified Application Load Balancers or all of your Application Load Balancers.
|
default DescribeRulesResponse |
describeRules(DescribeRulesRequest describeRulesRequest) |
Describes the specified rules or the rules for the specified listener.
|
default DescribeSSLPoliciesResponse |
describeSSLPolicies(DescribeSSLPoliciesRequest describeSSLPoliciesRequest) |
Describes the specified policies or all policies used for SSL negotiation.
|
default DescribeTagsResponse |
describeTags(DescribeTagsRequest describeTagsRequest) |
Describes the tags for the specified resources.
|
default DescribeTargetGroupAttributesResponse |
describeTargetGroupAttributes(DescribeTargetGroupAttributesRequest describeTargetGroupAttributesRequest) |
Describes the attributes for the specified target group.
|
default DescribeTargetGroupsResponse |
describeTargetGroups(DescribeTargetGroupsRequest describeTargetGroupsRequest) |
Describes the specified target groups or all of your target groups.
|
default DescribeTargetHealthResponse |
describeTargetHealth(DescribeTargetHealthRequest describeTargetHealthRequest) |
Describes the health of the specified targets or all of your targets.
|
default ModifyListenerResponse |
modifyListener(ModifyListenerRequest modifyListenerRequest) |
Modifies the specified properties of the specified listener.
|
default ModifyLoadBalancerAttributesResponse |
modifyLoadBalancerAttributes(ModifyLoadBalancerAttributesRequest modifyLoadBalancerAttributesRequest) |
Modifies the specified attributes of the specified Application Load Balancer.
|
default ModifyRuleResponse |
modifyRule(ModifyRuleRequest modifyRuleRequest) |
Modifies the specified rule.
|
default ModifyTargetGroupResponse |
modifyTargetGroup(ModifyTargetGroupRequest modifyTargetGroupRequest) |
Modifies the health checks used when evaluating the health state of the targets in the specified target group.
|
default ModifyTargetGroupAttributesResponse |
modifyTargetGroupAttributes(ModifyTargetGroupAttributesRequest modifyTargetGroupAttributesRequest) |
Modifies the specified attributes of the specified target group.
|
default RegisterTargetsResponse |
registerTargets(RegisterTargetsRequest registerTargetsRequest) |
Registers the specified targets with the specified target group.
|
default RemoveTagsResponse |
removeTags(RemoveTagsRequest removeTagsRequest) |
Removes the specified tags from the specified resource.
|
static ServiceMetadata |
serviceMetadata() |
|
default SetIpAddressTypeResponse |
setIpAddressType(SetIpAddressTypeRequest setIpAddressTypeRequest) |
Sets the type of IP addresses used by the subnets of the specified Application Load Balancer.
|
default SetRulePrioritiesResponse |
setRulePriorities(SetRulePrioritiesRequest setRulePrioritiesRequest) |
Sets the priorities of the specified rules.
|
default SetSecurityGroupsResponse |
setSecurityGroups(SetSecurityGroupsRequest setSecurityGroupsRequest) |
Associates the specified security groups with the specified load balancer.
|
default SetSubnetsResponse |
setSubnets(SetSubnetsRequest setSubnetsRequest) |
Enables the Availability Zone for the specified subnets for the specified load balancer.
|
ElasticLoadBalancingv2ClientWaiters |
waiters() |
closestatic final String SERVICE_NAME
static ElasticLoadBalancingv2Client create()
ElasticLoadBalancingv2Client with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static ElasticLoadBalancingv2ClientBuilder builder()
ElasticLoadBalancingv2Client.default AddTagsResponse addTags(AddTagsRequest addTagsRequest) throws DuplicateTagKeysException, TooManyTagsException, LoadBalancerNotFoundException, TargetGroupNotFoundException, SdkBaseException, SdkClientException, ElasticLoadBalancingv2Exception
Adds the specified tags to the specified resource. You can tag your Application 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 - DuplicateTagKeysException - A tag key was specified more than once.TooManyTagsException - You've reached the limit on the number of tags per load balancer.LoadBalancerNotFoundException - The specified load balancer does not exist.TargetGroupNotFoundException - The specified target group does not exist.SdkBaseException - 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)ElasticLoadBalancingv2Exception - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CreateListenerResponse createListener(CreateListenerRequest createListenerRequest) throws DuplicateListenerException, TooManyListenersException, TooManyCertificatesException, LoadBalancerNotFoundException, TargetGroupNotFoundException, TargetGroupAssociationLimitException, InvalidConfigurationRequestException, IncompatibleProtocolsException, SSLPolicyNotFoundException, CertificateNotFoundException, UnsupportedProtocolException, TooManyRegistrationsForTargetIdException, SdkBaseException, SdkClientException, ElasticLoadBalancingv2Exception
Creates a listener for the specified Application Load Balancer.
You can create up to 10 listeners per 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.
For more information, see Listeners for Your Application Load Balancers in the Application Load Balancers Guide.
createListenerRequest - DuplicateListenerException - A listener with the specified port already exists.TooManyListenersException - You've reached the limit on the number of listeners per load balancer.TooManyCertificatesException - You've reached the limit on the number of certificates per listener.LoadBalancerNotFoundException - The specified load balancer does not exist.TargetGroupNotFoundException - The specified target group does not exist.TargetGroupAssociationLimitException - You've reached the limit on the number of load balancers per target group.InvalidConfigurationRequestException - The requested configuration is not valid.IncompatibleProtocolsException - The specified configuration is not valid with this protocol.SSLPolicyNotFoundException - The specified SSL policy does not exist.CertificateNotFoundException - The specified certificate does not exist.UnsupportedProtocolException - The specified protocol is not supported.TooManyRegistrationsForTargetIdException - You've reached the limit on the number of times a target can be registered with a load balancer.SdkBaseException - 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)ElasticLoadBalancingv2Exception - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CreateLoadBalancerResponse createLoadBalancer(CreateLoadBalancerRequest createLoadBalancerRequest) throws DuplicateLoadBalancerNameException, TooManyLoadBalancersException, InvalidConfigurationRequestException, SubnetNotFoundException, InvalidSubnetException, InvalidSecurityGroupException, InvalidSchemeException, TooManyTagsException, DuplicateTagKeysException, SdkBaseException, SdkClientException, ElasticLoadBalancingv2Exception
Creates an Application 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.
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 Application Load Balancer in the Application Load Balancers Guide.
For more information, see Application Load Balancers in the Application Load Balancers Guide.
createLoadBalancerRequest - DuplicateLoadBalancerNameException - A load balancer with the specified name already exists.TooManyLoadBalancersException - You've reached the limit on the number of load balancers for your AWS account.InvalidConfigurationRequestException - The requested configuration is not valid.SubnetNotFoundException - The specified subnet does not exist.InvalidSubnetException - The specified subnet is out of available addresses.InvalidSecurityGroupException - The specified security group does not exist.InvalidSchemeException - The requested scheme is not valid.TooManyTagsException - You've reached the limit on the number of tags per load balancer.DuplicateTagKeysException - A tag key was specified more than once.SdkBaseException - 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)ElasticLoadBalancingv2Exception - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CreateRuleResponse createRule(CreateRuleRequest createRuleRequest) throws PriorityInUseException, TooManyTargetGroupsException, TooManyRulesException, TargetGroupAssociationLimitException, ListenerNotFoundException, TargetGroupNotFoundException, InvalidConfigurationRequestException, TooManyRegistrationsForTargetIdException, SdkBaseException, SdkClientException, ElasticLoadBalancingv2Exception
Creates a rule for the specified listener.
Each rule can have one action and one condition. 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 default 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 - PriorityInUseException - The specified priority is in use.TooManyTargetGroupsException - You've reached the limit on the number of target groups for your AWS account.TooManyRulesException - You've reached the limit on the number of rules per load balancer.TargetGroupAssociationLimitException - You've reached the limit on the number of load balancers per target group.ListenerNotFoundException - The specified listener does not exist.TargetGroupNotFoundException - The specified target group does not exist.InvalidConfigurationRequestException - The requested configuration is not valid.TooManyRegistrationsForTargetIdException - You've reached the limit on the number of times a target can be registered with a load balancer.SdkBaseException - 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)ElasticLoadBalancingv2Exception - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CreateTargetGroupResponse createTargetGroup(CreateTargetGroupRequest createTargetGroupRequest) throws DuplicateTargetGroupNameException, TooManyTargetGroupsException, SdkBaseException, SdkClientException, ElasticLoadBalancingv2Exception
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.
For more information, see Target Groups for Your Application Load Balancers in the Application Load Balancers Guide.
createTargetGroupRequest - DuplicateTargetGroupNameException - A target group with the specified name already exists.TooManyTargetGroupsException - You've reached the limit on the number of target groups for your AWS account.SdkBaseException - 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)ElasticLoadBalancingv2Exception - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeleteListenerResponse deleteListener(DeleteListenerRequest deleteListenerRequest) throws ListenerNotFoundException, SdkBaseException, SdkClientException, ElasticLoadBalancingv2Exception
Deletes the specified listener.
Alternatively, your listener is deleted when you delete the load balancer it is attached to using DeleteLoadBalancer.
deleteListenerRequest - ListenerNotFoundException - The specified listener does not exist.SdkBaseException - 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)ElasticLoadBalancingv2Exception - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeleteLoadBalancerResponse deleteLoadBalancer(DeleteLoadBalancerRequest deleteLoadBalancerRequest) throws LoadBalancerNotFoundException, OperationNotPermittedException, SdkBaseException, SdkClientException, ElasticLoadBalancingv2Exception
Deletes the specified Application 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 - LoadBalancerNotFoundException - The specified load balancer does not exist.OperationNotPermittedException - This operation is not allowed.SdkBaseException - 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)ElasticLoadBalancingv2Exception - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeleteRuleResponse deleteRule(DeleteRuleRequest deleteRuleRequest) throws RuleNotFoundException, OperationNotPermittedException, SdkBaseException, SdkClientException, ElasticLoadBalancingv2Exception
Deletes the specified rule.
deleteRuleRequest - RuleNotFoundException - The specified rule does not exist.OperationNotPermittedException - This operation is not allowed.SdkBaseException - 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)ElasticLoadBalancingv2Exception - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeleteTargetGroupResponse deleteTargetGroup(DeleteTargetGroupRequest deleteTargetGroupRequest) throws ResourceInUseException, SdkBaseException, SdkClientException, ElasticLoadBalancingv2Exception
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 - ResourceInUseException - A specified resource is in use.SdkBaseException - 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)ElasticLoadBalancingv2Exception - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeregisterTargetsResponse deregisterTargets(DeregisterTargetsRequest deregisterTargetsRequest) throws TargetGroupNotFoundException, InvalidTargetException, SdkBaseException, SdkClientException, ElasticLoadBalancingv2Exception
Deregisters the specified targets from the specified target group. After the targets are deregistered, they no longer receive traffic from the load balancer.
deregisterTargetsRequest - TargetGroupNotFoundException - The specified target group does not exist.InvalidTargetException - The specified target does not exist or is not in the same VPC as the target group.SdkBaseException - 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)ElasticLoadBalancingv2Exception - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeAccountLimitsResponse describeAccountLimits(DescribeAccountLimitsRequest describeAccountLimitsRequest) throws SdkBaseException, SdkClientException, ElasticLoadBalancingv2Exception
Describes the current Elastic Load Balancing resource limits for your AWS account.
For more information, see Limits for Your Application Load Balancer in the Application Load Balancer Guide.
describeAccountLimitsRequest - SdkBaseExceptionSdkClientExceptionElasticLoadBalancingv2Exceptiondefault DescribeListenersResponse describeListeners(DescribeListenersRequest describeListenersRequest) throws ListenerNotFoundException, LoadBalancerNotFoundException, SdkBaseException, SdkClientException, ElasticLoadBalancingv2Exception
Describes the specified listeners or the listeners for the specified Application Load Balancer. You must specify either a load balancer or one or more listeners.
describeListenersRequest - ListenerNotFoundException - The specified listener does not exist.LoadBalancerNotFoundException - The specified load balancer does not exist.SdkBaseException - 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)ElasticLoadBalancingv2Exception - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeLoadBalancerAttributesResponse describeLoadBalancerAttributes(DescribeLoadBalancerAttributesRequest describeLoadBalancerAttributesRequest) throws LoadBalancerNotFoundException, SdkBaseException, SdkClientException, ElasticLoadBalancingv2Exception
Describes the attributes for the specified Application Load Balancer.
describeLoadBalancerAttributesRequest - LoadBalancerNotFoundException - The specified load balancer does not exist.SdkBaseException - 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)ElasticLoadBalancingv2Exception - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeLoadBalancersResponse describeLoadBalancers(DescribeLoadBalancersRequest describeLoadBalancersRequest) throws LoadBalancerNotFoundException, SdkBaseException, SdkClientException, ElasticLoadBalancingv2Exception
Describes the specified Application Load Balancers or all of your Application Load Balancers.
To describe the listeners for a load balancer, use DescribeListeners. To describe the attributes for a load balancer, use DescribeLoadBalancerAttributes.
describeLoadBalancersRequest - LoadBalancerNotFoundException - The specified load balancer does not exist.SdkBaseException - 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)ElasticLoadBalancingv2Exception - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeRulesResponse describeRules(DescribeRulesRequest describeRulesRequest) throws ListenerNotFoundException, RuleNotFoundException, SdkBaseException, SdkClientException, ElasticLoadBalancingv2Exception
Describes the specified rules or the rules for the specified listener. You must specify either a listener or one or more rules.
describeRulesRequest - ListenerNotFoundException - The specified listener does not exist.RuleNotFoundException - The specified rule does not exist.SdkBaseException - 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)ElasticLoadBalancingv2Exception - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeSSLPoliciesResponse describeSSLPolicies(DescribeSSLPoliciesRequest describeSSLPoliciesRequest) throws SSLPolicyNotFoundException, SdkBaseException, SdkClientException, ElasticLoadBalancingv2Exception
Describes the specified policies or all policies used for SSL negotiation.
For more information, see Security Policies in the Application Load Balancers Guide.
describeSSLPoliciesRequest - SSLPolicyNotFoundException - The specified SSL policy does not exist.SdkBaseException - 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)ElasticLoadBalancingv2Exception - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeTagsResponse describeTags(DescribeTagsRequest describeTagsRequest) throws LoadBalancerNotFoundException, TargetGroupNotFoundException, ListenerNotFoundException, RuleNotFoundException, SdkBaseException, SdkClientException, ElasticLoadBalancingv2Exception
Describes the tags for the specified resources. You can describe the tags for one or more Application Load Balancers and target groups.
describeTagsRequest - LoadBalancerNotFoundException - The specified load balancer does not exist.TargetGroupNotFoundException - The specified target group does not exist.ListenerNotFoundException - The specified listener does not exist.RuleNotFoundException - The specified rule does not exist.SdkBaseException - 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)ElasticLoadBalancingv2Exception - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeTargetGroupAttributesResponse describeTargetGroupAttributes(DescribeTargetGroupAttributesRequest describeTargetGroupAttributesRequest) throws TargetGroupNotFoundException, SdkBaseException, SdkClientException, ElasticLoadBalancingv2Exception
Describes the attributes for the specified target group.
describeTargetGroupAttributesRequest - TargetGroupNotFoundException - The specified target group does not exist.SdkBaseException - 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)ElasticLoadBalancingv2Exception - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeTargetGroupsResponse describeTargetGroups(DescribeTargetGroupsRequest describeTargetGroupsRequest) throws LoadBalancerNotFoundException, TargetGroupNotFoundException, SdkBaseException, SdkClientException, ElasticLoadBalancingv2Exception
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 - LoadBalancerNotFoundException - The specified load balancer does not exist.TargetGroupNotFoundException - The specified target group does not exist.SdkBaseException - 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)ElasticLoadBalancingv2Exception - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeTargetHealthResponse describeTargetHealth(DescribeTargetHealthRequest describeTargetHealthRequest) throws InvalidTargetException, TargetGroupNotFoundException, HealthUnavailableException, SdkBaseException, SdkClientException, ElasticLoadBalancingv2Exception
Describes the health of the specified targets or all of your targets.
describeTargetHealthRequest - InvalidTargetException - The specified target does not exist or is not in the same VPC as the target group.TargetGroupNotFoundException - The specified target group does not exist.HealthUnavailableException - The health of the specified targets could not be retrieved due to an internal error.SdkBaseException - 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)ElasticLoadBalancingv2Exception - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ModifyListenerResponse modifyListener(ModifyListenerRequest modifyListenerRequest) throws DuplicateListenerException, TooManyListenersException, TooManyCertificatesException, ListenerNotFoundException, TargetGroupNotFoundException, TargetGroupAssociationLimitException, IncompatibleProtocolsException, SSLPolicyNotFoundException, CertificateNotFoundException, InvalidConfigurationRequestException, UnsupportedProtocolException, TooManyRegistrationsForTargetIdException, SdkBaseException, SdkClientException, ElasticLoadBalancingv2Exception
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 - DuplicateListenerException - A listener with the specified port already exists.TooManyListenersException - You've reached the limit on the number of listeners per load balancer.TooManyCertificatesException - You've reached the limit on the number of certificates per listener.ListenerNotFoundException - The specified listener does not exist.TargetGroupNotFoundException - The specified target group does not exist.TargetGroupAssociationLimitException - You've reached the limit on the number of load balancers per target group.IncompatibleProtocolsException - The specified configuration is not valid with this protocol.SSLPolicyNotFoundException - The specified SSL policy does not exist.CertificateNotFoundException - The specified certificate does not exist.InvalidConfigurationRequestException - The requested configuration is not valid.UnsupportedProtocolException - The specified protocol is not supported.TooManyRegistrationsForTargetIdException - You've reached the limit on the number of times a target can be registered with a load balancer.SdkBaseException - 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)ElasticLoadBalancingv2Exception - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ModifyLoadBalancerAttributesResponse modifyLoadBalancerAttributes(ModifyLoadBalancerAttributesRequest modifyLoadBalancerAttributesRequest) throws LoadBalancerNotFoundException, InvalidConfigurationRequestException, SdkBaseException, SdkClientException, ElasticLoadBalancingv2Exception
Modifies the specified attributes of the specified Application 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 - LoadBalancerNotFoundException - The specified load balancer does not exist.InvalidConfigurationRequestException - The requested configuration is not valid.SdkBaseException - 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)ElasticLoadBalancingv2Exception - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ModifyRuleResponse modifyRule(ModifyRuleRequest modifyRuleRequest) throws TargetGroupAssociationLimitException, RuleNotFoundException, OperationNotPermittedException, TooManyRegistrationsForTargetIdException, TooManyTargetsException, TargetGroupNotFoundException, SdkBaseException, SdkClientException, ElasticLoadBalancingv2Exception
Modifies the specified rule.
Any existing properties that you do not modify retain their current values.
To modify the default action, use ModifyListener.
modifyRuleRequest - TargetGroupAssociationLimitException - You've reached the limit on the number of load balancers per target group.RuleNotFoundException - The specified rule does not exist.OperationNotPermittedException - This operation is not allowed.TooManyRegistrationsForTargetIdException - You've reached the limit on the number of times a target can be registered with a load balancer.TooManyTargetsException - You've reached the limit on the number of targets.TargetGroupNotFoundException - The specified target group does not exist.SdkBaseException - 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)ElasticLoadBalancingv2Exception - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ModifyTargetGroupResponse modifyTargetGroup(ModifyTargetGroupRequest modifyTargetGroupRequest) throws TargetGroupNotFoundException, SdkBaseException, SdkClientException, ElasticLoadBalancingv2Exception
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 - TargetGroupNotFoundException - The specified target group does not exist.SdkBaseException - 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)ElasticLoadBalancingv2Exception - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ModifyTargetGroupAttributesResponse modifyTargetGroupAttributes(ModifyTargetGroupAttributesRequest modifyTargetGroupAttributesRequest) throws TargetGroupNotFoundException, SdkBaseException, SdkClientException, ElasticLoadBalancingv2Exception
Modifies the specified attributes of the specified target group.
modifyTargetGroupAttributesRequest - TargetGroupNotFoundException - The specified target group does not exist.SdkBaseException - 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)ElasticLoadBalancingv2Exception - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault RegisterTargetsResponse registerTargets(RegisterTargetsRequest registerTargetsRequest) throws TargetGroupNotFoundException, TooManyTargetsException, InvalidTargetException, TooManyRegistrationsForTargetIdException, SdkBaseException, SdkClientException, ElasticLoadBalancingv2Exception
Registers the specified targets with the specified target group.
By default, the load balancer routes requests to registered targets using the protocol and port number for the target group. Alternatively, you can override the port for a target when you register it.
The target must be in the virtual private cloud (VPC) that you specified for the target group. If the target is
an EC2 instance, it must be in the running state when you register it.
To remove a target from a target group, use DeregisterTargets.
registerTargetsRequest - TargetGroupNotFoundException - The specified target group does not exist.TooManyTargetsException - You've reached the limit on the number of targets.InvalidTargetException - The specified target does not exist or is not in the same VPC as the target group.TooManyRegistrationsForTargetIdException - You've reached the limit on the number of times a target can be registered with a load balancer.SdkBaseException - 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)ElasticLoadBalancingv2Exception - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault RemoveTagsResponse removeTags(RemoveTagsRequest removeTagsRequest) throws LoadBalancerNotFoundException, TargetGroupNotFoundException, ListenerNotFoundException, RuleNotFoundException, TooManyTagsException, SdkBaseException, SdkClientException, ElasticLoadBalancingv2Exception
Removes the specified tags from the specified resource.
To list the current tags for your resources, use DescribeTags.
removeTagsRequest - LoadBalancerNotFoundException - The specified load balancer does not exist.TargetGroupNotFoundException - The specified target group does not exist.ListenerNotFoundException - The specified listener does not exist.RuleNotFoundException - The specified rule does not exist.TooManyTagsException - You've reached the limit on the number of tags per load balancer.SdkBaseException - 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)ElasticLoadBalancingv2Exception - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault SetIpAddressTypeResponse setIpAddressType(SetIpAddressTypeRequest setIpAddressTypeRequest) throws LoadBalancerNotFoundException, InvalidConfigurationRequestException, InvalidSubnetException, SdkBaseException, SdkClientException, ElasticLoadBalancingv2Exception
Sets the type of IP addresses used by the subnets of the specified Application Load Balancer.
setIpAddressTypeRequest - LoadBalancerNotFoundException - The specified load balancer does not exist.InvalidConfigurationRequestException - The requested configuration is not valid.InvalidSubnetException - The specified subnet is out of available addresses.SdkBaseException - 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)ElasticLoadBalancingv2Exception - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault SetRulePrioritiesResponse setRulePriorities(SetRulePrioritiesRequest setRulePrioritiesRequest) throws RuleNotFoundException, PriorityInUseException, OperationNotPermittedException, SdkBaseException, SdkClientException, ElasticLoadBalancingv2Exception
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 - RuleNotFoundException - The specified rule does not exist.PriorityInUseException - The specified priority is in use.OperationNotPermittedException - This operation is not allowed.SdkBaseException - 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)ElasticLoadBalancingv2Exception - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault SetSecurityGroupsResponse setSecurityGroups(SetSecurityGroupsRequest setSecurityGroupsRequest) throws LoadBalancerNotFoundException, InvalidConfigurationRequestException, InvalidSecurityGroupException, SdkBaseException, SdkClientException, ElasticLoadBalancingv2Exception
Associates the specified security groups with the specified load balancer. The specified security groups override the previously associated security groups.
setSecurityGroupsRequest - LoadBalancerNotFoundException - The specified load balancer does not exist.InvalidConfigurationRequestException - The requested configuration is not valid.InvalidSecurityGroupException - The specified security group does not exist.SdkBaseException - 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)ElasticLoadBalancingv2Exception - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault SetSubnetsResponse setSubnets(SetSubnetsRequest setSubnetsRequest) throws LoadBalancerNotFoundException, InvalidConfigurationRequestException, SubnetNotFoundException, InvalidSubnetException, SdkBaseException, SdkClientException, ElasticLoadBalancingv2Exception
Enables the Availability Zone for the specified subnets for the specified load balancer. The specified subnets replace the previously enabled subnets.
setSubnetsRequest - LoadBalancerNotFoundException - The specified load balancer does not exist.InvalidConfigurationRequestException - The requested configuration is not valid.SubnetNotFoundException - The specified subnet does not exist.InvalidSubnetException - The specified subnet is out of available addresses.SdkBaseException - 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)ElasticLoadBalancingv2Exception - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typestatic ServiceMetadata serviceMetadata()
ElasticLoadBalancingv2ClientWaiters waiters()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.