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

#include <Alarm.h>

Public Member Functions

 Alarm ()
 
 Alarm (Aws::Utils::Json::JsonView jsonValue)
 
Alarmoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetName () const
 
bool NameHasBeenSet () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
AlarmWithName (const Aws::String &value)
 
AlarmWithName (Aws::String &&value)
 
AlarmWithName (const char *value)
 
const Aws::StringGetArn () const
 
bool ArnHasBeenSet () const
 
void SetArn (const Aws::String &value)
 
void SetArn (Aws::String &&value)
 
void SetArn (const char *value)
 
AlarmWithArn (const Aws::String &value)
 
AlarmWithArn (Aws::String &&value)
 
AlarmWithArn (const char *value)
 
const Aws::Utils::DateTimeGetCreatedAt () const
 
bool CreatedAtHasBeenSet () const
 
void SetCreatedAt (const Aws::Utils::DateTime &value)
 
void SetCreatedAt (Aws::Utils::DateTime &&value)
 
AlarmWithCreatedAt (const Aws::Utils::DateTime &value)
 
AlarmWithCreatedAt (Aws::Utils::DateTime &&value)
 
const ResourceLocationGetLocation () const
 
bool LocationHasBeenSet () const
 
void SetLocation (const ResourceLocation &value)
 
void SetLocation (ResourceLocation &&value)
 
AlarmWithLocation (const ResourceLocation &value)
 
AlarmWithLocation (ResourceLocation &&value)
 
const ResourceTypeGetResourceType () const
 
bool ResourceTypeHasBeenSet () const
 
void SetResourceType (const ResourceType &value)
 
void SetResourceType (ResourceType &&value)
 
AlarmWithResourceType (const ResourceType &value)
 
AlarmWithResourceType (ResourceType &&value)
 
const Aws::StringGetSupportCode () const
 
bool SupportCodeHasBeenSet () const
 
void SetSupportCode (const Aws::String &value)
 
void SetSupportCode (Aws::String &&value)
 
void SetSupportCode (const char *value)
 
AlarmWithSupportCode (const Aws::String &value)
 
AlarmWithSupportCode (Aws::String &&value)
 
AlarmWithSupportCode (const char *value)
 
const MonitoredResourceInfoGetMonitoredResourceInfo () const
 
bool MonitoredResourceInfoHasBeenSet () const
 
void SetMonitoredResourceInfo (const MonitoredResourceInfo &value)
 
void SetMonitoredResourceInfo (MonitoredResourceInfo &&value)
 
AlarmWithMonitoredResourceInfo (const MonitoredResourceInfo &value)
 
AlarmWithMonitoredResourceInfo (MonitoredResourceInfo &&value)
 
const ComparisonOperatorGetComparisonOperator () const
 
bool ComparisonOperatorHasBeenSet () const
 
void SetComparisonOperator (const ComparisonOperator &value)
 
void SetComparisonOperator (ComparisonOperator &&value)
 
AlarmWithComparisonOperator (const ComparisonOperator &value)
 
AlarmWithComparisonOperator (ComparisonOperator &&value)
 
int GetEvaluationPeriods () const
 
bool EvaluationPeriodsHasBeenSet () const
 
void SetEvaluationPeriods (int value)
 
AlarmWithEvaluationPeriods (int value)
 
int GetPeriod () const
 
bool PeriodHasBeenSet () const
 
void SetPeriod (int value)
 
AlarmWithPeriod (int value)
 
double GetThreshold () const
 
bool ThresholdHasBeenSet () const
 
void SetThreshold (double value)
 
AlarmWithThreshold (double value)
 
int GetDatapointsToAlarm () const
 
bool DatapointsToAlarmHasBeenSet () const
 
void SetDatapointsToAlarm (int value)
 
AlarmWithDatapointsToAlarm (int value)
 
const TreatMissingDataGetTreatMissingData () const
 
bool TreatMissingDataHasBeenSet () const
 
void SetTreatMissingData (const TreatMissingData &value)
 
void SetTreatMissingData (TreatMissingData &&value)
 
AlarmWithTreatMissingData (const TreatMissingData &value)
 
AlarmWithTreatMissingData (TreatMissingData &&value)
 
