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

Inheritance Hierarchy

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

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

Syntax

C#
public class DescribeInstanceHealthRequest : AmazonElasticLoadBalancingRequest
         IAmazonWebServiceRequest

The DescribeInstanceHealthRequest type exposes the following members

Constructors

NameDescription
Public Method DescribeInstanceHealthRequest()

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

Public Method DescribeInstanceHealthRequest(string)

Instantiates DescribeInstanceHealthRequest 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 describes the health of the instances for the specified load balancer.

To describe the health of the instances for a load balancer


var response = client.DescribeInstanceHealth(new DescribeInstanceHealthRequest 
{
    LoadBalancerName = "my-load-balancer"
});

List instanceStates = response.InstanceStates;

            

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