Alarm class

Describes an alarm.

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

Constructors

Alarm({String? arn, ComparisonOperator? comparisonOperator, List<ContactProtocol>? contactProtocols, DateTime? createdAt, int? datapointsToAlarm, int? evaluationPeriods, ResourceLocation? location, MetricName? metricName, MonitoredResourceInfo? monitoredResourceInfo, String? name, bool? notificationEnabled, List<AlarmState>? notificationTriggers, int? period, ResourceType? resourceType, AlarmState? state, MetricStatistic? statistic, String? supportCode, double? threshold, TreatMissingData? treatMissingData, MetricUnit? unit})
Alarm.fromJson(Map<String, dynamic> json)
factory

Properties

arn → String?
The Amazon Resource Name (ARN) of the alarm.
final
comparisonOperator → ComparisonOperator?
The arithmetic operation used when comparing the specified statistic and threshold.
final
contactProtocols → List<ContactProtocol>?
The contact protocols for the alarm, such as Email, SMS (text messaging), or both.
final
createdAt → DateTime?
The timestamp when the alarm was created.
final
datapointsToAlarm → int?
The number of data points that must not within the specified threshold to trigger the alarm.
final
evaluationPeriods → int?
The number of periods over which data is compared to the specified threshold.
final
hashCode → int
The hash code for this object.
no setterinherited
location → ResourceLocation?
An object that lists information about the location of the alarm.
final
metricName → MetricName?
The name of the metric associated with the alarm.
final
monitoredResourceInfo → MonitoredResourceInfo?
An object that lists information about the resource monitored by the alarm.
final
name → String?
The name of the alarm.
final
notificationEnabled → bool?
Indicates whether the alarm is enabled.
final
notificationTriggers → List<AlarmState>?
The alarm states that trigger a notification.
final
period → int?
The period, in seconds, over which the statistic is applied.
final
resourceType → ResourceType?
The Lightsail resource type (e.g., Alarm).
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
state → AlarmState?
The current state of the alarm.
final
statistic → MetricStatistic?
The statistic for the metric associated with the alarm.
final
supportCode → String?
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.
final
threshold → double?
The value against which the specified statistic is compared.
final
treatMissingData → TreatMissingData?
Specifies how the alarm handles missing data points.
final
unit → MetricUnit?
The unit of the metric associated with the alarm.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited