AWS SDK for C++  1.8.73
AWS SDK for C++
Public Member Functions | List of all members
Aws::ElasticLoadBalancing::Model::HealthCheck Class Reference

#include <HealthCheck.h>

Public Member Functions

 HealthCheck ()
 
 HealthCheck (const Aws::Utils::Xml::XmlNode &xmlNode)
 
HealthCheckoperator= (const Aws::Utils::Xml::XmlNode &xmlNode)
 
void OutputToStream (Aws::OStream &ostream, const char *location, unsigned index, const char *locationValue) const
 
void OutputToStream (Aws::OStream &oStream, const char *location) const
 
const Aws::StringGetTarget () const
 
bool TargetHasBeenSet () const
 
void SetTarget (const Aws::String &value)
 
void SetTarget (Aws::String &&value)
 
void SetTarget (const char *value)
 
HealthCheckWithTarget (const Aws::String &value)
 
HealthCheckWithTarget (Aws::String &&value)
 
HealthCheckWithTarget (const char *value)
 
int GetInterval () const
 
bool IntervalHasBeenSet () const
 
void SetInterval (int value)
 
HealthCheckWithInterval (int value)
 
int GetTimeout () const
 
bool TimeoutHasBeenSet () const
 
void SetTimeout (int value)
 
HealthCheckWithTimeout (int value)
 
int GetUnhealthyThreshold () const
 
bool UnhealthyThresholdHasBeenSet () const
 
void SetUnhealthyThreshold (int value)
 
HealthCheckWithUnhealthyThreshold (int value)
 
int GetHealthyThreshold () const
 
bool HealthyThresholdHasBeenSet () const
 
void SetHealthyThreshold (int value)
 
HealthCheckWithHealthyThreshold (int value)
 

Detailed Description

Information about a health check.

See Also:

AWS API Reference

Definition at line 31 of file HealthCheck.h.

Constructor & Destructor Documentation

◆ HealthCheck() [1/2]

Aws::ElasticLoadBalancing::Model::HealthCheck::HealthCheck ( )

◆ HealthCheck() [2/2]

Aws::ElasticLoadBalancing::Model::HealthCheck::HealthCheck ( const Aws::Utils::Xml::XmlNode xmlNode)

Member Function Documentation

◆ GetHealthyThreshold()

int Aws::ElasticLoadBalancing::Model::HealthCheck::GetHealthyThreshold ( ) const
inline

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

Definition at line 254 of file HealthCheck.h.

◆ GetInterval()

int Aws::ElasticLoadBalancing::Model::HealthCheck::GetInterval ( ) const
inline

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

Definition at line 175 of file HealthCheck.h.

◆ GetTarget()

const Aws::String& Aws::ElasticLoadBalancing::Model::HealthCheck::GetTarget ( ) const
inline

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.

Definition at line 56 of file HealthCheck.h.

◆ GetTimeout()

int Aws::ElasticLoadBalancing::Model::HealthCheck::GetTimeout ( ) const
inline

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

This value must be less than the Interval value.

Definition at line 201 of file HealthCheck.h.

◆ GetUnhealthyThreshold()

int Aws::ElasticLoadBalancing::Model::HealthCheck::GetUnhealthyThreshold ( ) const
inline

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

Definition at line 229 of file HealthCheck.h.

◆ HealthyThresholdHasBeenSet()

bool Aws::ElasticLoadBalancing::Model::HealthCheck::HealthyThresholdHasBeenSet ( ) const
inline

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

Definition at line 260 of file HealthCheck.h.

◆ IntervalHasBeenSet()

bool Aws::ElasticLoadBalancing::Model::HealthCheck::IntervalHasBeenSet ( ) const
inline

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

Definition at line 181 of file HealthCheck.h.

◆ operator=()

HealthCheck& Aws::ElasticLoadBalancing::Model::HealthCheck::operator= ( const Aws::Utils::Xml::XmlNode xmlNode)

◆ OutputToStream() [1/2]

void Aws::ElasticLoadBalancing::Model::HealthCheck::OutputToStream ( Aws::OStream ostream,
const char *  location,
unsigned  index,
const char *  locationValue 
) const

