AWS::SSMContacts::Rotation
Specifies a rotation in an on-call schedule.
Note
Template example: We recommend creating all Incident Manager
Contacts
resources using a single Amazon CloudFormation template. For a
demonstration, see the examples for AWS::SSMContacts::Contacts.
Syntax
To declare this entity in your Amazon CloudFormation template, use the following syntax:
JSON
{ "Type" : "AWS::SSMContacts::Rotation", "Properties" : { "ContactIds" :
[ String, ... ]
, "Name" :String
, "Recurrence" :RecurrenceSettings
, "StartTime" :String
, "Tags" :[ Tag, ... ]
, "TimeZoneId" :String
} }
YAML
Type: AWS::SSMContacts::Rotation Properties: ContactIds:
- String
Name:String
Recurrence:RecurrenceSettings
StartTime:String
Tags:- Tag
TimeZoneId:String
Properties
ContactIds
-
The Amazon Resource Names (ARNs) of the contacts to add to the rotation.
Note
Only the
PERSONAL
contact type is supported. The contact typesESCALATION
andONCALL_SCHEDULE
are not supported for this operation.The order in which you list the contacts is their shift order in the rotation schedule.
Required: Yes
Type: Array of String
Minimum:
0
Maximum:
25
Update requires: No interruption
Name
-
The name for the rotation.
Required: Yes
Type: String
Pattern:
^[a-zA-Z0-9_]*$
Update requires: No interruption
Recurrence
-
Information about the rule that specifies when shift team members rotate.
Required: Yes
Type: RecurrenceSettings
Update requires: No interruption
StartTime
-
The date and time the rotation goes into effect.
Required: Yes
Type: String
Pattern:
^(\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2})$
Update requires: No interruption
-
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.
Required: No
Type: Array of Tag
Update requires: No interruption
TimeZoneId
-
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. Note
Designators for time zones that don’t support Daylight Savings Time rules, such as Pacific Standard Time (PST), are not supported.
Required: Yes
Type: String
Pattern:
^[:a-zA-Z0-9_\-\s\.\\/]*$
Minimum:
1
Maximum:
255
Update requires: No interruption
Return values
Ref
Fn::GetAtt
The Fn::GetAtt
intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.
For more information about using the Fn::GetAtt
intrinsic function, see Fn::GetAtt
.
Arn
-
The Amazon Resource Name (ARN) of the
Rotation
resource.