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

Class: Aws::ECS::Types::StartTaskRequest

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

Overview

Note:

When passing StartTaskRequest 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,
      },
    ],
    task_role_arn: "String",
    execution_role_arn: "String",
  },
  container_instances: ["String"], # required
  started_by: "String",
  group: "String",
  network_configuration: {
    awsvpc_configuration: {
      subnets: ["String"], # required
      security_groups: ["String"],
      assign_public_ip: "ENABLED", # accepts ENABLED, DISABLED
    },
  },
}

Instance Attribute Summary collapse

Instance Attribute Details

#clusterString

The short name or full Amazon Resource Name (ARN) of the cluster on which to start 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 start your task.

#container_instancesArray<String>

The container instance IDs or full ARN entries for the container instances on which you would like to place your task. You can specify up to 10 container instances.

Returns:

  • (Array<String>)

    The container instance IDs or full ARN entries for the container instances on which you would like to place your 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.

#network_configurationTypes::NetworkConfiguration

The VPC subnet and security group configuration for tasks that receive their own Elastic Network Interface by using the awsvpc networking mode.

Returns:

  • (Types::NetworkConfiguration)

    The VPC subnet and security group configuration for tasks that receive their own Elastic Network Interface by using the awsvpc networking mode.

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

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

#task_definitionString

The family and revision (family:revision) or full ARN of the task definition to start. 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 start.