TaskSet¶
Structure Class¶
TaskSet
dataclass
¶
Bases: _SerdeShape
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.
Attributes¶
capacity_provider_strategy
class-attribute
instance-attribute
¶
capacity_provider_strategy: list[CapacityProviderStrategyItem] | None = ...
The capacity provider strategy that are associated with the task set.
cluster_arn
class-attribute
instance-attribute
¶
cluster_arn: str | None = ...
The Amazon Resource Name (ARN) of the cluster that the service that hosts the task set exists in.
computed_desired_count
class-attribute
instance-attribute
¶
computed_desired_count: int = ...
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.
created_at
class-attribute
instance-attribute
¶
created_at: datetime | None = ...
The Unix timestamp for the time when the task set was created.
external_id
class-attribute
instance-attribute
¶
external_id: str | None = ...
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.
fargate_ephemeral_storage
class-attribute
instance-attribute
¶
fargate_ephemeral_storage: DeploymentEphemeralStorage | None = ...
The Fargate ephemeral storage settings for the task set.
launch_type
class-attribute
instance-attribute
¶
launch_type: str | None = ...
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.
load_balancers
class-attribute
instance-attribute
¶
load_balancers: list[LoadBalancer] | None = ...
Details on a load balancer that are used with a task set.
network_configuration
class-attribute
instance-attribute
¶
network_configuration: NetworkConfiguration | None = ...
The network configuration for the task set.
pending_count
class-attribute
instance-attribute
¶
pending_count: int = ...
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.
platform_family
class-attribute
instance-attribute
¶
platform_family: str | None = ...
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.
platform_version
class-attribute
instance-attribute
¶
platform_version: str | None = ...
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.
running_count
class-attribute
instance-attribute
¶
running_count: int = ...
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.
scale
class-attribute
instance-attribute
¶
scale: Scale | None = ...
A floating-point percentage of your desired number of tasks to place and keep running in the task set.
service_arn
class-attribute
instance-attribute
¶
service_arn: str | None = ...
The Amazon Resource Name (ARN) of the service the task set exists in.
service_registries
class-attribute
instance-attribute
¶
service_registries: list[ServiceRegistry] | None = ...
The details for the service discovery registries to assign to this task set. For more information, see Service discovery.
stability_status
class-attribute
instance-attribute
¶
stability_status: str | None = ...
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
runningCountis equal to thecomputedDesiredCount. -
The
pendingCountis0. -
There are no tasks that are running on container instances in the
DRAININGstatus. -
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.
stability_status_at
class-attribute
instance-attribute
¶
stability_status_at: datetime | None = ...
The Unix timestamp for the time when the task set stability status was retrieved.
started_by
class-attribute
instance-attribute
¶
started_by: str | None = ...
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.
status
class-attribute
instance-attribute
¶
status: str | None = ...
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.
tags
class-attribute
instance-attribute
¶
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.
task_definition
class-attribute
instance-attribute
¶
task_definition: str | None = ...
The task definition that the task set is using.