You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::ElasticLoadBalancingV2::Types::TargetHealth

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Information about the current health of a target.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#descriptionString

A description of the target health that provides additional details. If the state is healthy, a description is not provided.

Returns:

  • (String)

    A description of the target health that provides additional details.

#reasonString

The reason code.

If the target state is healthy, a reason code is not provided.

If the target state is initial, the reason code can be one of the following values:

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

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

If the target state is unhealthy, the reason code can be one of the following values:

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

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

  • Target.FailedHealthChecks - The load balancer received an error while establishing a connection to the target or the target response was malformed.

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

If the target state is unused, the reason code can be one of the following values:

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

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

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

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

If the target state is draining, the reason code can be the following value:

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

^

If the target state is unavailable, the reason code can be the following value:

  • Target.HealthCheckDisabled - Health checks are disabled for the target group.

^

Possible values:

  • Elb.RegistrationInProgress
  • Elb.InitialHealthChecking
  • Target.ResponseCodeMismatch
  • Target.Timeout
  • Target.FailedHealthChecks
  • Target.NotRegistered
  • Target.NotInUse
  • Target.DeregistrationInProgress
  • Target.InvalidState
  • Target.IpUnusable
  • Target.HealthCheckDisabled
  • Elb.InternalError

Returns:

  • (String)

    The reason code.

#stateString

The state of the target.

Possible values:

  • initial
  • healthy
  • unhealthy
  • unused
  • draining
  • unavailable

Returns:

  • (String)

    The state of the target.