Amazon Relational Database Service
User Guide (API Version 2013-09-09)
« PreviousNext »
View the PDF for this guide.Go to the AWS Discussion Forum for this product.Go to the Kindle Store to download this guide in Kindle format.Did this page help you?  Yes | No |  Tell us about it...

Using Amazon RDS Event Notification

Amazon RDS uses the Amazon Simple Notification Service (Amazon SNS) to provide notification when an Amazon RDS event occurs. These notifications can be in any notification form supported by Amazon SNS for an AWS region, such as an email, a text message, or a call to an HTTP endpoint.

Amazon RDS groups these events into categories that you can subscribe to so that you can be notified when an event in that category occurs. You can subscribe to an event category for a DB instance, DB snapshot, DB security group, or for a DB parameter group. For example, if you subscribe to the Backup category for a given DB instance, you will be notified whenever a backup-related event occurs that affects the DB instance. If you subscribe to a Configuration Change category for a DB security group, you will be notified when the DB security group is changed. You will also receive notification when an event notification subscription changes.

Event notifications are sent to the addresses you provide when you create the subscription. You may want to create several different subscriptions, such as one subscription receiving all event notifications and another subscription that includes only critical events for your production DB instances. You can easily turn off notification without deleting a subscription by setting the Enabled radio button to No in the Amazon RDS console or by setting the Enabled parameter to false using the CLI or Amazon RDS API.

Note

Amazon RDS event notifications using SMS text messages are currently available for topic ARNs and Amazon RDS resources in the US-East (Northern Virginia) Region. For more information on using text messages with SNS, see Sending and Receiving SMS Notifications Using Amazon SNS.

Amazon RDS uses the Amazon Resource Name (ARN) of an Amazon SNS topic to identify each subscription. The Amazon RDS console will create the ARN for you when you create the subscription. If you use the CLI or API, you have to create the ARN by using the Amazon SNS console or the Amazon SNS API when you create a subscription.

Billing for Amazon RDS event notification is through the Amazon Simple Notification Service (Amazon SNS). Amazon SNS fees apply when using event notification; for more information on Amazon SNS billing, see Amazon Simple Notification Service Pricing.

The process for subscribing to Amazon RDS event notification is as follows:

  1. Create an Amazon RDS event notification subscription by using the Amazon RDS console, CLI, or API.

  2. Amazon RDS sends an approval email or SMS message to the addresses you submitted with your subscription. To confirm your subscription, click the link in the notification you were sent.

  3. When you have confirmed the subscription, the status of your subscription is updated in the Amazon RDS console's My Event Subscriptions section.

  4. You will begin to receive event notifications.

The following section lists all categories and events that you can be notified of. It also provides information about subscribing to and working with Amazon RDS event subscriptions.

Amazon RDS Event Categories and Event Messages

Amazon RDS generates a significant number of events in categories that you can subscribe to using the Amazon RDS Console, CLI, or the API. Each category applies to a source type, which can be a DB instance, DB snapshot, DB security group, or DB parameter group.

Event categories for a DB instance source type include: Availability, Backup, Configuration Change, Creation, Deletion, Failover, Failure, Low Storage, Maintenance, Notification, Recovery, and Restoration.

Event categories for a DB snapshot source type include: Creation, Deletion, and Restoration.

Event categories for a DB security group source type include: Configuration Change and Failure.

The event category for a DB parameter group source type is Configuration Change.

The following table shows the event category and a list of events when a DB instance is the source type.

Categories and Events for the DB Instance Source Type

Category

Amazon RDS Event ID

Description

Availability

RDS-EVENT-0006

The DB Instance is restarting and will be unavailable until the restart is complete.

Availability

RDS-EVENT-0004

The DB Instance has shut down.

Availability

RDS-EVENT-0022

An error has occurred while restarting MySQL.

Backup

RDS-EVENT-0001

A manual backup of the DB instance has started.

Backup

RDS-EVENT-0002

A manual backup of the DB instance is complete.

Configuration

Change

RDS-EVENT-0009

The DB instance has been added to a security group.

Configuration

Change

RDS-EVENT-0024

The DB instance is being converted to a Multi-AZ DB instance.

Configuration

Change

RDS-EVENT-0030

The DB instance is being converted to a Single-AZ DB instance.

Configuration

Change

RDS-EVENT-0012

The DB instance class for this DB instance is being changed.

Configuration

Change

RDS-EVENT-0018

The current storage settings for this DB instance is being changed.

Configuration

Change

RDS-EVENT-0011

A parameter group for this DB instance has changed.

Configuration

Change

RDS-EVENT-0028

Automatic backups for this DB instance have been disabled.

Configuration

Change

RDS-EVENT-0032

Automatic backups for this DB instance have been enabled.

Configuration

Change

RDS-EVENT-0033

There are [count] users that match the master user name. Users not tied to a specific host have been reset.

Configuration

Change

RDS-EVENT-0025

The DB instance has been converted to a Multi-AZ DB instance.

Configuration

Change

RDS-EVENT-0029

The DB instance has been converted to a Single-AZ DB instance.

Configuration

Change

RDS-EVENT-0014

The DB instance class for this DB instance has changed.

Configuration

Change

RDS-EVENT-0017

The storage settings for this DB instance has changed.

Configuration

Change

RDS-EVENT-0010

The DB instance has been removed from a security group.

Configuration

Change

RDS-EVENT-0016

The master password for the DB instance has been reset.

Creation

RDS-EVENT-0005

A DB instance is being created.

Deletion

RDS-EVENT-0003

The DB instance is being deleted.

Failover

RDS-EVENT-0034

Amazon RDS is not attempting a requested failover because a failover recently occurred on the DB instance.

Failover

RDS-EVENT-0013

A Multi-AZ failover that resulted in the promotion of a standby instance has started.

Failover

RDS-EVENT-0015

A Multi-AZ failover that resulted in the promotion of a standby instance is complete. It may take several minutes for the DNS to transfer to the new primary DB instance.

NotificationRDS-EVENT-0049A Multi-AZ failover has completed.

Failover

RDS-EVENT-0050

A Multi-AZ activation has started after a successful instance recovery.

Failover

RDS-EVENT-0051

A Multi-AZ activation is complete. Your database should be accessible now.

Failure

RDS-EVENT-0031

The DB instance has failed. We recommend that you begin a point-in-time-restore for the DB instance.

Failure

RDS-EVENT-0036

The DB instance is in an incompatible network. Some of the specified subnet IDs are invalid or do not exist.

Failure

RDS-EVENT-0035

The DB instance has invalid parameters. For example, MySQL could not start because a memory-related parameter is set too high for this instance class, so the customer action would be to modify the memory parameter and reboot the DB instance.

Failure

RDS-EVENT-0058

Error while creating Statspack user account PERFSTAT. Please drop the account before adding the Statspack option.

Low Storage

RDS-EVENT-0007

The allocated storage for the DB instance has been exhausted. To resolve this issue, you should allocate additional storage for the DB instance.

Maintenance

RDS-EVENT-0026

Offline maintenance of the DB instance is taking place. The DB instance is currently unavailable.

Maintenance

RDS-EVENT-0027

Offline maintenance of the DB instance is complete. The DB instance is now available.

NotificationRDS-EVENT-0044Operator-issued notification. For more information, see the event message.
NotificationRDS-EVENT-0045An error has occurred in the read replication process. For more information, see the event message. For information on troubleshooting read replica errors, see Troubleshooting a Read Replica Problem.
NotificationRDS-EVENT-0046The read replica has resumed replication. This message appears when you first create a read replica, and when replication has resumed after an error or after replication was stopped.
NotificationRDS-EVENT-0047The read replication process has been stopped because replication errors have occurred for more than 30 days. The read replica is still accessible for read operations but cannot synchronize with the master instance. We recommend that you delete the read replica and create a new one. For information on troubleshooting a broken read replica, see Troubleshooting a Read Replica Problem.
NotificationRDS-EVENT-0048Patching of the DB instance has been delayed.
NotificationRDS-EVENT-0054The MySQL storage engine you are using is not InnoDB, which is the recommended MySQL storage engine for Amazon RDS. For information on MySQL storage engines, see Amazon RDS Supported Storage Engines.
NotificationRDS-EVENT-0055The number of tables you have for your DB instance exceeds the recommended best practices for Amazon RDS. Please reduce the number of tables on your DB instance. For information on recommended best practices, see Amazon RDS Basic Operational Guidelines.
NotificationRDS-EVENT-0056The number of databases you have for your DB instance exceeds the recommended best practices for Amazon RDS. Please reduce the number of databases on your DB instance. For information on recommended best practices, see Amazon RDS Basic Operational Guidelines.

Recovery

RDS-EVENT-0020

Recovery of the DB instance has started. Recovery time will vary with the amount of data to be recovered.

Recovery

RDS-EVENT-0021

Recovery of the DB instance is complete.

Recovery

RDS-EVENT-0023

A manual backup has been requested but Amazon RDS is currently in the process of creating a DB snapshot. Submit the request again after Amazon RDS has completed the DB snapshot.

Recovery

RDS-EVENT-0052

Recovery of the Multi-AZ instance has started. Recovery time will vary with the amount of data to be recovered.

Recovery

RDS-EVENT-0053

Recovery of the Multi-AZ instance is complete.

Read Replicas

RDS-EVENT-0057

Replication on the read replica was terminated.

Read Replicas

RDS-EVENT-0062

Replication on the read replica was manually stopped.

Replication

RDS-EVENT-0063

Replication on the read replica was reset.

Restoration

RDS-EVENT-0008

The DB instance has been restored from a DB snapshot.

Restoration

RDS-EVENT-0019

The DB instance has been restored from a point-in-time backup.

The following table shows the event category and a list of events when a DB parameter group is the source type.

Categories and Events for the DB Parameter Group Source Type

Category

RDS Event ID

Description

Configuration

Change

RDS-EVENT-0037

The parameter group was modified.

The following tables shows the event category and a list of events when a DB security group is the source type.

Categories and Events for the DB Security Group Source Type

Category

RDS Event ID

Description

Configuration

Change

RDS-EVENT-0038

The security group has been modified.

Failure

RDS-EVENT-0039

The Amazon EC2 security group owned by [user] does not exist; authorization for the security group has been revoked.

The following tables shows the event category and a list of events when a DB snapshot is the source type.

Categories and Events for the DB Snapshot Source Type

Category

RDS Event ID

Description

Creation

RDS-EVENT-0040

A DB snapshot is being created.

Creation

RDS-EVENT-0042

A DB snapshot has been created.

Deletion

RDS-EVENT-0041

A DB snapshot has been deleted.

Notification

RDS-EVENT-0059

Started the copy of DB snapshot [DB snapshot name] from source region [region name].

Failure

RDS-EVENT-0061

The copy of a DB snapshot failed.

Notification

RDS-EVENT-0060

Finished the copy of DB snapshot [DB snapshot name] from source region [region name] in [time] minutes.

Restoration

RDS-EVENT-0043

A DB instance is being restored from a DB snapshot.

Subscribing to Amazon RDS Event Notification

You can create an Amazon RDS event notification subscription so you can be notified when an event occurs for a given DB instance, DB snapshot, DB security group, or DB parameter group. The simplest way to create a subscription is with the RDS console. If you choose to create event notification subscriptions using the CLI or API, you must create an Amazon Simple Notification Service topic and subscribe to that topic with the Amazon SNS console or Amazon SNS API. You will also need to retain the Amazon Resource Name (ARN) of the topic because it is used when submitting CLI commands or API actions. For information on creating an SNS topic and subscribing to it, see Getting Started with Amazon SNS.

You can specify the type of source you want to be notified of and the Amazon RDS source that triggers the event. These are defined by the SourceType (type of source) and the SourceIdentifier (the Amazon RDS source generating the event). If you specify both the SourceType and SourceIdentifier, such as SourceType = db-instance and SourceIdentifier = myDBInstance1, you will receive all the DB_Instance events for the specified source. If you specify a SourceType but do not specify a SourceIdentifier, you will receive notice of the events for that source type for all your Amazon RDS sources. If you do not specify either the SourceType nor the SourceIdentifier, you will be notified of events generated from all Amazon RDS sources belonging to your customer account.

AWS Management Console

