AWS SDK for C++  1.8.99
AWS SDK for C++
Public Member Functions | List of all members
Aws::Lightsail::Model::GetRelationalDatabaseMetricDataRequest Class Reference

#include <GetRelationalDatabaseMetricDataRequest.h>

+ Inheritance diagram for Aws::Lightsail::Model::GetRelationalDatabaseMetricDataRequest:

Public Member Functions

 GetRelationalDatabaseMetricDataRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetRelationalDatabaseName () const
 
bool RelationalDatabaseNameHasBeenSet () const
 
void SetRelationalDatabaseName (const Aws::String &value)
 
void SetRelationalDatabaseName (Aws::String &&value)
 
void SetRelationalDatabaseName (const char *value)
 
GetRelationalDatabaseMetricDataRequestWithRelationalDatabaseName (const Aws::String &value)
 
GetRelationalDatabaseMetricDataRequestWithRelationalDatabaseName (Aws::String &&value)
 
GetRelationalDatabaseMetricDataRequestWithRelationalDatabaseName (const char *value)
 
const RelationalDatabaseMetricNameGetMetricName () const
 
bool MetricNameHasBeenSet () const
 
void SetMetricName (const RelationalDatabaseMetricName &value)
 
void SetMetricName (RelationalDatabaseMetricName &&value)
 
GetRelationalDatabaseMetricDataRequestWithMetricName (const RelationalDatabaseMetricName &value)
 
GetRelationalDatabaseMetricDataRequestWithMetricName (RelationalDatabaseMetricName &&value)
 
int GetPeriod () const
 
bool PeriodHasBeenSet () const
 
void SetPeriod (int value)
 
GetRelationalDatabaseMetricDataRequestWithPeriod (int value)
 
const Aws::Utils::DateTimeGetStartTime () const
 
bool StartTimeHasBeenSet () const
 
void SetStartTime (const Aws::Utils::DateTime &value)
 
void SetStartTime (Aws::Utils::DateTime &&value)
 
GetRelationalDatabaseMetricDataRequestWithStartTime (const Aws::Utils::DateTime &value)
 
GetRelationalDatabaseMetricDataRequestWithStartTime (Aws::Utils::DateTime &&value)
 
const Aws::Utils::DateTimeGetEndTime () const
 
bool EndTimeHasBeenSet () const
 
void SetEndTime (const Aws::Utils::DateTime &value)
 
void SetEndTime (Aws::Utils::DateTime &&value)
 
GetRelationalDatabaseMetricDataRequestWithEndTime (const Aws::Utils::DateTime &value)
 
GetRelationalDatabaseMetricDataRequestWithEndTime (Aws::Utils::DateTime &&value)
 
const MetricUnitGetUnit () const
 
bool UnitHasBeenSet () const
 
void SetUnit (const MetricUnit &value)
 
void SetUnit (MetricUnit &&value)
 
GetRelationalDatabaseMetricDataRequestWithUnit (const MetricUnit &value)
 
GetRelationalDatabaseMetricDataRequestWithUnit (MetricUnit &&value)
 
const Aws::Vector< MetricStatistic > & GetStatistics () const
 
bool StatisticsHasBeenSet () const
 
void SetStatistics (const Aws::Vector< MetricStatistic > &value)
 
void SetStatistics (Aws::Vector< MetricStatistic > &&value)
 
GetRelationalDatabaseMetricDataRequestWithStatistics (const Aws::Vector< MetricStatistic > &value)
 
GetRelationalDatabaseMetricDataRequestWithStatistics (Aws::Vector< MetricStatistic > &&value)
 
GetRelationalDatabaseMetricDataRequestAddStatistics (const MetricStatistic &value)
 
GetRelationalDatabaseMetricDataRequestAddStatistics (MetricStatistic &&value)
 
- Public Member Functions inherited from Aws::Lightsail::LightsailRequest
virtual ~LightsailRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 26 of file GetRelationalDatabaseMetricDataRequest.h.

Constructor & Destructor Documentation

◆ GetRelationalDatabaseMetricDataRequest()

Aws::Lightsail::Model::GetRelationalDatabaseMetricDataRequest::GetRelationalDatabaseMetricDataRequest ( )

Member Function Documentation

◆ AddStatistics() [1/2]

GetRelationalDatabaseMetricDataRequest& Aws::Lightsail::Model::GetRelationalDatabaseMetricDataRequest::AddStatistics ( const MetricStatistic value)
inline

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.

