AWS CDK Reference

Appearance

v2.275.0

SingleValueWidgetProps Struct ​

Properties for a SingleValueWidget.

Source
aws-cloudwatch/lib/graph.ts
Type last changed
v2.97.0 · 22 Sep 2023

Example ​

ts
declare const dashboard: cloudwatch.Dashboard;

dashboard.addWidgets(new cloudwatch.SingleValueWidget({
  metrics: [ /* ... */ ],

  period: Duration.minutes(15),
}));

Properties ​

accountIdoptionalstringaccount_idoptionalstraccountIdoptionalStringAccountIdoptionalstringAccountIdoptional*string#
The AWS account ID where the metrics are located.

Default: Current account

notes

This enables cross-account functionality for CloudWatch dashboards. Before using this feature, ensure that proper cross-account sharing is configured between the monitoring account and source account.

For more information, see: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html

endoptionalstringendoptionalstrendoptionalStringEndoptionalstringEndoptional*string#
The end of the time range to use for each widget independently from those of the dashboard.

Default: When the dashboard loads, the end date will be the current time.

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.

fullPrecisionoptionalbooleanfull_precisionoptionalboolfullPrecisionoptionalBooleanFullPrecisionoptionalboolFullPrecisionoptional*bool= false#
Whether to show as many digits as can fit, before rounding.
heightoptionalnumberheightoptionalint | floatheightoptionalNumberHeightoptionaldoubleHeightoptional*float64#
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.

metricsIMetric[]metricstyping.List[IMetric]metricsList<IMetric>MetricsIMetric[]Metrics*[]IMetricrequired#
Metrics to display.
periodoptionalDurationperiodoptionalDurationperiodoptionalDurationPeriodoptionalDurationPeriodoptionalDuration= cdk.Duration.seconds(300)#
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.

regionoptionalstringregionoptionalstrregionoptionalStringRegionoptionalstringRegionoptional*string#
The region the metrics of this graph should be taken from.

Default: Current region

setPeriodToTimeRangeoptionalbooleanset_period_to_time_rangeoptionalboolsetPeriodToTimeRangeoptionalBooleanSetPeriodToTimeRangeoptionalboolSetPeriodToTimeRangeoptional*bool= false#
Whether to show the value from the entire time range.
sparklineoptionalbooleansparklineoptionalboolsparklineoptionalBooleanSparklineoptionalboolSparklineoptional*bool= false#
Whether to show a graph below the value illustrating the value for the whole time range.

Cannot be used in combination with setPeriodToTimeRange

startoptionalstringstartoptionalstrstartoptionalStringStartoptionalstringStartoptional*string#
The start of the time range to use for each widget independently from those of the dashboard.

Default: When the dashboard loads, the start time will be the default time range.

notes

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.

titleoptionalstringtitleoptionalstrtitleoptionalStringTitleoptionalstringTitleoptional*string= None#
Title for the graph.
widthoptionalnumberwidthoptionalint | floatwidthoptionalNumberWidthoptionaldoubleWidthoptional*float64= 6#
Width of the widget, in a grid of 24 units wide.