Class: Aws::ECS::Types::ContainerDependency

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-ecs/types.rb

Overview

Note:

When making an API call, you may pass ContainerDependency data as a hash:

{
  container_name: "String", # required
  condition: "START", # required, accepts START, COMPLETE, SUCCESS, HEALTHY
}

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

<note markdown=“1”> For tasks using the Fargate launch type, this parameter requires that the task or service uses platform version 1.3.0 or later.

</note>

[1]: docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html [2]: docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#conditionString

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.

Returns:

  • (String)

2047
2048
2049
2050
2051
2052
# File 'lib/aws-sdk-ecs/types.rb', line 2047

class ContainerDependency < Struct.new(
  :container_name,
  :condition)
  SENSITIVE = []
  include Aws::Structure
end

#container_nameString

The name of a container.

Returns:

  • (String)

2047
2048
2049
2050
2051
2052
# File 'lib/aws-sdk-ecs/types.rb', line 2047

class ContainerDependency < Struct.new(
  :container_name,
  :condition)
  SENSITIVE = []
  include Aws::Structure
end