AWS SDK Version 2 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

.NET Framework 3.5
 
Interface for accessing ElasticLoadBalancing 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.

Inheritance Hierarchy

Amazon.ElasticLoadBalancing.IAmazonElasticLoadBalancing

Namespace: Amazon.ElasticLoadBalancing
Assembly: AWSSDK.dll
Version: (assembly version)

Syntax

C#
public interface IAmazonElasticLoadBalancing
         IDisposable

The IAmazonElasticLoadBalancing type exposes the following members

Methods

NameDescription
Public Method AddTags(AddTagsRequest) 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.

Public Method ApplySecurityGroupsToLoadBalancer(ApplySecurityGroupsToLoadBalancerRequest) 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.

Public Method AttachLoadBalancerToSubnets(AttachLoadBalancerToSubnetsRequest) 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.

Public Method BeginAddTags(AddTagsRequest, AsyncCallback, object) Initiates the asynchronous execution of the AddTags operation.
Public Method BeginApplySecurityGroupsToLoadBalancer(ApplySecurityGroupsToLoadBalancerRequest, AsyncCallback, object) Initiates the asynchronous execution of the ApplySecurityGroupsToLoadBalancer operation.
Public Method BeginAttachLoadBalancerToSubnets(AttachLoadBalancerToSubnetsRequest, AsyncCallback, object) Initiates the asynchronous execution of the AttachLoadBalancerToSubnets operation.
Public Method BeginConfigureHealthCheck(ConfigureHealthCheckRequest, AsyncCallback, object) Initiates the asynchronous execution of the ConfigureHealthCheck operation.
Public Method BeginCreateAppCookieStickinessPolicy(CreateAppCookieStickinessPolicyRequest, AsyncCallback, object) Initiates the asynchronous execution of the CreateAppCookieStickinessPolicy operation.
Public Method BeginCreateLBCookieStickinessPolicy(CreateLBCookieStickinessPolicyRequest, AsyncCallback, object) Initiates the asynchronous execution of the CreateLBCookieStickinessPolicy operation.
Public Method BeginCreateLoadBalancer(CreateLoadBalancerRequest, AsyncCallback, object) Initiates the asynchronous execution of the CreateLoadBalancer operation.
Public Method BeginCreateLoadBalancerListeners(CreateLoadBalancerListenersRequest, AsyncCallback, object) Initiates the asynchronous execution of the CreateLoadBalancerListeners operation.
Public Method BeginCreateLoadBalancerPolicy(CreateLoadBalancerPolicyRequest, AsyncCallback, object) Initiates the asynchronous execution of the CreateLoadBalancerPolicy operation.
Public Method BeginDeleteLoadBalancer(DeleteLoadBalancerRequest, AsyncCallback, object) Initiates the asynchronous execution of the DeleteLoadBalancer operation.
Public Method BeginDeleteLoadBalancerListeners(DeleteLoadBalancerListenersRequest, AsyncCallback, object) Initiates the asynchronous execution of the DeleteLoadBalancerListeners operation.
Public Method BeginDeleteLoadBalancerPolicy(DeleteLoadBalancerPolicyRequest, AsyncCallback, object) Initiates the asynchronous execution of the DeleteLoadBalancerPolicy operation.
Public Method BeginDeregisterInstancesFromLoadBalancer(DeregisterInstancesFromLoadBalancerRequest, AsyncCallback, object) Initiates the asynchronous execution of the DeregisterInstancesFromLoadBalancer operation.
Public Method BeginDescribeInstanceHealth(DescribeInstanceHealthRequest, AsyncCallback, object) Initiates the asynchronous execution of the DescribeInstanceHealth operation.
Public Method BeginDescribeLoadBalancerAttributes(DescribeLoadBalancerAttributesRequest, AsyncCallback, object) Initiates the asynchronous execution of the DescribeLoadBalancerAttributes operation.
Public Method BeginDescribeLoadBalancerPolicies(DescribeLoadBalancerPoliciesRequest, AsyncCallback, object) Initiates the asynchronous execution of the DescribeLoadBalancerPolicies operation.
Public Method BeginDescribeLoadBalancerPolicyTypes(DescribeLoadBalancerPolicyTypesRequest, AsyncCallback, object) Initiates the asynchronous execution of the DescribeLoadBalancerPolicyTypes operation.
Public Method BeginDescribeLoadBalancers(DescribeLoadBalancersRequest, AsyncCallback, object) Initiates the asynchronous execution of the DescribeLoadBalancers operation.
Public Method BeginDescribeTags(DescribeTagsRequest, AsyncCallback, object) Initiates the asynchronous execution of the DescribeTags operation.
Public Method BeginDetachLoadBalancerFromSubnets(DetachLoadBalancerFromSubnetsRequest, AsyncCallback, object) Initiates the asynchronous execution of the DetachLoadBalancerFromSubnets operation.
Public Method BeginDisableAvailabilityZonesForLoadBalancer(DisableAvailabilityZonesForLoadBalancerRequest, AsyncCallback, object) Initiates the asynchronous execution of the DisableAvailabilityZonesForLoadBalancer operation.
Public Method BeginEnableAvailabilityZonesForLoadBalancer(EnableAvailabilityZonesForLoadBalancerRequest, AsyncCallback, object) Initiates the asynchronous execution of the EnableAvailabilityZonesForLoadBalancer operation.
Public Method BeginModifyLoadBalancerAttributes(ModifyLoadBalancerAttributesRequest, AsyncCallback, object) Initiates the asynchronous execution of the ModifyLoadBalancerAttributes operation.
Public Method BeginRegisterInstancesWithLoadBalancer(RegisterInstancesWithLoadBalancerRequest, AsyncCallback, object) Initiates the asynchronous execution of the RegisterInstancesWithLoadBalancer operation.
Public Method BeginRemoveTags(RemoveTagsRequest, AsyncCallback, object) Initiates the asynchronous execution of the RemoveTags operation.
Public Method BeginSetLoadBalancerListenerSSLCertificate(SetLoadBalancerListenerSSLCertificateRequest, AsyncCallback, object) Initiates the asynchronous execution of the SetLoadBalancerListenerSSLCertificate operation.
Public Method BeginSetLoadBalancerPoliciesForBackendServer(SetLoadBalancerPoliciesForBackendServerRequest, AsyncCallback, object) Initiates the asynchronous execution of the SetLoadBalancerPoliciesForBackendServer operation.
Public Method BeginSetLoadBalancerPoliciesOfListener(SetLoadBalancerPoliciesOfListenerRequest, AsyncCallback, object) Initiates the asynchronous execution of the SetLoadBalancerPoliciesOfListener operation.
Public Method ConfigureHealthCheck(ConfigureHealthCheckRequest) 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.

