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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-ecs/types.rb

Overview

Note:

When making an API call, you may pass StartTaskRequest data as a 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
          },
        ],
      },
    ],
    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
    },
  },
  tags: [
    {
      key: "TagKey",
      value: "TagValue",
    },
  ],
  enable_ecs_managed_tags: false,
  propagate_tags: "TASK_DEFINITION", # accepts TASK_DEFINITION, SERVICE
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#cluster ⇒ String

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) 


5974
5975
5976
5977
5978
5979
5980
5981
5982
5983
5984
5985
5986
 
# File 'lib/aws-sdk-ecs/types.rb', line 5974

class StartTaskRequest < Struct.new(
  :cluster,
  :task_definition,
  :overrides,
  :container_instances,
  :started_by,
  :group,
  :network_configuration,
  :tags,
  :enable_ecs_managed_tags,
  :propagate_tags)
  include Aws::Structure
end

#container_instances ⇒ Array<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>) 


5974
5975
5976
5977
5978
5979
5980
5981
5982
5983
5984
5985
5986
 
# File 'lib/aws-sdk-ecs/types.rb', line 5974

class StartTaskRequest < Struct.new(
  :cluster,
  :task_definition,
  :overrides,
  :container_instances,
  :started_by,
  :group,
  :network_configuration,
  :tags,
  :enable_ecs_managed_tags,
  :propagate_tags)
  include Aws::Structure
end

#enable_ecs_managed_tags ⇒ Boolean

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

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

Returns:

  • (Boolean) 


5974
5975
5976
5977
5978
5979
5980
5981
5982
5983
5984
5985
5986
 
# File 'lib/aws-sdk-ecs/types.rb', line 5974

class StartTaskRequest < Struct.new(
  :cluster,
  :task_definition,
  :overrides,
  :container_instances,
  :started_by,
  :group,
  :network_configuration,
  :tags,
  :enable_ecs_managed_tags,
  :propagate_tags)
  include Aws::Structure
end

#group ⇒ String

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) 


5974
5975
5976
5977
5978
5979
5980
5981
5982
5983
5984
5985
5986
 
# File 'lib/aws-sdk-ecs/types.rb', line 5974

class StartTaskRequest < Struct.new(
  :cluster,
  :task_definition,
  :overrides,
  :container_instances,
  :started_by,
  :group,
  :network_configuration,
  :tags,
  :enable_ecs_managed_tags,
  :propagate_tags)
  include Aws::Structure
end

#network_configuration ⇒ Types::NetworkConfiguration

The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the ‘awsvpc` networking mode.

Returns:



5974
5975
5976
5977
5978
5979
5980
5981
5982
5983
5984
5985
5986
 
# File 'lib/aws-sdk-ecs/types.rb', line 5974

class StartTaskRequest < Struct.new(
  :cluster,
  :task_definition,
  :overrides,
  :container_instances,
  :started_by,
  :group,
  :network_configuration,
  :tags,
  :enable_ecs_managed_tags,
  :propagate_tags)
  include Aws::Structure
end

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

<note markdown=“1”> A total of 8192 characters are allowed for overrides. This limit includes the JSON formatting characters of the override structure.

</note>

Returns:



5974
5975
5976
5977
5978
5979
5980
5981
5982
5983
5984
5985
5986
 
# File 'lib/aws-sdk-ecs/types.rb', line 5974

class StartTaskRequest < Struct.new(
  :cluster,
  :task_definition,
  :overrides,
  :container_instances,
  :started_by,
  :group,
  :network_configuration,
  :tags,
  :enable_ecs_managed_tags,
  :propagate_tags)
  include Aws::Structure
end

#propagate_tags ⇒ String

Specifies whether to propagate the tags from the task definition or the service to the task. If no value is specified, the tags are not propagated.

Returns:

  • (String) 


5974
5975
5976
5977
5978
5979
5980
5981
5982
5983
5984
5985
5986
 
# File 'lib/aws-sdk-ecs/types.rb', line 5974

class StartTaskRequest < Struct.new(
  :cluster,
  :task_definition,
  :overrides,
  :container_instances,
  :started_by,
  :group,
  :network_configuration,
  :tags,
  :enable_ecs_managed_tags,
  :propagate_tags)
  include Aws::Structure
end

#started_by ⇒ String

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) 


5974
5975
5976
5977
5978
5979
5980
5981
5982
5983
5984
5985
5986
 
# File 'lib/aws-sdk-ecs/types.rb', line 5974

class StartTaskRequest < Struct.new(
  :cluster,
  :task_definition,
  :overrides,
  :container_instances,
  :started_by,
  :group,
  :network_configuration,
  :tags,
  :enable_ecs_managed_tags,
  :propagate_tags)
  include Aws::Structure
end

#tags ⇒ Array<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. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

Returns:



5974
5975
5976
5977
5978
5979
5980
5981
5982
5983
5984
5985
5986
 
# File 'lib/aws-sdk-ecs/types.rb', line 5974

class StartTaskRequest < Struct.new(
  :cluster,
  :task_definition,
  :overrides,
  :container_instances,
  :started_by,
  :group,
  :network_configuration,
  :tags,
  :enable_ecs_managed_tags,
  :propagate_tags)
  include Aws::Structure
end

#task_definition ⇒ String

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) 


5974
5975
5976
5977
5978
5979
5980
5981
5982
5983
5984
5985
5986
 
# File 'lib/aws-sdk-ecs/types.rb', line 5974

class StartTaskRequest < Struct.new(
  :cluster,
  :task_definition,
  :overrides,
  :container_instances,
  :started_by,
  :group,
  :network_configuration,
  :tags,
  :enable_ecs_managed_tags,
  :propagate_tags)
  include Aws::Structure
end