Package software.amazon.awscdk.services.ssmcontacts

Interface CfnRotationProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnRotationProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:35.827Z")
@Stability(Stable)
public interface CfnRotationProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnRotation.

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.*;
 CfnRotationProps cfnRotationProps = CfnRotationProps.builder()
         .contactIds(List.of("contactIds"))
         .name("name")
         .recurrence(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())
         .startTime("startTime")
         .timeZoneId("timeZoneId")
         // the properties below are optional
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnRotationProps.Builder	builder()
List<String>	getContactIds()	The Amazon Resource Names (ARNs) of the contacts to add to the rotation.
String	getName()	The name for the rotation.
Object	getRecurrence()	Information about the rule that specifies when shift team members rotate.
String	getStartTime()	The date and time the rotation goes into effect.
default List<CfnTag>	getTags()	Optional metadata to assign to the rotation.
String	getTimeZoneId()	The time zone to base the rotation’s activity on, in Internet Assigned Numbers Authority (IANA) format.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getContactIds

@Stability(Stable)
@NotNull
List<String> getContactIds()

The Amazon Resource Names (ARNs) of the contacts to add to the rotation.

The order in which you list the contacts is their shift order in the rotation schedule.

getName

@Stability(Stable)
@NotNull
String getName()

The name for the rotation.

getRecurrence

@Stability(Stable)
@NotNull
Object getRecurrence()

Information about the rule that specifies when shift team members rotate.

getStartTime

@Stability(Stable)
@NotNull
String getStartTime()

The date and time the rotation goes into effect.

getTimeZoneId

@Stability(Stable)
@NotNull
String getTimeZoneId()

The time zone to base the rotation’s activity on, in Internet Assigned Numbers Authority (IANA) format.

For example: "America/Los_Angeles", "UTC", or "Asia/Seoul". For more information, see the Time Zone Database on the IANA website.

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

Optional metadata to assign to the rotation.

Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For more information, see Tagging Incident Manager resources in the Incident Manager User Guide .

builder

@Stability(Stable)
static CfnRotationProps.Builder builder()

Returns:

a CfnRotationProps.Builder of CfnRotationProps