com.amazonaws.services.elasticloadbalancing.AmazonElasticLoadBalancing Maven / Gradle / Ivy
Show all versions of aws-java-sdk-elasticloadbalancing Show documentation
/*
* Copyright 2010-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.elasticloadbalancing;
import com.amazonaws.*;
import com.amazonaws.regions.*;
import com.amazonaws.services.elasticloadbalancing.model.*;
/**
* Interface for accessing Elastic Load Balancing.
*
* Elastic Load Balancing
*
* Elastic Load Balancing distributes incoming traffic across your EC2
* instances.
*
*
* For information about the features of Elastic Load Balancing, see What Is Elastic Load Balancing? in the Elastic Load Balancing
* Developer Guide.
*
*
* For information about the AWS regions supported by Elastic Load Balancing,
* see Regions and Endpoints - Elastic Load Balancing in the Amazon Web
* Services General Reference.
*
*
* All Elastic Load Balancing operations are idempotent, which means that
* they complete at most one time. If you repeat an operation, it succeeds with
* a 200 OK response code.
*
*/
public interface AmazonElasticLoadBalancing {
/**
* Overrides the default endpoint for this client
* ("elasticloadbalancing.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.amazonaws.com") or a full URL, including the
* protocol (ex: "elasticloadbalancing.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.amazonaws.com") or a full
* URL, including the protocol (ex:
* "elasticloadbalancing.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 load balancer. Each load
* balancer can have a maximum of 10 tags.
*
*
* Each tag consists of a key and an optional value. If a tag with the same
* key is already associated with the load balancer, AddTags
* updates its value.
*
*
* For more information, see Tag Your Load Balancer in the Elastic Load Balancing Developer
* Guide.
*
*
* @param addTagsRequest
* @return Result of the AddTags operation returned by the service.
* @throws LoadBalancerNotFoundException
* The specified load balancer does not exist.
* @throws TooManyTagsException
* The quota for the number of tags that can be assigned to a load
* balancer has been reached.
* @throws DuplicateTagKeysException
* A tag key was specified more than once.
* @sample AmazonElasticLoadBalancing.AddTags
*/
AddTagsResult addTags(AddTagsRequest addTagsRequest);
/**
*
* Associates one or more security groups with your load balancer in a
* virtual private cloud (VPC). The specified security groups override the
* previously associated security groups.
*
*
* For more information, see Security Groups for Load Balancers in a VPC in the Elastic Load
* Balancing Developer Guide.
*
*
* @param applySecurityGroupsToLoadBalancerRequest
* @return Result of the ApplySecurityGroupsToLoadBalancer operation
* returned by the service.
* @throws LoadBalancerNotFoundException
* The specified load balancer does not exist.
* @throws InvalidConfigurationRequestException
* The requested configuration change is not valid.
* @throws InvalidSecurityGroupException
* One or more of the specified security groups do not exist.
* @sample AmazonElasticLoadBalancing.ApplySecurityGroupsToLoadBalancer
*/
ApplySecurityGroupsToLoadBalancerResult applySecurityGroupsToLoadBalancer(
ApplySecurityGroupsToLoadBalancerRequest applySecurityGroupsToLoadBalancerRequest);
/**
*
* Adds one or more subnets to the set of configured subnets for the
* specified load balancer.
*
*
* The load balancer evenly distributes requests across all registered
* subnets. For more information, see Add or Remove Subnets for Your Load Balancer in a VPC in the
* Elastic Load Balancing Developer Guide.
*
*
* @param attachLoadBalancerToSubnetsRequest
* @return Result of the AttachLoadBalancerToSubnets operation returned by
* the service.
* @throws LoadBalancerNotFoundException
* The specified load balancer does not exist.
* @throws InvalidConfigurationRequestException
* The requested configuration change is not valid.
* @throws SubnetNotFoundException
* One or more of the specified subnets do not exist.
* @throws InvalidSubnetException
* The specified VPC has no associated Internet gateway.
* @sample AmazonElasticLoadBalancing.AttachLoadBalancerToSubnets
*/
AttachLoadBalancerToSubnetsResult attachLoadBalancerToSubnets(
AttachLoadBalancerToSubnetsRequest attachLoadBalancerToSubnetsRequest);
/**
*
* Specifies the health check settings to use when evaluating the health
* state of your back-end instances.
*
*
* For more information, see Configure Health Checks in the Elastic Load Balancing Developer
* Guide.
*
*
* @param configureHealthCheckRequest
* @return Result of the ConfigureHealthCheck operation returned by the
* service.
* @throws LoadBalancerNotFoundException
* The specified load balancer does not exist.
* @sample AmazonElasticLoadBalancing.ConfigureHealthCheck
*/
ConfigureHealthCheckResult configureHealthCheck(
ConfigureHealthCheckRequest configureHealthCheckRequest);
/**
*
* Generates a stickiness policy with sticky session lifetimes that follow
* that of an application-generated cookie. This policy can be associated
* only with HTTP/HTTPS listeners.
*
*
* This policy is similar to the policy created by
* CreateLBCookieStickinessPolicy, except that the lifetime of the
* special Elastic Load Balancing cookie, AWSELB, follows the
* lifetime of the application-generated cookie specified in the policy
* configuration. The load balancer only inserts a new stickiness cookie
* when the application response includes a new application cookie.
*
*
* If the application cookie is explicitly removed or expires, the session
* stops being sticky until a new application cookie is issued.
*
*
* For more information, see Application-Controlled Session Stickiness in the Elastic Load
* Balancing Developer Guide.
*
*
* @param createAppCookieStickinessPolicyRequest
* @return Result of the CreateAppCookieStickinessPolicy operation returned
* by the service.
* @throws LoadBalancerNotFoundException
* The specified load balancer does not exist.
* @throws DuplicatePolicyNameException
* A policy with the specified name already exists for this load
* balancer.
* @throws TooManyPoliciesException
* The quota for the number of policies for this load balancer has
* been reached.
* @throws InvalidConfigurationRequestException
* The requested configuration change is not valid.
* @sample AmazonElasticLoadBalancing.CreateAppCookieStickinessPolicy
*/
CreateAppCookieStickinessPolicyResult createAppCookieStickinessPolicy(
CreateAppCookieStickinessPolicyRequest createAppCookieStickinessPolicyRequest);
/**
*
* Generates a stickiness policy with sticky session lifetimes controlled by
* the lifetime of the browser (user-agent) or a specified expiration
* period. This policy can be associated only with HTTP/HTTPS listeners.
*
*
* When a load balancer implements this policy, the load balancer uses a
* special cookie to track the back-end server instance for each request.
* When the load balancer receives a request, it first checks to see if this
* cookie is present in the request. If so, the load balancer sends the
* request to the application server specified in the cookie. If not, the
* load balancer sends the request to a server that is chosen based on the
* existing load-balancing algorithm.
*
*
* A cookie is inserted into the response for binding subsequent requests
* from the same user to that server. The validity of the cookie is based on
* the cookie expiration time, which is specified in the policy
* configuration.
*
*
* For more information, see Duration-Based Session Stickiness in the Elastic Load Balancing
* Developer Guide.
*
*
* @param createLBCookieStickinessPolicyRequest
* @return Result of the CreateLBCookieStickinessPolicy operation returned
* by the service.
* @throws LoadBalancerNotFoundException
* The specified load balancer does not exist.
* @throws DuplicatePolicyNameException
* A policy with the specified name already exists for this load
* balancer.
* @throws TooManyPoliciesException
* The quota for the number of policies for this load balancer has
* been reached.
* @throws InvalidConfigurationRequestException
* The requested configuration change is not valid.
* @sample AmazonElasticLoadBalancing.CreateLBCookieStickinessPolicy
*/
CreateLBCookieStickinessPolicyResult createLBCookieStickinessPolicy(
CreateLBCookieStickinessPolicyRequest createLBCookieStickinessPolicyRequest);
/**
*
* Creates a load balancer.
*
*
* If the call completes successfully, a new load balancer is created with a
* unique Domain Name Service (DNS) name. The load balancer receives
* incoming traffic and routes it to the registered instances. For more
* information, see How Elastic Load Balancing Works in the Elastic Load Balancing
* Developer Guide.
*
*
* 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 Elastic Load Balancing Limits in the Elastic Load Balancing
* Developer Guide.
*
*
* @param createLoadBalancerRequest
* @return Result of the CreateLoadBalancer operation returned by the
* service.
* @throws DuplicateLoadBalancerNameException
* The specified load balancer name already exists for this account.
* @throws TooManyLoadBalancersException
* The quota for the number of load balancers has been reached.
* @throws CertificateNotFoundException
* The specified SSL ID does not refer to a valid SSL certificate in
* AWS Identity and Access Management (IAM).
* @throws InvalidConfigurationRequestException
* The requested configuration change is not valid.
* @throws SubnetNotFoundException
* One or more of the specified subnets do not exist.
* @throws InvalidSubnetException
* The specified VPC has no associated Internet gateway.
* @throws InvalidSecurityGroupException
* One or more of the specified security groups do not exist.
* @throws InvalidSchemeException
* The specified value for the schema is not valid. You can only
* specify a scheme for load balancers in a VPC.
* @throws TooManyTagsException
* The quota for the number of tags that can be assigned to a load
* balancer has been reached.
* @throws DuplicateTagKeysException
* A tag key was specified more than once.
* @sample AmazonElasticLoadBalancing.CreateLoadBalancer
*/
CreateLoadBalancerResult createLoadBalancer(
CreateLoadBalancerRequest createLoadBalancerRequest);
/**
*
* Creates one or more listeners for the specified load balancer. If a
* listener with the specified port does not already exist, it is created;
* otherwise, the properties of the new listener must match the properties
* of the existing listener.
*
*
* For more information, see Add a Listener to Your Load Balancer in the Elastic Load
* Balancing Developer Guide.
*
*
* @param createLoadBalancerListenersRequest
* @return Result of the CreateLoadBalancerListeners operation returned by
* the service.
* @throws LoadBalancerNotFoundException
* The specified load balancer does not exist.
* @throws DuplicateListenerException
* A listener already exists for the specified
* LoadBalancerName and LoadBalancerPort,
* but with a different InstancePort,
* Protocol, or SSLCertificateId.
* @throws CertificateNotFoundException
* The specified SSL ID does not refer to a valid SSL certificate in
* AWS Identity and Access Management (IAM).
* @throws InvalidConfigurationRequestException
* The requested configuration change is not valid.
* @sample AmazonElasticLoadBalancing.CreateLoadBalancerListeners
*/
CreateLoadBalancerListenersResult createLoadBalancerListeners(
CreateLoadBalancerListenersRequest createLoadBalancerListenersRequest);
/**
*
* Creates a policy with the specified attributes for the specified load
* balancer.
*
*
* Policies are settings that are saved for your load balancer and that can
* be applied to the front-end listener or the back-end application server,
* depending on the policy type.
*
*
* @param createLoadBalancerPolicyRequest
* @return Result of the CreateLoadBalancerPolicy operation returned by the
* service.
* @throws LoadBalancerNotFoundException
* The specified load balancer does not exist.
* @throws PolicyTypeNotFoundException
* One or more of the specified policy types do not exist.
* @throws DuplicatePolicyNameException
* A policy with the specified name already exists for this load
* balancer.
* @throws TooManyPoliciesException
* The quota for the number of policies for this load balancer has
* been reached.
* @throws InvalidConfigurationRequestException
* The requested configuration change is not valid.
* @sample AmazonElasticLoadBalancing.CreateLoadBalancerPolicy
*/
CreateLoadBalancerPolicyResult createLoadBalancerPolicy(
CreateLoadBalancerPolicyRequest createLoadBalancerPolicyRequest);
/**
*
* Deletes the specified load balancer.
*
*
* If you are attempting to recreate a load balancer, you must reconfigure
* all settings. The DNS name associated with a deleted load balancer are no
* longer usable. The name and associated DNS record of the deleted load
* balancer no longer exist and traffic sent to any of its IP addresses is
* no longer delivered to back-end instances.
*
*
* If the load balancer does not exist or has already been deleted, the call
* to DeleteLoadBalancer still succeeds.
*
*
* @param deleteLoadBalancerRequest
* @return Result of the DeleteLoadBalancer operation returned by the
* service.
* @sample AmazonElasticLoadBalancing.DeleteLoadBalancer
*/
DeleteLoadBalancerResult deleteLoadBalancer(
DeleteLoadBalancerRequest deleteLoadBalancerRequest);
/**
*
* Deletes the specified listeners from the specified load balancer.
*
*
* @param deleteLoadBalancerListenersRequest
* @return Result of the DeleteLoadBalancerListeners operation returned by
* the service.
* @throws LoadBalancerNotFoundException
* The specified load balancer does not exist.
* @sample AmazonElasticLoadBalancing.DeleteLoadBalancerListeners
*/
DeleteLoadBalancerListenersResult deleteLoadBalancerListeners(
DeleteLoadBalancerListenersRequest deleteLoadBalancerListenersRequest);
/**
*
* Deletes the specified policy from the specified load balancer. This
* policy must not be enabled for any listeners.
*
*
* @param deleteLoadBalancerPolicyRequest
* =
* @return Result of the DeleteLoadBalancerPolicy operation returned by the
* service.
* @throws LoadBalancerNotFoundException
* The specified load balancer does not exist.
* @throws InvalidConfigurationRequestException
* The requested configuration change is not valid.
* @sample AmazonElasticLoadBalancing.DeleteLoadBalancerPolicy
*/
DeleteLoadBalancerPolicyResult deleteLoadBalancerPolicy(
DeleteLoadBalancerPolicyRequest deleteLoadBalancerPolicyRequest);
/**
*
* Deregisters the specified instances from the specified load balancer.
* After the instance is deregistered, it no longer receives traffic from
* the load balancer.
*
*
* You can use DescribeLoadBalancers to verify that the instance is
* deregistered from the load balancer.
*
*
* For more information, see Deregister and Register Amazon EC2 Instances in the Elastic Load
* Balancing Developer Guide.
*
*
* @param deregisterInstancesFromLoadBalancerRequest
* @return Result of the DeregisterInstancesFromLoadBalancer operation
* returned by the service.
* @throws LoadBalancerNotFoundException
* The specified load balancer does not exist.
* @throws InvalidInstanceException
* The specified endpoint is not valid.
* @sample AmazonElasticLoadBalancing.DeregisterInstancesFromLoadBalancer
*/
DeregisterInstancesFromLoadBalancerResult deregisterInstancesFromLoadBalancer(
DeregisterInstancesFromLoadBalancerRequest deregisterInstancesFromLoadBalancerRequest);
/**
*
* Describes the state of the specified instances with respect to the
* specified load balancer. If no instances are specified, the call
* describes the state of all instances that are currently registered with
* the load balancer. If instances are specified, their state is returned
* even if they are no longer registered with the load balancer. The state
* of terminated instances is not returned.
*
*
* @param describeInstanceHealthRequest
* @return Result of the DescribeInstanceHealth operation returned by the
* service.
* @throws LoadBalancerNotFoundException
* The specified load balancer does not exist.
* @throws InvalidInstanceException
* The specified endpoint is not valid.
* @sample AmazonElasticLoadBalancing.DescribeInstanceHealth
*/
DescribeInstanceHealthResult describeInstanceHealth(
DescribeInstanceHealthRequest describeInstanceHealthRequest);
/**
*
* Describes the attributes for the specified load balancer.
*
*
* @param describeLoadBalancerAttributesRequest
* @return Result of the DescribeLoadBalancerAttributes operation returned
* by the service.
* @throws LoadBalancerNotFoundException
* The specified load balancer does not exist.
* @throws LoadBalancerAttributeNotFoundException
* The specified load balancer attribute does not exist.
* @sample AmazonElasticLoadBalancing.DescribeLoadBalancerAttributes
*/
DescribeLoadBalancerAttributesResult describeLoadBalancerAttributes(
DescribeLoadBalancerAttributesRequest describeLoadBalancerAttributesRequest);
/**
*
* Describes the specified policies.
*
*
* If you specify a load balancer name, the action returns the descriptions
* of all policies created for the load balancer. If you specify a policy
* name associated with your load balancer, the action returns the
* description of that policy. If you don't specify a load balancer name,
* the action returns descriptions of the specified sample policies, or
* descriptions of all sample policies. The names of the sample policies
* have the ELBSample- prefix.
*
*
* @param describeLoadBalancerPoliciesRequest
* @return Result of the DescribeLoadBalancerPolicies operation returned by
* the service.
* @throws LoadBalancerNotFoundException
* The specified load balancer does not exist.
* @throws PolicyNotFoundException
* One or more of the specified policies do not exist.
* @sample AmazonElasticLoadBalancing.DescribeLoadBalancerPolicies
*/
DescribeLoadBalancerPoliciesResult describeLoadBalancerPolicies(
DescribeLoadBalancerPoliciesRequest describeLoadBalancerPoliciesRequest);
/**
* Simplified method form for invoking the DescribeLoadBalancerPolicies
* operation.
*
* @see #describeLoadBalancerPolicies(DescribeLoadBalancerPoliciesRequest)
*/
DescribeLoadBalancerPoliciesResult describeLoadBalancerPolicies();
/**
*
* Describes the specified load balancer policy types.
*
*
* You can use these policy types with CreateLoadBalancerPolicy to
* create policy configurations for a load balancer.
*
*
* @param describeLoadBalancerPolicyTypesRequest
* @return Result of the DescribeLoadBalancerPolicyTypes operation returned
* by the service.
* @throws PolicyTypeNotFoundException
* One or more of the specified policy types do not exist.
* @sample AmazonElasticLoadBalancing.DescribeLoadBalancerPolicyTypes
*/
DescribeLoadBalancerPolicyTypesResult describeLoadBalancerPolicyTypes(
DescribeLoadBalancerPolicyTypesRequest describeLoadBalancerPolicyTypesRequest);
/**
* Simplified method form for invoking the DescribeLoadBalancerPolicyTypes
* operation.
*
* @see #describeLoadBalancerPolicyTypes(DescribeLoadBalancerPolicyTypesRequest)
*/
DescribeLoadBalancerPolicyTypesResult describeLoadBalancerPolicyTypes();
/**
*
* Describes the specified the load balancers. If no load balancers are
* specified, the call describes all of your load balancers.
*
*
* @param describeLoadBalancersRequest
* @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);
/**
* Simplified method form for invoking the DescribeLoadBalancers operation.
*
* @see #describeLoadBalancers(DescribeLoadBalancersRequest)
*/
DescribeLoadBalancersResult describeLoadBalancers();
/**
*
* Describes the tags associated with the specified load balancers.
*
*
* @param describeTagsRequest
* @return Result of the DescribeTags operation returned by the service.
* @throws LoadBalancerNotFoundException
* The specified load balancer does not exist.
* @sample AmazonElasticLoadBalancing.DescribeTags
*/
DescribeTagsResult describeTags(DescribeTagsRequest describeTagsRequest);
/**
*
* Removes the specified subnets from the set of configured subnets for the
* load balancer.
*
*
* After a subnet is removed, all EC2 instances registered with the load
* balancer in the removed subnet go into the OutOfService
* state. Then, the load balancer balances the traffic among the remaining
* routable subnets.
*
*
* @param detachLoadBalancerFromSubnetsRequest
* @return Result of the DetachLoadBalancerFromSubnets operation returned by
* the service.
* @throws LoadBalancerNotFoundException
* The specified load balancer does not exist.
* @throws InvalidConfigurationRequestException
* The requested configuration change is not valid.
* @sample AmazonElasticLoadBalancing.DetachLoadBalancerFromSubnets
*/
DetachLoadBalancerFromSubnetsResult detachLoadBalancerFromSubnets(
DetachLoadBalancerFromSubnetsRequest detachLoadBalancerFromSubnetsRequest);
/**
*
* Removes the specified Availability Zones from the set of Availability
* Zones for the specified load balancer.
*
*
* There must be at least one Availability Zone registered with a load
* balancer at all times. After an Availability Zone is removed, all
* instances registered with the load balancer that are in the removed
* Availability Zone go into the OutOfService state. Then, the
* load balancer attempts to equally balance the traffic among its remaining
* Availability Zones.
*
*
* For more information, see Disable an Availability Zone from a Load-Balanced Application in the
* Elastic Load Balancing Developer Guide.
*
*
* @param disableAvailabilityZonesForLoadBalancerRequest
* @return Result of the DisableAvailabilityZonesForLoadBalancer operation
* returned by the service.
* @throws LoadBalancerNotFoundException
* The specified load balancer does not exist.
* @throws InvalidConfigurationRequestException
* The requested configuration change is not valid.
* @sample
* AmazonElasticLoadBalancing.DisableAvailabilityZonesForLoadBalancer
*/
DisableAvailabilityZonesForLoadBalancerResult disableAvailabilityZonesForLoadBalancer(
DisableAvailabilityZonesForLoadBalancerRequest disableAvailabilityZonesForLoadBalancerRequest);
/**
*
* Adds the specified Availability Zones to the set of Availability Zones
* for the specified load balancer.
*
*
* The load balancer evenly distributes requests across all its registered
* Availability Zones that contain instances.
*
*
* For more information, see Add Availability Zone in the Elastic Load Balancing Developer
* Guide.
*
*
* @param enableAvailabilityZonesForLoadBalancerRequest
* @return Result of the EnableAvailabilityZonesForLoadBalancer operation
* returned by the service.
* @throws LoadBalancerNotFoundException
* The specified load balancer does not exist.
* @sample AmazonElasticLoadBalancing.EnableAvailabilityZonesForLoadBalancer
*/
EnableAvailabilityZonesForLoadBalancerResult enableAvailabilityZonesForLoadBalancer(
EnableAvailabilityZonesForLoadBalancerRequest enableAvailabilityZonesForLoadBalancerRequest);
/**
*
* Modifies the attributes of the specified load balancer.
*
*
* You can modify the load balancer attributes, such as
* AccessLogs, ConnectionDraining, and
* CrossZoneLoadBalancing by either enabling or disabling them.
* Or, you can modify the load balancer attribute
* ConnectionSettings by specifying an idle connection timeout
* value for your load balancer.
*
*
* For more information, see the following in the Elastic Load Balancing
* Developer Guide:
*
*
*
* @param modifyLoadBalancerAttributesRequest
* @return Result of the ModifyLoadBalancerAttributes operation returned by
* the service.
* @throws LoadBalancerNotFoundException
* The specified load balancer does not exist.
* @throws LoadBalancerAttributeNotFoundException
* The specified load balancer attribute does not exist.
* @throws InvalidConfigurationRequestException
* The requested configuration change is not valid.
* @sample AmazonElasticLoadBalancing.ModifyLoadBalancerAttributes
*/
ModifyLoadBalancerAttributesResult modifyLoadBalancerAttributes(
ModifyLoadBalancerAttributesRequest modifyLoadBalancerAttributesRequest);
/**
*
* Adds the specified instances to the specified load balancer.
*
*
* The instance must be a running instance in the same network as the load
* balancer (EC2-Classic or the same VPC). If you have EC2-Classic instances
* and a load balancer in a VPC with ClassicLink enabled, you can link the
* EC2-Classic instances to that VPC and then register the linked
* EC2-Classic instances with the load balancer in the VPC.
*
*
* Note that RegisterInstanceWithLoadBalancer completes when
* the request has been registered. Instance registration takes a little
* time to complete. To check the state of the registered instances, use
* DescribeLoadBalancers or DescribeInstanceHealth.
*
*
* After the instance is registered, it starts receiving traffic and
* requests from the load balancer. Any instance that is not in one of the
* Availability Zones registered for the load balancer is moved to the
* OutOfService state. If an Availability Zone is added to the
* load balancer later, any instances registered with the load balancer move
* to the InService state.
*
*
* If you stop an instance registered with a load balancer and then start
* it, the IP addresses associated with the instance changes. Elastic Load
* Balancing cannot recognize the new IP address, which prevents it from
* routing traffic to the instances. We recommend that you use the following
* sequence: stop the instance, deregister the instance, start the instance,
* and then register the instance. To deregister instances from a load
* balancer, use DeregisterInstancesFromLoadBalancer.
*
*
* For more information, see Deregister and Register EC2 Instances in the Elastic Load
* Balancing Developer Guide.
*
*
* @param registerInstancesWithLoadBalancerRequest
* @return Result of the RegisterInstancesWithLoadBalancer operation
* returned by the service.
* @throws LoadBalancerNotFoundException
* The specified load balancer does not exist.
* @throws InvalidInstanceException
* The specified endpoint is not valid.
* @sample AmazonElasticLoadBalancing.RegisterInstancesWithLoadBalancer
*/
RegisterInstancesWithLoadBalancerResult registerInstancesWithLoadBalancer(
RegisterInstancesWithLoadBalancerRequest registerInstancesWithLoadBalancerRequest);
/**
*
* Removes one or more tags from the specified load balancer.
*
*
* @param removeTagsRequest
* @return Result of the RemoveTags operation returned by the service.
* @throws LoadBalancerNotFoundException
* The specified load balancer does not exist.
* @sample AmazonElasticLoadBalancing.RemoveTags
*/
RemoveTagsResult removeTags(RemoveTagsRequest removeTagsRequest);
/**
*
* Sets the certificate that terminates the specified listener's SSL
* connections. The specified certificate replaces any prior certificate
* that was used on the same load balancer and port.
*
*
* For more information about updating your SSL certificate, see Updating an SSL Certificate for a Load Balancer in the Elastic
* Load Balancing Developer Guide.
*
*
* @param setLoadBalancerListenerSSLCertificateRequest
* @return Result of the SetLoadBalancerListenerSSLCertificate operation
* returned by the service.
* @throws CertificateNotFoundException
* The specified SSL ID does not refer to a valid SSL certificate in
* AWS Identity and Access Management (IAM).
* @throws LoadBalancerNotFoundException
* The specified load balancer does not exist.
* @throws ListenerNotFoundException
* The load balancer does not have a listener configured at the
* specified port.
* @throws InvalidConfigurationRequestException
* The requested configuration change is not valid.
* @sample AmazonElasticLoadBalancing.SetLoadBalancerListenerSSLCertificate
*/
SetLoadBalancerListenerSSLCertificateResult setLoadBalancerListenerSSLCertificate(
SetLoadBalancerListenerSSLCertificateRequest setLoadBalancerListenerSSLCertificateRequest);
/**
*
* Replaces the set of policies associated with the specified port on which
* the back-end server is listening with a new set of policies. At this
* time, only the back-end server authentication policy type can be applied
* to the back-end ports; this policy type is composed of multiple public
* key policies.
*
*
* Each time you use SetLoadBalancerPoliciesForBackendServer to
* enable the policies, use the PolicyNames parameter to list
* the policies that you want to enable.
*
*
* You can use DescribeLoadBalancers or
* DescribeLoadBalancerPolicies to verify that the policy is
* associated with the back-end server.
*
*
* @param setLoadBalancerPoliciesForBackendServerRequest
* @return Result of the SetLoadBalancerPoliciesForBackendServer operation
* returned by the service.
* @throws LoadBalancerNotFoundException
* The specified load balancer does not exist.
* @throws PolicyNotFoundException
* One or more of the specified policies do not exist.
* @throws InvalidConfigurationRequestException
* The requested configuration change is not valid.
* @sample
* AmazonElasticLoadBalancing.SetLoadBalancerPoliciesForBackendServer
*/
SetLoadBalancerPoliciesForBackendServerResult setLoadBalancerPoliciesForBackendServer(
SetLoadBalancerPoliciesForBackendServerRequest setLoadBalancerPoliciesForBackendServerRequest);
/**
*
* Associates, updates, or disables a policy with a listener for the
* specified load balancer. You can associate multiple policies with a
* listener.
*
*
* @param setLoadBalancerPoliciesOfListenerRequest
* @return Result of the SetLoadBalancerPoliciesOfListener operation
* returned by the service.
* @throws LoadBalancerNotFoundException
* The specified load balancer does not exist.
* @throws PolicyNotFoundException
* One or more of the specified policies do not exist.
* @throws ListenerNotFoundException
* The load balancer does not have a listener configured at the
* specified port.
* @throws InvalidConfigurationRequestException
* The requested configuration change is not valid.
* @sample AmazonElasticLoadBalancing.SetLoadBalancerPoliciesOfListener
*/
SetLoadBalancerPoliciesOfListenerResult setLoadBalancerPoliciesOfListener(
SetLoadBalancerPoliciesOfListenerRequest setLoadBalancerPoliciesOfListenerRequest);
/**
* 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);
}