Skip to main content

task_sets

Creates, updates, deletes or gets a task_set resource or lists task_sets in a region

Overview

Nametask_sets
TypeResource
DescriptionCreate a task set in the specified cluster and service. This is used when a service uses the EXTERNAL deployment controller type. For more information, see https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.htmlin the Amazon Elastic Container Service Developer Guide.
Idaws.ecs.task_sets

Fields

NameDatatypeDescription
platform_versionstringThe platform version that the tasks in the task set should use. A platform version is specified only for tasks using the Fargate launch type. If one isn't specified, the LATEST platform version is used by default.
external_idstringAn optional non-unique tag that identifies this task set in external systems. If the task set is associated with a service discovery registry, the tasks in this task set will have the ECS_TASK_SET_EXTERNAL_ID AWS Cloud Map attribute set to the provided value.
clusterstringThe short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set in.
load_balancersarray
servicestringThe short name or full Amazon Resource Name (ARN) of the service to create the task set in.
scaleobjectA floating-point percentage of the desired number of tasks to place and keep running in the task set.
service_registriesarrayThe details of the service discovery registries to assign to this task set. For more information, see https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html.
capacity_provider_strategyarray
launch_typestringThe launch type that new tasks in the task set will use. For more information, see https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html in the Amazon Elastic Container Service Developer Guide.
task_definitionstringThe short name or full Amazon Resource Name (ARN) of the task definition for the tasks in the task set to use.
network_configurationobjectAn object representing the network configuration for a task or service.
idstringThe ID of the task set.
tagsarray
regionstringAWS region.

For more information, see AWS::ECS::TaskSet.

Methods

NameAccessible byRequired Params
create_resourceINSERTCluster, Service, TaskDefinition, region
delete_resourceDELETEdata__Identifier, region
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
get_resourceSELECTdata__Identifier, region

SELECT examples

Gets all properties from an individual task_set.

SELECT
region,
platform_version,
external_id,
cluster,
load_balancers,
service,
scale,
service_registries,
capacity_provider_strategy,
launch_type,
task_definition,
network_configuration,
id,
tags
FROM aws.ecs.task_sets
WHERE region = 'us-east-1' AND data__Identifier = '<Cluster>|<Service>|<Id>';

INSERT example

Use the following StackQL query and manifest file to create a new task_set resource, using stack-deploy.

/*+ create */
INSERT INTO aws.ecs.task_sets (
Cluster,
Service,
TaskDefinition,
region
)
SELECT
'{{ Cluster }}',
'{{ Service }}',
'{{ TaskDefinition }}',
'{{ region }}';

DELETE example

/*+ delete */
DELETE FROM aws.ecs.task_sets
WHERE data__Identifier = '<Cluster|Service|Id>'
AND region = 'us-east-1';

Permissions

To operate on the task_sets resource, the following permissions are required:

Read

ecs:DescribeTaskSets

Create

ecs:CreateTaskSet,
ecs:DescribeTaskSets,
ecs:TagResource

Update

ecs:DescribeTaskSets,
ecs:TagResource,
ecs:UntagResource,
ecs:UpdateTaskSet

Delete

ecs:DeleteTaskSet,
ecs:DescribeTaskSets