EcsParameters
The custom parameters to be used when the target is an Amazon ECS task.
Contents
- TaskDefinitionArn
-
The ARN of the task definition to use if the event target is an Amazon ECS task.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1600.
Required: Yes
- CapacityProviderStrategy
-
The capacity provider strategy to use for the task.
If a
capacityProviderStrategy
is specified, thelaunchType
parameter must be omitted. If nocapacityProviderStrategy
or launchType is specified, thedefaultCapacityProviderStrategy
for the cluster is used.Type: Array of CapacityProviderStrategyItem objects
Array Members: Maximum number of 6 items.
Required: No
- 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.
Type: Boolean
Required: No
- 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.
Type: Boolean
Required: No
- Group
-
Specifies an ECS task group for the task. The maximum length is 255 characters.
Type: String
Required: No
- 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
FARGATE
value is supported only in the Regions where Amazon Fargate with Amazon ECS is supported. For more information, see Amazon Fargate on Amazon ECS in the Amazon Elastic Container Service Developer Guide.Type: String
Valid Values:
EC2 | FARGATE | EXTERNAL
Required: No
- NetworkConfiguration
-
Use this structure if the Amazon ECS task uses the
awsvpc
network 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 ifLaunchType
isFARGATE
because theawsvpc
mode is required for Fargate tasks.If you specify
NetworkConfiguration
when the target ECS task does not use theawsvpc
network mode, the task fails.Type: NetworkConfiguration object
Required: No
- 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).
Type: Array of PlacementConstraint objects
Array Members: Maximum number of 10 items.
Required: No
- PlacementStrategy
-
The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.
Type: Array of PlacementStrategy objects
Array Members: Maximum number of 5 items.
Required: No
- 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
LaunchType
isFARGATE
. For more information about valid platform versions, see Amazon Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.Type: String
Required: No
- 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.
Type: String
Valid Values:
TASK_DEFINITION
Required: No
- ReferenceId
-
The reference ID to use for the task.
Type: String
Length Constraints: Maximum length of 1024.
Required: No
- 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. To learn more, see RunTask in the Amazon ECS API Reference.
Type: Array of Tag objects
Required: No
- TaskCount
-
The number of tasks to create based on
TaskDefinition
. The default is 1.Type: Integer
Valid Range: Minimum value of 1.
Required: No
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: