interface ScheduledTriggerPropertiesProperty
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.AppFlow.CfnFlow.ScheduledTriggerPropertiesProperty |
 Go | github.com/aws/aws-cdk-go/awscdk/v2/awsappflow#CfnFlow_ScheduledTriggerPropertiesProperty |
 Java | software.amazon.awscdk.services.appflow.CfnFlow.ScheduledTriggerPropertiesProperty |
 Python | aws_cdk.aws_appflow.CfnFlow.ScheduledTriggerPropertiesProperty |
 TypeScript | aws-cdk-lib » aws_appflow » CfnFlow » ScheduledTriggerPropertiesProperty |
Specifies the configuration details of a schedule-triggered flow as defined by the user.
Currently, these settings only apply to the Scheduled trigger type.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_appflow as appflow } from 'aws-cdk-lib';
const scheduledTriggerPropertiesProperty: appflow.CfnFlow.ScheduledTriggerPropertiesProperty = {
scheduleExpression: 'scheduleExpression',
// the properties below are optional
dataPullMode: 'dataPullMode',
firstExecutionFrom: 123,
flowErrorDeactivationThreshold: 123,
scheduleEndTime: 123,
scheduleOffset: 123,
scheduleStartTime: 123,
timeZone: 'timeZone',
};
Properties
| Name | Type | Description |
|---|---|---|
| schedule | string | The scheduling expression that determines the rate at which the schedule will run, for example rate(5minutes) . |
| data | string | Specifies whether a scheduled flow has an incremental data transfer or a complete data transfer for each flow run. |
| first | number | Specifies the date range for the records to import from the connector in the first flow run. |
| flow | number | Defines how many times a scheduled flow fails consecutively before Amazon AppFlow deactivates it. |
| schedule | number | The time at which the scheduled flow ends. |
| schedule | number | Specifies the optional offset that is added to the time interval for a schedule-triggered flow. |
| schedule | number | The time at which the scheduled flow starts. |
| time | string | Specifies the time zone used when referring to the dates and times of a scheduled flow, such as America/New_York . |
scheduleExpression
Type:
string
The scheduling expression that determines the rate at which the schedule will run, for example rate(5minutes) .
dataPullMode?
Type:
string
(optional)
Specifies whether a scheduled flow has an incremental data transfer or a complete data transfer for each flow run.
firstExecutionFrom?
Type:
number
(optional)
Specifies the date range for the records to import from the connector in the first flow run.
flowErrorDeactivationThreshold?
Type:
number
(optional)
Defines how many times a scheduled flow fails consecutively before Amazon AppFlow deactivates it.
scheduleEndTime?
Type:
number
(optional)
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 .
scheduleOffset?
Type:
number
(optional)
Specifies the optional offset that is added to the time interval for a schedule-triggered flow.
scheduleStartTime?
Type:
number
(optional)
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 .
timeZone?
Type:
string
(optional)
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 .