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::Plan
<a name="aws-resource-ssmcontacts-plan"></a>

Information about the stages and on-call rotation teams associated with an escalation plan or engagement plan. 

**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-plan-syntax"></a>

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

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

```
{
  "Type" : "AWS::SSMContacts::Plan",
  "Properties" : {
      "[ContactId](#cfn-ssmcontacts-plan-contactid)" : String,
      "[RotationIds](#cfn-ssmcontacts-plan-rotationids)" : [ String, ... ],
      "[Stages](#cfn-ssmcontacts-plan-stages)" : [ Stage, ... ]
    }
}
```

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

```
Type: AWS::SSMContacts::Plan
Properties:
  [ContactId](#cfn-ssmcontacts-plan-contactid): String
  [RotationIds](#cfn-ssmcontacts-plan-rotationids): 
    - String
  [Stages](#cfn-ssmcontacts-plan-stages): 
    - Stage
```

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

`ContactId`  <a name="cfn-ssmcontacts-plan-contactid"></a>
The Amazon Resource Name (ARN) of the contact.  
*Required*: No  
*Type*: String  
*Pattern*: `arn:[-\w+=\/,.@]+:[-\w+=\/,.@]+:[-\w+=\/,.@]*:[0-9]+:([\w+=\/,.@:-]+)*`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`RotationIds`  <a name="cfn-ssmcontacts-plan-rotationids"></a>
The Amazon Resource Names (ARNs) of the on-call rotations associated with the plan.  
*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)

`Stages`  <a name="cfn-ssmcontacts-plan-stages"></a>
A list of stages that the escalation plan or engagement plan uses to engage contacts and contact methods.  
*Required*: No  
*Type*: Array of [Stage](aws-properties-ssmcontacts-plan-stage.md)  
*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-plan-return-values"></a>

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

### Fn::GetAtt
<a name="aws-resource-ssmcontacts-plan-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-plan-return-values-fn--getatt-fn--getatt"></a>

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

# AWS::SSMContacts::Plan ChannelTargetInfo
<a name="aws-properties-ssmcontacts-plan-channeltargetinfo"></a>

Information about the contact channel that Incident Manager uses to engage the contact.

## Syntax
<a name="aws-properties-ssmcontacts-plan-channeltargetinfo-syntax"></a>

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

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

```
{
  "[ChannelId](#cfn-ssmcontacts-plan-channeltargetinfo-channelid)" : String,
  "[RetryIntervalInMinutes](#cfn-ssmcontacts-plan-channeltargetinfo-retryintervalinminutes)" : Integer
}
```

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

```
  [ChannelId](#cfn-ssmcontacts-plan-channeltargetinfo-channelid): String
  [RetryIntervalInMinutes](#cfn-ssmcontacts-plan-channeltargetinfo-retryintervalinminutes): Integer
```

## Properties
<a name="aws-properties-ssmcontacts-plan-channeltargetinfo-properties"></a>

`ChannelId`  <a name="cfn-ssmcontacts-plan-channeltargetinfo-channelid"></a>
The Amazon Resource Name (ARN) of the contact channel.  
*Required*: Yes  
*Type*: String  
*Pattern*: `arn:(aws|aws-cn|aws-us-gov):ssm-contacts:[-\w+=\/,.@]*:[0-9]+:([\w+=\/,.@:-])*`  
*Minimum*: `1`  
*Maximum*: `2048`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`RetryIntervalInMinutes`  <a name="cfn-ssmcontacts-plan-channeltargetinfo-retryintervalinminutes"></a>
The number of minutes to wait before retrying to send engagement if the engagement initially failed.  
*Required*: Yes  
*Type*: Integer  
*Minimum*: `0`  
*Maximum*: `60`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::SSMContacts::Plan ContactTargetInfo
<a name="aws-properties-ssmcontacts-plan-contacttargetinfo"></a>

The contact that Incident Manager is engaging during an incident.

## Syntax
<a name="aws-properties-ssmcontacts-plan-contacttargetinfo-syntax"></a>

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

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

