This is the new AWS CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.
AWS::Pipes::Pipe PipeTargetEcsTaskParameters
The parameters for using an Amazon ECS task as a target.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "CapacityProviderStrategy" :[ CapacityProviderStrategyItem, ... ], "EnableECSManagedTags" :Boolean, "EnableExecuteCommand" :Boolean, "Group" :String, "LaunchType" :String, "NetworkConfiguration" :NetworkConfiguration, "Overrides" :EcsTaskOverride, "PlacementConstraints" :[ PlacementConstraint, ... ], "PlacementStrategy" :[ PlacementStrategy, ... ], "PlatformVersion" :String, "PropagateTags" :String, "ReferenceId" :String, "Tags" :[ Tag, ... ], "TaskCount" :Integer, "TaskDefinitionArn" :String}
YAML
CapacityProviderStrategy:- CapacityProviderStrategyItemEnableECSManagedTags:BooleanEnableExecuteCommand:BooleanGroup:StringLaunchType:StringNetworkConfiguration:NetworkConfigurationOverrides:EcsTaskOverridePlacementConstraints:- PlacementConstraintPlacementStrategy:- PlacementStrategyPlatformVersion:StringPropagateTags:StringReferenceId:StringTags:- TagTaskCount:IntegerTaskDefinitionArn:String
Properties
CapacityProviderStrategy-
The capacity provider strategy to use for the task.
If a
capacityProviderStrategyis specified, thelaunchTypeparameter must be omitted. If nocapacityProviderStrategyor launchType is specified, thedefaultCapacityProviderStrategyfor the cluster is used.Required: No
Type: Array of CapacityProviderStrategyItem
Minimum:
0Maximum:
6Update requires: No interruption
-
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: No
Type: Boolean
Update requires: No interruption
EnableExecuteCommand-
Whether or not to enable the execute command functionality for the containers in this task. If true, this enables execute command functionality on all containers in the task.
Required: No
Type: Boolean
Update requires: No interruption
Group-
Specifies an Amazon ECS task group for the task. The maximum length is 255 characters.
Required: No
Type: String
Update requires: No interruption
LaunchType-
Specifies the launch type on which your task is running. The launch type that you specify here must match one of the launch type (compatibilities) of the target task. The
FARGATEvalue is supported only in the Regions where AWS Fargate with Amazon ECS is supported. For more information, see AWS Fargate on Amazon ECS in the Amazon Elastic Container Service Developer Guide.Required: No
Type: String
Allowed values:
EC2 | FARGATE | EXTERNALUpdate requires: No interruption
NetworkConfiguration-
Use this structure if the Amazon ECS task uses the
awsvpcnetwork mode. This structure specifies the VPC subnets and security groups associated with the task, and whether a public IP address is to be used. This structure is required ifLaunchTypeisFARGATEbecause theawsvpcmode is required for Fargate tasks.If you specify
NetworkConfigurationwhen the target ECS task does not use theawsvpcnetwork mode, the task fails.Required: No
Type: NetworkConfiguration
Update requires: No interruption
Overrides-
The overrides that are associated with a task.
Required: No
Type: EcsTaskOverride
Update requires: No interruption
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).
Required: No
Type: Array of PlacementConstraint
Minimum:
0Maximum:
10Update requires: No interruption
PlacementStrategy-
The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.
Required: No
Type: Array of PlacementStrategy
Minimum:
0Maximum:
5Update requires: No interruption
PlatformVersion-
Specifies the platform version for the task. Specify only the numeric portion of the platform version, such as
1.1.0.This structure is used only if
LaunchTypeisFARGATE. For more information about valid platform versions, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.Required: No
Type: String
Update requires: No interruption
-
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
TagResourceAPI action.Required: No
Type: String
Allowed values:
TASK_DEFINITIONUpdate requires: No interruption
ReferenceId-
The reference ID to use for the task.
Required: No
Type: String
Minimum:
0Maximum:
1024Update requires: No interruption
-
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. To learn more, see RunTask in the Amazon ECS API Reference.
Required: No
Type: Array of Tag
Update requires: No interruption
TaskCount-
The number of tasks to create based on
TaskDefinition. The default is 1.Required: No
Type: Integer
Minimum:
1Update requires: No interruption
TaskDefinitionArn-
The ARN of the task definition to use if the event target is an Amazon ECS task.
Required: Yes
Type: String
Pattern:
^arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\-]+):([a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1})?:(\d{12})?:(.+)|(\$(\.[\w/_-]+(\[(\d+|\*)\])*)*)$Minimum:
1Maximum:
1600Update requires: No interruption
