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

Inherits:

Struct

Object
Struct
Aws::ECS::Types::RunTaskRequest

show all

Includes:: Structure

Defined in:: lib/aws-sdk-ecs/types.rb

Overview

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#capacity_provider_strategy ⇒ Array<Types::CapacityProviderStrategyItem>

The capacity provider strategy to use for the task.
#client_token ⇒ String

An identifier that you provide to ensure the idempotency of the request.
#cluster ⇒ String

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

The number of instantiations of the specified task to place on your cluster.
#enable_ecs_managed_tags ⇒ Boolean

Specifies whether to use Amazon ECS managed tags for the task.
#enable_execute_command ⇒ Boolean

Determines whether to use the execute command functionality for the containers in this task.
#group ⇒ String

The name of the task group to associate with the task.
#launch_type ⇒ String

The infrastructure to run your standalone task on.
#network_configuration ⇒ Types::NetworkConfiguration

The network configuration for the task.
#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.
#placement_constraints ⇒ Array<Types::PlacementConstraint>

An array of placement constraint objects to use for the task.
#placement_strategy ⇒ Array<Types::PlacementStrategy>

The placement strategy objects to use for the task.
#platform_version ⇒ String

The platform version the task uses.
#propagate_tags ⇒ String

Specifies whether to propagate the tags from the task definition to the task.
#reference_id ⇒ String

This parameter is only used by Amazon ECS.
#started_by ⇒ String

An optional tag specified when a task is started.
#tags ⇒ Array<Types::Tag>

The metadata that you apply to the task to help you categorize and organize them.
#task_definition ⇒ String

The ‘family` and `revision` (`family:revision`) or full ARN of the task definition to run.
#volume_configurations ⇒ Array<Types::TaskVolumeConfiguration>

The details of the volume that was ‘configuredAtLaunch`.

Instance Attribute Details

#capacity_provider_strategy ⇒ `Array<Types::CapacityProviderStrategyItem>`

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.

Returns:

(Array<Types::CapacityProviderStrategyItem>)

# File 'lib/aws-sdk-ecs/types.rb', line 9106

class RunTaskRequest < Struct.new(
  :capacity_provider_strategy,
  :cluster,
  :count,
  :enable_ecs_managed_tags,
  :enable_execute_command,
  :group,
  :launch_type,
  :network_configuration,
  :overrides,
  :placement_constraints,
  :placement_strategy,
  :platform_version,
  :propagate_tags,
  :reference_id,
  :started_by,
  :tags,
  :task_definition,
  :client_token,
  :volume_configurations)
  SENSITIVE = []
  include Aws::Structure
end

#client_token ⇒ `String`

An identifier that you provide to ensure the idempotency of the request. It must be unique and is case sensitive. Up to 64 characters are allowed. The valid characters are characters in the range of 33-126, inclusive. For more information, see [Ensuring idempotency].

**A suitable default value is auto-generated.** You should normally not need to pass this option.

[1]: docs.aws.amazon.com/AmazonECS/latest/APIReference/ECS_Idempotency.html

Returns:

(String)

# File 'lib/aws-sdk-ecs/types.rb', line 9106

class RunTaskRequest < Struct.new(
  :capacity_provider_strategy,
  :cluster,
  :count,
  :enable_ecs_managed_tags,
  :enable_execute_command,
  :group,
  :launch_type,
  :network_configuration,
  :overrides,
  :placement_constraints,
  :placement_strategy,
  :platform_version,
  :propagate_tags,
  :reference_id,
  :started_by,
  :tags,
  :task_definition,
  :client_token,
  :volume_configurations)
  SENSITIVE = []
  include Aws::Structure
end

#cluster ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-ecs/types.rb', line 9106

class RunTaskRequest < Struct.new(
  :capacity_provider_strategy,
  :cluster,
  :count,
  :enable_ecs_managed_tags,
  :enable_execute_command,
  :group,
  :launch_type,
  :network_configuration,
  :overrides,
  :placement_constraints,
  :placement_strategy,
  :platform_version,
  :propagate_tags,
  :reference_id,
  :started_by,
  :tags,
  :task_definition,
  :client_token,
  :volume_configurations)
  SENSITIVE = []
  include Aws::Structure
end

#count ⇒ `Integer`

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

Returns:

(Integer)

# File 'lib/aws-sdk-ecs/types.rb', line 9106

class RunTaskRequest < Struct.new(
  :capacity_provider_strategy,
  :cluster,
  :count,
  :enable_ecs_managed_tags,
  :enable_execute_command,
  :group,
  :launch_type,
  :network_configuration,
  :overrides,
  :placement_constraints,
  :placement_strategy,
  :platform_version,
  :propagate_tags,
  :reference_id,
  :started_by,
  :tags,
  :task_definition,
  :client_token,
  :volume_configurations)
  SENSITIVE = []
  include Aws::Structure
