AWS::Scheduler::Schedule EcsParameters

The templated target type for the Amazon ECS RunTask API operation.

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,
  "PlacementConstraints" : [ PlacementConstraint, ... ],
  "PlacementStrategy" : [ PlacementStrategy, ... ],
  "PlatformVersion" : String,
  "PropagateTags" : String,
  "ReferenceId" : String,
  "Tags" : [ {Key: Value, ...}, ... ],
  "TaskCount" : Number,
  "TaskDefinitionArn" : String
}

YAML

  CapacityProviderStrategy: 
    - CapacityProviderStrategyItem
  EnableECSManagedTags: Boolean
  EnableExecuteCommand: Boolean
  Group: String
  LaunchType: String
  NetworkConfiguration: 
    NetworkConfiguration
  PlacementConstraints: 
    - PlacementConstraint
  PlacementStrategy: 
    - PlacementStrategy
  PlatformVersion: String
  PropagateTags: String
  ReferenceId: String
  Tags: 
    - 
    Key: Value
  TaskCount: Number
  TaskDefinitionArn: String

Properties

CapacityProviderStrategy

The capacity provider strategy to use for the task.

Required: No

Type: Array of CapacityProviderStrategyItem

Maximum: 6

Update requires: No interruption

EnableECSManagedTags

Specifies whether to enable Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources in the Amazon ECS 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

Minimum: 1

Maximum: 255

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 FARGATE value is supported only in the Regions where Fargate with Amazon ECS is supported. For more information, see AWS Fargate on Amazon ECS in the Amazon ECS Developer Guide.

Required: No

Type: String

Allowed values: EC2 | FARGATE | EXTERNAL

Update requires: No interruption

NetworkConfiguration

This structure specifies the network configuration for an ECS task.

Required: No

Type: NetworkConfiguration

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

Maximum: 10

Update requires: No interruption

PlacementStrategy

The task placement strategy for a task or service.

Required: No

Type: Array of PlacementStrategy

Maximum: 5

Update 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.

Required: No

Type: String

Minimum: 1

Maximum: 64

Update requires: No interruption

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 Amazon ECS TagResource API action.

Required: No

Type: String

Allowed values: TASK_DEFINITION

Update requires: No interruption

ReferenceId

The reference ID to use for the task.

Required: No

Type: String

Maximum: 1024

Update requires: No interruption

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. For more information, see RunTask in the Amazon ECS API Reference.

Required: No

Type: Array of Object

Minimum: 0

Maximum: 50

Update requires: No interruption

TaskCount

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

Required: No

Type: Number

Minimum: 1

Maximum: 10

Update requires: No interruption

TaskDefinitionArn

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

Required: Yes

Type: String

Minimum: 1

Maximum: 1600

Update requires: No interruption