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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb

Overview

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#schedule_expressionString

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 .

Returns:

  • (String)


5928
5929
5930
5931
5932
5933
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 5928

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

#statusString

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.

Returns:

  • (String)


5928
5929
5930
5931
5932
5933
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 5928

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