Class: Aws::CodeDeploy::Types::ECSTaskSet

Inherits:

Struct

• Object
• Struct
• Aws::CodeDeploy::Types::ECSTaskSet

Includes:

Structure

Defined in:

lib/aws-sdk-codedeploy/types.rb

Overview

Information about a set of Amazon ECS tasks in an CodeDeploy deployment. An Amazon ECS task set includes details such as the desired number of tasks, how many tasks are running, and whether the task set serves production traffic. An CodeDeploy application that uses the Amazon ECS compute platform deploys a containerized application in an Amazon ECS service as a task set.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #desired_count ⇒ Integer

  The number of tasks in a task set.

• #identifer ⇒ String

  A unique ID of an ‘ECSTaskSet`.

• #pending_count ⇒ Integer

  The number of tasks in the task set that are in the ‘PENDING` status during an Amazon ECS deployment.

• #running_count ⇒ Integer

  The number of tasks in the task set that are in the ‘RUNNING` status during an Amazon ECS deployment.

• #status ⇒ String

  The status of the task set.

• #target_group ⇒ Types::TargetGroupInfo

  The target group associated with the task set.

• #task_set_label ⇒ String

  A label that identifies whether the ECS task set is an original target (‘BLUE`) or a replacement target (`GREEN`).

• #traffic_weight ⇒ Float

  The percentage of traffic served by this task set.

Instance Attribute Details

#desired_count ⇒ Integer

The number of tasks in a task set. During a deployment that uses the Amazon ECS compute type, CodeDeploy instructs Amazon ECS to create a new task set and uses this value to determine how many tasks to create. After the updated task set is created, CodeDeploy shifts traffic to the new task set.

Returns:

• (Integer)

# File 'lib/aws-sdk-codedeploy/types.rb', line 2224

class ECSTaskSet < Struct.new(
  :identifer,
  :desired_count,
  :pending_count,
  :running_count,
  :status,
  :traffic_weight,
  :target_group,
  :task_set_label)
  SENSITIVE = []
  include Aws::Structure
end

#identifer ⇒ String

A unique ID of an ‘ECSTaskSet`.

Returns:

• (String)

# File 'lib/aws-sdk-codedeploy/types.rb', line 2224

class ECSTaskSet < Struct.new(
  :identifer,
  :desired_count,
  :pending_count,
  :running_count,
  :status,
  :traffic_weight,
  :target_group,
  :task_set_label)
  SENSITIVE = []
  include Aws::Structure
end

#pending_count ⇒ Integer

The number of tasks in the task set that are in the ‘PENDING` status during an Amazon ECS deployment. A task in the `PENDING` state is preparing to enter the `RUNNING` state. A task set enters the `PENDING` status when it launches for the first time, or when it is restarted after being in the `STOPPED` state.

Returns:

• (Integer)

# File 'lib/aws-sdk-codedeploy/types.rb', line 2224

class ECSTaskSet < Struct.new(
  :identifer,
  :desired_count,
  :pending_count,
  :running_count,
  :status,
  :traffic_weight,
  :target_group,
  :task_set_label)
  SENSITIVE = []
  include Aws::Structure
end

#running_count ⇒ Integer

The number of tasks in the task set that are in the ‘RUNNING` status during an Amazon ECS deployment. A task in the `RUNNING` state is running and ready for use.

Returns:

• (Integer)

# File 'lib/aws-sdk-codedeploy/types.rb', line 2224

class ECSTaskSet < Struct.new(
  :identifer,
  :desired_count,
  :pending_count,
  :running_count,
  :status,
  :traffic_weight,
  :target_group,
  :task_set_label)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The status of the task set. There are three valid task set statuses:

• ‘PRIMARY`: Indicates the task set is serving production traffic.

• ‘ACTIVE`: Indicates the task set is not serving production traffic.

• ‘DRAINING`: Indicates the tasks in the task set are being stopped and their corresponding targets are being deregistered from their target group.

Returns:

• (String)

# File 'lib/aws-sdk-codedeploy/types.rb', line 2224

class ECSTaskSet < Struct.new(
  :identifer,
  :desired_count,
  :pending_count,
  :running_count,
  :status,
  :traffic_weight,
  :target_group,
  :task_set_label)
  SENSITIVE = []
  include Aws::Structure
end

#target_group ⇒ Types::TargetGroupInfo

The target group associated with the task set. The target group is used by CodeDeploy to manage traffic to a task set.

Returns:

• (Types::TargetGroupInfo)

# File 'lib/aws-sdk-codedeploy/types.rb', line 2224

class ECSTaskSet < Struct.new(
  :identifer,
  :desired_count,
  :pending_count,
  :running_count,
  :status,
  :traffic_weight,
  :target_group,
  :task_set_label)
  SENSITIVE = []
  include Aws::Structure
end

#task_set_label ⇒ String

A label that identifies whether the ECS task set is an original target (‘BLUE`) or a replacement target (`GREEN`).

Returns:

• (String)

# File 'lib/aws-sdk-codedeploy/types.rb', line 2224

class ECSTaskSet < Struct.new(
  :identifer,
  :desired_count,
  :pending_count,
  :running_count,
  :status,
  :traffic_weight,
  :target_group,
  :task_set_label)
  SENSITIVE = []
  include Aws::Structure
end

#traffic_weight ⇒ Float

The percentage of traffic served by this task set.

Returns:

• (Float)

# File 'lib/aws-sdk-codedeploy/types.rb', line 2224

class ECSTaskSet < Struct.new(
  :identifer,
  :desired_count,
  :pending_count,
  :running_count,
  :status,
  :traffic_weight,
  :target_group,
  :task_set_label)
  SENSITIVE = []
  include Aws::Structure
end