gamelift/aws.sdk.kotlin.services.gamelift.model/ContainerHealthCheck

ContainerHealthCheck

Instructions on when and how to check the health of a support container in a container fleet. These properties override any Docker health checks that are set in the container image. For more information on container health checks, see HealthCheck command in the Amazon Elastic Container Service API. Game server containers don't have a health check parameter; Amazon GameLift Servers automatically handles health checks for these containers.

The following example instructs the container to initiate a health check command every 60 seconds and wait 10 seconds for it to succeed. If it fails, retry the command 3 times before flagging the container as unhealthy. It also tells the container to wait 100 seconds after launch before counting failed health checks.

{"Command": [ "CMD-SHELL", "ps cax | grep "processmanager" || exit 1" ], "Interval": 60, "Timeout": 10, "Retries": 3, "StartPeriod": 100 }

Part of:SupportContainerDefinition, SupportContainerDefinitionInput

Types

Builder

class Builder

Companion

object Companion

Properties

command

val command: List<String>?

A string array that specifies the command that the container runs to determine if it's healthy.

interval

val interval: Int?

The time period (in seconds) between each health check.

retries

val retries: Int?

The number of times to retry a failed health check before flagging the container unhealthy. The first run of the command does not count as a retry.

startPeriod

val startPeriod: Int?

The optional grace period (in seconds) to give a container time to bootstrap before the first failed health check counts toward the number of retries.

timeout

val timeout: Int?

The time period (in seconds) to wait for a health check to succeed before counting a failed health check.

Functions

copy

inline fun copy(block: ContainerHealthCheck.Builder.() -> Unit = {}): ContainerHealthCheck

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String