aws-cdk-lib.aws_cloudwatch.CfnDashboardProps

interface CfnDashboardProps

LanguageType name
.NETAmazon.CDK.AWS.CloudWatch.CfnDashboardProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awscloudwatch#CfnDashboardProps
Javasoftware.amazon.awscdk.services.cloudwatch.CfnDashboardProps
Pythonaws_cdk.aws_cloudwatch.CfnDashboardProps
TypeScript aws-cdk-lib » aws_cloudwatch » CfnDashboardProps

Properties for defining a CfnDashboard.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_cloudwatch as cloudwatch } from 'aws-cdk-lib';
const cfnDashboardProps: cloudwatch.CfnDashboardProps = {
  dashboardBody: 'dashboardBody',

  // the properties below are optional
  dashboardName: 'dashboardName',
};

Properties

NameTypeDescription
dashboardBodystringThe detailed information about the dashboard in JSON format, including the widgets to include and their location on the dashboard.
dashboardName?stringThe name of the dashboard.

dashboardBody

Type: 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 .


dashboardName?

Type: string (optional)

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.