TaskDefinitionHealthCheck

data class TaskDefinitionHealthCheck(val command: List<String>? = null, val interval: Int? = null, val retries: Int? = null, val startPeriod: Int? = null, val timeout: Int? = null)

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

Constructors

Link copied to clipboard
fun TaskDefinitionHealthCheck(command: List<String>? = null, interval: Int? = null, retries: Int? = null, startPeriod: Int? = null, timeout: Int? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val command: List<String>? = null

A string array representing the command that the container runs to determine if it is healthy.

Link copied to clipboard
val interval: Int? = null

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

Link copied to clipboard
val retries: Int? = null

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 three retries.

Link copied to clipboard
val startPeriod: Int? = null

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. The startPeriod is disabled by default.

Link copied to clipboard
val timeout: Int? = null

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