end

#enable_ecs_managed_tags ⇒ `Boolean`

Specifies whether to use 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)

# File 'lib/aws-sdk-ecs/types.rb', line 9106

class RunTaskRequest < Struct.new(
  :capacity_provider_strategy,
  :cluster,
  :count,
  :enable_ecs_managed_tags,
  :enable_execute_command,
  :group,
  :launch_type,
  :network_configuration,
  :overrides,
  :placement_constraints,
  :placement_strategy,
  :platform_version,
  :propagate_tags,
  :reference_id,
  :started_by,
  :tags,
  :task_definition,
  :client_token,
  :volume_configurations)
  SENSITIVE = []
  include Aws::Structure
end

#enable_execute_command ⇒ `Boolean`

Determines whether to use the execute command functionality for the containers in this task. If ‘true`, this enables execute command functionality on all containers in the task.

If ‘true`, then the task definition must have a task role, or you must provide one as an override.

Returns:

(Boolean)

# File 'lib/aws-sdk-ecs/types.rb', line 9106

class RunTaskRequest < Struct.new(
  :capacity_provider_strategy,
  :cluster,
  :count,
  :enable_ecs_managed_tags,
  :enable_execute_command,
  :group,
  :launch_type,
  :network_configuration,
  :overrides,
  :placement_constraints,
  :placement_strategy,
  :platform_version,
  :propagate_tags,
  :reference_id,
  :started_by,
  :tags,
  :task_definition,
  :client_token,
  :volume_configurations)
  SENSITIVE = []
  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)

# File 'lib/aws-sdk-ecs/types.rb', line 9106

class RunTaskRequest < Struct.new(
  :capacity_provider_strategy,
  :cluster,
  :count,
  :enable_ecs_managed_tags,
  :enable_execute_command,
  :group,
  :launch_type,
  :network_configuration,
  :overrides,
  :placement_constraints,
  :placement_strategy,
  :platform_version,
  :propagate_tags,
  :reference_id,
  :started_by,
  :tags,
  :task_definition,
  :client_token,
  :volume_configurations)
  SENSITIVE = []
  include Aws::Structure
end

#launch_type ⇒ `String`

The infrastructure to run your standalone task on. For more information, see [Amazon ECS launch types] 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] in the *Amazon ECS Developer Guide*.

</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-premises 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]: docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html [2]: docs.aws.amazon.com/AmazonECS/latest/developerguide/fargate-capacity-providers.html

Returns:

(String)

# File 'lib/aws-sdk-ecs/types.rb', line 9106

class RunTaskRequest < Struct.new(
  :capacity_provider_strategy,
  :cluster,
  :count,
  :enable_ecs_managed_tags,
  :enable_execute_command,
  :group,
  :launch_type,
  :network_configuration,
  :overrides,
  :placement_constraints,
  :placement_strategy,
  :platform_version,
  :propagate_tags,
  :reference_id,
  :started_by,
  :tags,
  :task_definition,
  :client_token,
  :volume_configurations)
  SENSITIVE = []
  include Aws::Structure
end

#network_configuration ⇒ `Types::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 isn’t supported for other network modes. For more information, see [Task networking] in the *Amazon Elastic Container Service Developer Guide*.

[1]: docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html

Returns:

(Types::NetworkConfiguration)

# File 'lib/aws-sdk-ecs/types.rb', line 9106

class RunTaskRequest < Struct.new(
  :capacity_provider_strategy,
  :cluster,
  :count,
  :enable_ecs_managed_tags,
  :enable_execute_command,
  :group,
  :launch_type,
  :network_configuration,
  :overrides,
  :placement_constraints,
  :placement_strategy,
  :platform_version,
  :propagate_tags,
  :reference_id,
  :started_by,
  :tags,
  :task_definition,
  :client_token,
  :volume_configurations)
  SENSITIVE = []
  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’s 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)

# File 'lib/aws-sdk-ecs/types.rb', line 9106

class RunTaskRequest < Struct.new(
  :capacity_provider_strategy,
  :cluster,
  :count,
  :enable_ecs_managed_tags,
  :enable_execute_command,
  :group,
  :launch_type,
  :network_configuration,
  :overrides,
  :placement_constraints,
  :placement_strategy,
  :platform_version,
  :propagate_tags,
  :reference_id,
  :started_by,
  :tags,
  :task_definition,
  :client_token,
  :volume_configurations)
  SENSITIVE = []
  include Aws::Structure
end

#placement_constraints ⇒ `Array<Types::PlacementConstraint>`

An array of placement constraint objects to use for the task. You can specify up to 10 constraints for each task (including constraints in the task definition and those specified at runtime).

Returns:

