Class: AWSCDK::StepFunctionsTasks::Schedule

Inherits:
Jsii::Object
  • Object
show all
Defined in:
step_functions_tasks/schedule.rb

Overview

Schedule for EventBridge Scheduler.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(*args) ⇒ Schedule

Returns a new instance of Schedule.

Raises:

  • (NoMethodError) 


8
9
10
 
# File 'step_functions_tasks/schedule.rb', line 8

def initialize(*args)
  raise NoMethodError, "aws-cdk-lib.aws_stepfunctions_tasks.Schedule does not have a visible constructor; use the provided factory methods"
end

Class Method Details

.cron(options) ⇒ AWSCDK::StepFunctionsTasks::Schedule

Create a cron-based schedule from a set of cron fields.

Parameters:

Returns:

  • (AWSCDK::StepFunctionsTasks::Schedule) 


22
23
24
25
26
 
# File 'step_functions_tasks/schedule.rb', line 22

def self.cron(options)
  options = options.is_a?(Hash) ? ::AWSCDK::StepFunctionsTasks::CronOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9uc190YXNrcy5Dcm9uT3B0aW9ucyJ9")), "options")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_stepfunctions_tasks.Schedule", "cron", [options])
end

.jsii_overridable_methods ⇒ Object 



12
13
14
15
16
 
# File 'step_functions_tasks/schedule.rb', line 12

def self.jsii_overridable_methods
  {
    :expression_string => { kind: :property, name: "expressionString", is_optional: false },
  }
end

.one_time(time) ⇒ AWSCDK::StepFunctionsTasks::Schedule

Construct a one-time schedule from a Date.

Parameters:

  • time (DateTime)

Returns:

  • (AWSCDK::StepFunctionsTasks::Schedule) 


32
33
34
35
 
# File 'step_functions_tasks/schedule.rb', line 32

def self.one_time(time)
  Jsii::Type.check_type(time, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJkYXRlIn0=")), "time")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_stepfunctions_tasks.Schedule", "oneTime", [time])
end

.rate(duration) ⇒ AWSCDK::StepFunctionsTasks::Schedule

Construct a rate-based schedule from an interval.

The minimum interval is 1 minute.

Parameters:

Returns:

  • (AWSCDK::StepFunctionsTasks::Schedule) 


43
44
45
46
 
# File 'step_functions_tasks/schedule.rb', line 43

def self.rate(duration)
  Jsii::Type.check_type(duration, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5EdXJhdGlvbiJ9")), "duration")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_stepfunctions_tasks.Schedule", "rate", [duration])
end

Instance Method Details

#expression_string ⇒ String

The Schedule expression.

Returns:

  • (String) 


51
52
53
 
# File 'step_functions_tasks/schedule.rb', line 51

def expression_string()
  jsii_get_property("expressionString")
end