```
{
  "[ContactId](#cfn-ssmcontacts-plan-contacttargetinfo-contactid)" : String,
  "[IsEssential](#cfn-ssmcontacts-plan-contacttargetinfo-isessential)" : Boolean
}
```

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

```
  [ContactId](#cfn-ssmcontacts-plan-contacttargetinfo-contactid): String
  [IsEssential](#cfn-ssmcontacts-plan-contacttargetinfo-isessential): Boolean
```

## Properties
<a name="aws-properties-ssmcontacts-plan-contacttargetinfo-properties"></a>

`ContactId`  <a name="cfn-ssmcontacts-plan-contacttargetinfo-contactid"></a>
The Amazon Resource Name (ARN) of the contact.  
*Required*: Yes  
*Type*: String  
*Pattern*: `arn:(aws|aws-cn|aws-us-gov):ssm-contacts:[-\w+=\/,.@]*:[0-9]+:([\w+=\/,.@:-])*`  
*Minimum*: `1`  
*Maximum*: `2048`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`IsEssential`  <a name="cfn-ssmcontacts-plan-contacttargetinfo-isessential"></a>
A Boolean value determining if the contact's acknowledgement stops the progress of stages in the plan.  
*Required*: Yes  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::SSMContacts::Plan Stage
<a name="aws-properties-ssmcontacts-plan-stage"></a>

A set amount of time that an escalation plan or engagement plan engages the specified contacts or contact methods.

## Syntax
<a name="aws-properties-ssmcontacts-plan-stage-syntax"></a>

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

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

```
{
  "[DurationInMinutes](#cfn-ssmcontacts-plan-stage-durationinminutes)" : Integer,
  "[Targets](#cfn-ssmcontacts-plan-stage-targets)" : [ Targets, ... ]
}
```

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

```
  [DurationInMinutes](#cfn-ssmcontacts-plan-stage-durationinminutes): Integer
  [Targets](#cfn-ssmcontacts-plan-stage-targets): 
    - Targets
```

## Properties
<a name="aws-properties-ssmcontacts-plan-stage-properties"></a>

`DurationInMinutes`  <a name="cfn-ssmcontacts-plan-stage-durationinminutes"></a>
The time to wait until beginning the next stage. The duration can only be set to 0 if a target is specified.  
*Required*: Yes  
*Type*: Integer  
*Minimum*: `0`  
*Maximum*: `30`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Targets`  <a name="cfn-ssmcontacts-plan-stage-targets"></a>
The contacts or contact methods that the escalation plan or engagement plan is engaging.  
*Required*: No  
*Type*: [Array](aws-properties-ssmcontacts-plan-targets.md) of [Targets](aws-properties-ssmcontacts-plan-targets.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::Plan Targets
<a name="aws-properties-ssmcontacts-plan-targets"></a>

The contact or contact channel that's being engaged.

## Syntax
<a name="aws-properties-ssmcontacts-plan-targets-syntax"></a>

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

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

```
{
  "[ChannelTargetInfo](#cfn-ssmcontacts-plan-targets-channeltargetinfo)" : ChannelTargetInfo,
  "[ContactTargetInfo](#cfn-ssmcontacts-plan-targets-contacttargetinfo)" : ContactTargetInfo
}
```

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

```
  [ChannelTargetInfo](#cfn-ssmcontacts-plan-targets-channeltargetinfo): 
    ChannelTargetInfo
  [ContactTargetInfo](#cfn-ssmcontacts-plan-targets-contacttargetinfo): 
    ContactTargetInfo
```

## Properties
<a name="aws-properties-ssmcontacts-plan-targets-properties"></a>

`ChannelTargetInfo`  <a name="cfn-ssmcontacts-plan-targets-channeltargetinfo"></a>
Information about the contact channel that Incident Manager engages.  
*Required*: No  
*Type*: [ChannelTargetInfo](aws-properties-ssmcontacts-plan-channeltargetinfo.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ContactTargetInfo`  <a name="cfn-ssmcontacts-plan-targets-contacttargetinfo"></a>
Information about the contact that Incident Manager engages.  
*Required*: No  
*Type*: [ContactTargetInfo](aws-properties-ssmcontacts-plan-contacttargetinfo.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)