* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from * {@link com.amazonaws.services.elasticloadbalancing.AbstractAmazonElasticLoadBalancing} instead. *
*
*
* A load balancer can distribute incoming traffic across your EC2 instances. This enables you to increase the * availability of your application. The load balancer also monitors the health of its registered instances and ensures * that it routes traffic only to healthy instances. 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 and a protocol and port number for connections from the load balancer to the instances. *
** Elastic Load Balancing supports three types of load balancers: Application Load Balancers, Network Load Balancers, * and Classic Load Balancers. You can select a load balancer based on your application needs. For more information, see * the Elastic Load Balancing User * Guide. *
** This reference covers the 2012-06-01 API, which supports Classic Load Balancers. The 2015-12-01 API supports * Application Load Balancers and Network Load Balancers. *
** To get started, create a load balancer with one or more listeners using CreateLoadBalancer. Register your * instances with the load balancer using RegisterInstancesWithLoadBalancer. *
** 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. *
*/ @Generated("com.amazonaws:aws-java-sdk-code-generator") 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.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: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection- * choose-endpoint *
* 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. * @deprecated use {@link AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration)} for * example: * {@code builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));} */ @Deprecated 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) * @deprecated use {@link AwsClientBuilder#setRegion(String)} */ @Deprecated 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 Classic Load * Balancer in the Classic Load Balancers Guide. *
* * @param addTagsRequest * Contains the parameters for AddTags. * @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 * @see AWS * API Documentation */ 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 Classic Load Balancers Guide. *
* * @param applySecurityGroupsToLoadBalancerRequest * Contains the parameters for ApplySecurityGroupsToLoadBalancer. * @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 * @see AWS API Documentation */ 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 Classic Load Balancers Guide. *
* * @param attachLoadBalancerToSubnetsRequest * Contains the parameters for AttachLoaBalancerToSubnets. * @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 * @see AWS API Documentation */ AttachLoadBalancerToSubnetsResult attachLoadBalancerToSubnets(AttachLoadBalancerToSubnetsRequest attachLoadBalancerToSubnetsRequest); /** ** Specifies the health check settings to use when evaluating the health state of your EC2 instances. *
** For more information, see Configure Health * Checks for Your Load Balancer in the Classic Load Balancers Guide. *
* * @param configureHealthCheckRequest * Contains the parameters for ConfigureHealthCheck. * @return Result of the ConfigureHealthCheck operation returned by the service. * @throws LoadBalancerNotFoundException * The specified load balancer does not exist. * @sample AmazonElasticLoadBalancing.ConfigureHealthCheck * @see AWS API Documentation */ 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 Classic Load Balancers Guide. *
* * @param createAppCookieStickinessPolicyRequest * Contains the parameters for CreateAppCookieStickinessPolicy. * @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 * @see AWS API Documentation */ 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 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 Classic Load Balancers Guide. *
* * @param createLBCookieStickinessPolicyRequest * Contains the parameters for CreateLBCookieStickinessPolicy. * @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 * @see AWS API Documentation */ CreateLBCookieStickinessPolicyResult createLBCookieStickinessPolicy(CreateLBCookieStickinessPolicyRequest createLBCookieStickinessPolicyRequest); /** ** Creates a Classic Load Balancer. *
** You can add listeners, security groups, subnets, and tags when you create your load balancer, or you can add them * later using CreateLoadBalancerListeners, ApplySecurityGroupsToLoadBalancer, * AttachLoadBalancerToSubnets, 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 Classic * Load Balancer in the Classic Load Balancers Guide. *
* * @param createLoadBalancerRequest * Contains the parameters for CreateLoadBalancer. * @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 ARN does not refer to a valid SSL certificate in AWS Identity and Access Management (IAM) * or AWS Certificate Manager (ACM). Note that if you recently uploaded the certificate to IAM, this error * might indicate that the certificate is not fully available yet. * @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. * @throws UnsupportedProtocolException * The specified protocol or signature version is not supported. * @throws OperationNotPermittedException * This operation is not allowed. * @sample AmazonElasticLoadBalancing.CreateLoadBalancer * @see AWS API Documentation */ 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 Listeners for * Your Classic Load Balancer in the Classic Load Balancers Guide. *
* * @param createLoadBalancerListenersRequest * Contains the parameters for CreateLoadBalancerListeners. * @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 load balancer name and port, but with a different instance * port, protocol, or SSL certificate. * @throws CertificateNotFoundException * The specified ARN does not refer to a valid SSL certificate in AWS Identity and Access Management (IAM) * or AWS Certificate Manager (ACM). Note that if you recently uploaded the certificate to IAM, this error * might indicate that the certificate is not fully available yet. * @throws InvalidConfigurationRequestException * The requested configuration change is not valid. * @throws UnsupportedProtocolException * The specified protocol or signature version is not supported. * @sample AmazonElasticLoadBalancing.CreateLoadBalancerListeners * @see AWS API Documentation */ 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 listener or the * application server, depending on the policy type. *
* * @param createLoadBalancerPolicyRequest * Contains the parameters for CreateLoadBalancerPolicy. * @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 * @see AWS API Documentation */ 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 your instances. *
*
* If the load balancer does not exist or has already been deleted, the call to DeleteLoadBalancer
* still succeeds.
*
* Deletes the specified listeners from the specified load balancer. *
* * @param deleteLoadBalancerListenersRequest * Contains the parameters for DeleteLoadBalancerListeners. * @return Result of the DeleteLoadBalancerListeners operation returned by the service. * @throws LoadBalancerNotFoundException * The specified load balancer does not exist. * @sample AmazonElasticLoadBalancing.DeleteLoadBalancerListeners * @see AWS API Documentation */ DeleteLoadBalancerListenersResult deleteLoadBalancerListeners(DeleteLoadBalancerListenersRequest deleteLoadBalancerListenersRequest); /** ** Deletes the specified policy from the specified load balancer. This policy must not be enabled for any listeners. *
* * @param deleteLoadBalancerPolicyRequest * Contains the parameters for DeleteLoadBalancerPolicy. * @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 * @see AWS API Documentation */ 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 Register or De-Register EC2 Instances in the Classic Load Balancers Guide. *
* * @param deregisterInstancesFromLoadBalancerRequest * Contains the parameters for DeregisterInstancesFromLoadBalancer. * @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 * @see AWS API Documentation */ DeregisterInstancesFromLoadBalancerResult deregisterInstancesFromLoadBalancer( DeregisterInstancesFromLoadBalancerRequest deregisterInstancesFromLoadBalancerRequest); /** ** Describes the current Elastic Load Balancing resource limits for your AWS account. *
** For more information, see Limits for Your Classic * Load Balancer in the Classic Load Balancers Guide. *
* * @param describeAccountLimitsRequest * @return Result of the DescribeAccountLimits operation returned by the service. * @sample AmazonElasticLoadBalancing.DescribeAccountLimits * @see AWS API Documentation */ DescribeAccountLimitsResult describeAccountLimits(DescribeAccountLimitsRequest describeAccountLimitsRequest); /** ** 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 * Contains the parameters for DescribeInstanceHealth. * @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 * @see AWS API Documentation */ DescribeInstanceHealthResult describeInstanceHealth(DescribeInstanceHealthRequest describeInstanceHealthRequest); /** ** 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. * @throws LoadBalancerAttributeNotFoundException * The specified load balancer attribute does not exist. * @sample AmazonElasticLoadBalancing.DescribeLoadBalancerAttributes * @see AWS API Documentation */ 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.
*
* Describes the specified load balancer policy types or all load balancer policy types. *
** The description of each type indicates how it can be used. For example, some policies can be used only with layer * 7 listeners, some policies can be used only with layer 4 listeners, and some policies can be used only with your * EC2 instances. *
** You can use CreateLoadBalancerPolicy to create a policy configuration for any of these policy types. Then, * depending on the policy type, use either SetLoadBalancerPoliciesOfListener or * SetLoadBalancerPoliciesForBackendServer to set the policy. *
* * @param describeLoadBalancerPolicyTypesRequest * Contains the parameters for DescribeLoadBalancerPolicyTypes. * @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 * @see AWS API Documentation */ 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 * Contains the parameters for DescribeLoadBalancers. * @return Result of the DescribeLoadBalancers operation returned by the service. * @throws LoadBalancerNotFoundException * The specified load balancer does not exist. * @throws DependencyThrottleException * A request made by Elastic Load Balancing to another service exceeds the maximum request rate permitted * for your account. * @sample AmazonElasticLoadBalancing.DescribeLoadBalancers * @see AWS API Documentation */ 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 * Contains the parameters for DescribeTags. * @return Result of the DescribeTags operation returned by the service. * @throws LoadBalancerNotFoundException * The specified load balancer does not exist. * @sample AmazonElasticLoadBalancing.DescribeTags * @see AWS API Documentation */ 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.
*
* Removes the specified Availability Zones from the set of Availability Zones for the specified load balancer in * EC2-Classic or a default VPC. *
** For load balancers in a non-default VPC, use DetachLoadBalancerFromSubnets. *
*
* 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 Add or Remove * Availability Zones in the Classic Load Balancers Guide. *
* * @param disableAvailabilityZonesForLoadBalancerRequest * Contains the parameters for DisableAvailabilityZonesForLoadBalancer. * @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 * @see AWS API Documentation */ DisableAvailabilityZonesForLoadBalancerResult disableAvailabilityZonesForLoadBalancer( DisableAvailabilityZonesForLoadBalancerRequest disableAvailabilityZonesForLoadBalancerRequest); /** ** Adds the specified Availability Zones to the set of Availability Zones for the specified load balancer in * EC2-Classic or a default VPC. *
** For load balancers in a non-default VPC, use AttachLoadBalancerToSubnets. *
** The load balancer evenly distributes requests across all its registered Availability Zones that contain * instances. For more information, see Add or Remove * Availability Zones in the Classic Load Balancers Guide. *
* * @param enableAvailabilityZonesForLoadBalancerRequest * Contains the parameters for EnableAvailabilityZonesForLoadBalancer. * @return Result of the EnableAvailabilityZonesForLoadBalancer operation returned by the service. * @throws LoadBalancerNotFoundException * The specified load balancer does not exist. * @sample AmazonElasticLoadBalancing.EnableAvailabilityZonesForLoadBalancer * @see AWS API Documentation */ 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 Classic Load Balancers Guide: *
** Access * Logs *
** 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.
*
* To deregister instances from a load balancer, use DeregisterInstancesFromLoadBalancer. *
** For more information, see Register or De-Register EC2 Instances in the Classic Load Balancers Guide. *
* * @param registerInstancesWithLoadBalancerRequest * Contains the parameters for RegisterInstancesWithLoadBalancer. * @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 * @see AWS API Documentation */ RegisterInstancesWithLoadBalancerResult registerInstancesWithLoadBalancer(RegisterInstancesWithLoadBalancerRequest registerInstancesWithLoadBalancerRequest); /** ** Removes one or more tags from the specified load balancer. *
* * @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. * @sample AmazonElasticLoadBalancing.RemoveTags * @see AWS API Documentation */ 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 Replace the SSL * Certificate for Your Load Balancer in the Classic Load Balancers Guide. *
* * @param setLoadBalancerListenerSSLCertificateRequest * Contains the parameters for SetLoadBalancerListenerSSLCertificate. * @return Result of the SetLoadBalancerListenerSSLCertificate operation returned by the service. * @throws CertificateNotFoundException * The specified ARN does not refer to a valid SSL certificate in AWS Identity and Access Management (IAM) * or AWS Certificate Manager (ACM). Note that if you recently uploaded the certificate to IAM, this error * might indicate that the certificate is not fully available yet. * @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. * @throws UnsupportedProtocolException * The specified protocol or signature version is not supported. * @sample AmazonElasticLoadBalancing.SetLoadBalancerListenerSSLCertificate * @see AWS API Documentation */ SetLoadBalancerListenerSSLCertificateResult setLoadBalancerListenerSSLCertificate( SetLoadBalancerListenerSSLCertificateRequest setLoadBalancerListenerSSLCertificateRequest); /** ** Replaces the set of policies associated with the specified port on which the EC2 instance is listening with a new * set of policies. At this time, only the back-end server authentication policy type can be applied to the instance * 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 EC2 instance. *
** For more information about enabling back-end instance authentication, see Configure Back-end Instance Authentication in the Classic Load Balancers Guide. For more information * about Proxy Protocol, see Configure Proxy * Protocol Support in the Classic Load Balancers Guide. *
* * @param setLoadBalancerPoliciesForBackendServerRequest * Contains the parameters for SetLoadBalancerPoliciesForBackendServer. * @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 * @see AWS API Documentation */ SetLoadBalancerPoliciesForBackendServerResult setLoadBalancerPoliciesForBackendServer( SetLoadBalancerPoliciesForBackendServerRequest setLoadBalancerPoliciesForBackendServerRequest); /** ** Replaces the current set of policies for the specified load balancer port with the specified set of policies. *
** To enable back-end server authentication, use SetLoadBalancerPoliciesForBackendServer. *
** For more information about setting policies, see Update the SSL * Negotiation Configuration, Duration-Based Session Stickiness, and Application-Controlled Session Stickiness in the Classic Load Balancers Guide. *
* * @param setLoadBalancerPoliciesOfListenerRequest * Contains the parameters for SetLoadBalancePoliciesOfListener. * @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 * @see AWS API Documentation */ 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); AmazonElasticLoadBalancingWaiters waiters(); }