Package software.amazon.awscdk.services.cloudwatch

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.cloudwatch.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:30:36.822Z") @Stability(Stable) public class CfnDashboard extends CfnResource implements IInspectable
A CloudFormation AWS::CloudWatch::Dashboard.

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

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

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

      This parameter is required.

      For more information about the syntax, see Dashboard Body Structure and Syntax .

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

      This parameter is required.

      For more information about the syntax, see Dashboard Body Structure and Syntax .

    • getDashboardName

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

      The name must be between 1 and 255 characters. If you do not specify a name, one will be generated automatically.

    • setDashboardName

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

      The name must be between 1 and 255 characters. If you do not specify a name, one will be generated automatically.