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:

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

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

Properties

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.

On this page:

• Syntax
• Properties
• Return Values
• Examples