Struct ScheduledTriggerProperties

#[non_exhaustive]
pub struct ScheduledTriggerProperties {
    pub schedule_expression: String,
    pub data_pull_mode: Option<DataPullMode>,
    pub schedule_start_time: Option<DateTime>,
    pub schedule_end_time: Option<DateTime>,
    pub timezone: Option<String>,
    pub schedule_offset: Option<i64>,
    pub first_execution_from: Option<DateTime>,
    pub flow_error_deactivation_threshold: Option<i32>,
}

Specifies the configuration details of a schedule-triggered flow as defined by the user. Currently, these settings only apply to the Scheduled trigger type.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

schedule_expression: String

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

data_pull_mode: Option<DataPullMode>

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

schedule_start_time: Option<DateTime>

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.

schedule_end_time: Option<DateTime>

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.

timezone: Option<String>

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.

schedule_offset: Option<i64>

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

first_execution_from: Option<DateTime>

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

flow_error_deactivation_threshold: Option<i32>

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

Implementations

impl ScheduledTriggerProperties

pub fn schedule_expression(&self) -> &str

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

pub fn data_pull_mode(&self) -> Option<&DataPullMode>

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

pub fn schedule_start_time(&self) -> Option<&DateTime>

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.

pub fn schedule_end_time(&self) -> Option<&DateTime>

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.

pub fn timezone(&self) -> Option<&str>

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.

pub fn schedule_offset(&self) -> Option<i64>

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

pub fn first_execution_from(&self) -> Option<&DateTime>

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

pub fn flow_error_deactivation_threshold(&self) -> Option<i32>

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

impl ScheduledTriggerProperties

pub fn builder() -> ScheduledTriggerPropertiesBuilder

Creates a new builder-style object to manufacture ScheduledTriggerProperties.

Trait Implementations

impl Clone for ScheduledTriggerProperties

fn clone(&self) -> ScheduledTriggerProperties

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ScheduledTriggerProperties

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for ScheduledTriggerProperties

fn eq(&self, other: &ScheduledTriggerProperties) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ScheduledTriggerProperties