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

#include <PutAlarmRequest.h>

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

Public Member Functions

 PutAlarmRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetAlarmName () const
 
bool AlarmNameHasBeenSet () const
 
void SetAlarmName (const Aws::String &value)
 
void SetAlarmName (Aws::String &&value)
 
void SetAlarmName (const char *value)
 
PutAlarmRequestWithAlarmName (const Aws::String &value)
 
PutAlarmRequestWithAlarmName (Aws::String &&value)
 
PutAlarmRequestWithAlarmName (const char *value)
 
const MetricNameGetMetricName () const
 
bool MetricNameHasBeenSet () const
 
void SetMetricName (const MetricName &value)
 
void SetMetricName (MetricName &&value)
 
PutAlarmRequestWithMetricName (const MetricName &value)
 
PutAlarmRequestWithMetricName (MetricName &&value)
 
const Aws::StringGetMonitoredResourceName () const
 
bool MonitoredResourceNameHasBeenSet () const
 
void SetMonitoredResourceName (const Aws::String &value)
 
void SetMonitoredResourceName (Aws::String &&value)
 
void SetMonitoredResourceName (const char *value)
 
PutAlarmRequestWithMonitoredResourceName (const Aws::String &value)
 
PutAlarmRequestWithMonitoredResourceName (Aws::String &&value)
 
PutAlarmRequestWithMonitoredResourceName (const char *value)
 
const ComparisonOperatorGetComparisonOperator () const
 
bool ComparisonOperatorHasBeenSet () const
 
void SetComparisonOperator (const ComparisonOperator &value)
 
void SetComparisonOperator (ComparisonOperator &&value)
 
PutAlarmRequestWithComparisonOperator (const ComparisonOperator &value)
 
PutAlarmRequestWithComparisonOperator (ComparisonOperator &&value)
 
double GetThreshold () const
 
bool ThresholdHasBeenSet () const
 
void SetThreshold (double value)
 
PutAlarmRequestWithThreshold (double value)
 
int GetEvaluationPeriods () const
 
bool EvaluationPeriodsHasBeenSet () const
 
void SetEvaluationPeriods (int value)
 
PutAlarmRequestWithEvaluationPeriods (int value)
 
int GetDatapointsToAlarm () const
 
bool DatapointsToAlarmHasBeenSet () const
 
void SetDatapointsToAlarm (int value)
 
PutAlarmRequestWithDatapointsToAlarm (int value)
 
const TreatMissingDataGetTreatMissingData () const
 
bool TreatMissingDataHasBeenSet () const
 
void SetTreatMissingData (const TreatMissingData &value)
 
void SetTreatMissingData (TreatMissingData &&value)
 
PutAlarmRequestWithTreatMissingData (const TreatMissingData &value)
 
PutAlarmRequestWithTreatMissingData (TreatMissingData &&value)
 
const Aws::Vector< ContactProtocol > & GetContactProtocols () const
 
bool ContactProtocolsHasBeenSet () const
 
void SetContactProtocols (const Aws::Vector< ContactProtocol > &value)
 
void SetContactProtocols (Aws::Vector< ContactProtocol > &&value)
 
PutAlarmRequestWithContactProtocols (const Aws::Vector< ContactProtocol > &value)
 
PutAlarmRequestWithContactProtocols (Aws::Vector< ContactProtocol > &&value)
 
PutAlarmRequestAddContactProtocols (const ContactProtocol &value)
 
PutAlarmRequestAddContactProtocols (ContactProtocol &&value)
 
const Aws::Vector< AlarmState > & GetNotificationTriggers () const
 
bool NotificationTriggersHasBeenSet () const
 
void SetNotificationTriggers (const Aws::Vector< AlarmState > &value)
 
void SetNotificationTriggers (Aws::Vector< AlarmState > &&value)
 
PutAlarmRequestWithNotificationTriggers (const Aws::Vector< AlarmState > &value)
 
PutAlarmRequestWithNotificationTriggers (Aws::Vector< AlarmState > &&value)
 
PutAlarmRequestAddNotificationTriggers (const AlarmState &value)
 
PutAlarmRequestAddNotificationTriggers (AlarmState &&value)
 
bool GetNotificationEnabled () const
 
bool NotificationEnabledHasBeenSet () const
 
void SetNotificationEnabled (bool value)
 
PutAlarmRequestWithNotificationEnabled (bool 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 27 of file PutAlarmRequest.h.

Constructor & Destructor Documentation

◆ PutAlarmRequest()

Aws::Lightsail::Model::PutAlarmRequest::PutAlarmRequest ( )

Member Function Documentation

◆ AddContactProtocols() [1/2]

PutAlarmRequest& Aws::Lightsail::Model::PutAlarmRequest::AddContactProtocols ( const ContactProtocol value)
inline

The contact protocols to use for the alarm, such as Email, SMS (text messaging), or both.

A notification is sent via the specified contact protocol if notifications are enabled for the alarm, and when the alarm is triggered.

A notification is not sent if a contact protocol is not specified, if the specified contact protocol is not configured in the AWS Region, or if notifications are not enabled for the alarm using the notificationEnabled paramater.

Use the CreateContactMethod action to configure a contact protocol in an AWS Region.

Definition at line 620 of file PutAlarmRequest.h.

◆ AddContactProtocols() [2/2]

PutAlarmRequest& Aws::Lightsail::Model::PutAlarmRequest::AddContactProtocols ( ContactProtocol &&  value)
inline

The contact protocols to use for the alarm, such as Email, SMS (text messaging), or both.

A notification is sent via the specified contact protocol if notifications are enabled for the alarm, and when the alarm is triggered.

A notification is not sent if a contact protocol is not specified, if the specified contact protocol is not configured in the AWS Region, or if notifications are not enabled for the alarm using the notificationEnabled paramater.

Use the CreateContactMethod action to configure a contact protocol in an AWS Region.

Definition at line 633 of file PutAlarmRequest.h.

◆ AddNotificationTriggers() [1/2]

PutAlarmRequest& Aws::Lightsail::Model::PutAlarmRequest::AddNotificationTriggers ( const AlarmState value)
inline

The alarm states that trigger a notification.

An alarm has the following possible states:

  • ALARM - The metric is outside of the defined threshold.

  • INSUFFICIENT_DATA - The alarm has just started, the metric is not available, or not enough data is available for the metric to determine the alarm state.

  • OK - The metric is within the defined threshold.

When you specify a notification trigger, the ALARM state must be specified. The INSUFFICIENT_DATA and OK states can be specified in addition to the ALARM state.

  • If you specify OK as an alarm trigger, a notification is sent when the alarm switches from an ALARM or INSUFFICIENT_DATA alarm state to an OK state. This can be thought of as an all clear alarm notification.

  • If you specify INSUFFICIENT_DATA as the alarm trigger, a notification is sent when the alarm switches from an OK or ALARM alarm state to an INSUFFICIENT_DATA state.

The notification trigger defaults to ALARM if you don't specify this parameter.

Definition at line 788 of file PutAlarmRequest.h.

◆ AddNotificationTriggers() [2/2]

PutAlarmRequest& Aws::Lightsail::Model::PutAlarmRequest::AddNotificationTriggers ( AlarmState &&  value)
inline

The alarm states that trigger a notification.

An alarm has the following possible states:

  • ALARM - The metric is outside of the defined threshold.

  • INSUFFICIENT_DATA - The alarm has just started, the metric is not available, or not enough data is available for the metric to determine the alarm state.

  • OK - The metric is within the defined threshold.

When you specify a notification trigger, the ALARM state must be specified. The INSUFFICIENT_DATA and OK states can be specified in addition to the ALARM state.

  • If you specify OK as an alarm trigger, a notification is sent when the alarm switches from an ALARM or INSUFFICIENT_DATA alarm state to an OK state. This can be thought of as an all clear alarm notification.

  • If you specify INSUFFICIENT_DATA as the alarm trigger, a notification is sent when the alarm switches from an OK or ALARM alarm state to an INSUFFICIENT_DATA state.

The notification trigger defaults to ALARM if you don't specify this parameter.

Definition at line 810 of file PutAlarmRequest.h.

◆ AlarmNameHasBeenSet()

bool Aws::Lightsail::Model::PutAlarmRequest::AlarmNameHasBeenSet ( ) const
inline

The name for the alarm. Specify the name of an existing alarm to update, and overwrite the previous configuration of the alarm.

Definition at line 53 of file PutAlarmRequest.h.

◆ ComparisonOperatorHasBeenSet()

bool Aws::Lightsail::Model::PutAlarmRequest::ComparisonOperatorHasBeenSet ( ) const
inline

The arithmetic operation to use when comparing the specified statistic to the threshold. The specified statistic value is used as the first operand.

Definition at line 310 of file PutAlarmRequest.h.

◆ ContactProtocolsHasBeenSet()

bool Aws::Lightsail::Model::PutAlarmRequest::ContactProtocolsHasBeenSet ( ) const
inline

The contact protocols to use for the alarm, such as Email, SMS (text messaging), or both.

A notification is sent via the specified contact protocol if notifications are enabled for the alarm, and when the alarm is triggered.

A notification is not sent if a contact protocol is not specified, if the specified contact protocol is not configured in the AWS Region, or if notifications are not enabled for the alarm using the notificationEnabled paramater.

Use the CreateContactMethod action to configure a contact protocol in an AWS Region.

Definition at line 555 of file PutAlarmRequest.h.

◆ DatapointsToAlarmHasBeenSet()

bool Aws::Lightsail::Model::PutAlarmRequest::DatapointsToAlarmHasBeenSet ( ) const
inline

The number of data points that must be not within the specified threshold to trigger the alarm. If you are setting an "M out of N" alarm, this value (datapointsToAlarm) is the M.

Definition at line 423 of file PutAlarmRequest.h.

◆ EvaluationPeriodsHasBeenSet()

bool Aws::Lightsail::Model::PutAlarmRequest::EvaluationPeriodsHasBeenSet ( ) const
inline

The number of most recent periods over which data is compared to the specified threshold. If you are setting an "M out of N" alarm, this value (evaluationPeriods) is the N.

If you are setting an alarm that requires that a number of consecutive data points be breaching to trigger the alarm, this value specifies the rolling period of time in which data points are evaluated.

Each evaluation period is five minutes long. For example, specify an evaluation period of 24 to evaluate a metric over a rolling period of two hours.

You can specify a minimum valuation period of 1 (5 minutes), and a maximum evaluation period of 288 (24 hours).

Definition at line 382 of file PutAlarmRequest.h.

◆ GetAlarmName()

const Aws::String& Aws::Lightsail::Model::PutAlarmRequest::GetAlarmName ( ) const
inline

The name for the alarm. Specify the name of an existing alarm to update, and overwrite the previous configuration of the alarm.

Definition at line 47 of file PutAlarmRequest.h.

◆ GetComparisonOperator()

const ComparisonOperator& Aws::Lightsail::Model::PutAlarmRequest::GetComparisonOperator ( ) const
inline

The arithmetic operation to use when comparing the specified statistic to the threshold. The specified statistic value is used as the first operand.

Definition at line 304 of file PutAlarmRequest.h.

◆ GetContactProtocols()

const Aws::Vector<ContactProtocol>& Aws::Lightsail::Model::PutAlarmRequest::GetContactProtocols ( ) const
inline

The contact protocols to use for the alarm, such as Email, SMS (text messaging), or both.

A notification is sent via the specified contact protocol if notifications are enabled for the alarm, and when the alarm is triggered.

A notification is not sent if a contact protocol is not specified, if the specified contact protocol is not configured in the AWS Region, or if notifications are not enabled for the alarm using the notificationEnabled paramater.

Use the CreateContactMethod action to configure a contact protocol in an AWS Region.

Definition at line 542 of file PutAlarmRequest.h.

◆ GetDatapointsToAlarm()

int Aws::Lightsail::Model::PutAlarmRequest::GetDatapointsToAlarm ( ) const
inline

The number of data points that must be not within the specified threshold to trigger the alarm. If you are setting an "M out of N" alarm, this value (datapointsToAlarm) is the M.

Definition at line 416 of file PutAlarmRequest.h.

◆ GetEvaluationPeriods()

int Aws::Lightsail::Model::PutAlarmRequest::GetEvaluationPeriods ( ) const
inline

The number of most recent periods over which data is compared to the specified threshold. If you are setting an "M out of N" alarm, this value (evaluationPeriods) is the N.

If you are setting an alarm that requires that a number of consecutive data points be breaching to trigger the alarm, this value specifies the rolling period of time in which data points are evaluated.

Each evaluation period is five minutes long. For example, specify an evaluation period of 24 to evaluate a metric over a rolling period of two hours.

You can specify a minimum valuation period of 1 (5 minutes), and a maximum evaluation period of 288 (24 hours).

Definition at line 369 of file PutAlarmRequest.h.

◆ GetMetricName()

const MetricName& Aws::Lightsail::Model::PutAlarmRequest::GetMetricName ( ) const
inline

The name of the metric to associate with the alarm.

You can configure up to two alarms per metric.

The following metrics are available for each resource type:

  • Instances: BurstCapacityPercentage, BurstCapacityTime, CPUUtilization, NetworkIn, NetworkOut, StatusCheckFailed, StatusCheckFailed_Instance, and StatusCheckFailed_System.

  • Load balancers: ClientTLSNegotiationErrorCount, HealthyHostCount, UnhealthyHostCount, HTTPCode_LB_4XX_Count, HTTPCode_LB_5XX_Count, HTTPCode_Instance_2XX_Count, HTTPCode_Instance_3XX_Count, HTTPCode_Instance_4XX_Count, HTTPCode_Instance_5XX_Count, InstanceResponseTime, RejectedConnectionCount, and RequestCount.

  • Relational databases: CPUUtilization, DatabaseConnections, DiskQueueDepth, FreeStorageSpace, NetworkReceiveThroughput, and NetworkTransmitThroughput.

For more information about these metrics, see Metrics available in Lightsail.

Definition at line 115 of file PutAlarmRequest.h.

◆ GetMonitoredResourceName()

const Aws::String& Aws::Lightsail::Model::PutAlarmRequest::GetMonitoredResourceName ( ) const
inline

The name of the Lightsail resource that will be monitored.

Instances, load balancers, and relational databases are the only Lightsail resources that can currently be monitored by alarms.

Definition at line 248 of file PutAlarmRequest.h.

◆ GetNotificationEnabled()

bool Aws::Lightsail::Model::PutAlarmRequest::GetNotificationEnabled ( ) const
inline

Indicates whether the alarm is enabled.

Notifications are enabled by default if you don't specify this parameter.

Definition at line 817 of file PutAlarmRequest.h.

◆ GetNotificationTriggers()

const Aws::Vector<AlarmState>& Aws::Lightsail::Model::PutAlarmRequest::GetNotificationTriggers ( ) const
inline

The alarm states that trigger a notification.

An alarm has the following possible states:

  • ALARM - The metric is outside of the defined threshold.

  • INSUFFICIENT_DATA - The alarm has just started, the metric is not available, or not enough data is available for the metric to determine the alarm state.

  • OK - The metric is within the defined threshold.

When you specify a notification trigger, the ALARM state must be specified. The INSUFFICIENT_DATA and OK states can be specified in addition to the ALARM state.

  • If you specify OK as an alarm trigger, a notification is sent when the alarm switches from an ALARM or INSUFFICIENT_DATA alarm state to an OK state. This can be thought of as an all clear alarm notification.

  • If you specify INSUFFICIENT_DATA as the alarm trigger, a notification is sent when the alarm switches from an OK or ALARM alarm state to an INSUFFICIENT_DATA state.

The notification trigger defaults to ALARM if you don't specify this parameter.

Definition at line 656 of file PutAlarmRequest.h.

◆ GetRequestSpecificHeaders()

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

Reimplemented from Aws::Lightsail::LightsailRequest.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 36 of file PutAlarmRequest.h.

◆ GetThreshold()

double Aws::Lightsail::Model::PutAlarmRequest::GetThreshold ( ) const
inline

The value against which the specified statistic is compared.

Definition at line 340 of file PutAlarmRequest.h.

◆ GetTreatMissingData()

const TreatMissingData& Aws::Lightsail::Model::PutAlarmRequest::GetTreatMissingData ( ) const
inline

Sets how this alarm will handle missing data points.

An alarm can treat missing data in the following ways:

  • breaching - Assume the missing data is not within the threshold. Missing data counts towards the number of times the metric is not within the threshold.

  • notBreaching - Assume the missing data is within the threshold. Missing data does not count towards the number of times the metric is not within the threshold.

  • ignore - Ignore the missing data. Maintains the current alarm state.

  • missing - Missing data is treated as missing.

If treatMissingData is not specified, the default behavior of missing is used.

Definition at line 453 of file PutAlarmRequest.h.

◆ MetricNameHasBeenSet()

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

The name of the metric to associate with the alarm.

You can configure up to two alarms per metric.

The following metrics are available for each resource type:

  • Instances: BurstCapacityPercentage, BurstCapacityTime, CPUUtilization, NetworkIn, NetworkOut, StatusCheckFailed, StatusCheckFailed_Instance, and StatusCheckFailed_System.

  • Load balancers: ClientTLSNegotiationErrorCount, HealthyHostCount, UnhealthyHostCount, HTTPCode_LB_4XX_Count, HTTPCode_LB_5XX_Count, HTTPCode_Instance_2XX_Count, HTTPCode_Instance_3XX_Count, HTTPCode_Instance_4XX_Count, HTTPCode_Instance_5XX_Count, InstanceResponseTime, RejectedConnectionCount, and RequestCount.

  • Relational databases: CPUUtilization, DatabaseConnections, DiskQueueDepth, FreeStorageSpace, NetworkReceiveThroughput, and NetworkTransmitThroughput.

For more information about these metrics, see Metrics available in Lightsail.

Definition at line 140 of file PutAlarmRequest.h.

◆ MonitoredResourceNameHasBeenSet()

bool Aws::Lightsail::Model::PutAlarmRequest::MonitoredResourceNameHasBeenSet ( ) const
inline

The name of the Lightsail resource that will be monitored.

Instances, load balancers, and relational databases are the only Lightsail resources that can currently be monitored by alarms.

Definition at line 255 of file PutAlarmRequest.h.

◆ NotificationEnabledHasBeenSet()

bool Aws::Lightsail::Model::PutAlarmRequest::NotificationEnabledHasBeenSet ( ) const
inline

Indicates whether the alarm is enabled.

Notifications are enabled by default if you don't specify this parameter.

Definition at line 823 of file PutAlarmRequest.h.

◆ NotificationTriggersHasBeenSet()

bool Aws::Lightsail::Model::PutAlarmRequest::NotificationTriggersHasBeenSet ( ) const
inline

The alarm states that trigger a notification.

An alarm has the following possible states:

  • ALARM - The metric is outside of the defined threshold.

  • INSUFFICIENT_DATA - The alarm has just started, the metric is not available, or not enough data is available for the metric to determine the alarm state.

  • OK - The metric is within the defined threshold.

When you specify a notification trigger, the ALARM state must be specified. The INSUFFICIENT_DATA and OK states can be specified in addition to the ALARM state.

  • If you specify OK as an alarm trigger, a notification is sent when the alarm switches from an ALARM or INSUFFICIENT_DATA alarm state to an OK state. This can be thought of as an all clear alarm notification.

  • If you specify INSUFFICIENT_DATA as the alarm trigger, a notification is sent when the alarm switches from an OK or ALARM alarm state to an INSUFFICIENT_DATA state.

The notification trigger defaults to ALARM if you don't specify this parameter.

Definition at line 678 of file PutAlarmRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAlarmName() [1/3]

void Aws::Lightsail::Model::PutAlarmRequest::SetAlarmName ( const Aws::String value)
inline

The name for the alarm. Specify the name of an existing alarm to update, and overwrite the previous configuration of the alarm.

Definition at line 59 of file PutAlarmRequest.h.

◆ SetAlarmName() [2/3]

void Aws::Lightsail::Model::PutAlarmRequest::SetAlarmName ( Aws::String &&  value)
inline

The name for the alarm. Specify the name of an existing alarm to update, and overwrite the previous configuration of the alarm.

Definition at line 65 of file PutAlarmRequest.h.

◆ SetAlarmName() [3/3]

void Aws::Lightsail::Model::PutAlarmRequest::SetAlarmName ( const char *  value)
inline

The name for the alarm. Specify the name of an existing alarm to update, and overwrite the previous configuration of the alarm.

Definition at line 71 of file PutAlarmRequest.h.

◆ SetComparisonOperator() [1/2]

void Aws::Lightsail::Model::PutAlarmRequest::SetComparisonOperator ( const ComparisonOperator value)
inline

The arithmetic operation to use when comparing the specified statistic to the threshold. The specified statistic value is used as the first operand.

Definition at line 316 of file PutAlarmRequest.h.

◆ SetComparisonOperator() [2/2]

void Aws::Lightsail::Model::PutAlarmRequest::SetComparisonOperator ( ComparisonOperator &&  value)
inline

The arithmetic operation to use when comparing the specified statistic to the threshold. The specified statistic value is used as the first operand.

Definition at line 322 of file PutAlarmRequest.h.

◆ SetContactProtocols() [1/2]

void Aws::Lightsail::Model::PutAlarmRequest::SetContactProtocols ( const Aws::Vector< ContactProtocol > &  value)
inline

The contact protocols to use for the alarm, such as Email, SMS (text messaging), or both.

A notification is sent via the specified contact protocol if notifications are enabled for the alarm, and when the alarm is triggered.

A notification is not sent if a contact protocol is not specified, if the specified contact protocol is not configured in the AWS Region, or if notifications are not enabled for the alarm using the notificationEnabled paramater.

Use the CreateContactMethod action to configure a contact protocol in an AWS Region.

Definition at line 568 of file PutAlarmRequest.h.

◆ SetContactProtocols() [2/2]

void Aws::Lightsail::Model::PutAlarmRequest::SetContactProtocols ( Aws::Vector< ContactProtocol > &&  value)
inline

The contact protocols to use for the alarm, such as Email, SMS (text messaging), or both.

A notification is sent via the specified contact protocol if notifications are enabled for the alarm, and when the alarm is triggered.

A notification is not sent if a contact protocol is not specified, if the specified contact protocol is not configured in the AWS Region, or if notifications are not enabled for the alarm using the notificationEnabled paramater.

Use the CreateContactMethod action to configure a contact protocol in an AWS Region.

Definition at line 581 of file PutAlarmRequest.h.

◆ SetDatapointsToAlarm()

void Aws::Lightsail::Model::PutAlarmRequest::SetDatapointsToAlarm ( int  value)
inline

The number of data points that must be not within the specified threshold to trigger the alarm. If you are setting an "M out of N" alarm, this value (datapointsToAlarm) is the M.

Definition at line 430 of file PutAlarmRequest.h.

◆ SetEvaluationPeriods()

void Aws::Lightsail::Model::PutAlarmRequest::SetEvaluationPeriods ( int  value)
inline

The number of most recent periods over which data is compared to the specified threshold. If you are setting an "M out of N" alarm, this value (evaluationPeriods) is the N.

If you are setting an alarm that requires that a number of consecutive data points be breaching to trigger the alarm, this value specifies the rolling period of time in which data points are evaluated.

Each evaluation period is five minutes long. For example, specify an evaluation period of 24 to evaluate a metric over a rolling period of two hours.

You can specify a minimum valuation period of 1 (5 minutes), and a maximum evaluation period of 288 (24 hours).

Definition at line 395 of file PutAlarmRequest.h.

◆ SetMetricName() [1/2]

void Aws::Lightsail::Model::PutAlarmRequest::SetMetricName ( const MetricName value)
inline

The name of the metric to associate with the alarm.

You can configure up to two alarms per metric.

The following metrics are available for each resource type:

  • Instances: BurstCapacityPercentage, BurstCapacityTime, CPUUtilization, NetworkIn, NetworkOut, StatusCheckFailed, StatusCheckFailed_Instance, and StatusCheckFailed_System.

  • Load balancers: ClientTLSNegotiationErrorCount, HealthyHostCount, UnhealthyHostCount, HTTPCode_LB_4XX_Count, HTTPCode_LB_5XX_Count, HTTPCode_Instance_2XX_Count, HTTPCode_Instance_3XX_Count, HTTPCode_Instance_4XX_Count, HTTPCode_Instance_5XX_Count, InstanceResponseTime, RejectedConnectionCount, and RequestCount.

  • Relational databases: CPUUtilization, DatabaseConnections, DiskQueueDepth, FreeStorageSpace, NetworkReceiveThroughput, and NetworkTransmitThroughput.

For more information about these metrics, see Metrics available in Lightsail.

Definition at line 165 of file PutAlarmRequest.h.

◆ SetMetricName() [2/2]

void Aws::Lightsail::Model::PutAlarmRequest::SetMetricName ( MetricName &&  value)
inline

The name of the metric to associate with the alarm.

You can configure up to two alarms per metric.

The following metrics are available for each resource type:

  • Instances: BurstCapacityPercentage, BurstCapacityTime, CPUUtilization, NetworkIn, NetworkOut, StatusCheckFailed, StatusCheckFailed_Instance, and StatusCheckFailed_System.

  • Load balancers: ClientTLSNegotiationErrorCount, HealthyHostCount, UnhealthyHostCount, HTTPCode_LB_4XX_Count, HTTPCode_LB_5XX_Count, HTTPCode_Instance_2XX_Count, HTTPCode_Instance_3XX_Count, HTTPCode_Instance_4XX_Count, HTTPCode_Instance_5XX_Count, InstanceResponseTime, RejectedConnectionCount, and RequestCount.

  • Relational databases: CPUUtilization, DatabaseConnections, DiskQueueDepth, FreeStorageSpace, NetworkReceiveThroughput, and NetworkTransmitThroughput.

For more information about these metrics, see Metrics available in Lightsail.

Definition at line 190 of file PutAlarmRequest.h.

◆ SetMonitoredResourceName() [1/3]

void Aws::Lightsail::Model::PutAlarmRequest::SetMonitoredResourceName ( const Aws::String value)
inline

The name of the Lightsail resource that will be monitored.

Instances, load balancers, and relational databases are the only Lightsail resources that can currently be monitored by alarms.

Definition at line 262 of file PutAlarmRequest.h.

◆ SetMonitoredResourceName() [2/3]

void Aws::Lightsail::Model::PutAlarmRequest::SetMonitoredResourceName ( Aws::String &&  value)
inline

The name of the Lightsail resource that will be monitored.

Instances, load balancers, and relational databases are the only Lightsail resources that can currently be monitored by alarms.

Definition at line 269 of file PutAlarmRequest.h.

◆ SetMonitoredResourceName() [3/3]

void Aws::Lightsail::Model::PutAlarmRequest::SetMonitoredResourceName ( const char *  value)
inline

The name of the Lightsail resource that will be monitored.

Instances, load balancers, and relational databases are the only Lightsail resources that can currently be monitored by alarms.

Definition at line 276 of file PutAlarmRequest.h.

◆ SetNotificationEnabled()

void Aws::Lightsail::Model::PutAlarmRequest::SetNotificationEnabled ( bool  value)
inline

Indicates whether the alarm is enabled.

Notifications are enabled by default if you don't specify this parameter.

Definition at line 829 of file PutAlarmRequest.h.

◆ SetNotificationTriggers() [1/2]

void Aws::Lightsail::Model::PutAlarmRequest::SetNotificationTriggers ( const Aws::Vector< AlarmState > &  value)
inline

The alarm states that trigger a notification.

An alarm has the following possible states:

  • ALARM - The metric is outside of the defined threshold.

  • INSUFFICIENT_DATA - The alarm has just started, the metric is not available, or not enough data is available for the metric to determine the alarm state.

  • OK - The metric is within the defined threshold.

When you specify a notification trigger, the ALARM state must be specified. The INSUFFICIENT_DATA and OK states can be specified in addition to the ALARM state.

  • If you specify OK as an alarm trigger, a notification is sent when the alarm switches from an ALARM or INSUFFICIENT_DATA alarm state to an OK state. This can be thought of as an all clear alarm notification.

  • If you specify INSUFFICIENT_DATA as the alarm trigger, a notification is sent when the alarm switches from an OK or ALARM alarm state to an INSUFFICIENT_DATA state.

The notification trigger defaults to ALARM if you don't specify this parameter.

Definition at line 700 of file PutAlarmRequest.h.

◆ SetNotificationTriggers() [2/2]

void Aws::Lightsail::Model::PutAlarmRequest::SetNotificationTriggers ( Aws::Vector< AlarmState > &&  value)
inline

The alarm states that trigger a notification.

An alarm has the following possible states:

  • ALARM - The metric is outside of the defined threshold.

  • INSUFFICIENT_DATA - The alarm has just started, the metric is not available, or not enough data is available for the metric to determine the alarm state.

  • OK - The metric is within the defined threshold.

When you specify a notification trigger, the ALARM state must be specified. The INSUFFICIENT_DATA and OK states can be specified in addition to the ALARM state.

  • If you specify OK as an alarm trigger, a notification is sent when the alarm switches from an ALARM or INSUFFICIENT_DATA alarm state to an OK state. This can be thought of as an all clear alarm notification.

  • If you specify INSUFFICIENT_DATA as the alarm trigger, a notification is sent when the alarm switches from an OK or ALARM alarm state to an INSUFFICIENT_DATA state.

The notification trigger defaults to ALARM if you don't specify this parameter.

Definition at line 722 of file PutAlarmRequest.h.

◆ SetThreshold()

void Aws::Lightsail::Model::PutAlarmRequest::SetThreshold ( double  value)
inline

The value against which the specified statistic is compared.

Definition at line 350 of file PutAlarmRequest.h.

◆ SetTreatMissingData() [1/2]

void Aws::Lightsail::Model::PutAlarmRequest::SetTreatMissingData ( const TreatMissingData value)
inline

Sets how this alarm will handle missing data points.

An alarm can treat missing data in the following ways:

  • breaching - Assume the missing data is not within the threshold. Missing data counts towards the number of times the metric is not within the threshold.

  • notBreaching - Assume the missing data is within the threshold. Missing data does not count towards the number of times the metric is not within the threshold.

  • ignore - Ignore the missing data. Maintains the current alarm state.

  • missing - Missing data is treated as missing.

If treatMissingData is not specified, the default behavior of missing is used.

Definition at line 483 of file PutAlarmRequest.h.

◆ SetTreatMissingData() [2/2]

void Aws::Lightsail::Model::PutAlarmRequest::SetTreatMissingData ( TreatMissingData &&  value)
inline

Sets how this alarm will handle missing data points.

An alarm can treat missing data in the following ways:

  • breaching - Assume the missing data is not within the threshold. Missing data counts towards the number of times the metric is not within the threshold.

  • notBreaching - Assume the missing data is within the threshold. Missing data does not count towards the number of times the metric is not within the threshold.

  • ignore - Ignore the missing data. Maintains the current alarm state.

  • missing - Missing data is treated as missing.

If treatMissingData is not specified, the default behavior of missing is used.

Definition at line 498 of file PutAlarmRequest.h.

◆ ThresholdHasBeenSet()

bool Aws::Lightsail::Model::PutAlarmRequest::ThresholdHasBeenSet ( ) const
inline

The value against which the specified statistic is compared.

Definition at line 345 of file PutAlarmRequest.h.

◆ TreatMissingDataHasBeenSet()

bool Aws::Lightsail::Model::PutAlarmRequest::TreatMissingDataHasBeenSet ( ) const
inline

Sets how this alarm will handle missing data points.

An alarm can treat missing data in the following ways:

  • breaching - Assume the missing data is not within the threshold. Missing data counts towards the number of times the metric is not within the threshold.

  • notBreaching - Assume the missing data is within the threshold. Missing data does not count towards the number of times the metric is not within the threshold.

  • ignore - Ignore the missing data. Maintains the current alarm state.

  • missing - Missing data is treated as missing.

If treatMissingData is not specified, the default behavior of missing is used.

Definition at line 468 of file PutAlarmRequest.h.

◆ WithAlarmName() [1/3]

PutAlarmRequest& Aws::Lightsail::Model::PutAlarmRequest::WithAlarmName ( const Aws::String value)
inline

The name for the alarm. Specify the name of an existing alarm to update, and overwrite the previous configuration of the alarm.

Definition at line 77 of file PutAlarmRequest.h.

◆ WithAlarmName() [2/3]

PutAlarmRequest& Aws::Lightsail::Model::PutAlarmRequest::WithAlarmName ( Aws::String &&  value)
inline

The name for the alarm. Specify the name of an existing alarm to update, and overwrite the previous configuration of the alarm.

Definition at line 83 of file PutAlarmRequest.h.

◆ WithAlarmName() [3/3]

PutAlarmRequest& Aws::Lightsail::Model::PutAlarmRequest::WithAlarmName ( const char *  value)
inline

The name for the alarm. Specify the name of an existing alarm to update, and overwrite the previous configuration of the alarm.

Definition at line 89 of file PutAlarmRequest.h.

◆ WithComparisonOperator() [1/2]

PutAlarmRequest& Aws::Lightsail::Model::PutAlarmRequest::WithComparisonOperator ( const ComparisonOperator value)
inline

The arithmetic operation to use when comparing the specified statistic to the threshold. The specified statistic value is used as the first operand.

Definition at line 328 of file PutAlarmRequest.h.

◆ WithComparisonOperator() [2/2]

PutAlarmRequest& Aws::Lightsail::Model::PutAlarmRequest::WithComparisonOperator ( ComparisonOperator &&  value)
inline

The arithmetic operation to use when comparing the specified statistic to the threshold. The specified statistic value is used as the first operand.

Definition at line 334 of file PutAlarmRequest.h.

◆ WithContactProtocols() [1/2]

PutAlarmRequest& Aws::Lightsail::Model::PutAlarmRequest::WithContactProtocols ( const Aws::Vector< ContactProtocol > &  value)
inline

The contact protocols to use for the alarm, such as Email, SMS (text messaging), or both.

A notification is sent via the specified contact protocol if notifications are enabled for the alarm, and when the alarm is triggered.

A notification is not sent if a contact protocol is not specified, if the specified contact protocol is not configured in the AWS Region, or if notifications are not enabled for the alarm using the notificationEnabled paramater.

Use the CreateContactMethod action to configure a contact protocol in an AWS Region.

Definition at line 594 of file PutAlarmRequest.h.

◆ WithContactProtocols() [2/2]

PutAlarmRequest& Aws::Lightsail::Model::PutAlarmRequest::WithContactProtocols ( Aws::Vector< ContactProtocol > &&  value)
inline

The contact protocols to use for the alarm, such as Email, SMS (text messaging), or both.

A notification is sent via the specified contact protocol if notifications are enabled for the alarm, and when the alarm is triggered.

A notification is not sent if a contact protocol is not specified, if the specified contact protocol is not configured in the AWS Region, or if notifications are not enabled for the alarm using the notificationEnabled paramater.

Use the CreateContactMethod action to configure a contact protocol in an AWS Region.

Definition at line 607 of file PutAlarmRequest.h.

◆ WithDatapointsToAlarm()

PutAlarmRequest& Aws::Lightsail::Model::PutAlarmRequest::WithDatapointsToAlarm ( int  value)
inline

The number of data points that must be not within the specified threshold to trigger the alarm. If you are setting an "M out of N" alarm, this value (datapointsToAlarm) is the M.

Definition at line 437 of file PutAlarmRequest.h.

◆ WithEvaluationPeriods()

PutAlarmRequest& Aws::Lightsail::Model::PutAlarmRequest::WithEvaluationPeriods ( int  value)
inline

The number of most recent periods over which data is compared to the specified threshold. If you are setting an "M out of N" alarm, this value (evaluationPeriods) is the N.

If you are setting an alarm that requires that a number of consecutive data points be breaching to trigger the alarm, this value specifies the rolling period of time in which data points are evaluated.

Each evaluation period is five minutes long. For example, specify an evaluation period of 24 to evaluate a metric over a rolling period of two hours.

You can specify a minimum valuation period of 1 (5 minutes), and a maximum evaluation period of 288 (24 hours).

Definition at line 408 of file PutAlarmRequest.h.

◆ WithMetricName() [1/2]

PutAlarmRequest& Aws::Lightsail::Model::PutAlarmRequest::WithMetricName ( const MetricName value)
inline

The name of the metric to associate with the alarm.

You can configure up to two alarms per metric.

The following metrics are available for each resource type:

  • Instances: BurstCapacityPercentage, BurstCapacityTime, CPUUtilization, NetworkIn, NetworkOut, StatusCheckFailed, StatusCheckFailed_Instance, and StatusCheckFailed_System.

  • Load balancers: ClientTLSNegotiationErrorCount, HealthyHostCount, UnhealthyHostCount, HTTPCode_LB_4XX_Count, HTTPCode_LB_5XX_Count, HTTPCode_Instance_2XX_Count, HTTPCode_Instance_3XX_Count, HTTPCode_Instance_4XX_Count, HTTPCode_Instance_5XX_Count, InstanceResponseTime, RejectedConnectionCount, and RequestCount.

  • Relational databases: CPUUtilization, DatabaseConnections, DiskQueueDepth, FreeStorageSpace, NetworkReceiveThroughput, and NetworkTransmitThroughput.

For more information about these metrics, see Metrics available in Lightsail.

Definition at line 215 of file PutAlarmRequest.h.

◆ WithMetricName() [2/2]

PutAlarmRequest& Aws::Lightsail::Model::PutAlarmRequest::WithMetricName ( MetricName &&  value)
inline

The name of the metric to associate with the alarm.

You can configure up to two alarms per metric.

The following metrics are available for each resource type:

  • Instances: BurstCapacityPercentage, BurstCapacityTime, CPUUtilization, NetworkIn, NetworkOut, StatusCheckFailed, StatusCheckFailed_Instance, and StatusCheckFailed_System.

  • Load balancers: ClientTLSNegotiationErrorCount, HealthyHostCount, UnhealthyHostCount, HTTPCode_LB_4XX_Count, HTTPCode_LB_5XX_Count, HTTPCode_Instance_2XX_Count, HTTPCode_Instance_3XX_Count, HTTPCode_Instance_4XX_Count, HTTPCode_Instance_5XX_Count, InstanceResponseTime, RejectedConnectionCount, and RequestCount.

  • Relational databases: CPUUtilization, DatabaseConnections, DiskQueueDepth, FreeStorageSpace, NetworkReceiveThroughput, and NetworkTransmitThroughput.

For more information about these metrics, see Metrics available in Lightsail.

Definition at line 240 of file PutAlarmRequest.h.

◆ WithMonitoredResourceName() [1/3]

PutAlarmRequest& Aws::Lightsail::Model::PutAlarmRequest::WithMonitoredResourceName ( const Aws::String value)
inline

The name of the Lightsail resource that will be monitored.

Instances, load balancers, and relational databases are the only Lightsail resources that can currently be monitored by alarms.

Definition at line 283 of file PutAlarmRequest.h.

◆ WithMonitoredResourceName() [2/3]

PutAlarmRequest& Aws::Lightsail::Model::PutAlarmRequest::WithMonitoredResourceName ( Aws::String &&  value)
inline

The name of the Lightsail resource that will be monitored.

Instances, load balancers, and relational databases are the only Lightsail resources that can currently be monitored by alarms.

Definition at line 290 of file PutAlarmRequest.h.

◆ WithMonitoredResourceName() [3/3]

PutAlarmRequest& Aws::Lightsail::Model::PutAlarmRequest::WithMonitoredResourceName ( const char *  value)
inline

The name of the Lightsail resource that will be monitored.

Instances, load balancers, and relational databases are the only Lightsail resources that can currently be monitored by alarms.

Definition at line 297 of file PutAlarmRequest.h.

◆ WithNotificationEnabled()

PutAlarmRequest& Aws::Lightsail::Model::PutAlarmRequest::WithNotificationEnabled ( bool  value)
inline

Indicates whether the alarm is enabled.

Notifications are enabled by default if you don't specify this parameter.

Definition at line 835 of file PutAlarmRequest.h.

◆ WithNotificationTriggers() [1/2]

PutAlarmRequest& Aws::Lightsail::Model::PutAlarmRequest::WithNotificationTriggers ( const Aws::Vector< AlarmState > &  value)
inline

The alarm states that trigger a notification.

An alarm has the following possible states:

  • ALARM - The metric is outside of the defined threshold.

  • INSUFFICIENT_DATA - The alarm has just started, the metric is not available, or not enough data is available for the metric to determine the alarm state.

  • OK - The metric is within the defined threshold.

When you specify a notification trigger, the ALARM state must be specified. The INSUFFICIENT_DATA and OK states can be specified in addition to the ALARM state.

  • If you specify OK as an alarm trigger, a notification is sent when the alarm switches from an ALARM or INSUFFICIENT_DATA alarm state to an OK state. This can be thought of as an all clear alarm notification.

  • If you specify INSUFFICIENT_DATA as the alarm trigger, a notification is sent when the alarm switches from an OK or ALARM alarm state to an INSUFFICIENT_DATA state.

The notification trigger defaults to ALARM if you don't specify this parameter.

Definition at line 744 of file PutAlarmRequest.h.

◆ WithNotificationTriggers() [2/2]

PutAlarmRequest& Aws::Lightsail::Model::PutAlarmRequest::WithNotificationTriggers ( Aws::Vector< AlarmState > &&  value)
inline

The alarm states that trigger a notification.

An alarm has the following possible states:

  • ALARM - The metric is outside of the defined threshold.

  • INSUFFICIENT_DATA - The alarm has just started, the metric is not available, or not enough data is available for the metric to determine the alarm state.

  • OK - The metric is within the defined threshold.

When you specify a notification trigger, the ALARM state must be specified. The INSUFFICIENT_DATA and OK states can be specified in addition to the ALARM state.

  • If you specify OK as an alarm trigger, a notification is sent when the alarm switches from an ALARM or INSUFFICIENT_DATA alarm state to an OK state. This can be thought of as an all clear alarm notification.

  • If you specify INSUFFICIENT_DATA as the alarm trigger, a notification is sent when the alarm switches from an OK or ALARM alarm state to an INSUFFICIENT_DATA state.

The notification trigger defaults to ALARM if you don't specify this parameter.

Definition at line 766 of file PutAlarmRequest.h.

◆ WithThreshold()

PutAlarmRequest& Aws::Lightsail::Model::PutAlarmRequest::WithThreshold ( double  value)
inline

The value against which the specified statistic is compared.

Definition at line 355 of file PutAlarmRequest.h.

◆ WithTreatMissingData() [1/2]

PutAlarmRequest& Aws::Lightsail::Model::PutAlarmRequest::WithTreatMissingData ( const TreatMissingData value)
inline

Sets how this alarm will handle missing data points.

An alarm can treat missing data in the following ways:

  • breaching - Assume the missing data is not within the threshold. Missing data counts towards the number of times the metric is not within the threshold.

  • notBreaching - Assume the missing data is within the threshold. Missing data does not count towards the number of times the metric is not within the threshold.

  • ignore - Ignore the missing data. Maintains the current alarm state.

  • missing - Missing data is treated as missing.

If treatMissingData is not specified, the default behavior of missing is used.

Definition at line 513 of file PutAlarmRequest.h.

◆ WithTreatMissingData() [2/2]

PutAlarmRequest& Aws::Lightsail::Model::PutAlarmRequest::WithTreatMissingData ( TreatMissingData &&  value)
inline

Sets how this alarm will handle missing data points.

An alarm can treat missing data in the following ways:

  • breaching - Assume the missing data is not within the threshold. Missing data counts towards the number of times the metric is not within the threshold.

  • notBreaching - Assume the missing data is within the threshold. Missing data does not count towards the number of times the metric is not within the threshold.

  • ignore - Ignore the missing data. Maintains the current alarm state.

  • missing - Missing data is treated as missing.

If treatMissingData is not specified, the default behavior of missing is used.

Definition at line 528 of file PutAlarmRequest.h.


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