Package software.amazon.awscdk.services.iotsitewise

Interface CfnDashboardProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDashboardProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.109.0 (build c221850)",
           date="2025-03-14T03:24:59.948Z")
@Stability(Stable)
public interface CfnDashboardProps
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.iotsitewise.*;
 CfnDashboardProps cfnDashboardProps = CfnDashboardProps.builder()
         .dashboardDefinition("dashboardDefinition")
         .dashboardDescription("dashboardDescription")
         .dashboardName("dashboardName")
         // the properties below are optional
         .projectId("projectId")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDashboardProps.Builder	A builder for CfnDashboardProps
static final class	CfnDashboardProps.Jsii$Proxy	An implementation for CfnDashboardProps

Method Summary

Modifier and Type	Method	Description
static CfnDashboardProps.Builder	builder()
String	getDashboardDefinition()	The dashboard definition specified in a JSON literal.
String	getDashboardDescription()	A description for the dashboard.
String	getDashboardName()	A friendly name for the dashboard.
default String	getProjectId()	The ID of the project in which to create the dashboard.
default List<CfnTag>	getTags()	A list of key-value pairs that contain metadata for the dashboard.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDashboardDefinition

@Stability(Stable)
@NotNull
String getDashboardDefinition()

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

See Also:

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

getDashboardDescription

@Stability(Stable)
@NotNull
String getDashboardDescription()

A description for the dashboard.

See Also:

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

getDashboardName

@Stability(Stable)
@NotNull
String getDashboardName()

A friendly name for the dashboard.

See Also:

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

getProjectId

@Stability(Stable)
@Nullable
default String getProjectId()

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

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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 .

See Also:

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

builder

@Stability(Stable)
static CfnDashboardProps.Builder builder()

Returns:

a CfnDashboardProps.Builder of CfnDashboardProps