class Aws::Lightsail::Types::GetRelationalDatabaseMetricDataRequest

@note When making an API call, you may pass GetRelationalDatabaseMetricDataRequest

data as a 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
    }

@!attribute [rw] relational_database_name

The name of your database from which to get metric data.
@return [String]

@!attribute [rw] metric_name

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.

* <b> <code>CPUUtilization</code> </b> - The percentage of CPU
  utilization currently in use on the database.

  `Statistics`\: The most useful statistics are `Maximum` and
  `Average`.

  `Unit`\: The published unit is `Percent`.

* <b> <code>DatabaseConnections</code> </b> - The number of database
  connections in use.

  `Statistics`\: The most useful statistics are `Maximum` and `Sum`.

  `Unit`\: The published unit is `Count`.

* <b> <code>DiskQueueDepth</code> </b> - The number of outstanding
  IOs (read/write requests) that are waiting to access the disk.

  `Statistics`\: The most useful statistic is `Sum`.

  `Unit`\: The published unit is `Count`.

* <b> <code>FreeStorageSpace</code> </b> - The amount of available
  storage space.

  `Statistics`\: The most useful statistic is `Sum`.

  `Unit`\: The published unit is `Bytes`.

* <b> <code>NetworkReceiveThroughput</code> </b> - 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 is `Average`.

  `Unit`\: The published unit is `Bytes/Second`.

* <b> <code>NetworkTransmitThroughput</code> </b> - 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 is `Average`.

  `Unit`\: The published unit is `Bytes/Second`.
@return [String]

@!attribute [rw] period

The granularity, in seconds, of the returned data points.

All relational database metric data is available in 1-minute (60
seconds) granularity.
@return [Integer]

@!attribute [rw] start_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.
@return [Time]

@!attribute [rw] end_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.
@return [Time]

@!attribute [rw] unit

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.
@return [String]

@!attribute [rw] statistics

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.
@return [Array<String>]

@see docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabaseMetricDataRequest AWS API Documentation

Constants

SENSITIVE