com.amazonaws.services.elasticloadbalancingv2.AmazonElasticLoadBalancing Maven / Gradle / Ivy
Show all versions of aws-java-sdk-elasticloadbalancingv2 Show documentation
/*
* Copyright 2011-2016 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not
* use this file except in compliance with the License. A copy of the License is
* located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on
* an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
package com.amazonaws.services.elasticloadbalancingv2;
import com.amazonaws.*;
import com.amazonaws.regions.*;
import com.amazonaws.services.elasticloadbalancingv2.model.*;
/**
* Interface for accessing Elastic Load Balancing v2.
*
* Elastic Load Balancing
*
* A load balancer distributes incoming traffic across targets, such as your EC2
* instances. This enables you to increase the availability of your application.
* The load balancer also monitors the health of its registered targets and
* ensures that it routes traffic only to healthy targets. You configure your
* load balancer to accept incoming traffic by specifying one or more listeners,
* which are configured with a protocol and port number for connections from
* clients to the load balancer. You configure a target group with a protocol
* and port number for connections from the load balancer to the targets, and
* with health check settings to be used when checking the health status of the
* targets.
*
*
* Elastic Load Balancing supports two types of load balancers: Classic load
* balancers and Application load balancers (new). A Classic load balancer makes
* routing and load balancing decisions either at the transport layer (TCP/SSL)
* or the application layer (HTTP/HTTPS), and supports either EC2-Classic or a
* VPC. An Application load balancer makes routing and load balancing decisions
* at the application layer (HTTP/HTTPS), supports path-based routing, and can
* route requests to one or more ports on each EC2 instance or container
* instance in your virtual private cloud (VPC). For more information, see the
*
* Elastic Load Balancing User Guide.
*
*
* This reference covers the 2015-12-01 API, which supports Application load
* balancers. The 2012-06-01 API supports Classic load balancers.
*
*
* To get started with an Application load balancer, complete the following
* tasks:
*
*
* -
*
* Create a load balancer using CreateLoadBalancer.
*
*
* -
*
* Create a target group using CreateTargetGroup.
*
*
* -
*
* Register targets for the target group using RegisterTargets.
*
*
* -
*
* Create one or more listeners for your load balancer using
* CreateListener.
*
*
* -
*
* (Optional) Create one or more rules for content routing based on URL using
* CreateRule.
*
*
*
*
* To delete an Application load balancer and its related resources, complete
* the following tasks:
*
*
* -
*
* Delete the load balancer using DeleteLoadBalancer.
*
*
* -
*
* Delete the target group using DeleteTargetGroup.
*
*
*
*
* All Elastic Load Balancing operations are idempotent, which means that they
* complete at most one time. If you repeat an operation, it succeeds.
*
*/
public interface AmazonElasticLoadBalancing {
/**
* The region metadata service name for computing region endpoints. You can
* use this value to retrieve metadata (such as supported regions) of the
* service.
*
* @see RegionUtils#getRegionsForService(String)
*/
String ENDPOINT_PREFIX = "elasticloadbalancing";
/**
* Overrides the default endpoint for this client
* ("elasticloadbalancing.us-east-1.amazonaws.com"). Callers can use this
* method to control which AWS region they want to work with.
*
* Callers can pass in just the endpoint (ex:
* "elasticloadbalancing.us-east-1.amazonaws.com") or a full URL, including
* the protocol (ex: "elasticloadbalancing.us-east-1.amazonaws.com"). If the
* protocol is not specified here, the default protocol from this client's
* {@link ClientConfiguration} will be used, which by default is HTTPS.
*
* For more information on using AWS regions with the AWS SDK for Java, and
* a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID=
* 3912
*
* This method is not threadsafe. An endpoint should be configured when
* the client is created and before any service requests are made. Changing
* it afterwards creates inevitable race conditions for any service requests
* in transit or retrying.
*
* @param endpoint
* The endpoint (ex: "elasticloadbalancing.us-east-1.amazonaws.com")
* or a full URL, including the protocol (ex:
* "elasticloadbalancing.us-east-1.amazonaws.com") of the region
* specific AWS endpoint this client will communicate with.
*/
void setEndpoint(String endpoint);
/**
* An alternative to {@link AmazonElasticLoadBalancing#setEndpoint(String)},
* sets the regional endpoint for this client's service calls. Callers can
* use this method to control which AWS region they want to work with.
*
* By default, all service endpoints in all regions use the https protocol.
* To use http instead, specify it in the {@link ClientConfiguration}
* supplied at construction.
*
* This method is not threadsafe. A region should be configured when the
* client is created and before any service requests are made. Changing it
* afterwards creates inevitable race conditions for any service requests in
* transit or retrying.
*
* @param region
* The region this client will communicate with. See
* {@link Region#getRegion(com.amazonaws.regions.Regions)} for
* accessing a given region. Must not be null and must be a region
* where the service is available.
*
* @see Region#getRegion(com.amazonaws.regions.Regions)
* @see Region#createClient(Class,
* com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
* @see Region#isServiceSupported(String)
*/
void setRegion(Region region);
/**
*
* Adds the specified tags to the specified resource. You can tag your
* Application load balancers and your target groups.
*
*
* Each tag consists of a key and an optional value. If a resource already
* has a tag with the same key, AddTags updates its value.
*
*
* To list the current tags for your resources, use DescribeTags. To
* remove tags from your resources, use RemoveTags.
*
*
* @param addTagsRequest
* Contains the parameters for AddTags.
* @return Result of the AddTags operation returned by the service.
* @throws DuplicateTagKeysException
* A tag key was specified more than once.
* @throws TooManyTagsException
* You've reached the limit on the number of tags per load balancer.
* @throws LoadBalancerNotFoundException
* The specified load balancer does not exist.
* @throws TargetGroupNotFoundException
* The specified target group does not exist.
* @sample AmazonElasticLoadBalancing.AddTags
*/
AddTagsResult addTags(AddTagsRequest addTagsRequest);
/**
*
* Creates a listener for the specified Application load balancer.
*
*
* To update a listener, use ModifyListener. When you are finished
* with a listener, you can delete it using DeleteListener. If you
* are finished with both the listener and the load balancer, you can delete
* them both using DeleteLoadBalancer.
*
*
* For more information, see Listeners for Your Application Load Balancers in the Application
* Load Balancers Guide.
*
*
* @param createListenerRequest
* Contains the parameters for CreateListener.
* @return Result of the CreateListener operation returned by the service.
* @throws DuplicateListenerException
* A listener with the specified port already exists.
* @throws TooManyListenersException
* You've reached the limit on the number of listeners per load
* balancer.
* @throws TooManyCertificatesException
* You've reached the limit on the number of certificates per
* listener.
* @throws LoadBalancerNotFoundException
* The specified load balancer does not exist.
* @throws TargetGroupNotFoundException
* The specified target group does not exist.
* @throws TargetGroupAssociationLimitException
* You've reached the limit on the number of load balancers per
* target group.
* @throws InvalidConfigurationRequestException
* The requested configuration is not valid.
* @throws IncompatibleProtocolsException
* The specified configuration is not valid with this protocol.
* @throws SSLPolicyNotFoundException
* The specified SSL policy does not exist.
* @throws CertificateNotFoundException
* The specified certificate does not exist.
* @throws UnsupportedProtocolException
* The specified protocol is not supported.
* @throws TooManyRegistrationsForTargetIdException
* You've reached the limit on the number of times a target can be
* registered with a load balancer.
* @sample AmazonElasticLoadBalancing.CreateListener
*/
CreateListenerResult createListener(
CreateListenerRequest createListenerRequest);
/**
*
* Creates an Application load balancer.
*
*
* To create listeners for your load balancer, use CreateListener.
* You can add security groups, subnets, and tags when you create your load
* balancer, or you can add them later using SetSecurityGroups,
* SetSubnets, and AddTags.
*
*
* To describe your current load balancers, see
* DescribeLoadBalancers. When you are finished with a load balancer,
* you can delete it using DeleteLoadBalancer.
*
*
* You can create up to 20 load balancers per region per account. You can
* request an increase for the number of load balancers for your account.
* For more information, see Limits for Your Application Load Balancer in the Application Load
* Balancers Guide.
*
*
* @param createLoadBalancerRequest
* Contains the parameters for CreateLoadBalancer.
* @return Result of the CreateLoadBalancer operation returned by the
* service.
* @throws DuplicateLoadBalancerNameException
* A load balancer with the specified name already exists for this
* account.
* @throws TooManyLoadBalancersException
* You've reached the limit on the number of load balancers for your
* AWS account.
* @throws InvalidConfigurationRequestException
* The requested configuration is not valid.
* @throws SubnetNotFoundException
* The specified subnet does not exist.
* @throws InvalidSubnetException
* The specified subnet is out of available addresses.
* @throws InvalidSecurityGroupException
* The specified security group does not exist.
* @throws InvalidSchemeException
* The requested scheme is not valid.
* @throws TooManyTagsException
* You've reached the limit on the number of tags per load balancer.
* @throws DuplicateTagKeysException
* A tag key was specified more than once.
* @sample AmazonElasticLoadBalancing.CreateLoadBalancer
*/
CreateLoadBalancerResult createLoadBalancer(
CreateLoadBalancerRequest createLoadBalancerRequest);
/**
*
* Creates a rule for the specified listener.
*
*
* A rule consists conditions and actions. Rules are evaluated in priority
* order, from the lowest value to the highest value. When the conditions
* for a rule are met, the specified actions are taken. If no rule's
* conditions are met, the default actions for the listener are taken.
*
*
* To view your current rules, use DescribeRules. To update a rule,
* use ModifyRule. To set the priorities of your rules, use
* SetRulePriorities. To delete a rule, use DeleteRule.
*
*
* @param createRuleRequest
* Contains the parameters for CreateRule.
* @return Result of the CreateRule operation returned by the service.
* @throws PriorityInUseException
* The specified priority is in use.
* @throws TooManyTargetGroupsException
* You've reached the limit on the number of target groups for your
* AWS account.
* @throws TooManyRulesException
* You've reached the limit on the number of rules per load
* balancer.
* @throws TargetGroupAssociationLimitException
* You've reached the limit on the number of load balancers per
* target group.
* @throws ListenerNotFoundException
* The specified listener does not exist.
* @throws TargetGroupNotFoundException
* The specified target group does not exist.
* @throws InvalidConfigurationRequestException
* The requested configuration is not valid.
* @throws TooManyRegistrationsForTargetIdException
* You've reached the limit on the number of times a target can be
* registered with a load balancer.
* @sample AmazonElasticLoadBalancing.CreateRule
*/
CreateRuleResult createRule(CreateRuleRequest createRuleRequest);
/**
*
* Creates a target group.
*
*
* To register targets with the target group, use RegisterTargets. To
* update the health check settings for the target group, use
* ModifyTargetGroup. To monitor the health of targets in the target
* group, use DescribeTargetHealth.
*
*
* To route traffic to the targets in a target group, specify the target
* group in an action using CreateListener or CreateRule.
*
*
* To delete a target group, use DeleteTargetGroup.
*
*
* For more information, see Target Groups for Your Application Load Balancers in the
* Application Load Balancers Guide.
*
*
* @param createTargetGroupRequest
* Contains the parameters for CreateTargetGroup.
* @return Result of the CreateTargetGroup operation returned by the
* service.
* @throws DuplicateTargetGroupNameException
* A target group with the specified name already exists.
* @throws TooManyTargetGroupsException
* You've reached the limit on the number of target groups for your
* AWS account.
* @sample AmazonElasticLoadBalancing.CreateTargetGroup
*/
CreateTargetGroupResult createTargetGroup(
CreateTargetGroupRequest createTargetGroupRequest);
/**
*
* Deletes the specified listener.
*
*
* Alternatively, your listener is deleted when you delete the load balancer
* it is attached to using DeleteLoadBalancer.
*
*
* @param deleteListenerRequest
* Contains the parameters for DeleteListener.
* @return Result of the DeleteListener operation returned by the service.
* @throws ListenerNotFoundException
* The specified listener does not exist.
* @sample AmazonElasticLoadBalancing.DeleteListener
*/
DeleteListenerResult deleteListener(
DeleteListenerRequest deleteListenerRequest);
/**
*
* Deletes the specified load balancer and its attached listeners.
*
*
* You can't delete a load balancer if deletion protection is enabled. If
* the load balancer does not exist or has already been deleted, the call
* succeeds.
*
*
* Deleting a load balancer does not affect its registered targets. For
* example, your EC2 instances continue to run and are still registered to
* their target groups. If you no longer need these EC2 instances, you can
* stop or terminate them.
*
*
* @param deleteLoadBalancerRequest
* Contains the parameters for DeleteLoadBalancer.
* @return Result of the DeleteLoadBalancer operation returned by the
* service.
* @throws LoadBalancerNotFoundException
* The specified load balancer does not exist.
* @throws OperationNotPermittedException
* This operation is not allowed.
* @sample AmazonElasticLoadBalancing.DeleteLoadBalancer
*/
DeleteLoadBalancerResult deleteLoadBalancer(
DeleteLoadBalancerRequest deleteLoadBalancerRequest);
/**
*
* Deletes the specified rule.
*
*
* @param deleteRuleRequest
* Contains the parameters for DeleteRule.
* @return Result of the DeleteRule operation returned by the service.
* @throws RuleNotFoundException
* The specified rule does not exist.
* @throws OperationNotPermittedException
* This operation is not allowed.
* @sample AmazonElasticLoadBalancing.DeleteRule
*/
DeleteRuleResult deleteRule(DeleteRuleRequest deleteRuleRequest);
/**
*
* 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.
*
*
* @param deleteTargetGroupRequest
* Contains the parameters for DeleteTargetGroup.
* @return Result of the DeleteTargetGroup operation returned by the
* service.
* @throws ResourceInUseException
* A specified resource is in use.
* @sample AmazonElasticLoadBalancing.DeleteTargetGroup
*/
DeleteTargetGroupResult deleteTargetGroup(
DeleteTargetGroupRequest deleteTargetGroupRequest);
/**
*
* Deregisters the specified targets from the specified target group. After
* the targets are deregistered, they no longer receive traffic from the
* load balancer.
*
*
* @param deregisterTargetsRequest
* Contains the parameters for DeregisterTargets.
* @return Result of the DeregisterTargets operation returned by the
* service.
* @throws TargetGroupNotFoundException
* The specified target group does not exist.
* @throws InvalidTargetException
* The specified target does not exist or is not in the same VPC as
* the target group.
* @sample AmazonElasticLoadBalancing.DeregisterTargets
*/
DeregisterTargetsResult deregisterTargets(
DeregisterTargetsRequest deregisterTargetsRequest);
/**
*
* Describes the specified listeners or the listeners for the specified load
* balancer. You must specify either a load balancer or one or more
* listeners.
*
*
* @param describeListenersRequest
* Contains the parameters for DescribeListeners.
* @return Result of the DescribeListeners operation returned by the
* service.
* @throws ListenerNotFoundException
* The specified listener does not exist.
* @throws LoadBalancerNotFoundException
* The specified load balancer does not exist.
* @sample AmazonElasticLoadBalancing.DescribeListeners
*/
DescribeListenersResult describeListeners(
DescribeListenersRequest describeListenersRequest);
/**
*
* Describes the attributes for the specified load balancer.
*
*
* @param describeLoadBalancerAttributesRequest
* Contains the parameters for DescribeLoadBalancerAttributes.
* @return Result of the DescribeLoadBalancerAttributes operation returned
* by the service.
* @throws LoadBalancerNotFoundException
* The specified load balancer does not exist.
* @sample AmazonElasticLoadBalancing.DescribeLoadBalancerAttributes
*/
DescribeLoadBalancerAttributesResult describeLoadBalancerAttributes(
DescribeLoadBalancerAttributesRequest describeLoadBalancerAttributesRequest);
/**
*
* Describes the specified Application load balancers or all of your
* Application load balancers.
*
*
* To describe the listeners for a load balancer, use
* DescribeListeners. To describe the attributes for a load balancer,
* use DescribeLoadBalancerAttributes.
*
*
* @param describeLoadBalancersRequest
* Contains the parameters for DescribeLoadBalancers.
* @return Result of the DescribeLoadBalancers operation returned by the
* service.
* @throws LoadBalancerNotFoundException
* The specified load balancer does not exist.
* @sample AmazonElasticLoadBalancing.DescribeLoadBalancers
*/
DescribeLoadBalancersResult describeLoadBalancers(
DescribeLoadBalancersRequest describeLoadBalancersRequest);
/**
*
* Describes the specified rules or the rules for the specified listener.
* You must specify either a listener or one or more rules.
*
*
* @param describeRulesRequest
* Contains the parameters for DescribeRules.
* @return Result of the DescribeRules operation returned by the service.
* @throws ListenerNotFoundException
* The specified listener does not exist.
* @throws RuleNotFoundException
* The specified rule does not exist.
* @sample AmazonElasticLoadBalancing.DescribeRules
*/
DescribeRulesResult describeRules(DescribeRulesRequest describeRulesRequest);
/**
*
* Describes the specified policies or all policies used for SSL
* negotiation.
*
*
* Note that the only supported policy at this time is
* ELBSecurityPolicy-2015-05.
*
*
* @param describeSSLPoliciesRequest
* Contains the parameters for DescribeSSLPolicies.
* @return Result of the DescribeSSLPolicies operation returned by the
* service.
* @throws SSLPolicyNotFoundException
* The specified SSL policy does not exist.
* @sample AmazonElasticLoadBalancing.DescribeSSLPolicies
*/
DescribeSSLPoliciesResult describeSSLPolicies(
DescribeSSLPoliciesRequest describeSSLPoliciesRequest);
/**
*
* Describes the tags for the specified resources.
*
*
* @param describeTagsRequest
* Contains the parameters for DescribeTags.
* @return Result of the DescribeTags operation returned by the service.
* @throws LoadBalancerNotFoundException
* The specified load balancer does not exist.
* @throws TargetGroupNotFoundException
* The specified target group does not exist.
* @throws ListenerNotFoundException
* The specified listener does not exist.
* @throws RuleNotFoundException
* The specified rule does not exist.
* @sample AmazonElasticLoadBalancing.DescribeTags
*/
DescribeTagsResult describeTags(DescribeTagsRequest describeTagsRequest);
/**
*
* Describes the attributes for the specified target group.
*
*
* @param describeTargetGroupAttributesRequest
* Contains the parameters for DescribeTargetGroupAttributes.
* @return Result of the DescribeTargetGroupAttributes operation returned by
* the service.
* @throws TargetGroupNotFoundException
* The specified target group does not exist.
* @sample AmazonElasticLoadBalancing.DescribeTargetGroupAttributes
*/
DescribeTargetGroupAttributesResult describeTargetGroupAttributes(
DescribeTargetGroupAttributesRequest describeTargetGroupAttributesRequest);
/**
*
* Describes the specified target groups or all of your target groups. By
* default, all target groups are described. Alternatively, you can specify
* one of the following to filter the results: the ARN of the load balancer,
* the names of one or more target groups, or the ARNs of one or more target
* groups.
*
*
* To describe the targets for a target group, use
* DescribeTargetHealth. To describe the attributes of a target
* group, use DescribeTargetGroupAttributes.
*
*
* @param describeTargetGroupsRequest
* Contains the parameters for DescribeTargetGroups.
* @return Result of the DescribeTargetGroups operation returned by the
* service.
* @throws LoadBalancerNotFoundException
* The specified load balancer does not exist.
* @throws TargetGroupNotFoundException
* The specified target group does not exist.
* @sample AmazonElasticLoadBalancing.DescribeTargetGroups
*/
DescribeTargetGroupsResult describeTargetGroups(
DescribeTargetGroupsRequest describeTargetGroupsRequest);
/**
*
* Describes the health of the specified targets or all of your targets.
*
*
* @param describeTargetHealthRequest
* Contains the parameters for DescribeTargetHealth.
* @return Result of the DescribeTargetHealth operation returned by the
* service.
* @throws InvalidTargetException
* The specified target does not exist or is not in the same VPC as
* the target group.
* @throws TargetGroupNotFoundException
* The specified target group does not exist.
* @throws HealthUnavailableException
* The health of the specified targets could not be retrieved due to
* an internal error.
* @sample AmazonElasticLoadBalancing.DescribeTargetHealth
*/
DescribeTargetHealthResult describeTargetHealth(
DescribeTargetHealthRequest describeTargetHealthRequest);
/**
*
* Modifies the specified properties of the specified listener.
*
*
* Any properties that you do not specify retain their current values.
* However, changing the protocol from HTTPS to HTTP removes the security
* policy and SSL certificate properties. If you change the protocol from
* HTTP to HTTPS, you must add the security policy.
*
*
* @param modifyListenerRequest
* Contains the parameters for ModifyListener.
* @return Result of the ModifyListener operation returned by the service.
* @throws DuplicateListenerException
* A listener with the specified port already exists.
* @throws TooManyListenersException
* You've reached the limit on the number of listeners per load
* balancer.
* @throws TooManyCertificatesException
* You've reached the limit on the number of certificates per
* listener.
* @throws ListenerNotFoundException
* The specified listener does not exist.
* @throws TargetGroupNotFoundException
* The specified target group does not exist.
* @throws TargetGroupAssociationLimitException
* You've reached the limit on the number of load balancers per
* target group.
* @throws IncompatibleProtocolsException
* The specified configuration is not valid with this protocol.
* @throws SSLPolicyNotFoundException
* The specified SSL policy does not exist.
* @throws CertificateNotFoundException
* The specified certificate does not exist.
* @throws InvalidConfigurationRequestException
* The requested configuration is not valid.
* @throws UnsupportedProtocolException
* The specified protocol is not supported.
* @throws TooManyRegistrationsForTargetIdException
* You've reached the limit on the number of times a target can be
* registered with a load balancer.
* @sample AmazonElasticLoadBalancing.ModifyListener
*/
ModifyListenerResult modifyListener(
ModifyListenerRequest modifyListenerRequest);
/**
*
* Modifies the specified attributes of the specified 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.
*
*
* @param modifyLoadBalancerAttributesRequest
* Contains the parameters for ModifyLoadBalancerAttributes.
* @return Result of the ModifyLoadBalancerAttributes operation returned by
* the service.
* @throws LoadBalancerNotFoundException
* The specified load balancer does not exist.
* @throws InvalidConfigurationRequestException
* The requested configuration is not valid.
* @sample AmazonElasticLoadBalancing.ModifyLoadBalancerAttributes
*/
ModifyLoadBalancerAttributesResult modifyLoadBalancerAttributes(
ModifyLoadBalancerAttributesRequest modifyLoadBalancerAttributesRequest);
/**
*
* Modifies the specified rule.
*
*
* Any existing properties that you do not modify retain their current
* values.
*
*
* To modify the default action, use ModifyListener.
*
*
* @param modifyRuleRequest
* Contains the parameters for ModifyRules.
* @return Result of the ModifyRule operation returned by the service.
* @throws TargetGroupAssociationLimitException
* You've reached the limit on the number of load balancers per
* target group.
* @throws RuleNotFoundException
* The specified rule does not exist.
* @throws OperationNotPermittedException
* This operation is not allowed.
* @throws TooManyRegistrationsForTargetIdException
* You've reached the limit on the number of times a target can be
* registered with a load balancer.
* @sample AmazonElasticLoadBalancing.ModifyRule
*/
ModifyRuleResult modifyRule(ModifyRuleRequest modifyRuleRequest);
/**
*
* Modifies the health checks used when evaluating the health state of the
* targets in the specified target group.
*
*
* To monitor the health of the targets, use DescribeTargetHealth.
*
*
* @param modifyTargetGroupRequest
* Contains the parameters for ModifyTargetGroup.
* @return Result of the ModifyTargetGroup operation returned by the
* service.
* @throws TargetGroupNotFoundException
* The specified target group does not exist.
* @sample AmazonElasticLoadBalancing.ModifyTargetGroup
*/
ModifyTargetGroupResult modifyTargetGroup(
ModifyTargetGroupRequest modifyTargetGroupRequest);
/**
*
* Modifies the specified attributes of the specified target group.
*
*
* @param modifyTargetGroupAttributesRequest
* Contains the parameters for ModifyTargetGroupAttributes.
* @return Result of the ModifyTargetGroupAttributes operation returned by
* the service.
* @throws TargetGroupNotFoundException
* The specified target group does not exist.
* @sample AmazonElasticLoadBalancing.ModifyTargetGroupAttributes
*/
ModifyTargetGroupAttributesResult modifyTargetGroupAttributes(
ModifyTargetGroupAttributesRequest modifyTargetGroupAttributesRequest);
/**
*
* Registers the specified targets with the specified target group.
*
*
* The target must be in the virtual private cloud (VPC) that you specified
* for the target group.
*
*
* To remove a target from a target group, use DeregisterTargets.
*
*
* @param registerTargetsRequest
* Contains the parameters for RegisterTargets.
* @return Result of the RegisterTargets operation returned by the service.
* @throws TargetGroupNotFoundException
* The specified target group does not exist.
* @throws TooManyTargetsException
* You've reached the limit on the number of targets.
* @throws InvalidTargetException
* The specified target does not exist or is not in the same VPC as
* the target group.
* @throws TooManyRegistrationsForTargetIdException
* You've reached the limit on the number of times a target can be
* registered with a load balancer.
* @sample AmazonElasticLoadBalancing.RegisterTargets
*/
RegisterTargetsResult registerTargets(
RegisterTargetsRequest registerTargetsRequest);
/**
*
* Removes the specified tags from the specified resource.
*
*
* To list the current tags for your resources, use DescribeTags.
*
*
* @param removeTagsRequest
* Contains the parameters for RemoveTags.
* @return Result of the RemoveTags operation returned by the service.
* @throws LoadBalancerNotFoundException
* The specified load balancer does not exist.
* @throws TargetGroupNotFoundException
* The specified target group does not exist.
* @throws ListenerNotFoundException
* The specified listener does not exist.
* @throws RuleNotFoundException
* The specified rule does not exist.
* @throws TooManyTagsException
* You've reached the limit on the number of tags per load balancer.
* @sample AmazonElasticLoadBalancing.RemoveTags
*/
RemoveTagsResult removeTags(RemoveTagsRequest removeTagsRequest);
/**
*
* 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.
*
*
* @param setRulePrioritiesRequest
* Contains the parameters for SetRulePriorities.
* @return Result of the SetRulePriorities operation returned by the
* service.
* @throws RuleNotFoundException
* The specified rule does not exist.
* @throws PriorityInUseException
* The specified priority is in use.
* @throws OperationNotPermittedException
* This operation is not allowed.
* @sample AmazonElasticLoadBalancing.SetRulePriorities
*/
SetRulePrioritiesResult setRulePriorities(
SetRulePrioritiesRequest setRulePrioritiesRequest);
/**
*
* Associates the specified security groups with the specified load
* balancer. The specified security groups override the previously
* associated security groups.
*
*
* @param setSecurityGroupsRequest
* Contains the parameters for SetSecurityGroups.
* @return Result of the SetSecurityGroups operation returned by the
* service.
* @throws LoadBalancerNotFoundException
* The specified load balancer does not exist.
* @throws InvalidConfigurationRequestException
* The requested configuration is not valid.
* @throws InvalidSecurityGroupException
* The specified security group does not exist.
* @sample AmazonElasticLoadBalancing.SetSecurityGroups
*/
SetSecurityGroupsResult setSecurityGroups(
SetSecurityGroupsRequest setSecurityGroupsRequest);
/**
*
* Enables the Availability Zone for the specified subnets for the specified
* load balancer. The specified subnets replace the previously enabled
* subnets.
*
*
* @param setSubnetsRequest
* Contains the parameters for SetSubnets.
* @return Result of the SetSubnets operation returned by the service.
* @throws LoadBalancerNotFoundException
* The specified load balancer does not exist.
* @throws InvalidConfigurationRequestException
* The requested configuration is not valid.
* @throws SubnetNotFoundException
* The specified subnet does not exist.
* @throws InvalidSubnetException
* The specified subnet is out of available addresses.
* @sample AmazonElasticLoadBalancing.SetSubnets
*/
SetSubnetsResult setSubnets(SetSubnetsRequest setSubnetsRequest);
/**
* Shuts down this client object, releasing any resources that might be held
* open. This is an optional method, and callers are not expected to call
* it, but can if they want to explicitly release any open resources. Once a
* client has been shutdown, it should not be used to make any more
* requests.
*/
void shutdown();
/**
* Returns additional metadata for a previously executed successful request,
* typically used for debugging issues where a service isn't acting as
* expected. This data isn't considered part of the result data returned by
* an operation, so it's available through this separate, diagnostic
* interface.
*
* Response metadata is only cached for a limited period of time, so if you
* need to access this extra diagnostic information for an executed request,
* you should use this method to retrieve it as soon as possible after
* executing a request.
*
* @param request
* The originally executed request.
*
* @return The response metadata for the specified request, or null if none
* is available.
*/
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request);
}