Class CfnFlow.ScheduledTriggerPropertiesProperty.Builder
java.lang.Object
software.amazon.awscdk.services.appflow.CfnFlow.ScheduledTriggerPropertiesProperty.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnFlow.ScheduledTriggerPropertiesProperty>
- Enclosing interface:
CfnFlow.ScheduledTriggerPropertiesProperty
@Stability(Stable)
public static final class CfnFlow.ScheduledTriggerPropertiesProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnFlow.ScheduledTriggerPropertiesProperty>
A builder for
CfnFlow.ScheduledTriggerPropertiesProperty
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds the configured instance.dataPullMode
(String dataPullMode) Sets the value ofCfnFlow.ScheduledTriggerPropertiesProperty.getDataPullMode()
firstExecutionFrom
(Number firstExecutionFrom) Sets the value ofCfnFlow.ScheduledTriggerPropertiesProperty.getFirstExecutionFrom()
flowErrorDeactivationThreshold
(Number flowErrorDeactivationThreshold) scheduleEndTime
(Number scheduleEndTime) Sets the value ofCfnFlow.ScheduledTriggerPropertiesProperty.getScheduleEndTime()
scheduleExpression
(String scheduleExpression) Sets the value ofCfnFlow.ScheduledTriggerPropertiesProperty.getScheduleExpression()
scheduleOffset
(Number scheduleOffset) Sets the value ofCfnFlow.ScheduledTriggerPropertiesProperty.getScheduleOffset()
scheduleStartTime
(Number scheduleStartTime) Sets the value ofCfnFlow.ScheduledTriggerPropertiesProperty.getScheduleStartTime()
Sets the value ofCfnFlow.ScheduledTriggerPropertiesProperty.getTimeZone()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
scheduleExpression
@Stability(Stable) public CfnFlow.ScheduledTriggerPropertiesProperty.Builder scheduleExpression(String scheduleExpression) Sets the value ofCfnFlow.ScheduledTriggerPropertiesProperty.getScheduleExpression()
- Parameters:
scheduleExpression
- The scheduling expression that determines the rate at which the schedule will run, for examplerate(5minutes)
. This parameter is required.- Returns:
this
-
dataPullMode
@Stability(Stable) public CfnFlow.ScheduledTriggerPropertiesProperty.Builder dataPullMode(String dataPullMode) Sets the value ofCfnFlow.ScheduledTriggerPropertiesProperty.getDataPullMode()
- Parameters:
dataPullMode
- Specifies whether a scheduled flow has an incremental data transfer or a complete data transfer for each flow run.- Returns:
this
-
firstExecutionFrom
@Stability(Stable) public CfnFlow.ScheduledTriggerPropertiesProperty.Builder firstExecutionFrom(Number firstExecutionFrom) Sets the value ofCfnFlow.ScheduledTriggerPropertiesProperty.getFirstExecutionFrom()
- Parameters:
firstExecutionFrom
- Specifies the date range for the records to import from the connector in the first flow run.- Returns:
this
-
flowErrorDeactivationThreshold
@Stability(Stable) public CfnFlow.ScheduledTriggerPropertiesProperty.Builder flowErrorDeactivationThreshold(Number flowErrorDeactivationThreshold) - Parameters:
flowErrorDeactivationThreshold
-CfnFlow.ScheduledTriggerPropertiesProperty.FlowErrorDeactivationThreshold
.- Returns:
this
-
scheduleEndTime
@Stability(Stable) public CfnFlow.ScheduledTriggerPropertiesProperty.Builder scheduleEndTime(Number scheduleEndTime) Sets the value ofCfnFlow.ScheduledTriggerPropertiesProperty.getScheduleEndTime()
- Parameters:
scheduleEndTime
- The time at which the scheduled flow ends. The time is formatted as a timestamp that follows the ISO 8601 standard, such as2022-04-27T13:00:00-07:00
.- Returns:
this
-
scheduleOffset
@Stability(Stable) public CfnFlow.ScheduledTriggerPropertiesProperty.Builder scheduleOffset(Number scheduleOffset) Sets the value ofCfnFlow.ScheduledTriggerPropertiesProperty.getScheduleOffset()
- Parameters:
scheduleOffset
- Specifies the optional offset that is added to the time interval for a schedule-triggered flow.- Returns:
this
-
scheduleStartTime
@Stability(Stable) public CfnFlow.ScheduledTriggerPropertiesProperty.Builder scheduleStartTime(Number scheduleStartTime) Sets the value ofCfnFlow.ScheduledTriggerPropertiesProperty.getScheduleStartTime()
- Parameters:
scheduleStartTime
- The time at which the scheduled flow starts. The time is formatted as a timestamp that follows the ISO 8601 standard, such as2022-04-26T13:00:00-07:00
.- Returns:
this
-
timeZone
@Stability(Stable) public CfnFlow.ScheduledTriggerPropertiesProperty.Builder timeZone(String timeZone) Sets the value ofCfnFlow.ScheduledTriggerPropertiesProperty.getTimeZone()
- Parameters:
timeZone
- Specifies the time zone used when referring to the dates and times of a scheduled flow, such asAmerica/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
.- Returns:
this
-
build
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnFlow.ScheduledTriggerPropertiesProperty>
- Returns:
- a new instance of
CfnFlow.ScheduledTriggerPropertiesProperty
- Throws:
NullPointerException
- if any required attribute was not provided
-