aws-cdk-lib.aws_customerprofiles.CfnIntegration.ScheduledTriggerPropertiesProperty

ScheduledTriggerPropertiesProperty Struct

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

Currently, these settings only apply to the scheduled-trigger type.

Source

Generated code

Type last changed

v2.93.0 · 23 Aug 2023

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_customerprofiles as customerprofiles } from 'aws-cdk-lib';
const scheduledTriggerPropertiesProperty: customerprofiles.CfnIntegration.ScheduledTriggerPropertiesProperty = {
  scheduleExpression: 'scheduleExpression',

  // the properties below are optional
  dataPullMode: 'dataPullMode',
  firstExecutionFrom: 123,
  scheduleEndTime: 123,
  scheduleOffset: 123,
  scheduleStartTime: 123,
  timezone: 'timezone',
};

Properties

dataPullModestringdata_pull_modestrdataPullModeStringDataPullModestringDataPullMode*string#

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

firstExecutionFromnumberfirst_execution_fromint | floatfirstExecutionFromNumberFirstExecutionFromdoubleFirstExecutionFrom*float64#

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

scheduleEndTimenumberschedule_end_timeint | floatscheduleEndTimeNumberScheduleEndTimedoubleScheduleEndTime*float64#

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

scheduleExpressionstringschedule_expressionstrscheduleExpressionStringScheduleExpressionstringScheduleExpression*stringrequired#

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

scheduleOffsetnumberschedule_offsetint | floatscheduleOffsetNumberScheduleOffsetdoubleScheduleOffset*float64#

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

scheduleStartTimenumberschedule_start_timeint | floatscheduleStartTimeNumberScheduleStartTimedoubleScheduleStartTime*float64#

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

The value must be a date/time value in EPOCH format.

timezonestringtimezonestrtimezoneStringTimezonestringTimezone*string#

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