AWS::DataSync::Task TaskSchedule - AWS CloudFormation
SyntaxProperties

AWS::DataSync::Task TaskSchedule

Configures your AWS DataSync task to run on a schedule (at a minimum interval of 1 hour).

Syntax

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

JSON

{
  "ScheduleExpression" : String,
  "Status" : String
}

YAML

  ScheduleExpression: String
  Status: String

Properties

ScheduleExpression

Specifies your task schedule by using a cron or rate expression.

Use cron expressions for task schedules that run on a specific time and day. For example, the following cron expression creates a task schedule that runs at 8 AM on the first Wednesday of every month:

cron(0 8 * * 3#1)

Use rate expressions for task schedules that run on a regular interval. For example, the following rate expression creates a task schedule that runs every 12 hours:

rate(12 hours)

For information about cron and rate expression syntax, see the Amazon EventBridge User Guide.

Required: No

Type: String

Pattern: ^[a-zA-Z0-9\ \_\*\?\,\|\^\-\/\#\s\(\)\+]*$

Maximum: 256

Update requires: No interruption

Status

Specifies whether to enable or disable your task schedule. Your schedule is enabled by default, but there can be situations where you need to disable it. For example, you might need to perform maintenance on a storage system before you can begin a recurring DataSync transfer.

DataSync might disable your schedule automatically if your task fails repeatedly with the same error. For more information, see the DataSync User Guide.

Required: No

Type: String

Allowed values: ENABLED | DISABLED

Update requires: No interruption