aws_ssm_incidents_response_plan

account_id

Type: STRING

actions

Type: UNORDERED_LIST_STRUCT
Provider name: actions
Description: The actions that this response plan takes at the beginning of the incident.

• ssm_automation
  Type: STRUCT
  Provider name: ssmAutomation
  Description: The Systems Manager automation document to start as the runbook at the beginning of the incident.
  
  • document_name
    Type: STRING
    Provider name: documentName
    Description: The automation document’s name.
    
  • document_version
    Type: STRING
    Provider name: documentVersion
    Description: The automation document’s version to use when running.
    
  • dynamic_parameters
    Type: STRING
    Provider name: dynamicParameters
    Description: The key-value pair to resolve dynamic parameter values when processing a Systems Manager Automation runbook.
    
  • parameters
    Type: STRING
    Provider name: parameters
    Description: The key-value pair parameters to use when running the automation document.
    
  • role_arn
    Type: STRING
    Provider name: roleArn
    Description: The Amazon Resource Name (ARN) of the role that the automation document will assume when running commands.
    
  • target_account
    Type: STRING
    Provider name: targetAccount
    Description: The account that the automation document will be run in. This can be in either the management account or an application account.
    

arn

Type: STRING
Provider name: arn
Description: The ARN of the response plan.

chat_channel

Type: STRUCT
Provider name: chatChannel
Description: The Chatbot chat channel used for collaboration during an incident.

• chatbot_sns
  Type: UNORDERED_LIST_STRING
  Provider name: chatbotSns
  Description: The Amazon SNS targets that Chatbot uses to notify the chat channel of updates to an incident. You can also make updates to the incident through the chat channel by using the Amazon SNS topics.
  
• empty
  Type: STRUCT
  Provider name: empty
  Description: Used to remove the chat channel from an incident record or response plan.
  

engagements

Type: UNORDERED_LIST_STRING
Provider name: engagements
Description: The Amazon Resource Name (ARN) for the contacts and escalation plans that the response plan engages during an incident.

incident_template

Type: STRUCT
Provider name: incidentTemplate
Description: Details used to create the incident when using this response plan.

• dedupe_string
  Type: STRING
  Provider name: dedupeString
  Description: The string Incident Manager uses to prevent the same root cause from creating multiple incidents in the same account. A deduplication string is a term or phrase the system uses to check for duplicate incidents. If you specify a deduplication string, Incident Manager searches for open incidents that contain the same string in the dedupeString field when it creates the incident. If a duplicate is detected, Incident Manager deduplicates the newer incident into the existing incident. By default, Incident Manager automatically deduplicates multiple incidents created by the same Amazon CloudWatch alarm or Amazon EventBridge event. You don’t have to enter your own deduplication string to prevent duplication for these resource types.
  
• impact
  Type: INT32
  Provider name: impact
  Description: The impact of the incident on your customers and applications.

  Supported impact codes

  • 1 - Critical
  • 2 - High
  • 3 - Medium
  • 4 - Low
  • 5 - No Impact
• incident_tags
  Type: MAP_STRING_STRING
  Provider name: incidentTags
  Description: 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.
  
• notification_targets
  Type: UNORDERED_LIST_STRUCT
  Provider name: notificationTargets
  Description: The Amazon SNS targets that are notified when updates are made to an incident.
  
  • sns_topic_arn
    Type: STRING
    Provider name: snsTopicArn
    Description: The Amazon Resource Name (ARN) of the SNS topic.
    
• summary
  Type: STRING
  Provider name: summary
  Description: The summary of the incident. The summary is a brief synopsis of what occurred, what’s currently happening, and context.
  
• title
  Type: STRING
  Provider name: title
  Description: The title of the incident.
  

integrations

Type: UNORDERED_LIST_STRUCT
Provider name: integrations
Description: Information about third-party services integrated into the Incident Manager response plan.

• pager_duty_configuration
  Type: STRUCT
  Provider name: pagerDutyConfiguration
  Description: Information about the PagerDuty service where the response plan creates an incident.
  
  • name
    Type: STRING
    Provider name: name
    Description: The name of the PagerDuty configuration.
    
  • pager_duty_incident_configuration
    Type: STRUCT
    Provider name: pagerDutyIncidentConfiguration
    Description: Details about the PagerDuty service associated with the configuration.
    
    • service_id
      Type: STRING
      Provider name: serviceId
      Description: The ID of the PagerDuty service that the response plan associates with an incident when it launches.
      
  • secret_id
    Type: STRING
    Provider name: secretId
    Description: The ID of the Amazon Web Services Secrets Manager secret that stores your PagerDuty key, either a General Access REST API Key or User Token REST API Key, and other user credentials.
    

name

Type: STRING
Provider name: name
Description: The short format name of the response plan. The name can’t contain spaces.

tags

Type: UNORDERED_LIST_STRING