Skip to content

/AWS1/CL_ECSTASKSET

Information about a set of Amazon ECS tasks in either an CodeDeploy or an EXTERNAL 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.

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_id TYPE /AWS1/ECSSTRING /AWS1/ECSSTRING

The ID of the task set.

iv_tasksetarn TYPE /AWS1/ECSSTRING /AWS1/ECSSTRING

The Amazon Resource Name (ARN) of the task set.

iv_servicearn TYPE /AWS1/ECSSTRING /AWS1/ECSSTRING

The Amazon Resource Name (ARN) of the service the task set exists in.

iv_clusterarn TYPE /AWS1/ECSSTRING /AWS1/ECSSTRING

The Amazon Resource Name (ARN) of the cluster that the service that hosts the task set exists in.

iv_startedby TYPE /AWS1/ECSSTRING /AWS1/ECSSTRING

The tag specified when a task set is started. If an CodeDeploy deployment created the task set, the startedBy parameter is CODE_DEPLOY. If an external deployment created the task set, the startedBy field isn't used.

iv_externalid TYPE /AWS1/ECSSTRING /AWS1/ECSSTRING

The external ID associated with the task set.

If an CodeDeploy deployment created a task set, the externalId parameter contains the CodeDeploy deployment ID.

If a task set is created for an external deployment and is associated with a service discovery registry, the externalId parameter contains the ECS_TASK_SET_EXTERNAL_ID Cloud Map attribute.

iv_status TYPE /AWS1/ECSSTRING /AWS1/ECSSTRING

The status of the task set. The following describes each state.

PRIMARY

The task set is serving production traffic.

ACTIVE

The task set isn't serving production traffic.

DRAINING

The tasks in the task set are being stopped, and their corresponding targets are being deregistered from their target group.

iv_taskdefinition TYPE /AWS1/ECSSTRING /AWS1/ECSSTRING

The task definition that the task set is using.

iv_computeddesiredcount TYPE /AWS1/ECSINTEGER /AWS1/ECSINTEGER

The computed desired count for the task set. This is calculated by multiplying the service's desiredCount by the task set's scale percentage. The result is always rounded up. For example, if the computed desired count is 1.2, it rounds up to 2 tasks.

iv_pendingcount TYPE /AWS1/ECSINTEGER /AWS1/ECSINTEGER

The number of tasks in the task set that are in the PENDING status during a 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's restarted after being in the STOPPED state.

iv_runningcount TYPE /AWS1/ECSINTEGER /AWS1/ECSINTEGER

The number of tasks in the task set that are in the RUNNING status during a deployment. A task in the RUNNING state is running and ready for use.

iv_createdat TYPE /AWS1/ECSTIMESTAMP /AWS1/ECSTIMESTAMP

The Unix timestamp for the time when the task set was created.

iv_updatedat TYPE /AWS1/ECSTIMESTAMP /AWS1/ECSTIMESTAMP

The Unix timestamp for the time when the task set was last updated.

iv_launchtype TYPE /AWS1/ECSLAUNCHTYPE /AWS1/ECSLAUNCHTYPE

The launch type the tasks in the task set are using. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.

it_capacityproviderstrategy TYPE /AWS1/CL_ECSCAPPVDRSTRAGITEM=>TT_CAPACITYPROVIDERSTRATEGY TT_CAPACITYPROVIDERSTRATEGY

The capacity provider strategy that are associated with the task set.

iv_platformversion TYPE /AWS1/ECSSTRING /AWS1/ECSSTRING

The Fargate platform version where the tasks in the task set are running. A platform version is only specified for tasks run on Fargate. For more information, see Fargate platform versions in the Amazon Elastic Container Service Developer Guide.

iv_platformfamily TYPE /AWS1/ECSSTRING /AWS1/ECSSTRING

The operating system that your tasks in the set are running on. A platform family is specified only for tasks that use the Fargate launch type.

All tasks in the set must have the same value.

io_networkconfiguration TYPE REF TO /AWS1/CL_ECSNETWORKCONF /AWS1/CL_ECSNETWORKCONF

The network configuration for the task set.

it_loadbalancers TYPE /AWS1/CL_ECSLOADBALANCER=>TT_LOADBALANCERS TT_LOADBALANCERS

Details on a load balancer that are used with a task set.

it_serviceregistries TYPE /AWS1/CL_ECSSERVICEREGISTRY=>TT_SERVICEREGISTRIES TT_SERVICEREGISTRIES

The details for the service discovery registries to assign to this task set. For more information, see Service discovery.

io_scale TYPE REF TO /AWS1/CL_ECSSCALE /AWS1/CL_ECSSCALE

A floating-point percentage of your desired number of tasks to place and keep running in the task set.

iv_stabilitystatus TYPE /AWS1/ECSSTABILITYSTATUS /AWS1/ECSSTABILITYSTATUS

The stability status. This indicates whether the task set has reached a steady state. If the following conditions are met, the task set are in STEADY_STATE:

  • The task runningCount is equal to the computedDesiredCount.

  • The pendingCount is 0.

  • There are no tasks that are running on container instances in the DRAINING status.

  • All tasks are reporting a healthy status from the load balancers, service discovery, and container health checks.

If any of those conditions aren't met, the stability status returns STABILIZING.

iv_stabilitystatusat TYPE /AWS1/ECSTIMESTAMP /AWS1/ECSTIMESTAMP

The Unix timestamp for the time when the task set stability status was retrieved.

it_tags TYPE /AWS1/CL_ECSTAG=>TT_TAGS TT_TAGS

The metadata that you apply to the task set to help you categorize and organize them. Each tag consists of a key and an optional value. You define both.

The following basic restrictions apply to tags:

  • Maximum number of tags per resource - 50

  • For each resource, each tag key must be unique, and each tag key can have only one value.

  • Maximum key length - 128 Unicode characters in UTF-8

  • Maximum value length - 256 Unicode characters in UTF-8

  • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

  • Tag keys and values are case-sensitive.

  • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

io_fargateephemeralstorage TYPE REF TO /AWS1/CL_ECSDEPLOYMENTEPHEME00 /AWS1/CL_ECSDEPLOYMENTEPHEME00

The Fargate ephemeral storage settings for the task set.

Queryable Attributes

id

The ID of the task set.

Accessible with the following methods

Method Description
GET_ID() Getter for ID, with configurable default
ASK_ID() Getter for ID w/ exceptions if field has no value
HAS_ID() Determine if ID has a value

taskSetArn

The Amazon Resource Name (ARN) of the task set.

Accessible with the following methods

Method Description
GET_TASKSETARN() Getter for TASKSETARN, with configurable default
ASK_TASKSETARN() Getter for TASKSETARN w/ exceptions if field has no value
HAS_TASKSETARN() Determine if TASKSETARN has a value

serviceArn

The Amazon Resource Name (ARN) of the service the task set exists in.

Accessible with the following methods

Method Description
GET_SERVICEARN() Getter for SERVICEARN, with configurable default
ASK_SERVICEARN() Getter for SERVICEARN w/ exceptions if field has no value
HAS_SERVICEARN() Determine if SERVICEARN has a value

clusterArn

The Amazon Resource Name (ARN) of the cluster that the service that hosts the task set exists in.

Accessible with the following methods

Method Description
GET_CLUSTERARN() Getter for CLUSTERARN, with configurable default
ASK_CLUSTERARN() Getter for CLUSTERARN w/ exceptions if field has no value
HAS_CLUSTERARN() Determine if CLUSTERARN has a value

startedBy

The tag specified when a task set is started. If an CodeDeploy deployment created the task set, the startedBy parameter is CODE_DEPLOY. If an external deployment created the task set, the startedBy field isn't used.

Accessible with the following methods