const MetricStatisticGetStatistic () const
 
bool StatisticHasBeenSet () const
 
void SetStatistic (const MetricStatistic &value)
 
void SetStatistic (MetricStatistic &&value)
 
AlarmWithStatistic (const MetricStatistic &value)
 
AlarmWithStatistic (MetricStatistic &&value)
 
const MetricNameGetMetricName () const
 
bool MetricNameHasBeenSet () const
 
void SetMetricName (const MetricName &value)
 
void SetMetricName (MetricName &&value)
 
AlarmWithMetricName (const MetricName &value)
 
AlarmWithMetricName (MetricName &&value)
 
const AlarmStateGetState () const
 
bool StateHasBeenSet () const
 
void SetState (const AlarmState &value)
 
void SetState (AlarmState &&value)
 
AlarmWithState (const AlarmState &value)
 
AlarmWithState (AlarmState &&value)
 
const MetricUnitGetUnit () const
 
bool UnitHasBeenSet () const
 
void SetUnit (const MetricUnit &value)
 
void SetUnit (MetricUnit &&value)
 
AlarmWithUnit (const MetricUnit &value)
 
AlarmWithUnit (MetricUnit &&value)
 
const Aws::Vector< ContactProtocol > & GetContactProtocols () const
 
bool ContactProtocolsHasBeenSet () const
 
void SetContactProtocols (const Aws::Vector< ContactProtocol > &value)
 
void SetContactProtocols (Aws::Vector< ContactProtocol > &&value)
 
AlarmWithContactProtocols (const Aws::Vector< ContactProtocol > &value)
 
AlarmWithContactProtocols (Aws::Vector< ContactProtocol > &&value)
 
AlarmAddContactProtocols (const ContactProtocol &value)
 
AlarmAddContactProtocols (ContactProtocol &&value)
 
const Aws::Vector< AlarmState > & GetNotificationTriggers () const
 
bool NotificationTriggersHasBeenSet () const
 
void SetNotificationTriggers (const Aws::Vector< AlarmState > &value)
 
void SetNotificationTriggers (Aws::Vector< AlarmState > &&value)
 
AlarmWithNotificationTriggers (const Aws::Vector< AlarmState > &value)
 
AlarmWithNotificationTriggers (Aws::Vector< AlarmState > &&value)
 
AlarmAddNotificationTriggers (const AlarmState &value)
 
AlarmAddNotificationTriggers (AlarmState &&value)
 
bool GetNotificationEnabled () const
 
bool NotificationEnabledHasBeenSet () const
 
void SetNotificationEnabled (bool value)
 
AlarmWithNotificationEnabled (bool value)
 

Detailed Description

Describes an alarm.

An alarm is a way to monitor your Amazon Lightsail resource metrics. For more information, see Alarms in Amazon Lightsail.

See Also:

AWS API Reference

Definition at line 46 of file Alarm.h.

Constructor & Destructor Documentation

◆ Alarm() [1/2]

Aws::Lightsail::Model::Alarm::Alarm ( )

◆ Alarm() [2/2]

Aws::Lightsail::Model::Alarm::Alarm ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AddContactProtocols() [1/2]

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

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

Definition at line 816 of file Alarm.h.

◆ AddContactProtocols() [2/2]

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

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

Definition at line 822 of file Alarm.h.

◆ AddNotificationTriggers() [1/2]

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

The alarm states that trigger a notification.

Definition at line 858 of file Alarm.h.

◆ AddNotificationTriggers() [2/2]

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

The alarm states that trigger a notification.

Definition at line 863 of file Alarm.h.

◆ ArnHasBeenSet()

bool Aws::Lightsail::Model::Alarm::ArnHasBeenSet ( ) const
inline

The Amazon Resource Name (ARN) of the alarm.

Definition at line 104 of file Alarm.h.

◆ ComparisonOperatorHasBeenSet()

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

The arithmetic operation used when comparing the specified statistic and threshold.

Definition at line 334 of file Alarm.h.

◆ ContactProtocolsHasBeenSet()

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

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

Definition at line 786 of file Alarm.h.

◆ CreatedAtHasBeenSet()

bool Aws::Lightsail::Model::Alarm::CreatedAtHasBeenSet ( ) const
inline

The timestamp when the alarm was created.

Definition at line 145 of file Alarm.h.

◆ DatapointsToAlarmHasBeenSet()

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

The number of data points that must not within the specified threshold to trigger the alarm.

Definition at line 438 of file Alarm.h.

◆ EvaluationPeriodsHasBeenSet()

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

The number of periods over which data is compared to the specified threshold.

Definition at line 371 of file Alarm.h.

◆ GetArn()

const Aws::String& Aws::Lightsail::Model::Alarm::GetArn ( ) const
inline

The Amazon Resource Name (ARN) of the alarm.

Definition at line 99 of file Alarm.h.

◆ GetComparisonOperator()

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

The arithmetic operation used when comparing the specified statistic and threshold.

Definition at line 328 of file Alarm.h.

◆ GetContactProtocols()

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

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

Definition at line 780 of file Alarm.h.

◆ GetCreatedAt()

const Aws::Utils::DateTime& Aws::Lightsail::Model::Alarm::GetCreatedAt ( ) const
inline

The timestamp when the alarm was created.

Definition at line 140 of file Alarm.h.

◆ GetDatapointsToAlarm()

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

The number of data points that must not within the specified threshold to trigger the alarm.

Definition at line 432 of file Alarm.h.

◆ GetEvaluationPeriods()

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

The number of periods over which data is compared to the specified threshold.

Definition at line 365 of file Alarm.h.

◆ GetLocation()

const ResourceLocation& Aws::Lightsail::Model::Alarm::GetLocation ( ) const
inline

An object that lists information about the location of the alarm.

Definition at line 171 of file Alarm.h.

◆ GetMetricName()

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

The name of the metric associated with the alarm.

Definition at line 656 of file Alarm.h.

◆ GetMonitoredResourceInfo()

const MonitoredResourceInfo& Aws::Lightsail::Model::Alarm::GetMonitoredResourceInfo ( ) const
inline

An object that lists information about the resource monitored by the alarm.

Definition at line 291 of file Alarm.h.

◆ GetName()

const Aws::String& Aws::Lightsail::Model::Alarm::GetName ( ) const
inline

The name of the alarm.

Definition at line 58 of file Alarm.h.

◆ GetNotificationEnabled()

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

Indicates whether the alarm is enabled.

Definition at line 869 of file Alarm.h.

◆ GetNotificationTriggers()

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

The alarm states that trigger a notification.

Definition at line 828 of file Alarm.h.

◆ GetPeriod()

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

The period, in seconds, over which the statistic is applied.

Definition at line 389 of file Alarm.h.

◆ GetResourceType()

const ResourceType& Aws::Lightsail::Model::Alarm::GetResourceType ( ) const
inline

The Lightsail resource type (e.g., Alarm).

Definition at line 202 of file Alarm.h.

◆ GetState()

const AlarmState& Aws::Lightsail::Model::Alarm::GetState ( ) const
inline

The current state of the alarm.

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.

Definition at line 692 of file Alarm.h.

◆ GetStatistic()

const MetricStatistic& Aws::Lightsail::Model::Alarm::GetStatistic ( ) const
inline

The statistic for the metric associated with the alarm.

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 555 of file Alarm.h.

◆ GetSupportCode()

const Aws::String& Aws::Lightsail::Model::Alarm::GetSupportCode ( ) const
inline

The support code. Include this code in your email to support when you have questions about your Lightsail alarm. This code enables our support team to look up your Lightsail information more easily.

Definition at line 235 of file Alarm.h.

◆ GetThreshold()

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

The value against which the specified statistic is compared.

Definition at line 410 of file Alarm.h.

◆ GetTreatMissingData()

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

Specifies how the alarm handles 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.

Definition at line 465 of file Alarm.h.

◆ GetUnit()

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

The unit of the metric associated with the alarm.

Definition at line 748 of file Alarm.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::Lightsail::Model::Alarm::Jsonize ( ) const

◆ LocationHasBeenSet()

bool Aws::Lightsail::Model::Alarm::LocationHasBeenSet ( ) const
inline

An object that lists information about the location of the alarm.

Definition at line 176 of file Alarm.h.

◆ MetricNameHasBeenSet()

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

The name of the metric associated with the alarm.

Definition at line 661 of file Alarm.h.

◆ MonitoredResourceInfoHasBeenSet()

bool Aws::Lightsail::Model::Alarm::MonitoredResourceInfoHasBeenSet ( ) const
inline

An object that lists information about the resource monitored by the alarm.

Definition at line 297 of file Alarm.h.

◆ NameHasBeenSet()

bool Aws::Lightsail::Model::Alarm::NameHasBeenSet ( ) const
inline

The name of the alarm.

Definition at line 63 of file Alarm.h.

◆ NotificationEnabledHasBeenSet()

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

Indicates whether the alarm is enabled.

Definition at line 874 of file Alarm.h.

◆ NotificationTriggersHasBeenSet()

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

The alarm states that trigger a notification.

Definition at line 833 of file Alarm.h.

◆ operator=()

Alarm& Aws::Lightsail::Model::Alarm::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ PeriodHasBeenSet()

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

The period, in seconds, over which the statistic is applied.

Definition at line 394 of file Alarm.h.

◆ ResourceTypeHasBeenSet()

bool Aws::Lightsail::Model::Alarm::ResourceTypeHasBeenSet ( ) const
inline

The Lightsail resource type (e.g., Alarm).

Definition at line 207 of file Alarm.h.

◆ SetArn() [1/3]

void Aws::Lightsail::Model::Alarm::SetArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the alarm.

Definition at line 109 of file Alarm.h.

◆ SetArn() [2/3]

void Aws::Lightsail::Model::Alarm::SetArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the alarm.

Definition at line 114 of file Alarm.h.

◆ SetArn() [3/3]

void Aws::Lightsail::Model::Alarm::SetArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the alarm.

Definition at line 119 of file Alarm.h.

◆ SetComparisonOperator() [1/2]

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

The arithmetic operation used when comparing the specified statistic and threshold.

Definition at line 340 of file Alarm.h.

◆ SetComparisonOperator() [2/2]

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

The arithmetic operation used when comparing the specified statistic and threshold.

Definition at line 346 of file Alarm.h.

◆ SetContactProtocols() [1/2]

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

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

Definition at line 792 of file Alarm.h.

◆ SetContactProtocols() [2/2]

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

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

Definition at line 798 of file Alarm.h.

◆ SetCreatedAt() [1/2]

void Aws::Lightsail::Model::Alarm::SetCreatedAt ( const Aws::Utils::DateTime value)
inline

The timestamp when the alarm was created.

Definition at line 150 of file Alarm.h.

◆ SetCreatedAt() [2/2]

void Aws::Lightsail::Model::Alarm::SetCreatedAt ( Aws::Utils::DateTime &&  value)
inline

The timestamp when the alarm was created.

Definition at line 155 of file Alarm.h.

◆ SetDatapointsToAlarm()

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

The number of data points that must not within the specified threshold to trigger the alarm.

Definition at line 444 of file Alarm.h.

◆ SetEvaluationPeriods()

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

The number of periods over which data is compared to the specified threshold.

Definition at line 377 of file Alarm.h.

◆ SetLocation() [1/2]

void Aws::Lightsail::Model::Alarm::SetLocation ( const ResourceLocation value)
inline

An object that lists information about the location of the alarm.

Definition at line 181 of file Alarm.h.

◆ SetLocation() [2/2]

void Aws::Lightsail::Model::Alarm::SetLocation ( ResourceLocation &&  value)
inline

An object that lists information about the location of the alarm.

Definition at line 186 of file Alarm.h.

◆ SetMetricName() [1/2]

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

The name of the metric associated with the alarm.

Definition at line 666 of file Alarm.h.

◆ SetMetricName() [2/2]

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

The name of the metric associated with the alarm.

Definition at line 671 of file Alarm.h.

◆ SetMonitoredResourceInfo() [1/2]

void Aws::Lightsail::Model::Alarm::SetMonitoredResourceInfo ( const MonitoredResourceInfo value)
inline

An object that lists information about the resource monitored by the alarm.

Definition at line 303 of file Alarm.h.

◆ SetMonitoredResourceInfo() [2/2]

void Aws::Lightsail::Model::Alarm::SetMonitoredResourceInfo ( MonitoredResourceInfo &&  value)
inline

An object that lists information about the resource monitored by the alarm.

Definition at line 309 of file Alarm.h.

◆ SetName() [1/3]

void Aws::Lightsail::Model::Alarm::SetName ( const Aws::String value)
inline

The name of the alarm.

Definition at line 68 of file Alarm.h.

◆ SetName() [2/3]

void Aws::Lightsail::Model::Alarm::SetName ( Aws::String &&  value)
inline

The name of the alarm.

Definition at line 73 of file Alarm.h.

◆ SetName() [3/3]

void Aws::Lightsail::Model::Alarm::SetName ( const char *  value)
inline

The name of the alarm.

Definition at line 78 of file Alarm.h.

◆ SetNotificationEnabled()

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

Indicates whether the alarm is enabled.

Definition at line 879 of file Alarm.h.

◆ SetNotificationTriggers() [1/2]

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

The alarm states that trigger a notification.

Definition at line 838 of file Alarm.h.

◆ SetNotificationTriggers() [2/2]

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

The alarm states that trigger a notification.

Definition at line 843 of file Alarm.h.

◆ SetPeriod()

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

The period, in seconds, over which the statistic is applied.

Definition at line 399 of file Alarm.h.

◆ SetResourceType() [1/2]

void Aws::Lightsail::Model::Alarm::SetResourceType ( const ResourceType value)
inline

The Lightsail resource type (e.g., Alarm).

Definition at line 212 of file Alarm.h.

◆ SetResourceType() [2/2]

void Aws::Lightsail::Model::Alarm::SetResourceType ( ResourceType &&  value)
inline

The Lightsail resource type (e.g., Alarm).

Definition at line 217 of file Alarm.h.

◆ SetState() [1/2]

void Aws::Lightsail::Model::Alarm::SetState ( const AlarmState value)
inline

The current state of the alarm.

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.

Definition at line 712 of file Alarm.h.

◆ SetState() [2/2]

void Aws::Lightsail::Model::Alarm::SetState ( AlarmState &&  value)
inline

The current state of the alarm.

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.

Definition at line 722 of file Alarm.h.

◆ SetStatistic() [1/2]

void Aws::Lightsail::Model::Alarm::SetStatistic ( const MetricStatistic value)
inline

The statistic for the metric associated with the alarm.

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 593 of file Alarm.h.

◆ SetStatistic() [2/2]

void Aws::Lightsail::Model::Alarm::SetStatistic ( MetricStatistic &&  value)
inline

The statistic for the metric associated with the alarm.

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 612 of file Alarm.h.

◆ SetSupportCode() [1/3]

void Aws::Lightsail::Model::Alarm::SetSupportCode ( const Aws::String value)
inline

The support code. Include this code in your email to support when you have questions about your Lightsail alarm. This code enables our support team to look up your Lightsail information more easily.

Definition at line 249 of file Alarm.h.

◆ SetSupportCode() [2/3]

void Aws::Lightsail::Model::Alarm::SetSupportCode ( Aws::String &&  value)
inline

The support code. Include this code in your email to support when you have questions about your Lightsail alarm. This code enables our support team to look up your Lightsail information more easily.

Definition at line 256 of file Alarm.h.

◆ SetSupportCode() [3/3]

void Aws::Lightsail::Model::Alarm::SetSupportCode ( const char *  value)
inline

The support code. Include this code in your email to support when you have questions about your Lightsail alarm. This code enables our support team to look up your Lightsail information more easily.

Definition at line 263 of file Alarm.h.

◆ SetThreshold()

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

The value against which the specified statistic is compared.

Definition at line 420 of file Alarm.h.

◆ SetTreatMissingData() [1/2]

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

Specifies how the alarm handles 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.

Definition at line 493 of file Alarm.h.

◆ SetTreatMissingData() [2/2]

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

Specifies how the alarm handles 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.

Definition at line 507 of file Alarm.h.

◆ SetUnit() [1/2]

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

The unit of the metric associated with the alarm.

Definition at line 758 of file Alarm.h.

◆ SetUnit() [2/2]

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

The unit of the metric associated with the alarm.

Definition at line 763 of file Alarm.h.

◆ StateHasBeenSet()

