Class GaugeWidget
A dashboard gauge widget that displays metrics.
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.CloudWatch
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class GaugeWidget : ConcreteWidget, IWidget
Syntax (vb)
Public Class GaugeWidget Inherits ConcreteWidget Implements IWidget
Remarks
ExampleMetadata: infused
Examples
Dashboard dashboard;
Alarm errorAlarm;
Metric gaugeMetric;
dashboard.AddWidgets(new GaugeWidget(new GaugeWidgetProps {
Metrics = new [] { gaugeMetric },
LeftYAxis = new YAxisProps {
Min = 0,
Max = 1000
}
}));
Synopsis
Constructors
| GaugeWidget(IGaugeWidgetProps) | A dashboard gauge widget that displays metrics. |
Methods
| AddMetric(IMetric) | Add another metric to the left Y axis of the GaugeWidget. |
| ToJson() | Return the widget JSON for use in the dashboard. |
Constructors
GaugeWidget(IGaugeWidgetProps)
A dashboard gauge widget that displays metrics.
public GaugeWidget(IGaugeWidgetProps props)
Parameters
- props IGaugeWidgetProps
Remarks
ExampleMetadata: infused
Examples
Dashboard dashboard;
Alarm errorAlarm;
Metric gaugeMetric;
dashboard.AddWidgets(new GaugeWidget(new GaugeWidgetProps {
Metrics = new [] { gaugeMetric },
LeftYAxis = new YAxisProps {
Min = 0,
Max = 1000
}
}));
Methods
AddMetric(IMetric)
Add another metric to the left Y axis of the GaugeWidget.
public virtual void AddMetric(IMetric metric)
Parameters
- metric IMetric
the metric to add.
Remarks
ExampleMetadata: infused
ToJson()
Return the widget JSON for use in the dashboard.
public override object[] ToJson()
Returns
object[]
Overrides
Remarks
ExampleMetadata: infused