AWS::AppFlow::Flow ScheduledTriggerProperties - AWS CloudFormation
SyntaxPropertiesSee also

AWS::AppFlow::Flow ScheduledTriggerProperties

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

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "DataPullMode" : String,
  "FirstExecutionFrom" : Number,
  "FlowErrorDeactivationThreshold" : Integer,
  "ScheduleEndTime" : Number,
  "ScheduleExpression" : String,
  "ScheduleOffset" : Number,
  "ScheduleStartTime" : Number,
  "TimeZone" : String
}

Properties

DataPullMode

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

Required: No

Type: String

Allowed values: Incremental | Complete

Update requires: No interruption

FirstExecutionFrom

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

Required: No

Type: Number

Update requires: No interruption

FlowErrorDeactivationThreshold

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

Required: No

Type: Integer

Minimum: 1

Maximum: 100

Update requires: No interruption

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.

Required: No

Type: Number

Update requires: No interruption

ScheduleExpression

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

Required: Yes

Type: String

Minimum: 1

Maximum: 256

Update requires: No interruption

ScheduleOffset

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

Required: No

Type: Number

Minimum: 0

Maximum: 36000

Update requires: No interruption

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.

Required: No

Type: Number

Update requires: No interruption

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.

Required: No

Type: String

Maximum: 256

Update requires: No interruption

See also