aws-cdk-lib.aws_iotsitewise.CfnDashboardProps

interface CfnDashboardProps

LanguageType name
.NETAmazon.CDK.AWS.IoTSiteWise.CfnDashboardProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsiotsitewise#CfnDashboardProps
Javasoftware.amazon.awscdk.services.iotsitewise.CfnDashboardProps
Pythonaws_cdk.aws_iotsitewise.CfnDashboardProps
TypeScript 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

NameTypeDescription
dashboardDefinitionstringThe dashboard definition specified in a JSON literal.
dashboardDescriptionstringA description for the dashboard.
dashboardNamestringA friendly name for the dashboard.
projectId?stringThe ID of the project in which to create the dashboard.
tags?CfnTag[]A list of key-value pairs that contain metadata for the dashboard.

dashboardDefinition

Type: string

The dashboard definition specified in a JSON literal.

For detailed information, see Creating dashboards (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: CfnTag[] (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 .