AWS::CloudWatch::Dashboard - Amazon CloudFormation
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).


The AWS::CloudWatch::Dashboard resource specifies an Amazon CloudWatch dashboard. A dashboard is a customizable home page in the CloudWatch console that you can use to monitor your Amazon resources in a single view.

All dashboards in your account are global, not region-specific.


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


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


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



The detailed information about the dashboard in JSON format, including the widgets to include and their location on the dashboard. This parameter is required.

For more information about the syntax, see Dashboard Body Structure and Syntax.

Required: Yes

Type: String

Update requires: No interruption


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

Required: No

Type: String

Update requires: Replacement

Return values


When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the value of DashboardName.

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

See also