ecs_run_task {aws.ecx} | R Documentation |
Run Task
Description
Run Task
Usage
ecs_run_task(
capacityProviderStrategy = NULL,
cluster = NULL,
count = NULL,
enableECSManagedTags = NULL,
group = NULL,
launchType = NULL,
networkConfiguration = NULL,
overrides = NULL,
placementConstraints = NULL,
placementStrategy = NULL,
platformVersion = NULL,
propagateTags = NULL,
referenceId = NULL,
startedBy = NULL,
tags = NULL,
taskDefinition = NULL,
simplify = TRUE,
others = list(),
print_on_error = aws_get_print_on_error(),
retry_time = aws_get_retry_time(),
network_timeout = aws_get_network_timeout(),
region = aws_get_region()
)
Arguments
capacityProviderStrategy |
List. The capacity provider strategy to use for the task. |
cluster |
Character. The short name or full Amazon Resource Name (ARN) of the cluster on which to run your task. |
count |
Integer. The number of instantiations of the specified task to place on your cluster. |
enableECSManagedTags |
Logical. Specifies whether to enable Amazon ECS managed tags for the task. |
group |
Character. The name of the task group to associate with the task. |
launchType |
Character. The launch type on which to run your task. |
networkConfiguration |
Object. The network configuration for the task. |
overrides |
Object. A list of container overrides in JSON format that specify the name of a container in the specified... |
placementConstraints |
List. An array of placement constraint objects to use for the task. |
placementStrategy |
List. The placement strategy objects to use for the task. |
platformVersion |
Character. The platform version the task should run. |
propagateTags |
Character. Specifies whether to propagate the tags from the task definition to the task. |
referenceId |
Character. The reference ID to use for the task. |
startedBy |
Character. An optional tag specified when a task is started. |
tags |
List. The metadata that you apply to the task to help you categorize and organize them. |
taskDefinition |
Character. The |
simplify |
Logical. Whether to simplify the result and handle |
others |
Named list. The parameters that are not included in the function parameters and need to be added into the request[optional] |
print_on_error |
Logical. Whether to show an error message when a network error occurs. |
retry_time |
Integer. Number of retries for a REST request when encounter the
network issue. If the request has been sent |
network_timeout |
Numeric. Number of seconds to wait for a REST response until giving up. Can not be less than 1 ms. |
region |
Character. The region of the AWS service. |
Value
A list object or a character vector
capacityProviderStrategy
The capacity provider strategy to use for the task.
A capacity provider strategy consists of one or more capacity providers
along with the base
and weight
to assign to them. A capacity
provider must be associated with the cluster to be used in a capacity
provider strategy. The PutClusterCapacityProviders API is used to
associate a capacity provider with a cluster. Only capacity providers
with an ACTIVE
or UPDATING
status can be used.
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.
If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.
To use a AWS Fargate capacity provider, specify either the FARGATE
or
FARGATE_SPOT
capacity providers. The AWS Fargate capacity providers
are available to all accounts and only need to be associated with a
cluster to be used.
The PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created.
cluster
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.
count
The number of instantiations of the specified task to place on your cluster. You can specify up to 10 tasks per call.
enableECSManagedTags
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.
group
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).
launchType
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.
If a launchType
is specified, the capacityProviderStrategy
parameter
must be omitted.
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.
overrides
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.
placementConstraints
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).
placementStrategy
The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.
platformVersion
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.
propagateTags
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.
referenceId
The reference ID to use for the task.
startedBy
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.
tags
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.
taskDefinition
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.