Method Description
GET_STARTEDBY() Getter for STARTEDBY, with configurable default
ASK_STARTEDBY() Getter for STARTEDBY w/ exceptions if field has no value
HAS_STARTEDBY() Determine if STARTEDBY has a value

externalId

The external ID associated with the task set.

If an CodeDeploy deployment created a task set, the externalId parameter contains the CodeDeploy deployment ID.

If a task set is created for an external deployment and is associated with a service discovery registry, the externalId parameter contains the ECS_TASK_SET_EXTERNAL_ID Cloud Map attribute.

Accessible with the following methods

Method Description
GET_EXTERNALID() Getter for EXTERNALID, with configurable default
ASK_EXTERNALID() Getter for EXTERNALID w/ exceptions if field has no value
HAS_EXTERNALID() Determine if EXTERNALID has a value

status

The status of the task set. The following describes each state.

PRIMARY

The task set is serving production traffic.

ACTIVE

The task set isn't serving production traffic.

DRAINING

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

taskDefinition

The task definition that the task set is using.

Accessible with the following methods

Method Description
GET_TASKDEFINITION() Getter for TASKDEFINITION, with configurable default
ASK_TASKDEFINITION() Getter for TASKDEFINITION w/ exceptions if field has no valu
HAS_TASKDEFINITION() Determine if TASKDEFINITION has a value

computedDesiredCount

The computed desired count for the task set. This is calculated by multiplying the service's desiredCount by the task set's scale percentage. The result is always rounded up. For example, if the computed desired count is 1.2, it rounds up to 2 tasks.

Accessible with the following methods

Method Description
GET_COMPUTEDDESIREDCOUNT() Getter for COMPUTEDDESIREDCOUNT

pendingCount

The number of tasks in the task set that are in the PENDING status during a 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's 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 a 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

createdAt

The Unix timestamp for the time when the task set was created.

Accessible with the following methods

Method Description
GET_CREATEDAT() Getter for CREATEDAT, with configurable default
ASK_CREATEDAT() Getter for CREATEDAT w/ exceptions if field has no value
HAS_CREATEDAT() Determine if CREATEDAT has a value

updatedAt

The Unix timestamp for the time when the task set was last updated.

Accessible with the following methods

Method Description
GET_UPDATEDAT() Getter for UPDATEDAT, with configurable default
ASK_UPDATEDAT() Getter for UPDATEDAT w/ exceptions if field has no value
HAS_UPDATEDAT() Determine if UPDATEDAT has a value

launchType

The launch type the tasks in the task set are using. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.

Accessible with the following methods

Method Description
GET_LAUNCHTYPE() Getter for LAUNCHTYPE, with configurable default
ASK_LAUNCHTYPE() Getter for LAUNCHTYPE w/ exceptions if field has no value
HAS_LAUNCHTYPE() Determine if LAUNCHTYPE has a value

capacityProviderStrategy

The capacity provider strategy that are associated with the task set.

Accessible with the following methods

Method Description
GET_CAPACITYPROVIDERSTRATEGY() Getter for CAPACITYPROVIDERSTRATEGY, with configurable defau
ASK_CAPACITYPROVIDERSTRATEGY() Getter for CAPACITYPROVIDERSTRATEGY w/ exceptions if field h
HAS_CAPACITYPROVIDERSTRATEGY() Determine if CAPACITYPROVIDERSTRATEGY has a value

platformVersion

The Fargate platform version where the tasks in the task set are running. A platform version is only specified for tasks run on Fargate. For more information, see Fargate platform versions in the Amazon Elastic Container Service Developer Guide.

Accessible with the following methods

Method Description
GET_PLATFORMVERSION() Getter for PLATFORMVERSION, with configurable default
ASK_PLATFORMVERSION() Getter for PLATFORMVERSION w/ exceptions if field has no val
HAS_PLATFORMVERSION() Determine if PLATFORMVERSION has a value

platformFamily

