Class: AWSCDK::Scheduler::CfnSchedule::FlexibleTimeWindowProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::Scheduler::CfnSchedule::FlexibleTimeWindowProperty

Defined in:

scheduler/cfn_schedule.rb

Overview

Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-flexibletimewindow.html

Instance Attribute Summary

• #maximum_window_in_minutes ⇒ Numeric^? readonly

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

• #mode ⇒ String readonly

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

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(mode:, maximum_window_in_minutes: nil) ⇒ FlexibleTimeWindowProperty constructor

  A new instance of FlexibleTimeWindowProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(mode:, maximum_window_in_minutes: nil) ⇒ FlexibleTimeWindowProperty

Returns a new instance of FlexibleTimeWindowProperty.

Parameters:

• mode (String) —

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

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

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

# File 'scheduler/cfn_schedule.rb', line 1027

def initialize(mode:, maximum_window_in_minutes: nil)
  @mode = mode
  Jsii::Type.check_type(@mode, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "mode")
  @maximum_window_in_minutes = maximum_window_in_minutes
  Jsii::Type.check_type(@maximum_window_in_minutes, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "maximumWindowInMinutes") unless @maximum_window_in_minutes.nil?
end

Instance Attribute Details

#maximum_window_in_minutes ⇒ Numeric^? (readonly)

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

Minimum : 1

Maximum : 1440

Returns:

• (Numeric, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-flexibletimewindow.html#cfn-scheduler-schedule-flexibletimewindow-maximumwindowinminutes

# File 'scheduler/cfn_schedule.rb', line 1051

def maximum_window_in_minutes
  @maximum_window_in_minutes
end

#mode ⇒ String (readonly)

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

You must use quotation marks when you specify this value in your JSON or YAML template.

Allowed Values : "OFF" | "FLEXIBLE"

Returns:

• (String)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-flexibletimewindow.html#cfn-scheduler-schedule-flexibletimewindow-mode

# File 'scheduler/cfn_schedule.rb', line 1042

def mode
  @mode
end

Class Method Details

.jsii_properties ⇒ Object

# File 'scheduler/cfn_schedule.rb', line 1053

def self.jsii_properties
  {
    :mode => "mode",
    :maximum_window_in_minutes => "maximumWindowInMinutes",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'scheduler/cfn_schedule.rb', line 1060

def to_jsii
  result = {}
  result.merge!({
    "mode" => @mode,
    "maximumWindowInMinutes" => @maximum_window_in_minutes,
  })
  result.compact
end