Aws::ECS::Model::ContainerDependency Class Reference

#include <ContainerDependency.h>

Public Member Functions

AWS_ECS_API ContainerDependency ()=default

 

AWS_ECS_API ContainerDependency (Aws::Utils::Json::JsonView jsonValue)

 

AWS_ECS_API ContainerDependency & operator= (Aws::Utils::Json::JsonView jsonValue)

 

AWS_ECS_API Aws::Utils::Json::JsonValue Jsonize () const

 

const Aws::String & GetContainerName () const

 

bool ContainerNameHasBeenSet () const

 

template<typename ContainerNameT = Aws::String>

void SetContainerName (ContainerNameT &&value)

 

template<typename ContainerNameT = Aws::String>

ContainerDependency & WithContainerName (ContainerNameT &&value)

 

ContainerCondition GetCondition () const

 

bool ConditionHasBeenSet () const

 

void SetCondition (ContainerCondition value)

 

ContainerDependency & WithCondition (ContainerCondition value)

 

Detailed Description

The dependencies defined for container startup and shutdown. A container can contain multiple dependencies. When a dependency is defined for container startup, for container shutdown it is reversed.

Your Amazon ECS container instances require at least version 1.26.0 of the container agent to use container dependencies. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ecs-init package. If your container instances are launched from version 20190301 or later, then they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.

For tasks that use the Fargate launch type, the task or service requires the following platforms:

• Linux platform version 1.3.0 or later.

• Windows platform version 1.0.0 or later.

For more information about how to create a container dependency, see Container dependency in the Amazon Elastic Container Service Developer Guide.

See Also:

AWS API Reference

Definition at line 55 of file ContainerDependency.h.

Constructor & Destructor Documentation

ContainerDependency() [1/2]

AWS_ECS_API Aws::ECS::Model::ContainerDependency::ContainerDependency ( )

default

ContainerDependency() [2/2]

AWS_ECS_API Aws::ECS::Model::ContainerDependency::ContainerDependency ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

ConditionHasBeenSet()

bool Aws::ECS::Model::ContainerDependency::ConditionHasBeenSet ( ) const

inline

The dependency condition of the container. The following are the available conditions and their behavior:

• 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 - 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. This condition can't be set on an essential container.

• SUCCESS - This condition is the same as COMPLETE, but it also requires that the container exits with a zero status. This condition can't be set on an essential container.

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

Definition at line 95 of file ContainerDependency.h.

ContainerNameHasBeenSet()

bool Aws::ECS::Model::ContainerDependency::ContainerNameHasBeenSet ( ) const

inline

The name of a container.

Definition at line 69 of file ContainerDependency.h.

GetCondition()

ContainerCondition Aws::ECS::Model::ContainerDependency::GetCondition ( ) const

inline

The dependency condition of the container. The following are the available conditions and their behavior:

• 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 - 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. This condition can't be set on an essential container.

• SUCCESS - This condition is the same as COMPLETE, but it also requires that the container exits with a zero status. This condition can't be set on an essential container.

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

Definition at line 94 of file ContainerDependency.h.

GetContainerName()

const Aws::String & Aws::ECS::Model::ContainerDependency::GetContainerName ( ) const

inline

The name of a container.

Definition at line 68 of file ContainerDependency.h.

Jsonize()

AWS_ECS_API Aws::Utils::Json::JsonValue Aws::ECS::Model::ContainerDependency::Jsonize ( ) const

operator=()

AWS_ECS_API ContainerDependency & Aws::ECS::Model::ContainerDependency::operator= ( Aws::Utils::Json::JsonView  jsonValue)

SetCondition()

void Aws::ECS::Model::ContainerDependency::SetCondition ( ContainerCondition  value)

inline

The dependency condition of the container. The following are the available conditions and their behavior:

• 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 - 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. This condition can't be set on an essential container.

• SUCCESS - This condition is the same as COMPLETE, but it also requires that the container exits with a zero status. This condition can't be set on an essential container.

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

Definition at line 96 of file ContainerDependency.h.

SetContainerName()

template<typename ContainerNameT = Aws::String>

void Aws::ECS::Model::ContainerDependency::SetContainerName ( ContainerNameT &&  value)

inline

The name of a container.

Definition at line 71 of file ContainerDependency.h.

WithCondition()

ContainerDependency & Aws::ECS::Model::ContainerDependency::WithCondition ( ContainerCondition  value)

inline

The dependency condition of the container. The following are the available conditions and their behavior:

• 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 - 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. This condition can't be set on an essential container.

• SUCCESS - This condition is the same as COMPLETE, but it also requires that the container exits with a zero status. This condition can't be set on an essential container.

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

Definition at line 97 of file ContainerDependency.h.

WithContainerName()

template<typename ContainerNameT = Aws::String>

ContainerDependency & Aws::ECS::Model::ContainerDependency::WithContainerName ( ContainerNameT &&  value)

inline

The name of a container.

Definition at line 73 of file ContainerDependency.h.

---

The documentation for this class was generated from the following file:

• generated/src/aws-cpp-sdk-ecs/include/aws/ecs/model/ContainerDependency.h