Interface SingleValueWidgetProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
,MetricWidgetProps
- All Known Implementing Classes:
SingleValueWidgetProps.Jsii$Proxy
Example:
Dashboard dashboard; dashboard.addWidgets(SingleValueWidget.Builder.create() .metrics(List.of()) .period(Duration.minutes(15)) .build());
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
A builder forSingleValueWidgetProps
static final class
An implementation forSingleValueWidgetProps
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
default String
getEnd()
The end of the time range to use for each widget independently from those of the dashboard.default Boolean
Whether to show as many digits as can fit, before rounding.Metrics to display.default Duration
The default period for all metrics in this widget.default Boolean
Whether to show the value from the entire time range.default Boolean
Whether to show a graph below the value illustrating the value for the whole time range.default String
getStart()
The start of the time range to use for each widget independently from those of the dashboard.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
Methods inherited from interface software.amazon.awscdk.services.cloudwatch.MetricWidgetProps
getHeight, getRegion, getTitle, getWidth
-
Method Details
-
getMetrics
Metrics to display. -
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.
-
getFullPrecision
Whether to show as many digits as can fit, before rounding.Default: false
-
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
Whether to show the value from the entire time range.Default: false
-
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
-
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.
-
builder
- Returns:
- a
SingleValueWidgetProps.Builder
ofSingleValueWidgetProps
-