AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::CloudWatch::Dashboard

CfnDashboard

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 AWS resources in a single view. All dashboards in your account are global, not region-specific.

Import

import { CfnDashboard } from 'aws-cdk-lib/aws-cloudwatch';

Or use the module namespace:

import * as cloudwatch from 'aws-cdk-lib/aws-cloudwatch';
// cloudwatch.CfnDashboard

Properties

Configuration passed to the constructor as CfnDashboardProps.

dashboardBodyRequired
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](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/CloudWatch-Dashboard-Body-Structure.html) .

dashboardNameOptional
string

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.

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

AWS::CloudWatch::DashboardView in CloudFormation Explorer

Get the Amazon CloudWatch Cheat Sheet

Everything you need to know about Amazon CloudWatch on one page. HD quality, print-friendly.

Download Free Infographic

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-cloudwatch
CFN TypeAWS::CloudWatch::Dashboard
Properties2

Related Constructs

Explore This Service

External Links