Package software.amazon.awscdk.services.cloudwatch

Interface IWidget

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Subinterfaces:
IWidget.Jsii$Default
All Known Implementing Classes:
AlarmStatusWidget, AlarmWidget, Column, ConcreteWidget, CustomWidget, GaugeWidget, GraphWidget, IWidget.Jsii$Proxy, LogQueryWidget, Row, SingleValueWidget, Spacer, TableWidget, TextWidget
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)", date="2024-11-22T02:23:58.523Z") @Stability(Stable) public interface IWidget extends software.amazon.jsii.JsiiSerializable
A single dashboard widget.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    IWidget.Jsii$Default
    Internal default implementation for IWidget.
    static final class 
    IWidget.Jsii$Proxy
    A proxy class which represents a concrete javascript instance of this type.

  • Method Summary

    Modifier and Type
    Method
    Description
    Number
    getHeight()
    The amount of vertical grid units the widget will take up.
    default List<String>
    getWarnings()
    Deprecated.
    use warningsV2
    default Map<String,String>
    getWarningsV2()
    Any warnings that are produced as a result of putting together this widget.
    Number
    getWidth()
    The amount of horizontal grid units the widget will take up.
    void
    position(Number x, Number y)
    Place the widget at a given position.
    List<Object>
    toJson()
    Return the widget JSON for use in the dashboard.

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Method Details

    • getHeight

      @Stability(Stable) @NotNull Number getHeight()
      The amount of vertical grid units the widget will take up.

    • getWidth

      @Stability(Stable) @NotNull Number getWidth()
      The amount of horizontal grid units the widget will take up.

    • getWarnings

      @Stability(Deprecated) @Deprecated @Nullable default List<String> getWarnings()
      Deprecated.
      • use warningsV2
      (deprecated) Any warnings that are produced as a result of putting together this widget.

    • getWarningsV2

      @Stability(Stable) @Nullable default Map<String,String> getWarningsV2()
      Any warnings that are produced as a result of putting together this widget.

    • position

      @Stability(Stable) void position(@NotNull Number x, @NotNull Number y)
      Place the widget at a given position.

      Parameters:
      x - This parameter is required.
      y - This parameter is required.

    • toJson

      @Stability(Stable) @NotNull List<Object> toJson()
      Return the widget JSON for use in the dashboard.