AWS SDK for C++  1.8.95
AWS SDK for C++
Public Member Functions | List of all members
Aws::Lightsail::Model::InstanceHealthSummary Class Reference

#include <InstanceHealthSummary.h>

Public Member Functions

 InstanceHealthSummary ()
 
 InstanceHealthSummary (Aws::Utils::Json::JsonView jsonValue)
 
InstanceHealthSummaryoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetInstanceName () const
 
bool InstanceNameHasBeenSet () const
 
void SetInstanceName (const Aws::String &value)
 
void SetInstanceName (Aws::String &&value)
 
void SetInstanceName (const char *value)
 
InstanceHealthSummaryWithInstanceName (const Aws::String &value)
 
InstanceHealthSummaryWithInstanceName (Aws::String &&value)
 
InstanceHealthSummaryWithInstanceName (const char *value)
 
const InstanceHealthStateGetInstanceHealth () const
 
bool InstanceHealthHasBeenSet () const
 
void SetInstanceHealth (const InstanceHealthState &value)
 
void SetInstanceHealth (InstanceHealthState &&value)
 
InstanceHealthSummaryWithInstanceHealth (const InstanceHealthState &value)
 
InstanceHealthSummaryWithInstanceHealth (InstanceHealthState &&value)
 
const InstanceHealthReasonGetInstanceHealthReason () const
 
bool InstanceHealthReasonHasBeenSet () const
 
void SetInstanceHealthReason (const InstanceHealthReason &value)
 
void SetInstanceHealthReason (InstanceHealthReason &&value)
 
InstanceHealthSummaryWithInstanceHealthReason (const InstanceHealthReason &value)
 
InstanceHealthSummaryWithInstanceHealthReason (InstanceHealthReason &&value)
 

Detailed Description

Describes information about the health of the instance.

See Also:

AWS API Reference

Definition at line 34 of file InstanceHealthSummary.h.

Constructor & Destructor Documentation

◆ InstanceHealthSummary() [1/2]

Aws::Lightsail::Model::InstanceHealthSummary::InstanceHealthSummary ( )

◆ InstanceHealthSummary() [2/2]

Aws::Lightsail::Model::InstanceHealthSummary::InstanceHealthSummary ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ GetInstanceHealth()

const InstanceHealthState& Aws::Lightsail::Model::InstanceHealthSummary::GetInstanceHealth ( ) const
inline

Describes the overall instance health. Valid values are below.

Definition at line 95 of file InstanceHealthSummary.h.

◆ GetInstanceHealthReason()

const InstanceHealthReason& Aws::Lightsail::Model::InstanceHealthSummary::GetInstanceHealthReason ( ) const
inline

More information about the instance health. If the instanceHealth is healthy, then an instanceHealthReason value is not provided.

If instanceHealth is initial, the instanceHealthReason value can be one of the following:

  • Lb.RegistrationInProgress - The target instance is in the process of being registered with the load balancer.

  • Lb.InitialHealthChecking - The Lightsail load balancer is still sending the target instance the minimum number of health checks required to determine its health status.

If instanceHealth is unhealthy, the instanceHealthReason value can be one of the following:

  • Instance.ResponseCodeMismatch - The health checks did not return an expected HTTP code.

  • Instance.Timeout - The health check requests timed out.

  • Instance.FailedHealthChecks - The health checks failed because the connection to the target instance timed out, the target instance response was malformed, or the target instance failed the health check for an unknown reason.

  • Lb.InternalError - The health checks failed due to an internal error.

If instanceHealth is unused, the instanceHealthReason value can be one of the following:

  • Instance.NotRegistered - The target instance is not registered with the target group.

  • Instance.NotInUse - The target group is not used by any load balancer, or the target instance is in an Availability Zone that is not enabled for its load balancer.

  • Instance.IpUnusable - The target IP address is reserved for use by a Lightsail load balancer.

  • Instance.InvalidState - The target is in the stopped or terminated state.

If instanceHealth is draining, the instanceHealthReason value can be one of the following:

  • Instance.DeregistrationInProgress - The target instance is in the process of being deregistered and the deregistration delay period has not expired.

Definition at line 161 of file InstanceHealthSummary.h.

◆ GetInstanceName()

const Aws::String& Aws::Lightsail::Model::InstanceHealthSummary::GetInstanceName ( ) const
inline

The name of the Lightsail instance for which you are requesting health check data.

Definition at line 47 of file InstanceHealthSummary.h.

◆ InstanceHealthHasBeenSet()

bool Aws::Lightsail::Model::InstanceHealthSummary::InstanceHealthHasBeenSet ( ) const
inline

Describes the overall instance health. Valid values are below.

Definition at line 100 of file InstanceHealthSummary.h.

◆ InstanceHealthReasonHasBeenSet()

bool Aws::Lightsail::Model::InstanceHealthSummary::InstanceHealthReasonHasBeenSet ( ) const
inline

More information about the instance health. If the instanceHealth is healthy, then an instanceHealthReason value is not provided.

If instanceHealth is initial, the instanceHealthReason value can be one of the following:

  • Lb.RegistrationInProgress - The target instance is in the process of being registered with the load balancer.

  • Lb.InitialHealthChecking - The Lightsail load balancer is still sending the target instance the minimum number of health checks required to determine its health status.

If instanceHealth is unhealthy, the instanceHealthReason value can be one of the following:

  • Instance.ResponseCodeMismatch - The health checks did not return an expected HTTP code.

  • Instance.Timeout - The health check requests timed out.

  • Instance.FailedHealthChecks - The health checks failed because the connection to the target instance timed out, the target instance response was malformed, or the target instance failed the health check for an unknown reason.

  • Lb.InternalError - The health checks failed due to an internal error.

If instanceHealth is unused, the instanceHealthReason value can be one of the following:

  • Instance.NotRegistered - The target instance is not registered with the target group.

  • Instance.NotInUse - The target group is not used by any load balancer, or the target instance is in an Availability Zone that is not enabled for its load balancer.

  • Instance.IpUnusable - The target IP address is reserved for use by a Lightsail load balancer.

  • Instance.InvalidState - The target is in the stopped or terminated state.

If instanceHealth is draining, the instanceHealthReason value can be one of the following:

  • Instance.DeregistrationInProgress - The target instance is in the process of being deregistered and the deregistration delay period has not expired.

Definition at line 201 of file InstanceHealthSummary.h.

◆ InstanceNameHasBeenSet()

bool Aws::Lightsail::Model::InstanceHealthSummary::InstanceNameHasBeenSet ( ) const
inline

The name of the Lightsail instance for which you are requesting health check data.

Definition at line 53 of file InstanceHealthSummary.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::Lightsail::Model::InstanceHealthSummary::Jsonize ( ) const

◆ operator=()

InstanceHealthSummary& Aws::Lightsail::Model::InstanceHealthSummary::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ SetInstanceHealth() [1/2]

void Aws::Lightsail::Model::InstanceHealthSummary::SetInstanceHealth ( const InstanceHealthState value)
inline

Describes the overall instance health. Valid values are below.

Definition at line 105 of file InstanceHealthSummary.h.

◆ SetInstanceHealth() [2/2]

void Aws::Lightsail::Model::InstanceHealthSummary::SetInstanceHealth ( InstanceHealthState &&  value)
inline

Describes the overall instance health. Valid values are below.

Definition at line 110 of file InstanceHealthSummary.h.

◆ SetInstanceHealthReason() [1/2]

void Aws::Lightsail::Model::InstanceHealthSummary::SetInstanceHealthReason ( const InstanceHealthReason value)
inline

More information about the instance health. If the instanceHealth is healthy, then an instanceHealthReason value is not provided.

If instanceHealth is initial, the instanceHealthReason value can be one of the following:

  • Lb.RegistrationInProgress - The target instance is in the process of being registered with the load balancer.

  • Lb.InitialHealthChecking - The Lightsail load balancer is still sending the target instance the minimum number of health checks required to determine its health status.

If instanceHealth is unhealthy, the instanceHealthReason value can be one of the following:

  • Instance.ResponseCodeMismatch - The health checks did not return an expected HTTP code.

  • Instance.Timeout - The health check requests timed out.

  • Instance.FailedHealthChecks - The health checks failed because the connection to the target instance timed out, the target instance response was malformed, or the target instance failed the health check for an unknown reason.

  • Lb.InternalError - The health checks failed due to an internal error.

If instanceHealth is unused, the instanceHealthReason value can be one of the following:

  • Instance.NotRegistered - The target instance is not registered with the target group.

  • Instance.NotInUse - The target group is not used by any load balancer, or the target instance is in an Availability Zone that is not enabled for its load balancer.

  • Instance.IpUnusable - The target IP address is reserved for use by a Lightsail load balancer.

  • Instance.InvalidState - The target is in the stopped or terminated state.

If instanceHealth is draining, the instanceHealthReason value can be one of the following:

  • Instance.DeregistrationInProgress - The target instance is in the process of being deregistered and the deregistration delay period has not expired.

Definition at line 241 of file InstanceHealthSummary.h.

◆ SetInstanceHealthReason() [2/2]

void Aws::Lightsail::Model::InstanceHealthSummary::SetInstanceHealthReason ( InstanceHealthReason &&  value)
inline

More information about the instance health. If the instanceHealth is healthy, then an instanceHealthReason value is not provided.

If instanceHealth is initial, the instanceHealthReason value can be one of the following:

  • Lb.RegistrationInProgress - The target instance is in the process of being registered with the load balancer.

  • Lb.InitialHealthChecking - The Lightsail load balancer is still sending the target instance the minimum number of health checks required to determine its health status.

If instanceHealth is unhealthy, the instanceHealthReason value can be one of the following:

  • Instance.ResponseCodeMismatch - The health checks did not return an expected HTTP code.

  • Instance.Timeout - The health check requests timed out.

  • Instance.FailedHealthChecks - The health checks failed because the connection to the target instance timed out, the target instance response was malformed, or the target instance failed the health check for an unknown reason.

  • Lb.InternalError - The health checks failed due to an internal error.

If instanceHealth is unused, the instanceHealthReason value can be one of the following:

  • Instance.NotRegistered - The target instance is not registered with the target group.

  • Instance.NotInUse - The target group is not used by any load balancer, or the target instance is in an Availability Zone that is not enabled for its load balancer.

  • Instance.IpUnusable - The target IP address is reserved for use by a Lightsail load balancer.

  • Instance.InvalidState - The target is in the stopped or terminated state.

If instanceHealth is draining, the instanceHealthReason value can be one of the following:

  • Instance.DeregistrationInProgress - The target instance is in the process of being deregistered and the deregistration delay period has not expired.

Definition at line 281 of file InstanceHealthSummary.h.

◆ SetInstanceName() [1/3]

void Aws::Lightsail::Model::InstanceHealthSummary::SetInstanceName ( const Aws::String value)
inline

The name of the Lightsail instance for which you are requesting health check data.

Definition at line 59 of file InstanceHealthSummary.h.

◆ SetInstanceName() [2/3]

void Aws::Lightsail::Model::InstanceHealthSummary::SetInstanceName ( Aws::String &&  value)
inline

The name of the Lightsail instance for which you are requesting health check data.

Definition at line 65 of file InstanceHealthSummary.h.

◆ SetInstanceName() [3/3]

void Aws::Lightsail::Model::InstanceHealthSummary::SetInstanceName ( const char *  value)
inline

The name of the Lightsail instance for which you are requesting health check data.

Definition at line 71 of file InstanceHealthSummary.h.

◆ WithInstanceHealth() [1/2]

InstanceHealthSummary& Aws::Lightsail::Model::InstanceHealthSummary::WithInstanceHealth ( const InstanceHealthState value)
inline

Describes the overall instance health. Valid values are below.

Definition at line 115 of file InstanceHealthSummary.h.

◆ WithInstanceHealth() [2/2]

InstanceHealthSummary& Aws::Lightsail::Model::InstanceHealthSummary::WithInstanceHealth ( InstanceHealthState &&  value)
inline

Describes the overall instance health. Valid values are below.

Definition at line 120 of file InstanceHealthSummary.h.

◆ WithInstanceHealthReason() [1/2]

InstanceHealthSummary& Aws::Lightsail::Model::InstanceHealthSummary::WithInstanceHealthReason ( const InstanceHealthReason value)
inline

