Skip to content

/AWS1/CL_DPLECSTASKSET

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.

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_identifer TYPE /AWS1/DPLECSTASKSETIDENTIFIER /AWS1/DPLECSTASKSETIDENTIFIER

A unique ID of an ECSTaskSet.

iv_desiredcount TYPE /AWS1/DPLECSTASKSETCOUNT /AWS1/DPLECSTASKSETCOUNT

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.

iv_pendingcount TYPE /AWS1/DPLECSTASKSETCOUNT /AWS1/DPLECSTASKSETCOUNT

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.

iv_runningcount TYPE /AWS1/DPLECSTASKSETCOUNT /AWS1/DPLECSTASKSETCOUNT

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.

iv_status TYPE /AWS1/DPLECSTASKSETSTATUS /AWS1/DPLECSTASKSETSTATUS

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.

iv_trafficweight TYPE /AWS1/RT_DOUBLE_AS_STRING /AWS1/RT_DOUBLE_AS_STRING

The percentage of traffic served by this task set.

io_targetgroup TYPE REF TO /AWS1/CL_DPLTARGETGROUPINFO /AWS1/CL_DPLTARGETGROUPINFO

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

iv_tasksetlabel TYPE /AWS1/DPLTARGETLABEL /AWS1/DPLTARGETLABEL

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

Queryable Attributes

identifer

A unique ID of an ECSTaskSet.

Accessible with the following methods

Method Description
GET_IDENTIFER() Getter for IDENTIFER, with configurable default
ASK_IDENTIFER() Getter for IDENTIFER w/ exceptions if field has no value
HAS_IDENTIFER() Determine if IDENTIFER has a value

desiredCount

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.

Accessible with the following methods

Method Description
GET_DESIREDCOUNT() Getter for DESIREDCOUNT

pendingCount

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.

Accessible with the following methods

Method Description
GET_PENDINGCOUNT() Getter for PENDINGCOUNT

runningCount

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.

Accessible with the following methods

Method Description
GET_RUNNINGCOUNT() Getter for RUNNINGCOUNT

status

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.

Accessible with the following methods

Method Description
GET_STATUS() Getter for STATUS, with configurable default
ASK_STATUS() Getter for STATUS w/ exceptions if field has no value
HAS_STATUS() Determine if STATUS has a value

trafficWeight

The percentage of traffic served by this task set.

Accessible with the following methods

Method Description
GET_TRAFFICWEIGHT() Getter for TRAFFICWEIGHT
ASK_TRAFFICWEIGHT() Getter for TRAFFICWEIGHT w/ exceptions if field has no value
STR_TRAFFICWEIGHT() String format for TRAFFICWEIGHT

targetGroup

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

Accessible with the following methods

Method Description
GET_TARGETGROUP() Getter for TARGETGROUP

taskSetLabel

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

Accessible with the following methods

Method Description
GET_TASKSETLABEL() Getter for TASKSETLABEL, with configurable default
ASK_TASKSETLABEL() Getter for TASKSETLABEL w/ exceptions if field has no value
HAS_TASKSETLABEL() Determine if TASKSETLABEL has a value

Public Local Types In This Class

Internal table types, representing arrays and maps of this class, are defined as local types:

TT_ECSTASKSETLIST

TYPES TT_ECSTASKSETLIST TYPE STANDARD TABLE OF REF TO /AWS1/CL_DPLECSTASKSET WITH DEFAULT KEY
.