Package software.amazon.awscdk.services.ecs

Class CfnTaskDefinition.HealthCheckProperty.Builder

java.lang.Object

software.amazon.awscdk.services.ecs.CfnTaskDefinition.HealthCheckProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnTaskDefinition.HealthCheckProperty>

Enclosing interface:

CfnTaskDefinition.HealthCheckProperty

@Stability(Stable)
public static final class CfnTaskDefinition.HealthCheckProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnTaskDefinition.HealthCheckProperty>

A builder for CfnTaskDefinition.HealthCheckProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnTaskDefinition.HealthCheckProperty	build()	Builds the configured instance.
CfnTaskDefinition.HealthCheckProperty.Builder	command(List<String> command)	Sets the value of CfnTaskDefinition.HealthCheckProperty.getCommand()
CfnTaskDefinition.HealthCheckProperty.Builder	interval(Number interval)	Sets the value of CfnTaskDefinition.HealthCheckProperty.getInterval()
CfnTaskDefinition.HealthCheckProperty.Builder	retries(Number retries)	Sets the value of CfnTaskDefinition.HealthCheckProperty.getRetries()
CfnTaskDefinition.HealthCheckProperty.Builder	startPeriod(Number startPeriod)	Sets the value of CfnTaskDefinition.HealthCheckProperty.getStartPeriod()
CfnTaskDefinition.HealthCheckProperty.Builder	timeout(Number timeout)	Sets the value of CfnTaskDefinition.HealthCheckProperty.getTimeout()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

command

@Stability(Stable)
public CfnTaskDefinition.HealthCheckProperty.Builder command(List<String> command)

Sets the value of CfnTaskDefinition.HealthCheckProperty.getCommand()

Parameters:

command - 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 Create a container section of the Docker Remote API .

Returns:

this

interval

@Stability(Stable)
public CfnTaskDefinition.HealthCheckProperty.Builder interval(Number interval)

Sets the value of CfnTaskDefinition.HealthCheckProperty.getInterval()

Parameters:

interval - The time period in seconds between each health check execution. You may specify between 5 and 300 seconds. The default value is 30 seconds.

Returns:

this

retries

@Stability(Stable)
public CfnTaskDefinition.HealthCheckProperty.Builder retries(Number retries)

Sets the value of CfnTaskDefinition.HealthCheckProperty.getRetries()

Parameters:

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

Returns:

this

startPeriod

@Stability(Stable)
public CfnTaskDefinition.HealthCheckProperty.Builder startPeriod(Number startPeriod)

Sets the value of CfnTaskDefinition.HealthCheckProperty.getStartPeriod()

Parameters:

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

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.

Returns:

this

timeout

@Stability(Stable)
public CfnTaskDefinition.HealthCheckProperty.Builder timeout(Number timeout)

Sets the value of CfnTaskDefinition.HealthCheckProperty.getTimeout()

Parameters:

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

Returns:

this

build

@Stability(Stable)
public CfnTaskDefinition.HealthCheckProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnTaskDefinition.HealthCheckProperty>

Returns:

a new instance of CfnTaskDefinition.HealthCheckProperty

Throws:

NullPointerException - if any required attribute was not provided