response_plans

Creates, updates, deletes or gets a response_plan resource or lists response_plans in a region

Overview

Name	response_plans
Type	Resource
Description	Resource type definition for AWS::SSMIncidents::ResponsePlan
Id	aws.ssmincidents.response_plans

Fields

Name	Datatype	Description
arn	string	The ARN of the response plan.
name	string	The name of the response plan.
display_name	string	The display name of the response plan.
chat_channel	object	The chat channel configuration.
engagements	array	The list of engagements to use.
actions	array	The list of actions.
integrations	array	The list of integrations.
tags	array	The tags to apply to the response plan.
incident_template	object	The incident template configuration.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	Name, IncidentTemplate, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all response_plans in a region.

SELECT
region,
arn,
name,
display_name,
chat_channel,
engagements,
actions,
integrations,
tags,
incident_template
FROM aws.ssmincidents.response_plans
WHERE region = 'us-east-1';

Gets all properties from an individual response_plan.

SELECT
region,
arn,
name,
display_name,
chat_channel,
engagements,
actions,
integrations,
tags,
incident_template
FROM aws.ssmincidents.response_plans
WHERE region = 'us-east-1' AND data__Identifier = '<Arn>';

INSERT example

Use the following StackQL query and manifest file to create a new response_plan resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.ssmincidents.response_plans (
 Name,
 IncidentTemplate,
 region
)
SELECT 
'{{ Name }}',
 '{{ IncidentTemplate }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.ssmincidents.response_plans (
 Name,
 DisplayName,
 ChatChannel,
 Engagements,
 Actions,
 Integrations,
 Tags,
 IncidentTemplate,
 region
)
SELECT 
 '{{ Name }}',
 '{{ DisplayName }}',
 '{{ ChatChannel }}',
 '{{ Engagements }}',
 '{{ Actions }}',
 '{{ Integrations }}',
 '{{ Tags }}',
 '{{ IncidentTemplate }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: response_plan
    props:
      - name: Name
        value: '{{ Name }}'
      - name: DisplayName
        value: '{{ DisplayName }}'
      - name: ChatChannel
        value:
          ChatbotSns:
            - '{{ ChatbotSns[0] }}'
      - name: Engagements
        value:
          - '{{ Engagements[0] }}'
      - name: Actions
        value:
          - SsmAutomation:
              RoleArn: '{{ RoleArn }}'
              DocumentName: '{{ DocumentName }}'
              DocumentVersion: '{{ DocumentVersion }}'
              TargetAccount: '{{ TargetAccount }}'
              Parameters:
                - Key: '{{ Key }}'
                  Values:
                    - '{{ Values[0] }}'
              DynamicParameters:
                - Key: '{{ Key }}'
                  Value:
                    Variable: '{{ Variable }}'
      - name: Integrations
        value:
          - PagerDutyConfiguration:
              Name: '{{ Name }}'
              SecretId: '{{ SecretId }}'
              PagerDutyIncidentConfiguration:
                ServiceId: '{{ ServiceId }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'
      - name: IncidentTemplate
        value:
          DedupeString: '{{ DedupeString }}'
          Impact: '{{ Impact }}'
          NotificationTargets:
            - SnsTopicArn: null
          Summary: '{{ Summary }}'
          Title: '{{ Title }}'
          IncidentTags:
            - null

DELETE example

/*+ delete */
DELETE FROM aws.ssmincidents.response_plans
WHERE data__Identifier = '<Arn>'
AND region = 'us-east-1';

Permissions

To operate on the response_plans resource, the following permissions are required:

Create

ssm-incidents:CreateResponsePlan,
ssm-incidents:GetResponsePlan,
ssm-incidents:TagResource,
ssm-incidents:ListTagsForResource,
iam:PassRole,
secretsmanager:GetSecretValue,
kms:Decrypt,
kms:GenerateDataKey,
kms:GenerateDataKeyPair,
kms:GenerateDataKeyPairWithoutPlaintext,
kms:GenerateDataKeyWithoutPlaintext

Read

ssm-incidents:GetResponsePlan,
ssm-incidents:ListTagsForResource

Update

ssm-incidents:UpdateResponsePlan,
ssm-incidents:GetResponsePlan,
ssm-incidents:TagResource,
ssm-incidents:UntagResource,
ssm-incidents:ListTagsForResource,
iam:PassRole,
secretsmanager:GetSecretValue,
kms:Decrypt,
kms:GenerateDataKey,
kms:GenerateDataKeyPair,
kms:GenerateDataKeyPairWithoutPlaintext,
kms:GenerateDataKeyWithoutPlaintext

Delete

ssm-incidents:DeleteResponsePlan,
ssm-incidents:GetResponsePlan

List

ssm-incidents:ListResponsePlans