Whether the task's elastic network interface receives a public IP address. The default value is DISABLED
.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | NetworkConfiguration_AwsvpcConfiguration_AssignPublicIp |
-AwsvpcConfiguration_SecurityGroup <
String[]>
The IDs of the security groups associated with the task or service. If you don't specify a security group, the default security group for the VPC is used. There's a limit of 5 security groups that can be specified per AwsVpcConfiguration
.All specified security groups must be from the same VPC.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | NetworkConfiguration_AwsvpcConfiguration_SecurityGroups |
The IDs of the subnets associated with the task or service. There's a limit of 16 subnets that can be specified per AwsVpcConfiguration
.All specified subnets must be from the same VPC.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | NetworkConfiguration_AwsvpcConfiguration_Subnets |
The short name or full Amazon Resource Name (ARN) of the cluster where to start your task. If you do not specify a cluster, the default cluster is assumed.
Required? | False |
Position? | 1 |
Accept pipeline input? | True (ByValue, ByPropertyName) |
The container instance IDs or full ARN entries for the container instances where you would like to place your task. You can specify up to 10 container instances.
Required? | True |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | ContainerInstances |
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.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | EnableECSManagedTags |
Whether or not the execute command functionality is enabled for the task. If true
, this enables execute command functionality on all containers in the task.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
-EphemeralStorage_SizeInGiB <
Int32>
The total amount, in GiB, of ephemeral storage to set for the task. The minimum supported value is 21
GiB and the maximum supported value is 200
GiB.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | Overrides_EphemeralStorage_SizeInGiB |
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? | True (ByPropertyName) |
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? | True (ByPropertyName) |
One or more container overrides that are sent to a task.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | Overrides_ContainerOverrides |
The cpu override for the task.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
-Overrides_ExecutionRoleArn <
String>
The Amazon Resource Name (ARN) of the task execution IAM role override for the task. For more information, see
Amazon ECS task execution IAM role in the
Amazon Elastic Container Service Developer Guide.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
The Elastic Inference accelerator override for the task.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | Overrides_InferenceAcceleratorOverrides |
The memory override for the task.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
-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. For more information, see
IAM Role for Tasks in the
Amazon Elastic Container Service Developer Guide.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Changes the cmdlet behavior to return the value passed to the Cluster parameter. The -PassThru parameter is deprecated, use -Select '^Cluster' instead. This parameter will be removed in a future version.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Specifies whether to propagate the tags from the task definition or the service to the task. If no value is specified, the tags aren't propagated.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | PropagateTags |
The reference ID to use for the task.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ECS.Model.StartTaskResponse). Specifying the name of a property of type Amazon.ECS.Model.StartTaskResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
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, the
startedBy
parameter contains the deployment ID of the service that starts it.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
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.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | Tags |
The family
and revision
(family:revision
) or full ARN of the task definition to start. If a revision
isn't specified, the latest ACTIVE
revision is used.
Required? | True |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |