Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface EcsParameters

The custom parameters to be used when the target is an Amazon ECS task.

Hierarchy

  • EcsParameters

Index

Properties

Optional CapacityProviderStrategy

CapacityProviderStrategy: CapacityProviderStrategyItem[]

The capacity provider strategy to use for the task.

If a capacityProviderStrategy is specified, the launchType parameter must be omitted. If no capacityProviderStrategy or launchType is specified, the defaultCapacityProviderStrategy for the cluster is used.

Optional EnableECSManagedTags

EnableECSManagedTags: undefined | false | true

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.

Optional EnableExecuteCommand

EnableExecuteCommand: undefined | false | true

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.

Optional Group

Group: undefined | string

Specifies an ECS task group for the task. The maximum length is 255 characters.

Optional LaunchType

LaunchType: LaunchType | string

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 Fargate witt Amazon ECS is supported. For more information, see Fargate on Amazon ECS in the Amazon Elastic Container Service Developer Guide.

Optional NetworkConfiguration

NetworkConfiguration: 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 if LaunchType is FARGATE because the awsvpc mode is required for Fargate tasks.

If you specify NetworkConfiguration when the target ECS task does not use the awsvpc network mode, the task fails.

Optional PlacementConstraints

PlacementConstraints: 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).

Optional PlacementStrategy

PlacementStrategy: PlacementStrategy[]

The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.

Optional PlatformVersion

PlatformVersion: undefined | string

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 is FARGATE. For more information about valid platform versions, see Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

Optional PropagateTags

PropagateTags: PropagateTags | string

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.

Optional ReferenceId

ReferenceId: undefined | string

The reference ID to use for the task.

Optional Tags

Tags: 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. To learn more, see RunTask in the Amazon ECS API Reference.

Optional TaskCount

TaskCount: undefined | number

The number of tasks to create based on TaskDefinition. The default is 1.

TaskDefinitionArn

TaskDefinitionArn: string | undefined

The ARN of the task definition to use if the event target is an Amazon ECS task.