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

Class: Aws::ElasticLoadBalancing::Types::HealthCheck

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

Overview

Note:

When making an API call, you may pass HealthCheck data as a hash:

{
  target: "HealthCheckTarget", # required
  interval: 1, # required
  timeout: 1, # required
  unhealthy_threshold: 1, # required
  healthy_threshold: 1, # required
}

Information about a health check.

Instance Attribute Summary collapse

Instance Attribute Details

#healthy_thresholdInteger

The number of consecutive health checks successes required before moving the instance to the Healthy state.

Returns:

  • (Integer)


1196
1197
1198
1199
1200
1201
1202
1203
# File 'gems/aws-sdk-elasticloadbalancing/lib/aws-sdk-elasticloadbalancing/types.rb', line 1196

class HealthCheck < Struct.new(
  :target,
  :interval,
  :timeout,
  :unhealthy_threshold,
  :healthy_threshold)
  include Aws::Structure
end

#intervalInteger

The approximate interval, in seconds, between health checks of an individual instance.

Returns:

  • (Integer)


1196
1197
1198
1199
1200
1201
1202
1203
# File 'gems/aws-sdk-elasticloadbalancing/lib/aws-sdk-elasticloadbalancing/types.rb', line 1196

class HealthCheck < Struct.new(
  :target,
  :interval,
  :timeout,
  :unhealthy_threshold,
  :healthy_threshold)
  include Aws::Structure
end

#targetString

The instance being checked. The protocol is either TCP, HTTP, HTTPS, or SSL. The range of valid ports is one (1) through 65535.

TCP is the default, specified as a TCP: port pair, for example "TCP:5000". In this case, a health check simply attempts to open a TCP connection to the instance on the specified port. Failure to connect within the configured timeout is considered unhealthy.

SSL is also specified as SSL: port pair, for example, SSL:5000.

For HTTP/HTTPS, you must include a ping path in the string. HTTP is specified as a HTTP:port;/;PathToPing; grouping, for example "HTTP:80/weather/us/wa/seattle". In this case, a HTTP GET request is issued to the instance on the given port and path. Any answer other than "200 OK" within the timeout period is considered unhealthy.

The total length of the HTTP ping target must be 1024 16-bit Unicode characters or less.

Returns:

  • (String)


1196
1197
1198
1199
1200
1201
1202
1203
# File 'gems/aws-sdk-elasticloadbalancing/lib/aws-sdk-elasticloadbalancing/types.rb', line 1196

class HealthCheck < Struct.new(
  :target,
  :interval,
  :timeout,
  :unhealthy_threshold,
  :healthy_threshold)
  include Aws::Structure
end

#timeoutInteger

The amount of time, in seconds, during which no response means a failed health check.

This value must be less than the Interval value.

Returns:

  • (Integer)


1196
1197
1198
1199
1200
1201
1202
1203
# File 'gems/aws-sdk-elasticloadbalancing/lib/aws-sdk-elasticloadbalancing/types.rb', line 1196

class HealthCheck < Struct.new(
  :target,
  :interval,
  :timeout,
  :unhealthy_threshold,
  :healthy_threshold)
  include Aws::Structure
end

#unhealthy_thresholdInteger

The number of consecutive health check failures required before moving the instance to the Unhealthy state.

Returns:

  • (Integer)


1196
1197
1198
1199
1200
1201
1202
1203
# File 'gems/aws-sdk-elasticloadbalancing/lib/aws-sdk-elasticloadbalancing/types.rb', line 1196

class HealthCheck < Struct.new(
  :target,
  :interval,
  :timeout,
  :unhealthy_threshold,
  :healthy_threshold)
  include Aws::Structure
end