Class: Aws::GameLift::Types::ContainerHealthCheck

Inherits:

Struct

• Object
• Struct
• Aws::GameLift::Types::ContainerHealthCheck

Includes:

Structure

Defined in:

lib/aws-sdk-gamelift/types.rb

Overview

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

[1]: docs.aws.amazon.com/AmazonECS/latest/APIReference/API_HealthCheck.html#ECS-Type-HealthCheck-command

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #command ⇒ Array<String>

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

• #interval ⇒ Integer

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

• #retries ⇒ Integer

  The number of times to retry a failed health check before flagging the container unhealthy.

• #start_period ⇒ Integer

  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 ⇒ Integer

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

Instance Attribute Details

#command ⇒ Array<String>

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

Returns:

• (Array<String>)

# File 'lib/aws-sdk-gamelift/types.rb', line 1135

class ContainerHealthCheck < Struct.new(
  :command,
  :interval,
  :retries,
  :start_period,
  :timeout)
  SENSITIVE = []
  include Aws::Structure
end

#interval ⇒ Integer

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

Returns:

• (Integer)

# File 'lib/aws-sdk-gamelift/types.rb', line 1135

class ContainerHealthCheck < Struct.new(
  :command,
  :interval,
  :retries,
  :start_period,
  :timeout)
  SENSITIVE = []
  include Aws::Structure
end

#retries ⇒ Integer

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.

Returns:

• (Integer)

# File 'lib/aws-sdk-gamelift/types.rb', line 1135

class ContainerHealthCheck < Struct.new(
  :command,
  :interval,
  :retries,
  :start_period,
  :timeout)
  SENSITIVE = []
  include Aws::Structure
end

#start_period ⇒ Integer

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.

Returns:

• (Integer)

# File 'lib/aws-sdk-gamelift/types.rb', line 1135

class ContainerHealthCheck < Struct.new(
  :command,
  :interval,
  :retries,
  :start_period,
  :timeout)
  SENSITIVE = []
  include Aws::Structure
end

#timeout ⇒ Integer

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

Returns:

• (Integer)

# File 'lib/aws-sdk-gamelift/types.rb', line 1135

class ContainerHealthCheck < Struct.new(
  :command,
  :interval,
  :retries,
  :start_period,
  :timeout)
  SENSITIVE = []
  include Aws::Structure
end