@Generated(value="software.amazon.awssdk:codegen") public interface ElasticLoadBalancingv2Client extends SdkClient, SdkAutoCloseable
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 AddListenerCertificatesResponse |
addListenerCertificates(AddListenerCertificatesRequest addListenerCertificatesRequest)
Adds the specified certificate to the specified secure listener.
|
default AddListenerCertificatesResponse |
addListenerCertificates(Consumer<AddListenerCertificatesRequest.Builder> addListenerCertificatesRequest)
Adds the specified certificate to the specified secure listener.
|
default AddTagsResponse |
addTags(AddTagsRequest addTagsRequest)
Adds the specified tags to the specified Elastic Load Balancing resource.
|
default AddTagsResponse |
addTags(Consumer<AddTagsRequest.Builder> addTagsRequest)
Adds the specified tags to the specified Elastic Load Balancing 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(Consumer<CreateListenerRequest.Builder> createListenerRequest)
Creates a listener for the specified Application Load Balancer or Network Load Balancer.
|
default CreateListenerResponse |
createListener(CreateListenerRequest createListenerRequest)
Creates a listener for the specified Application Load Balancer or Network Load Balancer.
|
default CreateLoadBalancerResponse |
createLoadBalancer(Consumer<CreateLoadBalancerRequest.Builder> createLoadBalancerRequest)
Creates an Application Load Balancer or a Network Load Balancer.
|
default CreateLoadBalancerResponse |
createLoadBalancer(CreateLoadBalancerRequest createLoadBalancerRequest)
Creates an Application Load Balancer or a Network Load Balancer.
|
default CreateRuleResponse |
createRule(Consumer<CreateRuleRequest.Builder> createRuleRequest)
Creates a rule for the specified listener.
|
default CreateRuleResponse |
createRule(CreateRuleRequest createRuleRequest)
Creates a rule for the specified listener.
|
default CreateTargetGroupResponse |
createTargetGroup(Consumer<CreateTargetGroupRequest.Builder> createTargetGroupRequest)
Creates a target group.
|
default CreateTargetGroupResponse |
createTargetGroup(CreateTargetGroupRequest createTargetGroupRequest)
Creates a target group.
|
default DeleteListenerResponse |
deleteListener(Consumer<DeleteListenerRequest.Builder> deleteListenerRequest)
Deletes the specified listener.
|
default DeleteListenerResponse |
deleteListener(DeleteListenerRequest deleteListenerRequest)
Deletes the specified listener.
|
default DeleteLoadBalancerResponse |
deleteLoadBalancer(Consumer<DeleteLoadBalancerRequest.Builder> deleteLoadBalancerRequest)
Deletes the specified Application Load Balancer or Network Load Balancer and its attached listeners.
|
default DeleteLoadBalancerResponse |
deleteLoadBalancer(DeleteLoadBalancerRequest deleteLoadBalancerRequest)
Deletes the specified Application Load Balancer or Network Load Balancer and its attached listeners.
|
default DeleteRuleResponse |
deleteRule(Consumer<DeleteRuleRequest.Builder> deleteRuleRequest)
Deletes the specified rule.
|
default DeleteRuleResponse |
deleteRule(DeleteRuleRequest deleteRuleRequest)
Deletes the specified rule.
|
default DeleteTargetGroupResponse |
deleteTargetGroup(Consumer<DeleteTargetGroupRequest.Builder> deleteTargetGroupRequest)
Deletes the specified target group.
|
default DeleteTargetGroupResponse |
deleteTargetGroup(DeleteTargetGroupRequest deleteTargetGroupRequest)
Deletes the specified target group.
|
default DeregisterTargetsResponse |
deregisterTargets(Consumer<DeregisterTargetsRequest.Builder> deregisterTargetsRequest)
Deregisters the specified targets from the specified target group.
|
default DeregisterTargetsResponse |
deregisterTargets(DeregisterTargetsRequest deregisterTargetsRequest)
Deregisters the specified targets from the specified target group.
|
default DescribeAccountLimitsResponse |
describeAccountLimits()
Describes the current Elastic Load Balancing resource limits for your AWS account.
|
default DescribeAccountLimitsResponse |
describeAccountLimits(Consumer<DescribeAccountLimitsRequest.Builder> describeAccountLimitsRequest)
Describes the current Elastic Load Balancing resource limits for your AWS account.
|
default DescribeAccountLimitsResponse |
describeAccountLimits(DescribeAccountLimitsRequest describeAccountLimitsRequest)
Describes the current Elastic Load Balancing resource limits for your AWS account.
|
default DescribeListenerCertificatesResponse |
describeListenerCertificates(Consumer<DescribeListenerCertificatesRequest.Builder> describeListenerCertificatesRequest)
Describes the certificates for the specified secure listener.
|
default DescribeListenerCertificatesResponse |
describeListenerCertificates(DescribeListenerCertificatesRequest describeListenerCertificatesRequest)
Describes the certificates for the specified secure listener.
|
default DescribeListenersResponse |
describeListeners(Consumer<DescribeListenersRequest.Builder> describeListenersRequest)
Describes the specified listeners or the listeners for the specified Application Load Balancer or Network Load
Balancer.
|
default DescribeListenersResponse |
describeListeners(DescribeListenersRequest describeListenersRequest)
Describes the specified listeners or the listeners for the specified Application Load Balancer or Network Load
Balancer.
|
default DescribeListenersIterable |
describeListenersPaginator(DescribeListenersRequest describeListenersRequest)
Describes the specified listeners or the listeners for the specified Application Load Balancer or Network Load
Balancer.
|
default DescribeLoadBalancerAttributesResponse |
describeLoadBalancerAttributes(Consumer<DescribeLoadBalancerAttributesRequest.Builder> describeLoadBalancerAttributesRequest)
Describes the attributes for the specified Application Load Balancer or Network Load Balancer.
|
default DescribeLoadBalancerAttributesResponse |
describeLoadBalancerAttributes(DescribeLoadBalancerAttributesRequest describeLoadBalancerAttributesRequest)
Describes the attributes for the specified Application Load Balancer or Network Load Balancer.
|
default DescribeLoadBalancersResponse |
describeLoadBalancers()
Describes the specified load balancers or all of your load balancers.
|
default DescribeLoadBalancersResponse |
describeLoadBalancers(Consumer<DescribeLoadBalancersRequest.Builder> describeLoadBalancersRequest)
Describes the specified load balancers or all of your load balancers.
|
default DescribeLoadBalancersResponse |
describeLoadBalancers(DescribeLoadBalancersRequest describeLoadBalancersRequest)
Describes the specified load balancers or all of your load balancers.
|
default DescribeLoadBalancersIterable |
describeLoadBalancersPaginator()
Describes the specified load balancers or all of your load balancers.
|
default DescribeLoadBalancersIterable |
describeLoadBalancersPaginator(DescribeLoadBalancersRequest describeLoadBalancersRequest)
Describes the specified load balancers or all of your load balancers.
|
default DescribeRulesResponse |
describeRules(Consumer<DescribeRulesRequest.Builder> describeRulesRequest)
Describes the specified rules or the rules for the specified listener.
|
default DescribeRulesResponse |
describeRules(DescribeRulesRequest describeRulesRequest)
Describes the specified rules or the rules for the specified listener.
|
default DescribeSSLPoliciesResponse |
describeSSLPolicies()
Describes the specified policies or all policies used for SSL negotiation.
|
default DescribeSSLPoliciesResponse |
describeSSLPolicies(Consumer<DescribeSSLPoliciesRequest.Builder> describeSSLPoliciesRequest)
Describes the specified policies or all policies used for SSL negotiation.
|
default DescribeSSLPoliciesResponse |
describeSSLPolicies(DescribeSSLPoliciesRequest describeSSLPoliciesRequest)
Describes the specified policies or all policies used for SSL negotiation.
|
default DescribeTagsResponse |
describeTags(Consumer<DescribeTagsRequest.Builder> describeTagsRequest)
Describes the tags for the specified resources.
|
default DescribeTagsResponse |
describeTags(DescribeTagsRequest describeTagsRequest)
Describes the tags for the specified resources.
|
default DescribeTargetGroupAttributesResponse |
describeTargetGroupAttributes(Consumer<DescribeTargetGroupAttributesRequest.Builder> describeTargetGroupAttributesRequest)
Describes the attributes for the specified target group.
|
default DescribeTargetGroupAttributesResponse |
describeTargetGroupAttributes(DescribeTargetGroupAttributesRequest describeTargetGroupAttributesRequest)
Describes the attributes for the specified target group.
|
default DescribeTargetGroupsResponse |
describeTargetGroups()
Describes the specified target groups or all of your target groups.
|
default DescribeTargetGroupsResponse |
describeTargetGroups(Consumer<DescribeTargetGroupsRequest.Builder> describeTargetGroupsRequest)
Describes the specified target groups or all of your target groups.
|
default DescribeTargetGroupsResponse |
describeTargetGroups(DescribeTargetGroupsRequest describeTargetGroupsRequest)
Describes the specified target groups or all of your target groups.
|
default DescribeTargetGroupsIterable |
describeTargetGroupsPaginator()
Describes the specified target groups or all of your target groups.
|
default DescribeTargetGroupsIterable |
describeTargetGroupsPaginator(DescribeTargetGroupsRequest describeTargetGroupsRequest)
Describes the specified target groups or all of your target groups.
|
default DescribeTargetHealthResponse |
describeTargetHealth(Consumer<DescribeTargetHealthRequest.Builder> describeTargetHealthRequest)
Describes the health of the specified targets or all of your targets.
|
default DescribeTargetHealthResponse |
describeTargetHealth(DescribeTargetHealthRequest describeTargetHealthRequest)
Describes the health of the specified targets or all of your targets.
|
default ModifyListenerResponse |
modifyListener(Consumer<ModifyListenerRequest.Builder> modifyListenerRequest)
Modifies the specified properties of the specified listener.
|
default ModifyListenerResponse |
modifyListener(ModifyListenerRequest modifyListenerRequest)
Modifies the specified properties of the specified listener.
|
default ModifyLoadBalancerAttributesResponse |
modifyLoadBalancerAttributes(Consumer<ModifyLoadBalancerAttributesRequest.Builder> modifyLoadBalancerAttributesRequest)
Modifies the specified attributes of the specified Application Load Balancer or Network Load Balancer.
|
default ModifyLoadBalancerAttributesResponse |
modifyLoadBalancerAttributes(ModifyLoadBalancerAttributesRequest modifyLoadBalancerAttributesRequest)
Modifies the specified attributes of the specified Application Load Balancer or Network Load Balancer.
|
default ModifyRuleResponse |
modifyRule(Consumer<ModifyRuleRequest.Builder> modifyRuleRequest)
Modifies the specified rule.
|
default ModifyRuleResponse |
modifyRule(ModifyRuleRequest modifyRuleRequest)
Modifies the specified rule.
|
default 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 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(Consumer<ModifyTargetGroupAttributesRequest.Builder> modifyTargetGroupAttributesRequest)
Modifies the specified attributes of the specified target group.
|
default ModifyTargetGroupAttributesResponse |
modifyTargetGroupAttributes(ModifyTargetGroupAttributesRequest modifyTargetGroupAttributesRequest)
Modifies the specified attributes of the specified target group.
|
default RegisterTargetsResponse |
registerTargets(Consumer<RegisterTargetsRequest.Builder> registerTargetsRequest)
Registers the specified targets with the specified target group.
|
default RegisterTargetsResponse |
registerTargets(RegisterTargetsRequest registerTargetsRequest)
Registers the specified targets with the specified target group.
|
default RemoveListenerCertificatesResponse |
removeListenerCertificates(Consumer<RemoveListenerCertificatesRequest.Builder> removeListenerCertificatesRequest)
Removes the specified certificate from the specified secure listener.
|
default RemoveListenerCertificatesResponse |
removeListenerCertificates(RemoveListenerCertificatesRequest removeListenerCertificatesRequest)
Removes the specified certificate from the specified secure listener.
|
default RemoveTagsResponse |
removeTags(Consumer<RemoveTagsRequest.Builder> removeTagsRequest)
Removes the specified tags from the specified Elastic Load Balancing resource.
|
default RemoveTagsResponse |
removeTags(RemoveTagsRequest removeTagsRequest)
Removes the specified tags from the specified Elastic Load Balancing resource.
|
static ServiceMetadata |
serviceMetadata() |
default 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 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 SetRulePrioritiesResponse |
setRulePriorities(Consumer<SetRulePrioritiesRequest.Builder> setRulePrioritiesRequest)
Sets the priorities of the specified rules.
|
default SetRulePrioritiesResponse |
setRulePriorities(SetRulePrioritiesRequest setRulePrioritiesRequest)
Sets the priorities of the specified rules.
|
default SetSecurityGroupsResponse |
setSecurityGroups(Consumer<SetSecurityGroupsRequest.Builder> setSecurityGroupsRequest)
Associates the specified security groups with the specified Application Load Balancer.
|
default SetSecurityGroupsResponse |
setSecurityGroups(SetSecurityGroupsRequest setSecurityGroupsRequest)
Associates the specified security groups with the specified Application Load Balancer.
|
default SetSubnetsResponse |
setSubnets(Consumer<SetSubnetsRequest.Builder> setSubnetsRequest)
Enables the Availability Zone for the specified subnets for the specified Application Load Balancer.
|
default 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 ElasticLoadBalancingv2Client create()
ElasticLoadBalancingv2Client
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from
the DefaultCredentialsProvider
.static ElasticLoadBalancingv2ClientBuilder builder()
ElasticLoadBalancingv2Client
.default AddListenerCertificatesResponse addListenerCertificates(AddListenerCertificatesRequest addListenerCertificatesRequest) throws ListenerNotFoundException, TooManyCertificatesException, CertificateNotFoundException, SdkServiceException, SdkClientException, ElasticLoadBalancingv2Exception
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
- ListenerNotFoundException
- The specified listener does not exist.TooManyCertificatesException
- You've reached the limit on the number of certificates per load balancer.CertificateNotFoundException
- The specified certificate does not exist.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticLoadBalancingv2Exception
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default AddListenerCertificatesResponse addListenerCertificates(Consumer<AddListenerCertificatesRequest.Builder> addListenerCertificatesRequest) throws ListenerNotFoundException, TooManyCertificatesException, CertificateNotFoundException, SdkServiceException, SdkClientException, ElasticLoadBalancingv2Exception
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
- ListenerNotFoundException
- The specified listener does not exist.TooManyCertificatesException
- You've reached the limit on the number of certificates per load balancer.CertificateNotFoundException
- The specified certificate does not exist.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticLoadBalancingv2Exception
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default AddTagsResponse addTags(AddTagsRequest addTagsRequest) throws DuplicateTagKeysException, TooManyTagsException, LoadBalancerNotFoundException, TargetGroupNotFoundException, SdkServiceException, SdkClientException, ElasticLoadBalancingv2Exception
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
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticLoadBalancingv2Exception
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default AddTagsResponse addTags(Consumer<AddTagsRequest.Builder> addTagsRequest) throws DuplicateTagKeysException, TooManyTagsException, LoadBalancerNotFoundException, TargetGroupNotFoundException, SdkServiceException, SdkClientException, ElasticLoadBalancingv2Exception
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
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticLoadBalancingv2Exception
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default CreateListenerResponse createListener(CreateListenerRequest createListenerRequest) throws DuplicateListenerException, TooManyListenersException, TooManyCertificatesException, LoadBalancerNotFoundException, TargetGroupNotFoundException, TargetGroupAssociationLimitException, InvalidConfigurationRequestException, IncompatibleProtocolsException, SSLPolicyNotFoundException, CertificateNotFoundException, UnsupportedProtocolException, TooManyRegistrationsForTargetIdException, TooManyTargetsException, SdkServiceException, SdkClientException, ElasticLoadBalancingv2Exception
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
- 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 load balancer.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.TooManyTargetsException
- You've reached the limit on the number of targets.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticLoadBalancingv2Exception
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default CreateListenerResponse createListener(Consumer<CreateListenerRequest.Builder> createListenerRequest) throws DuplicateListenerException, TooManyListenersException, TooManyCertificatesException, LoadBalancerNotFoundException, TargetGroupNotFoundException, TargetGroupAssociationLimitException, InvalidConfigurationRequestException, IncompatibleProtocolsException, SSLPolicyNotFoundException, CertificateNotFoundException, UnsupportedProtocolException, TooManyRegistrationsForTargetIdException, TooManyTargetsException, SdkServiceException, SdkClientException, ElasticLoadBalancingv2Exception
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
- 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 load balancer.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.TooManyTargetsException
- You've reached the limit on the number of targets.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticLoadBalancingv2Exception
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default CreateLoadBalancerResponse createLoadBalancer(CreateLoadBalancerRequest createLoadBalancerRequest) throws DuplicateLoadBalancerNameException, TooManyLoadBalancersException, InvalidConfigurationRequestException, SubnetNotFoundException, InvalidSubnetException, InvalidSecurityGroupException, InvalidSchemeException, TooManyTagsException, DuplicateTagKeysException, ResourceInUseException, AllocationIdNotFoundException, AvailabilityZoneNotSupportedException, SdkServiceException, SdkClientException, ElasticLoadBalancingv2Exception
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
- 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.ResourceInUseException
- A specified resource is in use.AllocationIdNotFoundException
- The specified allocation ID does not exist.AvailabilityZoneNotSupportedException
- The specified Availability Zone is not supported.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticLoadBalancingv2Exception
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default CreateLoadBalancerResponse createLoadBalancer(Consumer<CreateLoadBalancerRequest.Builder> createLoadBalancerRequest) throws DuplicateLoadBalancerNameException, TooManyLoadBalancersException, InvalidConfigurationRequestException, SubnetNotFoundException, InvalidSubnetException, InvalidSecurityGroupException, InvalidSchemeException, TooManyTagsException, DuplicateTagKeysException, ResourceInUseException, AllocationIdNotFoundException, AvailabilityZoneNotSupportedException, SdkServiceException, SdkClientException, ElasticLoadBalancingv2Exception
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
- 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.ResourceInUseException
- A specified resource is in use.AllocationIdNotFoundException
- The specified allocation ID does not exist.AvailabilityZoneNotSupportedException
- The specified Availability Zone is not supported.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticLoadBalancingv2Exception
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default CreateRuleResponse createRule(CreateRuleRequest createRuleRequest) throws PriorityInUseException, TooManyTargetGroupsException, TooManyRulesException, TargetGroupAssociationLimitException, IncompatibleProtocolsException, ListenerNotFoundException, TargetGroupNotFoundException, InvalidConfigurationRequestException, TooManyRegistrationsForTargetIdException, TooManyTargetsException, SdkServiceException, SdkClientException, ElasticLoadBalancingv2Exception
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
- 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.IncompatibleProtocolsException
- The specified configuration is not valid with this protocol.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.TooManyTargetsException
- You've reached the limit on the number of targets.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticLoadBalancingv2Exception
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default CreateRuleResponse createRule(Consumer<CreateRuleRequest.Builder> createRuleRequest) throws PriorityInUseException, TooManyTargetGroupsException, TooManyRulesException, TargetGroupAssociationLimitException, IncompatibleProtocolsException, ListenerNotFoundException, TargetGroupNotFoundException, InvalidConfigurationRequestException, TooManyRegistrationsForTargetIdException, TooManyTargetsException, SdkServiceException, SdkClientException, ElasticLoadBalancingv2Exception
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
- 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.IncompatibleProtocolsException
- The specified configuration is not valid with this protocol.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.TooManyTargetsException
- You've reached the limit on the number of targets.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticLoadBalancingv2Exception
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default CreateTargetGroupResponse createTargetGroup(CreateTargetGroupRequest createTargetGroupRequest) throws DuplicateTargetGroupNameException, TooManyTargetGroupsException, InvalidConfigurationRequestException, SdkServiceException, 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.
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
- 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.InvalidConfigurationRequestException
- The requested configuration is not valid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticLoadBalancingv2Exception
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default CreateTargetGroupResponse createTargetGroup(Consumer<CreateTargetGroupRequest.Builder> createTargetGroupRequest) throws DuplicateTargetGroupNameException, TooManyTargetGroupsException, InvalidConfigurationRequestException, SdkServiceException, 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.
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
- 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.InvalidConfigurationRequestException
- The requested configuration is not valid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticLoadBalancingv2Exception
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default DeleteListenerResponse deleteListener(DeleteListenerRequest deleteListenerRequest) throws ListenerNotFoundException, SdkServiceException, 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticLoadBalancingv2Exception
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default DeleteListenerResponse deleteListener(Consumer<DeleteListenerRequest.Builder> deleteListenerRequest) throws ListenerNotFoundException, SdkServiceException, 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticLoadBalancingv2Exception
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default DeleteLoadBalancerResponse deleteLoadBalancer(DeleteLoadBalancerRequest deleteLoadBalancerRequest) throws LoadBalancerNotFoundException, OperationNotPermittedException, ResourceInUseException, SdkServiceException, SdkClientException, ElasticLoadBalancingv2Exception
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
- LoadBalancerNotFoundException
- The specified load balancer does not exist.OperationNotPermittedException
- This operation is not allowed.ResourceInUseException
- A specified resource is in use.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticLoadBalancingv2Exception
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default DeleteLoadBalancerResponse deleteLoadBalancer(Consumer<DeleteLoadBalancerRequest.Builder> deleteLoadBalancerRequest) throws LoadBalancerNotFoundException, OperationNotPermittedException, ResourceInUseException, SdkServiceException, SdkClientException, ElasticLoadBalancingv2Exception
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
- LoadBalancerNotFoundException
- The specified load balancer does not exist.OperationNotPermittedException
- This operation is not allowed.ResourceInUseException
- A specified resource is in use.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticLoadBalancingv2Exception
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default DeleteRuleResponse deleteRule(DeleteRuleRequest deleteRuleRequest) throws RuleNotFoundException, OperationNotPermittedException, SdkServiceException, SdkClientException, ElasticLoadBalancingv2Exception
Deletes the specified rule.
deleteRuleRequest
- RuleNotFoundException
- The specified rule does not exist.OperationNotPermittedException
- This operation is not allowed.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticLoadBalancingv2Exception
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default DeleteRuleResponse deleteRule(Consumer<DeleteRuleRequest.Builder> deleteRuleRequest) throws RuleNotFoundException, OperationNotPermittedException, SdkServiceException, SdkClientException, ElasticLoadBalancingv2Exception
Deletes the specified rule.
deleteRuleRequest
- RuleNotFoundException
- The specified rule does not exist.OperationNotPermittedException
- This operation is not allowed.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticLoadBalancingv2Exception
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default DeleteTargetGroupResponse deleteTargetGroup(DeleteTargetGroupRequest deleteTargetGroupRequest) throws ResourceInUseException, SdkServiceException, 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticLoadBalancingv2Exception
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default DeleteTargetGroupResponse deleteTargetGroup(Consumer<DeleteTargetGroupRequest.Builder> deleteTargetGroupRequest) throws ResourceInUseException, SdkServiceException, 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticLoadBalancingv2Exception
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default DeregisterTargetsResponse deregisterTargets(DeregisterTargetsRequest deregisterTargetsRequest) throws TargetGroupNotFoundException, InvalidTargetException, SdkServiceException, 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, is not in the same VPC as the target group, or has an unsupported
instance type.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticLoadBalancingv2Exception
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default DeregisterTargetsResponse deregisterTargets(Consumer<DeregisterTargetsRequest.Builder> deregisterTargetsRequest) throws TargetGroupNotFoundException, InvalidTargetException, SdkServiceException, 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, is not in the same VPC as the target group, or has an unsupported
instance type.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticLoadBalancingv2Exception
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default DescribeAccountLimitsResponse describeAccountLimits() throws SdkServiceException, SdkClientException, ElasticLoadBalancingv2Exception
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.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticLoadBalancingv2Exception
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
describeAccountLimits(DescribeAccountLimitsRequest)
,
AWS API Documentationdefault DescribeAccountLimitsResponse describeAccountLimits(DescribeAccountLimitsRequest describeAccountLimitsRequest) throws SdkServiceException, SdkClientException, ElasticLoadBalancingv2Exception
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
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticLoadBalancingv2Exception
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default DescribeAccountLimitsResponse describeAccountLimits(Consumer<DescribeAccountLimitsRequest.Builder> describeAccountLimitsRequest) throws SdkServiceException, SdkClientException, ElasticLoadBalancingv2Exception
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
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticLoadBalancingv2Exception
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default DescribeListenerCertificatesResponse describeListenerCertificates(DescribeListenerCertificatesRequest describeListenerCertificatesRequest) throws ListenerNotFoundException, SdkServiceException, SdkClientException, ElasticLoadBalancingv2Exception
Describes the certificates for the specified secure listener.
describeListenerCertificatesRequest
- ListenerNotFoundException
- The specified listener does not exist.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticLoadBalancingv2Exception
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default DescribeListenerCertificatesResponse describeListenerCertificates(Consumer<DescribeListenerCertificatesRequest.Builder> describeListenerCertificatesRequest) throws ListenerNotFoundException, SdkServiceException, SdkClientException, ElasticLoadBalancingv2Exception
Describes the certificates for the specified secure listener.
describeListenerCertificatesRequest
- ListenerNotFoundException
- The specified listener does not exist.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticLoadBalancingv2Exception
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default DescribeListenersResponse describeListeners(DescribeListenersRequest describeListenersRequest) throws ListenerNotFoundException, LoadBalancerNotFoundException, SdkServiceException, SdkClientException, ElasticLoadBalancingv2Exception
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
- ListenerNotFoundException
- The specified listener does not exist.LoadBalancerNotFoundException
- The specified load balancer does not exist.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticLoadBalancingv2Exception
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default DescribeListenersResponse describeListeners(Consumer<DescribeListenersRequest.Builder> describeListenersRequest) throws ListenerNotFoundException, LoadBalancerNotFoundException, SdkServiceException, SdkClientException, ElasticLoadBalancingv2Exception
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
- ListenerNotFoundException
- The specified listener does not exist.LoadBalancerNotFoundException
- The specified load balancer does not exist.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticLoadBalancingv2Exception
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default DescribeListenersIterable describeListenersPaginator(DescribeListenersRequest describeListenersRequest) throws ListenerNotFoundException, LoadBalancerNotFoundException, SdkServiceException, SdkClientException, ElasticLoadBalancingv2Exception
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 iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.elasticloadbalancingv2.paginators.DescribeListenersIterable responses = client.describeListenersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.elasticloadbalancingv2.paginators.DescribeListenersIterable responses = client .describeListenersPaginator(request); for (software.amazon.awssdk.services.elasticloadbalancingv2.model.DescribeListenersResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.elasticloadbalancingv2.paginators.DescribeListenersIterable responses = client.describeListenersPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeListeners(software.amazon.awssdk.services.elasticloadbalancingv2.model.DescribeListenersRequest)
operation.
describeListenersRequest
- ListenerNotFoundException
- The specified listener does not exist.LoadBalancerNotFoundException
- The specified load balancer does not exist.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticLoadBalancingv2Exception
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default DescribeLoadBalancerAttributesResponse describeLoadBalancerAttributes(DescribeLoadBalancerAttributesRequest describeLoadBalancerAttributesRequest) throws LoadBalancerNotFoundException, SdkServiceException, SdkClientException, ElasticLoadBalancingv2Exception
Describes the attributes for the specified Application Load Balancer or Network Load Balancer.
describeLoadBalancerAttributesRequest
- LoadBalancerNotFoundException
- The specified load balancer does not exist.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticLoadBalancingv2Exception
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default DescribeLoadBalancerAttributesResponse describeLoadBalancerAttributes(Consumer<DescribeLoadBalancerAttributesRequest.Builder> describeLoadBalancerAttributesRequest) throws LoadBalancerNotFoundException, SdkServiceException, SdkClientException, ElasticLoadBalancingv2Exception
Describes the attributes for the specified Application Load Balancer or Network Load Balancer.
describeLoadBalancerAttributesRequest
- LoadBalancerNotFoundException
- The specified load balancer does not exist.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticLoadBalancingv2Exception
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default DescribeLoadBalancersResponse describeLoadBalancers() throws LoadBalancerNotFoundException, SdkServiceException, SdkClientException, ElasticLoadBalancingv2Exception
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.
LoadBalancerNotFoundException
- The specified load balancer does not exist.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticLoadBalancingv2Exception
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
describeLoadBalancers(DescribeLoadBalancersRequest)
,
AWS API Documentationdefault DescribeLoadBalancersResponse describeLoadBalancers(DescribeLoadBalancersRequest describeLoadBalancersRequest) throws LoadBalancerNotFoundException, SdkServiceException, SdkClientException, ElasticLoadBalancingv2Exception
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
- LoadBalancerNotFoundException
- The specified load balancer does not exist.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticLoadBalancingv2Exception
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default DescribeLoadBalancersResponse describeLoadBalancers(Consumer<DescribeLoadBalancersRequest.Builder> describeLoadBalancersRequest) throws LoadBalancerNotFoundException, SdkServiceException, SdkClientException, ElasticLoadBalancingv2Exception
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
- LoadBalancerNotFoundException
- The specified load balancer does not exist.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticLoadBalancingv2Exception
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default DescribeLoadBalancersIterable describeLoadBalancersPaginator() throws LoadBalancerNotFoundException, SdkServiceException, SdkClientException, ElasticLoadBalancingv2Exception
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 iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.elasticloadbalancingv2.paginators.DescribeLoadBalancersIterable responses = client.describeLoadBalancersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.elasticloadbalancingv2.paginators.DescribeLoadBalancersIterable responses = client .describeLoadBalancersPaginator(request); for (software.amazon.awssdk.services.elasticloadbalancingv2.model.DescribeLoadBalancersResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.elasticloadbalancingv2.paginators.DescribeLoadBalancersIterable responses = client.describeLoadBalancersPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeLoadBalancers(software.amazon.awssdk.services.elasticloadbalancingv2.model.DescribeLoadBalancersRequest)
operation.
LoadBalancerNotFoundException
- The specified load balancer does not exist.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticLoadBalancingv2Exception
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
describeLoadBalancersPaginator(DescribeLoadBalancersRequest)
,
AWS API Documentationdefault DescribeLoadBalancersIterable describeLoadBalancersPaginator(DescribeLoadBalancersRequest describeLoadBalancersRequest) throws LoadBalancerNotFoundException, SdkServiceException, SdkClientException, ElasticLoadBalancingv2Exception
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 iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.elasticloadbalancingv2.paginators.DescribeLoadBalancersIterable responses = client.describeLoadBalancersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.elasticloadbalancingv2.paginators.DescribeLoadBalancersIterable responses = client .describeLoadBalancersPaginator(request); for (software.amazon.awssdk.services.elasticloadbalancingv2.model.DescribeLoadBalancersResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.elasticloadbalancingv2.paginators.DescribeLoadBalancersIterable responses = client.describeLoadBalancersPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeLoadBalancers(software.amazon.awssdk.services.elasticloadbalancingv2.model.DescribeLoadBalancersRequest)
operation.
describeLoadBalancersRequest
- LoadBalancerNotFoundException
- The specified load balancer does not exist.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticLoadBalancingv2Exception
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default DescribeRulesResponse describeRules(DescribeRulesRequest describeRulesRequest) throws ListenerNotFoundException, RuleNotFoundException, SdkServiceException, 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticLoadBalancingv2Exception
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default DescribeRulesResponse describeRules(Consumer<DescribeRulesRequest.Builder> describeRulesRequest) throws ListenerNotFoundException, RuleNotFoundException, SdkServiceException, 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticLoadBalancingv2Exception
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default DescribeSSLPoliciesResponse describeSSLPolicies() throws SSLPolicyNotFoundException, SdkServiceException, 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.
SSLPolicyNotFoundException
- The specified SSL policy does not exist.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticLoadBalancingv2Exception
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
describeSSLPolicies(DescribeSSLPoliciesRequest)
,
AWS API Documentationdefault DescribeSSLPoliciesResponse describeSSLPolicies(DescribeSSLPoliciesRequest describeSSLPoliciesRequest) throws SSLPolicyNotFoundException, SdkServiceException, 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticLoadBalancingv2Exception
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default DescribeSSLPoliciesResponse describeSSLPolicies(Consumer<DescribeSSLPoliciesRequest.Builder> describeSSLPoliciesRequest) throws SSLPolicyNotFoundException, SdkServiceException, 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticLoadBalancingv2Exception
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default DescribeTagsResponse describeTags(DescribeTagsRequest describeTagsRequest) throws LoadBalancerNotFoundException, TargetGroupNotFoundException, ListenerNotFoundException, RuleNotFoundException, SdkServiceException, SdkClientException, ElasticLoadBalancingv2Exception
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
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticLoadBalancingv2Exception
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default DescribeTagsResponse describeTags(Consumer<DescribeTagsRequest.Builder> describeTagsRequest) throws LoadBalancerNotFoundException, TargetGroupNotFoundException, ListenerNotFoundException, RuleNotFoundException, SdkServiceException, SdkClientException, ElasticLoadBalancingv2Exception
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
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticLoadBalancingv2Exception
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default DescribeTargetGroupAttributesResponse describeTargetGroupAttributes(DescribeTargetGroupAttributesRequest describeTargetGroupAttributesRequest) throws TargetGroupNotFoundException, SdkServiceException, SdkClientException, ElasticLoadBalancingv2Exception
Describes the attributes for the specified target group.
describeTargetGroupAttributesRequest
- TargetGroupNotFoundException
- The specified target group does not exist.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticLoadBalancingv2Exception
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default DescribeTargetGroupAttributesResponse describeTargetGroupAttributes(Consumer<DescribeTargetGroupAttributesRequest.Builder> describeTargetGroupAttributesRequest) throws TargetGroupNotFoundException, SdkServiceException, SdkClientException, ElasticLoadBalancingv2Exception
Describes the attributes for the specified target group.
describeTargetGroupAttributesRequest
- TargetGroupNotFoundException
- The specified target group does not exist.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticLoadBalancingv2Exception
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default DescribeTargetGroupsResponse describeTargetGroups() throws LoadBalancerNotFoundException, TargetGroupNotFoundException, SdkServiceException, 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.
LoadBalancerNotFoundException
- The specified load balancer does not exist.TargetGroupNotFoundException
- The specified target group does not exist.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticLoadBalancingv2Exception
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
describeTargetGroups(DescribeTargetGroupsRequest)
,
AWS API Documentationdefault DescribeTargetGroupsResponse describeTargetGroups(DescribeTargetGroupsRequest describeTargetGroupsRequest) throws LoadBalancerNotFoundException, TargetGroupNotFoundException, SdkServiceException, 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticLoadBalancingv2Exception
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default DescribeTargetGroupsResponse describeTargetGroups(Consumer<DescribeTargetGroupsRequest.Builder> describeTargetGroupsRequest) throws LoadBalancerNotFoundException, TargetGroupNotFoundException, SdkServiceException, 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticLoadBalancingv2Exception
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default DescribeTargetGroupsIterable describeTargetGroupsPaginator() throws LoadBalancerNotFoundException, TargetGroupNotFoundException, SdkServiceException, 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.
This is a variant of
describeTargetGroups(software.amazon.awssdk.services.elasticloadbalancingv2.model.DescribeTargetGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.elasticloadbalancingv2.paginators.DescribeTargetGroupsIterable responses = client.describeTargetGroupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.elasticloadbalancingv2.paginators.DescribeTargetGroupsIterable responses = client .describeTargetGroupsPaginator(request); for (software.amazon.awssdk.services.elasticloadbalancingv2.model.DescribeTargetGroupsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.elasticloadbalancingv2.paginators.DescribeTargetGroupsIterable responses = client.describeTargetGroupsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeTargetGroups(software.amazon.awssdk.services.elasticloadbalancingv2.model.DescribeTargetGroupsRequest)
operation.
LoadBalancerNotFoundException
- The specified load balancer does not exist.TargetGroupNotFoundException
- The specified target group does not exist.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticLoadBalancingv2Exception
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
describeTargetGroupsPaginator(DescribeTargetGroupsRequest)
,
AWS API Documentationdefault DescribeTargetGroupsIterable describeTargetGroupsPaginator(DescribeTargetGroupsRequest describeTargetGroupsRequest) throws LoadBalancerNotFoundException, TargetGroupNotFoundException, SdkServiceException, 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.
This is a variant of
describeTargetGroups(software.amazon.awssdk.services.elasticloadbalancingv2.model.DescribeTargetGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.elasticloadbalancingv2.paginators.DescribeTargetGroupsIterable responses = client.describeTargetGroupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.elasticloadbalancingv2.paginators.DescribeTargetGroupsIterable responses = client .describeTargetGroupsPaginator(request); for (software.amazon.awssdk.services.elasticloadbalancingv2.model.DescribeTargetGroupsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.elasticloadbalancingv2.paginators.DescribeTargetGroupsIterable responses = client.describeTargetGroupsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeTargetGroups(software.amazon.awssdk.services.elasticloadbalancingv2.model.DescribeTargetGroupsRequest)
operation.
describeTargetGroupsRequest
- LoadBalancerNotFoundException
- The specified load balancer does not exist.TargetGroupNotFoundException
- The specified target group does not exist.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticLoadBalancingv2Exception
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default DescribeTargetHealthResponse describeTargetHealth(DescribeTargetHealthRequest describeTargetHealthRequest) throws InvalidTargetException, TargetGroupNotFoundException, HealthUnavailableException, SdkServiceException, SdkClientException, ElasticLoadBalancingv2Exception
Describes the health of the specified targets or all of your targets.
describeTargetHealthRequest
- InvalidTargetException
- The specified target does not exist, is not in the same VPC as the target group, or has an unsupported
instance type.TargetGroupNotFoundException
- The specified target group does not exist.HealthUnavailableException
- The health of the specified targets could not be retrieved due to an internal error.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticLoadBalancingv2Exception
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default DescribeTargetHealthResponse describeTargetHealth(Consumer<DescribeTargetHealthRequest.Builder> describeTargetHealthRequest) throws InvalidTargetException, TargetGroupNotFoundException, HealthUnavailableException, SdkServiceException, SdkClientException, ElasticLoadBalancingv2Exception
Describes the health of the specified targets or all of your targets.
describeTargetHealthRequest
- InvalidTargetException
- The specified target does not exist, is not in the same VPC as the target group, or has an unsupported
instance type.TargetGroupNotFoundException
- The specified target group does not exist.HealthUnavailableException
- The health of the specified targets could not be retrieved due to an internal error.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticLoadBalancingv2Exception
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default ModifyListenerResponse modifyListener(ModifyListenerRequest modifyListenerRequest) throws DuplicateListenerException, TooManyListenersException, TooManyCertificatesException, ListenerNotFoundException, TargetGroupNotFoundException, TargetGroupAssociationLimitException, IncompatibleProtocolsException, SSLPolicyNotFoundException, CertificateNotFoundException, InvalidConfigurationRequestException, UnsupportedProtocolException, TooManyRegistrationsForTargetIdException, TooManyTargetsException, SdkServiceException, 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 load balancer.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.TooManyTargetsException
- You've reached the limit on the number of targets.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticLoadBalancingv2Exception
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default ModifyListenerResponse modifyListener(Consumer<ModifyListenerRequest.Builder> modifyListenerRequest) throws DuplicateListenerException, TooManyListenersException, TooManyCertificatesException, ListenerNotFoundException, TargetGroupNotFoundException, TargetGroupAssociationLimitException, IncompatibleProtocolsException, SSLPolicyNotFoundException, CertificateNotFoundException, InvalidConfigurationRequestException, UnsupportedProtocolException, TooManyRegistrationsForTargetIdException, TooManyTargetsException, SdkServiceException, 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 load balancer.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.TooManyTargetsException
- You've reached the limit on the number of targets.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticLoadBalancingv2Exception
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default ModifyLoadBalancerAttributesResponse modifyLoadBalancerAttributes(ModifyLoadBalancerAttributesRequest modifyLoadBalancerAttributesRequest) throws LoadBalancerNotFoundException, InvalidConfigurationRequestException, SdkServiceException, SdkClientException, ElasticLoadBalancingv2Exception
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
- LoadBalancerNotFoundException
- The specified load balancer does not exist.InvalidConfigurationRequestException
- The requested configuration is not valid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticLoadBalancingv2Exception
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default ModifyLoadBalancerAttributesResponse modifyLoadBalancerAttributes(Consumer<ModifyLoadBalancerAttributesRequest.Builder> modifyLoadBalancerAttributesRequest) throws LoadBalancerNotFoundException, InvalidConfigurationRequestException, SdkServiceException, SdkClientException, ElasticLoadBalancingv2Exception
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
- LoadBalancerNotFoundException
- The specified load balancer does not exist.InvalidConfigurationRequestException
- The requested configuration is not valid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticLoadBalancingv2Exception
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default ModifyRuleResponse modifyRule(ModifyRuleRequest modifyRuleRequest) throws TargetGroupAssociationLimitException, IncompatibleProtocolsException, RuleNotFoundException, OperationNotPermittedException, TooManyRegistrationsForTargetIdException, TooManyTargetsException, TargetGroupNotFoundException, SdkServiceException, 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.IncompatibleProtocolsException
- The specified configuration is not valid with this protocol.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticLoadBalancingv2Exception
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default ModifyRuleResponse modifyRule(Consumer<ModifyRuleRequest.Builder> modifyRuleRequest) throws TargetGroupAssociationLimitException, IncompatibleProtocolsException, RuleNotFoundException, OperationNotPermittedException, TooManyRegistrationsForTargetIdException, TooManyTargetsException, TargetGroupNotFoundException, SdkServiceException, 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.IncompatibleProtocolsException
- The specified configuration is not valid with this protocol.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticLoadBalancingv2Exception
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default ModifyTargetGroupResponse modifyTargetGroup(ModifyTargetGroupRequest modifyTargetGroupRequest) throws TargetGroupNotFoundException, InvalidConfigurationRequestException, SdkServiceException, 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.InvalidConfigurationRequestException
- The requested configuration is not valid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticLoadBalancingv2Exception
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default ModifyTargetGroupResponse modifyTargetGroup(Consumer<ModifyTargetGroupRequest.Builder> modifyTargetGroupRequest) throws TargetGroupNotFoundException, InvalidConfigurationRequestException, SdkServiceException, 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.InvalidConfigurationRequestException
- The requested configuration is not valid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticLoadBalancingv2Exception
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default ModifyTargetGroupAttributesResponse modifyTargetGroupAttributes(ModifyTargetGroupAttributesRequest modifyTargetGroupAttributesRequest) throws TargetGroupNotFoundException, InvalidConfigurationRequestException, SdkServiceException, SdkClientException, ElasticLoadBalancingv2Exception
Modifies the specified attributes of the specified target group.
modifyTargetGroupAttributesRequest
- TargetGroupNotFoundException
- The specified target group does not exist.InvalidConfigurationRequestException
- The requested configuration is not valid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticLoadBalancingv2Exception
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default ModifyTargetGroupAttributesResponse modifyTargetGroupAttributes(Consumer<ModifyTargetGroupAttributesRequest.Builder> modifyTargetGroupAttributesRequest) throws TargetGroupNotFoundException, InvalidConfigurationRequestException, SdkServiceException, SdkClientException, ElasticLoadBalancingv2Exception
Modifies the specified attributes of the specified target group.
modifyTargetGroupAttributesRequest
- TargetGroupNotFoundException
- The specified target group does not exist.InvalidConfigurationRequestException
- The requested configuration is not valid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticLoadBalancingv2Exception
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default RegisterTargetsResponse registerTargets(RegisterTargetsRequest registerTargetsRequest) throws TargetGroupNotFoundException, TooManyTargetsException, InvalidTargetException, TooManyRegistrationsForTargetIdException, SdkServiceException, SdkClientException, ElasticLoadBalancingv2Exception
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
- 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, is not in the same VPC as the target group, or has an unsupported
instance type.TooManyRegistrationsForTargetIdException
- You've reached the limit on the number of times a target can be registered with a load balancer.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticLoadBalancingv2Exception
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default RegisterTargetsResponse registerTargets(Consumer<RegisterTargetsRequest.Builder> registerTargetsRequest) throws TargetGroupNotFoundException, TooManyTargetsException, InvalidTargetException, TooManyRegistrationsForTargetIdException, SdkServiceException, SdkClientException, ElasticLoadBalancingv2Exception
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
- 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, is not in the same VPC as the target group, or has an unsupported
instance type.TooManyRegistrationsForTargetIdException
- You've reached the limit on the number of times a target can be registered with a load balancer.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticLoadBalancingv2Exception
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default RemoveListenerCertificatesResponse removeListenerCertificates(RemoveListenerCertificatesRequest removeListenerCertificatesRequest) throws ListenerNotFoundException, OperationNotPermittedException, SdkServiceException, SdkClientException, ElasticLoadBalancingv2Exception
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
- ListenerNotFoundException
- The specified listener does not exist.OperationNotPermittedException
- This operation is not allowed.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticLoadBalancingv2Exception
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default RemoveListenerCertificatesResponse removeListenerCertificates(Consumer<RemoveListenerCertificatesRequest.Builder> removeListenerCertificatesRequest) throws ListenerNotFoundException, OperationNotPermittedException, SdkServiceException, SdkClientException, ElasticLoadBalancingv2Exception
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
- ListenerNotFoundException
- The specified listener does not exist.OperationNotPermittedException
- This operation is not allowed.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticLoadBalancingv2Exception
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default RemoveTagsResponse removeTags(RemoveTagsRequest removeTagsRequest) throws LoadBalancerNotFoundException, TargetGroupNotFoundException, ListenerNotFoundException, RuleNotFoundException, TooManyTagsException, SdkServiceException, SdkClientException, ElasticLoadBalancingv2Exception
Removes the specified tags from the specified Elastic Load Balancing 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticLoadBalancingv2Exception
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default RemoveTagsResponse removeTags(Consumer<RemoveTagsRequest.Builder> removeTagsRequest) throws LoadBalancerNotFoundException, TargetGroupNotFoundException, ListenerNotFoundException, RuleNotFoundException, TooManyTagsException, SdkServiceException, SdkClientException, ElasticLoadBalancingv2Exception
Removes the specified tags from the specified Elastic Load Balancing 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticLoadBalancingv2Exception
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default SetIpAddressTypeResponse setIpAddressType(SetIpAddressTypeRequest setIpAddressTypeRequest) throws LoadBalancerNotFoundException, InvalidConfigurationRequestException, InvalidSubnetException, SdkServiceException, SdkClientException, ElasticLoadBalancingv2Exception
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
- LoadBalancerNotFoundException
- The specified load balancer does not exist.InvalidConfigurationRequestException
- The requested configuration is not valid.InvalidSubnetException
- The specified subnet is out of available addresses.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticLoadBalancingv2Exception
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default SetIpAddressTypeResponse setIpAddressType(Consumer<SetIpAddressTypeRequest.Builder> setIpAddressTypeRequest) throws LoadBalancerNotFoundException, InvalidConfigurationRequestException, InvalidSubnetException, SdkServiceException, SdkClientException, ElasticLoadBalancingv2Exception
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
- LoadBalancerNotFoundException
- The specified load balancer does not exist.InvalidConfigurationRequestException
- The requested configuration is not valid.InvalidSubnetException
- The specified subnet is out of available addresses.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticLoadBalancingv2Exception
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default SetRulePrioritiesResponse setRulePriorities(SetRulePrioritiesRequest setRulePrioritiesRequest) throws RuleNotFoundException, PriorityInUseException, OperationNotPermittedException, SdkServiceException, 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticLoadBalancingv2Exception
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default SetRulePrioritiesResponse setRulePriorities(Consumer<SetRulePrioritiesRequest.Builder> setRulePrioritiesRequest) throws RuleNotFoundException, PriorityInUseException, OperationNotPermittedException, SdkServiceException, 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticLoadBalancingv2Exception
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default SetSecurityGroupsResponse setSecurityGroups(SetSecurityGroupsRequest setSecurityGroupsRequest) throws LoadBalancerNotFoundException, InvalidConfigurationRequestException, InvalidSecurityGroupException, SdkServiceException, SdkClientException, ElasticLoadBalancingv2Exception
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
- LoadBalancerNotFoundException
- The specified load balancer does not exist.InvalidConfigurationRequestException
- The requested configuration is not valid.InvalidSecurityGroupException
- The specified security group does not exist.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticLoadBalancingv2Exception
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default SetSecurityGroupsResponse setSecurityGroups(Consumer<SetSecurityGroupsRequest.Builder> setSecurityGroupsRequest) throws LoadBalancerNotFoundException, InvalidConfigurationRequestException, InvalidSecurityGroupException, SdkServiceException, SdkClientException, ElasticLoadBalancingv2Exception
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
- LoadBalancerNotFoundException
- The specified load balancer does not exist.InvalidConfigurationRequestException
- The requested configuration is not valid.InvalidSecurityGroupException
- The specified security group does not exist.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticLoadBalancingv2Exception
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default SetSubnetsResponse setSubnets(SetSubnetsRequest setSubnetsRequest) throws LoadBalancerNotFoundException, InvalidConfigurationRequestException, SubnetNotFoundException, InvalidSubnetException, AllocationIdNotFoundException, AvailabilityZoneNotSupportedException, SdkServiceException, SdkClientException, ElasticLoadBalancingv2Exception
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
- 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.AllocationIdNotFoundException
- The specified allocation ID does not exist.AvailabilityZoneNotSupportedException
- The specified Availability Zone is not supported.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticLoadBalancingv2Exception
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default SetSubnetsResponse setSubnets(Consumer<SetSubnetsRequest.Builder> setSubnetsRequest) throws LoadBalancerNotFoundException, InvalidConfigurationRequestException, SubnetNotFoundException, InvalidSubnetException, AllocationIdNotFoundException, AvailabilityZoneNotSupportedException, SdkServiceException, SdkClientException, ElasticLoadBalancingv2Exception
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
- 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.AllocationIdNotFoundException
- The specified allocation ID does not exist.AvailabilityZoneNotSupportedException
- The specified Availability Zone is not supported.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticLoadBalancingv2Exception
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
static ServiceMetadata serviceMetadata()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.