Skip to content

Delete Task Set

ecs_delete_task_set R Documentation

Deletes a specified task set within a service

Description

Deletes a specified task set within a service. This is used when a service uses the EXTERNAL deployment controller type. For more information, see Amazon ECS deployment types in the Amazon Elastic Container Service Developer Guide.

Usage

ecs_delete_task_set(cluster, service, taskSet, force)

Arguments

cluster

[required] The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task set found in to delete.

service

[required] The short name or full Amazon Resource Name (ARN) of the service that hosts the task set to delete.

taskSet

[required] The task set ID or full Amazon Resource Name (ARN) of the task set to delete.

force

If true, you can delete a task set even if it hasn't been scaled down to zero.

Value

A list with the following syntax:

list(
  taskSet = list(
    id = "string",
    taskSetArn = "string",
    serviceArn = "string",
    clusterArn = "string",
    startedBy = "string",
    externalId = "string",
    status = "string",
    taskDefinition = "string",
    computedDesiredCount = 123,
    pendingCount = 123,
    runningCount = 123,
    createdAt = as.POSIXct(
      "2015-01-01"
    ),
    updatedAt = as.POSIXct(
      "2015-01-01"
    ),
    launchType = "EC2"|"FARGATE"|"EXTERNAL",
    capacityProviderStrategy = list(
      list(
        capacityProvider = "string",
        weight = 123,
        base = 123
      )
    ),
    platformVersion = "string",
    platformFamily = "string",
    networkConfiguration = list(
      awsvpcConfiguration = list(
        subnets = list(
          "string"
        ),
        securityGroups = list(
          "string"
        ),
        assignPublicIp = "ENABLED"|"DISABLED"
      )
    ),
    loadBalancers = list(
      list(
        targetGroupArn = "string",
        loadBalancerName = "string",
        containerName = "string",
        containerPort = 123
      )
    ),
    serviceRegistries = list(
      list(
        registryArn = "string",
        port = 123,
        containerName = "string",
        containerPort = 123
      )
    ),
    scale = list(
      value = 123.0,
      unit = "PERCENT"
    ),
    stabilityStatus = "STEADY_STATE"|"STABILIZING",
    stabilityStatusAt = as.POSIXct(
      "2015-01-01"
    ),
    tags = list(
      list(
        key = "string",
        value = "string"
      )
    ),
    fargateEphemeralStorage = list(
      kmsKeyId = "string"
    )
  )
)

Request syntax

svc$delete_task_set(
  cluster = "string",
  service = "string",
  taskSet = "string",
  force = TRUE|FALSE
)