(Array<Types::PlacementConstraint>)

# File 'lib/aws-sdk-ecs/types.rb', line 9106

class RunTaskRequest < Struct.new(
  :capacity_provider_strategy,
  :cluster,
  :count,
  :enable_ecs_managed_tags,
  :enable_execute_command,
  :group,
  :launch_type,
  :network_configuration,
  :overrides,
  :placement_constraints,
  :placement_strategy,
  :platform_version,
  :propagate_tags,
  :reference_id,
  :started_by,
  :tags,
  :task_definition,
  :client_token,
  :volume_configurations)
  SENSITIVE = []
  include Aws::Structure
end

#placement_strategy ⇒ `Array<Types::PlacementStrategy>`

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

Returns:

(Array<Types::PlacementStrategy>)

# File 'lib/aws-sdk-ecs/types.rb', line 9106

class RunTaskRequest < Struct.new(
  :capacity_provider_strategy,
  :cluster,
  :count,
  :enable_ecs_managed_tags,
  :enable_execute_command,
  :group,
  :launch_type,
  :network_configuration,
  :overrides,
  :placement_constraints,
  :placement_strategy,
  :platform_version,
  :propagate_tags,
  :reference_id,
  :started_by,
  :tags,
  :task_definition,
  :client_token,
  :volume_configurations)
  SENSITIVE = []
  include Aws::Structure
end

#platform_version ⇒ `String`

The platform version the task uses. A platform version is only specified for tasks hosted on Fargate. If one isn’t specified, the ‘LATEST` platform version is used. For more information, see

Fargate platform versions][1: in the *Amazon Elastic Container

Service Developer Guide*.

[1]: docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html

Returns:

(String)

# File 'lib/aws-sdk-ecs/types.rb', line 9106

class RunTaskRequest < Struct.new(
  :capacity_provider_strategy,
  :cluster,
  :count,
  :enable_ecs_managed_tags,
  :enable_execute_command,
  :group,
  :launch_type,
  :network_configuration,
  :overrides,
  :placement_constraints,
  :placement_strategy,
  :platform_version,
  :propagate_tags,
  :reference_id,
  :started_by,
  :tags,
  :task_definition,
  :client_token,
  :volume_configurations)
  SENSITIVE = []
  include Aws::Structure
end

#propagate_tags ⇒ `String`

Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags aren’t propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use the[1] API action.

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

</note>

[1]: docs.aws.amazon.com/AmazonECS/latest/APIReference/API_TagResource.html

Returns:

(String)

# File 'lib/aws-sdk-ecs/types.rb', line 9106

class RunTaskRequest < Struct.new(
  :capacity_provider_strategy,
  :cluster,
  :count,
  :enable_ecs_managed_tags,
  :enable_execute_command,
  :group,
  :launch_type,
  :network_configuration,
  :overrides,
  :placement_constraints,
  :placement_strategy,
  :platform_version,
  :propagate_tags,
  :reference_id,
  :started_by,
  :tags,
  :task_definition,
  :client_token,
  :volume_configurations)
  SENSITIVE = []
  include Aws::Structure
end

#reference_id ⇒ `String`

This parameter is only used by Amazon ECS. It is not intended for use by customers.

Returns:

(String)

# File 'lib/aws-sdk-ecs/types.rb', line 9106

class RunTaskRequest < Struct.new(
  :capacity_provider_strategy,
  :cluster,
  :count,
  :enable_ecs_managed_tags,
  :enable_execute_command,
  :group,
  :launch_type,
  :network_configuration,
  :overrides,
  :placement_constraints,
  :placement_strategy,
  :platform_version,
  :propagate_tags,
  :reference_id,
  :started_by,
  :tags,
  :task_definition,
  :client_token,
  :volume_configurations)
  SENSITIVE = []
  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 128 letters (uppercase and lowercase), numbers, hyphens (-), forward slash (/), 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.

[1]: docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListTasks.html

Returns:

(String)

# File 'lib/aws-sdk-ecs/types.rb', line 9106

class RunTaskRequest < Struct.new(
  :capacity_provider_strategy,
  :cluster,
  :count,
  :enable_ecs_managed_tags,
  :enable_execute_command,
  :group,
  :launch_type,
  :network_configuration,
  :overrides,
  :placement_constraints,
  :placement_strategy,
  :platform_version,
  :propagate_tags,
  :reference_id,
  :started_by,
  :tags,
  :task_definition,
  :client_token,
  :volume_configurations)
  SENSITIVE = []
  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.

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.

Returns:

(Array<Types::Tag>)

# File 'lib/aws-sdk-ecs/types.rb', line 9106

class RunTaskRequest < Struct.new(
  :capacity_provider_strategy,
  :cluster,
  :count,
  :enable_ecs_managed_tags,
  :enable_execute_command,
  :group,
  :launch_type,
  :network_configuration,
  :overrides,
  :placement_constraints,
  :placement_strategy,
  :platform_version,
  :propagate_tags,
  :reference_id,
  :started_by,
  :tags,
  :task_definition,
  :client_token,
  :volume_configurations)
  SENSITIVE = []
  include Aws::Structure
end

#task_definition ⇒ `String`

The ‘family` and `revision` (`family:revision`) or full ARN of the task definition to run. If a `revision` isn’t specified, the latest ‘ACTIVE` revision is used.

The full ARN value must match the value that you specified as the ‘Resource` of the principal’s permissions policy.

