interface CfnRotationProps

Language	Type name
.NET	Amazon.CDK.AWS.SSMContacts.CfnRotationProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsssmcontacts#CfnRotationProps
Java	software.amazon.awscdk.services.ssmcontacts.CfnRotationProps
Python	aws_cdk.aws_ssmcontacts.CfnRotationProps
TypeScript	aws-cdk-lib » aws_ssmcontacts » CfnRotationProps

Properties for defining a CfnRotation.

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

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

Name	Type	Description
contactIds	string[]	The Amazon Resource Names (ARNs) of the contacts to add to the rotation.
name	string	The name for the rotation.
recurrence	IResolvable | RecurrenceSettingsProperty	Information about the rule that specifies when shift team members rotate.
startTime	string	The date and time the rotation goes into effect.
timeZoneId	string	The 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.

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

---

name

Type: string

The name for the rotation.

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

---

recurrence

Type: IResolvable | RecurrenceSettingsProperty

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

---

startTime

Type: string

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

---

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.

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

---

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 .

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