bool Aws::Lightsail::Model::Alarm::StateHasBeenSet ( ) const
inline

The current state of the alarm.

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.

Definition at line 702 of file Alarm.h.

◆ StatisticHasBeenSet()

bool Aws::Lightsail::Model::Alarm::StatisticHasBeenSet ( ) const
inline

The statistic for the metric associated with the alarm.

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 574 of file Alarm.h.

◆ SupportCodeHasBeenSet()

bool Aws::Lightsail::Model::Alarm::SupportCodeHasBeenSet ( ) const
inline

The support code. Include this code in your email to support when you have questions about your Lightsail alarm. This code enables our support team to look up your Lightsail information more easily.

Definition at line 242 of file Alarm.h.

◆ ThresholdHasBeenSet()

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

The value against which the specified statistic is compared.

Definition at line 415 of file Alarm.h.

◆ TreatMissingDataHasBeenSet()

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

Specifies how the alarm handles 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.

Definition at line 479 of file Alarm.h.

◆ UnitHasBeenSet()

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

The unit of the metric associated with the alarm.

Definition at line 753 of file Alarm.h.

◆ WithArn() [1/3]

Alarm& Aws::Lightsail::Model::Alarm::WithArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the alarm.

Definition at line 124 of file Alarm.h.

◆ WithArn() [2/3]

Alarm& Aws::Lightsail::Model::Alarm::WithArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the alarm.

Definition at line 129 of file Alarm.h.

◆ WithArn() [3/3]

Alarm& Aws::Lightsail::Model::Alarm::WithArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the alarm.

Definition at line 134 of file Alarm.h.

◆ WithComparisonOperator() [1/2]

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

The arithmetic operation used when comparing the specified statistic and threshold.

Definition at line 352 of file Alarm.h.

◆ WithComparisonOperator() [2/2]

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

The arithmetic operation used when comparing the specified statistic and threshold.

Definition at line 358 of file Alarm.h.

◆ WithContactProtocols() [1/2]

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

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

Definition at line 804 of file Alarm.h.

◆ WithContactProtocols() [2/2]

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

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

Definition at line 810 of file Alarm.h.

◆ WithCreatedAt() [1/2]

Alarm& Aws::Lightsail::Model::Alarm::WithCreatedAt ( const Aws::Utils::DateTime value)
inline

The timestamp when the alarm was created.

Definition at line 160 of file Alarm.h.

◆ WithCreatedAt() [2/2]

Alarm& Aws::Lightsail::Model::Alarm::WithCreatedAt ( Aws::Utils::DateTime &&  value)
inline

The timestamp when the alarm was created.

Definition at line 165 of file Alarm.h.

◆ WithDatapointsToAlarm()

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

The number of data points that must not within the specified threshold to trigger the alarm.

Definition at line 450 of file Alarm.h.

◆ WithEvaluationPeriods()

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

The number of periods over which data is compared to the specified threshold.

Definition at line 383 of file Alarm.h.

◆ WithLocation() [1/2]

Alarm& Aws::Lightsail::Model::Alarm::WithLocation ( const ResourceLocation value)
inline

An object that lists information about the location of the alarm.

Definition at line 191 of file Alarm.h.

◆ WithLocation() [2/2]

Alarm& Aws::Lightsail::Model::Alarm::WithLocation ( ResourceLocation &&  value)
inline

An object that lists information about the location of the alarm.

Definition at line 196 of file Alarm.h.

◆ WithMetricName() [1/2]

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

The name of the metric associated with the alarm.

Definition at line 676 of file Alarm.h.

◆ WithMetricName() [2/2]

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

The name of the metric associated with the alarm.

Definition at line 681 of file Alarm.h.

◆ WithMonitoredResourceInfo() [1/2]

Alarm& Aws::Lightsail::Model::Alarm::WithMonitoredResourceInfo ( const MonitoredResourceInfo value)
inline

An object that lists information about the resource monitored by the alarm.

Definition at line 315 of file Alarm.h.

◆ WithMonitoredResourceInfo() [2/2]

Alarm& Aws::Lightsail::Model::Alarm::WithMonitoredResourceInfo ( MonitoredResourceInfo &&  value)
inline

An object that lists information about the resource monitored by the alarm.

