Package software.amazon.awscdk.services.ssmcontacts

Class CfnRotation

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.ssmcontacts.CfnRotation
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:35.824Z") @Stability(Stable) public class CfnRotation extends CfnResource implements IInspectable
A CloudFormation AWS::SSMContacts::Rotation.

Specifies a rotation in an on-call schedule.

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.*;
 CfnRotation cfnRotation = CfnRotation.Builder.create(this, "MyCfnRotation")
         .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();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnRotation

      protected CfnRotation(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnRotation

      protected CfnRotation(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnRotation

      @Stability(Stable) public CfnRotation(@NotNull Construct scope, @NotNull String id, @NotNull CfnRotationProps props)
      Create a new AWS::SSMContacts::Rotation.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the Rotation resource.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager 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 .

    • getContactIds

      @Stability(Stable) @NotNull public 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.

    • setContactIds

      @Stability(Stable) public void setContactIds(@NotNull List<String> value)
      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 public String getName()
      The name for the rotation.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The name for the rotation.

    • getRecurrence

      @Stability(Stable) @NotNull public Object getRecurrence()
      Information about the rule that specifies when shift team members rotate.

    • setRecurrence

      @Stability(Stable) public void setRecurrence(@NotNull IResolvable value)
      Information about the rule that specifies when shift team members rotate.

    • setRecurrence

      @Stability(Stable) public void setRecurrence(@NotNull CfnRotation.RecurrenceSettingsProperty value)
      Information about the rule that specifies when shift team members rotate.

    • getStartTime

      @Stability(Stable) @NotNull public String getStartTime()
      The date and time the rotation goes into effect.

    • setStartTime

      @Stability(Stable) public void setStartTime(@NotNull String value)
      The date and time the rotation goes into effect.

    • getTimeZoneId

      @Stability(Stable) @NotNull public 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.

    • setTimeZoneId

      @Stability(Stable) public void setTimeZoneId(@NotNull String value)
      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.