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

#include <GetLoadBalancerMetricDataRequest.h>

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

Public Member Functions

 GetLoadBalancerMetricDataRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetLoadBalancerName () const
 
bool LoadBalancerNameHasBeenSet () const
 
void SetLoadBalancerName (const Aws::String &value)
 
void SetLoadBalancerName (Aws::String &&value)
 
void SetLoadBalancerName (const char *value)
 
GetLoadBalancerMetricDataRequestWithLoadBalancerName (const Aws::String &value)
 
GetLoadBalancerMetricDataRequestWithLoadBalancerName (Aws::String &&value)
 
GetLoadBalancerMetricDataRequestWithLoadBalancerName (const char *value)
 
const LoadBalancerMetricNameGetMetricName () const
 
bool MetricNameHasBeenSet () const
 
void SetMetricName (const LoadBalancerMetricName &value)
 
void SetMetricName (LoadBalancerMetricName &&value)
 
GetLoadBalancerMetricDataRequestWithMetricName (const LoadBalancerMetricName &value)
 
GetLoadBalancerMetricDataRequestWithMetricName (LoadBalancerMetricName &&value)
 
int GetPeriod () const
 
bool PeriodHasBeenSet () const
 
void SetPeriod (int value)
 
GetLoadBalancerMetricDataRequestWithPeriod (int value)
 
const Aws::Utils::DateTimeGetStartTime () const
 
bool StartTimeHasBeenSet () const
 
void SetStartTime (const Aws::Utils::DateTime &value)
 
void SetStartTime (Aws::Utils::DateTime &&value)
 
GetLoadBalancerMetricDataRequestWithStartTime (const Aws::Utils::DateTime &value)
 
GetLoadBalancerMetricDataRequestWithStartTime (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)
 
GetLoadBalancerMetricDataRequestWithEndTime (const Aws::Utils::DateTime &value)
 
GetLoadBalancerMetricDataRequestWithEndTime (Aws::Utils::DateTime &&value)
 
const MetricUnitGetUnit () const
 
bool UnitHasBeenSet () const
 
void SetUnit (const MetricUnit &value)
 
void SetUnit (MetricUnit &&value)
 
GetLoadBalancerMetricDataRequestWithUnit (const MetricUnit &value)
 
GetLoadBalancerMetricDataRequestWithUnit (MetricUnit &&value)
 
const Aws::Vector< MetricStatistic > & GetStatistics () const
 
bool StatisticsHasBeenSet () const
 
void SetStatistics (const Aws::Vector< MetricStatistic > &value)
 
void SetStatistics (Aws::Vector< MetricStatistic > &&value)
 
GetLoadBalancerMetricDataRequestWithStatistics (const Aws::Vector< MetricStatistic > &value)
 
GetLoadBalancerMetricDataRequestWithStatistics (Aws::Vector< MetricStatistic > &&value)
 
GetLoadBalancerMetricDataRequestAddStatistics (const MetricStatistic &value)
 
