software.amazon.awscdk.services.iotsitewise

Class CfnDashboard.Builder

java.lang.Object

software.amazon.awscdk.services.iotsitewise.CfnDashboard.Builder

Enclosing class:

CfnDashboard

public static final class CfnDashboard.Builder
extends java.lang.Object

A fluent builder for CfnDashboard.

Method Summary

Modifier and Type	Method and Description
CfnDashboard	build()
static CfnDashboard.Builder	create(Construct scope, java.lang.String id)
CfnDashboard.Builder	dashboardDefinition(java.lang.String dashboardDefinition) The dashboard definition specified in a JSON literal.
CfnDashboard.Builder	dashboardDescription(java.lang.String dashboardDescription) A description for the dashboard.
CfnDashboard.Builder	dashboardName(java.lang.String dashboardName) A friendly name for the dashboard.
CfnDashboard.Builder	projectId(java.lang.String projectId) The ID of the project in which to create the dashboard.
CfnDashboard.Builder	tags(java.util.List<? extends CfnTag> tags) A list of key-value pairs that contain metadata for the dashboard.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static CfnDashboard.Builder create(Construct scope,
                                          java.lang.String id)

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

Returns:

a new instance of CfnDashboard.Builder.

dashboardDefinition

public CfnDashboard.Builder dashboardDefinition(java.lang.String 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

public CfnDashboard.Builder dashboardDescription(java.lang.String dashboardDescription)

A description for the dashboard.

Parameters:

dashboardDescription - A description for the dashboard. This parameter is required.

Returns:

this

dashboardName

public CfnDashboard.Builder dashboardName(java.lang.String dashboardName)

A friendly name for the dashboard.

Parameters:

dashboardName - A friendly name for the dashboard. This parameter is required.

Returns:

this

projectId

public CfnDashboard.Builder projectId(java.lang.String 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

public CfnDashboard.Builder tags(java.util.List<? extends CfnTag> 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

public CfnDashboard build()