Package software.amazon.awscdk.services.gamelift

Interface CfnContainerGroupDefinition.ContainerHealthCheckProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnContainerGroupDefinition.ContainerHealthCheckProperty.Jsii$Proxy

Enclosing class:

CfnContainerGroupDefinition

@Stability(Stable)
public static interface CfnContainerGroupDefinition.ContainerHealthCheckProperty
extends software.amazon.jsii.JsiiSerializable

Specifies how the process manager checks the health of containers.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.gamelift.*;
 ContainerHealthCheckProperty containerHealthCheckProperty = ContainerHealthCheckProperty.builder()
         .command(List.of("command"))
         // the properties below are optional
         .interval(123)
         .retries(123)
         .startPeriod(123)
         .timeout(123)
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnContainerGroupDefinition.ContainerHealthCheckProperty.Builder	A builder for CfnContainerGroupDefinition.ContainerHealthCheckProperty
static final class	CfnContainerGroupDefinition.ContainerHealthCheckProperty.Jsii$Proxy	An implementation for CfnContainerGroupDefinition.ContainerHealthCheckProperty

Method Summary

Modifier and Type	Method	Description
static CfnContainerGroupDefinition.ContainerHealthCheckProperty.Builder	builder()
List<String>	getCommand()	A string array representing the command that the container runs to determine if it is healthy.
default Number	getInterval()	How often (in seconds) the health is checked.
default Number	getRetries()	How many times the process manager will retry the command after a timeout.
default Number	getStartPeriod()	The optional grace period (in seconds) to give a container time to boostrap before teh health check is declared failed.
default Number	getTimeout()	How many seconds the process manager allows the command to run before canceling it.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCommand

@Stability(Stable)
@NotNull
List<String> getCommand()

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

See Also:

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

getInterval

@Stability(Stable)
@Nullable
default Number getInterval()

How often (in seconds) the health is checked.

See Also:

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

getRetries

@Stability(Stable)
@Nullable
default Number getRetries()

How many times the process manager will retry the command after a timeout.

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

See Also:

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

getStartPeriod

@Stability(Stable)
@Nullable
default Number getStartPeriod()

The optional grace period (in seconds) to give a container time to boostrap before teh health check is declared failed.

See Also:

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

getTimeout

@Stability(Stable)
@Nullable
default Number getTimeout()

How many seconds the process manager allows the command to run before canceling it.

See Also:

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

builder

@Stability(Stable)
static CfnContainerGroupDefinition.ContainerHealthCheckProperty.Builder builder()

Returns:

a CfnContainerGroupDefinition.ContainerHealthCheckProperty.Builder of CfnContainerGroupDefinition.ContainerHealthCheckProperty