events

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

Overview

Name	events
Type	Resource
Id	aws.elasticache.events

Fields

The following fields are returned by SELECT queries:

describe_events

Name	Datatype	Description
date	string	The date and time when the event occurred.
message	string	The text of the event.
source_identifier	string	The identifier for the source of the event. For example, if the event occurred at the cluster level, the identifier would be the name of the cluster.
source_type	string	Specifies the origin of this event - a cluster, a parameter group, a security group, etc.

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, MaxRecords, Marker	Returns events related to clusters, cache security groups, and cache parameter groups. You can obtain events specific to a particular cluster, cache security group, or cache parameter group by providing the name as a parameter. By default, only the events occurring within the last hour are returned; however, you can retrieve up to 14 days' worth of events if necessary.

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 worth of events to retrieve.
EndTime	string (date-time)	The end of the time interval for which to retrieve events, specified in ISO 8601 format. Example: 2017-03-30T07:03:49.555Z
Marker	string	An optional marker returned from a prior request. Use this marker for pagination of results from this operation. 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 marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: minimum 20; maximum 100.
SourceIdentifier	string	The identifier of the event source for which events are returned. If not specified, all sources are included in the response.
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. Example: 2017-03-30T07:03:49.555Z

SELECT examples

describe_events

Returns events related to clusters, cache security groups, and cache parameter groups. You can obtain events specific to a particular cluster, cache security group, or cache parameter group by providing the name as a parameter. By default, only the events occurring within the last hour are returned; however, you can retrieve up to 14 days' worth of events if necessary.

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