/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::ECS::TaskSet

NAME

Paws::ECS::TaskSet

USAGE

This class represents one of two things:

Arguments in a call to a service

Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. Each attribute should be used as a named argument in the calls that expect this type of object.

As an example, if Att1 is expected to be a Paws::ECS::TaskSet object:

$service_obj->Method(Att1 => { CapacityProviderStrategy => $value, ..., UpdatedAt => $value  });

Results returned from an API call

Use accessors for each attribute. If Att1 is expected to be an Paws::ECS::TaskSet object:

$result = $service_obj->Method(...);
$result->Att1->CapacityProviderStrategy

DESCRIPTION

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.

ATTRIBUTES

CapacityProviderStrategy => ArrayRef[Paws::ECS::CapacityProviderStrategyItem]

The capacity provider strategy associated with the task set.

ClusterArn => Str

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

ComputedDesiredCount => 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.

CreatedAt => Str

The Unix timestamp for when the task set was created.

ExternalId => Str

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 the ECS_TASK_SET_EXTERNAL_ID AWS Cloud Map attribute.

Id => Str

The ID of the task set.

LaunchType => Str

The launch type the tasks in the task set are using. For more information, see Amazon ECS launch types (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) in the Amazon Elastic Container Service Developer Guide.

LoadBalancers => ArrayRef[Paws::ECS::LoadBalancer]

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

NetworkConfiguration => Paws::ECS::NetworkConfiguration

The network configuration for the task set.

PendingCount => 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 is restarted after being in the STOPPED state.

PlatformVersion => Str

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 (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) in the Amazon Elastic Container Service Developer Guide.

RunningCount => 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 => Paws::ECS::Scale

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

ServiceArn => Str

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

ServiceRegistries => ArrayRef[Paws::ECS::ServiceRegistry]

The details of the service discovery registries to assign to this task set. For more information, see Service discovery (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html).

StabilityStatus => Str

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.

StabilityStatusAt => Str

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

StartedBy => Str

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

Status => Str

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.

Tags => ArrayRef[Paws::ECS::Tag]

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.

TaskDefinition => Str

The task definition the task set is using.

TaskSetArn => Str

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

UpdatedAt => Str

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

SEE ALSO

This class forms part of Paws, describing an object used in Paws::ECS

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues