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.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:37.266Z")
 @Stability(value=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())
         .fullPrecision(true)
         .build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SingleValueWidgetProps.Builder A builder for SingleValueWidgetProps
static class	SingleValueWidgetProps.Jsii$Proxy An implementation for SingleValueWidgetProps

Method Summary

Modifier and Type	Method and Description
static SingleValueWidgetProps.Builder	builder()
default Boolean	getFullPrecision() Whether to show as many digits as can fit, before rounding.
List<IMetric>	getMetrics() Metrics to display.
default Boolean	getSetPeriodToTimeRange() Whether to show the value from the entire time range.
default Boolean	getSparkline() Whether to show a graph below the value illustrating the value for the whole time range.

Methods inherited from interface software.amazon.awscdk.services.cloudwatch.MetricWidgetProps

getHeight, getRegion, getTitle, getWidth

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getMetrics

@Stability(value=Stable)
 @NotNull
List<IMetric> getMetrics()

Metrics to display.

getFullPrecision

@Stability(value=Stable)
 @Nullable
default Boolean getFullPrecision()

Whether to show as many digits as can fit, before rounding.

Default: false

getSetPeriodToTimeRange

@Stability(value=Stable)
 @Nullable
default Boolean getSetPeriodToTimeRange()

Whether to show the value from the entire time range.

Default: false

getSparkline

@Stability(value=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

builder

@Stability(value=Stable)
static SingleValueWidgetProps.Builder builder()

Specified by:

builder in interface MetricWidgetProps

Returns:

a SingleValueWidgetProps.Builder of SingleValueWidgetProps