interface CfnDashboardProps
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.IoTSiteWise.CfnDashboardProps |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsiotsitewise#CfnDashboardProps |
![]() | software.amazon.awscdk.services.iotsitewise.CfnDashboardProps |
![]() | aws_cdk.aws_iotsitewise.CfnDashboardProps |
![]() | aws-cdk-lib » aws_iotsitewise » 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_iotsitewise as iotsitewise } from 'aws-cdk-lib';
const cfnDashboardProps: iotsitewise.CfnDashboardProps = {
dashboardDefinition: 'dashboardDefinition',
dashboardDescription: 'dashboardDescription',
dashboardName: 'dashboardName',
// the properties below are optional
projectId: 'projectId',
tags: [{
key: 'key',
value: 'value',
}],
};
Properties
Name | Type | Description |
---|---|---|
dashboard | string | The dashboard definition specified in a JSON literal. |
dashboard | string | A description for the dashboard. |
dashboard | string | A friendly name for the dashboard. |
project | string | The ID of the project in which to create the dashboard. |
tags? | Cfn [] | A list of key-value pairs that contain metadata for the dashboard. |
dashboardDefinition
Type:
string
The dashboard definition specified in a JSON literal.
- AWS IoT SiteWise Monitor (Classic) see Create dashboards ( AWS CLI )
- AWS IoT SiteWise Monitor (AI-aware) see Create dashboards ( AWS CLI )
in the AWS IoT SiteWise User Guide
dashboardDescription
Type:
string
A description for the dashboard.
dashboardName
Type:
string
A friendly name for the dashboard.
projectId?
Type:
string
(optional)
The ID of the project in which to create the dashboard.
tags?
Type:
Cfn
[]
(optional)
A list of key-value pairs that contain metadata for the dashboard.
For more information, see Tagging your AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide .