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

Class: Aws::ECS::Types::HealthCheck

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

Overview

Note:

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

{
  command: ["String"], # required
  interval: 1,
  timeout: 1,
  retries: 1,
  start_period: 1,
}

An object representing a container health check. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image (such as those specified in a parent image or from the image's Dockerfile).

Instance Attribute Summary collapse

Instance Attribute Details

#commandArray<String>

A string array representing the command that the container runs to determine if it is healthy. The string array must start with CMD to execute the command arguments directly, or CMD-SHELL to run the command with the container's default shell. For example:

[ "CMD-SHELL", "curl -f http://localhost/ || exit 1" ]

An exit code of 0 indicates success, and non-zero exit code indicates failure. For more information, see HealthCheck in the Create a container section of the Docker Remote API.

Returns:

  • (Array<String>)


2452
2453
2454
2455
2456
2457
2458
2459
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 2452

class HealthCheck < Struct.new(
  :command,
  :interval,
  :timeout,
  :retries,
  :start_period)
  include Aws::Structure
end

#intervalInteger

The time period in seconds between each health check execution. You may specify between 5 and 300 seconds. The default value is 30 seconds.

Returns:

  • (Integer)


2452
2453
2454
2455
2456
2457
2458
2459
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 2452

class HealthCheck < Struct.new(
  :command,
  :interval,
  :timeout,
  :retries,
  :start_period)
  include Aws::Structure
end

#retriesInteger

The number of times to retry a failed health check before the container is considered unhealthy. You may specify between 1 and 10 retries. The default value is 3.

Returns:

  • (Integer)


2452
2453
2454
2455
2456
2457
2458
2459
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 2452

class HealthCheck < Struct.new(
  :command,
  :interval,
  :timeout,
  :retries,
  :start_period)
  include Aws::Structure
end

#start_periodInteger

The optional grace period within which to provide containers time to bootstrap before failed health checks count towards the maximum number of retries. You may specify between 0 and 300 seconds. The startPeriod is disabled by default.

If a health check succeeds within the startPeriod, then the container is considered healthy and any subsequent failures count toward the maximum number of retries.

Returns:

  • (Integer)


2452
2453
2454
2455
2456
2457
2458
2459
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 2452

class HealthCheck < Struct.new(
  :command,
  :interval,
  :timeout,
  :retries,
  :start_period)
  include Aws::Structure
end

#timeoutInteger

The time period in seconds to wait for a health check to succeed before it is considered a failure. You may specify between 2 and 60 seconds. The default value is 5.

Returns:

  • (Integer)


2452
2453
2454
2455
2456
2457
2458
2459
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 2452

class HealthCheck < Struct.new(
  :command,
  :interval,
  :timeout,
  :retries,
  :start_period)
  include Aws::Structure
end