Definition at line 321 of file Alarm.h.

◆ WithName() [1/3]

Alarm& Aws::Lightsail::Model::Alarm::WithName ( const Aws::String value)
inline

The name of the alarm.

Definition at line 83 of file Alarm.h.

◆ WithName() [2/3]

Alarm& Aws::Lightsail::Model::Alarm::WithName ( Aws::String &&  value)
inline

The name of the alarm.

Definition at line 88 of file Alarm.h.

◆ WithName() [3/3]

Alarm& Aws::Lightsail::Model::Alarm::WithName ( const char *  value)
inline

The name of the alarm.

Definition at line 93 of file Alarm.h.

◆ WithNotificationEnabled()

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

Indicates whether the alarm is enabled.

Definition at line 884 of file Alarm.h.

◆ WithNotificationTriggers() [1/2]

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

The alarm states that trigger a notification.

Definition at line 848 of file Alarm.h.

◆ WithNotificationTriggers() [2/2]

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

The alarm states that trigger a notification.

Definition at line 853 of file Alarm.h.

◆ WithPeriod()

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

The period, in seconds, over which the statistic is applied.

Definition at line 404 of file Alarm.h.

◆ WithResourceType() [1/2]

Alarm& Aws::Lightsail::Model::Alarm::WithResourceType ( const ResourceType value)
inline

The Lightsail resource type (e.g., Alarm).

Definition at line 222 of file Alarm.h.

◆ WithResourceType() [2/2]

Alarm& Aws::Lightsail::Model::Alarm::WithResourceType ( ResourceType &&  value)
inline

The Lightsail resource type (e.g., Alarm).

Definition at line 227 of file Alarm.h.

◆ WithState() [1/2]

Alarm& Aws::Lightsail::Model::Alarm::WithState ( const AlarmState value)
inline

The current state of the alarm.

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.

Definition at line 732 of file Alarm.h.

◆ WithState() [2/2]

Alarm& Aws::Lightsail::Model::Alarm::WithState ( AlarmState &&  value)
inline

The current state of the alarm.

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.

Definition at line 742 of file Alarm.h.

◆ WithStatistic() [1/2]

Alarm& Aws::Lightsail::Model::Alarm::WithStatistic ( const MetricStatistic value)
inline

The statistic for the metric associated with the alarm.

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 631 of file Alarm.h.

◆ WithStatistic() [2/2]

Alarm& Aws::Lightsail::Model::Alarm::WithStatistic ( MetricStatistic &&  value)
inline

The statistic for the metric associated with the alarm.

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 650 of file Alarm.h.

◆ WithSupportCode() [1/3]

Alarm& Aws::Lightsail::Model::Alarm::WithSupportCode ( const Aws::String value)
inline

The support code. Include this code in your email to support when you have questions about your Lightsail alarm. This code enables our support team to look up your Lightsail information more easily.

Definition at line 270 of file Alarm.h.

◆ WithSupportCode() [2/3]

Alarm& Aws::Lightsail::Model::Alarm::WithSupportCode ( Aws::String &&  value)
inline

The support code. Include this code in your email to support when you have questions about your Lightsail alarm. This code enables our support team to look up your Lightsail information more easily.

Definition at line 277 of file Alarm.h.

◆ WithSupportCode() [3/3]

Alarm& Aws::Lightsail::Model::Alarm::WithSupportCode ( const char *  value)
inline

The support code. Include this code in your email to support when you have questions about your Lightsail alarm. This code enables our support team to look up your Lightsail information more easily.

Definition at line 284 of file Alarm.h.

◆ WithThreshold()

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

The value against which the specified statistic is compared.

Definition at line 425 of file Alarm.h.

◆ WithTreatMissingData() [1/2]

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

Specifies how the alarm handles 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.

Definition at line 521 of file Alarm.h.

◆ WithTreatMissingData() [2/2]

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

Specifies how the alarm handles 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.

Definition at line 535 of file Alarm.h.

◆ WithUnit() [1/2]

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

The unit of the metric associated with the alarm.

Definition at line 768 of file Alarm.h.

◆ WithUnit() [2/2]

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

The unit of the metric associated with the alarm.

Definition at line 773 of file Alarm.h.


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