AWS CDK Reference

Appearance

v2.275.0

YAxisProps Struct ​

Properties for a Y-Axis.

Source
aws-cloudwatch/lib/graph.ts
Type last changed
v2.214.0 · 2 Sep 2025

Example ​

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

dashboard.addWidgets(new cloudwatch.GaugeWidget({
  metrics: [gaugeMetric],
  leftYAxis: {
    min: 0,
    max: 1000,
  }
}));

Properties ​

labeloptionalstringlabeloptionalstrlabeloptionalStringLabeloptionalstringLabeloptional*string#
The label.

Default: No label

maxoptionalnumbermaxoptionalint | floatmaxoptionalNumberMaxoptionaldoubleMaxoptional*float64= Auto#
The max value.
minoptionalnumberminoptionalint | floatminoptionalNumberMinoptionaldoubleMinoptional*float64= Auto#
The min value.
showUnitsoptionalbooleanshow_unitsoptionalboolshowUnitsoptionalBooleanShowUnitsoptionalboolShowUnitsoptional*bool= true#
Whether to show units.