Class: Aws::Appflow::Types::ScheduledTriggerProperties

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

Overview

Note:

When making an API call, you may pass ScheduledTriggerProperties data as a hash:

{
  schedule_expression: "ScheduleExpression", # required
  data_pull_mode: "Incremental", # accepts Incremental, Complete
  schedule_start_time: Time.now,
  schedule_end_time: Time.now,
  timezone: "Timezone",
  schedule_offset: 1,
  first_execution_from: Time.now,
}

Specifies the configuration details of a schedule-triggered flow as defined by the user. Currently, these settings only apply to the Scheduled trigger type.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#data_pull_modeString

Specifies whether a scheduled flow has an incremental data transfer or a complete data transfer for each flow run.

Returns:

  • (String)


4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 4237

class ScheduledTriggerProperties < Struct.new(
  :schedule_expression,
  :data_pull_mode,
  :schedule_start_time,
  :schedule_end_time,
  :timezone,
  :schedule_offset,
  :first_execution_from)
  SENSITIVE = []
  include Aws::Structure
end

#first_execution_fromTime

Specifies the date range for the records to import from the connector in the first flow run.

Returns:

  • (Time)


4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 4237

class ScheduledTriggerProperties < Struct.new(
  :schedule_expression,
  :data_pull_mode,
  :schedule_start_time,
  :schedule_end_time,
  :timezone,
  :schedule_offset,
  :first_execution_from)
  SENSITIVE = []
  include Aws::Structure
end

#schedule_end_timeTime

Specifies the scheduled end time for a schedule-triggered flow.

Returns:

  • (Time)


4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 4237

class ScheduledTriggerProperties < Struct.new(
  :schedule_expression,
  :data_pull_mode,
  :schedule_start_time,
  :schedule_end_time,
  :timezone,
  :schedule_offset,
  :first_execution_from)
  SENSITIVE = []
  include Aws::Structure
end

#schedule_expressionString

The scheduling expression that determines the rate at which the schedule will run, for example rate(5minutes).

Returns:

  • (String)


4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 4237

class ScheduledTriggerProperties < Struct.new(
  :schedule_expression,
  :data_pull_mode,
  :schedule_start_time,
  :schedule_end_time,
  :timezone,
  :schedule_offset,
  :first_execution_from)
  SENSITIVE = []
  include Aws::Structure
end

#schedule_offsetInteger

Specifies the optional offset that is added to the time interval for a schedule-triggered flow.

Returns:

  • (Integer)


4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 4237

class ScheduledTriggerProperties < Struct.new(
  :schedule_expression,
  :data_pull_mode,
  :schedule_start_time,
  :schedule_end_time,
  :timezone,
  :schedule_offset,
  :first_execution_from)
  SENSITIVE = []
  include Aws::Structure
end

#schedule_start_timeTime

Specifies the scheduled start time for a schedule-triggered flow.

Returns:

  • (Time)


4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 4237

class ScheduledTriggerProperties < Struct.new(
  :schedule_expression,
  :data_pull_mode,
  :schedule_start_time,
  :schedule_end_time,
  :timezone,
  :schedule_offset,
  :first_execution_from)
  SENSITIVE = []
  include Aws::Structure
end

#timezoneString

Specifies the time zone used when referring to the date and time of a scheduled-triggered flow, such as America/New_York.

Returns:

  • (String)


4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 4237

class ScheduledTriggerProperties < Struct.new(
  :schedule_expression,
  :data_pull_mode,
  :schedule_start_time,
  :schedule_end_time,
  :timezone,
  :schedule_offset,
  :first_execution_from)
  SENSITIVE = []
  include Aws::Structure
end