CreateTaskSetRequest Class | AWS SDK for .NET V3

Container for the parameters to the CreateTaskSet operation. 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.

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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.ECS.AmazonECSRequest
      Amazon.ECS.Model.CreateTaskSetRequest

Namespace: Amazon.ECS.Model
Assembly: AWSSDK.ECS.dll
Version: 3.x.y.z

Syntax

public class CreateTaskSetRequest : AmazonECSRequest
         IAmazonWebServiceRequest

The CreateTaskSetRequest type exposes the following members

Constructors

	Name	Description
	CreateTaskSetRequest()

Properties

Name	Type	Description
CapacityProviderStrategy	System.Collections.Generic.List<Amazon.ECS.Model.CapacityProviderStrategyItem>	Gets and sets the property 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 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.
ClientToken	System.String	Gets and sets the property ClientToken. 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.
Cluster	System.String	Gets and sets the property Cluster. The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set in.
ExternalId	System.String	Gets and sets the property 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` Cloud Map attribute set to the provided value.
LaunchType	Amazon.ECS.LaunchType	Gets and sets the property LaunchType. 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.
LoadBalancers	System.Collections.Generic.List<Amazon.ECS.Model.LoadBalancer>	Gets and sets the property 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.
NetworkConfiguration	Amazon.ECS.Model.NetworkConfiguration	Gets and sets the property NetworkConfiguration. An object representing the network configuration for a task set.
PlatformVersion	System.String	Gets and sets the property PlatformVersion. 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.
Scale	Amazon.ECS.Model.Scale	Gets and sets the property Scale. A floating-point percentage of the desired number of tasks to place and keep running in the task set.
Service	System.String	Gets and sets the property Service. The short name or full Amazon Resource Name (ARN) of the service to create the task set in.
ServiceRegistries	System.Collections.Generic.List<Amazon.ECS.Model.ServiceRegistry>	Gets and sets the property ServiceRegistries. The details of the service discovery registries to assign to this task set. For more information, see Service discovery.
Tags	System.Collections.Generic.List<Amazon.ECS.Model.Tag>	Gets and sets the property Tags. 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.
TaskDefinition	System.String	Gets and sets the property TaskDefinition. The task definition for the tasks in the task set to use. If a revision isn't specified, the latest `ACTIVE` revision is used.

Examples

This example creates a task set in a service that uses the EXTERNAL deployment controller.

To create a task set


var client = new AmazonECSClient();
var response = client.CreateTaskSet(new CreateTaskSetRequest 
{
    Cluster = "MyCluster",
    NetworkConfiguration = new NetworkConfiguration { AwsvpcConfiguration = new AwsVpcConfiguration {
        SecurityGroups = new List<string> {
            "sg-12344321"
        },
        Subnets = new List<string> {
            "subnet-12344321"
        }
    } },
    Service = "MyService",
    TaskDefinition = "MyTaskDefinition:2"
});

TaskSet taskSet = response.TaskSet;

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5