Interface ElasticLoadBalancingV2Client
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
builder()
method.
A load balancer distributes incoming traffic across targets, such as your EC2 instances. This enables you to increase the availability of your application. The load balancer also monitors the health of its registered targets and ensures that it routes traffic only to healthy targets. You configure your load balancer to accept incoming traffic by specifying one or more listeners, which are configured with a protocol and port number for connections from clients to the load balancer. You configure a target group with a protocol and port number for connections from the load balancer to the targets, and with health check settings to be used when checking the health status of the targets.
Elastic Load Balancing supports the following types of load balancers: Application Load Balancers, Network Load Balancers, Gateway Load Balancers, and Classic Load Balancers. This reference covers the following load balancer types:
-
Application Load Balancer - Operates at the application layer (layer 7) and supports HTTP and HTTPS.
-
Network Load Balancer - Operates at the transport layer (layer 4) and supports TCP, TLS, and UDP.
-
Gateway Load Balancer - Operates at the network layer (layer 3).
For more information, see the Elastic Load Balancing User Guide.
All Elastic Load Balancing operations are idempotent, which means that they complete at most one time. If you repeat an operation, it succeeds.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringValue for looking up the service's metadata from theServiceMetadataProvider.static final String -
Method Summary
Modifier and TypeMethodDescriptiondefault AddListenerCertificatesResponseaddListenerCertificates(Consumer<AddListenerCertificatesRequest.Builder> addListenerCertificatesRequest) Adds the specified SSL server certificate to the certificate list for the specified HTTPS or TLS listener.default AddListenerCertificatesResponseaddListenerCertificates(AddListenerCertificatesRequest addListenerCertificatesRequest) Adds the specified SSL server certificate to the certificate list for the specified HTTPS or TLS listener.default AddTagsResponseaddTags(Consumer<AddTagsRequest.Builder> addTagsRequest) Adds the specified tags to the specified Elastic Load Balancing resource.default AddTagsResponseaddTags(AddTagsRequest addTagsRequest) Adds the specified tags to the specified Elastic Load Balancing resource.builder()Create a builder that can be used to configure and create aElasticLoadBalancingV2Client.static ElasticLoadBalancingV2Clientcreate()Create aElasticLoadBalancingV2Clientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.default CreateListenerResponsecreateListener(Consumer<CreateListenerRequest.Builder> createListenerRequest) Creates a listener for the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer.default CreateListenerResponsecreateListener(CreateListenerRequest createListenerRequest) Creates a listener for the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer.default CreateLoadBalancerResponsecreateLoadBalancer(Consumer<CreateLoadBalancerRequest.Builder> createLoadBalancerRequest) Creates an Application Load Balancer, Network Load Balancer, or Gateway Load Balancer.default CreateLoadBalancerResponsecreateLoadBalancer(CreateLoadBalancerRequest createLoadBalancerRequest) Creates an Application Load Balancer, Network Load Balancer, or Gateway Load Balancer.default CreateRuleResponsecreateRule(Consumer<CreateRuleRequest.Builder> createRuleRequest) Creates a rule for the specified listener.default CreateRuleResponsecreateRule(CreateRuleRequest createRuleRequest) Creates a rule for the specified listener.default CreateTargetGroupResponsecreateTargetGroup(Consumer<CreateTargetGroupRequest.Builder> createTargetGroupRequest) Creates a target group.default CreateTargetGroupResponsecreateTargetGroup(CreateTargetGroupRequest createTargetGroupRequest) Creates a target group.default DeleteListenerResponsedeleteListener(Consumer<DeleteListenerRequest.Builder> deleteListenerRequest) Deletes the specified listener.default DeleteListenerResponsedeleteListener(DeleteListenerRequest deleteListenerRequest) Deletes the specified listener.default DeleteLoadBalancerResponsedeleteLoadBalancer(Consumer<DeleteLoadBalancerRequest.Builder> deleteLoadBalancerRequest) Deletes the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer.default DeleteLoadBalancerResponsedeleteLoadBalancer(DeleteLoadBalancerRequest deleteLoadBalancerRequest) Deletes the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer.default DeleteRuleResponsedeleteRule(Consumer<DeleteRuleRequest.Builder> deleteRuleRequest) Deletes the specified rule.default DeleteRuleResponsedeleteRule(DeleteRuleRequest deleteRuleRequest) Deletes the specified rule.default DeleteTargetGroupResponsedeleteTargetGroup(Consumer<DeleteTargetGroupRequest.Builder> deleteTargetGroupRequest) Deletes the specified target group.default DeleteTargetGroupResponsedeleteTargetGroup(DeleteTargetGroupRequest deleteTargetGroupRequest) Deletes the specified target group.default DeregisterTargetsResponsederegisterTargets(Consumer<DeregisterTargetsRequest.Builder> deregisterTargetsRequest) Deregisters the specified targets from the specified target group.default DeregisterTargetsResponsederegisterTargets(DeregisterTargetsRequest deregisterTargetsRequest) Deregisters the specified targets from the specified target group.default DescribeAccountLimitsResponseDescribes the current Elastic Load Balancing resource limits for your Amazon Web Services account.default DescribeAccountLimitsResponsedescribeAccountLimits(Consumer<DescribeAccountLimitsRequest.Builder> describeAccountLimitsRequest) Describes the current Elastic Load Balancing resource limits for your Amazon Web Services account.default DescribeAccountLimitsResponsedescribeAccountLimits(DescribeAccountLimitsRequest describeAccountLimitsRequest) Describes the current Elastic Load Balancing resource limits for your Amazon Web Services account.describeListenerCertificates(Consumer<DescribeListenerCertificatesRequest.Builder> describeListenerCertificatesRequest) Describes the default certificate and the certificate list for the specified HTTPS or TLS listener.describeListenerCertificates(DescribeListenerCertificatesRequest describeListenerCertificatesRequest) Describes the default certificate and the certificate list for the specified HTTPS or TLS listener.default DescribeListenersResponsedescribeListeners(Consumer<DescribeListenersRequest.Builder> describeListenersRequest) Describes the specified listeners or the listeners for the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer.default DescribeListenersResponsedescribeListeners(DescribeListenersRequest describeListenersRequest) Describes the specified listeners or the listeners for the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer.default DescribeListenersIterabledescribeListenersPaginator(Consumer<DescribeListenersRequest.Builder> describeListenersRequest) Describes the specified listeners or the listeners for the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer.default DescribeListenersIterabledescribeListenersPaginator(DescribeListenersRequest describeListenersRequest) Describes the specified listeners or the listeners for the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer.describeLoadBalancerAttributes(Consumer<DescribeLoadBalancerAttributesRequest.Builder> describeLoadBalancerAttributesRequest) Describes the attributes for the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer.describeLoadBalancerAttributes(DescribeLoadBalancerAttributesRequest describeLoadBalancerAttributesRequest) Describes the attributes for the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer.default DescribeLoadBalancersResponseDescribes the specified load balancers or all of your load balancers.default DescribeLoadBalancersResponsedescribeLoadBalancers(Consumer<DescribeLoadBalancersRequest.Builder> describeLoadBalancersRequest) Describes the specified load balancers or all of your load balancers.default DescribeLoadBalancersResponsedescribeLoadBalancers(DescribeLoadBalancersRequest describeLoadBalancersRequest) Describes the specified load balancers or all of your load balancers.default DescribeLoadBalancersIterableDescribes the specified load balancers or all of your load balancers.default DescribeLoadBalancersIterabledescribeLoadBalancersPaginator(Consumer<DescribeLoadBalancersRequest.Builder> describeLoadBalancersRequest) Describes the specified load balancers or all of your load balancers.default DescribeLoadBalancersIterabledescribeLoadBalancersPaginator(DescribeLoadBalancersRequest describeLoadBalancersRequest) Describes the specified load balancers or all of your load balancers.default DescribeRulesResponsedescribeRules(Consumer<DescribeRulesRequest.Builder> describeRulesRequest) Describes the specified rules or the rules for the specified listener.default DescribeRulesResponsedescribeRules(DescribeRulesRequest describeRulesRequest) Describes the specified rules or the rules for the specified listener.default DescribeSslPoliciesResponseDescribes the specified policies or all policies used for SSL negotiation.default DescribeSslPoliciesResponsedescribeSSLPolicies(Consumer<DescribeSslPoliciesRequest.Builder> describeSslPoliciesRequest) Describes the specified policies or all policies used for SSL negotiation.default DescribeSslPoliciesResponsedescribeSSLPolicies(DescribeSslPoliciesRequest describeSslPoliciesRequest) Describes the specified policies or all policies used for SSL negotiation.default DescribeTagsResponsedescribeTags(Consumer<DescribeTagsRequest.Builder> describeTagsRequest) Describes the tags for the specified Elastic Load Balancing resources.default DescribeTagsResponsedescribeTags(DescribeTagsRequest describeTagsRequest) Describes the tags for the specified Elastic Load Balancing resources.describeTargetGroupAttributes(Consumer<DescribeTargetGroupAttributesRequest.Builder> describeTargetGroupAttributesRequest) Describes the attributes for the specified target group.describeTargetGroupAttributes(DescribeTargetGroupAttributesRequest describeTargetGroupAttributesRequest) Describes the attributes for the specified target group.default DescribeTargetGroupsResponseDescribes the specified target groups or all of your target groups.default DescribeTargetGroupsResponsedescribeTargetGroups(Consumer<DescribeTargetGroupsRequest.Builder> describeTargetGroupsRequest) Describes the specified target groups or all of your target groups.default DescribeTargetGroupsResponsedescribeTargetGroups(DescribeTargetGroupsRequest describeTargetGroupsRequest) Describes the specified target groups or all of your target groups.default DescribeTargetGroupsIterableDescribes the specified target groups or all of your target groups.default DescribeTargetGroupsIterabledescribeTargetGroupsPaginator(Consumer<DescribeTargetGroupsRequest.Builder> describeTargetGroupsRequest) Describes the specified target groups or all of your target groups.default DescribeTargetGroupsIterabledescribeTargetGroupsPaginator(DescribeTargetGroupsRequest describeTargetGroupsRequest) Describes the specified target groups or all of your target groups.default DescribeTargetHealthResponsedescribeTargetHealth(Consumer<DescribeTargetHealthRequest.Builder> describeTargetHealthRequest) Describes the health of the specified targets or all of your targets.default DescribeTargetHealthResponsedescribeTargetHealth(DescribeTargetHealthRequest describeTargetHealthRequest) Describes the health of the specified targets or all of your targets.default ModifyListenerResponsemodifyListener(Consumer<ModifyListenerRequest.Builder> modifyListenerRequest) Replaces the specified properties of the specified listener.default ModifyListenerResponsemodifyListener(ModifyListenerRequest modifyListenerRequest) Replaces the specified properties of the specified listener.modifyLoadBalancerAttributes(Consumer<ModifyLoadBalancerAttributesRequest.Builder> modifyLoadBalancerAttributesRequest) Modifies the specified attributes of the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer.modifyLoadBalancerAttributes(ModifyLoadBalancerAttributesRequest modifyLoadBalancerAttributesRequest) Modifies the specified attributes of the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer.default ModifyRuleResponsemodifyRule(Consumer<ModifyRuleRequest.Builder> modifyRuleRequest) Replaces the specified properties of the specified rule.default ModifyRuleResponsemodifyRule(ModifyRuleRequest modifyRuleRequest) Replaces the specified properties of the specified rule.default ModifyTargetGroupResponsemodifyTargetGroup(Consumer<ModifyTargetGroupRequest.Builder> modifyTargetGroupRequest) Modifies the health checks used when evaluating the health state of the targets in the specified target group.default ModifyTargetGroupResponsemodifyTargetGroup(ModifyTargetGroupRequest modifyTargetGroupRequest) Modifies the health checks used when evaluating the health state of the targets in the specified target group.modifyTargetGroupAttributes(Consumer<ModifyTargetGroupAttributesRequest.Builder> modifyTargetGroupAttributesRequest) Modifies the specified attributes of the specified target group.modifyTargetGroupAttributes(ModifyTargetGroupAttributesRequest modifyTargetGroupAttributesRequest) Modifies the specified attributes of the specified target group.default RegisterTargetsResponseregisterTargets(Consumer<RegisterTargetsRequest.Builder> registerTargetsRequest) Registers the specified targets with the specified target group.default RegisterTargetsResponseregisterTargets(RegisterTargetsRequest registerTargetsRequest) Registers the specified targets with the specified target group.removeListenerCertificates(Consumer<RemoveListenerCertificatesRequest.Builder> removeListenerCertificatesRequest) Removes the specified certificate from the certificate list for the specified HTTPS or TLS listener.removeListenerCertificates(RemoveListenerCertificatesRequest removeListenerCertificatesRequest) Removes the specified certificate from the certificate list for the specified HTTPS or TLS listener.default RemoveTagsResponseremoveTags(Consumer<RemoveTagsRequest.Builder> removeTagsRequest) Removes the specified tags from the specified Elastic Load Balancing resources.default RemoveTagsResponseremoveTags(RemoveTagsRequest removeTagsRequest) Removes the specified tags from the specified Elastic Load Balancing resources.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadatadefault SetIpAddressTypeResponsesetIpAddressType(Consumer<SetIpAddressTypeRequest.Builder> setIpAddressTypeRequest) Sets the type of IP addresses used by the subnets of the specified load balancer.default SetIpAddressTypeResponsesetIpAddressType(SetIpAddressTypeRequest setIpAddressTypeRequest) Sets the type of IP addresses used by the subnets of the specified load balancer.default SetRulePrioritiesResponsesetRulePriorities(Consumer<SetRulePrioritiesRequest.Builder> setRulePrioritiesRequest) Sets the priorities of the specified rules.default SetRulePrioritiesResponsesetRulePriorities(SetRulePrioritiesRequest setRulePrioritiesRequest) Sets the priorities of the specified rules.default SetSecurityGroupsResponsesetSecurityGroups(Consumer<SetSecurityGroupsRequest.Builder> setSecurityGroupsRequest) Associates the specified security groups with the specified Application Load Balancer or Network Load Balancer.default SetSecurityGroupsResponsesetSecurityGroups(SetSecurityGroupsRequest setSecurityGroupsRequest) Associates the specified security groups with the specified Application Load Balancer or Network Load Balancer.default SetSubnetsResponsesetSubnets(Consumer<SetSubnetsRequest.Builder> setSubnetsRequest) Enables the Availability Zones for the specified public subnets for the specified Application Load Balancer, Network Load Balancer or Gateway Load Balancer.default SetSubnetsResponsesetSubnets(SetSubnetsRequest setSubnetsRequest) Enables the Availability Zones for the specified public subnets for the specified Application Load Balancer, Network Load Balancer or Gateway Load Balancer.default ElasticLoadBalancingV2Waiterwaiter()Create an instance ofElasticLoadBalancingV2Waiterusing this client.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
closeMethods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
-
-
Method Details
-
addListenerCertificates
default AddListenerCertificatesResponse addListenerCertificates(AddListenerCertificatesRequest addListenerCertificatesRequest) throws ListenerNotFoundException, TooManyCertificatesException, CertificateNotFoundException, AwsServiceException, SdkClientException, ElasticLoadBalancingV2Exception Adds the specified SSL server certificate to the certificate list for the specified HTTPS or TLS listener.
If the certificate in already in the certificate list, the call is successful but the certificate is not added again.
For more information, see HTTPS listeners in the Application Load Balancers Guide or TLS listeners in the Network Load Balancers Guide.
- Parameters:
addListenerCertificatesRequest-- Returns:
- Result of the AddListenerCertificates operation returned by the service.
- See Also:
-
addListenerCertificates
default AddListenerCertificatesResponse addListenerCertificates(Consumer<AddListenerCertificatesRequest.Builder> addListenerCertificatesRequest) throws ListenerNotFoundException, TooManyCertificatesException, CertificateNotFoundException, AwsServiceException, SdkClientException, ElasticLoadBalancingV2Exception Adds the specified SSL server certificate to the certificate list for the specified HTTPS or TLS listener.
If the certificate in already in the certificate list, the call is successful but the certificate is not added again.
For more information, see HTTPS listeners in the Application Load Balancers Guide or TLS listeners in the Network Load Balancers Guide.
This is a convenience which creates an instance of the
AddListenerCertificatesRequest.Builderavoiding the need to create one manually viaAddListenerCertificatesRequest.builder()- Parameters:
addListenerCertificatesRequest- AConsumerthat will call methods onAddListenerCertificatesRequest.Builderto create a request.- Returns:
- Result of the AddListenerCertificates operation returned by the service.
- See Also:
-
addTags
default AddTagsResponse addTags(AddTagsRequest addTagsRequest) throws DuplicateTagKeysException, TooManyTagsException, LoadBalancerNotFoundException, TargetGroupNotFoundException, ListenerNotFoundException, RuleNotFoundException, AwsServiceException, SdkClientException, ElasticLoadBalancingV2Exception Adds the specified tags to the specified Elastic Load Balancing resource. You can tag your Application Load Balancers, Network Load Balancers, Gateway Load Balancers, target groups, listeners, and rules.
Each tag consists of a key and an optional value. If a resource already has a tag with the same key,
AddTagsupdates its value.- Parameters:
addTagsRequest-- Returns:
- Result of the AddTags operation returned by the service.
- See Also:
-
addTags
default AddTagsResponse addTags(Consumer<AddTagsRequest.Builder> addTagsRequest) throws DuplicateTagKeysException, TooManyTagsException, LoadBalancerNotFoundException, TargetGroupNotFoundException, ListenerNotFoundException, RuleNotFoundException, AwsServiceException, SdkClientException, ElasticLoadBalancingV2Exception Adds the specified tags to the specified Elastic Load Balancing resource. You can tag your Application Load Balancers, Network Load Balancers, Gateway Load Balancers, target groups, listeners, and rules.
Each tag consists of a key and an optional value. If a resource already has a tag with the same key,
AddTagsupdates its value.
This is a convenience which creates an instance of the
AddTagsRequest.Builderavoiding the need to create one manually viaAddTagsRequest.builder()- Parameters:
addTagsRequest- AConsumerthat will call methods onAddTagsRequest.Builderto create a request.- Returns:
- Result of the AddTags operation returned by the service.
- See Also:
-
createListener
default CreateListenerResponse createListener(CreateListenerRequest createListenerRequest) throws DuplicateListenerException, TooManyListenersException, TooManyCertificatesException, LoadBalancerNotFoundException, TargetGroupNotFoundException, TargetGroupAssociationLimitException, InvalidConfigurationRequestException, IncompatibleProtocolsException, SslPolicyNotFoundException, CertificateNotFoundException, UnsupportedProtocolException, TooManyRegistrationsForTargetIdException, TooManyTargetsException, TooManyActionsException, InvalidLoadBalancerActionException, TooManyUniqueTargetGroupsPerLoadBalancerException, AlpnPolicyNotSupportedException, TooManyTagsException, AwsServiceException, SdkClientException, ElasticLoadBalancingV2Exception Creates a listener for the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer.
For more information, see the following:
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.
- Parameters:
createListenerRequest-- Returns:
- Result of the CreateListener operation returned by the service.
- See Also:
-
createListener
default CreateListenerResponse createListener(Consumer<CreateListenerRequest.Builder> createListenerRequest) throws DuplicateListenerException, TooManyListenersException, TooManyCertificatesException, LoadBalancerNotFoundException, TargetGroupNotFoundException, TargetGroupAssociationLimitException, InvalidConfigurationRequestException, IncompatibleProtocolsException, SslPolicyNotFoundException, CertificateNotFoundException, UnsupportedProtocolException, TooManyRegistrationsForTargetIdException, TooManyTargetsException, TooManyActionsException, InvalidLoadBalancerActionException, TooManyUniqueTargetGroupsPerLoadBalancerException, AlpnPolicyNotSupportedException, TooManyTagsException, AwsServiceException, SdkClientException, ElasticLoadBalancingV2Exception Creates a listener for the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer.
For more information, see the following:
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.
This is a convenience which creates an instance of the
CreateListenerRequest.Builderavoiding the need to create one manually viaCreateListenerRequest.builder()- Parameters:
createListenerRequest- AConsumerthat will call methods onCreateListenerRequest.Builderto create a request.- Returns:
- Result of the CreateListener operation returned by the service.
- See Also:
-
createLoadBalancer
default CreateLoadBalancerResponse createLoadBalancer(CreateLoadBalancerRequest createLoadBalancerRequest) throws DuplicateLoadBalancerNameException, TooManyLoadBalancersException, InvalidConfigurationRequestException, SubnetNotFoundException, InvalidSubnetException, InvalidSecurityGroupException, InvalidSchemeException, TooManyTagsException, DuplicateTagKeysException, ResourceInUseException, AllocationIdNotFoundException, AvailabilityZoneNotSupportedException, OperationNotPermittedException, AwsServiceException, SdkClientException, ElasticLoadBalancingV2Exception Creates an Application Load Balancer, Network Load Balancer, or Gateway Load Balancer.
For more information, see the following:
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.
- Parameters:
createLoadBalancerRequest-- Returns:
- Result of the CreateLoadBalancer operation returned by the service.
- See Also:
-
createLoadBalancer
default CreateLoadBalancerResponse createLoadBalancer(Consumer<CreateLoadBalancerRequest.Builder> createLoadBalancerRequest) throws DuplicateLoadBalancerNameException, TooManyLoadBalancersException, InvalidConfigurationRequestException, SubnetNotFoundException, InvalidSubnetException, InvalidSecurityGroupException, InvalidSchemeException, TooManyTagsException, DuplicateTagKeysException, ResourceInUseException, AllocationIdNotFoundException, AvailabilityZoneNotSupportedException, OperationNotPermittedException, AwsServiceException, SdkClientException, ElasticLoadBalancingV2Exception Creates an Application Load Balancer, Network Load Balancer, or Gateway Load Balancer.
For more information, see the following:
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.
This is a convenience which creates an instance of the
CreateLoadBalancerRequest.Builderavoiding the need to create one manually viaCreateLoadBalancerRequest.builder()- Parameters:
createLoadBalancerRequest- AConsumerthat will call methods onCreateLoadBalancerRequest.Builderto create a request.- Returns:
- Result of the CreateLoadBalancer operation returned by the service.
- See Also:
-
createRule
default CreateRuleResponse createRule(CreateRuleRequest createRuleRequest) throws PriorityInUseException, TooManyTargetGroupsException, TooManyRulesException, TargetGroupAssociationLimitException, IncompatibleProtocolsException, ListenerNotFoundException, TargetGroupNotFoundException, InvalidConfigurationRequestException, TooManyRegistrationsForTargetIdException, TooManyTargetsException, UnsupportedProtocolException, TooManyActionsException, InvalidLoadBalancerActionException, TooManyUniqueTargetGroupsPerLoadBalancerException, TooManyTagsException, AwsServiceException, SdkClientException, ElasticLoadBalancingV2Exception Creates a rule for the specified listener. The listener must be associated with an Application Load Balancer.
Each rule consists of a priority, one or more actions, and one or more conditions. Rules are evaluated in priority order, from the lowest value to the highest value. When the conditions for a rule are met, its actions are performed. If the conditions for no rules are met, the actions for the default rule are performed. For more information, see Listener rules in the Application Load Balancers Guide.
- Parameters:
createRuleRequest-- Returns:
- Result of the CreateRule operation returned by the service.
- See Also:
-
createRule
default CreateRuleResponse createRule(Consumer<CreateRuleRequest.Builder> createRuleRequest) throws PriorityInUseException, TooManyTargetGroupsException, TooManyRulesException, TargetGroupAssociationLimitException, IncompatibleProtocolsException, ListenerNotFoundException, TargetGroupNotFoundException, InvalidConfigurationRequestException, TooManyRegistrationsForTargetIdException, TooManyTargetsException, UnsupportedProtocolException, TooManyActionsException, InvalidLoadBalancerActionException, TooManyUniqueTargetGroupsPerLoadBalancerException, TooManyTagsException, AwsServiceException, SdkClientException, ElasticLoadBalancingV2Exception Creates a rule for the specified listener. The listener must be associated with an Application Load Balancer.
Each rule consists of a priority, one or more actions, and one or more conditions. Rules are evaluated in priority order, from the lowest value to the highest value. When the conditions for a rule are met, its actions are performed. If the conditions for no rules are met, the actions for the default rule are performed. For more information, see Listener rules in the Application Load Balancers Guide.
This is a convenience which creates an instance of the
CreateRuleRequest.Builderavoiding the need to create one manually viaCreateRuleRequest.builder()- Parameters:
createRuleRequest- AConsumerthat will call methods onCreateRuleRequest.Builderto create a request.- Returns:
- Result of the CreateRule operation returned by the service.
- See Also:
-
createTargetGroup
default CreateTargetGroupResponse createTargetGroup(CreateTargetGroupRequest createTargetGroupRequest) throws DuplicateTargetGroupNameException, TooManyTargetGroupsException, InvalidConfigurationRequestException, TooManyTagsException, AwsServiceException, SdkClientException, ElasticLoadBalancingV2Exception Creates a target group.
For more information, see the following:
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.
- Parameters:
createTargetGroupRequest-- Returns:
- Result of the CreateTargetGroup operation returned by the service.
- See Also:
-
createTargetGroup
default CreateTargetGroupResponse createTargetGroup(Consumer<CreateTargetGroupRequest.Builder> createTargetGroupRequest) throws DuplicateTargetGroupNameException, TooManyTargetGroupsException, InvalidConfigurationRequestException, TooManyTagsException, AwsServiceException, SdkClientException, ElasticLoadBalancingV2Exception Creates a target group.
For more information, see the following:
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.
This is a convenience which creates an instance of the
CreateTargetGroupRequest.Builderavoiding the need to create one manually viaCreateTargetGroupRequest.builder()- Parameters:
createTargetGroupRequest- AConsumerthat will call methods onCreateTargetGroupRequest.Builderto create a request.- Returns:
- Result of the CreateTargetGroup operation returned by the service.
- See Also:
-
deleteListener
default DeleteListenerResponse deleteListener(DeleteListenerRequest deleteListenerRequest) throws ListenerNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, ElasticLoadBalancingV2Exception Deletes the specified listener.
Alternatively, your listener is deleted when you delete the load balancer to which it is attached.
- Parameters:
deleteListenerRequest-- Returns:
- Result of the DeleteListener operation returned by the service.
- See Also:
-
deleteListener
default DeleteListenerResponse deleteListener(Consumer<DeleteListenerRequest.Builder> deleteListenerRequest) throws ListenerNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, ElasticLoadBalancingV2Exception Deletes the specified listener.
Alternatively, your listener is deleted when you delete the load balancer to which it is attached.
This is a convenience which creates an instance of the
DeleteListenerRequest.Builderavoiding the need to create one manually viaDeleteListenerRequest.builder()- Parameters:
deleteListenerRequest- AConsumerthat will call methods onDeleteListenerRequest.Builderto create a request.- Returns:
- Result of the DeleteListener operation returned by the service.
- See Also:
-
deleteLoadBalancer
default DeleteLoadBalancerResponse deleteLoadBalancer(DeleteLoadBalancerRequest deleteLoadBalancerRequest) throws LoadBalancerNotFoundException, OperationNotPermittedException, ResourceInUseException, AwsServiceException, SdkClientException, ElasticLoadBalancingV2Exception Deletes the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer. Deleting a load balancer also deletes its 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.
- Parameters:
deleteLoadBalancerRequest-- Returns:
- Result of the DeleteLoadBalancer operation returned by the service.
- See Also:
-
deleteLoadBalancer
default DeleteLoadBalancerResponse deleteLoadBalancer(Consumer<DeleteLoadBalancerRequest.Builder> deleteLoadBalancerRequest) throws LoadBalancerNotFoundException, OperationNotPermittedException, ResourceInUseException, AwsServiceException, SdkClientException, ElasticLoadBalancingV2Exception Deletes the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer. Deleting a load balancer also deletes its listeners.
You can't delete a load balancer if deletion protection is enabled. If the load balancer does not exist or has already been deleted, the call succeeds.
Deleting a load balancer does not affect its registered targets. For example, your EC2 instances continue to run and are still registered to their target groups. If you no longer need these EC2 instances, you can stop or terminate them.
This is a convenience which creates an instance of the
DeleteLoadBalancerRequest.Builderavoiding the need to create one manually viaDeleteLoadBalancerRequest.builder()- Parameters:
deleteLoadBalancerRequest- AConsumerthat will call methods onDeleteLoadBalancerRequest.Builderto create a request.- Returns:
- Result of the DeleteLoadBalancer operation returned by the service.
- See Also:
-
deleteRule
default DeleteRuleResponse deleteRule(DeleteRuleRequest deleteRuleRequest) throws RuleNotFoundException, OperationNotPermittedException, AwsServiceException, SdkClientException, ElasticLoadBalancingV2Exception Deletes the specified rule.
You can't delete the default rule.
- Parameters:
deleteRuleRequest-- Returns:
- Result of the DeleteRule operation returned by the service.
- See Also:
-
deleteRule
default DeleteRuleResponse deleteRule(Consumer<DeleteRuleRequest.Builder> deleteRuleRequest) throws RuleNotFoundException, OperationNotPermittedException, AwsServiceException, SdkClientException, ElasticLoadBalancingV2Exception Deletes the specified rule.
You can't delete the default rule.
This is a convenience which creates an instance of the
DeleteRuleRequest.Builderavoiding the need to create one manually viaDeleteRuleRequest.builder()- Parameters:
deleteRuleRequest- AConsumerthat will call methods onDeleteRuleRequest.Builderto create a request.- Returns:
- Result of the DeleteRule operation returned by the service.
- See Also:
-
deleteTargetGroup
default DeleteTargetGroupResponse deleteTargetGroup(DeleteTargetGroupRequest deleteTargetGroupRequest) throws ResourceInUseException, AwsServiceException, 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. Deleting a target group does not affect its registered targets. For example, any EC2 instances continue to run until you stop or terminate them.
- Parameters:
deleteTargetGroupRequest-- Returns:
- Result of the DeleteTargetGroup operation returned by the service.
- See Also:
-
deleteTargetGroup
default DeleteTargetGroupResponse deleteTargetGroup(Consumer<DeleteTargetGroupRequest.Builder> deleteTargetGroupRequest) throws ResourceInUseException, AwsServiceException, 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. Deleting a target group does not affect its registered targets. For example, any EC2 instances continue to run until you stop or terminate them.
This is a convenience which creates an instance of the
DeleteTargetGroupRequest.Builderavoiding the need to create one manually viaDeleteTargetGroupRequest.builder()- Parameters:
deleteTargetGroupRequest- AConsumerthat will call methods onDeleteTargetGroupRequest.Builderto create a request.- Returns:
- Result of the DeleteTargetGroup operation returned by the service.
- See Also:
-
deregisterTargets
default DeregisterTargetsResponse deregisterTargets(DeregisterTargetsRequest deregisterTargetsRequest) throws TargetGroupNotFoundException, InvalidTargetException, AwsServiceException, 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.
The load balancer stops sending requests to targets that are deregistering, but uses connection draining to ensure that in-flight traffic completes on the existing connections. This deregistration delay is configured by default but can be updated for each target group.
For more information, see the following:
-
Deregistration delay in the Application Load Balancers User Guide
-
Deregistration delay in the Network Load Balancers User Guide
-
Deregistration delay in the Gateway Load Balancers User Guide
Note: If the specified target does not exist, the action returns successfully.
- Parameters:
deregisterTargetsRequest-- Returns:
- Result of the DeregisterTargets operation returned by the service.
- See Also:
-
-
deregisterTargets
default DeregisterTargetsResponse deregisterTargets(Consumer<DeregisterTargetsRequest.Builder> deregisterTargetsRequest) throws TargetGroupNotFoundException, InvalidTargetException, AwsServiceException, 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.
The load balancer stops sending requests to targets that are deregistering, but uses connection draining to ensure that in-flight traffic completes on the existing connections. This deregistration delay is configured by default but can be updated for each target group.
For more information, see the following:
-
Deregistration delay in the Application Load Balancers User Guide
-
Deregistration delay in the Network Load Balancers User Guide
-
Deregistration delay in the Gateway Load Balancers User Guide
Note: If the specified target does not exist, the action returns successfully.
This is a convenience which creates an instance of the
DeregisterTargetsRequest.Builderavoiding the need to create one manually viaDeregisterTargetsRequest.builder()- Parameters:
deregisterTargetsRequest- AConsumerthat will call methods onDeregisterTargetsRequest.Builderto create a request.- Returns:
- Result of the DeregisterTargets operation returned by the service.
- See Also:
-
-
describeAccountLimits
default DescribeAccountLimitsResponse describeAccountLimits(DescribeAccountLimitsRequest describeAccountLimitsRequest) throws AwsServiceException, SdkClientException, ElasticLoadBalancingV2Exception Describes the current Elastic Load Balancing resource limits for your Amazon Web Services account.
For more information, see the following:
- Parameters:
describeAccountLimitsRequest-- Returns:
- Result of the DescribeAccountLimits operation returned by the service.
- See Also:
-
describeAccountLimits
default DescribeAccountLimitsResponse describeAccountLimits(Consumer<DescribeAccountLimitsRequest.Builder> describeAccountLimitsRequest) throws AwsServiceException, SdkClientException, ElasticLoadBalancingV2Exception Describes the current Elastic Load Balancing resource limits for your Amazon Web Services account.
For more information, see the following:
This is a convenience which creates an instance of the
DescribeAccountLimitsRequest.Builderavoiding the need to create one manually viaDescribeAccountLimitsRequest.builder()- Parameters:
describeAccountLimitsRequest- AConsumerthat will call methods onDescribeAccountLimitsRequest.Builderto create a request.- Returns:
- Result of the DescribeAccountLimits operation returned by the service.
- See Also:
-
describeAccountLimits
default DescribeAccountLimitsResponse describeAccountLimits() throws AwsServiceException, SdkClientException, ElasticLoadBalancingV2ExceptionDescribes the current Elastic Load Balancing resource limits for your Amazon Web Services account.
For more information, see the following:
- Returns:
- Result of the DescribeAccountLimits operation returned by the service.
- See Also:
-
describeListenerCertificates
default DescribeListenerCertificatesResponse describeListenerCertificates(DescribeListenerCertificatesRequest describeListenerCertificatesRequest) throws ListenerNotFoundException, AwsServiceException, SdkClientException, ElasticLoadBalancingV2Exception Describes the default certificate and the certificate list for the specified HTTPS or TLS listener.
If the default certificate is also in the certificate list, it appears twice in the results (once with
IsDefaultset to true and once withIsDefaultset to false).For more information, see SSL certificates in the Application Load Balancers Guide or Server certificates in the Network Load Balancers Guide.
- Parameters:
describeListenerCertificatesRequest-- Returns:
- Result of the DescribeListenerCertificates operation returned by the service.
- See Also:
-
describeListenerCertificates
default DescribeListenerCertificatesResponse describeListenerCertificates(Consumer<DescribeListenerCertificatesRequest.Builder> describeListenerCertificatesRequest) throws ListenerNotFoundException, AwsServiceException, SdkClientException, ElasticLoadBalancingV2Exception Describes the default certificate and the certificate list for the specified HTTPS or TLS listener.
If the default certificate is also in the certificate list, it appears twice in the results (once with
IsDefaultset to true and once withIsDefaultset to false).For more information, see SSL certificates in the Application Load Balancers Guide or Server certificates in the Network Load Balancers Guide.
This is a convenience which creates an instance of the
DescribeListenerCertificatesRequest.Builderavoiding the need to create one manually viaDescribeListenerCertificatesRequest.builder()- Parameters:
describeListenerCertificatesRequest- AConsumerthat will call methods onDescribeListenerCertificatesRequest.Builderto create a request.- Returns:
- Result of the DescribeListenerCertificates operation returned by the service.
- See Also:
-
describeListeners
default DescribeListenersResponse describeListeners(DescribeListenersRequest describeListenersRequest) throws ListenerNotFoundException, LoadBalancerNotFoundException, UnsupportedProtocolException, AwsServiceException, SdkClientException, ElasticLoadBalancingV2Exception Describes the specified listeners or the listeners for the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer. You must specify either a load balancer or one or more listeners.
- Parameters:
describeListenersRequest-- Returns:
- Result of the DescribeListeners operation returned by the service.
- See Also:
-
describeListeners
default DescribeListenersResponse describeListeners(Consumer<DescribeListenersRequest.Builder> describeListenersRequest) throws ListenerNotFoundException, LoadBalancerNotFoundException, UnsupportedProtocolException, AwsServiceException, SdkClientException, ElasticLoadBalancingV2Exception Describes the specified listeners or the listeners for the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer. You must specify either a load balancer or one or more listeners.
This is a convenience which creates an instance of the
DescribeListenersRequest.Builderavoiding the need to create one manually viaDescribeListenersRequest.builder()- Parameters:
describeListenersRequest- AConsumerthat will call methods onDescribeListenersRequest.Builderto create a request.- Returns:
- Result of the DescribeListeners operation returned by the service.
- See Also:
-
describeListenersPaginator
default DescribeListenersIterable describeListenersPaginator(DescribeListenersRequest describeListenersRequest) throws ListenerNotFoundException, LoadBalancerNotFoundException, UnsupportedProtocolException, AwsServiceException, SdkClientException, ElasticLoadBalancingV2Exception Describes the specified listeners or the listeners for the specified Application Load Balancer, Network Load Balancer, or Gateway 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
2) Using For loopsoftware.amazon.awssdk.services.elasticloadbalancingv2.paginators.DescribeListenersIterable responses = client.describeListenersPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.amazon.awssdk.services.elasticloadbalancingv2.paginators.DescribeListenersIterable responses = client.describeListenersPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeListeners(software.amazon.awssdk.services.elasticloadbalancingv2.model.DescribeListenersRequest)operation.- Parameters:
describeListenersRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeListenersPaginator
default DescribeListenersIterable describeListenersPaginator(Consumer<DescribeListenersRequest.Builder> describeListenersRequest) throws ListenerNotFoundException, LoadBalancerNotFoundException, UnsupportedProtocolException, AwsServiceException, SdkClientException, ElasticLoadBalancingV2Exception Describes the specified listeners or the listeners for the specified Application Load Balancer, Network Load Balancer, or Gateway 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
2) Using For loopsoftware.amazon.awssdk.services.elasticloadbalancingv2.paginators.DescribeListenersIterable responses = client.describeListenersPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.amazon.awssdk.services.elasticloadbalancingv2.paginators.DescribeListenersIterable responses = client.describeListenersPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeListeners(software.amazon.awssdk.services.elasticloadbalancingv2.model.DescribeListenersRequest)operation.This is a convenience which creates an instance of the
DescribeListenersRequest.Builderavoiding the need to create one manually viaDescribeListenersRequest.builder()- Parameters:
describeListenersRequest- AConsumerthat will call methods onDescribeListenersRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeLoadBalancerAttributes
default DescribeLoadBalancerAttributesResponse describeLoadBalancerAttributes(DescribeLoadBalancerAttributesRequest describeLoadBalancerAttributesRequest) throws LoadBalancerNotFoundException, AwsServiceException, SdkClientException, ElasticLoadBalancingV2Exception Describes the attributes for the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer.
For more information, see the following:
-
Load balancer attributes in the Application Load Balancers Guide
-
Load balancer attributes in the Network Load Balancers Guide
-
Load balancer attributes in the Gateway Load Balancers Guide
- Parameters:
describeLoadBalancerAttributesRequest-- Returns:
- Result of the DescribeLoadBalancerAttributes operation returned by the service.
- See Also:
-
-
describeLoadBalancerAttributes
default DescribeLoadBalancerAttributesResponse describeLoadBalancerAttributes(Consumer<DescribeLoadBalancerAttributesRequest.Builder> describeLoadBalancerAttributesRequest) throws LoadBalancerNotFoundException, AwsServiceException, SdkClientException, ElasticLoadBalancingV2Exception Describes the attributes for the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer.
For more information, see the following:
-
Load balancer attributes in the Application Load Balancers Guide
-
Load balancer attributes in the Network Load Balancers Guide
-
Load balancer attributes in the Gateway Load Balancers Guide
This is a convenience which creates an instance of the
DescribeLoadBalancerAttributesRequest.Builderavoiding the need to create one manually viaDescribeLoadBalancerAttributesRequest.builder()- Parameters:
describeLoadBalancerAttributesRequest- AConsumerthat will call methods onDescribeLoadBalancerAttributesRequest.Builderto create a request.- Returns:
- Result of the DescribeLoadBalancerAttributes operation returned by the service.
- See Also:
-
-
describeLoadBalancers
default DescribeLoadBalancersResponse describeLoadBalancers(DescribeLoadBalancersRequest describeLoadBalancersRequest) throws LoadBalancerNotFoundException, AwsServiceException, SdkClientException, ElasticLoadBalancingV2Exception Describes the specified load balancers or all of your load balancers.
- Parameters:
describeLoadBalancersRequest-- Returns:
- Result of the DescribeLoadBalancers operation returned by the service.
- See Also:
-
describeLoadBalancers
default DescribeLoadBalancersResponse describeLoadBalancers(Consumer<DescribeLoadBalancersRequest.Builder> describeLoadBalancersRequest) throws LoadBalancerNotFoundException, AwsServiceException, SdkClientException, ElasticLoadBalancingV2Exception Describes the specified load balancers or all of your load balancers.
This is a convenience which creates an instance of the
DescribeLoadBalancersRequest.Builderavoiding the need to create one manually viaDescribeLoadBalancersRequest.builder()- Parameters:
describeLoadBalancersRequest- AConsumerthat will call methods onDescribeLoadBalancersRequest.Builderto create a request.- Returns:
- Result of the DescribeLoadBalancers operation returned by the service.
- See Also:
-
describeLoadBalancers
default DescribeLoadBalancersResponse describeLoadBalancers() throws LoadBalancerNotFoundException, AwsServiceException, SdkClientException, ElasticLoadBalancingV2ExceptionDescribes the specified load balancers or all of your load balancers.
- Returns:
- Result of the DescribeLoadBalancers operation returned by the service.
- See Also:
-
describeLoadBalancersPaginator
default DescribeLoadBalancersIterable describeLoadBalancersPaginator() throws LoadBalancerNotFoundException, AwsServiceException, SdkClientException, ElasticLoadBalancingV2ExceptionDescribes the specified load balancers or all of your load balancers.
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
2) Using For loopsoftware.amazon.awssdk.services.elasticloadbalancingv2.paginators.DescribeLoadBalancersIterable responses = client.describeLoadBalancersPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.amazon.awssdk.services.elasticloadbalancingv2.paginators.DescribeLoadBalancersIterable responses = client.describeLoadBalancersPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeLoadBalancers(software.amazon.awssdk.services.elasticloadbalancingv2.model.DescribeLoadBalancersRequest)operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeLoadBalancersPaginator
default DescribeLoadBalancersIterable describeLoadBalancersPaginator(DescribeLoadBalancersRequest describeLoadBalancersRequest) throws LoadBalancerNotFoundException, AwsServiceException, SdkClientException, ElasticLoadBalancingV2Exception Describes the specified load balancers or all of your load balancers.
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
2) Using For loopsoftware.amazon.awssdk.services.elasticloadbalancingv2.paginators.DescribeLoadBalancersIterable responses = client.describeLoadBalancersPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.amazon.awssdk.services.elasticloadbalancingv2.paginators.DescribeLoadBalancersIterable responses = client.describeLoadBalancersPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeLoadBalancers(software.amazon.awssdk.services.elasticloadbalancingv2.model.DescribeLoadBalancersRequest)operation.- Parameters:
describeLoadBalancersRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeLoadBalancersPaginator
default DescribeLoadBalancersIterable describeLoadBalancersPaginator(Consumer<DescribeLoadBalancersRequest.Builder> describeLoadBalancersRequest) throws LoadBalancerNotFoundException, AwsServiceException, SdkClientException, ElasticLoadBalancingV2Exception Describes the specified load balancers or all of your load balancers.
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
2) Using For loopsoftware.amazon.awssdk.services.elasticloadbalancingv2.paginators.DescribeLoadBalancersIterable responses = client.describeLoadBalancersPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.amazon.awssdk.services.elasticloadbalancingv2.paginators.DescribeLoadBalancersIterable responses = client.describeLoadBalancersPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeLoadBalancers(software.amazon.awssdk.services.elasticloadbalancingv2.model.DescribeLoadBalancersRequest)operation.This is a convenience which creates an instance of the
DescribeLoadBalancersRequest.Builderavoiding the need to create one manually viaDescribeLoadBalancersRequest.builder()- Parameters:
describeLoadBalancersRequest- AConsumerthat will call methods onDescribeLoadBalancersRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeRules
default DescribeRulesResponse describeRules(DescribeRulesRequest describeRulesRequest) throws ListenerNotFoundException, RuleNotFoundException, UnsupportedProtocolException, AwsServiceException, SdkClientException, ElasticLoadBalancingV2Exception Describes the specified rules or the rules for the specified listener. You must specify either a listener or one or more rules.
- Parameters:
describeRulesRequest-- Returns:
- Result of the DescribeRules operation returned by the service.
- See Also:
-
describeRules
default DescribeRulesResponse describeRules(Consumer<DescribeRulesRequest.Builder> describeRulesRequest) throws ListenerNotFoundException, RuleNotFoundException, UnsupportedProtocolException, AwsServiceException, SdkClientException, ElasticLoadBalancingV2Exception Describes the specified rules or the rules for the specified listener. You must specify either a listener or one or more rules.
This is a convenience which creates an instance of the
DescribeRulesRequest.Builderavoiding the need to create one manually viaDescribeRulesRequest.builder()- Parameters:
describeRulesRequest- AConsumerthat will call methods onDescribeRulesRequest.Builderto create a request.- Returns:
- Result of the DescribeRules operation returned by the service.
- See Also:
-
describeSSLPolicies
default DescribeSslPoliciesResponse describeSSLPolicies(DescribeSslPoliciesRequest describeSslPoliciesRequest) throws SslPolicyNotFoundException, AwsServiceException, 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 or Security policies in the Network Load Balancers Guide.
- Parameters:
describeSslPoliciesRequest-- Returns:
- Result of the DescribeSSLPolicies operation returned by the service.
- See Also:
-
describeSSLPolicies
default DescribeSslPoliciesResponse describeSSLPolicies(Consumer<DescribeSslPoliciesRequest.Builder> describeSslPoliciesRequest) throws SslPolicyNotFoundException, AwsServiceException, 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 or Security policies in the Network Load Balancers Guide.
This is a convenience which creates an instance of the
DescribeSslPoliciesRequest.Builderavoiding the need to create one manually viaDescribeSslPoliciesRequest.builder()- Parameters:
describeSslPoliciesRequest- AConsumerthat will call methods onDescribeSslPoliciesRequest.Builderto create a request.- Returns:
- Result of the DescribeSSLPolicies operation returned by the service.
- See Also:
-
describeSSLPolicies
default DescribeSslPoliciesResponse describeSSLPolicies() throws SslPolicyNotFoundException, AwsServiceException, SdkClientException, ElasticLoadBalancingV2ExceptionDescribes the specified policies or all policies used for SSL negotiation.
For more information, see Security policies in the Application Load Balancers Guide or Security policies in the Network Load Balancers Guide.
- Returns:
- Result of the DescribeSSLPolicies operation returned by the service.
- See Also:
-
describeTags
default DescribeTagsResponse describeTags(DescribeTagsRequest describeTagsRequest) throws LoadBalancerNotFoundException, TargetGroupNotFoundException, ListenerNotFoundException, RuleNotFoundException, AwsServiceException, SdkClientException, ElasticLoadBalancingV2Exception Describes the tags for the specified Elastic Load Balancing resources. You can describe the tags for one or more Application Load Balancers, Network Load Balancers, Gateway Load Balancers, target groups, listeners, or rules.
- Parameters:
describeTagsRequest-- Returns:
- Result of the DescribeTags operation returned by the service.
- See Also:
-
describeTags
default DescribeTagsResponse describeTags(Consumer<DescribeTagsRequest.Builder> describeTagsRequest) throws LoadBalancerNotFoundException, TargetGroupNotFoundException, ListenerNotFoundException, RuleNotFoundException, AwsServiceException, SdkClientException, ElasticLoadBalancingV2Exception Describes the tags for the specified Elastic Load Balancing resources. You can describe the tags for one or more Application Load Balancers, Network Load Balancers, Gateway Load Balancers, target groups, listeners, or rules.
This is a convenience which creates an instance of the
DescribeTagsRequest.Builderavoiding the need to create one manually viaDescribeTagsRequest.builder()- Parameters:
describeTagsRequest- AConsumerthat will call methods onDescribeTagsRequest.Builderto create a request.- Returns:
- Result of the DescribeTags operation returned by the service.
- See Also:
-
describeTargetGroupAttributes
default DescribeTargetGroupAttributesResponse describeTargetGroupAttributes(DescribeTargetGroupAttributesRequest describeTargetGroupAttributesRequest) throws TargetGroupNotFoundException, AwsServiceException, SdkClientException, ElasticLoadBalancingV2Exception Describes the attributes for the specified target group.
For more information, see the following:
-
Target group attributes in the Application Load Balancers Guide
-
Target group attributes in the Network Load Balancers Guide
-
Target group attributes in the Gateway Load Balancers Guide
- Parameters:
describeTargetGroupAttributesRequest-- Returns:
- Result of the DescribeTargetGroupAttributes operation returned by the service.
- See Also:
-
-
describeTargetGroupAttributes
default DescribeTargetGroupAttributesResponse describeTargetGroupAttributes(Consumer<DescribeTargetGroupAttributesRequest.Builder> describeTargetGroupAttributesRequest) throws TargetGroupNotFoundException, AwsServiceException, SdkClientException, ElasticLoadBalancingV2Exception Describes the attributes for the specified target group.
For more information, see the following:
-
Target group attributes in the Application Load Balancers Guide
-
Target group attributes in the Network Load Balancers Guide
-
Target group attributes in the Gateway Load Balancers Guide
This is a convenience which creates an instance of the
DescribeTargetGroupAttributesRequest.Builderavoiding the need to create one manually viaDescribeTargetGroupAttributesRequest.builder()- Parameters:
describeTargetGroupAttributesRequest- AConsumerthat will call methods onDescribeTargetGroupAttributesRequest.Builderto create a request.- Returns:
- Result of the DescribeTargetGroupAttributes operation returned by the service.
- See Also:
-
-
describeTargetGroups
default DescribeTargetGroupsResponse describeTargetGroups(DescribeTargetGroupsRequest describeTargetGroupsRequest) throws LoadBalancerNotFoundException, TargetGroupNotFoundException, AwsServiceException, 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.
- Parameters:
describeTargetGroupsRequest-- Returns:
- Result of the DescribeTargetGroups operation returned by the service.
- See Also:
-
describeTargetGroups
default DescribeTargetGroupsResponse describeTargetGroups(Consumer<DescribeTargetGroupsRequest.Builder> describeTargetGroupsRequest) throws LoadBalancerNotFoundException, TargetGroupNotFoundException, AwsServiceException, 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.
This is a convenience which creates an instance of the
DescribeTargetGroupsRequest.Builderavoiding the need to create one manually viaDescribeTargetGroupsRequest.builder()- Parameters:
describeTargetGroupsRequest- AConsumerthat will call methods onDescribeTargetGroupsRequest.Builderto create a request.- Returns:
- Result of the DescribeTargetGroups operation returned by the service.
- See Also:
-
describeTargetGroups
default DescribeTargetGroupsResponse describeTargetGroups() throws LoadBalancerNotFoundException, TargetGroupNotFoundException, AwsServiceException, SdkClientException, ElasticLoadBalancingV2ExceptionDescribes 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.
- Returns:
- Result of the DescribeTargetGroups operation returned by the service.
- See Also:
-
describeTargetGroupsPaginator
default DescribeTargetGroupsIterable describeTargetGroupsPaginator() throws LoadBalancerNotFoundException, TargetGroupNotFoundException, AwsServiceException, SdkClientException, ElasticLoadBalancingV2ExceptionDescribes 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.
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
2) Using For loopsoftware.amazon.awssdk.services.elasticloadbalancingv2.paginators.DescribeTargetGroupsIterable responses = client.describeTargetGroupsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.amazon.awssdk.services.elasticloadbalancingv2.paginators.DescribeTargetGroupsIterable responses = client.describeTargetGroupsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeTargetGroups(software.amazon.awssdk.services.elasticloadbalancingv2.model.DescribeTargetGroupsRequest)operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeTargetGroupsPaginator
default DescribeTargetGroupsIterable describeTargetGroupsPaginator(DescribeTargetGroupsRequest describeTargetGroupsRequest) throws LoadBalancerNotFoundException, TargetGroupNotFoundException, AwsServiceException, 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.
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
2) Using For loopsoftware.amazon.awssdk.services.elasticloadbalancingv2.paginators.DescribeTargetGroupsIterable responses = client.describeTargetGroupsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.amazon.awssdk.services.elasticloadbalancingv2.paginators.DescribeTargetGroupsIterable responses = client.describeTargetGroupsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeTargetGroups(software.amazon.awssdk.services.elasticloadbalancingv2.model.DescribeTargetGroupsRequest)operation.- Parameters:
describeTargetGroupsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeTargetGroupsPaginator
default DescribeTargetGroupsIterable describeTargetGroupsPaginator(Consumer<DescribeTargetGroupsRequest.Builder> describeTargetGroupsRequest) throws LoadBalancerNotFoundException, TargetGroupNotFoundException, AwsServiceException, 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.
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
2) Using For loopsoftware.amazon.awssdk.services.elasticloadbalancingv2.paginators.DescribeTargetGroupsIterable responses = client.describeTargetGroupsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.amazon.awssdk.services.elasticloadbalancingv2.paginators.DescribeTargetGroupsIterable responses = client.describeTargetGroupsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeTargetGroups(software.amazon.awssdk.services.elasticloadbalancingv2.model.DescribeTargetGroupsRequest)operation.This is a convenience which creates an instance of the
DescribeTargetGroupsRequest.Builderavoiding the need to create one manually viaDescribeTargetGroupsRequest.builder()- Parameters:
describeTargetGroupsRequest- AConsumerthat will call methods onDescribeTargetGroupsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeTargetHealth
default DescribeTargetHealthResponse describeTargetHealth(DescribeTargetHealthRequest describeTargetHealthRequest) throws InvalidTargetException, TargetGroupNotFoundException, HealthUnavailableException, AwsServiceException, SdkClientException, ElasticLoadBalancingV2Exception Describes the health of the specified targets or all of your targets.
- Parameters:
describeTargetHealthRequest-- Returns:
- Result of the DescribeTargetHealth operation returned by the service.
- See Also:
-
describeTargetHealth
default DescribeTargetHealthResponse describeTargetHealth(Consumer<DescribeTargetHealthRequest.Builder> describeTargetHealthRequest) throws InvalidTargetException, TargetGroupNotFoundException, HealthUnavailableException, AwsServiceException, SdkClientException, ElasticLoadBalancingV2Exception Describes the health of the specified targets or all of your targets.
This is a convenience which creates an instance of the
DescribeTargetHealthRequest.Builderavoiding the need to create one manually viaDescribeTargetHealthRequest.builder()- Parameters:
describeTargetHealthRequest- AConsumerthat will call methods onDescribeTargetHealthRequest.Builderto create a request.- Returns:
- Result of the DescribeTargetHealth operation returned by the service.
- See Also:
-
modifyListener
default ModifyListenerResponse modifyListener(ModifyListenerRequest modifyListenerRequest) throws DuplicateListenerException, TooManyListenersException, TooManyCertificatesException, ListenerNotFoundException, TargetGroupNotFoundException, TargetGroupAssociationLimitException, IncompatibleProtocolsException, SslPolicyNotFoundException, CertificateNotFoundException, InvalidConfigurationRequestException, UnsupportedProtocolException, TooManyRegistrationsForTargetIdException, TooManyTargetsException, TooManyActionsException, InvalidLoadBalancerActionException, TooManyUniqueTargetGroupsPerLoadBalancerException, AlpnPolicyNotSupportedException, AwsServiceException, SdkClientException, ElasticLoadBalancingV2Exception Replaces the specified properties of the specified listener. Any properties that you do not specify remain unchanged.
Changing the protocol from HTTPS to HTTP, or from TLS to TCP, removes the security policy and default certificate properties. If you change the protocol from HTTP to HTTPS, or from TCP to TLS, you must add the security policy and default certificate properties.
To add an item to a list, remove an item from a list, or update an item in a list, you must provide the entire list. For example, to add an action, specify a list with the current actions plus the new action.
- Parameters:
modifyListenerRequest-- Returns:
- Result of the ModifyListener operation returned by the service.
- See Also:
-
modifyListener
default ModifyListenerResponse modifyListener(Consumer<ModifyListenerRequest.Builder> modifyListenerRequest) throws DuplicateListenerException, TooManyListenersException, TooManyCertificatesException, ListenerNotFoundException, TargetGroupNotFoundException, TargetGroupAssociationLimitException, IncompatibleProtocolsException, SslPolicyNotFoundException, CertificateNotFoundException, InvalidConfigurationRequestException, UnsupportedProtocolException, TooManyRegistrationsForTargetIdException, TooManyTargetsException, TooManyActionsException, InvalidLoadBalancerActionException, TooManyUniqueTargetGroupsPerLoadBalancerException, AlpnPolicyNotSupportedException, AwsServiceException, SdkClientException, ElasticLoadBalancingV2Exception Replaces the specified properties of the specified listener. Any properties that you do not specify remain unchanged.
Changing the protocol from HTTPS to HTTP, or from TLS to TCP, removes the security policy and default certificate properties. If you change the protocol from HTTP to HTTPS, or from TCP to TLS, you must add the security policy and default certificate properties.
To add an item to a list, remove an item from a list, or update an item in a list, you must provide the entire list. For example, to add an action, specify a list with the current actions plus the new action.
This is a convenience which creates an instance of the
ModifyListenerRequest.Builderavoiding the need to create one manually viaModifyListenerRequest.builder()- Parameters:
modifyListenerRequest- AConsumerthat will call methods onModifyListenerRequest.Builderto create a request.- Returns:
- Result of the ModifyListener operation returned by the service.
- See Also:
-
modifyLoadBalancerAttributes
default ModifyLoadBalancerAttributesResponse modifyLoadBalancerAttributes(ModifyLoadBalancerAttributesRequest modifyLoadBalancerAttributesRequest) throws LoadBalancerNotFoundException, InvalidConfigurationRequestException, AwsServiceException, SdkClientException, ElasticLoadBalancingV2Exception Modifies the specified attributes of the specified Application Load Balancer, Network Load Balancer, or Gateway 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.
- Parameters:
modifyLoadBalancerAttributesRequest-- Returns:
- Result of the ModifyLoadBalancerAttributes operation returned by the service.
- See Also:
-
modifyLoadBalancerAttributes
default ModifyLoadBalancerAttributesResponse modifyLoadBalancerAttributes(Consumer<ModifyLoadBalancerAttributesRequest.Builder> modifyLoadBalancerAttributesRequest) throws LoadBalancerNotFoundException, InvalidConfigurationRequestException, AwsServiceException, SdkClientException, ElasticLoadBalancingV2Exception Modifies the specified attributes of the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer.
If any of the specified attributes can't be modified as requested, the call fails. Any existing attributes that you do not modify retain their current values.
This is a convenience which creates an instance of the
ModifyLoadBalancerAttributesRequest.Builderavoiding the need to create one manually viaModifyLoadBalancerAttributesRequest.builder()- Parameters:
modifyLoadBalancerAttributesRequest- AConsumerthat will call methods onModifyLoadBalancerAttributesRequest.Builderto create a request.- Returns:
- Result of the ModifyLoadBalancerAttributes operation returned by the service.
- See Also:
-
modifyRule
default ModifyRuleResponse modifyRule(ModifyRuleRequest modifyRuleRequest) throws TargetGroupAssociationLimitException, IncompatibleProtocolsException, RuleNotFoundException, OperationNotPermittedException, TooManyRegistrationsForTargetIdException, TooManyTargetsException, TargetGroupNotFoundException, UnsupportedProtocolException, TooManyActionsException, InvalidLoadBalancerActionException, TooManyUniqueTargetGroupsPerLoadBalancerException, AwsServiceException, SdkClientException, ElasticLoadBalancingV2Exception Replaces the specified properties of the specified rule. Any properties that you do not specify are unchanged.
To add an item to a list, remove an item from a list, or update an item in a list, you must provide the entire list. For example, to add an action, specify a list with the current actions plus the new action.
- Parameters:
modifyRuleRequest-- Returns:
- Result of the ModifyRule operation returned by the service.
- See Also:
-
modifyRule
default ModifyRuleResponse modifyRule(Consumer<ModifyRuleRequest.Builder> modifyRuleRequest) throws TargetGroupAssociationLimitException, IncompatibleProtocolsException, RuleNotFoundException, OperationNotPermittedException, TooManyRegistrationsForTargetIdException, TooManyTargetsException, TargetGroupNotFoundException, UnsupportedProtocolException, TooManyActionsException, InvalidLoadBalancerActionException, TooManyUniqueTargetGroupsPerLoadBalancerException, AwsServiceException, SdkClientException, ElasticLoadBalancingV2Exception Replaces the specified properties of the specified rule. Any properties that you do not specify are unchanged.
To add an item to a list, remove an item from a list, or update an item in a list, you must provide the entire list. For example, to add an action, specify a list with the current actions plus the new action.
This is a convenience which creates an instance of the
ModifyRuleRequest.Builderavoiding the need to create one manually viaModifyRuleRequest.builder()- Parameters:
modifyRuleRequest- AConsumerthat will call methods onModifyRuleRequest.Builderto create a request.- Returns:
- Result of the ModifyRule operation returned by the service.
- See Also:
-
modifyTargetGroup
default ModifyTargetGroupResponse modifyTargetGroup(ModifyTargetGroupRequest modifyTargetGroupRequest) throws TargetGroupNotFoundException, InvalidConfigurationRequestException, AwsServiceException, SdkClientException, ElasticLoadBalancingV2Exception Modifies the health checks used when evaluating the health state of the targets in the specified target group.
- Parameters:
modifyTargetGroupRequest-- Returns:
- Result of the ModifyTargetGroup operation returned by the service.
- See Also:
-
modifyTargetGroup
default ModifyTargetGroupResponse modifyTargetGroup(Consumer<ModifyTargetGroupRequest.Builder> modifyTargetGroupRequest) throws TargetGroupNotFoundException, InvalidConfigurationRequestException, AwsServiceException, SdkClientException, ElasticLoadBalancingV2Exception Modifies the health checks used when evaluating the health state of the targets in the specified target group.
This is a convenience which creates an instance of the
ModifyTargetGroupRequest.Builderavoiding the need to create one manually viaModifyTargetGroupRequest.builder()- Parameters:
modifyTargetGroupRequest- AConsumerthat will call methods onModifyTargetGroupRequest.Builderto create a request.- Returns:
- Result of the ModifyTargetGroup operation returned by the service.
- See Also:
-
modifyTargetGroupAttributes
default ModifyTargetGroupAttributesResponse modifyTargetGroupAttributes(ModifyTargetGroupAttributesRequest modifyTargetGroupAttributesRequest) throws TargetGroupNotFoundException, InvalidConfigurationRequestException, AwsServiceException, SdkClientException, ElasticLoadBalancingV2Exception Modifies the specified attributes of the specified target group.
- Parameters:
modifyTargetGroupAttributesRequest-- Returns:
- Result of the ModifyTargetGroupAttributes operation returned by the service.
- See Also:
-
modifyTargetGroupAttributes
default ModifyTargetGroupAttributesResponse modifyTargetGroupAttributes(Consumer<ModifyTargetGroupAttributesRequest.Builder> modifyTargetGroupAttributesRequest) throws TargetGroupNotFoundException, InvalidConfigurationRequestException, AwsServiceException, SdkClientException, ElasticLoadBalancingV2Exception Modifies the specified attributes of the specified target group.
This is a convenience which creates an instance of the
ModifyTargetGroupAttributesRequest.Builderavoiding the need to create one manually viaModifyTargetGroupAttributesRequest.builder()- Parameters:
modifyTargetGroupAttributesRequest- AConsumerthat will call methods onModifyTargetGroupAttributesRequest.Builderto create a request.- Returns:
- Result of the ModifyTargetGroupAttributes operation returned by the service.
- See Also:
-
registerTargets
default RegisterTargetsResponse registerTargets(RegisterTargetsRequest registerTargetsRequest) throws TargetGroupNotFoundException, TooManyTargetsException, InvalidTargetException, TooManyRegistrationsForTargetIdException, AwsServiceException, SdkClientException, ElasticLoadBalancingV2Exception Registers the specified targets with the specified target group.
If the target is an EC2 instance, it must be in the
runningstate 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.
- Parameters:
registerTargetsRequest-- Returns:
- Result of the RegisterTargets operation returned by the service.
- See Also:
-
registerTargets
default RegisterTargetsResponse registerTargets(Consumer<RegisterTargetsRequest.Builder> registerTargetsRequest) throws TargetGroupNotFoundException, TooManyTargetsException, InvalidTargetException, TooManyRegistrationsForTargetIdException, AwsServiceException, SdkClientException, ElasticLoadBalancingV2Exception Registers the specified targets with the specified target group.
If the target is an EC2 instance, it must be in the
runningstate 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.
This is a convenience which creates an instance of the
RegisterTargetsRequest.Builderavoiding the need to create one manually viaRegisterTargetsRequest.builder()- Parameters:
registerTargetsRequest- AConsumerthat will call methods onRegisterTargetsRequest.Builderto create a request.- Returns:
- Result of the RegisterTargets operation returned by the service.
- See Also:
-
removeListenerCertificates
default RemoveListenerCertificatesResponse removeListenerCertificates(RemoveListenerCertificatesRequest removeListenerCertificatesRequest) throws ListenerNotFoundException, OperationNotPermittedException, AwsServiceException, SdkClientException, ElasticLoadBalancingV2Exception Removes the specified certificate from the certificate list for the specified HTTPS or TLS listener.
- Parameters:
removeListenerCertificatesRequest-- Returns:
- Result of the RemoveListenerCertificates operation returned by the service.
- See Also:
-
removeListenerCertificates
default RemoveListenerCertificatesResponse removeListenerCertificates(Consumer<RemoveListenerCertificatesRequest.Builder> removeListenerCertificatesRequest) throws ListenerNotFoundException, OperationNotPermittedException, AwsServiceException, SdkClientException, ElasticLoadBalancingV2Exception Removes the specified certificate from the certificate list for the specified HTTPS or TLS listener.
This is a convenience which creates an instance of the
RemoveListenerCertificatesRequest.Builderavoiding the need to create one manually viaRemoveListenerCertificatesRequest.builder()- Parameters:
removeListenerCertificatesRequest- AConsumerthat will call methods onRemoveListenerCertificatesRequest.Builderto create a request.- Returns:
- Result of the RemoveListenerCertificates operation returned by the service.
- See Also:
-
removeTags
default RemoveTagsResponse removeTags(RemoveTagsRequest removeTagsRequest) throws LoadBalancerNotFoundException, TargetGroupNotFoundException, ListenerNotFoundException, RuleNotFoundException, TooManyTagsException, AwsServiceException, SdkClientException, ElasticLoadBalancingV2Exception Removes the specified tags from the specified Elastic Load Balancing resources. You can remove the tags for one or more Application Load Balancers, Network Load Balancers, Gateway Load Balancers, target groups, listeners, or rules.
- Parameters:
removeTagsRequest-- Returns:
- Result of the RemoveTags operation returned by the service.
- See Also:
-
removeTags
default RemoveTagsResponse removeTags(Consumer<RemoveTagsRequest.Builder> removeTagsRequest) throws LoadBalancerNotFoundException, TargetGroupNotFoundException, ListenerNotFoundException, RuleNotFoundException, TooManyTagsException, AwsServiceException, SdkClientException, ElasticLoadBalancingV2Exception Removes the specified tags from the specified Elastic Load Balancing resources. You can remove the tags for one or more Application Load Balancers, Network Load Balancers, Gateway Load Balancers, target groups, listeners, or rules.
This is a convenience which creates an instance of the
RemoveTagsRequest.Builderavoiding the need to create one manually viaRemoveTagsRequest.builder()- Parameters:
removeTagsRequest- AConsumerthat will call methods onRemoveTagsRequest.Builderto create a request.- Returns:
- Result of the RemoveTags operation returned by the service.
- See Also:
-
setIpAddressType
default SetIpAddressTypeResponse setIpAddressType(SetIpAddressTypeRequest setIpAddressTypeRequest) throws LoadBalancerNotFoundException, InvalidConfigurationRequestException, InvalidSubnetException, AwsServiceException, SdkClientException, ElasticLoadBalancingV2Exception Sets the type of IP addresses used by the subnets of the specified load balancer.
- Parameters:
setIpAddressTypeRequest-- Returns:
- Result of the SetIpAddressType operation returned by the service.
- See Also:
-
setIpAddressType
default SetIpAddressTypeResponse setIpAddressType(Consumer<SetIpAddressTypeRequest.Builder> setIpAddressTypeRequest) throws LoadBalancerNotFoundException, InvalidConfigurationRequestException, InvalidSubnetException, AwsServiceException, SdkClientException, ElasticLoadBalancingV2Exception Sets the type of IP addresses used by the subnets of the specified load balancer.
This is a convenience which creates an instance of the
SetIpAddressTypeRequest.Builderavoiding the need to create one manually viaSetIpAddressTypeRequest.builder()- Parameters:
setIpAddressTypeRequest- AConsumerthat will call methods onSetIpAddressTypeRequest.Builderto create a request.- Returns:
- Result of the SetIpAddressType operation returned by the service.
- See Also:
-
setRulePriorities
default SetRulePrioritiesResponse setRulePriorities(SetRulePrioritiesRequest setRulePrioritiesRequest) throws RuleNotFoundException, PriorityInUseException, OperationNotPermittedException, AwsServiceException, 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.
- Parameters:
setRulePrioritiesRequest-- Returns:
- Result of the SetRulePriorities operation returned by the service.
- See Also:
-
setRulePriorities
default SetRulePrioritiesResponse setRulePriorities(Consumer<SetRulePrioritiesRequest.Builder> setRulePrioritiesRequest) throws RuleNotFoundException, PriorityInUseException, OperationNotPermittedException, AwsServiceException, 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.
This is a convenience which creates an instance of the
SetRulePrioritiesRequest.Builderavoiding the need to create one manually viaSetRulePrioritiesRequest.builder()- Parameters:
setRulePrioritiesRequest- AConsumerthat will call methods onSetRulePrioritiesRequest.Builderto create a request.- Returns:
- Result of the SetRulePriorities operation returned by the service.
- See Also:
-
setSecurityGroups
default SetSecurityGroupsResponse setSecurityGroups(SetSecurityGroupsRequest setSecurityGroupsRequest) throws LoadBalancerNotFoundException, InvalidConfigurationRequestException, InvalidSecurityGroupException, AwsServiceException, SdkClientException, ElasticLoadBalancingV2Exception Associates the specified security groups with the specified Application Load Balancer or Network Load Balancer. The specified security groups override the previously associated security groups.
You can't perform this operation on a Network Load Balancer unless you specified a security group for the load balancer when you created it.
You can't associate a security group with a Gateway Load Balancer.
- Parameters:
setSecurityGroupsRequest-- Returns:
- Result of the SetSecurityGroups operation returned by the service.
- See Also:
-
setSecurityGroups
default SetSecurityGroupsResponse setSecurityGroups(Consumer<SetSecurityGroupsRequest.Builder> setSecurityGroupsRequest) throws LoadBalancerNotFoundException, InvalidConfigurationRequestException, InvalidSecurityGroupException, AwsServiceException, SdkClientException, ElasticLoadBalancingV2Exception Associates the specified security groups with the specified Application Load Balancer or Network Load Balancer. The specified security groups override the previously associated security groups.
You can't perform this operation on a Network Load Balancer unless you specified a security group for the load balancer when you created it.
You can't associate a security group with a Gateway Load Balancer.
This is a convenience which creates an instance of the
SetSecurityGroupsRequest.Builderavoiding the need to create one manually viaSetSecurityGroupsRequest.builder()- Parameters:
setSecurityGroupsRequest- AConsumerthat will call methods onSetSecurityGroupsRequest.Builderto create a request.- Returns:
- Result of the SetSecurityGroups operation returned by the service.
- See Also:
-
setSubnets
default SetSubnetsResponse setSubnets(SetSubnetsRequest setSubnetsRequest) throws LoadBalancerNotFoundException, InvalidConfigurationRequestException, SubnetNotFoundException, InvalidSubnetException, AllocationIdNotFoundException, AvailabilityZoneNotSupportedException, AwsServiceException, SdkClientException, ElasticLoadBalancingV2Exception Enables the Availability Zones for the specified public subnets for the specified Application Load Balancer, Network Load Balancer or Gateway Load Balancer. The specified subnets replace the previously enabled subnets.
When you specify subnets for a Network Load Balancer, or Gateway Load Balancer you must include all subnets that were enabled previously, with their existing configurations, plus any additional subnets.
- Parameters:
setSubnetsRequest-- Returns:
- Result of the SetSubnets operation returned by the service.
- See Also:
-
setSubnets
default SetSubnetsResponse setSubnets(Consumer<SetSubnetsRequest.Builder> setSubnetsRequest) throws LoadBalancerNotFoundException, InvalidConfigurationRequestException, SubnetNotFoundException, InvalidSubnetException, AllocationIdNotFoundException, AvailabilityZoneNotSupportedException, AwsServiceException, SdkClientException, ElasticLoadBalancingV2Exception Enables the Availability Zones for the specified public subnets for the specified Application Load Balancer, Network Load Balancer or Gateway Load Balancer. The specified subnets replace the previously enabled subnets.
When you specify subnets for a Network Load Balancer, or Gateway Load Balancer you must include all subnets that were enabled previously, with their existing configurations, plus any additional subnets.
This is a convenience which creates an instance of the
SetSubnetsRequest.Builderavoiding the need to create one manually viaSetSubnetsRequest.builder()- Parameters:
setSubnetsRequest- AConsumerthat will call methods onSetSubnetsRequest.Builderto create a request.- Returns:
- Result of the SetSubnets operation returned by the service.
- See Also:
-
waiter
Create an instance ofElasticLoadBalancingV2Waiterusing this client.Waiters created via this method are managed by the SDK and resources will be released when the service client is closed.
- Returns:
- an instance of
ElasticLoadBalancingV2Waiter
-
create
Create aElasticLoadBalancingV2Clientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider. -
builder
Create a builder that can be used to configure and create aElasticLoadBalancingV2Client. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClientThe SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient- Returns:
- SdkServiceClientConfiguration
-