| « PreviousNext » | |
   | Did this page help you? Yes | No | Tell us about it... |
Using Amazon RDS Event Notification
Topics
- Amazon RDS Event Categories and Event Messages
- Subscribing to RDS Event Notification
- Listing Your RDS Event Notification Subscriptions
- Modifying an RDS Event Notification Subscription
- Adding a Source Identifier to an RDS Event Notification Subscription
- Removing a Source identifier from an RDS Event Notification Subscription
- Listing the RDS Event Notification Categories
- Deleting an RDS Event Notification Subscription
Amazon RDS uses the Amazon Simple Notification Service (SNS) to provide notification when an Amazon RDS event occurs. These notifications can be in any notification form supported by SNS for a 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 RDS console or by setting the
Enabled parameter to false using the CLI or
RDS API.
Note
RDS event notifications using SMS text messages are currently available for topic ARNs and RDS resources in the 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 SNS topic to identify each subscription. The 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 SNS console or the SNS API when you create a subscription.
Billing for RDS event notification is through the Amazon Simple Notification Service (SNS). SNS fees apply when using event notification; for more information on SNS billing, see Amazon Simple Notification Service (SNS) Pricing.
The process for subscribing to RDS event notification is as follows:
Create an RDS event notification subscription by using the RDS console, CLI, or API.
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.
When you have confirmed the subscription, the status of your subscription is updated in the RDS console's My Event Subscriptions section.
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, 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 | 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-0002 |
A manual backup of the DB instance is complete. |
|
Backup | RDS-EVENT-0001 |
A manual backup of the DB instance has started. |
|
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. |
|
Failover | RDS-EVENT-0049 |
A Multi-AZ failover that resulted in the promotion of a standby instance is complete. Your database should be accessible now. |
|
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. |
|
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. |
| Notification | RDS-EVENT-0044 | Operator-issued notification. For more information, see the event message. |
| Notification | RDS-EVENT-0045 | An error has occurrred 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. |
| Notification | RDS-EVENT-0046 | The 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. |
| Notification | RDS-EVENT-0047 | The 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. |
|
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. |
|
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
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
Subscribing to RDS Event Notification
You can create an 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 SNS topic and subscribe to that topic with the Amazon SNS console or 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 Get Started with Amazon SNS.
You can specify the type of source you want to be notified of and the RDS source that triggers the event. These are defined by the SourceType (type of source) and the SourceIdentifier (the 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 RDS sources. If you do not specify either the SourceType nor the SourceIdentifier, you will be notified of events generated from all RDS sources belonging to your customer account.
AWS Management Console
To subscribe to RDS event notification
Sign in to the AWS Management Console and open the Amazon RDS console at https://console.aws.amazon.com/rds/.
In the Amazon RDS Console navigation pane, click Event Subscriptions.
In the Event Subscriptions pane, click Create Event Subscription.
In the Create Event Subscription dialog box, do the following:
Type a name for the event notification subscription in the Name textbox.
Select an existing SNS Amazon Resource Name (ARN) for an SNS topic in the Send notifications to dropdown menu or click create topic to enter the name of a topic and a list of recepients.
Select a source type from the Source Type dropdown menu.
Select Yes to enable the subscription. If you want to create the subscription but to not have notifications sent yet, select No.
Depending on the source type you selected, select the event categories and sources you want to receive event notifications for.
Click Yes, Create.
The RDS console indicates that the subscription is being created.
CLI
API
Listing Your RDS Event Notification Subscriptions
You can list your current RDS event notification subscriptions.
AWS Management Console
To list your current RDS event notification subscriptions
Sign in to the AWS Management Console and open the Amazon RDS console at https://console.aws.amazon.com/rds/.
In the Amazon RDS Console navigation pane, click Event Subscriptions. The Event Subscriptions pane shows all your event notification subscriptions.
CLI
To list your current RDS event notification subscriptions
Use the
rds-describe-event-subscriptionscommand.
API
Modifying an 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 RDS event notification subscription
Sign in to the AWS Management Console and open the Amazon RDS console at https://console.aws.amazon.com/rds/.
In the Amazon RDS Console navigation pane, click Event Notification.
In the DB Event Notifications pane, select the subscription that you want to modify.
Make your changes to the subscription in the lower pane.
Click Update. The RDS console indicates that the subscription is being modified.
CLI
API
Adding a Source Identifier to an RDS Event Notification Subscription
You can add a source identifier (the RDS source generating the event) to an existing subscription.
AWS Management Console
To add a source identifier to an RDS event notification subscription
You can easily add or remove source identifiers using the RDS console by selecting or deselecting them when modifying a subscription. See the topic Modifying an RDS Event Notification Subscription for more information.
CLI
To add a source identifier to an RDS event notification subscription
Use the
rds-add-source-identifier-to-subscriptioncommand.
Removing a Source identifier from an RDS Event Notification Subscription
You can remove a source identifier (the 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 RDS event notification subscription
You can easily add or remove source identifiers using the RDS console by selecting or deselecting them when modifying a subscription. See the topic Modifying an RDS Event Notification Subscription for more information.
CLI
To remove a source identifier from an RDS event notification subscription
Use the
rds-remove-source-identifier-from-subscriptioncommand.
Listing the 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 RDS event notification categories
When you create or modify an event notification subscription, the event categories are displayed in the RDS console. See the topic Modifying an RDS Event Notification Subscription for more information.
CLI
API
Deleting an 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 RDS event notification subscription
Sign in to the AWS Management Console and open the Amazon RDS console at https://console.aws.amazon.com/rds/.
In the Amazon RDS Console navigation pane, click DB Event Subscriptions.
In the My DB Event Subscriptions pane, click the subscription that you want to delete.
Click Delete.
The RDS console indicates that the subscription is being deleted.
