Package software.amazon.awscdk.services.cloudwatch

Class SingleValueWidget.Builder

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

  • Method Details

    • create

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

    • height

      @Stability(Stable) public SingleValueWidget.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 SingleValueWidget.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 SingleValueWidget.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 SingleValueWidget.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

    • metrics

      @Stability(Stable) public SingleValueWidget.Builder metrics(List<? extends IMetric> metrics)
      Metrics to display.

      Parameters:
      metrics - Metrics to display. This parameter is required.
      Returns:
      this

    • end

      @Stability(Stable) public SingleValueWidget.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

    • fullPrecision

      @Stability(Stable) public SingleValueWidget.Builder fullPrecision(Boolean fullPrecision)
      Whether to show as many digits as can fit, before rounding.

      Default: false

      Parameters:
      fullPrecision - Whether to show as many digits as can fit, before rounding. This parameter is required.
      Returns:
      this

    • period

      @Stability(Stable) public SingleValueWidget.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 SingleValueWidget.Builder setPeriodToTimeRange(Boolean setPeriodToTimeRange)
      Whether to show the value from the entire time range.

      Default: false

      Parameters:
      setPeriodToTimeRange - Whether to show the value from the entire time range. This parameter is required.
      Returns:
      this

    • sparkline

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

      Parameters:
      sparkline - Whether to show a graph below the value illustrating the value for the whole time range. This parameter is required.
      Returns:
      this

    • start

      @Stability(Stable) public SingleValueWidget.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

    • build

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