Interface CfnDashboardProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnDashboardProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.102.0 (build e354887)",
date="2024-08-23T05:56:18.288Z")
@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:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnDashboardProps
static final class
An implementation forCfnDashboardProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic CfnDashboardProps.Builder
builder()
The dashboard definition specified in a JSON literal.A description for the dashboard.A friendly name for the dashboard.default String
The ID of the project in which to create the dashboard.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
The dashboard definition specified in a JSON literal.For detailed information, see Creating dashboards (CLI) in the AWS IoT SiteWise User Guide .
- See Also:
-
getDashboardDescription
A description for the dashboard.- See Also:
-
getDashboardName
A friendly name for the dashboard.- See Also:
-
getProjectId
The ID of the project in which to create the dashboard.- See Also:
-
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:
-
builder
- Returns:
- a
CfnDashboardProps.Builder
ofCfnDashboardProps
-