(Optional) Set up Amazon SNS to receive notifications about OpsItems - Amazon Systems Manager
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

(Optional) Set up Amazon SNS to receive notifications about OpsItems

You can configure OpsCenter to send notifications to an Amazon Simple Notification Service (Amazon SNS) topic when the system creates an OpsItem or updates an existing OpsItem.

Complete the following steps to receive notifications for OpsItems.

Step 1: Creating and subscribing to an Amazon SNS topic

To receive notifications, you must create and subscribe to an Amazon SNS topic. For more information, see Creating an Amazon SNS topic and Subscribing to an Amazon SNS topic in the Amazon Simple Notification Service Developer Guide.

Note

If you're using OpsCenter in multiple Amazon Web Services Regions or accounts, you must create and subscribe to an Amazon SNS topic in each Region or account where you want to receive OpsItem notifications.

Step 2: Updating the Amazon SNS access policy

You have to associate an Amazon SNS topic with OpsItems. Use the following procedure to set up an Amazon SNS access policy so that Systems Manager can publish OpsItems notifications to the Amazon SNS topic that you created in Step 1.

  1. Sign in to the Amazon Web Services Management Console and open the Amazon SNS console at https://console.amazonaws.cn/sns/v3/home.

  2. In the navigation pane, choose Topics.

  3. Choose the topic that you created in Step 1, and then choose Edit.

  4. Expand Access policy.

  5. Add the following Sid block to the existing policy. Replace each example resource placeholder with your own information.

    { "Sid": "Allow OpsCenter to publish to this topic", "Effect": "Allow", "Principal": { "Service": "ssm.amazonaws.com.cn" }, "Action": "SNS:Publish", "Resource": "arn:aws-cn:sns:region:account ID:topic name", // Account ID of the SNS topic owner "Condition": { "StringEquals": { "AWS:SourceAccount": "account ID" // Account ID of the OpsItem owner } } }
    Note

    The aws:SourceAccount global condition key protects against the confused deputy scenario. To use this condition key, set the value to the account ID of the OpsItem owner. For more information, see Confused Deputy in the IAM User Guide.

  6. Choose Save changes.

The system now sends notifications to the Amazon SNS topic when OpsItems are created or updated.

Important

If you configure the Amazon SNS topic with an Amazon Key Management Service (Amazon KMS) server-side encryption key in the Step 2, then complete Step 3. Otherwise, you can skip Step 3.

Step 3: Updating the Amazon KMS access policy

If you turned on Amazon KMS server-side encryption for your Amazon SNS topic, you must also update the access policy of the Amazon KMS key that you chose when you configured the topic. Use the following procedure to update the access policy so that Systems Manager can publish OpsItem notifications to the Amazon SNS topic you created in Step 1.

Note

OpsCenter doesn't support publishing OpsItems to an Amazon SNS topic that is configured with an Amazon managed key.

  1. Open the Amazon KMS console at https://console.amazonaws.cn/kms.

  2. To change the Amazon Web Services Region, use the Region selector in the upper-right corner of the page.

  3. In the navigation pane, choose Customer managed keys.

  4. Choose the ID of the KMS key that you chose when you created the topic.

  5. In the Key policy section, choose Switch to policy view.

  6. Choose Edit.

  7. Add the following Sid block to the existing policy. Replace each example resource placeholder with your own information.

    { "Sid": "Allow OpsItems to decrypt the key", "Effect": "Allow", "Principal": { "Service": "ssm.amazonaws.com.cn" }, "Action": ["kms:Decrypt", "kms:GenerateDataKey*"], "Resource": "arn:aws-cn:kms:region:account ID:key/key ID" }

    In the following example, the new block is entered at line 14.

    
                                Editing the Amazon KMS access policy of an Amazon SNS topic.
  8. Choose Save changes.

Step 4: Turning on default OpsItems rules to send notifications for new OpsItems

Default OpsItems rules in Amazon EventBridge aren't configured with an Amazon Resource Name (ARN) for Amazon SNS notifications. Use the following procedure to edit a rule in EventBridge and enter a notifications block.

To add a notifications block to a default OpsItem rule
  1. Open the Amazon Systems Manager console at https://console.amazonaws.cn/systems-manager/.

  2. In the navigation pane, choose OpsCenter.

  3. Choose the OpsItems tab, and then choose Configure sources.

  4. Choose the name of the source rule that you want to configure with a notifications block, as shown in the following example.

    
                                Choosing an Amazon EventBridge rule to add an Amazon SNS notifications
                                    block.

    The rule opens in Amazon EventBridge.

  5. On the rule details page, on the Targets tab, choose Edit.

  6. In the Additional settings section, choose Configure input transformer.

  7. In the Template box, add a notifications block in the following format.

    "notifications":[{"arn":"arn:aws-cn:sns:region:account ID:topic name"}],

    Here's an example.

    "notifications":[{"arn":"arn:aws:sns:us-west-2:1234567890:MySNSTopic"}],

    Enter the notifications block before the resources block, as shown in the following example for the US West (Oregon) (us-west-2) Region.

    { "title": "EBS snapshot copy failed", "description": "CloudWatch Event Rule SSMOpsItems-EBS-snapshot-copy-failed was triggered. Your EBS snapshot copy has failed. See below for more details.", "category": "Availability", "severity": "2", "source": "EC2", "notifications": [{ "arn": "arn:aws:sns:us-west-2:1234567890:MySNSTopic" }], "resources": <resources>, "operationalData": { "/aws/dedup": { "type": "SearchableString", "value": "{\"dedupString\":\"SSMOpsItems-EBS-snapshot-copy-failed\"}" }, "/aws/automations": { "value": "[ { \"automationType\": \"AWS:SSM:Automation\", \"automationId\": \"AWS-CopySnapshot\" } ]" }, "failure-cause": { "value": <failure - cause> }, "source": { "value": <source> }, "start-time": { "value": <start - time> }, "end-time": { "value": <end - time> } } }
  8. Choose Confirm.

  9. Choose Next.

  10. Choose Next.

  11. Choose Update rule.

The next time that the system creates an OpsItem for the default rule, it publishes a notification to the Amazon SNS topic.