HealthCheckArgs

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

Definition of HealthCheck

Constructors

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

Properties

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

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 AWS Management Console JSON panel, the CLIlong, 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 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.

Link copied to clipboard
val interval: Output<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: Output<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 3.

Link copied to clipboard
val startPeriod: Output<Int>? = null

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.

Link copied to clipboard
val timeout: Output<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.

Functions

Link copied to clipboard
open override fun toJava(): HealthCheckArgs