Class: AWSCDK::ECS::CfnTaskDefinition::ContainerDependencyProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::ECS::CfnTaskDefinition::ContainerDependencyProperty

Defined in:

ecs/cfn_task_definition.rb

Overview

The ContainerDependency property specifies 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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdependency.html

Instance Attribute Summary

• #condition ⇒ String^? readonly

  The dependency condition of the container.

• #container_name ⇒ String^? readonly

  The name of a container.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(condition: nil, container_name: nil) ⇒ ContainerDependencyProperty constructor

  A new instance of ContainerDependencyProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(condition: nil, container_name: nil) ⇒ ContainerDependencyProperty

Returns a new instance of ContainerDependencyProperty.

Parameters:

• condition (String, nil) (defaults to: nil) —

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

• container_name (String, nil) (defaults to: nil) —

  The name of a container.

# File 'ecs/cfn_task_definition.rb', line 1476

def initialize(condition: nil, container_name: nil)
  @condition = condition
  Jsii::Type.check_type(@condition, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "condition") unless @condition.nil?
  @container_name = container_name
  Jsii::Type.check_type(@container_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "containerName") unless @container_name.nil?
end

Instance Attribute Details

#condition ⇒ String^? (readonly)

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.

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdependency.html#cfn-ecs-taskdefinition-containerdependency-condition

# File 'ecs/cfn_task_definition.rb', line 1492

def condition
  @condition
end

#container_name ⇒ String^? (readonly)

The name of a container.

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdependency.html#cfn-ecs-taskdefinition-containerdependency-containername

# File 'ecs/cfn_task_definition.rb', line 1497

def container_name
  @container_name
end

Class Method Details

.jsii_properties ⇒ Object

# File 'ecs/cfn_task_definition.rb', line 1499

def self.jsii_properties
  {
    :condition => "condition",
    :container_name => "containerName",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'ecs/cfn_task_definition.rb', line 1506

def to_jsii
  result = {}
  result.merge!({
    "condition" => @condition,
    "containerName" => @container_name,
  })
  result.compact
end