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 4.5
 
 

Classes

NameDescription
Class AccessLog Information about the AccessLog attribute.
Class AccessPointNotFoundException ElasticLoadBalancing exception
Class AdditionalAttribute This data type is reserved.
Class AddTagsRequest Container for the parameters to the AddTags operation. 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.

Class AddTagsResponse Configuration for accessing Amazon AddTags service
Class AddTagsResult
Class AppCookieStickinessPolicy Information about a policy for application-controlled session stickiness.
Class ApplySecurityGroupsToLoadBalancerRequest Container for the parameters to the ApplySecurityGroupsToLoadBalancer operation. 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.

Class ApplySecurityGroupsToLoadBalancerResponse Configuration for accessing Amazon ApplySecurityGroupsToLoadBalancer service
Class ApplySecurityGroupsToLoadBalancerResult
Class AttachLoadBalancerToSubnetsRequest Container for the parameters to the AttachLoadBalancerToSubnets operation. 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.

Class AttachLoadBalancerToSubnetsResponse Configuration for accessing Amazon AttachLoadBalancerToSubnets service
Class AttachLoadBalancerToSubnetsResult
Class BackendServerDescription Information about the configuration of a back-end server.
Class CertificateNotFoundException ElasticLoadBalancing exception
Class ConfigureHealthCheckRequest Container for the parameters to the ConfigureHealthCheck operation. 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.

Class ConfigureHealthCheckResponse Configuration for accessing Amazon ConfigureHealthCheck service
Class ConfigureHealthCheckResult
Class ConnectionDraining Information about the ConnectionDraining attribute.
Class ConnectionSettings Information about the ConnectionSettings attribute.
Class CreateAppCookieStickinessPolicyRequest Container for the parameters to the CreateAppCookieStickinessPolicy operation. 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.

Class CreateAppCookieStickinessPolicyResponse Configuration for accessing Amazon CreateAppCookieStickinessPolicy service
Class CreateAppCookieStickinessPolicyResult
Class CreateLBCookieStickinessPolicyRequest Container for the parameters to the CreateLBCookieStickinessPolicy operation. 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.

Class CreateLBCookieStickinessPolicyResponse Configuration for accessing Amazon CreateLBCookieStickinessPolicy service
Class CreateLBCookieStickinessPolicyResult
Class CreateLoadBalancerListenersRequest Container for the parameters to the CreateLoadBalancerListeners operation. 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.

Class CreateLoadBalancerListenersResponse Configuration for accessing Amazon CreateLoadBalancerListeners service
Class CreateLoadBalancerListenersResult
Class CreateLoadBalancerPolicyRequest Container for the parameters to the CreateLoadBalancerPolicy operation. 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.

Class CreateLoadBalancerPolicyResponse Configuration for accessing Amazon CreateLoadBalancerPolicy service
Class CreateLoadBalancerPolicyResult
Class CreateLoadBalancerRequest Container for the parameters to the CreateLoadBalancer operation. 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.

Class CreateLoadBalancerResponse Configuration for accessing Amazon CreateLoadBalancer service
Class CreateLoadBalancerResult
Class CrossZoneLoadBalancing Information about the CrossZoneLoadBalancing attribute.
Class DeleteLoadBalancerListenersRequest Container for the parameters to the DeleteLoadBalancerListeners operation. Deletes the specified listeners from the specified load balancer.
Class DeleteLoadBalancerListenersResponse Configuration for accessing Amazon DeleteLoadBalancerListeners service
Class DeleteLoadBalancerListenersResult
Class DeleteLoadBalancerPolicyRequest Container for the parameters to the DeleteLoadBalancerPolicy operation. Deletes the specified policy from the specified load balancer. This policy must not be enabled for any listeners.
Class DeleteLoadBalancerPolicyResponse Configuration for accessing Amazon DeleteLoadBalancerPolicy service
Class DeleteLoadBalancerPolicyResult
Class DeleteLoadBalancerRequest Container for the parameters to the DeleteLoadBalancer operation. 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.

