AWS-EnableCloudFormationSNSNotification - AWS Systems Manager Automation runbook reference

AWS-EnableCloudFormationSNSNotification

Description

The AWS-EnableCloudFormationSNSNotification runbook enables Amazon Simple Notification Service (Amazon SNS) notifications for the AWS CloudFormation (AWS CloudFormation) stack you specify.

Run this Automation (console)

Document type

Automation

Owner

Amazon

Platforms

Linux, macOS, Windows

Parameters

  • AutomationAssumeRole

    Type: String

    Description: (Optional) The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that allows Systems Manager Automation to perform the actions on your behalf. If no role is specified, Systems Manager Automation uses the permissions of the user that starts this runbook.

  • StackArn

    Type: String

    Description: (Required) The ARN or name of the AWS CloudFormation stack you want to enable Amazon SNS notifications for.

  • NotificationArn

    Type: String

    Description: (Required) The ARN of the Amazon SNS topic you want to associate with the AWS CloudFormation stack.

Required IAM permissions

The AutomationAssumeRole parameter requires the following actions to use the runbook successfully.

  • ssm:GetAutomationExecution

  • ssm:StartAutomationExecution

  • cloudformation:DescribeStacks

  • cloudformation:UpdateStack

  • kms:Decrypt

  • kms:GenerateDataKey

  • sns:Publish

  • sqs:GetQueueAttributes

Document Steps

  • CheckCfnSnsLimits (aws:executeScript) - Verifies the maximum number of Amazon SNS topics haven't already been associated with the AWS CloudFormation stack you specify.

  • EnableCfnSnsNotification (aws:executeAwsApi) - Enables Amazon SNS notifications for the AWS CloudFormation stack.

  • VerificationCfnSnsNotification (aws:executeScript) - Verifies that Amazon SNS notifications have been enabled for the AWS CloudFormation stack.

Outputs

CheckCfnSnsLimits.NotificationArnList - A list of ARNs that receive Amazon SNS notifications for the AWS CloudFormation stack.

VerificationCfnSnsNotification.VerifySnsTopicsResponse - Response from the API operation confirming Amazon SNS notifications have been enabled for the AWS CloudFormation stack.