TaskSet
Information about a set of Amazon ECS tasks in either an AWS 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.
Contents
- capacityProviderStrategy
-
The capacity provider strategy associated with the task set.
Type: Array of CapacityProviderStrategyItem objects
Required: No
- clusterArn
-
The Amazon Resource Name (ARN) of the cluster that the service that hosts the task set exists in.
Type: String
Required: No
- computedDesiredCount
-
The computed desired count for the task set. This is calculated by multiplying the service's
desiredCount
by the task set'sscale
percentage. The result is always rounded up. For example, if the computed desired count is 1.2, it rounds up to 2 tasks.Type: Integer
Required: No
- createdAt
-
The Unix timestamp for when the task set was created.
Type: Timestamp
Required: No
- externalId
-
The external ID associated with the task set.
If a task set is created by an AWS CodeDeploy deployment, the
externalId
parameter contains the AWS 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 theECS_TASK_SET_EXTERNAL_ID
AWS Cloud Map attribute.Type: String
Required: No
- id
-
The ID of the task set.
Type: String
Required: No
- 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.
Type: String
Valid Values:
EC2 | FARGATE
Required: No
- loadBalancers
-
Details on a load balancer that is used with a task set.
Type: Array of LoadBalancer objects
Required: No
- networkConfiguration
-
The network configuration for the task set.
Type: NetworkConfiguration object
Required: No
- pendingCount
-
The number of tasks in the task set that are in the
PENDING
status during a deployment. A task in thePENDING
state is preparing to enter theRUNNING
state. A task set enters thePENDING
status when it launches for the first time or when it is restarted after being in theSTOPPED
state.Type: Integer
Required: No
- platformVersion
-
The AWS Fargate platform version on which the tasks in the task set are running. A platform version is only specified for tasks run on AWS Fargate. For more information, see AWS Fargate platform versions in the Amazon Elastic Container Service Developer Guide.
Type: String
Required: No
- runningCount
-
The number of tasks in the task set that are in the
RUNNING
status during a deployment. A task in theRUNNING
state is running and ready for use.Type: Integer
Required: No
- scale
-
A floating-point percentage of the desired number of tasks to place and keep running in the task set.
Type: Scale object
Required: No
- serviceArn
-
The Amazon Resource Name (ARN) of the service the task set exists in.
Type: String
Required: No
- serviceRegistries
-
The details of the service discovery registries to assign to this task set. For more information, see Service discovery.
Type: Array of ServiceRegistry objects
Required: No
- stabilityStatus
-
The stability status, which indicates whether the task set has reached a steady state. If the following conditions are met, the task set will be in
STEADY_STATE
:-
The task
runningCount
is equal to thecomputedDesiredCount
. -
The
pendingCount
is0
. -
There are no tasks 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 are not met, the stability status returns
STABILIZING
.Type: String
Valid Values:
STEADY_STATE | STABILIZING
Required: No
-
- stabilityStatusAt
-
The Unix timestamp for when the task set stability status was retrieved.
Type: Timestamp
Required: No
- startedBy
-
The tag specified when a task set is started. If the task set is created by an AWS CodeDeploy deployment, the
startedBy
parameter isCODE_DEPLOY
. For a task set created for an external deployment, the startedBy field isn't used.Type: String
Required: No
- status
-
The status of the task set. The following describes each state:
Type: String
Required: No
- 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, both of which you define.
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 AWS 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.
Type: Array of Tag objects
Array Members: Minimum number of 0 items. Maximum number of 50 items.
Required: No
-
- taskDefinition
-
The task definition the task set is using.
Type: String
Required: No
- taskSetArn
-
The Amazon Resource Name (ARN) of the task set.
Type: String
Required: No
- updatedAt
-
The Unix timestamp for when the task set was last updated.
Type: Timestamp
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: