AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
New-ECSTask-Cluster <String>-AwsvpcConfiguration_AssignPublicIp <AssignPublicIp>-CapacityProviderStrategy <CapacityProviderStrategyItem[]>-Overrides_ContainerOverride <ContainerOverride[]>-Count <Int32>-Overrides_Cpu <String>-EnableECSManagedTag <Boolean>-EnableExecuteCommand <Boolean>-Overrides_ExecutionRoleArn <String>-Group <String>-Overrides_InferenceAcceleratorOverride <InferenceAcceleratorOverride[]>-LaunchType <LaunchType>-Overrides_Memory <String>-PlacementConstraint <PlacementConstraint[]>-PlacementStrategy <PlacementStrategy[]>-PlatformVersion <String>-PropagateTag <PropagateTags>-ReferenceId <String>-AwsvpcConfiguration_SecurityGroup <String[]>-EphemeralStorage_SizeInGiB <Int32>-StartedBy <String>-AwsvpcConfiguration_Subnet <String[]>-Tag <Tag[]>-TaskDefinition <String>-Overrides_TaskRoleArn <String>-Select <String>-PassThru <SwitchParameter>-Force <SwitchParameter>
DISABLED
. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | NetworkConfiguration_AwsvpcConfiguration_AssignPublicIp |
AwsVpcConfiguration
.All specified security groups must be from the same VPC. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | NetworkConfiguration_AwsvpcConfiguration_SecurityGroups |
AwsVpcConfiguration
.All specified subnets must be from the same VPC. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | NetworkConfiguration_AwsvpcConfiguration_Subnets |
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. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | 1 |
Accept pipeline input? | True (ByValue, ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | EnableECSManagedTags |
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. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
21
GiB and the maximum supported value is 200
GiB. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | Overrides_EphemeralStorage_SizeInGiB |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
family:my-family-name
). Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
FARGATE
launch type runs your tasks on Fargate On-Demand infrastructure.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 User Guide for Fargate.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
. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | Overrides_ContainerOverrides |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | Overrides_InferenceAcceleratorOverrides |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | PlacementConstraints |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
LATEST
platform version is used. For more information, see Fargate platform versions in the Amazon Elastic Container Service Developer Guide. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
SERVICE
option when running a task. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | PropagateTags |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
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? | True (ByPropertyName) |
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 |
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.When you create an IAM policy for run-task, you can set the resource to be the latest task definition revision, or a specific revision.The full ARN value must match the value that you specified as the Resource
of the IAM principal's permissions policy.When you specify the policy resource as the latest task definition version (by setting the Resource
in the policy to arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName
), then set this value to arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName
.When you specify the policy resource as a specific task definition version (by setting the Resource
in the policy to arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:1
or arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:*
), then set this value to arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:1
.For more information, see Policy Resources for Amazon ECS in the Amazon Elastic Container Service developer Guide. Required? | True |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | AK |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByValue, ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByValue, ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | AWSProfilesLocation, ProfilesLocation |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | StoredCredentials, AWSProfileName |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | RegionToCall |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | SK, SecretAccessKey |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | ST |
AWS Tools for PowerShell: 2.x.y.z