The operating system that your tasks in the set are running on. A platform family is specified only for tasks that use the Fargate launch type.

All tasks in the set must have the same value.

Accessible with the following methods

Method Description
GET_PLATFORMFAMILY() Getter for PLATFORMFAMILY, with configurable default
ASK_PLATFORMFAMILY() Getter for PLATFORMFAMILY w/ exceptions if field has no valu
HAS_PLATFORMFAMILY() Determine if PLATFORMFAMILY has a value

networkConfiguration

The network configuration for the task set.

Accessible with the following methods

Method Description
GET_NETWORKCONFIGURATION() Getter for NETWORKCONFIGURATION

loadBalancers

Details on a load balancer that are used with a task set.

Accessible with the following methods

Method Description
GET_LOADBALANCERS() Getter for LOADBALANCERS, with configurable default
ASK_LOADBALANCERS() Getter for LOADBALANCERS w/ exceptions if field has no value
HAS_LOADBALANCERS() Determine if LOADBALANCERS has a value

serviceRegistries

The details for the service discovery registries to assign to this task set. For more information, see Service discovery.

Accessible with the following methods

Method Description
GET_SERVICEREGISTRIES() Getter for SERVICEREGISTRIES, with configurable default
ASK_SERVICEREGISTRIES() Getter for SERVICEREGISTRIES w/ exceptions if field has no v
HAS_SERVICEREGISTRIES() Determine if SERVICEREGISTRIES has a value

scale

A floating-point percentage of your desired number of tasks to place and keep running in the task set.

Accessible with the following methods

Method Description
GET_SCALE() Getter for SCALE

stabilityStatus

The stability status. This indicates whether the task set has reached a steady state. If the following conditions are met, the task set are in STEADY_STATE:

  • The task runningCount is equal to the computedDesiredCount.

  • The pendingCount is 0.

  • There are no tasks that are running on container instances in the DRAINING status.

  • All tasks are reporting a healthy status from the load balancers, service discovery, and container health checks.

If any of those conditions aren't met, the stability status returns STABILIZING.

Accessible with the following methods

Method Description
GET_STABILITYSTATUS() Getter for STABILITYSTATUS, with configurable default
ASK_STABILITYSTATUS() Getter for STABILITYSTATUS w/ exceptions if field has no val
HAS_STABILITYSTATUS() Determine if STABILITYSTATUS has a value

stabilityStatusAt

The Unix timestamp for the time when the task set stability status was retrieved.

Accessible with the following methods

Method Description
GET_STABILITYSTATUSAT() Getter for STABILITYSTATUSAT, with configurable default
ASK_STABILITYSTATUSAT() Getter for STABILITYSTATUSAT w/ exceptions if field has no v
HAS_STABILITYSTATUSAT() Determine if STABILITYSTATUSAT has a value

tags

The metadata that you apply to the task set to help you categorize and organize them. Each tag consists of a key and an optional value. You define both.

The following basic restrictions apply to tags:

  • Maximum number of tags per resource - 50

  • For each resource, each tag key must be unique, and each tag key can have only one value.

  • Maximum key length - 128 Unicode characters in UTF-8

  • Maximum value length - 256 Unicode characters in UTF-8

  • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

  • Tag keys and values are case-sensitive.

  • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

Accessible with the following methods

Method Description
GET_TAGS() Getter for TAGS, with configurable default
ASK_TAGS() Getter for TAGS w/ exceptions if field has no value
HAS_TAGS() Determine if TAGS has a value

fargateEphemeralStorage

The Fargate ephemeral storage settings for the task set.

Accessible with the following methods

Method Description
GET_FARGATEEPHEMERALSTORAGE() Getter for FARGATEEPHEMERALSTORAGE

Public Local Types In This Class

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

TT_TASKSETS

TYPES TT_TASKSETS TYPE STANDARD TABLE OF REF TO /AWS1/CL_ECSTASKSET WITH DEFAULT KEY
.