software.amazon.awscdk.services.customerprofiles

Interface CfnIntegration.ScheduledTriggerPropertiesProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnIntegration.ScheduledTriggerPropertiesProperty.Jsii$Proxy

Enclosing class:

CfnIntegration

@Stability(value=Stable)
public static interface CfnIntegration.ScheduledTriggerPropertiesProperty
extends software.amazon.jsii.JsiiSerializable

Specifies the configuration details of a scheduled-trigger flow that you define.

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.customerprofiles.*;
 ScheduledTriggerPropertiesProperty scheduledTriggerPropertiesProperty = ScheduledTriggerPropertiesProperty.builder()
         .scheduleExpression("scheduleExpression")
         // the properties below are optional
         .dataPullMode("dataPullMode")
         .firstExecutionFrom(123)
         .scheduleEndTime(123)
         .scheduleOffset(123)
         .scheduleStartTime(123)
         .timezone("timezone")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnIntegration.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	getScheduleEndTime() Specifies the scheduled end time for a scheduled-trigger flow.
String	getScheduleExpression() The scheduling expression that determines the rate at which the schedule will run, for example rate (5 minutes).
default Number	getScheduleOffset() Specifies the optional offset that is added to the time interval for a schedule-triggered flow.
default Number	getScheduleStartTime() Specifies the scheduled start time for a scheduled-trigger flow.
default String	getTimezone() Specifies the time zone used when referring to the date and time of a scheduled-triggered flow, such as America/New_York.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getScheduleExpression

@Stability(value=Stable)
 @NotNull
String getScheduleExpression()

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

getDataPullMode

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

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

getFirstExecutionFrom

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

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

getScheduleEndTime

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

Specifies the scheduled end time for a scheduled-trigger flow.

getScheduleOffset

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

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

getScheduleStartTime

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

Specifies the scheduled start time for a scheduled-trigger flow.

getTimezone

@Stability(value=Stable)
 @Nullable
default String getTimezone()

Specifies the time zone used when referring to the date and time of a scheduled-triggered flow, such as America/New_York.

builder

@Stability(value=Stable)
static CfnIntegration.ScheduledTriggerPropertiesProperty.Builder builder()

Returns:

a CfnIntegration.ScheduledTriggerPropertiesProperty.Builder of CfnIntegration.ScheduledTriggerPropertiesProperty