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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
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.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#data_pull_mode ⇒ String

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

Returns:

  • (String) 


3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
 
# File 'lib/aws-sdk-appflow/types.rb', line 3809

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_from ⇒ Time

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

Returns:

  • (Time) 


3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
 
# File 'lib/aws-sdk-appflow/types.rb', line 3809

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_time ⇒ Time

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

Returns:

  • (Time) 


3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
 
# File 'lib/aws-sdk-appflow/types.rb', line 3809

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_expression ⇒ String

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

Returns:

  • (String) 


3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
 
# File 'lib/aws-sdk-appflow/types.rb', line 3809

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_offset ⇒ Integer

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

Returns:

  • (Integer) 


3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
 
# File 'lib/aws-sdk-appflow/types.rb', line 3809

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_time ⇒ Time

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

Returns:

  • (Time) 


3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
 
# File 'lib/aws-sdk-appflow/types.rb', line 3809

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

#timezone ⇒ String

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

Returns:

  • (String) 


3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
 
# File 'lib/aws-sdk-appflow/types.rb', line 3809

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