AWS CloudFormation
User Guide (API Version 2010-05-15)
« PreviousNext »
View the PDF for this guide.Go to the AWS Discussion Forum for this product.Go to the Kindle Store to download this guide in Kindle format.Did this page help you?  Yes | No |  Tell us about it...

AWS::CloudWatch::Alarm

The AWS::CloudWatch::Alarm type creates an CloudWatch alarm.

This type supports updates. For more information about updating this resource, see PutMetricAlarm. For more information about updating stacks, see AWS CloudFormation Stacks Updates.

When you specify an AWS::CloudWatch::Alarm type as an argument to the Ref function, AWS CloudFormation returns the value of the AlarmName.

Properties

PropertyTypeRequiredNotes

ActionsEnabled

String

No

Indicates whether or not actions should be executed during any changes to the alarm's state. Either true or false.

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.

AlarmName

String

No

A name for the alarm. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the alarm name. For more information, see Name Type.

Important

If you specify a name, you cannot do updates that require this resource to be replaced. You can still do updates to this resource if the update requires no or some interruption.

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: GreaterThanOrEqualToThreshold | GreaterThanThreshold | LessThanThreshold | LessThanOrEqualToThreshold

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. For more information about the metrics that you can specify, see Amazon CloudWatch Namespaces, Dimensions, and Metrics Reference in the Amazon CloudWatch Developer Guide.

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: SampleCount | Average | Sum | Minimum | Maximum

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

FunctionTypeDescription

Ref

Name

mystack-myalarm-3AOHFRGOXR5T