CfnDashboardProps

class aws_cdk.aws_iotsitewise.CfnDashboardProps(*, dashboard_definition, dashboard_description, dashboard_name, project_id=None, tags=None)

Bases: object

Properties for defining a CfnDashboard.

Parameters
  • dashboard_definition (str) – The dashboard definition specified in a JSON literal. For detailed information, see Creating dashboards (CLI) in the AWS IoT SiteWise User Guide .

  • dashboard_description (str) – A description for the dashboard.

  • dashboard_name (str) – A friendly name for the dashboard.

  • project_id (Optional[str]) – The ID of the project in which to create the dashboard.

  • tags (Optional[Sequence[CfnTag]]) – 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 .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-dashboard.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_iotsitewise as iotsitewise

cfn_dashboard_props = iotsitewise.CfnDashboardProps(
    dashboard_definition="dashboardDefinition",
    dashboard_description="dashboardDescription",
    dashboard_name="dashboardName",

    # the properties below are optional
    project_id="projectId",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

dashboard_definition

The dashboard definition specified in a JSON literal.

For detailed information, see Creating dashboards (CLI) in the AWS IoT SiteWise User Guide .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-dashboard.html#cfn-iotsitewise-dashboard-dashboarddefinition

Return type

str

dashboard_description

A description for the dashboard.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-dashboard.html#cfn-iotsitewise-dashboard-dashboarddescription

Return type

str

dashboard_name

A friendly name for the dashboard.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-dashboard.html#cfn-iotsitewise-dashboard-dashboardname

Return type

str

project_id

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

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-dashboard.html#cfn-iotsitewise-dashboard-projectid

Return type

Optional[str]

tags

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 .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-dashboard.html#cfn-iotsitewise-dashboard-tags

Return type

Optional[List[CfnTag]]