AWS SDK for C++  1.8.95
AWS SDK for C++
Public Member Functions | List of all members
Aws::ECS::Model::ContainerDependency Class Reference

#include <ContainerDependency.h>

Public Member Functions

 ContainerDependency ()
 
 ContainerDependency (Aws::Utils::Json::JsonView jsonValue)
 
ContainerDependencyoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetContainerName () const
 
bool ContainerNameHasBeenSet () const
 
void SetContainerName (const Aws::String &value)
 
void SetContainerName (Aws::String &&value)
 
void SetContainerName (const char *value)
 
ContainerDependencyWithContainerName (const Aws::String &value)
 
ContainerDependencyWithContainerName (Aws::String &&value)
 
ContainerDependencyWithContainerName (const char *value)
 
const ContainerConditionGetCondition () const
 
bool ConditionHasBeenSet () const
 
void SetCondition (const ContainerCondition &value)
 
void SetCondition (ContainerCondition &&value)
 
ContainerDependencyWithCondition (const ContainerCondition &value)
 
ContainerDependencyWithCondition (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 enable 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 are 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 using the Fargate launch type, this parameter requires that the task or service uses platform version 1.3.0 or later.

See Also:

AWS API Reference

Definition at line 50 of file ContainerDependency.h.

Constructor & Destructor Documentation

◆ ContainerDependency() [1/2]

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

◆ ContainerDependency() [2/2]

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 cannot 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 cannot 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 136 of file ContainerDependency.h.

◆ ContainerNameHasBeenSet()

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

The name of a container.

Definition at line 67 of file ContainerDependency.h.

◆ GetCondition()

const 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 cannot 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 cannot 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 117 of file ContainerDependency.h.

◆ GetContainerName()

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

The name of a container.

Definition at line 62 of file ContainerDependency.h.

◆ Jsonize()

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

◆ operator=()

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

◆ SetCondition() [1/2]

void Aws::ECS::Model::ContainerDependency::SetCondition ( const 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 cannot 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 cannot 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 155 of file ContainerDependency.h.

◆ SetCondition() [2/2]

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 cannot 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 cannot 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 174 of file ContainerDependency.h.

◆ SetContainerName() [1/3]

void Aws::ECS::Model::ContainerDependency::SetContainerName ( const Aws::String value)
inline

The name of a container.

Definition at line 72 of file ContainerDependency.h.

◆ SetContainerName() [2/3]

void Aws::ECS::Model::ContainerDependency::SetContainerName ( Aws::String &&  value)
inline

The name of a container.

Definition at line 77 of file ContainerDependency.h.

◆ SetContainerName() [3/3]

void Aws::ECS::Model::ContainerDependency::SetContainerName ( const char *  value)
inline

The name of a container.

Definition at line 82 of file ContainerDependency.h.

◆ WithCondition() [1/2]

ContainerDependency& Aws::ECS::Model::ContainerDependency::WithCondition ( const 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 cannot 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 cannot 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 193 of file ContainerDependency.h.

◆ WithCondition() [2/2]

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 cannot 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 cannot 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 212 of file ContainerDependency.h.

◆ WithContainerName() [1/3]

ContainerDependency& Aws::ECS::Model::ContainerDependency::WithContainerName ( const Aws::String value)
inline

The name of a container.

Definition at line 87 of file ContainerDependency.h.

◆ WithContainerName() [2/3]

ContainerDependency& Aws::ECS::Model::ContainerDependency::WithContainerName ( Aws::String &&  value)
inline

The name of a container.

Definition at line 92 of file ContainerDependency.h.

◆ WithContainerName() [3/3]

ContainerDependency& Aws::ECS::Model::ContainerDependency::WithContainerName ( const char *  value)
inline

The name of a container.

Definition at line 97 of file ContainerDependency.h.


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