Interface CfnContainerGroupDefinition.IContainerHealthCheckProperty

Instructions on when and how to check the health of a support container in a container fleet.

Namespace: Amazon.CDK.AWS.GameLift

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface CfnContainerGroupDefinition.IContainerHealthCheckProperty

Syntax (vb)

Public Interface CfnContainerGroupDefinition.IContainerHealthCheckProperty

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-containerhealthcheck.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.GameLift;

             var containerHealthCheckProperty = new ContainerHealthCheckProperty {
                 Command = new [] { "command" },

                 // the properties below are optional
                 Interval = 123,
                 Retries = 123,
                 StartPeriod = 123,
                 Timeout = 123
             };

Synopsis

Properties

Command	A string array that specifies the command that the container runs to determine if it's healthy.
Interval	The time period (in seconds) between each health check.
Retries	The number of times to retry a failed health check before flagging the container unhealthy.
StartPeriod	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	The time period (in seconds) to wait for a health check to succeed before counting a failed health check.

Properties

Command

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

string[] Command { get; }

Property Value

string[]

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-containerhealthcheck.html#cfn-gamelift-containergroupdefinition-containerhealthcheck-command

Interval

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

double? Interval { get; }

Property Value

double?

Remarks

Retries

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

double? Retries { get; }

Property Value

double?

Remarks

The first run of the command does not count as a retry.

StartPeriod

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.

double? StartPeriod { get; }

Property Value

double?

Remarks

Timeout

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

double? Timeout { get; }

Property Value

double?