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

    • 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

    • 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

    • build

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