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.73.0 (build 6faeda3)",
           date="2023-01-31T18:36:51.207Z")
 @Stability(value=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 and Description
static class	AlarmWidgetProps.Builder A builder for AlarmWidgetProps
static class	AlarmWidgetProps.Jsii$Proxy An implementation for AlarmWidgetProps

Method Summary

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

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

getHeight, getRegion, getTitle, getWidth

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAlarm

@Stability(value=Stable)
 @NotNull
IAlarm getAlarm()

The alarm to show.

getLeftYAxis

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

Left Y axis.

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

builder

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

Specified by:

builder in interface MetricWidgetProps

Returns:

a AlarmWidgetProps.Builder of AlarmWidgetProps