GetLoadBalancerMetricDataRequestAddStatistics (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 GetLoadBalancerMetricDataRequest.h.

Constructor & Destructor Documentation

◆ GetLoadBalancerMetricDataRequest()

Aws::Lightsail::Model::GetLoadBalancerMetricDataRequest::GetLoadBalancerMetricDataRequest ( )

Member Function Documentation

◆ AddStatistics() [1/2]

GetLoadBalancerMetricDataRequest& Aws::Lightsail::Model::GetLoadBalancerMetricDataRequest::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 809 of file GetLoadBalancerMetricDataRequest.h.

◆ AddStatistics() [2/2]

GetLoadBalancerMetricDataRequest& Aws::Lightsail::Model::GetLoadBalancerMetricDataRequest::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 828 of file GetLoadBalancerMetricDataRequest.h.

◆ EndTimeHasBeenSet()

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

The end time of the period.

Definition at line 612 of file GetLoadBalancerMetricDataRequest.h.

◆ GetEndTime()

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

The end time of the period.

Definition at line 607 of file GetLoadBalancerMetricDataRequest.h.

◆ GetLoadBalancerName()

const Aws::String& Aws::Lightsail::Model::GetLoadBalancerMetricDataRequest::GetLoadBalancerName ( ) const
inline

The name of the load balancer.

Definition at line 45 of file GetLoadBalancerMetricDataRequest.h.

◆ GetMetricName()

const LoadBalancerMetricName& Aws::Lightsail::Model::GetLoadBalancerMetricDataRequest::GetMetricName ( ) const
inline

The metric for which you want to return information.

Valid load balancer metric names are listed below, along with the most useful statistics to include in your request, and the published unit value.

  • ClientTLSNegotiationErrorCount - The number of TLS connections initiated by the client that did not establish a session with the load balancer due to a TLS error generated by the load balancer. Possible causes include a mismatch of ciphers or protocols.

    Statistics: The most useful statistic is Sum.

    Unit: The published unit is Count.

  • HealthyHostCount - The number of target instances that are considered healthy.

    Statistics: The most useful statistic are Average, Minimum, and Maximum.

    Unit: The published unit is Count.

  • HTTPCode_Instance_2XX_Count - The number of HTTP 2XX response codes generated by the target instances. This does not include any response codes generated by the load balancer.

    Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

    Unit: The published unit is Count.

  • HTTPCode_Instance_3XX_Count - The number of HTTP 3XX response codes generated by the target instances. This does not include any response codes generated by the load balancer.

    Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

    Unit: The published unit is Count.

  • HTTPCode_Instance_4XX_Count - The number of HTTP 4XX response codes generated by the target instances. This does not include any response codes generated by the load balancer.

    Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

    Unit: The published unit is Count.

  • HTTPCode_Instance_5XX_Count - The number of HTTP 5XX response codes generated by the target instances. This does not include any response codes generated by the load balancer.

    Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

    Unit: The published unit is Count.

  • HTTPCode_LB_4XX_Count - The number of HTTP 4XX client error codes that originated from the load balancer. Client errors are generated when requests are malformed or incomplete. These requests were not received by the target instance. This count does not include response codes generated by the target instances.

    Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

    Unit: The published unit is Count.

  • HTTPCode_LB_5XX_Count - The number of HTTP 5XX server error codes that originated from the load balancer. This does not include any response codes generated by the target instance. This metric is reported if there are no healthy instances attached to the load balancer, or if the request rate exceeds the capacity of the instances (spillover) or the load balancer.

    Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

    Unit: The published unit is Count.

  • InstanceResponseTime - The time elapsed, in seconds, after the request leaves the load balancer until a response from the target instance is received.

    Statistics: The most useful statistic is Average.

    Unit: The published unit is Seconds.

  • RejectedConnectionCount - The number of connections that were rejected because the load balancer had reached its maximum number of connections.

    Statistics: The most useful statistic is Sum.

    Unit: The published unit is Count.

  • RequestCount - The number of requests processed over IPv4. This count includes only the requests with a response generated by a target instance of the load balancer.

    Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

    Unit: The published unit is Count.

  • UnhealthyHostCount

    • The number of target instances that are considered unhealthy.

    Statistics: The most useful statistic are Average, Minimum, and Maximum.

    Unit: The published unit is Count.

Definition at line 159 of file GetLoadBalancerMetricDataRequest.h.

◆ GetPeriod()

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

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

Definition at line 555 of file GetLoadBalancerMetricDataRequest.h.

◆ GetRequestSpecificHeaders()

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

Reimplemented from Aws::Lightsail::LightsailRequest.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 35 of file GetLoadBalancerMetricDataRequest.h.

◆ GetStartTime()

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

The start time of the period.

Definition at line 576 of file GetLoadBalancerMetricDataRequest.h.

◆ GetStatistics()

const Aws::Vector<MetricStatistic>& Aws::Lightsail::Model::GetLoadBalancerMetricDataRequest::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 695 of file GetLoadBalancerMetricDataRequest.h.

◆ GetUnit()

const MetricUnit& Aws::Lightsail::Model::GetLoadBalancerMetricDataRequest::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 640 of file GetLoadBalancerMetricDataRequest.h.

◆ LoadBalancerNameHasBeenSet()

bool Aws::Lightsail::Model::GetLoadBalancerMetricDataRequest::LoadBalancerNameHasBeenSet ( ) const
inline

The name of the load balancer.

Definition at line 50 of file GetLoadBalancerMetricDataRequest.h.

◆ MetricNameHasBeenSet()

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

The metric for which you want to return information.

Valid load balancer metric names are listed below, along with the most useful statistics to include in your request, and the published unit value.

  • ClientTLSNegotiationErrorCount - The number of TLS connections initiated by the client that did not establish a session with the load balancer due to a TLS error generated by the load balancer. Possible causes include a mismatch of ciphers or protocols.

    Statistics: The most useful statistic is Sum.

    Unit: The published unit is Count.

  • HealthyHostCount - The number of target instances that are considered healthy.

    Statistics: The most useful statistic are Average, Minimum, and Maximum.

    Unit: The published unit is Count.

  • HTTPCode_Instance_2XX_Count - The number of HTTP 2XX response codes generated by the target instances. This does not include any response codes generated by the load balancer.

    Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

    Unit: The published unit is Count.

  • HTTPCode_Instance_3XX_Count - The number of HTTP 3XX response codes generated by the target instances. This does not include any response codes generated by the load balancer.

    Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

    Unit: The published unit is Count.

  • HTTPCode_Instance_4XX_Count - The number of HTTP 4XX response codes generated by the target instances. This does not include any response codes generated by the load balancer.

    Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

    Unit: The published unit is Count.

  • HTTPCode_Instance_5XX_Count - The number of HTTP 5XX response codes generated by the target instances. This does not include any response codes generated by the load balancer.

    Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

    Unit: The published unit is Count.

  • HTTPCode_LB_4XX_Count - The number of HTTP 4XX client error codes that originated from the load balancer. Client errors are generated when requests are malformed or incomplete. These requests were not received by the target instance. This count does not include response codes generated by the target instances.

    Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

    Unit: The published unit is Count.

  • HTTPCode_LB_5XX_Count - The number of HTTP 5XX server error codes that originated from the load balancer. This does not include any response codes generated by the target instance. This metric is reported if there are no healthy instances attached to the load balancer, or if the request rate exceeds the capacity of the instances (spillover) or the load balancer.

    Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

    Unit: The published unit is Count.

  • InstanceResponseTime - The time elapsed, in seconds, after the request leaves the load balancer until a response from the target instance is received.

    Statistics: The most useful statistic is Average.

    Unit: The published unit is Seconds.

  • RejectedConnectionCount - The number of connections that were rejected because the load balancer had reached its maximum number of connections.

    Statistics: The most useful statistic is Sum.

    Unit: The published unit is Count.

  • RequestCount - The number of requests processed over IPv4. This count includes only the requests with a response generated by a target instance of the load balancer.

    Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

    Unit: The published unit is Count.

  • UnhealthyHostCount

    • The number of target instances that are considered unhealthy.

    Statistics: The most useful statistic are Average, Minimum, and Maximum.

    Unit: The published unit is Count.

Definition at line 237 of file GetLoadBalancerMetricDataRequest.h.

◆ PeriodHasBeenSet()

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

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

Definition at line 560 of file GetLoadBalancerMetricDataRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetEndTime() [1/2]

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

The end time of the period.

Definition at line 617 of file GetLoadBalancerMetricDataRequest.h.

◆ SetEndTime() [2/2]

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

The end time of the period.

Definition at line 622 of file GetLoadBalancerMetricDataRequest.h.

◆ SetLoadBalancerName() [1/3]

void Aws::Lightsail::Model::GetLoadBalancerMetricDataRequest::SetLoadBalancerName ( const Aws::String value)
inline

The name of the load balancer.

Definition at line 55 of file GetLoadBalancerMetricDataRequest.h.

◆ SetLoadBalancerName() [2/3]

void Aws::Lightsail::Model::GetLoadBalancerMetricDataRequest::SetLoadBalancerName ( Aws::String &&  value)
inline

The name of the load balancer.

Definition at line 60 of file GetLoadBalancerMetricDataRequest.h.

◆ SetLoadBalancerName() [3/3]

void Aws::Lightsail::Model::GetLoadBalancerMetricDataRequest::SetLoadBalancerName ( const char *  value)
inline

The name of the load balancer.

Definition at line 65 of file GetLoadBalancerMetricDataRequest.h.

◆ SetMetricName() [1/2]

void Aws::Lightsail::Model::GetLoadBalancerMetricDataRequest::SetMetricName ( const LoadBalancerMetricName value)
inline

The metric for which you want to return information.

Valid load balancer metric names are listed below, along with the most useful statistics to include in your request, and the published unit value.

  • ClientTLSNegotiationErrorCount - The number of TLS connections initiated by the client that did not establish a session with the load balancer due to a TLS error generated by the load balancer. Possible causes include a mismatch of ciphers or protocols.

    Statistics: The most useful statistic is Sum.

    Unit: The published unit is Count.

  • HealthyHostCount - The number of target instances that are considered healthy.

    Statistics: The most useful statistic are Average, Minimum, and Maximum.

    Unit: The published unit is Count.

  • HTTPCode_Instance_2XX_Count - The number of HTTP 2XX response codes generated by the target instances. This does not include any response codes generated by the load balancer.

    Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

    Unit: The published unit is Count.

  • HTTPCode_Instance_3XX_Count - The number of HTTP 3XX response codes generated by the target instances. This does not include any response codes generated by the load balancer.

    Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

    Unit: The published unit is Count.

  • HTTPCode_Instance_4XX_Count - The number of HTTP 4XX response codes generated by the target instances. This does not include any response codes generated by the load balancer.

    Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

    Unit: The published unit is Count.

  • HTTPCode_Instance_5XX_Count - The number of HTTP 5XX response codes generated by the target instances. This does not include any response codes generated by the load balancer.

    Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

    Unit: The published unit is Count.

  • HTTPCode_LB_4XX_Count - The number of HTTP 4XX client error codes that originated from the load balancer. Client errors are generated when requests are malformed or incomplete. These requests were not received by the target instance. This count does not include response codes generated by the target instances.

    Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

    Unit: The published unit is Count.

  • HTTPCode_LB_5XX_Count - The number of HTTP 5XX server error codes that originated from the load balancer. This does not include any response codes generated by the target instance. This metric is reported if there are no healthy instances attached to the load balancer, or if the request rate exceeds the capacity of the instances (spillover) or the load balancer.

    Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

    Unit: The published unit is Count.

  • InstanceResponseTime - The time elapsed, in seconds, after the request leaves the load balancer until a response from the target instance is received.

    Statistics: The most useful statistic is Average.

    Unit: The published unit is Seconds.

  • RejectedConnectionCount - The number of connections that were rejected because the load balancer had reached its maximum number of connections.

    Statistics: The most useful statistic is Sum.

    Unit: The published unit is Count.

  • RequestCount - The number of requests processed over IPv4. This count includes only the requests with a response generated by a target instance of the load balancer.

    Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

    Unit: The published unit is Count.

  • UnhealthyHostCount

    • The number of target instances that are considered unhealthy.

    Statistics: The most useful statistic are Average, Minimum, and Maximum.

    Unit: The published unit is Count.

Definition at line 315 of file GetLoadBalancerMetricDataRequest.h.

◆ SetMetricName() [2/2]

void Aws::Lightsail::Model::GetLoadBalancerMetricDataRequest::SetMetricName ( LoadBalancerMetricName &&  value)
inline

The metric for which you want to return information.

Valid load balancer metric names are listed below, along with the most useful statistics to include in your request, and the published unit value.

  • ClientTLSNegotiationErrorCount - The number of TLS connections initiated by the client that did not establish a session with the load balancer due to a TLS error generated by the load balancer. Possible causes include a mismatch of ciphers or protocols.

    Statistics: The most useful statistic is Sum.

    Unit: The published unit is Count.

  • HealthyHostCount - The number of target instances that are considered healthy.

    Statistics: The most useful statistic are Average, Minimum, and Maximum.

    Unit: The published unit is Count.

  • HTTPCode_Instance_2XX_Count - The number of HTTP 2XX response codes generated by the target instances. This does not include any response codes generated by the load balancer.

    Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

    Unit: The published unit is Count.

  • HTTPCode_Instance_3XX_Count - The number of HTTP 3XX response codes generated by the target instances. This does not include any response codes generated by the load balancer.

    Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

    Unit: The published unit is Count.

  • HTTPCode_Instance_4XX_Count - The number of HTTP 4XX response codes generated by the target instances. This does not include any response codes generated by the load balancer.

    Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

    Unit: The published unit is Count.

  • HTTPCode_Instance_5XX_Count - The number of HTTP 5XX response codes generated by the target instances. This does not include any response codes generated by the load balancer.

    Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

    Unit: The published unit is Count.

  • HTTPCode_LB_4XX_Count - The number of HTTP 4XX client error codes that originated from the load balancer. Client errors are generated when requests are malformed or incomplete. These requests were not received by the target instance. This count does not include response codes generated by the target instances.

    Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

    Unit: The published unit is Count.

  • HTTPCode_LB_5XX_Count - The number of HTTP 5XX server error codes that originated from the load balancer. This does not include any response codes generated by the target instance. This metric is reported if there are no healthy instances attached to the load balancer, or if the request rate exceeds the capacity of the instances (spillover) or the load balancer.

    Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

    Unit: The published unit is Count.

  • InstanceResponseTime - The time elapsed, in seconds, after the request leaves the load balancer until a response from the target instance is received.

    Statistics: The most useful statistic is Average.

    Unit: The published unit is Seconds.

  • RejectedConnectionCount - The number of connections that were rejected because the load balancer had reached its maximum number of connections.

    Statistics: The most useful statistic is Sum.

    Unit: The published unit is Count.

  • RequestCount - The number of requests processed over IPv4. This count includes only the requests with a response generated by a target instance of the load balancer.

    Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

    Unit: The published unit is Count.

  • UnhealthyHostCount

    • The number of target instances that are considered unhealthy.

    Statistics: The most useful statistic are Average, Minimum, and Maximum.

    Unit: The published unit is Count.

Definition at line 393 of file GetLoadBalancerMetricDataRequest.h.

◆ SetPeriod()

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

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

Definition at line 565 of file GetLoadBalancerMetricDataRequest.h.

◆ SetStartTime() [1/2]

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

The start time of the period.

Definition at line 586 of file GetLoadBalancerMetricDataRequest.h.

◆ SetStartTime() [2/2]

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

The start time of the period.

Definition at line 591 of file GetLoadBalancerMetricDataRequest.h.

◆ SetStatistics() [1/2]

void Aws::Lightsail::Model::GetLoadBalancerMetricDataRequest::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 733 of file GetLoadBalancerMetricDataRequest.h.

◆ SetStatistics() [2/2]

void Aws::Lightsail::Model::GetLoadBalancerMetricDataRequest::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 752 of file GetLoadBalancerMetricDataRequest.h.

◆ SetUnit() [1/2]

void Aws::Lightsail::Model::GetLoadBalancerMetricDataRequest::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 654 of file GetLoadBalancerMetricDataRequest.h.

◆ SetUnit() [2/2]

void Aws::Lightsail::Model::GetLoadBalancerMetricDataRequest::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 661 of file GetLoadBalancerMetricDataRequest.h.

◆ StartTimeHasBeenSet()

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

The start time of the period.

Definition at line 581 of file GetLoadBalancerMetricDataRequest.h.

◆ StatisticsHasBeenSet()

bool Aws::Lightsail::Model::GetLoadBalancerMetricDataRequest::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 714 of file GetLoadBalancerMetricDataRequest.h.

◆ UnitHasBeenSet()

bool Aws::Lightsail::Model::GetLoadBalancerMetricDataRequest::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 647 of file GetLoadBalancerMetricDataRequest.h.

◆ WithEndTime() [1/2]

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

The end time of the period.

Definition at line 627 of file GetLoadBalancerMetricDataRequest.h.

◆ WithEndTime() [2/2]

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

The end time of the period.

Definition at line 632 of file GetLoadBalancerMetricDataRequest.h.

◆ WithLoadBalancerName() [1/3]

GetLoadBalancerMetricDataRequest& Aws::Lightsail::Model::GetLoadBalancerMetricDataRequest::WithLoadBalancerName ( const Aws::String value)
inline

The name of the load balancer.

Definition at line 70 of file GetLoadBalancerMetricDataRequest.h.

◆ WithLoadBalancerName() [2/3]

GetLoadBalancerMetricDataRequest& Aws::Lightsail::Model::GetLoadBalancerMetricDataRequest::WithLoadBalancerName ( Aws::String &&  value)
inline

The name of the load balancer.

Definition at line 75 of file GetLoadBalancerMetricDataRequest.h.

◆ WithLoadBalancerName() [3/3]

GetLoadBalancerMetricDataRequest& Aws::Lightsail::Model::GetLoadBalancerMetricDataRequest::WithLoadBalancerName ( const char *  value)
inline

The name of the load balancer.

Definition at line 80 of file GetLoadBalancerMetricDataRequest.h.

◆ WithMetricName() [1/2]

GetLoadBalancerMetricDataRequest& Aws::Lightsail::Model::GetLoadBalancerMetricDataRequest::WithMetricName ( const LoadBalancerMetricName value)
inline

The metric for which you want to return information.

Valid load balancer metric names are listed below, along with the most useful statistics to include in your request, and the published unit value.

  • ClientTLSNegotiationErrorCount - The number of TLS connections initiated by the client that did not establish a session with the load balancer due to a TLS error generated by the load balancer. Possible causes include a mismatch of ciphers or protocols.

    Statistics: The most useful statistic is Sum.

    Unit: The published unit is Count.

  • HealthyHostCount - The number of target instances that are considered healthy.

    Statistics: The most useful statistic are Average, Minimum, and Maximum.

    Unit: The published unit is Count.

  • HTTPCode_Instance_2XX_Count - The number of HTTP 2XX response codes generated by the target instances. This does not include any response codes generated by the load balancer.

    Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

    Unit: The published unit is Count.

  • HTTPCode_Instance_3XX_Count - The number of HTTP 3XX response codes generated by the target instances. This does not include any response codes generated by the load balancer.

    Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

    Unit: The published unit is Count.

  • HTTPCode_Instance_4XX_Count - The number of HTTP 4XX response codes generated by the target instances. This does not include any response codes generated by the load balancer.

    Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

    Unit: The published unit is Count.

  • HTTPCode_Instance_5XX_Count - The number of HTTP 5XX response codes generated by the target instances. This does not include any response codes generated by the load balancer.

    Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

    Unit: The published unit is Count.

  • HTTPCode_LB_4XX_Count - The number of HTTP 4XX client error codes that originated from the load balancer. Client errors are generated when requests are malformed or incomplete. These requests were not received by the target instance. This count does not include response codes generated by the target instances.

    Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

    Unit: The published unit is Count.

  • HTTPCode_LB_5XX_Count - The number of HTTP 5XX server error codes that originated from the load balancer. This does not include any response codes generated by the target instance. This metric is reported if there are no healthy instances attached to the load balancer, or if the request rate exceeds the capacity of the instances (spillover) or the load balancer.

    Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

    Unit: The published unit is Count.

  • InstanceResponseTime - The time elapsed, in seconds, after the request leaves the load balancer until a response from the target instance is received.

    Statistics: The most useful statistic is Average.

    Unit: The published unit is Seconds.

  • RejectedConnectionCount - The number of connections that were rejected because the load balancer had reached its maximum number of connections.

    Statistics: The most useful statistic is Sum.

    Unit: The published unit is Count.

  • RequestCount - The number of requests processed over IPv4. This count includes only the requests with a response generated by a target instance of the load balancer.

    Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

    Unit: The published unit is Count.

  • UnhealthyHostCount

    • The number of target instances that are considered unhealthy.

    Statistics: The most useful statistic are Average, Minimum, and Maximum.

    Unit: The published unit is Count.

Definition at line 471 of file GetLoadBalancerMetricDataRequest.h.

◆ WithMetricName() [2/2]

GetLoadBalancerMetricDataRequest& Aws::Lightsail::Model::GetLoadBalancerMetricDataRequest::WithMetricName ( LoadBalancerMetricName &&  value)
inline

The metric for which you want to return information.

Valid load balancer metric names are listed below, along with the most useful statistics to include in your request, and the published unit value.

  • ClientTLSNegotiationErrorCount - The number of TLS connections initiated by the client that did not establish a session with the load balancer due to a TLS error generated by the load balancer. Possible causes include a mismatch of ciphers or protocols.

    Statistics: The most useful statistic is Sum.

    Unit: The published unit is Count.

  • HealthyHostCount - The number of target instances that are considered healthy.

    Statistics: The most useful statistic are Average, Minimum, and Maximum.

    Unit: The published unit is Count.

  • HTTPCode_Instance_2XX_Count - The number of HTTP 2XX response codes generated by the target instances. This does not include any response codes generated by the load balancer.

    Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

    Unit: The published unit is Count.

  • HTTPCode_Instance_3XX_Count - The number of HTTP 3XX response codes generated by the target instances. This does not include any response codes generated by the load balancer.

    Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

    Unit: The published unit is Count.

  • HTTPCode_Instance_4XX_Count - The number of HTTP 4XX response codes generated by the target instances. This does not include any response codes generated by the load balancer.

    Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

    Unit: The published unit is Count.

  • HTTPCode_Instance_5XX_Count - The number of HTTP 5XX response codes generated by the target instances. This does not include any response codes generated by the load balancer.

    Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

    Unit: The published unit is Count.

  • HTTPCode_LB_4XX_Count - The number of HTTP 4XX client error codes that originated from the load balancer. Client errors are generated when requests are malformed or incomplete. These requests were not received by the target instance. This count does not include response codes generated by the target instances.

    Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

    Unit: The published unit is Count.

  • HTTPCode_LB_5XX_Count - The number of HTTP 5XX server error codes that originated from the load balancer. This does not include any response codes generated by the target instance. This metric is reported if there are no healthy instances attached to the load balancer, or if the request rate exceeds the capacity of the instances (spillover) or the load balancer.

    Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

    Unit: The published unit is Count.

  • InstanceResponseTime - The time elapsed, in seconds, after the request leaves the load balancer until a response from the target instance is received.

    Statistics: The most useful statistic is Average.

    Unit: The published unit is Seconds.

  • RejectedConnectionCount - The number of connections that were rejected because the load balancer had reached its maximum number of connections.

    Statistics: The most useful statistic is Sum.

    Unit: The published unit is Count.

  • RequestCount - The number of requests processed over IPv4. This count includes only the requests with a response generated by a target instance of the load balancer.

    Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

    Unit: The published unit is Count.

  • UnhealthyHostCount

    • The number of target instances that are considered unhealthy.

    Statistics: The most useful statistic are Average, Minimum, and Maximum.

    Unit: The published unit is Count.

Definition at line 549 of file GetLoadBalancerMetricDataRequest.h.

◆ WithPeriod()

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

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

Definition at line 570 of file GetLoadBalancerMetricDataRequest.h.

◆ WithStartTime() [1/2]

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

The start time of the period.

Definition at line 596 of file GetLoadBalancerMetricDataRequest.h.

◆ WithStartTime() [2/2]

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

The start time of the period.

Definition at line 601 of file GetLoadBalancerMetricDataRequest.h.

◆ WithStatistics() [1/2]

GetLoadBalancerMetricDataRequest& Aws::Lightsail::Model::GetLoadBalancerMetricDataRequest::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 771 of file GetLoadBalancerMetricDataRequest.h.

◆ WithStatistics() [2/2]

GetLoadBalancerMetricDataRequest& Aws::Lightsail::Model::GetLoadBalancerMetricDataRequest::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 790 of file GetLoadBalancerMetricDataRequest.h.

◆ WithUnit() [1/2]

GetLoadBalancerMetricDataRequest& Aws::Lightsail::Model::GetLoadBalancerMetricDataRequest::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 668 of file GetLoadBalancerMetricDataRequest.h.

◆ WithUnit() [2/2]

GetLoadBalancerMetricDataRequest& Aws::Lightsail::Model::GetLoadBalancerMetricDataRequest::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 675 of file GetLoadBalancerMetricDataRequest.h.


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