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, IDashboardRef, IEnvironmentAware, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-13T16:10:00.803Z")
@Stability(Stable)
public class CfnDashboard
extends CfnResource
implements IInspectable, IDashboardRef

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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-dashboard.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnDashboard.Builder	A fluent builder for CfnDashboard.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.interfaces.cloudwatch.IDashboardRef

IDashboardRef.Jsii$Default, IDashboardRef.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnDashboard(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnDashboard(software.amazon.jsii.JsiiObjectRef objRef)
	CfnDashboard(software.constructs.Construct scope, String id, CfnDashboardProps props)	Create a new AWS::CloudWatch::Dashboard.

Method Summary

Modifier and Type	Method	Description
static IDashboardRef	fromDashboardName(software.constructs.Construct scope, String id, String dashboardName)	Creates a new IDashboardRef from a dashboardName.
protected Map<String,Object>	getCfnProperties()
String	getDashboardBody()	The detailed information about the dashboard in JSON format, including the widgets to include and their location on the dashboard.
String	getDashboardName()	The name of the dashboard.
DashboardReference	getDashboardRef()	A reference to a Dashboard resource.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDashboardBody(String value)	The detailed information about the dashboard in JSON format, including the widgets to include and their location on the dashboard.
void	setDashboardName(String value)	The name of the dashboard.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getEnv, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware

getEnv

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

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)

Create a new AWS::CloudWatch::Dashboard.

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

fromDashboardName

@Stability(Stable)
@NotNull
public static IDashboardRef fromDashboardName(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 String dashboardName)

Creates a new IDashboardRef from a dashboardName.

Parameters:

scope - This parameter is required.

id - This parameter is required.

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

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

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.