IAmazonElasticLoadBalancing.RegisterInstancesWithLoadBalancer Method (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.

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.

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to RegisterInstancesWithLoadBalancerAsync.

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

Syntax

public abstract RegisterInstancesWithLoadBalancerResponse RegisterInstancesWithLoadBalancer(
         RegisterInstancesWithLoadBalancerRequest request
)

Parameters

request: Type: Amazon.ElasticLoadBalancing.Model.RegisterInstancesWithLoadBalancerRequest

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

Return Value

Type: RegisterInstancesWithLoadBalancerResponse

The response from the RegisterInstancesWithLoadBalancer service method, as returned by ElasticLoadBalancing.

Exceptions

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

Examples

This example registers the specified instance with the specified load balancer.

To register instances with a load balancer


var client = new AmazonElasticLoadBalancingClient();
var response = client.RegisterInstancesWithLoadBalancer(new RegisterInstancesWithLoadBalancerRequest 
{
    Instances = new List<Instance> {
        new Instance { InstanceId = "i-d6f6fae3" }
    },
    LoadBalancerName = "my-load-balancer"
});

List<Instance> instances = response.Instances;

Version Information

.NET Framework:
Supported in: 4.5 and newer, 3.5

IAmazonElasticLoadBalancing.RegisterInstancesWithLoadBalancer (RegisterInstancesWithLoadBalancerRequest)

Method