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.98.0 (build 00b106d)",
           date="2024-05-17T05:10:18.411Z")
@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();
 

See Also:

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

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.

Only the PERSONAL contact type is supported. The contact types ESCALATION and ONCALL_SCHEDULE are not supported for this operation.

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmcontacts-rotation.html#cfn-ssmcontacts-rotation-contactids

getName

@Stability(Stable)
@NotNull
String getName()

The name for the rotation.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmcontacts-rotation.html#cfn-ssmcontacts-rotation-name

getRecurrence

@Stability(Stable)
@NotNull
Object getRecurrence()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmcontacts-rotation.html#cfn-ssmcontacts-rotation-recurrence

getStartTime

@Stability(Stable)
@NotNull
String getStartTime()

The date and time the rotation goes into effect.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmcontacts-rotation.html#cfn-ssmcontacts-rotation-starttime

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.

Designators for time zones that don’t support Daylight Savings Time rules, such as Pacific Standard Time (PST), are not supported.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmcontacts-rotation.html#cfn-ssmcontacts-rotation-timezoneid

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmcontacts-rotation.html#cfn-ssmcontacts-rotation-tags

builder

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

Returns:

a CfnRotationProps.Builder of CfnRotationProps