create_task_set¶
Operation¶
async
¶
create_task_set(input: CreateTaskSetInput, plugins: list[Plugin] | None = None) -> CreateTaskSetOutput
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.
Note
On March 21, 2024, a change was made to resolve the task definition revision before authorization. When a task definition revision is not specified, authorization will occur using the latest revision of a task definition.
For information about the maximum number of task sets and other quotas, see Amazon ECS service quotas in the Amazon Elastic Container Service Developer Guide.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
CreateTaskSetInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
CreateTaskSetOutput
|
An instance of |
Input¶
dataclass
¶
Bases: _SerdeShape
Dataclass for CreateTaskSetInput structure.
Attributes¶
class-attribute
instance-attribute
¶
capacity_provider_strategy: list[CapacityProviderStrategyItem] | None = ...
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 CreateCapacityProviderProviderAPI operation.
To use a Fargate capacity provider, specify either the FARGATE or
FARGATE_SPOT capacity providers. The 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.
class-attribute
instance-attribute
¶
client_token: str | None = ...
An identifier that you provide to ensure the idempotency of the request. It must be unique and is case sensitive. Up to 36 ASCII characters in the range of 33-126 (inclusive) are allowed.
class-attribute
instance-attribute
¶
cluster: str | None = ...
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set in.
class-attribute
instance-attribute
¶
external_id: str | None = ...
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 Cloud Map attribute set to the provided
value.
class-attribute
instance-attribute
¶
launch_type: str | None = ...
The launch type that new tasks in the task set uses. 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.
class-attribute
instance-attribute
¶
load_balancers: list[LoadBalancer] | None = ...
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.
class-attribute
instance-attribute
¶
An object representing the network configuration for a task set.
class-attribute
instance-attribute
¶
platform_version: str | None = ...
The platform version that the tasks in the task set uses. A platform
version is specified only for tasks using the Fargate launch type. If
one isn't specified, the LATEST platform version is used.
class-attribute
instance-attribute
¶
A floating-point percentage of the desired number of tasks to place and keep running in the task set.
class-attribute
instance-attribute
¶
service: str | None = ...
The short name or full Amazon Resource Name (ARN) of the service to create the task set in.
class-attribute
instance-attribute
¶
service_registries: list[ServiceRegistry] | None = ...
The details of the service discovery registries to assign to this task set. For more information, see Service discovery.
class-attribute
instance-attribute
¶
tags: list[Tag] | None = ...
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. You define both. When a service is deleted, the tags are deleted.
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.
Output¶
dataclass
¶
Bases: _SerdeShape
Dataclass for CreateTaskSetOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.
class-attribute
instance-attribute
¶
Information about a set of Amazon ECS tasks in either an CodeDeploy or
an EXTERNAL deployment. A task set includes details such as the
desired number of tasks, how many tasks are running, and whether the
task set serves production traffic.