Class GaugeWidget
java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.cloudwatch.ConcreteWidget
software.amazon.awscdk.services.cloudwatch.GaugeWidget
- All Implemented Interfaces:
IWidget
,software.amazon.jsii.JsiiSerializable
@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
date="2024-10-05T03:43:40.203Z")
@Stability(Stable)
public class GaugeWidget
extends ConcreteWidget
A dashboard gauge widget that displays metrics.
Example:
Dashboard dashboard; Alarm errorAlarm; Metric gaugeMetric; dashboard.addWidgets(GaugeWidget.Builder.create() .metrics(List.of(gaugeMetric)) .leftYAxis(YAxisProps.builder() .min(0) .max(1000) .build()) .build());
-
Nested Class Summary
Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.amazon.awscdk.services.cloudwatch.IWidget
IWidget.Jsii$Default
-
Constructor Summary
ModifierConstructorDescriptionGaugeWidget
(GaugeWidgetProps props) protected
GaugeWidget
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
GaugeWidget
(software.amazon.jsii.JsiiObjectRef objRef) -
Method Summary
Methods inherited from class software.amazon.awscdk.services.cloudwatch.ConcreteWidget
copyMetricWarnings, getHeight, getWarnings, getWarningsV2, getWidth, getX, getY, position, setX, setY
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, toString, wait, wait, wait
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Constructor Details
-
GaugeWidget
protected GaugeWidget(software.amazon.jsii.JsiiObjectRef objRef) -
GaugeWidget
protected GaugeWidget(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
GaugeWidget
- Parameters:
props
- This parameter is required.
-
-
Method Details
-
addMetric
Add another metric to the left Y axis of the GaugeWidget.- Parameters:
metric
- the metric to add. This parameter is required.
-
toJson
Return the widget JSON for use in the dashboard.- Specified by:
toJson
in interfaceIWidget
- Specified by:
toJson
in classConcreteWidget
-