InstanceState

Amazon Elastic Load Balancing: 2009-05-15

previous page next page

InstanceState

The InstanceState data type.

Relevant Operations

Contents

The following table describes the elements contained in instancestate.

Name Description

InstanceId

EC2 instance ID of the instance.

Type: string

State

Current status of the instance:

  • The state can be InService, when traffic is being routed to the instance by the LoadBalancer

  • The state can be OutOfService, when traffic is not being routed to the instance by the LoadBalancer

Type: string

ReasonCode

ReasonCode returns a string that provides more information about the cause of OutOfService instances. Specifically, it indicates whether the cause is Elastic Load Balancing or the instance behind the Load Balancer.

See the Description element of this data type.

Type: string

Description

Possible reasons for an OutOfService state include the following:

  • Health checks to the instance are failing, or at a minimum have consecutively failed the UnhealthyThreshold number of health checks, and therefore is not considered healthy

  • The registered instance has not consecutively passed the configured HealthyThreshold number of health checks, and therefore is still not yet considered healthy

  • The LoadBalancer (of the given LoadBalancer name) is not available

  • The instance has terminated

  • The instance is in an EC2 Availability Zone that the LoadBalancer has not been configured to route traffic to

For more information about health checks, please see the HealthCheck data type and the API, ConfigureHealthCheck.

Type: string
previous page start next page