When you specify a task definition, you must either specify a specific revision, or all revisions in the ARN.

To specify a specific revision, include the revision number in the ARN. For example, to specify revision 2, use ‘arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:2`.

To specify all revisions, use the wildcard (*) in the ARN. For example, to specify all revisions, use ‘arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:*`.

For more information, see [Policy Resources for Amazon ECS] in the Amazon Elastic Container Service Developer Guide.

[1]: docs.aws.amazon.com/AmazonECS/latest/developerguide/security_iam_service-with-iam.html#security_iam_service-with-iam-id-based-policies-resources

Returns:

(String)

# File 'lib/aws-sdk-ecs/types.rb', line 9106

class RunTaskRequest < Struct.new(
  :capacity_provider_strategy,
  :cluster,
  :count,
  :enable_ecs_managed_tags,
  :enable_execute_command,
  :group,
  :launch_type,
  :network_configuration,
  :overrides,
  :placement_constraints,
  :placement_strategy,
  :platform_version,
  :propagate_tags,
  :reference_id,
  :started_by,
  :tags,
  :task_definition,
  :client_token,
  :volume_configurations)
  SENSITIVE = []
  include Aws::Structure
end

#volume_configurations ⇒ `Array<Types::TaskVolumeConfiguration>`

The details of the volume that was ‘configuredAtLaunch`. You can configure the size, volumeType, IOPS, throughput, snapshot and encryption in in [TaskManagedEBSVolumeConfiguration]. The `name` of the volume must match the `name` from the task definition.

[1]: docs.aws.amazon.com/AmazonECS/latest/APIReference/API_TaskManagedEBSVolumeConfiguration.html

Returns:

(Array<Types::TaskVolumeConfiguration>)

# File 'lib/aws-sdk-ecs/types.rb', line 9106

class RunTaskRequest < Struct.new(
  :capacity_provider_strategy,
  :cluster,
  :count,
  :enable_ecs_managed_tags,
  :enable_execute_command,
  :group,
  :launch_type,
  :network_configuration,
  :overrides,
  :placement_constraints,
  :placement_strategy,
  :platform_version,
  :propagate_tags,
  :reference_id,
  :started_by,
  :tags,
  :task_definition,
  :client_token,
  :volume_configurations)
  SENSITIVE = []
  include Aws::Structure
end

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

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#capacity_provider_strategy ⇒ Array<Types::CapacityProviderStrategyItem>

#client_token ⇒ String

#cluster ⇒ String

#count ⇒ Integer

#enable_ecs_managed_tags ⇒ Boolean

#enable_execute_command ⇒ Boolean

#group ⇒ String

#launch_type ⇒ String

#network_configuration ⇒ Types::NetworkConfiguration

#overrides ⇒ Types::TaskOverride

#placement_constraints ⇒ Array<Types::PlacementConstraint>

#placement_strategy ⇒ Array<Types::PlacementStrategy>

#platform_version ⇒ String

#propagate_tags ⇒ String

#reference_id ⇒ String

#started_by ⇒ String

#tags ⇒ Array<Types::Tag>

#task_definition ⇒ String

#volume_configurations ⇒ Array<Types::TaskVolumeConfiguration>

#capacity_provider_strategy ⇒ `Array<Types::CapacityProviderStrategyItem>`

#client_token ⇒ `String`

#cluster ⇒ `String`

#count ⇒ `Integer`

#enable_ecs_managed_tags ⇒ `Boolean`

#enable_execute_command ⇒ `Boolean`

#group ⇒ `String`

#launch_type ⇒ `String`

#network_configuration ⇒ `Types::NetworkConfiguration`

#overrides ⇒ `Types::TaskOverride`

#placement_constraints ⇒ `Array<Types::PlacementConstraint>`

#placement_strategy ⇒ `Array<Types::PlacementStrategy>`

#platform_version ⇒ `String`

#propagate_tags ⇒ `String`

#reference_id ⇒ `String`

#started_by ⇒ `String`

#tags ⇒ `Array<Types::Tag>`

#task_definition ⇒ `String`

#volume_configurations ⇒ `Array<Types::TaskVolumeConfiguration>`