Definition at line 607 of file GetRelationalDatabaseMetricDataRequest.h.

◆ AddStatistics() [2/2]

GetRelationalDatabaseMetricDataRequest& Aws::Lightsail::Model::GetRelationalDatabaseMetricDataRequest::AddStatistics ( MetricStatistic &&  value)
inline

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.

Definition at line 626 of file GetRelationalDatabaseMetricDataRequest.h.

◆ EndTimeHasBeenSet()

bool Aws::Lightsail::Model::GetRelationalDatabaseMetricDataRequest::EndTimeHasBeenSet ( ) const
inline

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.

Definition at line 394 of file GetRelationalDatabaseMetricDataRequest.h.

◆ GetEndTime()

const Aws::Utils::DateTime& Aws::Lightsail::Model::GetRelationalDatabaseMetricDataRequest::GetEndTime ( ) const
inline

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.

Definition at line 385 of file GetRelationalDatabaseMetricDataRequest.h.

◆ GetMetricName()

const RelationalDatabaseMetricName& Aws::Lightsail::Model::GetRelationalDatabaseMetricDataRequest::GetMetricName ( ) const
inline

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.

Definition at line 116 of file GetRelationalDatabaseMetricDataRequest.h.

◆ GetPeriod()

int Aws::Lightsail::Model::GetRelationalDatabaseMetricDataRequest::GetPeriod ( ) const
inline

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

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

Definition at line 299 of file GetRelationalDatabaseMetricDataRequest.h.

◆ GetRelationalDatabaseName()

const Aws::String& Aws::Lightsail::Model::GetRelationalDatabaseMetricDataRequest::GetRelationalDatabaseName ( ) const
inline

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

Definition at line 45 of file GetRelationalDatabaseMetricDataRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::Lightsail::Model::GetRelationalDatabaseMetricDataRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

Reimplemented from Aws::Lightsail::LightsailRequest.

◆ GetServiceRequestName()

virtual const char* Aws::Lightsail::Model::GetRelationalDatabaseMetricDataRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

◆ GetStartTime()

const Aws::Utils::DateTime& Aws::Lightsail::Model::GetRelationalDatabaseMetricDataRequest::GetStartTime ( ) const
inline

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.

Definition at line 330 of file GetRelationalDatabaseMetricDataRequest.h.

◆ GetStatistics()

const Aws::Vector<MetricStatistic>& Aws::Lightsail::Model::GetRelationalDatabaseMetricDataRequest::GetStatistics ( ) const
inline

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.

Definition at line 493 of file GetRelationalDatabaseMetricDataRequest.h.

◆ GetUnit()

const MetricUnit& Aws::Lightsail::Model::GetRelationalDatabaseMetricDataRequest::GetUnit ( ) const
inline

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.

Definition at line 438 of file GetRelationalDatabaseMetricDataRequest.h.

◆ MetricNameHasBeenSet()

bool Aws::Lightsail::Model::GetRelationalDatabaseMetricDataRequest::MetricNameHasBeenSet ( ) const
inline

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.

Definition at line 151 of file GetRelationalDatabaseMetricDataRequest.h.

◆ PeriodHasBeenSet()

bool Aws::Lightsail::Model::GetRelationalDatabaseMetricDataRequest::PeriodHasBeenSet ( ) const
inline

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

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

Definition at line 306 of file GetRelationalDatabaseMetricDataRequest.h.

◆ RelationalDatabaseNameHasBeenSet()

bool Aws::Lightsail::Model::GetRelationalDatabaseMetricDataRequest::RelationalDatabaseNameHasBeenSet ( ) const
inline

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

Definition at line 50 of file GetRelationalDatabaseMetricDataRequest.h.

◆ SerializePayload()

Aws::String Aws::Lightsail::Model::GetRelationalDatabaseMetricDataRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetEndTime() [1/2]

void Aws::Lightsail::Model::GetRelationalDatabaseMetricDataRequest::SetEndTime ( const Aws::Utils::DateTime value)
inline

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.

Definition at line 403 of file GetRelationalDatabaseMetricDataRequest.h.

◆ SetEndTime() [2/2]

void Aws::Lightsail::Model::GetRelationalDatabaseMetricDataRequest::SetEndTime ( Aws::Utils::DateTime &&  value)
inline

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.

Definition at line 412 of file GetRelationalDatabaseMetricDataRequest.h.

◆ SetMetricName() [1/2]

void Aws::Lightsail::Model::GetRelationalDatabaseMetricDataRequest::SetMetricName ( const RelationalDatabaseMetricName value)
inline

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.

Definition at line 186 of file GetRelationalDatabaseMetricDataRequest.h.

◆ SetMetricName() [2/2]

void Aws::Lightsail::Model::GetRelationalDatabaseMetricDataRequest::SetMetricName ( RelationalDatabaseMetricName &&  value)
inline

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.

Definition at line 221 of file GetRelationalDatabaseMetricDataRequest.h.

◆ SetPeriod()

void Aws::Lightsail::Model::GetRelationalDatabaseMetricDataRequest::SetPeriod ( int  value)
inline

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

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

Definition at line 313 of file GetRelationalDatabaseMetricDataRequest.h.

◆ SetRelationalDatabaseName() [1/3]

void Aws::Lightsail::Model::GetRelationalDatabaseMetricDataRequest::SetRelationalDatabaseName ( const Aws::String value)
inline

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

Definition at line 55 of file GetRelationalDatabaseMetricDataRequest.h.

◆ SetRelationalDatabaseName() [2/3]

void Aws::Lightsail::Model::GetRelationalDatabaseMetricDataRequest::SetRelationalDatabaseName ( Aws::String &&  value)
inline

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

Definition at line 60 of file GetRelationalDatabaseMetricDataRequest.h.

◆ SetRelationalDatabaseName() [3/3]

void Aws::Lightsail::Model::GetRelationalDatabaseMetricDataRequest::SetRelationalDatabaseName ( const char *  value)
inline

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

Definition at line 65 of file GetRelationalDatabaseMetricDataRequest.h.

◆ SetStartTime() [1/2]

void Aws::Lightsail::Model::GetRelationalDatabaseMetricDataRequest::SetStartTime ( const Aws::Utils::DateTime value)
inline

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.

Definition at line 348 of file GetRelationalDatabaseMetricDataRequest.h.

◆ SetStartTime() [2/2]

void Aws::Lightsail::Model::GetRelationalDatabaseMetricDataRequest::SetStartTime ( Aws::Utils::DateTime &&  value)
inline

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.

Definition at line 357 of file GetRelationalDatabaseMetricDataRequest.h.

◆ SetStatistics() [1/2]

void Aws::Lightsail::Model::GetRelationalDatabaseMetricDataRequest::SetStatistics ( const Aws::Vector< MetricStatistic > &  value)
inline

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.

Definition at line 531 of file GetRelationalDatabaseMetricDataRequest.h.

◆ SetStatistics() [2/2]

void Aws::Lightsail::Model::GetRelationalDatabaseMetricDataRequest::SetStatistics ( Aws::Vector< MetricStatistic > &&  value)
inline

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.

Definition at line 550 of file GetRelationalDatabaseMetricDataRequest.h.

◆ SetUnit() [1/2]

void Aws::Lightsail::Model::GetRelationalDatabaseMetricDataRequest::SetUnit ( const MetricUnit value)
inline

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.

Definition at line 452 of file GetRelationalDatabaseMetricDataRequest.h.

◆ SetUnit() [2/2]

void Aws::Lightsail::Model::GetRelationalDatabaseMetricDataRequest::SetUnit ( MetricUnit &&  value)
inline

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.

Definition at line 459 of file GetRelationalDatabaseMetricDataRequest.h.

◆ StartTimeHasBeenSet()

bool Aws::Lightsail::Model::GetRelationalDatabaseMetricDataRequest::StartTimeHasBeenSet ( ) const
inline

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.

Definition at line 339 of file GetRelationalDatabaseMetricDataRequest.h.

◆ StatisticsHasBeenSet()

bool Aws::Lightsail::Model::GetRelationalDatabaseMetricDataRequest::StatisticsHasBeenSet ( ) const
inline

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.

Definition at line 512 of file GetRelationalDatabaseMetricDataRequest.h.

◆ UnitHasBeenSet()

bool Aws::Lightsail::Model::GetRelationalDatabaseMetricDataRequest::UnitHasBeenSet ( ) const
inline

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.

Definition at line 445 of file GetRelationalDatabaseMetricDataRequest.h.

◆ WithEndTime() [1/2]

GetRelationalDatabaseMetricDataRequest& Aws::Lightsail::Model::GetRelationalDatabaseMetricDataRequest::WithEndTime ( const Aws::Utils::DateTime value)
inline

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.

