Tutorial: Sending Amazon SNS alerts for available software updates - Amazon OpenSearch Service (successor to Amazon Elasticsearch Service)

Tutorial: Sending Amazon SNS alerts for available software updates

In this tutorial, you configure an Amazon EventBridge event rule that captures notifications for available service software updates in Amazon OpenSearch Service and sends you an email notification through Amazon Simple Notification Service (Amazon SNS).

Prerequisites

This tutorial assumes that you have an existing OpenSearch Service domain. If you haven't created a domain, follow the steps in Creating and managing Amazon OpenSearch Service domains to create one.

Step 1: Create and subscribe to an Amazon SNS topic

Configure an Amazon SNS topic to serve as an event target for your new event rule.

To create an Amazon SNS target

  1. Open the Amazon SNS console at https://console.aws.amazon.com/sns/v3/home.

  2. Choose Topics and Create topic.

  3. For the job type, choose Standard, and name the job software-update.

  4. Choose Create topic.

  5. After the topic is created, choose Create subscription.

  6. For Protocol, choose Email. For Endpoint, enter an email address that you currently have access to and choose Create subscription.

  7. Check your email account and wait to receive a subscription confirmation email message. When you receive it, choose Confirm subscription.

Step 2: Register an event rule

Next, register an event rule that captures only service software update events.

To create an event rule

  1. Open the EventBridge console at https://console.aws.amazon.com/events/.

  2. Choose Create rule.

  3. Name the rule softwareupdate-rule.

  4. For Define pattern, choose Event pattern, then choose Custom pattern.

  5. Paste the following event pattern into the text area:

    { "source": ["aws.es"], "detail-type": ["Amazon OpenSearch Service Software Update Notification"] }

    Press Save after adding the pattern. This pattern matches any service software update event from OpenSearch Service. For more information about event patterns, see Amazon EventBridge event patterns in the Amazon EventBridge User Guide.

  6. For Target, choose SNS topic and select software-update.

  7. Choose Create.

The next time you receive a notification from OpenSearch Service about an available service software update, if everything is configured properly, Amazon SNS should send you an email alert about the update.