Package software.amazon.awscdk.services.cloudwatch

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.cloudwatch.CfnDashboard
All Implemented Interfaces:
IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.110.0 (build 336b265)", date="2025-04-22T23:08:08.849Z") @Stability(Stable) public class CfnDashboard extends CfnResource implements IInspectable
The AWS::CloudWatch::Dashboard resource specifies an Amazon CloudWatch dashboard.

A dashboard is a customizable home page in the CloudWatch console that you can use to monitor your AWS resources in a single view.

All dashboards in your account are global, not region-specific.

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.cloudwatch.*;
 CfnDashboard cfnDashboard = CfnDashboard.Builder.create(this, "MyCfnDashboard")
         .dashboardBody("dashboardBody")
         // the properties below are optional
         .dashboardName("dashboardName")
         .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

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

    • getCfnProperties

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

    • getDashboardBody

      @Stability(Stable) @NotNull public String getDashboardBody()
      The detailed information about the dashboard in JSON format, including the widgets to include and their location on the dashboard.

    • setDashboardBody

      @Stability(Stable) public void setDashboardBody(@NotNull String value)
      The detailed information about the dashboard in JSON format, including the widgets to include and their location on the dashboard.

    • getDashboardName

      @Stability(Stable) @Nullable public String getDashboardName()
      The name of the dashboard.

    • setDashboardName

      @Stability(Stable) public void setDashboardName(@Nullable String value)
      The name of the dashboard.