events

Creates, updates, deletes, gets or lists an events resource.

Overview

Name	events
Type	Resource
Id	aws.rds.events

Fields

The following fields are returned by SELECT queries:

describe_events

Name	Datatype	Description
date	string	Specifies the date and time of the event.
event_categories	string	Specifies the category for the event.
message	string	Provides the text of this event.
source_arn	string	The Amazon Resource Name (ARN) for the event.
source_identifier	string	Provides the identifier for the source of the event.
source_type	string	Specifies the source type for this event.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_events	select	region	SourceIdentifier, SourceType, StartTime, EndTime, Duration, EventCategories, Filters, MaxRecords, Marker	Returns events related to DB instances, DB clusters, DB parameter groups, DB security groups, DB snapshots, DB cluster snapshots, and RDS Proxies for the past 14 days. Events specific to a particular DB instance, DB cluster, DB parameter group, DB security group, DB snapshot, DB cluster snapshot group, or RDS Proxy can be obtained by providing the name as a parameter. For more information on working with events, see Monitoring Amazon RDS events in the Amazon RDS User Guide and Monitoring Amazon Aurora events in the Amazon Aurora User Guide. By default, RDS returns events that were generated in the past hour.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)
Duration	integer	The number of minutes to retrieve events for. Default: 60
EndTime	string (date-time)	The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page. Example: 2009-07-08T18:00Z
EventCategories	array	A list of event categories that trigger notifications for a event notification subscription.
Filters	array	This parameter isn't currently supported.
Marker	string	An optional pagination token provided by a previous DescribeEvents request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
MaxRecords	integer	The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results. Default: 100 Constraints: Minimum 20, maximum 100.
SourceIdentifier	string	The identifier of the event source for which events are returned. If not specified, then all sources are included in the response. Constraints: If SourceIdentifier is supplied, SourceType must also be provided. If the source type is a DB instance, a DBInstanceIdentifier value must be supplied. If the source type is a DB cluster, a DBClusterIdentifier value must be supplied. If the source type is a DB parameter group, a DBParameterGroupName value must be supplied. If the source type is a DB security group, a DBSecurityGroupName value must be supplied. If the source type is a DB snapshot, a DBSnapshotIdentifier value must be supplied. If the source type is a DB cluster snapshot, a DBClusterSnapshotIdentifier value must be supplied. If the source type is an RDS Proxy, a DBProxyName value must be supplied. Can't end with a hyphen or contain two consecutive hyphens.
SourceType	string	The event source to retrieve events for. If no value is specified, all events are returned.
StartTime	string (date-time)	The beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page. Example: 2009-07-08T18:00Z

SELECT examples

describe_events

Returns events related to DB instances, DB clusters, DB parameter groups, DB security groups, DB snapshots, DB cluster snapshots, and RDS Proxies for the past 14 days. Events specific to a particular DB instance, DB cluster, DB parameter group, DB security group, DB snapshot, DB cluster snapshot group, or RDS Proxy can be obtained by providing the name as a parameter. For more information on working with events, see Monitoring Amazon RDS events in the Amazon RDS User Guide and Monitoring Amazon Aurora events in the Amazon Aurora User Guide. By default, RDS returns events that were generated in the past hour.

SELECT
date,
event_categories,
message,
source_arn,
source_identifier,
source_type
FROM aws.rds.events
WHERE region = '{{ region }}' -- required
AND SourceIdentifier = '{{ SourceIdentifier }}'
AND SourceType = '{{ SourceType }}'
AND StartTime = '{{ StartTime }}'
AND EndTime = '{{ EndTime }}'
AND Duration = '{{ Duration }}'
AND EventCategories = '{{ EventCategories }}'
AND Filters = '{{ Filters }}'
AND MaxRecords = '{{ MaxRecords }}'
AND Marker = '{{ Marker }}'
;