Package software.amazon.awscdk.services.iotsitewise

Class CfnDashboard

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.iotsitewise.CfnDashboard
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:57.906Z") @Stability(Stable) public class CfnDashboard extends CfnResource implements IInspectable
A CloudFormation AWS::IoTSiteWise::Dashboard.

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();

  • 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 Construct scope, @NotNull String id, @NotNull CfnDashboardProps props)
      Create a new AWS::IoTSiteWise::Dashboard.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • 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

    • getTags

      @Stability(Stable) @NotNull public TagManager 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 .

    • getDashboardDefinition

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

      For detailed information, see Creating dashboards (CLI) in the AWS IoT SiteWise User Guide .

    • setDashboardDefinition

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

      For detailed information, see Creating dashboards (CLI) in the AWS IoT SiteWise User Guide .

    • 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.