Package software.amazon.awscdk.services.iotsitewise

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 Type	Method	Description
CfnDashboard	build()
static CfnDashboard.Builder	create(software.constructs.Construct scope, String id)
CfnDashboard.Builder	dashboardDefinition(String dashboardDefinition)	The dashboard definition specified in a JSON literal.
CfnDashboard.Builder	dashboardDescription(String dashboardDescription)	A description for the dashboard.
CfnDashboard.Builder	dashboardName(String dashboardName)	A friendly name for the dashboard.
CfnDashboard.Builder	projectId(String projectId)	The ID of the project in which to create the dashboard.
CfnDashboard.Builder	tags(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 Details

create

@Stability(Stable)
public static CfnDashboard.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

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

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnDashboard.Builder.

dashboardDefinition

@Stability(Stable)
public CfnDashboard.Builder dashboardDefinition(String dashboardDefinition)

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

Parameters:

dashboardDefinition - The dashboard definition specified in a JSON literal. This parameter is required.

Returns:

this

See Also:

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

dashboardDescription

@Stability(Stable)
public CfnDashboard.Builder dashboardDescription(String dashboardDescription)

A description for the dashboard.

Parameters:

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

Returns:

this

See Also:

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

dashboardName

@Stability(Stable)
public CfnDashboard.Builder dashboardName(String dashboardName)

A friendly name for the dashboard.

Parameters:

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

Returns:

this

See Also:

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

projectId

@Stability(Stable)
public CfnDashboard.Builder projectId(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

See Also:

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

tags

@Stability(Stable)
public CfnDashboard.Builder tags(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

See Also:

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

build

@Stability(Stable)
public CfnDashboard build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnDashboard>

Returns:

a newly built instance of CfnDashboard.