software.amazon.awscdk.services.appflow

Interface CfnFlow.ScheduledTriggerPropertiesProperty

All Known Implementing Classes:

CfnFlow.ScheduledTriggerPropertiesProperty.Jsii$Proxy

Enclosing class:

CfnFlow

public static interface 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 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();
 

Nested Class Summary

Nested Classes

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

Method Summary

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

Method Detail

getScheduleExpression

java.lang.String getScheduleExpression()

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

getDataPullMode

default java.lang.String getDataPullMode()

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

getFirstExecutionFrom

default java.lang.Number getFirstExecutionFrom()

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

getFlowErrorDeactivationThreshold

default java.lang.Number getFlowErrorDeactivationThreshold()

`CfnFlow.ScheduledTriggerPropertiesProperty.FlowErrorDeactivationThreshold`.

getScheduleEndTime

default java.lang.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 .

getScheduleOffset

default java.lang.Number getScheduleOffset()

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

getScheduleStartTime

default java.lang.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 .

getTimeZone

default java.lang.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 .

builder

static CfnFlow.ScheduledTriggerPropertiesProperty.Builder builder()

Returns:

a CfnFlow.ScheduledTriggerPropertiesProperty.Builder of CfnFlow.ScheduledTriggerPropertiesProperty