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 DescribeTargetHealth operation. Describes the health of the specified targets or all of your targets.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.ElasticLoadBalancingV2.AmazonElasticLoadBalancingV2Request
      Amazon.ElasticLoadBalancingV2.Model.DescribeTargetHealthRequest

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

Syntax

C#
public class DescribeTargetHealthRequest : AmazonElasticLoadBalancingV2Request
         IAmazonWebServiceRequest

The DescribeTargetHealthRequest type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property TargetGroupArn System.String

Gets and sets the property TargetGroupArn.

The Amazon Resource Name (ARN) of the target group.

Public Property Targets System.Collections.Generic.List<Amazon.ElasticLoadBalancingV2.Model.TargetDescription>

Gets and sets the property Targets.

The targets.

Examples

This example describes the health of the targets for the specified target group. One target is healthy but the other is not specified in an action, so it can't receive traffic from the load balancer.

To describe the health of the targets for a target group


var response = client.DescribeTargetHealth(new DescribeTargetHealthRequest 
{
    TargetGroupArn = "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067"
});

List targetHealthDescriptions = response.TargetHealthDescriptions;

            

This example describes the health of the specified target. This target is healthy.

To describe the health of a target


var response = client.DescribeTargetHealth(new DescribeTargetHealthRequest 
{
    TargetGroupArn = "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067",
    Targets = new List {
        new TargetDescription {
            Id = "i-0f76fade",
            Port = 80
        }
    }
});

List targetHealthDescriptions = response.TargetHealthDescriptions;

            

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