Class DeleteLoadBalancerResponse Configuration for accessing Amazon DeleteLoadBalancer service
Class DeleteLoadBalancerResult
Class DeregisterInstancesFromLoadBalancerRequest Container for the parameters to the DeregisterInstancesFromLoadBalancer operation. 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.

Class DeregisterInstancesFromLoadBalancerResponse Configuration for accessing Amazon DeregisterInstancesFromLoadBalancer service
Class DeregisterInstancesFromLoadBalancerResult
Class DescribeInstanceHealthRequest Container for the parameters to the DescribeInstanceHealth operation. 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.
Class DescribeInstanceHealthResponse Configuration for accessing Amazon DescribeInstanceHealth service
Class DescribeInstanceHealthResult
Class DescribeLoadBalancerAttributesRequest Container for the parameters to the DescribeLoadBalancerAttributes operation. Describes the attributes for the specified load balancer.
Class DescribeLoadBalancerAttributesResponse Configuration for accessing Amazon DescribeLoadBalancerAttributes service
Class DescribeLoadBalancerAttributesResult
Class DescribeLoadBalancerPoliciesRequest Container for the parameters to the DescribeLoadBalancerPolicies operation. 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.

Class DescribeLoadBalancerPoliciesResponse Configuration for accessing Amazon DescribeLoadBalancerPolicies service
Class DescribeLoadBalancerPoliciesResult
Class DescribeLoadBalancerPolicyTypesRequest Container for the parameters to the DescribeLoadBalancerPolicyTypes operation. Describes the specified load balancer policy types.

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

Class DescribeLoadBalancerPolicyTypesResponse Configuration for accessing Amazon DescribeLoadBalancerPolicyTypes service
Class DescribeLoadBalancerPolicyTypesResult
Class DescribeLoadBalancersRequest Container for the parameters to the DescribeLoadBalancers operation. Describes the specified the load balancers. If no load balancers are specified, the call describes all of your load balancers.
Class DescribeLoadBalancersResponse Configuration for accessing Amazon DescribeLoadBalancers service
Class DescribeLoadBalancersResult
Class DescribeTagsRequest Container for the parameters to the DescribeTags operation. Describes the tags associated with the specified load balancers.
Class DescribeTagsResponse Configuration for accessing Amazon DescribeTags service
Class DescribeTagsResult
Class DetachLoadBalancerFromSubnetsRequest Container for the parameters to the DetachLoadBalancerFromSubnets operation. 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.

Class DetachLoadBalancerFromSubnetsResponse Configuration for accessing Amazon DetachLoadBalancerFromSubnets service
Class DetachLoadBalancerFromSubnetsResult
Class DisableAvailabilityZonesForLoadBalancerRequest Container for the parameters to the DisableAvailabilityZonesForLoadBalancer operation. 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.

Class DisableAvailabilityZonesForLoadBalancerResponse Configuration for accessing Amazon DisableAvailabilityZonesForLoadBalancer service
Class DisableAvailabilityZonesForLoadBalancerResult
Class DuplicateAccessPointNameException ElasticLoadBalancing exception
Class DuplicateListenerException ElasticLoadBalancing exception
Class DuplicateLoadBalancerNameException AmazonElasticLoadBalancing exception
Class DuplicatePolicyNameException ElasticLoadBalancing exception
Class DuplicateTagKeysException ElasticLoadBalancing exception
Class EnableAvailabilityZonesForLoadBalancerRequest Container for the parameters to the EnableAvailabilityZonesForLoadBalancer operation. 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.

Class EnableAvailabilityZonesForLoadBalancerResponse Configuration for accessing Amazon EnableAvailabilityZonesForLoadBalancer service
Class EnableAvailabilityZonesForLoadBalancerResult
Class HealthCheck Information about a health check.
Class Instance The ID of a back-end instance.
Class InstanceState Information about the state of a back-end instance.
Class InvalidConfigurationRequestException ElasticLoadBalancing exception
Class InvalidEndPointException ElasticLoadBalancing exception
Class InvalidInstanceException AmazonElasticLoadBalancing exception
Class InvalidSchemeException ElasticLoadBalancing exception
Class InvalidSecurityGroupException ElasticLoadBalancing exception
Class InvalidSubnetException ElasticLoadBalancing exception
Class LBCookieStickinessPolicy Information about a policy for duration-based session stickiness.
Class Listener Information about a listener.

For information about the protocols and the ports supported by Elastic Load Balancing, see Listener Configurations for Elastic Load Balancing in the Elastic Load Balancing Developer Guide.

Class ListenerDescription The policies enabled for a listener.
Class ListenerNotFoundException ElasticLoadBalancing exception
Class LoadBalancerAttributeNotFoundException ElasticLoadBalancing exception
Class LoadBalancerAttributes The attributes for a load balancer.
Class LoadBalancerDescription Information about a load balancer.
Class LoadBalancerNotFoundException AmazonElasticLoadBalancing exception
Class ModifyLoadBalancerAttributesRequest Container for the parameters to the ModifyLoadBalancerAttributes operation. 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:

Class ModifyLoadBalancerAttributesResponse Configuration for accessing Amazon ModifyLoadBalancerAttributes service
Class ModifyLoadBalancerAttributesResult
Class Policies The policies for a load balancer.
Class PolicyAttribute Information about a policy attribute.
Class PolicyAttributeDescription Information about a policy attribute.
Class PolicyAttributeTypeDescription Information about a policy attribute type.
Class PolicyDescription Information about a policy.
Class PolicyNotFoundException ElasticLoadBalancing exception
Class PolicyTypeDescription Information about a policy type.
Class PolicyTypeNotFoundException ElasticLoadBalancing exception
Class RegisterInstancesWithLoadBalancerRequest Container for the parameters to the RegisterInstancesWithLoadBalancer operation. 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.

Class RegisterInstancesWithLoadBalancerResponse Configuration for accessing Amazon RegisterInstancesWithLoadBalancer service
Class RegisterInstancesWithLoadBalancerResult
Class RemoveTagsRequest Container for the parameters to the RemoveTags operation. Removes one or more tags from the specified load balancer.
Class RemoveTagsResponse Configuration for accessing Amazon RemoveTags service
Class RemoveTagsResult
Class SetLoadBalancerListenerSSLCertificateRequest Container for the parameters to the SetLoadBalancerListenerSSLCertificate operation. 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.

Class SetLoadBalancerListenerSSLCertificateResponse Configuration for accessing Amazon SetLoadBalancerListenerSSLCertificate service
Class SetLoadBalancerListenerSSLCertificateResult
Class SetLoadBalancerPoliciesForBackendServerRequest Container for the parameters to the SetLoadBalancerPoliciesForBackendServer operation. 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.

Class SetLoadBalancerPoliciesForBackendServerResponse Configuration for accessing Amazon SetLoadBalancerPoliciesForBackendServer service
Class SetLoadBalancerPoliciesForBackendServerResult
Class SetLoadBalancerPoliciesOfListenerRequest Container for the parameters to the SetLoadBalancerPoliciesOfListener operation. Associates, updates, or disables a policy with a listener for the specified load balancer. You can associate multiple policies with a listener.
Class SetLoadBalancerPoliciesOfListenerResponse Configuration for accessing Amazon SetLoadBalancerPoliciesOfListener service
Class SetLoadBalancerPoliciesOfListenerResult
Class SourceSecurityGroup Information about a source security group.
Class SubnetNotFoundException ElasticLoadBalancing exception
Class Tag Information about a tag.
Class TagDescription The tags associated with a load balancer.
Class TagKeyOnly The key of a tag.
Class TooManyAccessPointsException ElasticLoadBalancing exception
Class TooManyLoadBalancersException AmazonElasticLoadBalancing exception
Class TooManyPoliciesException ElasticLoadBalancing exception
Class TooManyTagsException ElasticLoadBalancing exception