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

Class: Aws::ElasticLoadBalancing::Types::InstanceState

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-elasticloadbalancing/lib/aws-sdk-elasticloadbalancing/types.rb

Overview

Information about the state of an EC2 instance.

Instance Attribute Summary collapse

Instance Attribute Details

#descriptionString

A description of the instance state. This string can contain one or more of the following messages.

  • N/A

  • A transient error occurred. Please try again later.

  • Instance has failed at least the UnhealthyThreshold number of health checks consecutively.

  • Instance has not passed the configured HealthyThreshold number of health checks consecutively.

  • Instance registration is still in progress.

  • Instance is in the EC2 Availability Zone for which LoadBalancer is not configured to route traffic to.

  • Instance is not currently registered with the LoadBalancer.

  • Instance deregistration currently in progress.

  • Disable Availability Zone is currently in progress.

  • Instance is in pending state.

  • Instance is in stopped state.

  • Instance is in terminated state.

Returns:

  • (String)


1279
1280
1281
1282
1283
1284
1285
# File 'gems/aws-sdk-elasticloadbalancing/lib/aws-sdk-elasticloadbalancing/types.rb', line 1279

class InstanceState < Struct.new(
  :instance_id,
  :state,
  :reason_code,
  :description)
  include Aws::Structure
end

#instance_idString

The ID of the instance.

Returns:

  • (String)


1279
1280
1281
1282
1283
1284
1285
# File 'gems/aws-sdk-elasticloadbalancing/lib/aws-sdk-elasticloadbalancing/types.rb', line 1279

class InstanceState < Struct.new(
  :instance_id,
  :state,
  :reason_code,
  :description)
  include Aws::Structure
end

#reason_codeString

Information about the cause of OutOfService instances. Specifically, whether the cause is Elastic Load Balancing or the instance.

Valid values: ELB | Instance | N/A

Returns:

  • (String)


1279
1280
1281
1282
1283
1284
1285
# File 'gems/aws-sdk-elasticloadbalancing/lib/aws-sdk-elasticloadbalancing/types.rb', line 1279

class InstanceState < Struct.new(
  :instance_id,
  :state,
  :reason_code,
  :description)
  include Aws::Structure
end

#stateString

The current state of the instance.

Valid values: InService | OutOfService | Unknown

Returns:

  • (String)


1279
1280
1281
1282
1283
1284
1285
# File 'gems/aws-sdk-elasticloadbalancing/lib/aws-sdk-elasticloadbalancing/types.rb', line 1279

class InstanceState < Struct.new(
  :instance_id,
  :state,
  :reason_code,
  :description)
  include Aws::Structure
end