Package software.amazon.awscdk.services.cloudwatch

Class AlarmWidget

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.cloudwatch.ConcreteWidget
software.amazon.awscdk.services.cloudwatch.AlarmWidget
All Implemented Interfaces:
IWidget, software.amazon.jsii.JsiiSerializable
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:36.773Z") @Stability(Stable) public class AlarmWidget extends ConcreteWidget
Display the metric associated with an alarm, including the alarm line.

Example: 

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

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    AlarmWidget.Builder
    A fluent builder for AlarmWidget.

    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

    Constructors
    Modifier
    Constructor
    Description
     
    AlarmWidget(AlarmWidgetProps props)
     
    protected
    AlarmWidget(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
     
    protected
    AlarmWidget(software.amazon.jsii.JsiiObjectRef objRef)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    List<Object>
    toJson()
    Return the widget JSON for use in the dashboard.

    Methods inherited from class software.amazon.awscdk.services.cloudwatch.ConcreteWidget

    copyMetricWarnings, getHeight, getWarnings, 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

    • AlarmWidget

      protected AlarmWidget(software.amazon.jsii.JsiiObjectRef objRef)

    • AlarmWidget

      protected AlarmWidget(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • AlarmWidget

      @Stability(Stable) public AlarmWidget(@NotNull AlarmWidgetProps props)
      Parameters:
      props - This parameter is required.

  • Method Details