1.204.0

interface CfnRotationProps

LanguageType name
.NETAmazon.CDK.AWS.SSMContacts.CfnRotationProps
Javasoftware.amazon.awscdk.services.ssmcontacts.CfnRotationProps
Pythonaws_cdk.aws_ssmcontacts.CfnRotationProps
TypeScript @aws-cdk/aws-ssmcontacts » CfnRotationProps

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 * as ssmcontacts from '@aws-cdk/aws-ssmcontacts';
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

NameTypeDescription
contactIdsstring[]The Amazon Resource Names (ARNs) of the contacts to add to the rotation.
namestringThe name for the rotation.
recurrenceIResolvable | RecurrenceSettingsPropertyInformation about the rule that specifies when shift team members rotate.
startTimestringThe date and time the rotation goes into effect.
timeZoneIdstringThe time zone to base the rotation’s activity on, in Internet Assigned Numbers Authority (IANA) format.
tags?CfnTag[]Optional metadata to assign to the rotation.

contactIds

Type: string[]

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.

name

Type: string

The name for the rotation.

recurrence

Type: IResolvable | RecurrenceSettingsProperty

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

startTime

Type: string

The date and time the rotation goes into effect.

timeZoneId

Type: string

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.

tags?

Type: CfnTag[] (optional)

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 .

← PreviousNext →