You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::Lightsail::Types::GetRelationalDatabaseMetricDataRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::Lightsail::Types::GetRelationalDatabaseMetricDataRequest
- Defined in:
- (unknown)
Overview
When passing GetRelationalDatabaseMetricDataRequest as input to an Aws::Client method, you can use a vanilla Hash:
{
relational_database_name: "ResourceName", # required
metric_name: "CPUUtilization", # required, accepts CPUUtilization, DatabaseConnections, DiskQueueDepth, FreeStorageSpace, NetworkReceiveThroughput, NetworkTransmitThroughput
period: 1, # required
start_time: Time.now, # required
end_time: Time.now, # required
unit: "Seconds", # required, accepts Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None
statistics: ["Minimum"], # required, accepts Minimum, Maximum, Sum, Average, SampleCount
}
Instance Attribute Summary collapse
-
#end_time ⇒ Time
The end of the time interval from which to get metric data.
-
#metric_name ⇒ String
The metric for which you want to return information.
-
#period ⇒ Integer
The granularity, in seconds, of the returned data points.
-
#relational_database_name ⇒ String
The name of your database from which to get metric data.
-
#start_time ⇒ Time
The start of the time interval from which to get metric data.
-
#statistics ⇒ Array<String>
The statistic for the metric.
-
#unit ⇒ String
The unit for the metric data request.
Instance Attribute Details
#end_time ⇒ Time
The end of the time interval from which to get metric data.
Constraints:
Specified in Coordinated Universal Time (UTC).
Specified in the Unix time format.
For example, if you wish to use an end time of October 1, 2018, at 8 PM UTC, then you input
1538424000
as the end time.
#metric_name ⇒ String
The metric for which you want to return information.
Valid relational database metric names are listed below, along with the
most useful statistics
to include in your request, and the published
unit
value. All relational database metric data is available in
1-minute (60 seconds) granularity.
CPUUtilization
- The percentage of CPU utilization currently in use on the database.Statistics
: The most useful statistics areMaximum
andAverage
.Unit
: The published unit isPercent
.DatabaseConnections
- The number of database connections in use.Statistics
: The most useful statistics areMaximum
andSum
.Unit
: The published unit isCount
.DiskQueueDepth
- The number of outstanding IOs (read/write requests) that are waiting to access the disk.Statistics
: The most useful statistic isSum
.Unit
: The published unit isCount
.FreeStorageSpace
- The amount of available storage space.Statistics
: The most useful statistic isSum
.Unit
: The published unit isBytes
.NetworkReceiveThroughput
- The incoming (Receive) network traffic on the database, including both customer database traffic and AWS traffic used for monitoring and replication.Statistics
: The most useful statistic isAverage
.Unit
: The published unit isBytes/Second
.NetworkTransmitThroughput
- The outgoing (Transmit) network traffic on the database, including both customer database traffic and AWS traffic used for monitoring and replication.Statistics
: The most useful statistic isAverage
.Unit
: The published unit isBytes/Second
.Possible values:
- CPUUtilization
- DatabaseConnections
- DiskQueueDepth
- FreeStorageSpace
- NetworkReceiveThroughput
- NetworkTransmitThroughput
#period ⇒ Integer
The granularity, in seconds, of the returned data points.
All relational database metric data is available in 1-minute (60 seconds) granularity.
#relational_database_name ⇒ String
The name of your database from which to get metric data.
#start_time ⇒ Time
The start of the time interval from which to get metric data.
Constraints:
Specified in Coordinated Universal Time (UTC).
Specified in the Unix time format.
For example, if you wish to use a start time of October 1, 2018, at 8 PM UTC, then you input
1538424000
as the start time.
#statistics ⇒ Array<String>
The statistic for the metric.
The following statistics are available:
Minimum
- The lowest value observed during the specified period. Use this value to determine low volumes of activity for your application.Maximum
- The highest value observed during the specified period. Use this value to determine high volumes of activity for your application.Sum
- All values submitted for the matching metric added together. You can use this statistic to determine the total volume of a metric.Average
- The value of Sum / SampleCount during the specified period. By comparing this statistic with the Minimum and Maximum values, you can determine the full scope of a metric and how close the average use is to the Minimum and Maximum values. This comparison helps you to know when to increase or decrease your resources.SampleCount
- The count, or number, of data points used for the statistical calculation.
#unit ⇒ String
The unit for the metric data request. Valid units depend on the metric
data being requested. For the valid units with each available metric,
see the metricName
parameter.
Possible values:
- Seconds
- Microseconds
- Milliseconds
- Bytes
- Kilobytes
- Megabytes
- Gigabytes
- Terabytes
- Bits
- Kilobits
- Megabits
- Gigabits
- Terabits
- Percent
- Count
- Bytes/Second
- Kilobytes/Second
- Megabytes/Second
- Gigabytes/Second
- Terabytes/Second
- Bits/Second
- Kilobits/Second
- Megabits/Second
- Gigabits/Second
- Terabits/Second
- Count/Second
- None