Package software.amazon.awscdk.services.cloudwatch

Interface SingleValueWidgetProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable, MetricWidgetProps
All Known Implementing Classes:
SingleValueWidgetProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)", date="2024-11-27T16:50:54.540Z") @Stability(Stable) public interface SingleValueWidgetProps extends software.amazon.jsii.JsiiSerializable, MetricWidgetProps
Properties for a SingleValueWidget.

Example: 

 Dashboard dashboard;
 dashboard.addWidgets(SingleValueWidget.Builder.create()
         .metrics(List.of())
         .period(Duration.minutes(15))
         .build());

  • Method Details

    • getMetrics

      @Stability(Stable) @NotNull List<IMetric> getMetrics()
      Metrics to display.

    • getEnd

      @Stability(Stable) @Nullable default String getEnd()
      The end of the time range to use for each widget independently from those of the dashboard.

      If you specify a value for end, you must also specify a value for start. Specify an absolute time in the ISO 8601 format. For example, 2018-12-17T06:00:00.000Z.

      Default: When the dashboard loads, the end date will be the current time.

    • getFullPrecision

      @Stability(Stable) @Nullable default Boolean getFullPrecision()
      Whether to show as many digits as can fit, before rounding.

      Default: false

    • getPeriod

      @Stability(Stable) @Nullable default Duration getPeriod()
      The default period for all metrics in this widget.

      The period is the length of time represented by one data point on the graph. This default can be overridden within each metric definition.

      Default: cdk.Duration.seconds(300)

    • getSetPeriodToTimeRange

      @Stability(Stable) @Nullable default Boolean getSetPeriodToTimeRange()
      Whether to show the value from the entire time range.

      Default: false

    • getSparkline

      @Stability(Stable) @Nullable default Boolean getSparkline()
      Whether to show a graph below the value illustrating the value for the whole time range.

      Cannot be used in combination with setPeriodToTimeRange

      Default: false

    • getStart

      @Stability(Stable) @Nullable default String getStart()
      The start of the time range to use for each widget independently from those of the dashboard.

      You can specify start without specifying end to specify a relative time range that ends with the current time. In this case, the value of start must begin with -P, and you can use M, H, D, W and M as abbreviations for minutes, hours, days, weeks and months. For example, -PT8H shows the last 8 hours and -P3M shows the last three months. You can also use start along with an end field, to specify an absolute time range. When specifying an absolute time range, use the ISO 8601 format. For example, 2018-12-17T06:00:00.000Z.

      Default: When the dashboard loads, the start time will be the default time range.

    • builder

      @Stability(Stable) static SingleValueWidgetProps.Builder builder()
      Returns:
      a SingleValueWidgetProps.Builder of SingleValueWidgetProps