Class: AWSCDK::AppFlow::CfnFlow::ScheduledTriggerPropertiesProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
app_flow/cfn_flow.rb

Overview

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 Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(schedule_expression:, data_pull_mode: nil, first_execution_from: nil, flow_error_deactivation_threshold: nil, schedule_end_time: nil, schedule_offset: nil, schedule_start_time: nil, time_zone: nil) ⇒ ScheduledTriggerPropertiesProperty

Returns a new instance of ScheduledTriggerPropertiesProperty.

Parameters:

  • schedule_expression (String) —

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

  • data_pull_mode (String, nil) (defaults to: nil) —

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

  • first_execution_from (Numeric, nil) (defaults to: nil) —

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

  • flow_error_deactivation_threshold (Numeric, nil) (defaults to: nil) —

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

  • schedule_end_time (Numeric, nil) (defaults to: nil) —

    The time at which the scheduled flow ends.

  • schedule_offset (Numeric, nil) (defaults to: nil) —

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

  • schedule_start_time (Numeric, nil) (defaults to: nil) —

    The time at which the scheduled flow starts.

  • time_zone (String, nil) (defaults to: nil) —

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



2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
 
# File 'app_flow/cfn_flow.rb', line 2512

def initialize(schedule_expression:, data_pull_mode: nil, first_execution_from: nil, flow_error_deactivation_threshold: nil, schedule_end_time: nil, schedule_offset: nil, schedule_start_time: nil, time_zone: nil)
  @schedule_expression = schedule_expression
  Jsii::Type.check_type(@schedule_expression, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "scheduleExpression")
  @data_pull_mode = data_pull_mode
  Jsii::Type.check_type(@data_pull_mode, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "dataPullMode") unless @data_pull_mode.nil?
  @first_execution_from = first_execution_from
  Jsii::Type.check_type(@first_execution_from, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "firstExecutionFrom") unless @first_execution_from.nil?
  @flow_error_deactivation_threshold = flow_error_deactivation_threshold
  Jsii::Type.check_type(@flow_error_deactivation_threshold, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "flowErrorDeactivationThreshold") unless @flow_error_deactivation_threshold.nil?
  @schedule_end_time = schedule_end_time
  Jsii::Type.check_type(@schedule_end_time, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "scheduleEndTime") unless @schedule_end_time.nil?
  @schedule_offset = schedule_offset
  Jsii::Type.check_type(@schedule_offset, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "scheduleOffset") unless @schedule_offset.nil?
  @schedule_start_time = schedule_start_time
  Jsii::Type.check_type(@schedule_start_time, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "scheduleStartTime") unless @schedule_start_time.nil?
  @time_zone = time_zone
  Jsii::Type.check_type(@time_zone, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "timeZone") unless @time_zone.nil?
end

Instance Attribute Details

#data_pull_mode ⇒ String? (readonly)

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

Returns:

  • (String, nil)

See Also:



2540
2541
2542
 
# File 'app_flow/cfn_flow.rb', line 2540

def data_pull_mode
  @data_pull_mode
end

#first_execution_from ⇒ Numeric? (readonly)

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

Returns:

  • (Numeric, nil)

See Also:



2545
2546
2547
 
# File 'app_flow/cfn_flow.rb', line 2545

def first_execution_from
  @first_execution_from
end

#flow_error_deactivation_threshold ⇒ Numeric? (readonly)

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

Returns:

  • (Numeric, nil)

See Also:



2550
2551
2552
 
# File 'app_flow/cfn_flow.rb', line 2550

def flow_error_deactivation_threshold
  @flow_error_deactivation_threshold
end

#schedule_end_time ⇒ Numeric? (readonly)

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 .

Returns:

  • (Numeric, nil)

See Also:



2557
2558
2559
 
# File 'app_flow/cfn_flow.rb', line 2557

def schedule_end_time
  @schedule_end_time
end

#schedule_expression ⇒ String (readonly)

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

Returns:

  • (String)

See Also:



2535
2536
2537
 
# File 'app_flow/cfn_flow.rb', line 2535

def schedule_expression
  @schedule_expression
end

#schedule_offset ⇒ Numeric? (readonly)

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

Returns:

  • (Numeric, nil)

See Also:



2562
2563
2564
 
# File 'app_flow/cfn_flow.rb', line 2562

def schedule_offset
  @schedule_offset
end

#schedule_start_time ⇒ Numeric? (readonly)

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 .

Returns:

  • (Numeric, nil)

See Also:



2569
2570
2571
 
# File 'app_flow/cfn_flow.rb', line 2569

def schedule_start_time
  @schedule_start_time
end

#time_zone ⇒ String? (readonly)

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 .

Returns:

  • (String, nil)

See Also:



2578
2579
2580
 
# File 'app_flow/cfn_flow.rb', line 2578

def time_zone
  @time_zone
end

Class Method Details

.jsii_properties ⇒ Object 



2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
 
# File 'app_flow/cfn_flow.rb', line 2580

def self.jsii_properties
  {
    :schedule_expression => "scheduleExpression",
    :data_pull_mode => "dataPullMode",
    :first_execution_from => "firstExecutionFrom",
    :flow_error_deactivation_threshold => "flowErrorDeactivationThreshold",
    :schedule_end_time => "scheduleEndTime",
    :schedule_offset => "scheduleOffset",
    :schedule_start_time => "scheduleStartTime",
    :time_zone => "timeZone",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
 
# File 'app_flow/cfn_flow.rb', line 2593

def to_jsii
  result = {}
  result.merge!({
    "scheduleExpression" => @schedule_expression,
    "dataPullMode" => @data_pull_mode,
    "firstExecutionFrom" => @first_execution_from,
    "flowErrorDeactivationThreshold" => @flow_error_deactivation_threshold,
    "scheduleEndTime" => @schedule_end_time,
    "scheduleOffset" => @schedule_offset,
    "scheduleStartTime" => @schedule_start_time,
    "timeZone" => @time_zone,
  })
  result.compact
end