interface CfnDashboardProps
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.CloudWatch.CfnDashboardProps |
 Go | github.com/aws/aws-cdk-go/awscdk/v2/awscloudwatch#CfnDashboardProps |
 Java | software.amazon.awscdk.services.cloudwatch.CfnDashboardProps |
 Python | aws_cdk.aws_cloudwatch.CfnDashboardProps |
 TypeScript | aws-cdk-lib » aws_cloudwatch » CfnDashboardProps |
Properties for defining a CfnDashboard.
See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-dashboard.html
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
| Name | Type | Description |
|---|---|---|
| dashboard | string | The detailed information about the dashboard in JSON format, including the widgets to include and their location on the dashboard. |
| dashboard | string | The 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.