R: Create Task Set

ecs_create_task_set {aws.ecx}

R Documentation

Create Task Set

Description

Create 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 Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide.

Usage

ecs_create_task_set(
  service = NULL,
  cluster = NULL,
  externalId = NULL,
  taskDefinition = NULL,
  networkConfiguration = NULL,
  loadBalancers = NULL,
  serviceRegistries = NULL,
  launchType = NULL,
  capacityProviderStrategy = NULL,
  platformVersion = NULL,
  scale = NULL,
  clientToken = NULL,
  tags = NULL,
  simplify = TRUE,
  others = list(),
  print_on_error = aws_get_print_on_error(),
  retry_time = aws_get_retry_time(),
  network_timeout = aws_get_network_timeout(),
  region = aws_get_region()
)

Arguments

`service`	Character. The short name or full Amazon Resource Name (ARN) of the service to create the task set in.
`cluster`	Character. The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create...
`externalId`	Character. An optional non-unique tag that identifies this task set in external systems.
`taskDefinition`	Character. The task definition for the tasks in the task set to use.
`networkConfiguration`	No description can be found.
`loadBalancers`	List. A load balancer object representing the load balancer to use with the task set.
`serviceRegistries`	List. The details of the service discovery registries to assign to this task set.
`launchType`	Character. The launch type that new tasks in the task set will use.
`capacityProviderStrategy`	List. The capacity provider strategy to use for the task set.
`platformVersion`	Character. The platform version that the tasks in the task set should use.
`scale`	No description can be found.
`clientToken`	Character. Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
`tags`	List. The metadata that you apply to the task set to help you categorize and organize them.
`simplify`	Logical. Whether to simplify the result and handle `nextToken` in the response[optional]
`others`	Named list. The parameters that are not included in the function parameters and need to be added into the request[optional]
`print_on_error`	Logical. Whether to show an error message when a network error occurs.
`retry_time`	Integer. Number of retries for a REST request when encounter the network issue. If the request has been sent `retry_time` times but still not be able to get the response, an error will be thrown.
`network_timeout`	Numeric. Number of seconds to wait for a REST response until giving up. Can not be less than 1 ms.
`region`	Character. The region of the AWS service.

Value

A list object or a character vector

service

The short name or full Amazon Resource Name (ARN) of the service to create the task set in.

cluster

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set in.

externalId

An 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.

taskDefinition

The task definition for the tasks in the task set to use.

networkConfiguration

No description can be found.

loadBalancers

A load balancer object representing the load balancer to use with the task set. The supported load balancer types are either an Application Load Balancer or a Network Load Balancer.

serviceRegistries

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

launchType

The launch type that new tasks in the task set will use. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.

If a launchType is specified, the capacityProviderStrategy parameter must be omitted.

capacityProviderStrategy

The capacity provider strategy to use for the task set.

A capacity provider strategy consists of one or more capacity providers along with the base and weight to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with an ACTIVE or UPDATING status can be used.

If a capacityProviderStrategy is specified, the launchType parameter must be omitted. If no capacityProviderStrategy or launchType is specified, the defaultCapacityProviderStrategy for the cluster is used.

If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.

To use a AWS Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.

The PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created.

platformVersion

The 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.

scale

No description can be found.

clientToken

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 32 ASCII characters are allowed.