Public Method CreateAppCookieStickinessPolicy(CreateAppCookieStickinessPolicyRequest) 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.

Public Method CreateLBCookieStickinessPolicy(CreateLBCookieStickinessPolicyRequest) 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.

Public Method CreateLoadBalancer(CreateLoadBalancerRequest) 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.

Public Method CreateLoadBalancerListeners(CreateLoadBalancerListenersRequest) 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.

Public Method CreateLoadBalancerPolicy(CreateLoadBalancerPolicyRequest) 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.

Public Method DeleteLoadBalancer(DeleteLoadBalancerRequest) 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.

Public Method DeleteLoadBalancerListeners(DeleteLoadBalancerListenersRequest) Deletes the specified listeners from the specified load balancer.
Public Method DeleteLoadBalancerPolicy(DeleteLoadBalancerPolicyRequest) Deletes the specified policy from the specified load balancer. This policy must not be enabled for any listeners.
Public Method DeregisterInstancesFromLoadBalancer(DeregisterInstancesFromLoadBalancerRequest) 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.

Public Method DescribeInstanceHealth(DescribeInstanceHealthRequest) 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.
Public Method DescribeLoadBalancerAttributes(DescribeLoadBalancerAttributesRequest) Describes the attributes for the specified load balancer.
Public Method DescribeLoadBalancerPolicies() 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.

Public Method DescribeLoadBalancerPolicies(DescribeLoadBalancerPoliciesRequest) 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.

Public Method DescribeLoadBalancerPolicyTypes() Describes the specified load balancer policy types.

You can use these policy types with CreateLoadBalancerPolicy to create policy configurations for a load balancer.

Public Method DescribeLoadBalancerPolicyTypes(DescribeLoadBalancerPolicyTypesRequest) Describes the specified load balancer policy types.

You can use these policy types with CreateLoadBalancerPolicy to create policy configurations for a load balancer.

Public Method DescribeLoadBalancers() Describes the specified the load balancers. If no load balancers are specified, the call describes all of your load balancers.
Public Method DescribeLoadBalancers(DescribeLoadBalancersRequest) Describes the specified the load balancers. If no load balancers are specified, the call describes all of your load balancers.
Public Method DescribeTags(DescribeTagsRequest) Describes the tags associated with the specified load balancers.
Public Method DetachLoadBalancerFromSubnets(DetachLoadBalancerFromSubnetsRequest) 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.

Public Method DisableAvailabilityZonesForLoadBalancer(DisableAvailabilityZonesForLoadBalancerRequest) 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.

Public Method EnableAvailabilityZonesForLoadBalancer(EnableAvailabilityZonesForLoadBalancerRequest) 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.

