dashboards

Creates, updates, deletes or gets a dashboard resource or lists dashboards in a region

Overview

Name	dashboards
Type	Resource
Description	Resource schema for AWS::IoTSiteWise::Dashboard
Id	aws.iotsitewise.dashboards

Fields

Name	Datatype	Description
project_id	string	The ID of the project in which to create the dashboard.
dashboard_id	string	The ID of the dashboard.
dashboard_name	string	A friendly name for the dashboard.
dashboard_description	string	A description for the dashboard.
dashboard_definition	string	The dashboard definition specified in a JSON literal.
dashboard_arn	string	The ARN of the dashboard.
tags	array	A list of key-value pairs that contain metadata for the dashboard.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	DashboardDefinition, DashboardDescription, DashboardName, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all dashboards in a region.

SELECT
region,
project_id,
dashboard_id,
dashboard_name,
dashboard_description,
dashboard_definition,
dashboard_arn,
tags
FROM aws.iotsitewise.dashboards
WHERE region = 'us-east-1';

Gets all properties from an individual dashboard.

SELECT
region,
project_id,
dashboard_id,
dashboard_name,
dashboard_description,
dashboard_definition,
dashboard_arn,
tags
FROM aws.iotsitewise.dashboards
WHERE region = 'us-east-1' AND data__Identifier = '<DashboardId>';

INSERT example

Use the following StackQL query and manifest file to create a new dashboard resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.iotsitewise.dashboards (
 DashboardName,
 DashboardDescription,
 DashboardDefinition,
 region
)
SELECT 
'{{ DashboardName }}',
 '{{ DashboardDescription }}',
 '{{ DashboardDefinition }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.iotsitewise.dashboards (
 ProjectId,
 DashboardName,
 DashboardDescription,
 DashboardDefinition,
 Tags,
 region
)
SELECT 
 '{{ ProjectId }}',
 '{{ DashboardName }}',
 '{{ DashboardDescription }}',
 '{{ DashboardDefinition }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: dashboard
    props:
      - name: ProjectId
        value: '{{ ProjectId }}'
      - name: DashboardName
        value: '{{ DashboardName }}'
      - name: DashboardDescription
        value: '{{ DashboardDescription }}'
      - name: DashboardDefinition
        value: '{{ DashboardDefinition }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.iotsitewise.dashboards
WHERE data__Identifier = '<DashboardId>'
AND region = 'us-east-1';

Permissions

To operate on the dashboards resource, the following permissions are required:

Create

iotsitewise:CreateDashboard,
iotsitewise:DescribeDashboard,
iotsitewise:ListTagsForResource,
iotsitewise:TagResource,
iotsitewise:DescribeAsset,
iotsitewise:DescribeAssetModel,
iotsitewise:ListAssetModelProperties,
iotsitewise:ListAssetModelCompositeModels

Read

iotsitewise:DescribeDashboard,
iotsitewise:ListTagsForResource

Update

iotsitewise:DescribeDashboard,
iotsitewise:UpdateDashboard,
iotsitewise:TagResource,
iotsitewise:UntagResource,
iotsitewise:ListTagsForResource,
iotsitewise:DescribeAsset,
iotsitewise:DescribeAssetModel,
iotsitewise:ListAssetModelProperties,
iotsitewise:ListAssetModelCompositeModels

Delete

iotsitewise:DescribeDashboard,
iotsitewise:DeleteDashboard

List

iotsitewise:ListDashboards