NAME

Paws::Lightsail::GetRelationalDatabaseMetricData - Arguments for method GetRelationalDatabaseMetricData on Paws::Lightsail

DESCRIPTION

This class represents the parameters used for calling the method GetRelationalDatabaseMetricData on the Amazon Lightsail service. Use the attributes of this class as arguments to method GetRelationalDatabaseMetricData.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetRelationalDatabaseMetricData.

SYNOPSIS

    my $lightsail = Paws->service('Lightsail');
    my $GetRelationalDatabaseMetricDataResult =
      $lightsail->GetRelationalDatabaseMetricData(
      EndTime                => '1970-01-01T01:00:00',
      MetricName             => 'CPUUtilization',
      Period                 => 1,
      RelationalDatabaseName => 'MyResourceName',
      StartTime              => '1970-01-01T01:00:00',
      Statistics             => [
        'Minimum', ...    # values: Minimum, Maximum, Sum, Average, SampleCount
      ],
      Unit => 'Seconds',
      );
    # Results:
    my $MetricData = $GetRelationalDatabaseMetricDataResult->MetricData;
    my $MetricName = $GetRelationalDatabaseMetricDataResult->MetricName;
   # Returns a L<Paws::Lightsail::GetRelationalDatabaseMetricDataResult> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see <https://docs.aws.amazon.com/goto/WebAPI/lightsail/GetRelationalDatabaseMetricData>

ATTRIBUTES

REQUIRED EndTime => Str

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.

REQUIRED MetricName => Str

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 are "Maximum" and "Average".

"Unit": The published unit is "Percent".
"DatabaseConnections" - The number of database connections in use.
"Statistics": The most useful statistics are "Maximum" and "Sum".

"Unit": The published unit is "Count".
"DiskQueueDepth" - 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".
"FreeStorageSpace" - The amount of available storage space.
"Statistics": The most useful statistic is "Sum".

"Unit": The published unit is "Bytes".
"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 is "Average".

"Unit": The published unit is "Bytes/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 is "Average".

"Unit": The published unit is "Bytes/Second".

Valid values are: "CPUUtilization", "DatabaseConnections", "DiskQueueDepth", "FreeStorageSpace", "NetworkReceiveThroughput", "NetworkTransmitThroughput"

REQUIRED Period => Int

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

All relational database metric data is available in 1-minute (60 seconds) granularity.

REQUIRED RelationalDatabaseName => Str

The name of your database from which to get metric data.

REQUIRED StartTime => Str

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.

REQUIRED Statistics => ArrayRef[Str|Undef]

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.

REQUIRED Unit => Str

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.

Valid values are: "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"

BUGS and CONTRIBUTIONS

The source code is located here: <https://github.com/pplu/aws-sdk-perl>

Please report bugs to: <https://github.com/pplu/aws-sdk-perl/issues>