AWS::SSMIncidents::ResponsePlan IncidentTemplate - AWS CloudFormation
SyntaxProperties

AWS::SSMIncidents::ResponsePlan IncidentTemplate

The IncidentTemplate property type specifies details used to create an incident when using this response plan.

Syntax

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

JSON

{
  "DedupeString" : String,
  "Impact" : Integer,
  "IncidentTags" : [ Tag, ... ],
  "NotificationTargets" : [ NotificationTargetItem, ... ],
  "Summary" : String,
  "Title" : String
}

Properties

DedupeString

Used to create only one incident record for an incident.

Required: No

Type: String

Minimum: 1

Maximum: 1000

Update requires: No interruption

Impact

Defines the impact to the customers. Providing an impact overwrites the impact provided by a response plan.

Possible impacts:

  • 1 - Critical impact, this typically relates to full application failure that impacts many to all customers.

  • 2 - High impact, partial application failure with impact to many customers.

  • 3 - Medium impact, the application is providing reduced service to customers.

  • 4 - Low impact, customer might aren't impacted by the problem yet.

  • 5 - No impact, customers aren't currently impacted but urgent action is needed to avoid impact.

Required: Yes

Type: Integer

Minimum: 1

Maximum: 5

Update requires: No interruption

IncidentTags

Tags to assign to the template. When the StartIncident API action is called, Incident Manager assigns the tags specified in the template to the incident.

Required: No

Type: Array of Tag

Maximum: 50

Update requires: No interruption

NotificationTargets

The Amazon Simple Notification Service (Amazon SNS) targets that AWS Chatbot uses to notify the chat channel of updates to an incident. You can also make updates to the incident through the chat channel using the Amazon SNS topics.

Required: No

Type: Array of NotificationTargetItem

Maximum: 10

Update requires: No interruption

Summary

The summary describes what has happened during the incident.

Required: No

Type: String

Minimum: 1

Maximum: 4000

Update requires: No interruption

Title

The title of the incident is a brief and easily recognizable.

Required: Yes

Type: String

Maximum: 200

Update requires: No interruption