Package software.amazon.awscdk.services.cloudwatch

Interface AlarmWidgetProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, MetricWidgetProps

All Known Implementing Classes:

AlarmWidgetProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:04.019Z")
@Stability(Stable)
public interface AlarmWidgetProps
extends software.amazon.jsii.JsiiSerializable, MetricWidgetProps

Properties for an AlarmWidget.

Example:

 Dashboard dashboard;
 Alarm errorAlarm;
 dashboard.addWidgets(AlarmWidget.Builder.create()
         .title("Errors")
         .alarm(errorAlarm)
         .build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	AlarmWidgetProps.Builder	A builder for AlarmWidgetProps
static final class	AlarmWidgetProps.Jsii$Proxy	An implementation for AlarmWidgetProps

Method Summary

Modifier and Type	Method	Description
static AlarmWidgetProps.Builder	builder()
IAlarm	getAlarm()	The alarm to show.
default YAxisProps	getLeftYAxis()	Left Y axis.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Methods inherited from interface software.amazon.awscdk.services.cloudwatch.MetricWidgetProps

getHeight, getRegion, getTitle, getWidth

Method Details

getAlarm

@Stability(Stable)
@NotNull
IAlarm getAlarm()

The alarm to show.

getLeftYAxis

@Stability(Stable)
@Nullable
default YAxisProps getLeftYAxis()

Left Y axis.

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

builder

@Stability(Stable)
static AlarmWidgetProps.Builder builder()

Returns:

a AlarmWidgetProps.Builder of AlarmWidgetProps