To subscribe to RDS event notification

  1. Sign in to the AWS Management Console and open the Amazon RDS console at https://console.aws.amazon.com/rds/.

  2. In the Amazon RDS Console navigation pane, click Event Subscriptions.

  3. In the Event Subscriptions pane, click Create Event Subscription.

  4. In the Create Event Subscription dialog box, do the following:

    1. Type a name for the event notification subscription in the Name text box.

    2. Select an existing Amazon SNS Amazon Resource Name (ARN) for an Amazon SNS topic in the Send notifications to dropdown menu or click create topic to enter the name of a topic and a list of recipients.

    3. Select a source type from the Source Type dropdown menu.

    4. Select Yes to enable the subscription. If you want to create the subscription but to not have notifications sent yet, select No.

    5. Depending on the source type you selected, select the event categories and sources you want to receive event notifications for.

      Console Tags tab

    6. Click Yes, Create.

  5. The Amazon RDS console indicates that the subscription is being created.

    List DB event notification subscriptions

CLI

To subscribe to RDS Event Notification

API

To subscribe to Amazon RDS Event Notification

Listing Your Amazon RDS Event Notification Subscriptions

You can list your current Amazon RDS event notification subscriptions.

AWS Management Console

To list your current Amazon RDS event notification subscriptions

  1. Sign in to the AWS Management Console and open the Amazon RDS console at https://console.aws.amazon.com/rds/.

  2. In the Amazon RDS Console navigation pane, click Event Subscriptions. The Event Subscriptions pane shows all your event notification subscriptions.

    List DB event notification subscriptions

CLI

To list your current Amazon RDS event notification subscriptions

API

To list your current Amazon RDS event notification subscriptions

Modifying an Amazon RDS Event Notification Subscription

After you have created a subscription, you can change the subscription name, source identifier, categories, or topic ARN.

AWS Management Console

To modify an Amazon RDS event notification subscription

  1. Sign in to the AWS Management Console and open the Amazon RDS console at https://console.aws.amazon.com/rds/.

  2. In the Amazon RDS Console navigation pane, click Event Notification.

  3. In the DB Event Notifications pane, select the subscription that you want to modify.

  4. Make your changes to the subscription in the lower pane.

    List DB event notification subscriptions

  5. Click Update. The Amazon RDS console indicates that the subscription is being modified.

    List DB event notification subscriptions

CLI

To modify an Amazon RDS event notification subscription

API

To modify an Amazon RDS Event

Adding a Source Identifier to an Amazon RDS Event Notification Subscription

You can add a source identifier (the Amazon RDS source generating the event) to an existing subscription.

AWS Management Console

To add a source identifier to an Amazon RDS event notification subscription

CLI

To add a source identifier to an Amazon RDS event notification subscription

API

To add a source identifier to an Amazon RDS event notification subscription

Removing a Source identifier from an Amazon RDS Event Notification Subscription

You can remove a source identifier (the Amazon RDS source generating the event) from a subscription if you no longer want to be notified of events for that source.

AWS Management Console

To remove a source identifier from an Amazon RDS event notification subscription

CLI

To remove a source identifier from an Amazon RDS event notification subscription

API

To remove a source identifier from an Amazon RDS event notification subscription

Listing the Amazon RDS Event Notification Categories

All events for a resource type are grouped into categories. To view the list of categories available, use the following procedures.

AWS Management Console

To list the Amazon RDS event notification categories

CLI

To list the Amazon RDS event notification categories

API

To list the Amazon RDS event notification categories

Deleting an Amazon RDS Event Notification Subscription

You can delete a subscription when you no longer need it. All subscribers to the topic will no longer receive event notifications specified by the subscription.

AWS Management Console

To delete an Amazon RDS event notification subscription

  1. Sign in to the AWS Management Console and open the Amazon RDS console at https://console.aws.amazon.com/rds/.

  2. In the Amazon RDS Console navigation pane, click DB Event Subscriptions.

  3. In the My DB Event Subscriptions pane, click the subscription that you want to delete.

  4. Click Delete.

  5. The Amazon RDS console indicates that the subscription is being deleted.

    Delete an event notification subscription

CLI

To delete an Amazon RDS event notification subscription

API

To delete an Amazon RDS event notification subscription