Package software.amazon.awscdk.cfnpropertymixins.services.ecs

Class CfnTaskDefinitionPropsMixin.HealthCheckProperty.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.cfnpropertymixins.services.ecs.CfnTaskDefinitionPropsMixin.HealthCheckProperty.Jsii$Proxy

All Implemented Interfaces:

CfnTaskDefinitionPropsMixin.HealthCheckProperty, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnTaskDefinitionPropsMixin.HealthCheckProperty

@Stability(Stable)
@Internal
public static final class CfnTaskDefinitionPropsMixin.HealthCheckProperty.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements CfnTaskDefinitionPropsMixin.HealthCheckProperty

An implementation for CfnTaskDefinitionPropsMixin.HealthCheckProperty

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.cfnpropertymixins.services.ecs.CfnTaskDefinitionPropsMixin.HealthCheckProperty

CfnTaskDefinitionPropsMixin.HealthCheckProperty.Builder, CfnTaskDefinitionPropsMixin.HealthCheckProperty.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CfnTaskDefinitionPropsMixin.HealthCheckProperty.Builder builder)	Constructor that initializes the object based on literal property values passed by the CfnTaskDefinitionPropsMixin.HealthCheckProperty.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final List<String>	getCommand()	A string array representing the command that the container runs to determine if it is healthy.
final Number	getInterval()	The time period in seconds between each health check execution.
final Number	getRetries()	The number of times to retry a failed health check before the container is considered unhealthy.
final Number	getStartPeriod()	The optional grace period to provide containers time to bootstrap before failed health checks count towards the maximum number of retries.
final Number	getTimeout()	The time period in seconds to wait for a health check to succeed before it is considered a failure.
final int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(CfnTaskDefinitionPropsMixin.HealthCheckProperty.Builder builder)

Constructor that initializes the object based on literal property values passed by the CfnTaskDefinitionPropsMixin.HealthCheckProperty.Builder.

Method Details

getCommand

public final List<String> getCommand()

Description copied from interface: CfnTaskDefinitionPropsMixin.HealthCheckProperty

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 AWS Command Line Interface , 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 docker container create command.

Specified by:

getCommand in interface CfnTaskDefinitionPropsMixin.HealthCheckProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-healthcheck.html#cfn-ecs-taskdefinition-healthcheck-command

getInterval

public final Number getInterval()

Description copied from interface: CfnTaskDefinitionPropsMixin.HealthCheckProperty

The time period in seconds between each health check execution.

You may specify between 5 and 300 seconds. The default value is 30 seconds. This value applies only when you specify a command .

Specified by:

getInterval in interface CfnTaskDefinitionPropsMixin.HealthCheckProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-healthcheck.html#cfn-ecs-taskdefinition-healthcheck-interval

getRetries

public final Number getRetries()

Description copied from interface: CfnTaskDefinitionPropsMixin.HealthCheckProperty

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. This value applies only when you specify a command .

Specified by:

getRetries in interface CfnTaskDefinitionPropsMixin.HealthCheckProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-healthcheck.html#cfn-ecs-taskdefinition-healthcheck-retries

getStartPeriod

public final Number getStartPeriod()

Description copied from interface: CfnTaskDefinitionPropsMixin.HealthCheckProperty

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. This value applies only when you specify a command .

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.

Specified by:

getStartPeriod in interface CfnTaskDefinitionPropsMixin.HealthCheckProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-healthcheck.html#cfn-ecs-taskdefinition-healthcheck-startperiod

getTimeout

public final Number getTimeout()

Description copied from interface: CfnTaskDefinitionPropsMixin.HealthCheckProperty

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. This value applies only when you specify a command .

Specified by:

getTimeout in interface CfnTaskDefinitionPropsMixin.HealthCheckProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-healthcheck.html#cfn-ecs-taskdefinition-healthcheck-timeout

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object