class Aws::ECS::Types::TaskSet

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.

@!attribute [rw] id

The ID of the task set.
@return [String]

@!attribute [rw] task_set_arn

The Amazon Resource Name (ARN) of the task set.
@return [String]

@!attribute [rw] service_arn

The Amazon Resource Name (ARN) of the service the task set exists
in.
@return [String]

@!attribute [rw] cluster_arn

The Amazon Resource Name (ARN) of the cluster that the service that
hosts the task set exists in.
@return [String]

@!attribute [rw] started_by

The tag specified when a task set is started. If the task set is
created by an CodeDeploy deployment, the `startedBy` parameter is
`CODE_DEPLOY`. For a task set created for an external deployment,
the startedBy field isn't used.
@return [String]

@!attribute [rw] external_id

The external ID associated with the task set.

If a task set is created by an CodeDeploy deployment, 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.
@return [String]

@!attribute [rw] status

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

PRIMARY

: The task set is serving production traffic.

ACTIVE

: The task set is not serving production traffic.

DRAINING

: The tasks in the task set are being stopped and their
  corresponding targets are being deregistered from their target
  group.
@return [String]

@!attribute [rw] task_definition

The task definition the task set is using.
@return [String]

@!attribute [rw] computed_desired_count

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.
@return [Integer]

@!attribute [rw] pending_count

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 is restarted after
being in the `STOPPED` state.
@return [Integer]

@!attribute [rw] running_count

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.
@return [Integer]

@!attribute [rw] created_at

The Unix timestamp for when the task set was created.
@return [Time]

@!attribute [rw] updated_at

The Unix timestamp for when the task set was last updated.
@return [Time]

@!attribute [rw] launch_type

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

[1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html
@return [String]

@!attribute [rw] capacity_provider_strategy

The capacity provider strategy associated with the task set.
@return [Array<Types::CapacityProviderStrategyItem>]

@!attribute [rw] platform_version

The Fargate platform version on which 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][1] in
the *Amazon Elastic Container Service Developer Guide*.

[1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html
@return [String]

@!attribute [rw] network_configuration

The network configuration for the task set.
@return [Types::NetworkConfiguration]

@!attribute [rw] load_balancers

Details on a load balancer that is used with a task set.
@return [Array<Types::LoadBalancer>]

@!attribute [rw] service_registries

The details of the service discovery registries to assign to this
task set. For more information, see [Service discovery][1].

[1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html
@return [Array<Types::ServiceRegistry>]

@!attribute [rw] scale

A floating-point percentage of the desired number of tasks to place
and keep running in the task set.
@return [Types::Scale]

@!attribute [rw] stability_status

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 the `computedDesiredCount`.

* The `pendingCount` is `0`.

* 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`.
@return [String]

@!attribute [rw] stability_status_at

The Unix timestamp for when the task set stability status was
retrieved.
@return [Time]

@!attribute [rw] 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 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.
@return [Array<Types::Tag>]

@see docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/TaskSet AWS API Documentation

Constants

SENSITIVE