Menu
AWS CloudFormation
User Guide (API Version 2010-05-15)

AWS::CloudWatch::Dashboard

The AWS::CloudWatch::Dashboard resource creates an Amazon CloudWatch dashboard. A dashboard is a customizable home page in the CloudWatch console that you can use to monitor your AWS resources in a single view. Each metric, graph, alarm, or text block on a dashboard is called a widget.

This resource supports updates. For more information about updating this resource, see PutDashboard in the Amazon CloudWatch API Reference. For more information about updating stacks, see AWS CloudFormation Stacks Updates.

Syntax

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

JSON

Copy
{ "Type" : "AWS::CloudWatch::Dashboard", "Properties" : { "DashboardName" : String, "DashboardBody" : String, } }

YAML

Copy
Type: "AWS::CloudWatch::Dashboard" Properties: DashboardName: String DashboardBody: String

Properties

DashboardName

A name for the dashboard. The name must be between 1 and 255 characters. If you do not specify a name, one will be generated autoamtically.

Required: No

Type: String

Update requires: Replacement

DashboardBody

A JSON string that defines the widgets contained in the dashboard and their location. For information about how to format this string, see Dashboard Body Structure and Syntax.

Required: Yes

Type: String

Update requires: No interruption

Return Values

Ref

When you specify an AWS::CloudWatch::Dashboard resource as an argument to the Ref function, AWS CloudFormation returns the value of the Name.

For more information about using the Ref function, see Ref.

Examples

For examples, see Amazon CloudWatch Template Snippets.