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,
  flow_error_deactivation_threshold: 1,
}

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)


5737
5738
5739
5740
5741
5742
5743
5744
5745
5746
5747
5748
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 5737

class ScheduledTriggerProperties < Struct.new(
  :schedule_expression,
  :data_pull_mode,
  :schedule_start_time,
  :schedule_end_time,
  :timezone,
  :schedule_offset,
  :first_execution_from,
  :flow_error_deactivation_threshold)
  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)


5737
5738
5739
5740
5741
5742
5743
5744
5745
5746
5747
5748
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 5737

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

#flow_error_deactivation_thresholdInteger

Defines how many times a scheduled flow fails consecutively before Amazon AppFlow deactivates it.

Returns:

  • (Integer)


5737
5738
5739
5740
5741
5742
5743
5744
5745
5746
5747
5748
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 5737

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

#schedule_end_timeTime

The time at which the scheduled flow ends. The time is formatted as a timestamp that follows the ISO 8601 standard, such as 2022-04-27T13:00:00-07:00.

Returns:

  • (Time)


5737
5738
5739
5740
5741
5742
5743
5744
5745
5746
5747
5748
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 5737

class ScheduledTriggerProperties < Struct.new(
  :schedule_expression,
  :data_pull_mode,
  :schedule_start_time,
  :schedule_end_time,
  :timezone,
  :schedule_offset,
  :first_execution_from,
  :flow_error_deactivation_threshold)
  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)


5737
5738
5739
5740
5741
5742
5743
5744
5745
5746
5747
5748
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 5737

class ScheduledTriggerProperties < Struct.new(
  :schedule_expression,
  :data_pull_mode,
  :schedule_start_time,
  :schedule_end_time,
  :timezone,
  :schedule_offset,
  :first_execution_from,
  :flow_error_deactivation_threshold)
  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)


5737
5738
5739
5740
5741
5742
5743
5744
5745
5746
5747
5748
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 5737

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

#schedule_start_timeTime

The time at which the scheduled flow starts. The time is formatted as a timestamp that follows the ISO 8601 standard, such as 2022-04-26T13:00:00-07:00.

Returns:

  • (Time)


5737
5738
5739
5740
5741
5742
5743
5744
5745
5746
5747
5748
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 5737

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

#timezoneString

Specifies the time zone used when referring to the dates and times of a scheduled flow, such as America/New_York. This time zone is only a descriptive label. It doesn't affect how Amazon AppFlow interprets the timestamps that you specify to schedule the flow.

If you want to schedule a flow by using times in a particular time zone, indicate the time zone as a UTC offset in your timestamps. For example, the UTC offsets for the America/New_York timezone are -04:00 EDT and -05:00 EST.

Returns:

  • (String)


5737
5738
5739
5740
5741
5742
5743
5744
5745
5746
5747
5748
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 5737

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