AWS CloudFormation
User Guide (API Version 2010-05-15)

Amazon Elastic Container Service TaskDefinition HealthCheck

The HealthCheck property type specifies 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).

HealthCheck is a property of the Amazon Elastic Container Service TaskDefinition ContainerDefinition property type.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{ "Command" : [ String, ... ] , "Interval" : Integer, "Retries" : Integer, "StartPeriod" : Integer, "Timeout" : Integer }

YAML

Command - String Interval: Integer Retries: Integer StartPeriod: Integer Timeout: Integer

Properties

Command

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.

Required: Yes

Type: List of String values

Update requires: Replacement

Interval

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

Required: No

Type: Integer

Update requires: Replacement

Retries

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 retries.

Required: No

Type: Integer

Update requires: Replacement

StartPeriod

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

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.

Required: No

Type: String

Update requires: Replacement

Timeout

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 seconds.

Required: No

Type: Integer

Update requires: Replacement

See Also

  • HealthCheck in the Amazon Elastic Container Service API Reference

On this page: