Synopsis
Calls the Amazon EC2 Container Service RunTask API operation.
Syntax
New-ECSTask-Cluster <String>-AwsvpcConfiguration_AssignPublicIp <AssignPublicIp>-Overrides_ContainerOverride <ContainerOverride[]>-Count <Int32>-EnableECSManagedTag <Boolean>-Overrides_ExecutionRoleArn <String>-Group <String>-LaunchType <LaunchType>-PlacementConstraint <PlacementConstraint[]>-PlacementStrategy <PlacementStrategy[]>-PlatformVersion <String>-PropagateTag <PropagateTags>-AwsvpcConfiguration_SecurityGroup <String[]>-StartedBy <String>-AwsvpcConfiguration_Subnet <String[]>-Tag <Tag[]>-TaskDefinition <String>-Overrides_TaskRoleArn <String>-Force <SwitchParameter>
Description
Starts a new task using the specified task definition.
You can allow Amazon ECS to place tasks for you, or you can customize how Amazon ECS places tasks using placement constraints and placement strategies. For more information, see Scheduling Tasks in the Amazon Elastic Container Service Developer Guide.
Alternatively, you can use StartTask to use your own scheduler or place tasks manually on specific container instances.
The Amazon ECS API follows an eventual consistency model, due to the distributed nature of the system supporting the API. This means that the result of an API command you run that affects your Amazon ECS resources might not be immediately visible to all subsequent commands you run. Keep this in mind when you carry out an API command that immediately follows a previous API command.
To manage eventual consistency, you can do the following:
- Confirm the state of the resource before you run a command to modify it. Run the DescribeTasks command using an exponential backoff algorithm to ensure that you allow enough time for the previous command to propagate through the system. To do this, run the DescribeTasks command repeatedly, starting with a couple of seconds of wait time and increasing gradually up to five minutes of wait time.
- Add wait time between subsequent commands, even if the DescribeTasks command returns an accurate response. Apply an exponential backoff algorithm starting with a couple of seconds of wait time, and increase gradually up to about five minutes of wait time.
Parameters
-AwsvpcConfiguration_AssignPublicIp <AssignPublicIp>
Whether the task's elastic network interface receives a public IP address. The default value is
DISABLED. | Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-AwsvpcConfiguration_SecurityGroup <String[]>
The security groups associated with the task or service. If you do not specify a security group, the default security group for the VPC is used. There is a limit of five security groups able to be specified per
AwsVpcConfiguration.All specified security groups must be from the same VPC. | Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-AwsvpcConfiguration_Subnet <String[]>
The subnets associated with the task or service. There is a limit of 16 subnets able to be specified per
AwsVpcConfiguration.All specified subnets must be from the same VPC. | Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-Cluster <String>
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.
| Required? | False |
| Position? | 1 |
| Accept pipeline input? | True (ByValue, ) |
-Count <Int32>
The number of instantiations of the specified task to place on your cluster. You can specify up to 10 tasks per call.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-EnableECSManagedTag <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.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-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).
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-LaunchType <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.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-Overrides_ContainerOverride <ContainerOverride[]>
One or more container overrides sent to a task.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-Overrides_ExecutionRoleArn <String>
The Amazon Resource Name (ARN) of the task execution role that the Amazon ECS container agent and the Docker daemon can assume.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-Overrides_TaskRoleArn <String>
The Amazon Resource Name (ARN) of the IAM role that containers in this task can assume. All containers in this task are granted the permissions that are specified in this role.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-PlacementConstraint <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 runtime).
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-PlacementStrategy <PlacementStrategy[]>
The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-PlatformVersion <String>
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. | Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-PropagateTag <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. | Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-StartedBy <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. | Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-Tag <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.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-TaskDefinition <String>
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. | Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
Common Credential and Region Parameters
-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key
if the corresponding session token is supplied to the -SessionToken parameter.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information,
and optionally a token for session-based credentials.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)
If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials. Note that the encrypted credential file is not supported on all platforms. It will be skipped when searching for profiles on Windows Nano Server, Mac, and Linux platforms.
If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.
As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing
credential information. The profile is expected to be found in the secure credential
file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also
specify the name of a profile stored in the .ini-format credential file used with
the AWS CLI and other AWS SDKs.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile.
Contains the network credentials to be supplied during authentication with the
configured identity provider's endpoint. This parameter is not required if the
user's default network identity can or should be used during authentication.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key
if the corresponding session token is supplied to the -SessionToken parameter.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-SessionToken <String>
The session token if the access and secret keys are temporary session-based
credentials.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-Region <String>
The system name of the AWS region in which the operation should be invoked. For example, us-east-1, eu-west-1 etc.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-EndpointUrl <String>
The endpoint to make the call against.
Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
Inputs
You can pipe a String object to this cmdlet for the Cluster parameter.
Outputs
This cmdlet returns a Amazon.ECS.Model.RunTaskResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
Related Links
Supported Version
AWS Tools for PowerShell: 2.x.y.z
