You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::ElastiCache::Types::DescribeEventsMessage

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing DescribeEventsMessage as input to an Aws::Client method, you can use a vanilla Hash:

{
  source_identifier: "String",
  source_type: "cache-cluster", # accepts cache-cluster, cache-parameter-group, cache-security-group, cache-subnet-group, replication-group
  start_time: Time.now,
  end_time: Time.now,
  duration: 1,
  max_records: 1,
  marker: "String",
}

Represents the input of a DescribeEvents operation.

Instance Attribute Summary collapse

Instance Attribute Details

#durationInteger

The number of minutes worth of events to retrieve.

Returns:

  • (Integer)

    The number of minutes worth of events to retrieve.

#end_timeTime

The end of the time interval for which to retrieve events, specified in ISO 8601 format.

Example: 2017-03-30T07:03:49.555Z

Returns:

  • (Time)

    The end of the time interval for which to retrieve events, specified in ISO 8601 format.

#markerString

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.

Returns:

  • (String)

    An optional marker returned from a prior request.

#max_recordsInteger

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.

Returns:

  • (Integer)

    The maximum number of records to include in the response.

#source_identifierString

The identifier of the event source for which events are returned. If not specified, all sources are included in the response.

Returns:

  • (String)

    The identifier of the event source for which events are returned.

#source_typeString

The event source to retrieve events for. If no value is specified, all events are returned.

Possible values:

  • cache-cluster
  • cache-parameter-group
  • cache-security-group
  • cache-subnet-group
  • replication-group

Returns:

  • (String)

    The event source to retrieve events for.

#start_timeTime

The beginning of the time interval to retrieve events for, specified in ISO 8601 format.

Example: 2017-03-30T07:03:49.555Z

Returns:

  • (Time)

    The beginning of the time interval to retrieve events for, specified in ISO 8601 format.