Amazon DocumentDB (with MongoDB compatibility) keeps a record of events that relate to your clusters, instances, snapshots, security groups, and cluster parameter groups. This information includes the date and time of the event, the source name and source type of the event, and a message that is associated with the event.
Important
For certain management features, Amazon DocumentDB uses operational technology that is shared with Amazon RDS and Amazon Neptune. Region limits, limits that are governed at the Region level, are shared between Amazon DocumentDB, Amazon RDS, and Amazon Neptune. For more information, see Regional quotas.
Viewing Amazon DocumentDB event categories
Each Amazon DocumentDB resource type has specific types of events that can be associated with it. You can use the AWS CLI describe-event-categories
operation to view the mapping between event types and Amazon DocumentDB resource types.
Parameters
-
--source-type—Optional. Use the--source-typeparameter to see the event categories for a particular source type. The following are permitted values:-
db-cluster -
db-instance -
db-parameter-group -
db-security-group -
db-cluster-snapshot
-
-
--filters—Optional. To view the event categories for just Amazon DocumentDB, use the filter--filter Name=engine,Values=docdb.
The following code lists the event categories associated with clusters.
For Linux, macOS, or Unix:
aws docdb describe-event-categories \ --filter Name=engine,Values=docdb \ --source-typedb-cluster
For Windows:
aws docdb describe-event-categories ^ --filter Name=engine,Values=docdb ^ --source-typedb-cluster
Output from this operation looks something like the following (JSON format).
{
"EventCategoriesMapList": [
{
"EventCategories": [
"notification",
"failure",
"maintenance",
"failover"
],
"SourceType": "db-cluster"
}
]
}The following code lists the event categories that are associated with each Amazon DocumentDB source type.
aws docdb describe-event-categories
Output from this operation looks something like the following (JSON format).
{
"EventCategoriesMapList": [
{
"SourceType": "db-instance",
"EventCategories": [
"notification",
"failure",
"creation",
"maintenance",
"deletion",
"recovery",
"restoration",
"configuration change",
"read replica",
"backtrack",
"low storage",
"backup",
"availability",
"failover"
]
},
{
"SourceType": "db-security-group",
"EventCategories": [
"configuration change",
"failure"
]
},
{
"SourceType": "db-parameter-group",
"EventCategories": [
"configuration change"
]
},
{
"SourceType": "db-cluster",
"EventCategories": [
"notification",
"failure",
"maintenance",
"failover"
]
},
{
"SourceType": "db-cluster-snapshot",
"EventCategories": [
"backup"
]
}
]
}Viewing Amazon DocumentDB events
You can retrieve events for your Amazon DocumentDB resources through the Amazon DocumentDB console, which shows events from the past 24 hours. You can also retrieve events for your Amazon DocumentDB resources by using the describe-events AWS CLI command, or the DescribeEvents Amazon DocumentDB API operation. If you use the AWS CLI or the Amazon DocumentDB API to view events, you can retrieve events for up to the past 14 days.
To view all Amazon DocumentDB instance events for the past 24 hours
Sign in to the AWS Management Console, and open the Amazon DocumentDB console at https://console.aws.amazon.com/docdb
. -
In the navigation pane, choose Events. The available events appear in a list.
-
Use the Filter list to filter the events by type. Enter a term in the text box to further filter your results. For example, the following screenshot shows filtering all Amazon DocumentDB events for snapshot events.
For more information, see Auditing Amazon DocumentDB events.
