Class: Aws::DocDB::Types::DescribeEventsMessage

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

Overview

Note:

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

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#duration ⇒ Integer

The number of minutes to retrieve events for.

Default: 60

Returns:

  • (Integer) 


3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
 
# File 'lib/aws-sdk-docdb/types.rb', line 3566

class DescribeEventsMessage < Struct.new(
  :source_identifier,
  :source_type,
  :start_time,
  :end_time,
  :duration,
  :event_categories,
  :filters,
  :max_records,
  :marker)
  SENSITIVE = []
  include Aws::Structure
end

#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) 


3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
 
# File 'lib/aws-sdk-docdb/types.rb', line 3566

class DescribeEventsMessage < Struct.new(
  :source_identifier,
  :source_type,
  :start_time,
  :end_time,
  :duration,
  :event_categories,
  :filters,
  :max_records,
  :marker)
  SENSITIVE = []
  include Aws::Structure
end

#event_categories ⇒ Array<String>

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

Returns:

  • (Array<String>) 


3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
 
# File 'lib/aws-sdk-docdb/types.rb', line 3566

class DescribeEventsMessage < Struct.new(
  :source_identifier,
  :source_type,
  :start_time,
  :end_time,
  :duration,
  :event_categories,
  :filters,
  :max_records,
  :marker)
  SENSITIVE = []
  include Aws::Structure
end

#filters ⇒ Array<Types::Filter>

This parameter is not currently supported.

Returns:



3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
 
# File 'lib/aws-sdk-docdb/types.rb', line 3566

class DescribeEventsMessage < Struct.new(
  :source_identifier,
  :source_type,
  :start_time,
  :end_time,
  :duration,
  :event_categories,
  :filters,
  :max_records,
  :marker)
  SENSITIVE = []
  include Aws::Structure
end

#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) 


3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
 
# File 'lib/aws-sdk-docdb/types.rb', line 3566

class DescribeEventsMessage < Struct.new(
  :source_identifier,
  :source_type,
  :start_time,
  :end_time,
  :duration,
  :event_categories,
  :filters,
  :max_records,
  :marker)
  SENSITIVE = []
  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 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) 


3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
 
# File 'lib/aws-sdk-docdb/types.rb', line 3566

class DescribeEventsMessage < Struct.new(
  :source_identifier,
  :source_type,
  :start_time,
  :end_time,
  :duration,
  :event_categories,
  :filters,
  :max_records,
  :marker)
  SENSITIVE = []
  include Aws::Structure
end

#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) 


3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
 
# File 'lib/aws-sdk-docdb/types.rb', line 3566

class DescribeEventsMessage < Struct.new(
  :source_identifier,
  :source_type,
  :start_time,
  :end_time,
  :duration,
  :event_categories,
  :filters,
  :max_records,
  :marker)
  SENSITIVE = []
  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) 


3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
 
# File 'lib/aws-sdk-docdb/types.rb', line 3566

class DescribeEventsMessage < Struct.new(
  :source_identifier,
  :source_type,
  :start_time,
  :end_time,
  :duration,
  :event_categories,
  :filters,
  :max_records,
  :marker)
  SENSITIVE = []
  include Aws::Structure
end

#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) 


3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
 
# File 'lib/aws-sdk-docdb/types.rb', line 3566

class DescribeEventsMessage < Struct.new(
  :source_identifier,
  :source_type,
  :start_time,
  :end_time,
  :duration,
  :event_categories,
  :filters,
  :max_records,
  :marker)
  SENSITIVE = []
  include Aws::Structure
end