Definition at line 421 of file GetRelationalDatabaseMetricDataRequest.h.

◆ WithEndTime() [2/2]

GetRelationalDatabaseMetricDataRequest& Aws::Lightsail::Model::GetRelationalDatabaseMetricDataRequest::WithEndTime ( Aws::Utils::DateTime &&  value)
inline

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.

Definition at line 430 of file GetRelationalDatabaseMetricDataRequest.h.

◆ WithMetricName() [1/2]

GetRelationalDatabaseMetricDataRequest& Aws::Lightsail::Model::GetRelationalDatabaseMetricDataRequest::WithMetricName ( const RelationalDatabaseMetricName value)
inline

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.

Definition at line 256 of file GetRelationalDatabaseMetricDataRequest.h.

◆ WithMetricName() [2/2]

GetRelationalDatabaseMetricDataRequest& Aws::Lightsail::Model::GetRelationalDatabaseMetricDataRequest::WithMetricName ( RelationalDatabaseMetricName &&  value)
inline

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.

Definition at line 291 of file GetRelationalDatabaseMetricDataRequest.h.

◆ WithPeriod()

GetRelationalDatabaseMetricDataRequest& Aws::Lightsail::Model::GetRelationalDatabaseMetricDataRequest::WithPeriod ( int  value)
inline

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

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

Definition at line 320 of file GetRelationalDatabaseMetricDataRequest.h.

◆ WithRelationalDatabaseName() [1/3]

GetRelationalDatabaseMetricDataRequest& Aws::Lightsail::Model::GetRelationalDatabaseMetricDataRequest::WithRelationalDatabaseName ( const Aws::String value)
inline

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

Definition at line 70 of file GetRelationalDatabaseMetricDataRequest.h.

◆ WithRelationalDatabaseName() [2/3]

GetRelationalDatabaseMetricDataRequest& Aws::Lightsail::Model::GetRelationalDatabaseMetricDataRequest::WithRelationalDatabaseName ( Aws::String &&  value)
inline

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

Definition at line 75 of file GetRelationalDatabaseMetricDataRequest.h.

◆ WithRelationalDatabaseName() [3/3]

GetRelationalDatabaseMetricDataRequest& Aws::Lightsail::Model::GetRelationalDatabaseMetricDataRequest::WithRelationalDatabaseName ( const char *  value)
inline

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

Definition at line 80 of file GetRelationalDatabaseMetricDataRequest.h.

◆ WithStartTime() [1/2]

GetRelationalDatabaseMetricDataRequest& Aws::Lightsail::Model::GetRelationalDatabaseMetricDataRequest::WithStartTime ( const Aws::Utils::DateTime value)
inline

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.

Definition at line 366 of file GetRelationalDatabaseMetricDataRequest.h.

◆ WithStartTime() [2/2]

GetRelationalDatabaseMetricDataRequest& Aws::Lightsail::Model::GetRelationalDatabaseMetricDataRequest::WithStartTime ( Aws::Utils::DateTime &&  value)
inline

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.

Definition at line 375 of file GetRelationalDatabaseMetricDataRequest.h.

◆ WithStatistics() [1/2]

GetRelationalDatabaseMetricDataRequest& Aws::Lightsail::Model::GetRelationalDatabaseMetricDataRequest::WithStatistics ( const Aws::Vector< MetricStatistic > &  value)
inline

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.

Definition at line 569 of file GetRelationalDatabaseMetricDataRequest.h.

◆ WithStatistics() [2/2]

GetRelationalDatabaseMetricDataRequest& Aws::Lightsail::Model::GetRelationalDatabaseMetricDataRequest::WithStatistics ( Aws::Vector< MetricStatistic > &&  value)
inline

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.

Definition at line 588 of file GetRelationalDatabaseMetricDataRequest.h.

◆ WithUnit() [1/2]

GetRelationalDatabaseMetricDataRequest& Aws::Lightsail::Model::GetRelationalDatabaseMetricDataRequest::WithUnit ( const MetricUnit value)
inline

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.

Definition at line 466 of file GetRelationalDatabaseMetricDataRequest.h.

◆ WithUnit() [2/2]

GetRelationalDatabaseMetricDataRequest& Aws::Lightsail::Model::GetRelationalDatabaseMetricDataRequest::WithUnit ( MetricUnit &&  value)
inline

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.

Definition at line 473 of file GetRelationalDatabaseMetricDataRequest.h.


The documentation for this class was generated from the following file: