Package software.amazon.awscdk.services.appflow

Interface CfnFlow.ScheduledTriggerPropertiesProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnFlow.ScheduledTriggerPropertiesProperty.Jsii$Proxy

Enclosing class:

CfnFlow

@Stability(Stable)
public static interface CfnFlow.ScheduledTriggerPropertiesProperty
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.appflow.*;
 ScheduledTriggerPropertiesProperty scheduledTriggerPropertiesProperty = ScheduledTriggerPropertiesProperty.builder()
         .scheduleExpression("scheduleExpression")
         // the properties below are optional
         .dataPullMode("dataPullMode")
         .firstExecutionFrom(123)
         .flowErrorDeactivationThreshold(123)
         .scheduleEndTime(123)
         .scheduleOffset(123)
         .scheduleStartTime(123)
         .timeZone("timeZone")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-scheduledtriggerproperties.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnFlow.ScheduledTriggerPropertiesProperty.Builder	A builder for CfnFlow.ScheduledTriggerPropertiesProperty
static final class	CfnFlow.ScheduledTriggerPropertiesProperty.Jsii$Proxy	An implementation for CfnFlow.ScheduledTriggerPropertiesProperty

Method Summary

Modifier and Type	Method	Description
static CfnFlow.ScheduledTriggerPropertiesProperty.Builder	builder()
default String	getDataPullMode()	Specifies whether a scheduled flow has an incremental data transfer or a complete data transfer for each flow run.
default Number	getFirstExecutionFrom()	Specifies the date range for the records to import from the connector in the first flow run.
default Number	getFlowErrorDeactivationThreshold()	Defines how many times a scheduled flow fails consecutively before Amazon AppFlow deactivates it.
default Number	getScheduleEndTime()	The time at which the scheduled flow ends.
String	getScheduleExpression()	The scheduling expression that determines the rate at which the schedule will run, for example rate(5minutes) .
default Number	getScheduleOffset()	Specifies the optional offset that is added to the time interval for a schedule-triggered flow.
default Number	getScheduleStartTime()	The time at which the scheduled flow starts.
default String	getTimeZone()	Specifies the time zone used when referring to the dates and times of a scheduled flow, such as America/New_York .

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getScheduleExpression

@Stability(Stable)
@NotNull
String getScheduleExpression()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-scheduledtriggerproperties.html#cfn-appflow-flow-scheduledtriggerproperties-scheduleexpression

getDataPullMode

@Stability(Stable)
@Nullable
default String getDataPullMode()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-scheduledtriggerproperties.html#cfn-appflow-flow-scheduledtriggerproperties-datapullmode

getFirstExecutionFrom

@Stability(Stable)
@Nullable
default Number getFirstExecutionFrom()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-scheduledtriggerproperties.html#cfn-appflow-flow-scheduledtriggerproperties-firstexecutionfrom

getFlowErrorDeactivationThreshold

@Stability(Stable)
@Nullable
default Number getFlowErrorDeactivationThreshold()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-scheduledtriggerproperties.html#cfn-appflow-flow-scheduledtriggerproperties-flowerrordeactivationthreshold

getScheduleEndTime

@Stability(Stable)
@Nullable
default Number getScheduleEndTime()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-scheduledtriggerproperties.html#cfn-appflow-flow-scheduledtriggerproperties-scheduleendtime

getScheduleOffset

@Stability(Stable)
@Nullable
default Number getScheduleOffset()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-scheduledtriggerproperties.html#cfn-appflow-flow-scheduledtriggerproperties-scheduleoffset

getScheduleStartTime

@Stability(Stable)
@Nullable
default Number getScheduleStartTime()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-scheduledtriggerproperties.html#cfn-appflow-flow-scheduledtriggerproperties-schedulestarttime

getTimeZone

@Stability(Stable)
@Nullable
default String getTimeZone()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-scheduledtriggerproperties.html#cfn-appflow-flow-scheduledtriggerproperties-timezone

builder

@Stability(Stable)
static CfnFlow.ScheduledTriggerPropertiesProperty.Builder builder()

Returns:

a CfnFlow.ScheduledTriggerPropertiesProperty.Builder of CfnFlow.ScheduledTriggerPropertiesProperty