software.amazon.awscdk.services.ecs

Interface CfnTaskDefinition.HealthCheckProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTaskDefinition.HealthCheckProperty.Jsii$Proxy

Enclosing class:

CfnTaskDefinition

@Stability(value=Stable)
public static interface CfnTaskDefinition.HealthCheckProperty
extends software.amazon.jsii.JsiiSerializable

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

The following are notes about container health check support:

• 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 are using platform version 1.1.0 or greater. For more information, see AWS Fargate Platform Versions .
• Container health checks are not supported for tasks that are part of a service that is configured to use a Classic Load Balancer.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.ecs.*;
 HealthCheckProperty healthCheckProperty = HealthCheckProperty.builder()
         .command(List.of("command"))
         .interval(123)
         .retries(123)
         .startPeriod(123)
         .timeout(123)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnTaskDefinition.HealthCheckProperty.Builder A builder for CfnTaskDefinition.HealthCheckProperty
static class	CfnTaskDefinition.HealthCheckProperty.Jsii$Proxy An implementation for CfnTaskDefinition.HealthCheckProperty

Method Summary

Modifier and Type	Method and Description
static CfnTaskDefinition.HealthCheckProperty.Builder	builder()
default List<String>	getCommand() A string array representing the command that the container runs to determine if it is healthy.
default Number	getInterval() The time period in seconds between each health check execution.
default Number	getRetries() The number of times to retry a failed health check before the container is considered unhealthy.
default Number	getStartPeriod() The optional grace period to provide containers time to bootstrap before failed health checks count towards the maximum number of retries.
default Number	getTimeout() The time period in seconds to wait for a health check to succeed before it is considered a failure.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getCommand

@Stability(value=Stable)
 @Nullable
default List<String> getCommand()

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.

When you use the AWS Management Console JSON panel, the AWS Command Line Interface , or the APIs, enclose the list of commands in brackets.

[ "CMD-SHELL", "curl -f http://localhost/ || exit 1" ]

You don't need to include the brackets when you use the AWS 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 .

getInterval

@Stability(value=Stable)
 @Nullable
default Number getInterval()

The time period in seconds between each health check execution.

You may specify between 5 and 300 seconds. The default value is 30 seconds.

getRetries

@Stability(value=Stable)
 @Nullable
default Number getRetries()

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.

getStartPeriod

@Stability(value=Stable)
 @Nullable
default Number getStartPeriod()

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

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.

getTimeout

@Stability(value=Stable)
 @Nullable
default Number getTimeout()

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.

builder

@Stability(value=Stable)
static CfnTaskDefinition.HealthCheckProperty.Builder builder()

Returns:

a CfnTaskDefinition.HealthCheckProperty.Builder of CfnTaskDefinition.HealthCheckProperty