HealthCheckDict¶
Dictionary Type¶
HealthCheckDict
¶
Bases: TypedDict
Dictionary form of HealthCheck.
Attributes¶
command
instance-attribute
¶
A string array representing the command that the container runs to
determine if it is healthy. The string array must start with CMD to
run the command arguments directly, or CMD-SHELL to run the command
with the container's default shell.
When you use the Amazon Web Services Management Console JSON panel, the Command Line Interface, or the APIs, enclose the list of commands in double quotes and brackets.
[ "CMD-SHELL", "curl -f http://localhost/ || exit 1" ]
You don't include the double quotes and brackets when you use the Amazon Web Services Management Console.
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 docker container
create command.
interval
instance-attribute
¶
interval: int | None
The time period in seconds between each health check execution. You may
specify between 5 and 300 seconds. The default value is 30 seconds. This
value applies only when you specify a command.
retries
instance-attribute
¶
retries: int | None
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. This value applies only when you specify a
command.
start_period
instance-attribute
¶
start_period: int | None
The optional grace period to provide containers time to bootstrap before
failed health checks count towards the maximum number of retries. You
can specify between 0 and 300 seconds. By default, the startPeriod is
off. This value applies only when you specify a command.
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.