AWS SDK Version 3 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.

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 Balancer Guide.

Note:

For PCL this operation is only available in asynchronous form. Please refer to DeregisterInstancesFromLoadBalancerAsync.

Namespace: Amazon.ElasticLoadBalancing
Assembly: AWSSDK.ElasticLoadBalancing.dll
Version: 3.x.y.z

Syntax

C#
public virtual DeregisterInstancesFromLoadBalancerResponse DeregisterInstancesFromLoadBalancer(
         DeregisterInstancesFromLoadBalancerRequest request
)
Parameters
request
Type: Amazon.ElasticLoadBalancing.Model.DeregisterInstancesFromLoadBalancerRequest

Container for the necessary parameters to execute the DeregisterInstancesFromLoadBalancer service method.

Return Value
The response from the DeregisterInstancesFromLoadBalancer service method, as returned by ElasticLoadBalancing.

Exceptions

ExceptionCondition
AccessPointNotFoundException The specified load balancer does not exist.
InvalidEndPointException The specified endpoint is not valid.

Examples

This example deregisters the specified instance from the specified load balancer.

To deregister instances from a load balancer


var response = client.DeregisterInstancesFromLoadBalancer(new DeregisterInstancesFromLoadBalancerRequest 
{
    Instances = new List {
        new Instance { InstanceId = "i-d6f6fae3" }
    },
    LoadBalancerName = "my-load-balancer"
});

List instances = response.Instances;

            

Version Information

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

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms

See Also