Amazonka.AppFlow.Types.ScheduledTriggerProperties

Documentation

data ScheduledTriggerProperties

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

See: newScheduledTriggerProperties smart constructor.

Constructors

ScheduledTriggerProperties'

Fields

• dataPullMode :: Maybe DataPullMode

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

• firstExecutionFrom :: Maybe POSIX

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

• flowErrorDeactivationThreshold :: Maybe Natural

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

• scheduleEndTime :: Maybe POSIX

  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.

• scheduleOffset :: Maybe Natural

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

• scheduleStartTime :: Maybe POSIX

  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.

• timezone :: Maybe Text

  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.

• scheduleExpression :: Text

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

Instances

FromJSON ScheduledTriggerProperties

Defined in Amazonka.AppFlow.Types.ScheduledTriggerProperties

Methods

parseJSON :: Value -> Parser ScheduledTriggerProperties

parseJSONList :: Value -> Parser [ScheduledTriggerProperties]

ToJSON ScheduledTriggerProperties

Defined in Amazonka.AppFlow.Types.ScheduledTriggerProperties

Methods

toJSON :: ScheduledTriggerProperties -> Value

toEncoding :: ScheduledTriggerProperties -> Encoding

toJSONList :: [ScheduledTriggerProperties] -> Value

toEncodingList :: [ScheduledTriggerProperties] -> Encoding

Generic ScheduledTriggerProperties

Defined in Amazonka.AppFlow.Types.ScheduledTriggerProperties

Associated Types

type Rep ScheduledTriggerProperties :: Type -> Type

Methods

from :: ScheduledTriggerProperties -> Rep ScheduledTriggerProperties x

to :: Rep ScheduledTriggerProperties x -> ScheduledTriggerProperties

Read ScheduledTriggerProperties

Defined in Amazonka.AppFlow.Types.ScheduledTriggerProperties

Methods

readsPrec :: Int -> ReadS ScheduledTriggerProperties

readList :: ReadS [ScheduledTriggerProperties]

readPrec :: ReadPrec ScheduledTriggerProperties

readListPrec :: ReadPrec [ScheduledTriggerProperties]

Show ScheduledTriggerProperties

Defined in Amazonka.AppFlow.Types.ScheduledTriggerProperties

Methods

showsPrec :: Int -> ScheduledTriggerProperties -> ShowS

show :: ScheduledTriggerProperties -> String

showList :: [ScheduledTriggerProperties] -> ShowS

NFData ScheduledTriggerProperties

Defined in Amazonka.AppFlow.Types.ScheduledTriggerProperties

Methods

rnf :: ScheduledTriggerProperties -> ()

Eq ScheduledTriggerProperties

Defined in Amazonka.AppFlow.Types.ScheduledTriggerProperties

Methods

(==) :: ScheduledTriggerProperties -> ScheduledTriggerProperties -> Bool

(/=) :: ScheduledTriggerProperties -> ScheduledTriggerProperties -> Bool

Hashable ScheduledTriggerProperties

Defined in Amazonka.AppFlow.Types.ScheduledTriggerProperties

Methods

hashWithSalt :: Int -> ScheduledTriggerProperties -> Int

hash :: ScheduledTriggerProperties -> Int

type Rep ScheduledTriggerProperties

Defined in Amazonka.AppFlow.Types.ScheduledTriggerProperties

type Rep ScheduledTriggerProperties = D1 ('MetaData "ScheduledTriggerProperties" "Amazonka.AppFlow.Types.ScheduledTriggerProperties" "amazonka-appflow-2.0-3aJWKTszi6ZKDtrkFSqVAB" 'False) (C1 ('MetaCons "ScheduledTriggerProperties'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "dataPullMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DataPullMode)) :*: S1 ('MetaSel ('Just "firstExecutionFrom") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :*: (S1 ('MetaSel ('Just "flowErrorDeactivationThreshold") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "scheduleEndTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :*: ((S1 ('MetaSel ('Just "scheduleOffset") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "scheduleStartTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :*: (S1 ('MetaSel ('Just "timezone") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "scheduleExpression") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newScheduledTriggerProperties

Arguments

:: Text

$sel:scheduleExpression:ScheduledTriggerProperties'

-> ScheduledTriggerProperties

Create a value of ScheduledTriggerProperties with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:dataPullMode:ScheduledTriggerProperties', scheduledTriggerProperties_dataPullMode - Specifies whether a scheduled flow has an incremental data transfer or a complete data transfer for each flow run.

$sel:firstExecutionFrom:ScheduledTriggerProperties', scheduledTriggerProperties_firstExecutionFrom - Specifies the date range for the records to import from the connector in the first flow run.

$sel:flowErrorDeactivationThreshold:ScheduledTriggerProperties', scheduledTriggerProperties_flowErrorDeactivationThreshold - Defines how many times a scheduled flow fails consecutively before Amazon AppFlow deactivates it.

$sel:scheduleEndTime:ScheduledTriggerProperties', scheduledTriggerProperties_scheduleEndTime - 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.

$sel:scheduleOffset:ScheduledTriggerProperties', scheduledTriggerProperties_scheduleOffset - Specifies the optional offset that is added to the time interval for a schedule-triggered flow.

$sel:scheduleStartTime:ScheduledTriggerProperties', scheduledTriggerProperties_scheduleStartTime - 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.

$sel:timezone:ScheduledTriggerProperties', scheduledTriggerProperties_timezone - 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.

$sel:scheduleExpression:ScheduledTriggerProperties', scheduledTriggerProperties_scheduleExpression - The scheduling expression that determines the rate at which the schedule will run, for example rate(5minutes).

scheduledTriggerProperties_dataPullMode :: Lens' ScheduledTriggerProperties (Maybe DataPullMode)

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

scheduledTriggerProperties_firstExecutionFrom :: Lens' ScheduledTriggerProperties (Maybe UTCTime)

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

scheduledTriggerProperties_flowErrorDeactivationThreshold :: Lens' ScheduledTriggerProperties (Maybe Natural)

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

scheduledTriggerProperties_scheduleEndTime :: Lens' ScheduledTriggerProperties (Maybe UTCTime)

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.

scheduledTriggerProperties_scheduleOffset :: Lens' ScheduledTriggerProperties (Maybe Natural)

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

scheduledTriggerProperties_scheduleStartTime :: Lens' ScheduledTriggerProperties (Maybe UTCTime)

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.

scheduledTriggerProperties_timezone :: Lens' ScheduledTriggerProperties (Maybe Text)

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.

scheduledTriggerProperties_scheduleExpression :: Lens' ScheduledTriggerProperties Text

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