More information about the instance health. If the instanceHealth is healthy, then an instanceHealthReason value is not provided.

If instanceHealth is initial, the instanceHealthReason value can be one of the following:

  • Lb.RegistrationInProgress - The target instance is in the process of being registered with the load balancer.

  • Lb.InitialHealthChecking - The Lightsail load balancer is still sending the target instance the minimum number of health checks required to determine its health status.

If instanceHealth is unhealthy, the instanceHealthReason value can be one of the following:

  • Instance.ResponseCodeMismatch - The health checks did not return an expected HTTP code.

  • Instance.Timeout - The health check requests timed out.

  • Instance.FailedHealthChecks - The health checks failed because the connection to the target instance timed out, the target instance response was malformed, or the target instance failed the health check for an unknown reason.

  • Lb.InternalError - The health checks failed due to an internal error.

If instanceHealth is unused, the instanceHealthReason value can be one of the following:

  • Instance.NotRegistered - The target instance is not registered with the target group.

  • Instance.NotInUse - The target group is not used by any load balancer, or the target instance is in an Availability Zone that is not enabled for its load balancer.

  • Instance.IpUnusable - The target IP address is reserved for use by a Lightsail load balancer.

  • Instance.InvalidState - The target is in the stopped or terminated state.

If instanceHealth is draining, the instanceHealthReason value can be one of the following:

  • Instance.DeregistrationInProgress - The target instance is in the process of being deregistered and the deregistration delay period has not expired.

Definition at line 321 of file InstanceHealthSummary.h.

◆ WithInstanceHealthReason() [2/2]

InstanceHealthSummary& Aws::Lightsail::Model::InstanceHealthSummary::WithInstanceHealthReason ( InstanceHealthReason &&  value)
inline

More information about the instance health. If the instanceHealth is healthy, then an instanceHealthReason value is not provided.

If instanceHealth is initial, the instanceHealthReason value can be one of the following:

  • Lb.RegistrationInProgress - The target instance is in the process of being registered with the load balancer.

  • Lb.InitialHealthChecking - The Lightsail load balancer is still sending the target instance the minimum number of health checks required to determine its health status.

If instanceHealth is unhealthy, the instanceHealthReason value can be one of the following:

  • Instance.ResponseCodeMismatch - The health checks did not return an expected HTTP code.

  • Instance.Timeout - The health check requests timed out.

  • Instance.FailedHealthChecks - The health checks failed because the connection to the target instance timed out, the target instance response was malformed, or the target instance failed the health check for an unknown reason.

  • Lb.InternalError - The health checks failed due to an internal error.

If instanceHealth is unused, the instanceHealthReason value can be one of the following:

  • Instance.NotRegistered - The target instance is not registered with the target group.

  • Instance.NotInUse - The target group is not used by any load balancer, or the target instance is in an Availability Zone that is not enabled for its load balancer.

  • Instance.IpUnusable - The target IP address is reserved for use by a Lightsail load balancer.

  • Instance.InvalidState - The target is in the stopped or terminated state.

If instanceHealth is draining, the instanceHealthReason value can be one of the following:

  • Instance.DeregistrationInProgress - The target instance is in the process of being deregistered and the deregistration delay period has not expired.

Definition at line 361 of file InstanceHealthSummary.h.

◆ WithInstanceName() [1/3]

InstanceHealthSummary& Aws::Lightsail::Model::InstanceHealthSummary::WithInstanceName ( const Aws::String value)
inline

The name of the Lightsail instance for which you are requesting health check data.

Definition at line 77 of file InstanceHealthSummary.h.

◆ WithInstanceName() [2/3]

InstanceHealthSummary& Aws::Lightsail::Model::InstanceHealthSummary::WithInstanceName ( Aws::String &&  value)
inline

The name of the Lightsail instance for which you are requesting health check data.

Definition at line 83 of file InstanceHealthSummary.h.

◆ WithInstanceName() [3/3]

InstanceHealthSummary& Aws::Lightsail::Model::InstanceHealthSummary::WithInstanceName ( const char *  value)
inline

The name of the Lightsail instance for which you are requesting health check data.

Definition at line 89 of file InstanceHealthSummary.h.


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