HealthCheck¶

class aws_cdk.aws_ecs.HealthCheck(*, command, interval=None, retries=None, start_period=None, timeout=None)¶

Bases: object

The health check command and associated configuration parameters for the container.

Parameters

command (Sequence[str]) – 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” ]
interval (Optional[Duration]) – The time period in seconds between each health check execution. You may specify between 5 and 300 seconds. Default: Duration.seconds(30)
retries (Union[int, float, 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. Default: 3
start_period (Optional[Duration]) – 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. Default: No start period
timeout (Optional[Duration]) – 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. Default: Duration.seconds(5)

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_ecs as ecs
import aws_cdk.core as cdk

health_check = ecs.HealthCheck(
    command=["command"],

    # the properties below are optional
    interval=cdk.Duration.minutes(30),
    retries=123,
    start_period=cdk.Duration.minutes(30),
    timeout=cdk.Duration.minutes(30)
)

Attributes

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” ]

Return type: List[str]

interval¶

The time period in seconds between each health check execution.

You may specify between 5 and 300 seconds.

Default: Duration.seconds(30)
Return type: Optional[Duration]

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.

Default: 3
Return type: Union[int, float, None]

start_period¶

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.

Default: No start period
Return type: Optional[Duration]

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.

Default: Duration.seconds(5)
Return type: Optional[Duration]