Package software.amazon.awscdk.services.ssmcontacts

Interface CfnRotation.RecurrenceSettingsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnRotation.RecurrenceSettingsProperty.Jsii$Proxy

Enclosing class:

CfnRotation

@Stability(Stable)
public static interface CfnRotation.RecurrenceSettingsProperty
extends software.amazon.jsii.JsiiSerializable

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

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.ssmcontacts.*;
 RecurrenceSettingsProperty recurrenceSettingsProperty = RecurrenceSettingsProperty.builder()
         .numberOfOnCalls(123)
         .recurrenceMultiplier(123)
         // the properties below are optional
         .dailySettings(List.of("dailySettings"))
         .monthlySettings(List.of(MonthlySettingProperty.builder()
                 .dayOfMonth(123)
                 .handOffTime("handOffTime")
                 .build()))
         .shiftCoverages(List.of(ShiftCoverageProperty.builder()
                 .coverageTimes(List.of(CoverageTimeProperty.builder()
                         .endTime("endTime")
                         .startTime("startTime")
                         .build()))
                 .dayOfWeek("dayOfWeek")
                 .build()))
         .weeklySettings(List.of(WeeklySettingProperty.builder()
                 .dayOfWeek("dayOfWeek")
                 .handOffTime("handOffTime")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-rotation-recurrencesettings.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnRotation.RecurrenceSettingsProperty.Builder	A builder for CfnRotation.RecurrenceSettingsProperty
static final class	CfnRotation.RecurrenceSettingsProperty.Jsii$Proxy	An implementation for CfnRotation.RecurrenceSettingsProperty

Method Summary

Modifier and Type	Method	Description
static CfnRotation.RecurrenceSettingsProperty.Builder	builder()
default List<String>	getDailySettings()	Information about on-call rotations that recur daily.
default Object	getMonthlySettings()	Information about on-call rotations that recur monthly.
Number	getNumberOfOnCalls()	The number of contacts, or shift team members designated to be on call concurrently during a shift.
Number	getRecurrenceMultiplier()	The number of days, weeks, or months a single rotation lasts.
default Object	getShiftCoverages()	Information about the days of the week included in on-call rotation coverage.
default Object	getWeeklySettings()	Information about on-call rotations that recur weekly.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getNumberOfOnCalls

@Stability(Stable)
@NotNull
Number getNumberOfOnCalls()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-rotation-recurrencesettings.html#cfn-ssmcontacts-rotation-recurrencesettings-numberofoncalls

getRecurrenceMultiplier

@Stability(Stable)
@NotNull
Number getRecurrenceMultiplier()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-rotation-recurrencesettings.html#cfn-ssmcontacts-rotation-recurrencesettings-recurrencemultiplier

getDailySettings

@Stability(Stable)
@Nullable
default List<String> getDailySettings()

Information about on-call rotations that recur daily.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-rotation-recurrencesettings.html#cfn-ssmcontacts-rotation-recurrencesettings-dailysettings

getMonthlySettings

@Stability(Stable)
@Nullable
default Object getMonthlySettings()

Information about on-call rotations that recur monthly.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnRotation.MonthlySettingProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-rotation-recurrencesettings.html#cfn-ssmcontacts-rotation-recurrencesettings-monthlysettings

getShiftCoverages

@Stability(Stable)
@Nullable
default Object getShiftCoverages()

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

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnRotation.ShiftCoverageProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-rotation-recurrencesettings.html#cfn-ssmcontacts-rotation-recurrencesettings-shiftcoverages

getWeeklySettings

@Stability(Stable)
@Nullable
default Object getWeeklySettings()

Information about on-call rotations that recur weekly.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnRotation.WeeklySettingProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-rotation-recurrencesettings.html#cfn-ssmcontacts-rotation-recurrencesettings-weeklysettings

builder

@Stability(Stable)
static CfnRotation.RecurrenceSettingsProperty.Builder builder()

Returns:

a CfnRotation.RecurrenceSettingsProperty.Builder of CfnRotation.RecurrenceSettingsProperty