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.

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.

To deregister instances from a load balancer, use DeregisterInstancesFromLoadBalancer.

For more information, see Register or De-Register EC2 Instances in the Classic Load Balancer Guide.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingRequest
      Amazon.ElasticLoadBalancing.Model.RegisterInstancesWithLoadBalancerRequest

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

Syntax

C#
public class RegisterInstancesWithLoadBalancerRequest : AmazonElasticLoadBalancingRequest
         IAmazonWebServiceRequest

The RegisterInstancesWithLoadBalancerRequest type exposes the following members

Constructors

NameDescription
Public Method RegisterInstancesWithLoadBalancerRequest()

Empty constructor used to set properties independently even when a simple constructor is available

Public Method RegisterInstancesWithLoadBalancerRequest(string, List<Instance>)

Instantiates RegisterInstancesWithLoadBalancerRequest with the parameterized properties

Properties

NameTypeDescription
Public Property Instances System.Collections.Generic.List<Amazon.ElasticLoadBalancing.Model.Instance>

Gets and sets the property Instances.

The IDs of the instances.

Public Property LoadBalancerName System.String

Gets and sets the property LoadBalancerName.

The name of the load balancer.

Examples

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

To register instances with a load balancer


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

List instances = response.Instances;

            

Version Information

.NET Standard:
Supported in: 1.3

.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