Package software.amazon.awscdk.services.cloudwatch

Interface GaugeWidgetProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable, MetricWidgetProps
All Known Implementing Classes:
GaugeWidgetProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)", date="2024-10-25T14:21:11.820Z") @Stability(Stable) public interface GaugeWidgetProps extends software.amazon.jsii.JsiiSerializable, MetricWidgetProps
Properties for a GaugeWidget.

Example: 

 Dashboard dashboard;
 Alarm errorAlarm;
 Metric gaugeMetric;
 dashboard.addWidgets(GaugeWidget.Builder.create()
         .metrics(List.of(gaugeMetric))
         .leftYAxis(YAxisProps.builder()
                 .min(0)
                 .max(1000)
                 .build())
         .build());

  • Method Details

    • getAnnotations

      @Stability(Stable) @Nullable default List<HorizontalAnnotation> getAnnotations()
      Annotations for the left Y axis.

      Default: - No annotations

    • 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.

    • getLeftYAxis

      @Stability(Stable) @Nullable default YAxisProps getLeftYAxis()
      Left Y axis.

      Default: - None

    • getLegendPosition

      @Stability(Stable) @Nullable default LegendPosition getLegendPosition()
      Position of the legend.

      Default: - bottom

    • getLiveData

      @Stability(Stable) @Nullable default Boolean getLiveData()
      Whether the graph should show live data.

      Default: false

    • getMetrics

      @Stability(Stable) @Nullable default List<IMetric> getMetrics()
      Metrics to display on left Y axis.

      Default: - No metrics

    • 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. Only applicable for Bar and Pie charts.

      If false, values will be from the most recent period of your chosen time range; if true, shows the value from the entire time range.

      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.

    • getStatistic

      @Stability(Stable) @Nullable default String getStatistic()
      The default statistic to be displayed for each metric.

      This default can be overridden within the definition of each individual metric

      Default: - The statistic for each metric is used

    • builder

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