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.

Information about a health check.

Inheritance Hierarchy

System.Object
  Amazon.ElasticLoadBalancing.Model.HealthCheck

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

Syntax

C#
public class HealthCheck

The HealthCheck type exposes the following members

Constructors

NameDescription
Public Method HealthCheck()

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

Public Method HealthCheck(string, int, int, int, int)

Instantiates HealthCheck with the parameterized properties

Properties

NameTypeDescription
Public Property HealthyThreshold System.Int32

Gets and sets the property HealthyThreshold.

The number of consecutive health checks successes required before moving the instance to the Healthy state.

Public Property Interval System.Int32

Gets and sets the property Interval.

The approximate interval, in seconds, between health checks of an individual instance.

Public Property Target System.String

Gets and sets the property Target.

The instance being checked. The protocol is either TCP, HTTP, HTTPS, or SSL. The range of valid ports is one (1) through 65535.

TCP is the default, specified as a TCP: port pair, for example "TCP:5000". In this case, a health check simply attempts to open a TCP connection to the instance on the specified port. Failure to connect within the configured timeout is considered unhealthy.

SSL is also specified as SSL: port pair, for example, SSL:5000.

For HTTP/HTTPS, you must include a ping path in the string. HTTP is specified as a HTTP:port;/;PathToPing; grouping, for example "HTTP:80/weather/us/wa/seattle". In this case, a HTTP GET request is issued to the instance on the given port and path. Any answer other than "200 OK" within the timeout period is considered unhealthy.

The total length of the HTTP ping target must be 1024 16-bit Unicode characters or less.

Public Property Timeout System.Int32

Gets and sets the property Timeout.

The amount of time, in seconds, during which no response means a failed health check.

This value must be less than the Interval value.

Public Property UnhealthyThreshold System.Int32

Gets and sets the property UnhealthyThreshold.

The number of consecutive health check failures required before moving the instance to the Unhealthy state.

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