| « PreviousNext » | |
   | Did this page help you? Yes | No | Tell us about it... |
AWS::CloudWatch::Alarm
The AWS::CloudWatch::Alarm type creates an Amazon CloudWatch alarm.
This type supports updates. For more information about updating this resource, see PutMetricAlarm. For more information about updating stacks, see Updating AWS CloudFormation Stacks.
When you specify an AWS::CloudWatch::Alarm type as an argument to the Ref function, AWS CloudFormation
returns the value of the AlarmName.
Properties
| Property | Type | Required | Notes |
|---|---|---|---|
|
ActionsEnabled |
String |
No |
Indicates whether or not actions should be executed during any changes to the
alarm's state. Either |
|
AlarmActions |
List of String |
No |
The list of actions to execute when this alarm transitions into an ALARM state from any other state. Each action is specified as an Amazon Resource Number (ARN). Currently the only action supported is publishing to an Amazon SNS topic or an Amazon Auto Scaling policy. |
|
AlarmDescription |
String |
No |
The description for the alarm. |
|
ComparisonOperator |
String |
Yes |
The arithmetic operation to use when comparing the specified Statistic and Threshold. The specified Statistic value is used as the first operand. Valid Values: |
|
Dimensions |
List of Metric Dimension type |
No |
The dimensions for the alarm's associated metric. |
|
EvaluationPeriods |
String |
Yes |
The number of periods over which data is compared to the specified threshold. |
|
InsufficientDataActions |
List of String |
No |
The list of actions to execute when this alarm transitions into an INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Number (ARN). Currently the only action supported is publishing to an Amazon SNS topic or an Amazon Auto Scaling policy. |
|
MetricName |
String |
Yes |
The name for the alarm's associated metric. |
|
Namespace |
String |
Yes |
The namespace for the alarm's associated metric. |
|
OKActions |
List of String |
No |
The list of actions to execute when this alarm transitions into an OK state from any other state. Each action is specified as an Amazon Resource Number (ARN). Currently the only action supported is publishing to an Amazon SNS topic or an Amazon Auto Scaling policy. |
|
Period |
String |
Yes |
The period in seconds over which the specified statistic is applied. |
|
Statistic |
String |
Yes |
The statistic to apply to the alarm's associated metric. Valid Values: |
|
Threshold |
String |
Yes |
The value against which the specified statistic is compared. |
|
Unit |
String |
No |
The unit for the alarm's associated metric. Valid Values: Seconds | Microseconds | Milliseconds | Bytes | Kilobytes | Megabytes | Gigabytes | Terabytes | Bits | Kilobits | Megabits | Gigabits | Terabits | Percent | Count | Bytes/Second | Kilobytes/Second | Megabytes/Second | Gigabytes/Second | Terabytes/Second | Bits/Second | Kilobits/Second | Megabits/Second | Gigabits/Second | Terabits/Second | Count/Second | None |
Return Values
| Function | Type | Description |
|---|---|---|
|
Name |
mystack-myalarm-3AOHFRGOXR5T |
