AWS CDK Reference

Appearance

v2.274.0

AlarmWidgetProps Struct ​

Properties for an AlarmWidget.

Source
aws-cloudwatch/lib/graph.ts
Type last changed
v2.234.0 · 8 Jan 2026

Example ​

ts
declare const dashboard: cloudwatch.Dashboard;
declare const errorAlarm: cloudwatch.Alarm;

dashboard.addWidgets(new cloudwatch.AlarmWidget({
  title: "Errors",
  alarm: errorAlarm,
}));

Properties ​

accountIdoptionalstringaccount_idoptionalstraccountIdoptionalStringAccountIdoptionalstringAccountIdoptional*string#
The AWS account ID where the metrics are located.

Default: Current account

notes

This enables cross-account functionality for CloudWatch dashboards. Before using this feature, ensure that proper cross-account sharing is configured between the monitoring account and source account.

For more information, see: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html

alarmIAlarmRefalarmIAlarmRefalarmIAlarmRefAlarmIAlarmRefAlarmIAlarmRefrequired#
The alarm to show.
heightoptionalnumberheightoptionalint | floatheightoptionalNumberHeightoptionaldoubleHeightoptional*float64#
Height of the widget.

Default: 6 for Alarm and Graph widgets. 3 for single value widgets where most recent value of a metric is displayed.

leftYAxisoptionalYAxisPropsleft_y_axisoptionalYAxisPropsleftYAxisoptionalYAxisPropsLeftYAxisoptionalYAxisPropsLeftYAxisoptionalYAxisProps#
Left Y axis.

Default: No minimum or maximum values for the left Y-axis

regionoptionalstringregionoptionalstrregionoptionalStringRegionoptionalstringRegionoptional*string#
The region the metrics of this graph should be taken from.

Default: Current region

titleoptionalstringtitleoptionalstrtitleoptionalStringTitleoptionalstringTitleoptional*string= None#
Title for the graph.
widthoptionalnumberwidthoptionalint | floatwidthoptionalNumberWidthoptionaldoubleWidthoptional*float64= 6#
Width of the widget, in a grid of 24 units wide.