AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Add-LSAlarm-AlarmName <String>-ComparisonOperator <ComparisonOperator>-ContactProtocol <String[]>-DatapointsToAlarm <Int32>-EvaluationPeriod <Int32>-MetricName <MetricName>-MonitoredResourceName <String>-NotificationEnabled <Boolean>-NotificationTrigger <String[]>-Threshold <Double>-TreatMissingData <TreatMissingData>-Select <String>-PassThru <SwitchParameter>-Force <SwitchParameter>-ClientConfig <AmazonLightsailConfig>
INSUFFICIENT_DATA
. The alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then executed.
When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm. The alarm is then evaluated with the updated configuration. Required? | True |
Position? | 1 |
Accept pipeline input? | True (ByValue, ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | True |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
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 Amazon Web Services 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 Amazon Web Services Region. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | ContactProtocols |
datapointsToAlarm
) is the M. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
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). Required? | True |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | EvaluationPeriods |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
BurstCapacityPercentage
, BurstCapacityTime
, CPUUtilization
, NetworkIn
, NetworkOut
, StatusCheckFailed
, StatusCheckFailed_Instance
, and StatusCheckFailed_System
.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
.CPUUtilization
, DatabaseConnections
, DiskQueueDepth
, FreeStorageSpace
, NetworkReceiveThroughput
, and NetworkTransmitThroughput
.Required? | True |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | True |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
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.ALARM
state must be specified. The INSUFFICIENT_DATA
and OK
states can be specified in addition to the ALARM
state.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.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.ALARM
if you don't specify this parameter. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | NotificationTriggers |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | True |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
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.treatMissingData
is not specified, the default behavior of missing
is used. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | AK |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByValue, ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByValue, ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | AWSProfilesLocation, ProfilesLocation |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | StoredCredentials, AWSProfileName |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | RegionToCall |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | SK, SecretAccessKey |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | ST |
AWS Tools for PowerShell: 2.x.y.z