Documentation

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: newScheduledTriggerProperties smart constructor.

Create a value of ScheduledTriggerProperties with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:dataPullMode:ScheduledTriggerProperties', scheduledTriggerProperties_dataPullMode - Specifies whether a scheduled flow has an incremental data transfer or a complete data transfer for each flow run.

$sel:firstExecutionFrom:ScheduledTriggerProperties', scheduledTriggerProperties_firstExecutionFrom - Specifies the date range for the records to import from the connector in the first flow run.

$sel:flowErrorDeactivationThreshold:ScheduledTriggerProperties', scheduledTriggerProperties_flowErrorDeactivationThreshold - Defines how many times a scheduled flow fails consecutively before Amazon AppFlow deactivates it.

$sel:scheduleEndTime:ScheduledTriggerProperties', scheduledTriggerProperties_scheduleEndTime - 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.

$sel:scheduleOffset:ScheduledTriggerProperties', scheduledTriggerProperties_scheduleOffset - Specifies the optional offset that is added to the time interval for a schedule-triggered flow.

$sel:scheduleStartTime:ScheduledTriggerProperties', scheduledTriggerProperties_scheduleStartTime - 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.

$sel:timezone:ScheduledTriggerProperties', scheduledTriggerProperties_timezone - 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.

$sel:scheduleExpression:ScheduledTriggerProperties', scheduledTriggerProperties_scheduleExpression - The scheduling expression that determines the rate at which the schedule will run, for example rate(5minutes).

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

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

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

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.

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

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.

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.

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