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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-elasticache/types.rb

Overview

Note:

When making an API call, you may pass DescribeEventsMessage data as a 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.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#duration ⇒ Integer

The number of minutes worth of events to retrieve.

Returns:

  • (Integer) 


2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
 
# File 'lib/aws-sdk-elasticache/types.rb', line 2909

class DescribeEventsMessage < Struct.new(
  :source_identifier,
  :source_type,
  :start_time,
  :end_time,
  :duration,
  :max_records,
  :marker)
  include Aws::Structure
end

#end_time ⇒ Time

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) 


2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
 
# File 'lib/aws-sdk-elasticache/types.rb', line 2909

class DescribeEventsMessage < Struct.new(
  :source_identifier,
  :source_type,
  :start_time,
  :end_time,
  :duration,
  :max_records,
  :marker)
  include Aws::Structure
end

#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`.

Returns:

  • (String) 


2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
 
# File 'lib/aws-sdk-elasticache/types.rb', line 2909

class DescribeEventsMessage < Struct.new(
  :source_identifier,
  :source_type,
  :start_time,
  :end_time,
  :duration,
  :max_records,
  :marker)
  include Aws::Structure
end

#max_records ⇒ 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.

Returns:

  • (Integer) 


2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
 
# File 'lib/aws-sdk-elasticache/types.rb', line 2909

class DescribeEventsMessage < Struct.new(
  :source_identifier,
  :source_type,
  :start_time,
  :end_time,
  :duration,
  :max_records,
  :marker)
  include Aws::Structure
end

#source_identifier ⇒ String

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

Returns:

  • (String) 


2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
 
# File 'lib/aws-sdk-elasticache/types.rb', line 2909

class DescribeEventsMessage < Struct.new(
  :source_identifier,
  :source_type,
  :start_time,
  :end_time,
  :duration,
  :max_records,
  :marker)
  include Aws::Structure
end

#source_type ⇒ String

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

Returns:

  • (String) 


2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
 
# File 'lib/aws-sdk-elasticache/types.rb', line 2909

class DescribeEventsMessage < Struct.new(
  :source_identifier,
  :source_type,
  :start_time,
  :end_time,
  :duration,
  :max_records,
  :marker)
  include Aws::Structure
end

#start_time ⇒ Time

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

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

Returns:

  • (Time) 


2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
 
# File 'lib/aws-sdk-elasticache/types.rb', line 2909

class DescribeEventsMessage < Struct.new(
  :source_identifier,
  :source_type,
  :start_time,
  :end_time,
  :duration,
  :max_records,
  :marker)
  include Aws::Structure
end