Class: Aws::RDS::Types::DescribeEventsMessage

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-rds/lib/aws-sdk-rds/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",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#durationInteger

The number of minutes to retrieve events for.

Default: 60

Returns:

  • (Integer)


10428
10429
10430
10431
10432
10433
10434
10435
10436
10437
10438
10439
10440
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 10428

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_timeTime

The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

Example: 2009-07-08T18:00Z

Returns:

  • (Time)


10428
10429
10430
10431
10432
10433
10434
10435
10436
10437
10438
10439
10440
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 10428

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_categoriesArray<String>

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

Returns:

  • (Array<String>)


10428
10429
10430
10431
10432
10433
10434
10435
10436
10437
10438
10439
10440
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 10428

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

#filtersArray<Types::Filter>

This parameter isn't currently supported.

Returns:



10428
10429
10430
10431
10432
10433
10434
10435
10436
10437
10438
10439
10440
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 10428

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

#markerString

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

Returns:

  • (String)


10428
10429
10430
10431
10432
10433
10434
10435
10436
10437
10438
10439
10440
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 10428

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_recordsInteger

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

Returns:

  • (Integer)


10428
10429
10430
10431
10432
10433
10434
10435
10436
10437
10438
10439
10440
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 10428

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_identifierString

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 supplied, SourceType must also be provided.

  • If the source type is a DB instance, a DBInstanceIdentifier value must be supplied.

  • If the source type is a DB cluster, a DBClusterIdentifier value must be supplied.

  • If the source type is a DB parameter group, a DBParameterGroupName value must be supplied.

  • If the source type is a DB security group, a DBSecurityGroupName value must be supplied.

  • If the source type is a DB snapshot, a DBSnapshotIdentifier value must be supplied.

  • If the source type is a DB cluster snapshot, a DBClusterSnapshotIdentifier value must be supplied.

  • Can't end with a hyphen or contain two consecutive hyphens.

Returns:

  • (String)


10428
10429
10430
10431
10432
10433
10434
10435
10436
10437
10438
10439
10440
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 10428

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_typeString

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

Returns:

  • (String)


10428
10429
10430
10431
10432
10433
10434
10435
10436
10437
10438
10439
10440
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 10428

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_timeTime

The beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

Example: 2009-07-08T18:00Z

Returns:

  • (Time)


10428
10429
10430
10431
10432
10433
10434
10435
10436
10437
10438
10439
10440
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 10428

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