Class: AWSCDK::SSMContacts::CfnRotation::RecurrenceSettingsProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
ssm_contacts/cfn_rotation.rb

Overview

Information about when an on-call rotation is in effect and how long the rotation period lasts.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(number_of_on_calls:, recurrence_multiplier:, daily_settings: nil, monthly_settings: nil, shift_coverages: nil, weekly_settings: nil) ⇒ RecurrenceSettingsProperty

Returns a new instance of RecurrenceSettingsProperty.

Parameters:



676
677
678
679
680
681
682
683
684
685
686
687
688
689
 
# File 'ssm_contacts/cfn_rotation.rb', line 676

def initialize(number_of_on_calls:, recurrence_multiplier:, daily_settings: nil, monthly_settings: nil, shift_coverages: nil, weekly_settings: nil)
  @number_of_on_calls = number_of_on_calls
  Jsii::Type.check_type(@number_of_on_calls, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "numberOfOnCalls")
  @recurrence_multiplier = recurrence_multiplier
  Jsii::Type.check_type(@recurrence_multiplier, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "recurrenceMultiplier")
  @daily_settings = daily_settings
  Jsii::Type.check_type(@daily_settings, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "dailySettings") unless @daily_settings.nil?
  @monthly_settings = monthly_settings
  Jsii::Type.check_type(@monthly_settings, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3NtY29udGFjdHMuQ2ZuUm90YXRpb24uTW9udGhseVNldHRpbmdQcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "monthlySettings") unless @monthly_settings.nil?
  @shift_coverages = shift_coverages
  Jsii::Type.check_type(@shift_coverages, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3NtY29udGFjdHMuQ2ZuUm90YXRpb24uU2hpZnRDb3ZlcmFnZVByb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "shiftCoverages") unless @shift_coverages.nil?
  @weekly_settings = weekly_settings
  Jsii::Type.check_type(@weekly_settings, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3NtY29udGFjdHMuQ2ZuUm90YXRpb24uV2Vla2x5U2V0dGluZ1Byb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "weeklySettings") unless @weekly_settings.nil?
end

Instance Attribute Details

#daily_settings ⇒ Array<String>? (readonly)

Information about on-call rotations that recur daily.

Returns:

  • (Array<String>, nil)

See Also:



707
708
709
 
# File 'ssm_contacts/cfn_rotation.rb', line 707

def daily_settings
  @daily_settings
end

#monthly_settings ⇒ AWSCDK::IResolvable, ... (readonly)

Information about on-call rotations that recur monthly.

Returns:

See Also:



712
713
714
 
# File 'ssm_contacts/cfn_rotation.rb', line 712

def monthly_settings
  @monthly_settings
end

#number_of_on_calls ⇒ Numeric (readonly)

The number of contacts, or shift team members designated to be on call concurrently during a shift.

For example, in an on-call schedule that contains ten contacts, a value of 2 designates that two of them are on call at any given time.

Returns:

  • (Numeric)

See Also:



697
698
699
 
# File 'ssm_contacts/cfn_rotation.rb', line 697

def number_of_on_calls
  @number_of_on_calls
end

#recurrence_multiplier ⇒ Numeric (readonly)

The number of days, weeks, or months a single rotation lasts.

Returns:

  • (Numeric)

See Also:



702
703
704
 
# File 'ssm_contacts/cfn_rotation.rb', line 702

def recurrence_multiplier
  @recurrence_multiplier
end

#shift_coverages ⇒ AWSCDK::IResolvable, ... (readonly)

Information about the days of the week included in on-call rotation coverage.

Returns:

See Also:



717
718
719
 
# File 'ssm_contacts/cfn_rotation.rb', line 717

def shift_coverages
  @shift_coverages
end

#weekly_settings ⇒ AWSCDK::IResolvable, ... (readonly)

Information about on-call rotations that recur weekly.

Returns:

See Also:



722
723
724
 
# File 'ssm_contacts/cfn_rotation.rb', line 722

def weekly_settings
  @weekly_settings
end

Class Method Details

.jsii_properties ⇒ Object 



724
725
726
727
728
729
730
731
732
733
 
# File 'ssm_contacts/cfn_rotation.rb', line 724

def self.jsii_properties
  {
    :number_of_on_calls => "numberOfOnCalls",
    :recurrence_multiplier => "recurrenceMultiplier",
    :daily_settings => "dailySettings",
    :monthly_settings => "monthlySettings",
    :shift_coverages => "shiftCoverages",
    :weekly_settings => "weeklySettings",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



735
736
737
738
739
740
741
742
743
744
745
746
 
# File 'ssm_contacts/cfn_rotation.rb', line 735

def to_jsii
  result = {}
  result.merge!({
    "numberOfOnCalls" => @number_of_on_calls,
    "recurrenceMultiplier" => @recurrence_multiplier,
    "dailySettings" => @daily_settings,
    "monthlySettings" => @monthly_settings,
    "shiftCoverages" => @shift_coverages,
    "weeklySettings" => @weekly_settings,
  })
  result.compact
end