class Aws::ECS::Types::CreateTaskSetRequest

@note When making an API call, you may pass CreateTaskSetRequest

data as a hash:

    {
      service: "String", # required
      cluster: "String", # required
      external_id: "String",
      task_definition: "String", # required
      network_configuration: {
        awsvpc_configuration: {
          subnets: ["String"], # required
          security_groups: ["String"],
          assign_public_ip: "ENABLED", # accepts ENABLED, DISABLED
        },
      },
      load_balancers: [
        {
          target_group_arn: "String",
          load_balancer_name: "String",
          container_name: "String",
          container_port: 1,
        },
      ],
      service_registries: [
        {
          registry_arn: "String",
          port: 1,
          container_name: "String",
          container_port: 1,
        },
      ],
      launch_type: "EC2", # accepts EC2, FARGATE, EXTERNAL
      capacity_provider_strategy: [
        {
          capacity_provider: "String", # required
          weight: 1,
          base: 1,
        },
      ],
      platform_version: "String",
      scale: {
        value: 1.0,
        unit: "PERCENT", # accepts PERCENT
      },
      client_token: "String",
      tags: [
        {
          key: "TagKey",
          value: "TagValue",
        },
      ],
    }

@!attribute [rw] service

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

@!attribute [rw] cluster

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

@!attribute [rw] external_id

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.
@return [String]

@!attribute [rw] task_definition

The task definition for the tasks in the task set to use.
@return [String]

@!attribute [rw] network_configuration

An object representing the network configuration for a task set.
@return [Types::NetworkConfiguration]

@!attribute [rw] load_balancers

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.
@return [Array<Types::LoadBalancer>]

@!attribute [rw] service_registries

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

[1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html
@return [Array<Types::ServiceRegistry>]

@!attribute [rw] launch_type

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

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

[1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html
@return [String]

@!attribute [rw] capacity_provider_strategy

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 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.
@return [Array<Types::CapacityProviderStrategyItem>]

@!attribute [rw] platform_version

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.
@return [String]

@!attribute [rw] scale

A floating-point percentage of the desired number of tasks to place
and keep running in the task set.
@return [Types::Scale]

@!attribute [rw] client_token

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

@!attribute [rw] 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,
both of which you define. When a service is deleted, the tags are
deleted as well.

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.
@return [Array<Types::Tag>]

@see docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/CreateTaskSetRequest AWS API Documentation

Constants

SENSITIVE