◆ OutputToStream() [2/2]

void Aws::ElasticLoadBalancing::Model::HealthCheck::OutputToStream ( Aws::OStream oStream,
const char *  location 
) const

◆ SetHealthyThreshold()

void Aws::ElasticLoadBalancing::Model::HealthCheck::SetHealthyThreshold ( int  value)
inline

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

Definition at line 266 of file HealthCheck.h.

◆ SetInterval()

void Aws::ElasticLoadBalancing::Model::HealthCheck::SetInterval ( int  value)
inline

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

Definition at line 187 of file HealthCheck.h.

◆ SetTarget() [1/3]

void Aws::ElasticLoadBalancing::Model::HealthCheck::SetTarget ( const Aws::String value)
inline

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.

Definition at line 88 of file HealthCheck.h.

◆ SetTarget() [2/3]

void Aws::ElasticLoadBalancing::Model::HealthCheck::SetTarget ( Aws::String &&  value)
inline

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.

Definition at line 104 of file HealthCheck.h.

◆ SetTarget() [3/3]

void Aws::ElasticLoadBalancing::Model::HealthCheck::SetTarget ( const char *  value)
inline

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.

Definition at line 120 of file HealthCheck.h.

◆ SetTimeout()

void Aws::ElasticLoadBalancing::Model::HealthCheck::SetTimeout ( int  value)
inline

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

This value must be less than the Interval value.

Definition at line 215 of file HealthCheck.h.

◆ SetUnhealthyThreshold()

void Aws::ElasticLoadBalancing::Model::HealthCheck::SetUnhealthyThreshold ( int  value)
inline

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

Definition at line 241 of file HealthCheck.h.

◆ TargetHasBeenSet()

bool Aws::ElasticLoadBalancing::Model::HealthCheck::TargetHasBeenSet ( ) const
inline

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.

Definition at line 72 of file HealthCheck.h.

◆ TimeoutHasBeenSet()

bool Aws::ElasticLoadBalancing::Model::HealthCheck::TimeoutHasBeenSet ( ) const
inline

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

This value must be less than the Interval value.

Definition at line 208 of file HealthCheck.h.

◆ UnhealthyThresholdHasBeenSet()

bool Aws::ElasticLoadBalancing::Model::HealthCheck::UnhealthyThresholdHasBeenSet ( ) const
inline

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

Definition at line 235 of file HealthCheck.h.

◆ WithHealthyThreshold()

HealthCheck& Aws::ElasticLoadBalancing::Model::HealthCheck::WithHealthyThreshold ( int  value)
inline

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

Definition at line 272 of file HealthCheck.h.

◆ WithInterval()

HealthCheck& Aws::ElasticLoadBalancing::Model::HealthCheck::WithInterval ( int  value)
inline

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

Definition at line 193 of file HealthCheck.h.

◆ WithTarget() [1/3]

HealthCheck& Aws::ElasticLoadBalancing::Model::HealthCheck::WithTarget ( const Aws::String value)
inline

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.

Definition at line 136 of file HealthCheck.h.

◆ WithTarget() [2/3]

HealthCheck& Aws::ElasticLoadBalancing::Model::HealthCheck::WithTarget ( Aws::String &&  value)
inline

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.

Definition at line 152 of file HealthCheck.h.

◆ WithTarget() [3/3]

HealthCheck& Aws::ElasticLoadBalancing::Model::HealthCheck::WithTarget ( const char *  value)
inline

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.

Definition at line 168 of file HealthCheck.h.

◆ WithTimeout()

HealthCheck& Aws::ElasticLoadBalancing::Model::HealthCheck::WithTimeout ( int  value)
inline

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

This value must be less than the Interval value.

Definition at line 222 of file HealthCheck.h.

◆ WithUnhealthyThreshold()

HealthCheck& Aws::ElasticLoadBalancing::Model::HealthCheck::WithUnhealthyThreshold ( int  value)
inline

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

Definition at line 247 of file HealthCheck.h.


The documentation for this class was generated from the following file: