Package software.amazon.awscdk.services.cloudwatch

Class Dashboard

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.cloudwatch.Dashboard

All Implemented Interfaces:

IEnvironmentAware, IResource, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-20T23:37:16.626Z")
@Stability(Stable)
public class Dashboard
extends Resource

A CloudWatch dashboard.

Example:

 import software.amazon.awscdk.services.cloudwatch.*;
 Dashboard dashboard = Dashboard.Builder.create(this, "Dash")
         .defaultInterval(Duration.days(7))
         .variables(List.of(DashboardVariable.Builder.create()
                 .id("region2")
                 .type(VariableType.PATTERN)
                 .label("RegionPattern")
                 .inputType(VariableInputType.INPUT)
                 .value("us-east-1")
                 .defaultValue(DefaultValue.value("us-east-1"))
                 .visible(true)
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

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

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

IResource.Jsii$Default

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROPERTY_INJECTION_ID	Uniquely identifies this class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Dashboard(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	Dashboard(software.amazon.jsii.JsiiObjectRef objRef)
	Dashboard(software.constructs.Construct scope, String id)
	Dashboard(software.constructs.Construct scope, String id, DashboardProps props)

Method Summary

Modifier and Type	Method	Description
void	addVariable(IVariable variable)	Add a variable to the dashboard.
void	addWidgets(IWidget... widgets)	Add a widget to the dashboard.
String	getDashboardArn()	ARN of this dashboard.
String	getDashboardName()	The name of this dashboard.

Methods inherited from class software.amazon.awscdk.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

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.jsii.JsiiSerializable

$jsii$toJson

Field Details

PROPERTY_INJECTION_ID

@Stability(Stable)
public static final String PROPERTY_INJECTION_ID

Uniquely identifies this class.

Constructor Details

Dashboard

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

Dashboard

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

Dashboard

@Stability(Stable)
public Dashboard(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @Nullable
 DashboardProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props -

Dashboard

@Stability(Stable)
public Dashboard(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Method Details

addVariable

@Stability(Stable)
public void addVariable(@NotNull
 IVariable variable)

Add a variable to the dashboard.

Parameters:

variable - This parameter is required.

See Also:

• https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_dashboard_variables.html

addWidgets

@Stability(Stable)
public void addWidgets(@NotNull
 IWidget... widgets)

Add a widget to the dashboard.

Widgets given in multiple calls to add() will be laid out stacked on top of each other.

Multiple widgets added in the same call to add() will be laid out next to each other.

Parameters:

widgets - This parameter is required.

getDashboardArn

@Stability(Stable)
@NotNull
public String getDashboardArn()

ARN of this dashboard.

getDashboardName

@Stability(Stable)
@NotNull
public String getDashboardName()

The name of this dashboard.