This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html).

# AWS::SSMContacts::Rotation
<a name="aws-resource-ssmcontacts-rotation"></a>

Specifies a rotation in an on-call schedule.

**Note**  
**Template example**: We recommend creating all Incident Manager`Contacts` resources using a single AWS CloudFormation template. For a demonstration, see the examples for [AWS::SSMContacts::Contacts](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmcontacts-contact.html).

## Syntax
<a name="aws-resource-ssmcontacts-rotation-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-resource-ssmcontacts-rotation-syntax.json"></a>

```
{
  "Type" : "AWS::SSMContacts::Rotation",
  "Properties" : {
      "[ContactIds](#cfn-ssmcontacts-rotation-contactids)" : [ String, ... ],
      "[Name](#cfn-ssmcontacts-rotation-name)" : String,
      "[Recurrence](#cfn-ssmcontacts-rotation-recurrence)" : RecurrenceSettings,
      "[StartTime](#cfn-ssmcontacts-rotation-starttime)" : String,
      "[Tags](#cfn-ssmcontacts-rotation-tags)" : [ Tag, ... ],
      "[TimeZoneId](#cfn-ssmcontacts-rotation-timezoneid)" : String
    }
}
```

### YAML
<a name="aws-resource-ssmcontacts-rotation-syntax.yaml"></a>

```
Type: AWS::SSMContacts::Rotation
Properties:
  [ContactIds](#cfn-ssmcontacts-rotation-contactids): 
    - String
  [Name](#cfn-ssmcontacts-rotation-name): String
  [Recurrence](#cfn-ssmcontacts-rotation-recurrence): 
    RecurrenceSettings
  [StartTime](#cfn-ssmcontacts-rotation-starttime): String
  [Tags](#cfn-ssmcontacts-rotation-tags): 
    - Tag
  [TimeZoneId](#cfn-ssmcontacts-rotation-timezoneid): String
```

## Properties
<a name="aws-resource-ssmcontacts-rotation-properties"></a>

