class Aws::Lightsail::Types::InstanceHealthSummary

Describes information about the health of the instance.

@!attribute [rw] instance_name

The name of the Lightsail instance for which you are requesting
health check data.
@return [String]

@!attribute [rw] instance_health

Describes the overall instance health. Valid values are below.
@return [String]

@!attribute [rw] instance_health_reason

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

If <b> <code>instanceHealth</code> </b> is `initial`, the <b>
<code>instanceHealthReason</code> </b> value can be one of the
following:

* <b> <code>Lb.RegistrationInProgress</code> </b> - The target
  instance is in the process of being registered with the load
  balancer.

* <b> <code>Lb.InitialHealthChecking</code> </b> - The Lightsail
  load balancer is still sending the target instance the minimum
  number of health checks required to determine its health status.

If <b> <code>instanceHealth</code> </b> is `unhealthy`, the <b>
<code>instanceHealthReason</code> </b> value can be one of the
following:

* <b> <code>Instance.ResponseCodeMismatch</code> </b> - The health
  checks did not return an expected HTTP code.

* <b> <code>Instance.Timeout</code> </b> - The health check requests
  timed out.

* <b> <code>Instance.FailedHealthChecks</code> </b> - 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.

* <b> <code>Lb.InternalError</code> </b> - The health checks failed
  due to an internal error.

If <b> <code>instanceHealth</code> </b> is `unused`, the <b>
<code>instanceHealthReason</code> </b> value can be one of the
following:

* <b> <code>Instance.NotRegistered</code> </b> - The target instance
  is not registered with the target group.

* <b> <code>Instance.NotInUse</code> </b> - 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.

* <b> <code>Instance.IpUnusable</code> </b> - The target IP address
  is reserved for use by a Lightsail load balancer.

* <b> <code>Instance.InvalidState</code> </b> - The target is in the
  stopped or terminated state.

If <b> <code>instanceHealth</code> </b> is `draining`, the <b>
<code>instanceHealthReason</code> </b> value can be one of the
following:

* <b> <code>Instance.DeregistrationInProgress</code> </b> - The
  target instance is in the process of being deregistered and the
  deregistration delay period has not expired.

^
@return [String]

@see docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/InstanceHealthSummary AWS API Documentation

Constants

SENSITIVE