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

Class: Aws::DocDB::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: "db-instance", # accepts db-instance, db-parameter-group, db-security-group, db-snapshot, db-cluster, db-cluster-snapshot
  start_time: Time.now,
  end_time: Time.now,
  duration: 1,
  event_categories: ["String"],
  filters: [
    {
      name: "String", # required
      values: ["String"], # required
    },
  ],
  max_records: 1,
  marker: "String",
}

Represents the input to DescribeEvents.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#duration ⇒ Integer

The number of minutes to retrieve events for.

Default: 60

Returns:

  • (Integer) —

    The number of minutes to retrieve events for.

#end_time ⇒ Time

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

Example: 2009-07-08T18:00Z

Returns:

  • (Time) —

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

#event_categories ⇒ Array<String>

A list of event categories that trigger notifications for an event notification subscription.

Returns:

  • (Array<String>) —

    A list of event categories that trigger notifications for an event notification subscription.

#filters ⇒ Array<Types::Filter>

This parameter is not currently supported.

Returns:

  • (Array<Types::Filter>) —

    This parameter is not currently supported.

#marker ⇒ String

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Returns:

  • (String) —

    An optional pagination token provided by a previous request.

#max_records ⇒ Integer

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (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_identifier ⇒ 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 provided, SourceType must also be provided.

  • If the source type is DBInstance, a DBInstanceIdentifier must be provided.

  • If the source type is DBSecurityGroup, a DBSecurityGroupName must be provided.

  • If the source type is DBParameterGroup, a DBParameterGroupName must be provided.

  • If the source type is DBSnapshot, a DBSnapshotIdentifier must be provided.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Returns:

  • (String) —

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

#source_type ⇒ String

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

Possible values:

  • db-instance
  • db-parameter-group
  • db-security-group
  • db-snapshot
  • db-cluster
  • db-cluster-snapshot

Returns:

  • (String) —

    The event source to retrieve events for.

#start_time ⇒ Time

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

Example: 2009-07-08T18:00Z

Returns:

  • (Time) —

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