ContainerHealthCheck
Instructions on when and how to check the health of a container in a container fleet. When health check properties are set in a container definition, they override any Docker health checks in the container image. For more information on container health checks, see HealthCheck command in the Amazon Elastic Container Service API.
The following example instructions tell the container to wait 100 seconds after launch before counting failed health checks, then initiate the health check command every 60 seconds. After issuing the health check command, wait 10 seconds for it to succeed. If it fails, retry the command 3 times before considering the container to be unhealthy.
{"Command": [ "CMD-SHELL", "ps cax | grep "processmanager" || exit 1" ], "Interval":
300, "Timeout": 30, "Retries": 5, "StartPeriod": 100 }
Part of: ContainerDefinition:HealthCheck
Contents
Note
In the following list, the required parameters are described first.
- Command
-
A string array that specifies the command that the container runs to determine if it's healthy.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 20 items.
Length Constraints: Minimum length of 1. Maximum length of 255.
Required: Yes
- Interval
-
The time period (in seconds) between each health check.
Type: Integer
Valid Range: Minimum value of 60. Maximum value of 300.
Required: No
- Retries
-
The number of times to retry a failed health check before the container is considered unhealthy. The first run of the command does not count as a retry.
Type: Integer
Valid Range: Minimum value of 5. Maximum value of 10.
Required: No
- StartPeriod
-
The optional grace period (in seconds) to give a container time to bootstrap before the first failed health check counts toward the number of retries.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 300.
Required: No
- Timeout
-
The time period (in seconds) to wait for a health check to succeed before a failed health check is counted.
Type: Integer
Valid Range: Minimum value of 30. Maximum value of 60.
Required: No
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: