Struct aws_sdk_lightsail::operation::get_relational_database_metric_data::GetRelationalDatabaseMetricDataInput

#[non_exhaustive]
pub struct GetRelationalDatabaseMetricDataInput {
    pub relational_database_name: Option<String>,
    pub metric_name: Option<RelationalDatabaseMetricName>,
    pub period: Option<i32>,
    pub start_time: Option<DateTime>,
    pub end_time: Option<DateTime>,
    pub unit: Option<MetricUnit>,
    pub statistics: Option<Vec<MetricStatistic>>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

relational_database_name: Option<String>

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

metric_name: Option<RelationalDatabaseMetricName>

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.

period: Option<i32>

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

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

start_time: Option<DateTime>

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.

end_time: Option<DateTime>

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.

unit: Option<MetricUnit>

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.

statistics: Option<Vec<MetricStatistic>>

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.

Implementations

impl GetRelationalDatabaseMetricDataInput

pub fn relational_database_name(&self) -> Option<&str>

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

pub fn metric_name(&self) -> Option<&RelationalDatabaseMetricName>

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.

pub fn period(&self) -> Option<i32>

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

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

pub fn start_time(&self) -> Option<&DateTime>

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.

pub fn end_time(&self) -> Option<&DateTime>

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.

pub fn unit(&self) -> Option<&MetricUnit>

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.

pub fn statistics(&self) -> &[MetricStatistic]

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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .statistics.is_none().

impl GetRelationalDatabaseMetricDataInput

pub fn builder() -> GetRelationalDatabaseMetricDataInputBuilder

Creates a new builder-style object to manufacture GetRelationalDatabaseMetricDataInput.

Trait Implementations

impl Clone for GetRelationalDatabaseMetricDataInput

fn clone(&self) -> GetRelationalDatabaseMetricDataInput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GetRelationalDatabaseMetricDataInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for GetRelationalDatabaseMetricDataInput

fn eq(&self, other: &GetRelationalDatabaseMetricDataInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for GetRelationalDatabaseMetricDataInput