Class: Aws::DataSync::Types::TaskSchedule

Inherits:

Struct

Object
Struct
Aws::DataSync::Types::TaskSchedule

show all

Includes:: Structure

Defined in:: lib/aws-sdk-datasync/types.rb

Overview

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

[1]: docs.aws.amazon.com/datasync/latest/userguide/task-scheduling.html

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#schedule_expression ⇒ String

Specifies your task schedule by using a cron or rate expression.
#status ⇒ String

Specifies whether to enable or disable your task schedule.

Instance Attribute Details

#schedule_expression ⇒ `String`

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* ][1].

[1]: docs.aws.amazon.com/eventbridge/latest/userguide/eb-scheduled-rule-pattern.html

Returns:

(String)

# File 'lib/aws-sdk-datasync/types.rb', line 5928

class TaskSchedule < Struct.new(
  :schedule_expression,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ `String`

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 pause a recurring transfer to fix an issue with your task or perform maintenance on your storage system.

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

[1]: docs.aws.amazon.com/datasync/latest/userguide/API_TaskScheduleDetails.html