software.amazon.awscdk.services.ecs

Enum ContainerDependencyCondition

java.lang.Object

java.lang.Enum<ContainerDependencyCondition>

software.amazon.awscdk.services.ecs.ContainerDependencyCondition

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ContainerDependencyCondition>

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:49.625Z")
public enum ContainerDependencyCondition
extends java.lang.Enum<ContainerDependencyCondition>

Enum Constant Summary

Enum Constants

Enum Constant and Description
COMPLETE This condition validates that a dependent container runs to completion (exits) before permitting other containers to start.
HEALTHY This condition validates that the dependent container passes its Docker health check before permitting other containers to start.
START This condition emulates the behavior of links and volumes today.
SUCCESS This condition is the same as COMPLETE, but it also requires that the container exits with a zero status.

Method Summary

Modifier and Type	Method and Description
static ContainerDependencyCondition	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ContainerDependencyCondition[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

START

public static final ContainerDependencyCondition START

This condition emulates the behavior of links and volumes today.

It validates that a dependent container is started before permitting other containers to start.

COMPLETE

public static final ContainerDependencyCondition COMPLETE

This condition validates that a dependent container runs to completion (exits) before permitting other containers to start.

This can be useful for nonessential containers that run a script and then exit.

SUCCESS

public static final ContainerDependencyCondition SUCCESS

This condition is the same as COMPLETE, but it also requires that the container exits with a zero status.

HEALTHY

public static final ContainerDependencyCondition HEALTHY

This condition validates that the dependent container passes its Docker health check before permitting other containers to start.

This requires that the dependent container has health checks configured. This condition is confirmed only at task startup.

Method Detail

values

public static ContainerDependencyCondition[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ContainerDependencyCondition c : ContainerDependencyCondition.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ContainerDependencyCondition valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null