/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::Lightsail::Alarm

NAME

Paws::Lightsail::Alarm

USAGE

This class represents one of two things:

Arguments in a call to a service

Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. Each attribute should be used as a named argument in the calls that expect this type of object.

As an example, if Att1 is expected to be a Paws::Lightsail::Alarm object:

$service_obj->Method(Att1 => { Arn => $value, ..., Unit => $value  });

Results returned from an API call

Use accessors for each attribute. If Att1 is expected to be an Paws::Lightsail::Alarm object:

$result = $service_obj->Method(...);
$result->Att1->Arn

DESCRIPTION

Describes an alarm.

An alarm is a way to monitor your Amazon Lightsail resource metrics. For more information, see Alarms in Amazon Lightsail (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-alarms).

ATTRIBUTES

Arn => Str

The Amazon Resource Name (ARN) of the alarm.

ComparisonOperator => Str

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

ContactProtocols => ArrayRef[Str|Undef]

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

CreatedAt => Str

The timestamp when the alarm was created.

DatapointsToAlarm => Int

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

EvaluationPeriods => Int

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

Location => Paws::Lightsail::ResourceLocation

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

MetricName => Str

The name of the metric associated with the alarm.

MonitoredResourceInfo => Paws::Lightsail::MonitoredResourceInfo

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

Name => Str

The name of the alarm.

NotificationEnabled => Bool

Indicates whether the alarm is enabled.

NotificationTriggers => ArrayRef[Str|Undef]

The alarm states that trigger a notification.

Period => Int

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

ResourceType => Str

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

State => Str

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.

Statistic => Str

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.

SupportCode => Str

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.

Threshold => Num

The value against which the specified statistic is compared.

TreatMissingData => Str

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.

Unit => Str

The unit of the metric associated with the alarm.

SEE ALSO

This class forms part of Paws, describing an object used in Paws::Lightsail

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues