You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::ECS::Types::RunTaskRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing RunTaskRequest as input to an Aws::Client method, you can use a vanilla Hash:

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

Instance Attribute Summary collapse

Instance Attribute Details

#clusterString

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.

Returns:

  • (String)

    The short name or full Amazon Resource Name (ARN) of the cluster on which to run your task.

#countInteger

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

Returns:

  • (Integer)

    The number of instantiations of the specified task to place on your cluster.

#enable_ecs_managed_tagsBoolean

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

Returns:

  • (Boolean)

    Specifies whether to enable Amazon ECS managed tags for the task.

#groupString

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

Returns:

  • (String)

    The name of the task group to associate with the task.

#launch_typeString

The launch type on which to run your task. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.

Returns:

  • (String)

    The launch type on which to run your task.

#network_configurationTypes::NetworkConfiguration

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

Returns:

#overridesTypes::TaskOverride

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.

Returns:

  • (Types::TaskOverride)

    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.

#placement_constraintsArray<Types::PlacementConstraint>

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

Returns:

#placement_strategyArray<Types::PlacementStrategy>

The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.

Returns:

#platform_versionString

The platform version the task should run. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

Returns:

  • (String)

    The platform version the task should run.

#propagate_tagsString

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.

An error will be received if you specify the SERVICE option when running a task.

Possible values:

  • TASK_DEFINITION
  • SERVICE

Returns:

  • (String)

    Specifies whether to propagate the tags from the task definition to the task.

#started_byString

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.

Returns:

  • (String)

    An optional tag specified when a task is started.

#tagsArray<Types::Tag>

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

Returns:

  • (Array<Types::Tag>)

    The metadata that you apply to the task to help you categorize and organize them.

#task_definitionString

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.

Returns:

  • (String)

    The family and revision (family:revision) or full ARN of the task definition to run.