You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-codedeploy/lib/aws-sdk-codedeploy/types.rb

Overview

Information about a set of Amazon ECS tasks in an AWS 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 AWS CodeDeploy application that uses the Amazon ECS compute platform deploys a containerized application in an Amazon ECS service as a task set.

Instance Attribute Summary collapse

Instance Attribute Details

#desired_countInteger

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)


2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
# File 'gems/aws-sdk-codedeploy/lib/aws-sdk-codedeploy/types.rb', line 2205

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

#identiferString

A unique ID of an ECSTaskSet.

Returns:

  • (String)


2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
# File 'gems/aws-sdk-codedeploy/lib/aws-sdk-codedeploy/types.rb', line 2205

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

#pending_countInteger

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)


2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
# File 'gems/aws-sdk-codedeploy/lib/aws-sdk-codedeploy/types.rb', line 2205

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

#running_countInteger

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)


2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
# File 'gems/aws-sdk-codedeploy/lib/aws-sdk-codedeploy/types.rb', line 2205

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

#statusString

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)


2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
# File 'gems/aws-sdk-codedeploy/lib/aws-sdk-codedeploy/types.rb', line 2205

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

#target_groupTypes::TargetGroupInfo

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



2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
# File 'gems/aws-sdk-codedeploy/lib/aws-sdk-codedeploy/types.rb', line 2205

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

#task_set_labelString

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

Returns:

  • (String)


2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
# File 'gems/aws-sdk-codedeploy/lib/aws-sdk-codedeploy/types.rb', line 2205

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

#traffic_weightFloat

The percentage of traffic served by this task set.

Returns:

  • (Float)


2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
# File 'gems/aws-sdk-codedeploy/lib/aws-sdk-codedeploy/types.rb', line 2205

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