class Aws::ECS::Types::RunTaskRequest

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

data as a hash:

    {
      capacity_provider_strategy: [
        {
          capacity_provider: "String", # required
          weight: 1,
          base: 1,
        },
      ],
      cluster: "String",
      count: 1,
      enable_ecs_managed_tags: false,
      enable_execute_command: false,
      group: "String",
      launch_type: "EC2", # accepts EC2, FARGATE, EXTERNAL
      network_configuration: {
        awsvpc_configuration: {
          subnets: ["String"], # required
          security_groups: ["String"],
          assign_public_ip: "ENABLED", # accepts ENABLED, DISABLED
        },
      },
      overrides: {
        container_overrides: [
          {
            name: "String",
            command: ["String"],
            environment: [
              {
                name: "String",
                value: "String",
              },
            ],
            environment_files: [
              {
                value: "String", # required
                type: "s3", # required, accepts s3
              },
            ],
            cpu: 1,
            memory: 1,
            memory_reservation: 1,
            resource_requirements: [
              {
                value: "String", # required
                type: "GPU", # required, accepts GPU, InferenceAccelerator
              },
            ],
          },
        ],
        cpu: "String",
        inference_accelerator_overrides: [
          {
            device_name: "String",
            device_type: "String",
          },
        ],
        execution_role_arn: "String",
        memory: "String",
        task_role_arn: "String",
        ephemeral_storage: {
          size_in_gi_b: 1, # required
        },
      },
      placement_constraints: [
        {
          type: "distinctInstance", # accepts distinctInstance, memberOf
          expression: "String",
        },
      ],
      placement_strategy: [
        {
          type: "random", # accepts random, spread, binpack
          field: "String",
        },
      ],
      platform_version: "String",
      propagate_tags: "TASK_DEFINITION", # accepts TASK_DEFINITION, SERVICE
      reference_id: "String",
      started_by: "String",
      tags: [
        {
          key: "TagKey",
          value: "TagValue",
        },
      ],
      task_definition: "String", # required
    }

@!attribute [rw] capacity_provider_strategy

The capacity provider strategy to use for the task.

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.

When you use cluster auto scaling, you must specify
`capacityProviderStrategy` and not `launchType`.

A capacity provider strategy may contain a maximum of 6 capacity
providers.
@return [Array<Types::CapacityProviderStrategyItem>]

@!attribute [rw] cluster

The short name or full Amazon Resource Name (ARN) of the cluster on
which to run your task. If you do not specify a cluster, the default
cluster is assumed.
@return [String]

@!attribute [rw] count

The number of instantiations of the specified task to place on your
cluster. You can specify up to 10 tasks per call.
@return [Integer]

@!attribute [rw] enable_ecs_managed_tags

Specifies whether to enable Amazon ECS managed tags for the task.
For more information, see [Tagging Your Amazon ECS Resources][1] in
the *Amazon Elastic Container Service Developer Guide*.

[1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html
@return [Boolean]

@!attribute [rw] enable_execute_command

Whether or not to enable the execute command functionality for the
containers in this task. If `true`, this enables execute command
functionality on all containers in the task.
@return [Boolean]

@!attribute [rw] group

The name of the task group to associate with the task. The default
value is the family name of the task definition (for example,
`family:my-family-name`).
@return [String]

@!attribute [rw] launch_type

The infrastructure on which to run your standalone task. For more
information, see [Amazon ECS launch types][1] in the *Amazon Elastic
Container Service Developer Guide*.

The `FARGATE` launch type runs your tasks on Fargate On-Demand
infrastructure.

<note markdown="1"> Fargate Spot infrastructure is available for use but a capacity
provider strategy must be used. For more information, see [Fargate
capacity providers][2] in the *Amazon ECS User Guide for Fargate*.

 </note>

The `EC2` launch type runs your tasks on Amazon EC2 instances
registered to your cluster.

The `EXTERNAL` launch type runs your tasks on your on-premise server
or virtual machine (VM) capacity registered to your cluster.

A task can use either a launch type or a capacity provider strategy.
If a `launchType` is specified, the `capacityProviderStrategy`
parameter must be omitted.

When you use cluster auto scaling, you must specify
`capacityProviderStrategy` and not `launchType`.

[1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html
[2]: https://docs.aws.amazon.com/AmazonECS/latest/userguide/fargate-capacity-providers.html
@return [String]

@!attribute [rw] network_configuration

The network configuration for the task. This parameter is required
for task definitions that use the `awsvpc` network mode to receive
their own elastic network interface, and it is not supported for
other network modes. For more information, see [Task networking][1]
in the *Amazon Elastic Container Service Developer Guide*.

[1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html
@return [Types::NetworkConfiguration]

@!attribute [rw] overrides

A list of container overrides in JSON format that specify the name
of a container in the specified task definition and the overrides it
should receive. You can override the default command for a container
(that is specified in the task definition or Docker image) with a
`command` override. You can also override existing environment
variables (that are specified in the task definition or Docker
image) on a container or add new environment variables to it with an
`environment` override.

A total of 8192 characters are allowed for overrides. This limit
includes the JSON formatting characters of the override structure.
@return [Types::TaskOverride]

@!attribute [rw] placement_constraints

An array of placement constraint objects to use for the task. You
can specify up to 10 constraints per task (including constraints in
the task definition and those specified at runtime).
@return [Array<Types::PlacementConstraint>]

@!attribute [rw] placement_strategy

The placement strategy objects to use for the task. You can specify
a maximum of 5 strategy rules per task.
@return [Array<Types::PlacementStrategy>]

@!attribute [rw] platform_version

The platform version the task should use. A platform version is only
specified for tasks hosted on Fargate. If one is not specified, the
`LATEST` platform version is used by default. For more information,
see [Fargate platform versions][1] in the *Amazon Elastic Container
Service Developer Guide*.

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

@!attribute [rw] propagate_tags

Specifies whether to propagate the tags from the task definition to
the task. If no value is specified, the tags are not propagated.
Tags can only be propagated to the task during task creation. To add
tags to a task after task creation, use the TagResource API action.

<note markdown="1"> An error will be received if you specify the `SERVICE` option when
running a task.

 </note>
@return [String]

@!attribute [rw] reference_id

The reference ID to use for the task. The reference ID can have a
maximum length of 1024 characters.
@return [String]

@!attribute [rw] started_by

An optional tag specified when a task is started. For example, if
you automatically trigger a task to run a batch process job, you
could apply a unique identifier for that job to your task with the
`startedBy` parameter. You can then identify which tasks belong to
that job by filtering the results of a ListTasks call with the
`startedBy` value. Up to 36 letters (uppercase and lowercase),
numbers, hyphens, and underscores are allowed.

If a task is started by an Amazon ECS service, then the `startedBy`
parameter contains the deployment ID of the service that starts it.
@return [String]

@!attribute [rw] tags

The metadata that you apply to the task to help you categorize and
organize them. Each tag consists of a key and an optional value,
both of which you define.

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>]

@!attribute [rw] task_definition

The `family` and `revision` (`family:revision`) or full ARN of the
task definition to run. If a `revision` is not specified, the latest
`ACTIVE` revision is used.
@return [String]

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

Constants

SENSITIVE