`ContactIds`  <a name="cfn-ssmcontacts-rotation-contactids"></a>
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.  
*Required*: Yes  
*Type*: Array of String  
*Minimum*: `0`  
*Maximum*: `25`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Name`  <a name="cfn-ssmcontacts-rotation-name"></a>
The name for the rotation.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^[a-zA-Z0-9_]*$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Recurrence`  <a name="cfn-ssmcontacts-rotation-recurrence"></a>
Information about the rule that specifies when shift team members rotate.  
*Required*: Yes  
*Type*: [RecurrenceSettings](aws-properties-ssmcontacts-rotation-recurrencesettings.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`StartTime`  <a name="cfn-ssmcontacts-rotation-starttime"></a>
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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Tags`  <a name="cfn-ssmcontacts-rotation-tags"></a>
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](https://docs.aws.amazon.com/incident-manager/latest/userguide/tagging.html) in the *Incident Manager User Guide*.  
*Required*: No  
*Type*: Array of [Tag](aws-properties-ssmcontacts-rotation-tag.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`TimeZoneId`  <a name="cfn-ssmcontacts-rotation-timezoneid"></a>
The time zone to base the rotation’s activity on, in Internet Assigned Numbers Authority (IANA) format. For example: "America/Los\$1Angeles", "UTC", or "Asia/Seoul". For more information, see the [Time Zone Database](https://www.iana.org/time-zones) 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.
*Required*: Yes  
*Type*: String  
*Pattern*: `^[:a-zA-Z0-9_\-\s\.\\/]*$`  
*Minimum*: `1`  
*Maximum*: `255`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return values
<a name="aws-resource-ssmcontacts-rotation-return-values"></a>

### Ref
<a name="aws-resource-ssmcontacts-rotation-return-values-ref"></a>

### Fn::GetAtt
<a name="aws-resource-ssmcontacts-rotation-return-values-fn--getatt"></a>

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 [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html).

#### 
<a name="aws-resource-ssmcontacts-rotation-return-values-fn--getatt-fn--getatt"></a>

`Arn`  <a name="Arn-fn::getatt"></a>
The Amazon Resource Name (ARN) of the `Rotation` resource.

# AWS::SSMContacts::Rotation CoverageTime
<a name="aws-properties-ssmcontacts-rotation-coveragetime"></a>

Information about when an on-call shift begins and ends.

## Syntax
<a name="aws-properties-ssmcontacts-rotation-coveragetime-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-ssmcontacts-rotation-coveragetime-syntax.json"></a>

```
{
  "[EndTime](#cfn-ssmcontacts-rotation-coveragetime-endtime)" : String,
  "[StartTime](#cfn-ssmcontacts-rotation-coveragetime-starttime)" : String
}
```

### YAML
<a name="aws-properties-ssmcontacts-rotation-coveragetime-syntax.yaml"></a>

```
  [EndTime](#cfn-ssmcontacts-rotation-coveragetime-endtime): String
  [StartTime](#cfn-ssmcontacts-rotation-coveragetime-starttime): String
```

## Properties
<a name="aws-properties-ssmcontacts-rotation-coveragetime-properties"></a>

`EndTime`  <a name="cfn-ssmcontacts-rotation-coveragetime-endtime"></a>
Information about when an on-call rotation shift ends.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^([0-9]|0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`StartTime`  <a name="cfn-ssmcontacts-rotation-coveragetime-starttime"></a>
Information about when an on-call rotation shift begins.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^([0-9]|0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::SSMContacts::Rotation MonthlySetting
<a name="aws-properties-ssmcontacts-rotation-monthlysetting"></a>

Information about on-call rotations that recur monthly.

## Syntax
<a name="aws-properties-ssmcontacts-rotation-monthlysetting-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-ssmcontacts-rotation-monthlysetting-syntax.json"></a>

```
{
  "[DayOfMonth](#cfn-ssmcontacts-rotation-monthlysetting-dayofmonth)" : Integer,
  "[HandOffTime](#cfn-ssmcontacts-rotation-monthlysetting-handofftime)" : String
}
```

### YAML
<a name="aws-properties-ssmcontacts-rotation-monthlysetting-syntax.yaml"></a>

```
  [DayOfMonth](#cfn-ssmcontacts-rotation-monthlysetting-dayofmonth): Integer
  [HandOffTime](#cfn-ssmcontacts-rotation-monthlysetting-handofftime): String
```

## Properties
<a name="aws-properties-ssmcontacts-rotation-monthlysetting-properties"></a>

`DayOfMonth`  <a name="cfn-ssmcontacts-rotation-monthlysetting-dayofmonth"></a>
The day of the month when monthly recurring on-call rotations begin.  
*Required*: Yes  
*Type*: Integer  
*Minimum*: `1`  
*Maximum*: `31`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`HandOffTime`  <a name="cfn-ssmcontacts-rotation-monthlysetting-handofftime"></a>
The time of day when a monthly recurring on-call shift rotation begins.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^([0-9]|0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::SSMContacts::Rotation RecurrenceSettings
<a name="aws-properties-ssmcontacts-rotation-recurrencesettings"></a>

Information about when an on-call rotation is in effect and how long the rotation period lasts.

## Syntax
<a name="aws-properties-ssmcontacts-rotation-recurrencesettings-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-ssmcontacts-rotation-recurrencesettings-syntax.json"></a>

```
{
  "[DailySettings](#cfn-ssmcontacts-rotation-recurrencesettings-dailysettings)" : [ String, ... ],
  "[MonthlySettings](#cfn-ssmcontacts-rotation-recurrencesettings-monthlysettings)" : [ MonthlySetting, ... ],
  "[NumberOfOnCalls](#cfn-ssmcontacts-rotation-recurrencesettings-numberofoncalls)" : Integer,
  "[RecurrenceMultiplier](#cfn-ssmcontacts-rotation-recurrencesettings-recurrencemultiplier)" : Integer,
  "[ShiftCoverages](#cfn-ssmcontacts-rotation-recurrencesettings-shiftcoverages)" : [ ShiftCoverage, ... ],
  "[WeeklySettings](#cfn-ssmcontacts-rotation-recurrencesettings-weeklysettings)" : [ WeeklySetting, ... ]
}
```

### YAML
<a name="aws-properties-ssmcontacts-rotation-recurrencesettings-syntax.yaml"></a>

```
  [DailySettings](#cfn-ssmcontacts-rotation-recurrencesettings-dailysettings): 
    - String
  [MonthlySettings](#cfn-ssmcontacts-rotation-recurrencesettings-monthlysettings): 
    - MonthlySetting
  [NumberOfOnCalls](#cfn-ssmcontacts-rotation-recurrencesettings-numberofoncalls): Integer
  [RecurrenceMultiplier](#cfn-ssmcontacts-rotation-recurrencesettings-recurrencemultiplier): Integer
  [ShiftCoverages](#cfn-ssmcontacts-rotation-recurrencesettings-shiftcoverages): 
    - ShiftCoverage
  [WeeklySettings](#cfn-ssmcontacts-rotation-recurrencesettings-weeklysettings): 
    - WeeklySetting
```

## Properties
<a name="aws-properties-ssmcontacts-rotation-recurrencesettings-properties"></a>

`DailySettings`  <a name="cfn-ssmcontacts-rotation-recurrencesettings-dailysettings"></a>
Information about on-call rotations that recur daily.  
*Required*: No  
*Type*: Array of String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`MonthlySettings`  <a name="cfn-ssmcontacts-rotation-recurrencesettings-monthlysettings"></a>
Information about on-call rotations that recur monthly.  
*Required*: No  
*Type*: Array of [MonthlySetting](aws-properties-ssmcontacts-rotation-monthlysetting.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`NumberOfOnCalls`  <a name="cfn-ssmcontacts-rotation-recurrencesettings-numberofoncalls"></a>
The number of contacts, or shift team members designated to be on call concurrently during a shift. For example, in an on-call schedule that contains ten contacts, a value of `2` designates that two of them are on call at any given time.  
*Required*: No  
*Type*: Integer  
*Minimum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`RecurrenceMultiplier`  <a name="cfn-ssmcontacts-rotation-recurrencesettings-recurrencemultiplier"></a>
The number of days, weeks, or months a single rotation lasts.  
*Required*: No  
*Type*: Integer  
*Minimum*: `1`  
*Maximum*: `100`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ShiftCoverages`  <a name="cfn-ssmcontacts-rotation-recurrencesettings-shiftcoverages"></a>
Information about the days of the week included in on-call rotation coverage.  
*Required*: No  
*Type*: Array of [ShiftCoverage](aws-properties-ssmcontacts-rotation-shiftcoverage.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`WeeklySettings`  <a name="cfn-ssmcontacts-rotation-recurrencesettings-weeklysettings"></a>
Information about on-call rotations that recur weekly.  
*Required*: No  
*Type*: Array of [WeeklySetting](aws-properties-ssmcontacts-rotation-weeklysetting.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::SSMContacts::Rotation ShiftCoverage
<a name="aws-properties-ssmcontacts-rotation-shiftcoverage"></a>

Information about the days of the week that the on-call rotation coverage includes.

## Syntax
<a name="aws-properties-ssmcontacts-rotation-shiftcoverage-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-ssmcontacts-rotation-shiftcoverage-syntax.json"></a>

```
{
  "[CoverageTimes](#cfn-ssmcontacts-rotation-shiftcoverage-coveragetimes)" : [ CoverageTime, ... ],
  "[DayOfWeek](#cfn-ssmcontacts-rotation-shiftcoverage-dayofweek)" : String
}
```

### YAML
<a name="aws-properties-ssmcontacts-rotation-shiftcoverage-syntax.yaml"></a>

```
  [CoverageTimes](#cfn-ssmcontacts-rotation-shiftcoverage-coveragetimes): 
    - CoverageTime
  [DayOfWeek](#cfn-ssmcontacts-rotation-shiftcoverage-dayofweek): String
```

## Properties
<a name="aws-properties-ssmcontacts-rotation-shiftcoverage-properties"></a>

`CoverageTimes`  <a name="cfn-ssmcontacts-rotation-shiftcoverage-coveragetimes"></a>
The start and end times of the shift.  
*Required*: Yes  
*Type*: Array of [CoverageTime](aws-properties-ssmcontacts-rotation-coveragetime.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DayOfWeek`  <a name="cfn-ssmcontacts-rotation-shiftcoverage-dayofweek"></a>
A list of days on which the schedule is active.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `MON | TUE | WED | THU | FRI | SAT | SUN`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::SSMContacts::Rotation Tag
<a name="aws-properties-ssmcontacts-rotation-tag"></a>

A container of a key-value name pair.

## Syntax
<a name="aws-properties-ssmcontacts-rotation-tag-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-ssmcontacts-rotation-tag-syntax.json"></a>

```
{
  "[Key](#cfn-ssmcontacts-rotation-tag-key)" : String,
  "[Value](#cfn-ssmcontacts-rotation-tag-value)" : String
}
```

### YAML
<a name="aws-properties-ssmcontacts-rotation-tag-syntax.yaml"></a>

```
  [Key](#cfn-ssmcontacts-rotation-tag-key): String
  [Value](#cfn-ssmcontacts-rotation-tag-value): String
```

## Properties
<a name="aws-properties-ssmcontacts-rotation-tag-properties"></a>

`Key`  <a name="cfn-ssmcontacts-rotation-tag-key"></a>
Name of the object key.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `128`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Value`  <a name="cfn-ssmcontacts-rotation-tag-value"></a>
Value of the tag.  
*Required*: Yes  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::SSMContacts::Rotation WeeklySetting
<a name="aws-properties-ssmcontacts-rotation-weeklysetting"></a>

Information about rotations that recur weekly.

## Syntax
<a name="aws-properties-ssmcontacts-rotation-weeklysetting-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-ssmcontacts-rotation-weeklysetting-syntax.json"></a>

```
{
  "[DayOfWeek](#cfn-ssmcontacts-rotation-weeklysetting-dayofweek)" : String,
  "[HandOffTime](#cfn-ssmcontacts-rotation-weeklysetting-handofftime)" : String
}
```

### YAML
<a name="aws-properties-ssmcontacts-rotation-weeklysetting-syntax.yaml"></a>

```
  [DayOfWeek](#cfn-ssmcontacts-rotation-weeklysetting-dayofweek): String
  [HandOffTime](#cfn-ssmcontacts-rotation-weeklysetting-handofftime): String
```

## Properties
<a name="aws-properties-ssmcontacts-rotation-weeklysetting-properties"></a>

`DayOfWeek`  <a name="cfn-ssmcontacts-rotation-weeklysetting-dayofweek"></a>
The day of the week when weekly recurring on-call shift rotations begins.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `MON | TUE | WED | THU | FRI | SAT | SUN`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`HandOffTime`  <a name="cfn-ssmcontacts-rotation-weeklysetting-handofftime"></a>
The time of day when a weekly recurring on-call shift rotation begins.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^([0-9]|0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)