aws-cdk-lib.aws_ssmcontacts.CfnRotationProps

CfnRotationProps Struct

Properties for defining a CfnRotation.

CfnRotationProps

used as props by

• CfnRotation

Source

Generated code

Type last changed

v2.78.0 · 4 May 2023

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_ssmcontacts as ssmcontacts } from 'aws-cdk-lib';
const cfnRotationProps: ssmcontacts.CfnRotationProps = {
  contactIds: ['contactIds'],
  name: 'name',
  recurrence: {
    numberOfOnCalls: 123,
    recurrenceMultiplier: 123,

    // the properties below are optional
    dailySettings: ['dailySettings'],
    monthlySettings: [{
      dayOfMonth: 123,
      handOffTime: 'handOffTime',
    }],
    shiftCoverages: [{
      coverageTimes: [{
        endTime: 'endTime',
        startTime: 'startTime',
      }],
      dayOfWeek: 'dayOfWeek',
    }],
    weeklySettings: [{
      dayOfWeek: 'dayOfWeek',
      handOffTime: 'handOffTime',
    }],
  },
  startTime: 'startTime',
  timeZoneId: 'timeZoneId',

  // the properties below are optional
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

contactIdsstring[]contact_idstyping.List[str]contactIdsList<String>ContactIdsstring[]ContactIds*[]*stringrequired#

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.

namestringnamestrnameStringNamestringName*stringrequired#

The name for the rotation.

recurrenceIResolvable | CfnRotation.RecurrenceSettingsPropertyrecurrencetyping.Union[IResolvable, RecurrenceSettingsProperty]recurrenceIResolvableRecurrenceIResolvableRecurrenceinterface{}required#

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

startTimestringstart_timestrstartTimeStringStartTimestringStartTime*stringrequired#

The date and time the rotation goes into effect.

tags?optionalCfnTag[]tags?optionaltyping.List[CfnTag]tags?optionalList<CfnTag>Tags?optionalCfnTag[]Tags?optional*[]CfnTag#

Optional metadata to assign to the rotation.

notes

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 .

timeZoneIdstringtime_zone_idstrtimeZoneIdStringTimeZoneIdstringTimeZoneId*stringrequired#

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

notes

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.