Class: Aws::ECS::Types::HealthCheck
- Inherits:
-
Struct
- Object
- Struct
- Aws::ECS::Types::HealthCheck
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-ecs/types.rb
Overview
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).
The following are notes about container health check support:
-
Container health checks require version 1.17.0 or greater of the Amazon ECS container agent. For more information, see [Updating the Amazon ECS Container Agent].
-
Container health checks are supported for Fargate tasks if you are using platform version 1.1.0 or greater. For more information, see [AWS Fargate Platform Versions].
-
Container health checks are not supported for tasks that are part of a service that is configured to use a Classic Load Balancer.
[1]: docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html [2]: docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html
Instance Attribute Summary collapse
-
#command ⇒ Array<String>
A string array representing the command that the container runs to determine if it is healthy.
-
#interval ⇒ Integer
The time period in seconds between each health check execution.
-
#retries ⇒ Integer
The number of times to retry a failed health check before the container is considered unhealthy.
-
#start_period ⇒ Integer
The optional grace period within which to provide containers time to bootstrap before failed health checks count towards the maximum number of retries.
-
#timeout ⇒ Integer
The time period in seconds to wait for a health check to succeed before it is considered a failure.
Instance Attribute Details
#command ⇒ Array<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 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][1
-
section of the [Docker Remote API].
[1]: docs.docker.com/engine/api/v1.35/#operation/ContainerCreate [2]: docs.docker.com/engine/api/v1.35/
2913 2914 2915 2916 2917 2918 2919 2920 |
# File 'lib/aws-sdk-ecs/types.rb', line 2913 class HealthCheck < Struct.new( :command, :interval, :timeout, :retries, :start_period) include Aws::Structure end |
#interval ⇒ Integer
The time period in seconds between each health check execution. You may specify between 5 and 300 seconds. The default value is 30 seconds.
2913 2914 2915 2916 2917 2918 2919 2920 |
# File 'lib/aws-sdk-ecs/types.rb', line 2913 class HealthCheck < Struct.new( :command, :interval, :timeout, :retries, :start_period) include Aws::Structure end |
#retries ⇒ Integer
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.
2913 2914 2915 2916 2917 2918 2919 2920 |
# File 'lib/aws-sdk-ecs/types.rb', line 2913 class HealthCheck < Struct.new( :command, :interval, :timeout, :retries, :start_period) include Aws::Structure end |
#start_period ⇒ Integer
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.
<note markdown=“1”> 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.
</note>
2913 2914 2915 2916 2917 2918 2919 2920 |
# File 'lib/aws-sdk-ecs/types.rb', line 2913 class HealthCheck < Struct.new( :command, :interval, :timeout, :retries, :start_period) include Aws::Structure end |
#timeout ⇒ Integer
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.
2913 2914 2915 2916 2917 2918 2919 2920 |
# File 'lib/aws-sdk-ecs/types.rb', line 2913 class HealthCheck < Struct.new( :command, :interval, :timeout, :retries, :start_period) include Aws::Structure end |