Class CfnFlow.ScheduledTriggerPropertiesProperty
Specifies the configuration details of a schedule-triggered flow as defined by the user.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.AppFlow
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class ScheduledTriggerPropertiesProperty : Object, CfnFlow.IScheduledTriggerPropertiesProperty
Syntax (vb)
Public Class ScheduledTriggerPropertiesProperty
Inherits Object
Implements CfnFlow.IScheduledTriggerPropertiesProperty
Remarks
Currently, these settings only apply to the Scheduled
trigger type.
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.AppFlow;
var scheduledTriggerPropertiesProperty = new ScheduledTriggerPropertiesProperty {
ScheduleExpression = "scheduleExpression",
// the properties below are optional
DataPullMode = "dataPullMode",
FirstExecutionFrom = 123,
FlowErrorDeactivationThreshold = 123,
ScheduleEndTime = 123,
ScheduleOffset = 123,
ScheduleStartTime = 123,
TimeZone = "timeZone"
};
Synopsis
Constructors
ScheduledTriggerPropertiesProperty() |
Properties
DataPullMode | Specifies whether a scheduled flow has an incremental data transfer or a complete data transfer for each flow run. |
FirstExecutionFrom | Specifies the date range for the records to import from the connector in the first flow run. |
FlowErrorDeactivationThreshold | Defines how many times a scheduled flow fails consecutively before Amazon AppFlow deactivates it. |
ScheduleEndTime | The time at which the scheduled flow ends. |
ScheduleExpression | The scheduling expression that determines the rate at which the schedule will run, for example |
ScheduleOffset | Specifies the optional offset that is added to the time interval for a schedule-triggered flow. |
ScheduleStartTime | The time at which the scheduled flow starts. |
TimeZone | Specifies the time zone used when referring to the dates and times of a scheduled flow, such as |
Constructors
ScheduledTriggerPropertiesProperty()
public ScheduledTriggerPropertiesProperty()
Properties
DataPullMode
Specifies whether a scheduled flow has an incremental data transfer or a complete data transfer for each flow run.
public string DataPullMode { get; set; }
Property Value
System.String
Remarks
FirstExecutionFrom
Specifies the date range for the records to import from the connector in the first flow run.
public Nullable<double> FirstExecutionFrom { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
FlowErrorDeactivationThreshold
Defines how many times a scheduled flow fails consecutively before Amazon AppFlow deactivates it.
public Nullable<double> FlowErrorDeactivationThreshold { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
ScheduleEndTime
The time at which the scheduled flow ends.
public Nullable<double> ScheduleEndTime { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
The time is formatted as a timestamp that follows the ISO 8601 standard, such as 2022-04-27T13:00:00-07:00
.
ScheduleExpression
The scheduling expression that determines the rate at which the schedule will run, for example rate(5minutes)
.
public string ScheduleExpression { get; set; }
Property Value
System.String
Remarks
ScheduleOffset
Specifies the optional offset that is added to the time interval for a schedule-triggered flow.
public Nullable<double> ScheduleOffset { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
ScheduleStartTime
The time at which the scheduled flow starts.
public Nullable<double> ScheduleStartTime { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
The time is formatted as a timestamp that follows the ISO 8601 standard, such as 2022-04-26T13:00:00-07:00
.
TimeZone
Specifies the time zone used when referring to the dates and times of a scheduled flow, such as America/New_York
.
public string TimeZone { get; set; }
Property Value
System.String
Remarks
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
.