/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include namespace Aws { namespace Utils { namespace Json { class JsonValue; class JsonView; } // namespace Json } // namespace Utils namespace ECS { namespace Model { /** *

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). This configuration maps to the HEALTHCHECK * parameter of docker * run.

The Amazon ECS container agent only monitors and reports * on the health checks specified in the task definition. Amazon ECS does not * monitor Docker health checks that are embedded in a container image and not * specified in the container definition. Health check parameters that are * specified in a container definition override any Docker health checks that exist * in the container image.

You can view the health status of both * individual containers and a task with the DescribeTasks API operation or when * viewing the task details in the console.

The health check is designed to * make sure that your containers survive agent restarts, upgrades, or temporary * unavailability.

The following describes the possible * healthStatus values for a container:

  • * HEALTHY-The container health check has passed successfully.

    *

  • UNHEALTHY-The container health check has failed.

    *

  • UNKNOWN-The container health check is being * evaluated or there's no container health check defined.

The * following describes the possible healthStatus values for a task. * The container health check status of non-essential containers don't have an * effect on the health status of a task.

  • * HEALTHY-All essential containers within the task have passed their * health checks.

  • UNHEALTHY-One or more essential * containers have failed their health check.

  • * UNKNOWN-The essential containers within the task are still having * their health checks evaluated, there are only nonessential containers with * health checks defined, or there are no container health checks defined.

    *

If a task is run manually, and not as part of a service, the task * will continue its lifecycle regardless of its health status. For tasks that are * part of a service, if the task reports as unhealthy then the task will be * stopped and the service scheduler will replace it.

The following are * notes about container health check support:

  • When the Amazon ECS * agent cannot connect to the Amazon ECS service, the service reports the * container as UNHEALTHY.

  • The health check * statuses are the "last heard from" response from the Amazon ECS agent. There are * no assumptions made about the status of the container health checks.

    • *

  • 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're using platform version * 1.1.0 or greater. For more information, see Fargate * platform versions.

  • Container health checks aren't * supported for tasks that are part of a service that's configured to use a * Classic Load Balancer.

See Also:

AWS API * Reference

*/ class HealthCheck { public: AWS_ECS_API HealthCheck(); AWS_ECS_API HealthCheck(Aws::Utils::Json::JsonView jsonValue); AWS_ECS_API HealthCheck& operator=(Aws::Utils::Json::JsonView jsonValue); AWS_ECS_API Aws::Utils::Json::JsonValue Jsonize() const; /** *

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 Create * a container section of the Docker Remote API.

*/ inline const Aws::Vector& GetCommand() const{ return m_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 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 Create * a container section of the Docker Remote API.

*/ inline bool CommandHasBeenSet() const { return m_commandHasBeenSet; } /** *

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 Create * a container section of the Docker Remote API.

*/ inline void SetCommand(const Aws::Vector& value) { m_commandHasBeenSet = true; m_command = value; } /** *

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 Create * a container section of the Docker Remote API.

*/ inline void SetCommand(Aws::Vector&& value) { m_commandHasBeenSet = true; m_command = std::move(value); } /** *

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 Create * a container section of the Docker Remote API.

*/ inline HealthCheck& WithCommand(const Aws::Vector& value) { SetCommand(value); return *this;} /** *

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 Create * a container section of the Docker Remote API.

*/ inline HealthCheck& WithCommand(Aws::Vector&& value) { SetCommand(std::move(value)); return *this;} /** *

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 Create * a container section of the Docker Remote API.

*/ inline HealthCheck& AddCommand(const Aws::String& value) { m_commandHasBeenSet = true; m_command.push_back(value); return *this; } /** *

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 Create * a container section of the Docker Remote API.

*/ inline HealthCheck& AddCommand(Aws::String&& value) { m_commandHasBeenSet = true; m_command.push_back(std::move(value)); return *this; } /** *

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 Create * a container section of the Docker Remote API.

*/ inline HealthCheck& AddCommand(const char* value) { m_commandHasBeenSet = true; m_command.push_back(value); return *this; } /** *

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

*/ inline int GetInterval() const{ return m_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.

*/ inline bool IntervalHasBeenSet() const { return m_intervalHasBeenSet; } /** *

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

*/ inline void SetInterval(int value) { m_intervalHasBeenSet = true; m_interval = value; } /** *

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

*/ inline HealthCheck& WithInterval(int value) { SetInterval(value); return *this;} /** *

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.

*/ inline int GetTimeout() const{ return m_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.

*/ inline bool TimeoutHasBeenSet() const { return m_timeoutHasBeenSet; } /** *

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.

*/ inline void SetTimeout(int value) { m_timeoutHasBeenSet = true; m_timeout = value; } /** *

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.

*/ inline HealthCheck& WithTimeout(int value) { SetTimeout(value); return *this;} /** *

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.

*/ inline int GetRetries() const{ return m_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.

*/ inline bool RetriesHasBeenSet() const { return m_retriesHasBeenSet; } /** *

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.

*/ inline void SetRetries(int value) { m_retriesHasBeenSet = true; m_retries = value; } /** *

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.

*/ inline HealthCheck& WithRetries(int value) { SetRetries(value); return *this;} /** *

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.

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.

*/ inline int GetStartPeriod() const{ return m_startPeriod; } /** *

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.

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.

*/ inline bool StartPeriodHasBeenSet() const { return m_startPeriodHasBeenSet; } /** *

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.

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.

*/ inline void SetStartPeriod(int value) { m_startPeriodHasBeenSet = true; m_startPeriod = value; } /** *

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.

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.

*/ inline HealthCheck& WithStartPeriod(int value) { SetStartPeriod(value); return *this;} private: Aws::Vector m_command; bool m_commandHasBeenSet = false; int m_interval; bool m_intervalHasBeenSet = false; int m_timeout; bool m_timeoutHasBeenSet = false; int m_retries; bool m_retriesHasBeenSet = false; int m_startPeriod; bool m_startPeriodHasBeenSet = false; }; } // namespace Model } // namespace ECS } // namespace Aws