Class: AWSCDK::Scheduler::TimeWindow

Inherits:
Jsii::Object
  • Object
show all
Defined in:
scheduler/time_window.rb

Overview

A time window during which EventBridge Scheduler invokes the schedule.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(*args) ⇒ TimeWindow

Returns a new instance of TimeWindow.

Raises:

  • (NoMethodError) 


8
9
10
 
# File 'scheduler/time_window.rb', line 8

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

Class Method Details

.flexible(max_window) ⇒ AWSCDK::Scheduler::TimeWindow

TimeWindow is enabled.

Parameters:

Returns:

  • (AWSCDK::Scheduler::TimeWindow) 


23
24
25
26
 
# File 'scheduler/time_window.rb', line 23

def self.flexible(max_window)
  Jsii::Type.check_type(max_window, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5EdXJhdGlvbiJ9")), "maxWindow")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_scheduler.TimeWindow", "flexible", [max_window])
end

.jsii_overridable_methods ⇒ Object 



12
13
14
15
16
17
 
# File 'scheduler/time_window.rb', line 12

def self.jsii_overridable_methods
  {
    :mode => { kind: :property, name: "mode", is_optional: false },
    :max_window => { kind: :property, name: "maxWindow", is_optional: true },
  }
end

.off ⇒ AWSCDK::Scheduler::TimeWindow

TimeWindow is disabled.

Returns:

  • (AWSCDK::Scheduler::TimeWindow) 


31
32
33
 
# File 'scheduler/time_window.rb', line 31

def self.off()
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_scheduler.TimeWindow", "off", [])
end

Instance Method Details

#max_window ⇒ AWSCDK::Duration?

Note:

Default: - no value

The maximum time window during which the schedule can be invoked.

Must be between 1 to 1440 minutes.

Returns:



48
49
50
 
# File 'scheduler/time_window.rb', line 48

def max_window()
  jsii_get_property("maxWindow")
end

#mode ⇒ String

Determines whether the schedule is invoked within a flexible time window.

Returns:

  • (String) 


38
39
40
 
# File 'scheduler/time_window.rb', line 38

def mode()
  jsii_get_property("mode")
end