This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html).

# AWS::Scheduler::Schedule
<a name="aws-resource-scheduler-schedule"></a>

 A *schedule* is the main resource you create, configure, and manage using Amazon EventBridge Scheduler. 

 Every schedule has a *schedule expression* that determines when, and with what frequency, the schedule runs. EventBridge Scheduler supports three types of schedules: rate, cron, and one-time schedules. For more information about different schedule types, see [Schedule types](https://docs.aws.amazon.com/scheduler/latest/UserGuide/schedule-types.html) in the *EventBridge Scheduler User Guide*. 

 When you create a schedule, you configure a target for the schedule to invoke. A target is an API operation that EventBridge Scheduler calls on your behalf every time your schedule runs. EventBridge Scheduler supports two types of targets: *templated* targets invoke common API operations across a core groups of services, and customizeable *universal* targets that you can use to call more than 6,000 operations across over 270 services. For more information about configuring targets, see [Managing targets](https://docs.aws.amazon.com/scheduler/latest/UserGuide/managing-targets.html) in the *EventBridge Scheduler User Guide*. 

 For more information about managing schedules, changing the schedule state, setting up flexible time windows, and configuring a dead-letter queue for a schedule, see [Managing a schedule](https://docs.aws.amazon.com/scheduler/latest/UserGuide/managing-schedule.html) in the *EventBridge Scheduler User Guide*. 

## Syntax
<a name="aws-resource-scheduler-schedule-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-resource-scheduler-schedule-syntax.json"></a>

```
{
  "Type" : "AWS::Scheduler::Schedule",
  "Properties" : {
      "[Description](#cfn-scheduler-schedule-description)" : String,
      "[EndDate](#cfn-scheduler-schedule-enddate)" : String,
      "[FlexibleTimeWindow](#cfn-scheduler-schedule-flexibletimewindow)" : FlexibleTimeWindow,
      "[GroupName](#cfn-scheduler-schedule-groupname)" : String,
      "[KmsKeyArn](#cfn-scheduler-schedule-kmskeyarn)" : String,
      "[Name](#cfn-scheduler-schedule-name)" : String,
      "[ScheduleExpression](#cfn-scheduler-schedule-scheduleexpression)" : String,
      "[ScheduleExpressionTimezone](#cfn-scheduler-schedule-scheduleexpressiontimezone)" : String,
      "[StartDate](#cfn-scheduler-schedule-startdate)" : String,
      "[State](#cfn-scheduler-schedule-state)" : String,
      "[Target](#cfn-scheduler-schedule-target)" : Target
    }
}
```

### YAML
<a name="aws-resource-scheduler-schedule-syntax.yaml"></a>

```
Type: AWS::Scheduler::Schedule
Properties:
  [Description](#cfn-scheduler-schedule-description): String
  [EndDate](#cfn-scheduler-schedule-enddate): String
  [FlexibleTimeWindow](#cfn-scheduler-schedule-flexibletimewindow): 
    FlexibleTimeWindow
  [GroupName](#cfn-scheduler-schedule-groupname): String
  [KmsKeyArn](#cfn-scheduler-schedule-kmskeyarn): String
  [Name](#cfn-scheduler-schedule-name): String
  [ScheduleExpression](#cfn-scheduler-schedule-scheduleexpression): String
  [ScheduleExpressionTimezone](#cfn-scheduler-schedule-scheduleexpressiontimezone): String
  [StartDate](#cfn-scheduler-schedule-startdate): String
  [State](#cfn-scheduler-schedule-state): String
  [Target](#cfn-scheduler-schedule-target): 
    Target
```

## Properties
<a name="aws-resource-scheduler-schedule-properties"></a>

`Description`  <a name="cfn-scheduler-schedule-description"></a>
The description you specify for the schedule.  
*Required*: No  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `512`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`EndDate`  <a name="cfn-scheduler-schedule-enddate"></a>
The date, in UTC, before which the schedule can invoke its target. Depending on the schedule's recurrence expression, invocations might stop on, or before, the `EndDate` you specify. EventBridge Scheduler ignores `EndDate` for one-time schedules.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`FlexibleTimeWindow`  <a name="cfn-scheduler-schedule-flexibletimewindow"></a>
Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.  
*Required*: Yes  
*Type*: [FlexibleTimeWindow](aws-properties-scheduler-schedule-flexibletimewindow.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`GroupName`  <a name="cfn-scheduler-schedule-groupname"></a>
The name of the schedule group associated with this schedule.  
*Required*: No  
*Type*: String  
*Pattern*: `^[0-9a-zA-Z-_.]+$`  
*Minimum*: `1`  
*Maximum*: `64`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`KmsKeyArn`  <a name="cfn-scheduler-schedule-kmskeyarn"></a>
The Amazon Resource Name (ARN) for the customer managed KMS key that EventBridge Scheduler will use to encrypt and decrypt your data.  
*Required*: No  
*Type*: String  
*Pattern*: `^arn:aws[a-z-]*:kms:[a-z0-9\-]+:\d{12}:(key|alias)\/[0-9a-zA-Z-_]*$`  
*Minimum*: `1`  
*Maximum*: `2048`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Name`  <a name="cfn-scheduler-schedule-name"></a>
The name of the schedule.  
*Required*: No  
*Type*: String  
*Pattern*: `^[0-9a-zA-Z-_.]+$`  
*Minimum*: `1`  
*Maximum*: `64`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`ScheduleExpression`  <a name="cfn-scheduler-schedule-scheduleexpression"></a>
 The expression that defines when the schedule runs. The following formats are supported.   
+ `at` expression - `at(yyyy-mm-ddThh:mm:ss)`
+ `rate` expression - `rate(value unit)`
+ `cron` expression - `cron(fields)`
 You can use `at` expressions to create one-time schedules that invoke a target once, at the time and in the time zone, that you specify. You can use `rate` and `cron` expressions to create recurring schedules. Rate-based schedules are useful when you want to invoke a target at regular intervals, such as every 15 minutes or every five days. Cron-based schedules are useful when you want to invoke a target periodically at a specific time, such as at 8:00 am (UTC\$10) every 1st day of the month.   
 A `cron` expression consists of six fields separated by white spaces: `(minutes hours day_of_month month day_of_week year)`.   
 A `rate` expression consists of a *value* as a positive integer, and a *unit* with the following options: `minute` \$1 `minutes` \$1 `hour` \$1 `hours` \$1 `day` \$1 `days`  
 For more information and examples, see [Schedule types on EventBridge Scheduler](https://docs.aws.amazon.com/scheduler/latest/UserGuide/schedule-types.html) in the *EventBridge Scheduler User Guide*.   
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ScheduleExpressionTimezone`  <a name="cfn-scheduler-schedule-scheduleexpressiontimezone"></a>
The timezone in which the scheduling expression is evaluated.  
*Required*: No  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `50`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`StartDate`  <a name="cfn-scheduler-schedule-startdate"></a>
The date, in UTC, after which the schedule can begin invoking its target. Depending on the schedule's recurrence expression, invocations might occur on, or after, the `StartDate` you specify. EventBridge Scheduler ignores `StartDate` for one-time schedules.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`State`  <a name="cfn-scheduler-schedule-state"></a>
Specifies whether the schedule is enabled or disabled.  
*Allowed Values*: `ENABLED` \$1 `DISABLED`  
*Required*: No  
*Type*: String  
*Allowed values*: `ENABLED | DISABLED`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Target`  <a name="cfn-scheduler-schedule-target"></a>
The schedule's target details.  
*Required*: Yes  
*Type*: [Target](aws-properties-scheduler-schedule-target.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return values
<a name="aws-resource-scheduler-schedule-return-values"></a>

### Ref
<a name="aws-resource-scheduler-schedule-return-values-ref"></a>

When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the `Name` attribute of theschedule.

### Fn::GetAtt
<a name="aws-resource-scheduler-schedule-return-values-fn--getatt"></a>

 The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes that `Fn::GetAtt` returns. For more information about using the `Fn::GetAtt` intrinsic function, see [Fn::GetAtt](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-getatt.html). 

#### 
<a name="aws-resource-scheduler-schedule-return-values-fn--getatt-fn--getatt"></a>

`Arn`  <a name="Arn-fn::getatt"></a>
The Amazon Resource Name (ARN) for the Amazon EventBridge Scheduler schedule.

# AWS::Scheduler::Schedule AwsVpcConfiguration
<a name="aws-properties-scheduler-schedule-awsvpcconfiguration"></a>

This structure specifies the VPC subnets and security groups for the task, and whether a public IP address is to be used. This structure is relevant only for ECS tasks that use the awsvpc network mode.

## Syntax
<a name="aws-properties-scheduler-schedule-awsvpcconfiguration-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-scheduler-schedule-awsvpcconfiguration-syntax.json"></a>

```
{
  "[AssignPublicIp](#cfn-scheduler-schedule-awsvpcconfiguration-assignpublicip)" : String,
  "[SecurityGroups](#cfn-scheduler-schedule-awsvpcconfiguration-securitygroups)" : [ String, ... ],
  "[Subnets](#cfn-scheduler-schedule-awsvpcconfiguration-subnets)" : [ String, ... ]
}
```

### YAML
<a name="aws-properties-scheduler-schedule-awsvpcconfiguration-syntax.yaml"></a>

```
  [AssignPublicIp](#cfn-scheduler-schedule-awsvpcconfiguration-assignpublicip): String
  [SecurityGroups](#cfn-scheduler-schedule-awsvpcconfiguration-securitygroups): 
    - String
  [Subnets](#cfn-scheduler-schedule-awsvpcconfiguration-subnets): 
    - String
```

## Properties
<a name="aws-properties-scheduler-schedule-awsvpcconfiguration-properties"></a>

`AssignPublicIp`  <a name="cfn-scheduler-schedule-awsvpcconfiguration-assignpublicip"></a>
Specifies whether the task's elastic network interface receives a public IP address. You can specify `ENABLED` only when `LaunchType` in `EcsParameters` is set to `FARGATE`.  
*Required*: No  
*Type*: String  
*Allowed values*: `ENABLED | DISABLED`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SecurityGroups`  <a name="cfn-scheduler-schedule-awsvpcconfiguration-securitygroups"></a>
Specifies the security groups associated with the task. These security groups must all be in the same VPC. You can specify as many as five security groups. If you do not specify a security group, the default security group for the VPC is used.  
*Required*: No  
*Type*: Array of String  
*Minimum*: `1 | 1`  
*Maximum*: `1000 | 5`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Subnets`  <a name="cfn-scheduler-schedule-awsvpcconfiguration-subnets"></a>
Specifies the subnets associated with the task. These subnets must all be in the same VPC. You can specify as many as 16 subnets.  
*Required*: Yes  
*Type*: Array of String  
*Minimum*: `1 | 1`  
*Maximum*: `1000 | 16`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::Scheduler::Schedule CapacityProviderStrategyItem
<a name="aws-properties-scheduler-schedule-capacityproviderstrategyitem"></a>

The details of a capacity provider strategy.

## Syntax
<a name="aws-properties-scheduler-schedule-capacityproviderstrategyitem-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-scheduler-schedule-capacityproviderstrategyitem-syntax.json"></a>

```
{
  "[Base](#cfn-scheduler-schedule-capacityproviderstrategyitem-base)" : Number,
  "[CapacityProvider](#cfn-scheduler-schedule-capacityproviderstrategyitem-capacityprovider)" : String,
  "[Weight](#cfn-scheduler-schedule-capacityproviderstrategyitem-weight)" : Number
}
```

### YAML
<a name="aws-properties-scheduler-schedule-capacityproviderstrategyitem-syntax.yaml"></a>

```
  [Base](#cfn-scheduler-schedule-capacityproviderstrategyitem-base): Number
  [CapacityProvider](#cfn-scheduler-schedule-capacityproviderstrategyitem-capacityprovider): String
  [Weight](#cfn-scheduler-schedule-capacityproviderstrategyitem-weight): Number
```

## Properties
<a name="aws-properties-scheduler-schedule-capacityproviderstrategyitem-properties"></a>

`Base`  <a name="cfn-scheduler-schedule-capacityproviderstrategyitem-base"></a>
The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined. If no value is specified, the default value of `0` is used.  
*Required*: No  
*Type*: Number  
*Minimum*: `0`  
*Maximum*: `100000`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`CapacityProvider`  <a name="cfn-scheduler-schedule-capacityproviderstrategyitem-capacityprovider"></a>
The short name of the capacity provider.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `255`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Weight`  <a name="cfn-scheduler-schedule-capacityproviderstrategyitem-weight"></a>
The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. The weight value is taken into consideration after the base value, if defined, is satisfied.  
*Required*: No  
*Type*: Number  
*Minimum*: `0`  
*Maximum*: `1000`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::Scheduler::Schedule DeadLetterConfig
<a name="aws-properties-scheduler-schedule-deadletterconfig"></a>

An object that contains information about an Amazon SQS queue that EventBridge Scheduler uses as a dead-letter queue for your schedule. If specified, EventBridge Scheduler delivers failed events that could not be successfully delivered to a target to the queue.

## Syntax
<a name="aws-properties-scheduler-schedule-deadletterconfig-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-scheduler-schedule-deadletterconfig-syntax.json"></a>

```
{
  "[Arn](#cfn-scheduler-schedule-deadletterconfig-arn)" : String
}
```

### YAML
<a name="aws-properties-scheduler-schedule-deadletterconfig-syntax.yaml"></a>

```
  [Arn](#cfn-scheduler-schedule-deadletterconfig-arn): String
```

## Properties
<a name="aws-properties-scheduler-schedule-deadletterconfig-properties"></a>

`Arn`  <a name="cfn-scheduler-schedule-deadletterconfig-arn"></a>
The Amazon Resource Name (ARN) of the SQS queue specified as the destination for the dead-letter queue.  
*Required*: No  
*Type*: String  
*Pattern*: `^arn:aws[a-z-]*:sqs:[a-z0-9\-]+:\d{12}:[a-zA-Z0-9\-_]+$`  
*Minimum*: `1`  
*Maximum*: `1600`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::Scheduler::Schedule EcsParameters
<a name="aws-properties-scheduler-schedule-ecsparameters"></a>

The templated target type for the Amazon ECS[https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html) API operation.

## Syntax
<a name="aws-properties-scheduler-schedule-ecsparameters-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-scheduler-schedule-ecsparameters-syntax.json"></a>

```
{
  "[CapacityProviderStrategy](#cfn-scheduler-schedule-ecsparameters-capacityproviderstrategy)" : [ CapacityProviderStrategyItem, ... ],
  "[EnableECSManagedTags](#cfn-scheduler-schedule-ecsparameters-enableecsmanagedtags)" : Boolean,
  "[EnableExecuteCommand](#cfn-scheduler-schedule-ecsparameters-enableexecutecommand)" : Boolean,
  "[Group](#cfn-scheduler-schedule-ecsparameters-group)" : String,
  "[LaunchType](#cfn-scheduler-schedule-ecsparameters-launchtype)" : String,
  "[NetworkConfiguration](#cfn-scheduler-schedule-ecsparameters-networkconfiguration)" : NetworkConfiguration,
  "[PlacementConstraints](#cfn-scheduler-schedule-ecsparameters-placementconstraints)" : [ PlacementConstraint, ... ],
  "[PlacementStrategy](#cfn-scheduler-schedule-ecsparameters-placementstrategy)" : [ PlacementStrategy, ... ],
  "[PlatformVersion](#cfn-scheduler-schedule-ecsparameters-platformversion)" : String,
  "[PropagateTags](#cfn-scheduler-schedule-ecsparameters-propagatetags)" : String,
  "[ReferenceId](#cfn-scheduler-schedule-ecsparameters-referenceid)" : String,
  "[Tags](#cfn-scheduler-schedule-ecsparameters-tags)" : [ {Key: Value, ...}, ... ],
  "[TaskCount](#cfn-scheduler-schedule-ecsparameters-taskcount)" : Number,
  "[TaskDefinitionArn](#cfn-scheduler-schedule-ecsparameters-taskdefinitionarn)" : String
}
```

### YAML
<a name="aws-properties-scheduler-schedule-ecsparameters-syntax.yaml"></a>

```
  [CapacityProviderStrategy](#cfn-scheduler-schedule-ecsparameters-capacityproviderstrategy): 
    - CapacityProviderStrategyItem
  [EnableECSManagedTags](#cfn-scheduler-schedule-ecsparameters-enableecsmanagedtags): Boolean
  [EnableExecuteCommand](#cfn-scheduler-schedule-ecsparameters-enableexecutecommand): Boolean
  [Group](#cfn-scheduler-schedule-ecsparameters-group): String
  [LaunchType](#cfn-scheduler-schedule-ecsparameters-launchtype): String
  [NetworkConfiguration](#cfn-scheduler-schedule-ecsparameters-networkconfiguration): 
    NetworkConfiguration
  [PlacementConstraints](#cfn-scheduler-schedule-ecsparameters-placementconstraints): 
    - PlacementConstraint
  [PlacementStrategy](#cfn-scheduler-schedule-ecsparameters-placementstrategy): 
    - PlacementStrategy
  [PlatformVersion](#cfn-scheduler-schedule-ecsparameters-platformversion): String
  [PropagateTags](#cfn-scheduler-schedule-ecsparameters-propagatetags): String
  [ReferenceId](#cfn-scheduler-schedule-ecsparameters-referenceid): String
  [Tags](#cfn-scheduler-schedule-ecsparameters-tags): 
    - 
    Key: Value
  [TaskCount](#cfn-scheduler-schedule-ecsparameters-taskcount): Number
  [TaskDefinitionArn](#cfn-scheduler-schedule-ecsparameters-taskdefinitionarn): String
```

## Properties
<a name="aws-properties-scheduler-schedule-ecsparameters-properties"></a>

`CapacityProviderStrategy`  <a name="cfn-scheduler-schedule-ecsparameters-capacityproviderstrategy"></a>
The capacity provider strategy to use for the task.  
*Required*: No  
*Type*: Array of [CapacityProviderStrategyItem](aws-properties-scheduler-schedule-capacityproviderstrategyitem.md)  
*Maximum*: `6`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`EnableECSManagedTags`  <a name="cfn-scheduler-schedule-ecsparameters-enableecsmanagedtags"></a>
Specifies whether to enable Amazon ECS managed tags for the task. For more information, see [Tagging Your Amazon ECS Resources](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html) in the *Amazon ECS Developer Guide*.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`EnableExecuteCommand`  <a name="cfn-scheduler-schedule-ecsparameters-enableexecutecommand"></a>
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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Group`  <a name="cfn-scheduler-schedule-ecsparameters-group"></a>
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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`LaunchType`  <a name="cfn-scheduler-schedule-ecsparameters-launchtype"></a>
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](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/AWS_Fargate.html) in the *Amazon ECS Developer Guide*.  
*Required*: No  
*Type*: String  
*Allowed values*: `EC2 | FARGATE | EXTERNAL`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`NetworkConfiguration`  <a name="cfn-scheduler-schedule-ecsparameters-networkconfiguration"></a>
This structure specifies the network configuration for an ECS task.  
*Required*: No  
*Type*: [NetworkConfiguration](aws-properties-scheduler-schedule-networkconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`PlacementConstraints`  <a name="cfn-scheduler-schedule-ecsparameters-placementconstraints"></a>
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](aws-properties-scheduler-schedule-placementconstraint.md)  
*Maximum*: `10`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`PlacementStrategy`  <a name="cfn-scheduler-schedule-ecsparameters-placementstrategy"></a>
The task placement strategy for a task or service.  
*Required*: No  
*Type*: [Array](aws-properties-scheduler-schedule-placementstrategy.md) of [PlacementStrategy](aws-properties-scheduler-schedule-placementstrategy.md)  
*Maximum*: `5`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`PlatformVersion`  <a name="cfn-scheduler-schedule-ecsparameters-platformversion"></a>
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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`PropagateTags`  <a name="cfn-scheduler-schedule-ecsparameters-propagatetags"></a>
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[https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_TagResource.html](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_TagResource.html) API action.   
*Required*: No  
*Type*: String  
*Allowed values*: `TASK_DEFINITION`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ReferenceId`  <a name="cfn-scheduler-schedule-ecsparameters-referenceid"></a>
The reference ID to use for the task.  
*Required*: No  
*Type*: String  
*Maximum*: `1024`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Tags`  <a name="cfn-scheduler-schedule-ecsparameters-tags"></a>
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 [https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html) in the *Amazon ECS API Reference*.  
*Required*: No  
*Type*: Array of Object  
*Minimum*: `0`  
*Maximum*: `50`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`TaskCount`  <a name="cfn-scheduler-schedule-ecsparameters-taskcount"></a>
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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`TaskDefinitionArn`  <a name="cfn-scheduler-schedule-ecsparameters-taskdefinitionarn"></a>
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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::Scheduler::Schedule EventBridgeParameters
<a name="aws-properties-scheduler-schedule-eventbridgeparameters"></a>

The templated target type for the EventBridge [https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutEvents.html](https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutEvents.html) API operation.

## Syntax
<a name="aws-properties-scheduler-schedule-eventbridgeparameters-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-scheduler-schedule-eventbridgeparameters-syntax.json"></a>

```
{
  "[DetailType](#cfn-scheduler-schedule-eventbridgeparameters-detailtype)" : String,
  "[Source](#cfn-scheduler-schedule-eventbridgeparameters-source)" : String
}
```

### YAML
<a name="aws-properties-scheduler-schedule-eventbridgeparameters-syntax.yaml"></a>

```
  [DetailType](#cfn-scheduler-schedule-eventbridgeparameters-detailtype): String
  [Source](#cfn-scheduler-schedule-eventbridgeparameters-source): String
```

## Properties
<a name="aws-properties-scheduler-schedule-eventbridgeparameters-properties"></a>

`DetailType`  <a name="cfn-scheduler-schedule-eventbridgeparameters-detailtype"></a>
A free-form string, with a maximum of 128 characters, used to decide what fields to expect in the event detail.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `128`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Source`  <a name="cfn-scheduler-schedule-eventbridgeparameters-source"></a>
The source of the event.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^(?=[/\.\-_A-Za-z0-9]+)((?!aws\.).*)|(\$(\.[\w_-]+(\[(\d+|\*)\])*)*)$`  
*Minimum*: `1`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::Scheduler::Schedule FlexibleTimeWindow
<a name="aws-properties-scheduler-schedule-flexibletimewindow"></a>

Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.

## Syntax
<a name="aws-properties-scheduler-schedule-flexibletimewindow-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-scheduler-schedule-flexibletimewindow-syntax.json"></a>

```
{
  "[MaximumWindowInMinutes](#cfn-scheduler-schedule-flexibletimewindow-maximumwindowinminutes)" : Number,
  "[Mode](#cfn-scheduler-schedule-flexibletimewindow-mode)" : String
}
```

### YAML
<a name="aws-properties-scheduler-schedule-flexibletimewindow-syntax.yaml"></a>

```
  [MaximumWindowInMinutes](#cfn-scheduler-schedule-flexibletimewindow-maximumwindowinminutes): Number
  [Mode](#cfn-scheduler-schedule-flexibletimewindow-mode): String
```

## Properties
<a name="aws-properties-scheduler-schedule-flexibletimewindow-properties"></a>

`MaximumWindowInMinutes`  <a name="cfn-scheduler-schedule-flexibletimewindow-maximumwindowinminutes"></a>
The maximum time window during which a schedule can be invoked.  
*Minimum*: `1`  
*Maximum*: `1440`  
*Required*: No  
*Type*: Number  
*Minimum*: `1`  
*Maximum*: `1440`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Mode`  <a name="cfn-scheduler-schedule-flexibletimewindow-mode"></a>
Determines whether the schedule is invoked within a flexible time window. You must use quotation marks when you specify this value in your JSON or YAML template.  
*Allowed Values*: `"OFF"` \$1 `"FLEXIBLE"`  
*Required*: Yes  
*Type*: String  
*Allowed values*: `OFF | FLEXIBLE`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::Scheduler::Schedule KinesisParameters
<a name="aws-properties-scheduler-schedule-kinesisparameters"></a>

The templated target type for the Amazon Kinesis [https://docs.aws.amazon.com/kinesis/latest/APIReference/API_PutRecord.html](https://docs.aws.amazon.com/kinesis/latest/APIReference/API_PutRecord.html) API operation.

## Syntax
<a name="aws-properties-scheduler-schedule-kinesisparameters-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-scheduler-schedule-kinesisparameters-syntax.json"></a>

```
{
  "[PartitionKey](#cfn-scheduler-schedule-kinesisparameters-partitionkey)" : String
}
```

### YAML
<a name="aws-properties-scheduler-schedule-kinesisparameters-syntax.yaml"></a>

```
  [PartitionKey](#cfn-scheduler-schedule-kinesisparameters-partitionkey): String
```

## Properties
<a name="aws-properties-scheduler-schedule-kinesisparameters-properties"></a>

`PartitionKey`  <a name="cfn-scheduler-schedule-kinesisparameters-partitionkey"></a>
Specifies the shard to which EventBridge Scheduler sends the event. For more information, see [Amazon Kinesis Data Streams terminology and concepts](https://docs.aws.amazon.com/streams/latest/dev/key-concepts.html) in the *Amazon Kinesis Streams Developer Guide*.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::Scheduler::Schedule NetworkConfiguration
<a name="aws-properties-scheduler-schedule-networkconfiguration"></a>

Specifies the network configuration for an ECS task.

## Syntax
<a name="aws-properties-scheduler-schedule-networkconfiguration-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-scheduler-schedule-networkconfiguration-syntax.json"></a>

```
{
  "[AwsvpcConfiguration](#cfn-scheduler-schedule-networkconfiguration-awsvpcconfiguration)" : AwsVpcConfiguration
}
```

### YAML
<a name="aws-properties-scheduler-schedule-networkconfiguration-syntax.yaml"></a>

```
  [AwsvpcConfiguration](#cfn-scheduler-schedule-networkconfiguration-awsvpcconfiguration): 
    AwsVpcConfiguration
```

## Properties
<a name="aws-properties-scheduler-schedule-networkconfiguration-properties"></a>

`AwsvpcConfiguration`  <a name="cfn-scheduler-schedule-networkconfiguration-awsvpcconfiguration"></a>
Specifies the Amazon VPC subnets and security groups for the task, and whether a public IP address is to be used. This structure is relevant only for ECS tasks that use the awsvpc network mode.  
*Required*: No  
*Type*: [AwsVpcConfiguration](aws-properties-scheduler-schedule-awsvpcconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::Scheduler::Schedule PlacementConstraint
<a name="aws-properties-scheduler-schedule-placementconstraint"></a>

An object representing a constraint on task placement.

## Syntax
<a name="aws-properties-scheduler-schedule-placementconstraint-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-scheduler-schedule-placementconstraint-syntax.json"></a>

```
{
  "[Expression](#cfn-scheduler-schedule-placementconstraint-expression)" : String,
  "[Type](#cfn-scheduler-schedule-placementconstraint-type)" : String
}
```

### YAML
<a name="aws-properties-scheduler-schedule-placementconstraint-syntax.yaml"></a>

```
  [Expression](#cfn-scheduler-schedule-placementconstraint-expression): String
  [Type](#cfn-scheduler-schedule-placementconstraint-type): String
```

## Properties
<a name="aws-properties-scheduler-schedule-placementconstraint-properties"></a>

`Expression`  <a name="cfn-scheduler-schedule-placementconstraint-expression"></a>
A cluster query language expression to apply to the constraint. You cannot specify an expression if the constraint type is `distinctInstance`. For more information, see [Cluster query language](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html) in the *Amazon ECS Developer Guide*.  
*Required*: No  
*Type*: String  
*Maximum*: `2000`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Type`  <a name="cfn-scheduler-schedule-placementconstraint-type"></a>
The type of constraint. Use `distinctInstance` to ensure that each task in a particular group is running on a different container instance. Use `memberOf` to restrict the selection to a group of valid candidates.  
*Required*: No  
*Type*: String  
*Allowed values*: `distinctInstance | memberOf`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::Scheduler::Schedule PlacementStrategy
<a name="aws-properties-scheduler-schedule-placementstrategy"></a>

The task placement strategy for a task or service.

## Syntax
<a name="aws-properties-scheduler-schedule-placementstrategy-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-scheduler-schedule-placementstrategy-syntax.json"></a>

```
{
  "[Field](#cfn-scheduler-schedule-placementstrategy-field)" : String,
  "[Type](#cfn-scheduler-schedule-placementstrategy-type)" : String
}
```

### YAML
<a name="aws-properties-scheduler-schedule-placementstrategy-syntax.yaml"></a>

```
  [Field](#cfn-scheduler-schedule-placementstrategy-field): String
  [Type](#cfn-scheduler-schedule-placementstrategy-type): String
```

## Properties
<a name="aws-properties-scheduler-schedule-placementstrategy-properties"></a>

`Field`  <a name="cfn-scheduler-schedule-placementstrategy-field"></a>
The field to apply the placement strategy against. For the spread placement strategy, valid values are `instanceId` (or `instanceId`, which has the same effect), or any platform or custom attribute that is applied to a container instance, such as `attribute:ecs.availability-zone`. For the binpack placement strategy, valid values are `cpu` and `memory`. For the random placement strategy, this field is not used.  
*Required*: No  
*Type*: String  
*Maximum*: `255`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Type`  <a name="cfn-scheduler-schedule-placementstrategy-type"></a>
The type of placement strategy. The random placement strategy randomly places tasks on available candidates. The spread placement strategy spreads placement across available candidates evenly based on the field parameter. The binpack strategy places tasks on available candidates that have the least available amount of the resource that is specified with the field parameter. For example, if you binpack on memory, a task is placed on the instance with the least amount of remaining memory (but still enough to run the task).  
*Required*: No  
*Type*: String  
*Allowed values*: `random | spread | binpack`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::Scheduler::Schedule RetryPolicy
<a name="aws-properties-scheduler-schedule-retrypolicy"></a>

A `RetryPolicy` object that includes information about the retry policy settings, including the maximum age of an event, and the maximum number of times EventBridge Scheduler will try to deliver the event to a target.

## Syntax
<a name="aws-properties-scheduler-schedule-retrypolicy-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-scheduler-schedule-retrypolicy-syntax.json"></a>

```
{
  "[MaximumEventAgeInSeconds](#cfn-scheduler-schedule-retrypolicy-maximumeventageinseconds)" : Number,
  "[MaximumRetryAttempts](#cfn-scheduler-schedule-retrypolicy-maximumretryattempts)" : Number
}
```

### YAML
<a name="aws-properties-scheduler-schedule-retrypolicy-syntax.yaml"></a>

```
  [MaximumEventAgeInSeconds](#cfn-scheduler-schedule-retrypolicy-maximumeventageinseconds): Number
  [MaximumRetryAttempts](#cfn-scheduler-schedule-retrypolicy-maximumretryattempts): Number
```

## Properties
<a name="aws-properties-scheduler-schedule-retrypolicy-properties"></a>

`MaximumEventAgeInSeconds`  <a name="cfn-scheduler-schedule-retrypolicy-maximumeventageinseconds"></a>
The maximum amount of time, in seconds, to continue to make retry attempts.  
*Required*: No  
*Type*: Number  
*Minimum*: `60`  
*Maximum*: `86400`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`MaximumRetryAttempts`  <a name="cfn-scheduler-schedule-retrypolicy-maximumretryattempts"></a>
The maximum number of retry attempts to make before the request fails. Retry attempts with exponential backoff continue until either the maximum number of attempts is made or until the duration of the `MaximumEventAgeInSeconds` is reached.  
*Required*: No  
*Type*: Number  
*Minimum*: `0`  
*Maximum*: `185`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::Scheduler::Schedule SageMakerPipelineParameter
<a name="aws-properties-scheduler-schedule-sagemakerpipelineparameter"></a>

The name and value pair of a parameter to use to start execution of a SageMaker Model Building Pipeline.

## Syntax
<a name="aws-properties-scheduler-schedule-sagemakerpipelineparameter-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-scheduler-schedule-sagemakerpipelineparameter-syntax.json"></a>

```
{
  "[Name](#cfn-scheduler-schedule-sagemakerpipelineparameter-name)" : String,
  "[Value](#cfn-scheduler-schedule-sagemakerpipelineparameter-value)" : String
}
```

### YAML
<a name="aws-properties-scheduler-schedule-sagemakerpipelineparameter-syntax.yaml"></a>

```
  [Name](#cfn-scheduler-schedule-sagemakerpipelineparameter-name): String
  [Value](#cfn-scheduler-schedule-sagemakerpipelineparameter-value): String
```

## Properties
<a name="aws-properties-scheduler-schedule-sagemakerpipelineparameter-properties"></a>

`Name`  <a name="cfn-scheduler-schedule-sagemakerpipelineparameter-name"></a>
Name of parameter to start execution of a SageMaker Model Building Pipeline.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^[A-Za-z0-9\-_]*$`  
*Minimum*: `1`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Value`  <a name="cfn-scheduler-schedule-sagemakerpipelineparameter-value"></a>
Value of parameter to start execution of a SageMaker Model Building Pipeline.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `1024`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::Scheduler::Schedule SageMakerPipelineParameters
<a name="aws-properties-scheduler-schedule-sagemakerpipelineparameters"></a>

The templated target type for the Amazon SageMaker [https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_StartPipelineExecution.html](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_StartPipelineExecution.html) API operation.

## Syntax
<a name="aws-properties-scheduler-schedule-sagemakerpipelineparameters-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-scheduler-schedule-sagemakerpipelineparameters-syntax.json"></a>

```
{
  "[PipelineParameterList](#cfn-scheduler-schedule-sagemakerpipelineparameters-pipelineparameterlist)" : [ SageMakerPipelineParameter, ... ]
}
```

### YAML
<a name="aws-properties-scheduler-schedule-sagemakerpipelineparameters-syntax.yaml"></a>

```
  [PipelineParameterList](#cfn-scheduler-schedule-sagemakerpipelineparameters-pipelineparameterlist): 
    - SageMakerPipelineParameter
```

## Properties
<a name="aws-properties-scheduler-schedule-sagemakerpipelineparameters-properties"></a>

`PipelineParameterList`  <a name="cfn-scheduler-schedule-sagemakerpipelineparameters-pipelineparameterlist"></a>
List of parameter names and values to use when executing the SageMaker Model Building Pipeline.  
*Required*: No  
*Type*: Array of [SageMakerPipelineParameter](aws-properties-scheduler-schedule-sagemakerpipelineparameter.md)  
*Minimum*: `0`  
*Maximum*: `200`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::Scheduler::Schedule SqsParameters
<a name="aws-properties-scheduler-schedule-sqsparameters"></a>

The templated target type for the Amazon SQS [https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_SendMessage.html](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_SendMessage.html) API operation. Contains the message group ID to use when the target is a FIFO queue. If you specify an Amazon SQS FIFO queue as a target, the queue must have content-based deduplication enabled. For more information, see [Using the Amazon SQS message deduplication ID](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagededuplicationid-property.html) in the *Amazon SQS Developer Guide*. 

## Syntax
<a name="aws-properties-scheduler-schedule-sqsparameters-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-scheduler-schedule-sqsparameters-syntax.json"></a>

```
{
  "[MessageGroupId](#cfn-scheduler-schedule-sqsparameters-messagegroupid)" : String
}
```

### YAML
<a name="aws-properties-scheduler-schedule-sqsparameters-syntax.yaml"></a>

```
  [MessageGroupId](#cfn-scheduler-schedule-sqsparameters-messagegroupid): String
```

## Properties
<a name="aws-properties-scheduler-schedule-sqsparameters-properties"></a>

`MessageGroupId`  <a name="cfn-scheduler-schedule-sqsparameters-messagegroupid"></a>
The FIFO message group ID to use as the target.  
*Required*: No  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `128`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::Scheduler::Schedule Target
<a name="aws-properties-scheduler-schedule-target"></a>

The schedule's target. EventBridge Scheduler supports templated target that invoke common API operations, as well as universal targets that you can customize to invoke over 6,000 API operations across more than 270 services. You can only specify one templated or universal target for a schedule.

## Syntax
<a name="aws-properties-scheduler-schedule-target-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-scheduler-schedule-target-syntax.json"></a>

```
{
  "[Arn](#cfn-scheduler-schedule-target-arn)" : String,
  "[DeadLetterConfig](#cfn-scheduler-schedule-target-deadletterconfig)" : DeadLetterConfig,
  "[EcsParameters](#cfn-scheduler-schedule-target-ecsparameters)" : EcsParameters,
  "[EventBridgeParameters](#cfn-scheduler-schedule-target-eventbridgeparameters)" : EventBridgeParameters,
  "[Input](#cfn-scheduler-schedule-target-input)" : String,
  "[KinesisParameters](#cfn-scheduler-schedule-target-kinesisparameters)" : KinesisParameters,
  "[RetryPolicy](#cfn-scheduler-schedule-target-retrypolicy)" : RetryPolicy,
  "[RoleArn](#cfn-scheduler-schedule-target-rolearn)" : String,
  "[SageMakerPipelineParameters](#cfn-scheduler-schedule-target-sagemakerpipelineparameters)" : SageMakerPipelineParameters,
  "[SqsParameters](#cfn-scheduler-schedule-target-sqsparameters)" : SqsParameters
}
```

### YAML
<a name="aws-properties-scheduler-schedule-target-syntax.yaml"></a>

```
  [Arn](#cfn-scheduler-schedule-target-arn): String
  [DeadLetterConfig](#cfn-scheduler-schedule-target-deadletterconfig): 
    DeadLetterConfig
  [EcsParameters](#cfn-scheduler-schedule-target-ecsparameters): 
    EcsParameters
  [EventBridgeParameters](#cfn-scheduler-schedule-target-eventbridgeparameters): 
    EventBridgeParameters
  [Input](#cfn-scheduler-schedule-target-input): String
  [KinesisParameters](#cfn-scheduler-schedule-target-kinesisparameters): 
    KinesisParameters
  [RetryPolicy](#cfn-scheduler-schedule-target-retrypolicy): 
    RetryPolicy
  [RoleArn](#cfn-scheduler-schedule-target-rolearn): String
  [SageMakerPipelineParameters](#cfn-scheduler-schedule-target-sagemakerpipelineparameters): 
    SageMakerPipelineParameters
  [SqsParameters](#cfn-scheduler-schedule-target-sqsparameters): 
    SqsParameters
```

## Properties
<a name="aws-properties-scheduler-schedule-target-properties"></a>

`Arn`  <a name="cfn-scheduler-schedule-target-arn"></a>
The Amazon Resource Name (ARN) of the target.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `1600`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DeadLetterConfig`  <a name="cfn-scheduler-schedule-target-deadletterconfig"></a>
An object that contains information about an Amazon SQS queue that EventBridge Scheduler uses as a dead-letter queue for your schedule. If specified, EventBridge Scheduler delivers failed events that could not be successfully delivered to a target to the queue.  
*Required*: No  
*Type*: [DeadLetterConfig](aws-properties-scheduler-schedule-deadletterconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`EcsParameters`  <a name="cfn-scheduler-schedule-target-ecsparameters"></a>
The templated target type for the Amazon ECS [https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html) API operation.  
*Required*: No  
*Type*: [EcsParameters](aws-properties-scheduler-schedule-ecsparameters.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`EventBridgeParameters`  <a name="cfn-scheduler-schedule-target-eventbridgeparameters"></a>
The templated target type for the EventBridge [https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutEvents.html](https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutEvents.html) API operation.  
*Required*: No  
*Type*: [EventBridgeParameters](aws-properties-scheduler-schedule-eventbridgeparameters.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Input`  <a name="cfn-scheduler-schedule-target-input"></a>
The text, or well-formed JSON, passed to the target. If you are configuring a templated Lambda, AWS Step Functions, or Amazon EventBridge target, the input must be a well-formed JSON. For all other target types, a JSON is not required. If you do not specify anything for this field, Amazon EventBridge Scheduler delivers a default notification to the target.  
*Required*: No  
*Type*: String  
*Minimum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`KinesisParameters`  <a name="cfn-scheduler-schedule-target-kinesisparameters"></a>
The templated target type for the Amazon Kinesis [https://docs.aws.amazon.com/kinesis/latest/APIReference/API_PutRecord.html](https://docs.aws.amazon.com/kinesis/latest/APIReference/API_PutRecord.html) API operation.  
*Required*: No  
*Type*: [KinesisParameters](aws-properties-scheduler-schedule-kinesisparameters.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`RetryPolicy`  <a name="cfn-scheduler-schedule-target-retrypolicy"></a>
A `RetryPolicy` object that includes information about the retry policy settings, including the maximum age of an event, and the maximum number of times EventBridge Scheduler will try to deliver the event to a target.  
*Required*: No  
*Type*: [RetryPolicy](aws-properties-scheduler-schedule-retrypolicy.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`RoleArn`  <a name="cfn-scheduler-schedule-target-rolearn"></a>
The Amazon Resource Name (ARN) of the IAM role that EventBridge Scheduler will use for this target when the schedule is invoked.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^arn:aws[a-z-]*:iam::\d{12}:role\/[\w+=,.@\/-]+$`  
*Minimum*: `1`  
*Maximum*: `1600`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SageMakerPipelineParameters`  <a name="cfn-scheduler-schedule-target-sagemakerpipelineparameters"></a>
The templated target type for the Amazon SageMaker [https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_StartPipelineExecution.html](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_StartPipelineExecution.html) API operation.  
*Required*: No  
*Type*: [SageMakerPipelineParameters](aws-properties-scheduler-schedule-sagemakerpipelineparameters.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SqsParameters`  <a name="cfn-scheduler-schedule-target-sqsparameters"></a>
The templated target type for the Amazon SQS [https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_SendMessage.html](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_SendMessage.html) API operation. Contains the message group ID to use when the target is a FIFO queue. If you specify an Amazon SQS FIFO queue as a target, the queue must have content-based deduplication enabled. For more information, see [Using the Amazon SQS message deduplication ID](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagededuplicationid-property.html) in the *Amazon SQS Developer Guide*.  
*Required*: No  
*Type*: [SqsParameters](aws-properties-scheduler-schedule-sqsparameters.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)