AWS::IoTSiteWise::Dashboard - Amazon CloudFormation
SyntaxPropertiesReturn values
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AWS::IoTSiteWise::Dashboard

Creates a dashboard in an Amazon IoT SiteWise Monitor project.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::IoTSiteWise::Dashboard",
  "Properties" : {
      "DashboardDefinition" : String,
      "DashboardDescription" : String,
      "DashboardName" : String,
      "ProjectId" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::IoTSiteWise::Dashboard
Properties:
  DashboardDefinition: String
  DashboardDescription: String
  DashboardName: String
  ProjectId: String
  Tags: 
    - Tag

Properties

DashboardDefinition

The dashboard definition specified in a JSON literal. For detailed information, see Creating dashboards (CLI) in the Amazon IoT SiteWise User Guide.

Required: Yes

Type: String

Update requires: No interruption

DashboardDescription

A description for the dashboard.

Required: Yes

Type: String

Update requires: No interruption

DashboardName

A friendly name for the dashboard.

Required: Yes

Type: String

Update requires: No interruption

ProjectId

The ID of the project in which to create the dashboard.

Required: No

Type: String

Update requires: Replacement

Tags

A list of key-value pairs that contain metadata for the dashboard. For more information, see Tagging your Amazon IoT SiteWise resources in the Amazon IoT SiteWise User Guide.

Required: No

Type: Array of Tag

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the DashboardId.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

DashboardArn

The ARN of the dashboard, which has the following format.

arn:${Partition}:iotsitewise:${Region}:${Account}:dashboard/${DashboardId}

For more information about using the Ref function, see Ref.

DashboardId

The ID of the dashboard.

For more information about using the Ref function, see Ref.