Package software.amazon.awscdk.services.cloudwatch

Class ConcreteWidget

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.cloudwatch.ConcreteWidget
All Implemented Interfaces:
IWidget, software.amazon.jsii.JsiiSerializable
Direct Known Subclasses:
AlarmStatusWidget, AlarmWidget, CustomWidget, GaugeWidget, GraphWidget, LogQueryWidget, SingleValueWidget, TableWidget, TextWidget
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)", date="2024-12-11T23:26:30.238Z") @Stability(Stable) public abstract class ConcreteWidget extends software.amazon.jsii.JsiiObject implements IWidget
A real CloudWatch widget that has its own fixed size and remembers its position.

This is in contrast to other widgets which exist for layout purposes.

  • Nested Class Summary

    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
    protected
    ConcreteWidget(Number width, Number height)
     
    protected
    ConcreteWidget(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
     
    protected
    ConcreteWidget(software.amazon.jsii.JsiiObjectRef objRef)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected void
    copyMetricWarnings(@NotNull IMetric... ms)
    Copy the warnings from the given metric.
    Number
    getHeight()
    The amount of vertical grid units the widget will take up.
    List<String>
    getWarnings()
    Any warnings that are produced as a result of putting together this widget.
    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.
    protected Number
    getX()
     
    protected Number
    getY()
     
    void
    position(Number x, Number y)
    Place the widget at a given position.
    protected void
    setX(Number value)
     
    protected void
    setY(Number value)
     
    abstract List<Object>
    toJson()
    Return the widget JSON for use in the dashboard.

    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

    • ConcreteWidget

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

    • ConcreteWidget

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

    • ConcreteWidget

      @Stability(Stable) protected ConcreteWidget(@NotNull Number width, @NotNull Number height)
      Parameters:
      width - The amount of horizontal grid units the widget will take up. This parameter is required.
      height - The amount of vertical grid units the widget will take up. This parameter is required.

  • Method Details

    • copyMetricWarnings

      @Stability(Stable) protected void copyMetricWarnings(@NotNull @NotNull IMetric... ms)
      Copy the warnings from the given metric.

      Parameters:
      ms - This parameter is required.

    • position

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

      Specified by:
      position in interface IWidget
      Parameters:
      x - This parameter is required.
      y - This parameter is required.

    • toJson

      @Stability(Stable) @NotNull public abstract List<Object> toJson()
      Return the widget JSON for use in the dashboard.
      Specified by:
      toJson in interface IWidget

    • getHeight

      @Stability(Stable) @NotNull public Number getHeight()
      The amount of vertical grid units the widget will take up.
      Specified by:
      getHeight in interface IWidget

    • getWidth

      @Stability(Stable) @NotNull public Number getWidth()
      The amount of horizontal grid units the widget will take up.
      Specified by:
      getWidth in interface IWidget

    • getWarnings

      @Stability(Stable) @Nullable public List<String> getWarnings()
      Any warnings that are produced as a result of putting together this widget.
      Specified by:
      getWarnings in interface IWidget

    • getWarningsV2

      @Stability(Stable) @Nullable public Map<String,String> getWarningsV2()
      Any warnings that are produced as a result of putting together this widget.
      Specified by:
      getWarningsV2 in interface IWidget

    • getX

      @Stability(Stable) @Nullable protected Number getX()

    • setX

      @Stability(Stable) protected void setX(@Nullable Number value)

    • getY

      @Stability(Stable) @Nullable protected Number getY()

    • setY

      @Stability(Stable) protected void setY(@Nullable Number value)