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

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

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

Overview

Note:

When making an API call, you may pass RunTaskRequest 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,
      },
    ],
    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
    },
  },
}

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)


3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 3989

class RunTaskRequest < Struct.new(
  :cluster,
  :task_definition,
  :overrides,
  :count,
  :started_by,
  :group,
  :placement_constraints,
  :placement_strategy,
  :launch_type,
  :platform_version,
  :network_configuration)
  include Aws::Structure
end

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


3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 3989

class RunTaskRequest < Struct.new(
  :cluster,
  :task_definition,
  :overrides,
  :count,
  :started_by,
  :group,
  :placement_constraints,
  :placement_strategy,
  :launch_type,
  :platform_version,
  :network_configuration)
  include Aws::Structure
end

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


3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 3989

class RunTaskRequest < Struct.new(
  :cluster,
  :task_definition,
  :overrides,
  :count,
  :started_by,
  :group,
  :placement_constraints,
  :placement_strategy,
  :launch_type,
  :platform_version,
  :network_configuration)
  include Aws::Structure
end

#launch_typeString

The launch type on which to run your task.

Returns:

  • (String)


3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 3989

class RunTaskRequest < Struct.new(
  :cluster,
  :task_definition,
  :overrides,
  :count,
  :started_by,
  :group,
  :placement_constraints,
  :placement_strategy,
  :launch_type,
  :platform_version,
  :network_configuration)
  include Aws::Structure
end

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



3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 3989

class RunTaskRequest < Struct.new(
  :cluster,
  :task_definition,
  :overrides,
  :count,
  :started_by,
  :group,
  :placement_constraints,
  :placement_strategy,
  :launch_type,
  :platform_version,
  :network_configuration)
  include Aws::Structure
end

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



3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 3989

class RunTaskRequest < Struct.new(
  :cluster,
  :task_definition,
  :overrides,
  :count,
  :started_by,
  :group,
  :placement_constraints,
  :placement_strategy,
  :launch_type,
  :platform_version,
  :network_configuration)
  include Aws::Structure
end

#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 run time).

Returns:



3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 3989

class RunTaskRequest < Struct.new(
  :cluster,
  :task_definition,
  :overrides,
  :count,
  :started_by,
  :group,
  :placement_constraints,
  :placement_strategy,
  :launch_type,
  :platform_version,
  :network_configuration)
  include Aws::Structure
end

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



3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 3989

class RunTaskRequest < Struct.new(
  :cluster,
  :task_definition,
  :overrides,
  :count,
  :started_by,
  :group,
  :placement_constraints,
  :placement_strategy,
  :launch_type,
  :platform_version,
  :network_configuration)
  include Aws::Structure
end

#platform_versionString

The platform version on which to run your task. If one is not specified, the latest version is used by default.

Returns:

  • (String)


3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 3989

class RunTaskRequest < Struct.new(
  :cluster,
  :task_definition,
  :overrides,
  :count,
  :started_by,
  :group,
  :placement_constraints,
  :placement_strategy,
  :launch_type,
  :platform_version,
  :network_configuration)
  include Aws::Structure
end

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


3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 3989

class RunTaskRequest < Struct.new(
  :cluster,
  :task_definition,
  :overrides,
  :count,
  :started_by,
  :group,
  :placement_constraints,
  :placement_strategy,
  :launch_type,
  :platform_version,
  :network_configuration)
  include Aws::Structure
end

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


3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 3989

class RunTaskRequest < Struct.new(
  :cluster,
  :task_definition,
  :overrides,
  :count,
  :started_by,
  :group,
  :placement_constraints,
  :placement_strategy,
  :launch_type,
  :platform_version,
  :network_configuration)
  include Aws::Structure
end