Package software.amazon.awscdk.services.iotsitewise

Class CfnDashboard

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.iotsitewise.CfnDashboard
All Implemented Interfaces:
IEnvironmentAware, IInspectable, ITaggable, IDashboardRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)", date="2025-11-10T13:40:07.954Z") @Stability(Stable) public class CfnDashboard extends CfnResource implements IInspectable, IDashboardRef, ITaggable

The AWS IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025 .

If you would like to use the AWS IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see AWS IoT SiteWise Monitor availability change .

Creates a dashboard in an AWS IoT SiteWise Monitor project.

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.*;
 CfnDashboard cfnDashboard = CfnDashboard.Builder.create(this, "MyCfnDashboard")
         .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:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnDashboard

      protected CfnDashboard(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnDashboard

      protected CfnDashboard(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnDashboard

      @Stability(Stable) public CfnDashboard(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnDashboardProps props)
      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.
      props - Resource properties. This parameter is required.

  • Method Details

    • fromDashboardArn

      @Stability(Stable) @NotNull public static IDashboardRef fromDashboardArn(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String arn)
      Creates a new IDashboardRef from an ARN.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      arn - This parameter is required.

    • fromDashboardId

      @Stability(Stable) @NotNull public static IDashboardRef fromDashboardId(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String dashboardId)
      Creates a new IDashboardRef from a dashboardId.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      dashboardId - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrDashboardArn

      @Stability(Stable) @NotNull public String getAttrDashboardArn()
      The ARN of the dashboard, which has the following format.

      arn:${Partition}:iotsitewise:${Region}:${Account}:dashboard/${DashboardId}

    • getAttrDashboardId

      @Stability(Stable) @NotNull public String getAttrDashboardId()
      The ID of the dashboard.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getDashboardRef

      @Stability(Stable) @NotNull public DashboardReference getDashboardRef()
      A reference to a Dashboard resource.
      Specified by:
      getDashboardRef in interface IDashboardRef

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getDashboardDefinition

      @Stability(Stable) @NotNull public String getDashboardDefinition()
      The dashboard definition specified in a JSON literal.

    • setDashboardDefinition

      @Stability(Stable) public void setDashboardDefinition(@NotNull String value)
      The dashboard definition specified in a JSON literal.

    • getDashboardDescription

      @Stability(Stable) @NotNull public String getDashboardDescription()
      A description for the dashboard.

    • setDashboardDescription

      @Stability(Stable) public void setDashboardDescription(@NotNull String value)
      A description for the dashboard.

    • getDashboardName

      @Stability(Stable) @NotNull public String getDashboardName()
      A friendly name for the dashboard.

    • setDashboardName

      @Stability(Stable) public void setDashboardName(@NotNull String value)
      A friendly name for the dashboard.

    • getProjectId

      @Stability(Stable) @Nullable public String getProjectId()
      The ID of the project in which to create the dashboard.

    • setProjectId

      @Stability(Stable) public void setProjectId(@Nullable String value)
      The ID of the project in which to create the dashboard.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      A list of key-value pairs that contain metadata for the dashboard.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      A list of key-value pairs that contain metadata for the dashboard.