Package software.amazon.awscdk.services.cloudwatch

Class GaugeWidget.Builder

java.lang.Object
software.amazon.awscdk.services.cloudwatch.GaugeWidget.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<GaugeWidget>
Enclosing class:
GaugeWidget
@Stability(Stable) public static final class GaugeWidget.Builder extends Object implements software.amazon.jsii.Builder<GaugeWidget>
A fluent builder for GaugeWidget.

  • Method Details

    • create

      @Stability(Stable) public static GaugeWidget.Builder create()
      Returns:
      a new instance of GaugeWidget.Builder.

    • height

      @Stability(Stable) public GaugeWidget.Builder height(Number height)
      Height of the widget.

      Default: - 6 for Alarm and Graph widgets. 3 for single value widgets where most recent value of a metric is displayed.

      Parameters:
      height - Height of the widget. This parameter is required.
      Returns:
      this

    • region

      @Stability(Stable) public GaugeWidget.Builder region(String region)
      The region the metrics of this graph should be taken from.

      Default: - Current region

      Parameters:
      region - The region the metrics of this graph should be taken from. This parameter is required.
      Returns:
      this

    • title

      @Stability(Stable) public GaugeWidget.Builder title(String title)
      Title for the graph.

      Default: - None

      Parameters:
      title - Title for the graph. This parameter is required.
      Returns:
      this

    • width

      @Stability(Stable) public GaugeWidget.Builder width(Number width)
      Width of the widget, in a grid of 24 units wide.

      Default: 6

      Parameters:
      width - Width of the widget, in a grid of 24 units wide. This parameter is required.
      Returns:
      this

    • annotations

      @Stability(Stable) public GaugeWidget.Builder annotations(List<? extends HorizontalAnnotation> annotations)
      Annotations for the left Y axis.

      Default: - No annotations

      Parameters:
      annotations - Annotations for the left Y axis. This parameter is required.
      Returns:
      this

    • end

      @Stability(Stable) public GaugeWidget.Builder end(String end)
      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.

      Parameters:
      end - The end of the time range to use for each widget independently from those of the dashboard. This parameter is required.
      Returns:
      this

    • leftYAxis

      @Stability(Stable) public GaugeWidget.Builder leftYAxis(YAxisProps leftYAxis)
      Left Y axis.

      Default: - None

      Parameters:
      leftYAxis - Left Y axis. This parameter is required.
      Returns:
      this

    • legendPosition

      @Stability(Stable) public GaugeWidget.Builder legendPosition(LegendPosition legendPosition)
      Position of the legend.

      Default: - bottom

      Parameters:
      legendPosition - Position of the legend. This parameter is required.
      Returns:
      this

    • liveData

      @Stability(Stable) public GaugeWidget.Builder liveData(Boolean liveData)
      Whether the graph should show live data.

      Default: false

      Parameters:
      liveData - Whether the graph should show live data. This parameter is required.
      Returns:
      this

    • metrics

      @Stability(Stable) public GaugeWidget.Builder metrics(List<? extends IMetric> metrics)
      Metrics to display on left Y axis.

      Default: - No metrics

      Parameters:
      metrics - Metrics to display on left Y axis. This parameter is required.
      Returns:
      this

    • period

      @Stability(Stable) public GaugeWidget.Builder period(Duration period)
      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)

      Parameters:
      period - The default period for all metrics in this widget. This parameter is required.
      Returns:
      this

    • setPeriodToTimeRange

      @Stability(Stable) public GaugeWidget.Builder setPeriodToTimeRange(Boolean setPeriodToTimeRange)
      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

      Parameters:
      setPeriodToTimeRange - Whether to show the value from the entire time range. Only applicable for Bar and Pie charts. This parameter is required.
      Returns:
      this

    • start

      @Stability(Stable) public GaugeWidget.Builder start(String start)
      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.

      Parameters:
      start - The start of the time range to use for each widget independently from those of the dashboard. This parameter is required.
      Returns:
      this

    • statistic

      @Stability(Stable) public GaugeWidget.Builder statistic(String statistic)
      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

      Parameters:
      statistic - The default statistic to be displayed for each metric. This parameter is required.
      Returns:
      this

    • build

      @Stability(Stable) public GaugeWidget build()
      Specified by:
      build in interface software.amazon.jsii.Builder<GaugeWidget>
      Returns:
      a newly built instance of GaugeWidget.