AWS CloudFormation
User Guide (Version )

AWS::CloudWatch::Alarm Dimension

Dimension is an embedded property of the AWS::CloudWatch::Alarm type. Dimensions are arbitrary name/value pairs that can be associated with a CloudWatch metric. You can specify a maximum of 10 dimensions for a given metric.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{ "Name" : String, "Value" : String }

YAML

Name: String Value: String

Properties

Name

The name of the dimension, from 1–255 characters in length.

Required: Yes

Type: String

Minimum: 1

Maximum: 255

Update requires: No interruption

Value

The value for the dimension, from 1–255 characters in length.

Required: Yes

Type: String

Minimum: 1

Maximum: 255

Update requires: No interruption

Examples

Two CloudWatch alarms with dimension values supplied by the Ref function

The Ref and GetAtt intrinsic functions are often used to supply values for CloudWatch metric dimensions. Here is an example using the Ref function.

JSON

"CPUAlarmHigh": { "Type": "AWS::CloudWatch::Alarm", "Properties": { "AlarmDescription": "Scale-up if CPU is greater than 90% for 10 minutes", "MetricName": "CPUUtilization", "Namespace": "AWS/EC2", "Statistic": "Average", "Period": "300", "EvaluationPeriods": "2", "Threshold": "90", "AlarmActions": [ { "Ref": "WebServerScaleUpPolicy" } ], "Dimensions": [ { "Name": "AutoScalingGroupName", "Value": { "Ref": "WebServerGroup" } } ], "ComparisonOperator": "GreaterThanThreshold" } }, "CPUAlarmLow": { "Type": "AWS::CloudWatch::Alarm", "Properties": { "AlarmDescription": "Scale-down if CPU is less than 70% for 10 minutes", "MetricName": "CPUUtilization", "Namespace": "AWS/EC2", "Statistic": "Average", "Period": "300", "EvaluationPeriods": "2", "Threshold": "70", "AlarmActions": [ { "Ref": "WebServerScaleDownPolicy" } ], "Dimensions": [ { "Name": "AutoScalingGroupName", "Value": { "Ref": "WebServerGroup" } } ], "ComparisonOperator": "LessThanThreshold" } }

On this page: