Class: AWSCDK::CustomerProfiles::CfnIntegration::ScheduledTriggerPropertiesProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
customer_profiles/cfn_integration.rb

Overview

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

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, schedule_end_time: nil, schedule_offset: nil, schedule_start_time: nil, timezone: 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 (5 minutes).

  • 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.

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

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

  • 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) —

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

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

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



983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
 
# File 'customer_profiles/cfn_integration.rb', line 983

def initialize(schedule_expression:, data_pull_mode: nil, first_execution_from: nil, schedule_end_time: nil, schedule_offset: nil, schedule_start_time: nil, timezone: 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?
  @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?
  @timezone = timezone
  Jsii::Type.check_type(@timezone, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "timezone") unless @timezone.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:



1009
1010
1011
 
# File 'customer_profiles/cfn_integration.rb', line 1009

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:



1014
1015
1016
 
# File 'customer_profiles/cfn_integration.rb', line 1014

def first_execution_from
  @first_execution_from
end

#schedule_end_time ⇒ Numeric? (readonly)

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

Returns:

  • (Numeric, nil)

See Also:



1019
1020
1021
 
# File 'customer_profiles/cfn_integration.rb', line 1019

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 (5 minutes).

Returns:

  • (String)

See Also:



1004
1005
1006
 
# File 'customer_profiles/cfn_integration.rb', line 1004

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:



1024
1025
1026
 
# File 'customer_profiles/cfn_integration.rb', line 1024

def schedule_offset
  @schedule_offset
end

#schedule_start_time ⇒ Numeric? (readonly)

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

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

Returns:

  • (Numeric, nil)

See Also:



1031
1032
1033
 
# File 'customer_profiles/cfn_integration.rb', line 1031

def schedule_start_time
  @schedule_start_time
end

#timezone ⇒ String? (readonly)

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

Returns:

  • (String, nil)

See Also:



1036
1037
1038
 
# File 'customer_profiles/cfn_integration.rb', line 1036

def timezone
  @timezone
end

Class Method Details

.jsii_properties ⇒ Object 



1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
 
# File 'customer_profiles/cfn_integration.rb', line 1038

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

Instance Method Details

#to_jsii ⇒ Object 



1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
 
# File 'customer_profiles/cfn_integration.rb', line 1050

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