Public Method EndAddTags(IAsyncResult) Finishes the asynchronous execution of the AddTags operation.
Public Method EndApplySecurityGroupsToLoadBalancer(IAsyncResult) Finishes the asynchronous execution of the ApplySecurityGroupsToLoadBalancer operation.
Public Method EndAttachLoadBalancerToSubnets(IAsyncResult) Finishes the asynchronous execution of the AttachLoadBalancerToSubnets operation.
Public Method EndConfigureHealthCheck(IAsyncResult) Finishes the asynchronous execution of the ConfigureHealthCheck operation.
Public Method EndCreateAppCookieStickinessPolicy(IAsyncResult) Finishes the asynchronous execution of the CreateAppCookieStickinessPolicy operation.
Public Method EndCreateLBCookieStickinessPolicy(IAsyncResult) Finishes the asynchronous execution of the CreateLBCookieStickinessPolicy operation.
Public Method EndCreateLoadBalancer(IAsyncResult) Finishes the asynchronous execution of the CreateLoadBalancer operation.
Public Method EndCreateLoadBalancerListeners(IAsyncResult) Finishes the asynchronous execution of the CreateLoadBalancerListeners operation.
Public Method EndCreateLoadBalancerPolicy(IAsyncResult) Finishes the asynchronous execution of the CreateLoadBalancerPolicy operation.
Public Method EndDeleteLoadBalancer(IAsyncResult) Finishes the asynchronous execution of the DeleteLoadBalancer operation.
Public Method EndDeleteLoadBalancerListeners(IAsyncResult) Finishes the asynchronous execution of the DeleteLoadBalancerListeners operation.
Public Method EndDeleteLoadBalancerPolicy(IAsyncResult) Finishes the asynchronous execution of the DeleteLoadBalancerPolicy operation.
Public Method EndDeregisterInstancesFromLoadBalancer(IAsyncResult) Finishes the asynchronous execution of the DeregisterInstancesFromLoadBalancer operation.
Public Method EndDescribeInstanceHealth(IAsyncResult) Finishes the asynchronous execution of the DescribeInstanceHealth operation.
Public Method EndDescribeLoadBalancerAttributes(IAsyncResult) Finishes the asynchronous execution of the DescribeLoadBalancerAttributes operation.
Public Method EndDescribeLoadBalancerPolicies(IAsyncResult) Finishes the asynchronous execution of the DescribeLoadBalancerPolicies operation.
Public Method EndDescribeLoadBalancerPolicyTypes(IAsyncResult) Finishes the asynchronous execution of the DescribeLoadBalancerPolicyTypes operation.
Public Method EndDescribeLoadBalancers(IAsyncResult) Finishes the asynchronous execution of the DescribeLoadBalancers operation.
Public Method EndDescribeTags(IAsyncResult) Finishes the asynchronous execution of the DescribeTags operation.
Public Method EndDetachLoadBalancerFromSubnets(IAsyncResult) Finishes the asynchronous execution of the DetachLoadBalancerFromSubnets operation.
Public Method EndDisableAvailabilityZonesForLoadBalancer(IAsyncResult) Finishes the asynchronous execution of the DisableAvailabilityZonesForLoadBalancer operation.
Public Method EndEnableAvailabilityZonesForLoadBalancer(IAsyncResult) Finishes the asynchronous execution of the EnableAvailabilityZonesForLoadBalancer operation.
Public Method EndModifyLoadBalancerAttributes(IAsyncResult) Finishes the asynchronous execution of the ModifyLoadBalancerAttributes operation.
Public Method EndRegisterInstancesWithLoadBalancer(IAsyncResult) Finishes the asynchronous execution of the RegisterInstancesWithLoadBalancer operation.
Public Method EndRemoveTags(IAsyncResult) Finishes the asynchronous execution of the RemoveTags operation.
Public Method EndSetLoadBalancerListenerSSLCertificate(IAsyncResult) Finishes the asynchronous execution of the SetLoadBalancerListenerSSLCertificate operation.
Public Method EndSetLoadBalancerPoliciesForBackendServer(IAsyncResult) Finishes the asynchronous execution of the SetLoadBalancerPoliciesForBackendServer operation.
Public Method EndSetLoadBalancerPoliciesOfListener(IAsyncResult) Finishes the asynchronous execution of the SetLoadBalancerPoliciesOfListener operation.
Public Method ModifyLoadBalancerAttributes(ModifyLoadBalancerAttributesRequest) 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:

Public Method RegisterInstancesWithLoadBalancer(RegisterInstancesWithLoadBalancerRequest) 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.

Public Method RemoveTags(RemoveTagsRequest) Removes one or more tags from the specified load balancer.
Public Method SetLoadBalancerListenerSSLCertificate(SetLoadBalancerListenerSSLCertificateRequest) 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.

Public Method SetLoadBalancerPoliciesForBackendServer(SetLoadBalancerPoliciesForBackendServerRequest) 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.

Public Method SetLoadBalancerPoliciesOfListener(SetLoadBalancerPoliciesOfListenerRequest) Associates, updates, or disables a policy with a listener for the specified load balancer. You can associate multiple policies with a listener.

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

.NET for Windows Store apps:
Supported in: Windows 8.1, Windows 8

.NET for Windows Phone:
Supported in: Windows Phone 8.1, Windows Phone 8