You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::RDS::Types::DescribeEventsMessage
- Inherits:
-
Struct
- Object
- Struct
- Aws::RDS::Types::DescribeEventsMessage
- Defined in:
- (unknown)
Overview
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",
}
Instance Attribute Summary collapse
-
#duration ⇒ 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.
-
#event_categories ⇒ Array<String>
A list of event categories that trigger notifications for a event notification subscription.
-
#filters ⇒ Array<Types::Filter>
This parameter isn\'t currently supported.
-
#marker ⇒ String
An optional pagination token provided by a previous DescribeEvents request.
-
#max_records ⇒ 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.
-
#source_type ⇒ 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.
Instance Attribute Details
#duration ⇒ Integer
The number of minutes to retrieve events for.
Default: 60
#end_time ⇒ Time
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
#event_categories ⇒ Array<String>
A list of event categories that trigger notifications for a event notification subscription.
#filters ⇒ Array<Types::Filter>
This parameter isn\'t currently supported.
#marker ⇒ String
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
.
#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
called a marker is included in the response so that you can retrieve the
remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
#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 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.
#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
#start_time ⇒ Time
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