Class CfnDashboard.Builder
java.lang.Object
software.amazon.awscdk.services.iotsitewise.CfnDashboard.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnDashboard>
- Enclosing class:
- CfnDashboard
@Stability(Stable)
public static final class CfnDashboard.Builder
extends Object
implements software.amazon.jsii.Builder<CfnDashboard>
A fluent builder for
CfnDashboard
.-
Method Summary
Modifier and TypeMethodDescriptionbuild()
static CfnDashboard.Builder
dashboardDefinition
(String dashboardDefinition) The dashboard definition specified in a JSON literal.dashboardDescription
(String dashboardDescription) A description for the dashboard.dashboardName
(String dashboardName) A friendly name for the dashboard.The ID of the project in which to create the dashboard.A list of key-value pairs that contain metadata for the dashboard.
-
Method Details
-
create
- Parameters:
scope
-- scope in which this resource is defined.
id
-- scoped id of the resource.
- Returns:
- a new instance of
CfnDashboard.Builder
.
-
dashboardDefinition
The dashboard definition specified in a JSON literal.For detailed information, see Creating dashboards (CLI) in the AWS IoT SiteWise User Guide .
- Parameters:
dashboardDefinition
- The dashboard definition specified in a JSON literal. This parameter is required.- Returns:
this
-
dashboardDescription
A description for the dashboard.- Parameters:
dashboardDescription
- A description for the dashboard. This parameter is required.- Returns:
this
-
dashboardName
A friendly name for the dashboard.- Parameters:
dashboardName
- A friendly name for the dashboard. This parameter is required.- Returns:
this
-
projectId
The ID of the project in which to create the dashboard.- Parameters:
projectId
- The ID of the project in which to create the dashboard. This parameter is required.- Returns:
this
-
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 .
- Parameters:
tags
- A list of key-value pairs that contain metadata for the dashboard. This parameter is required.- Returns:
this
-
build
- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnDashboard>
- Returns:
- a newly built instance of
CfnDashboard
.
-