Class SingleValueWidgetProps
Properties for a SingleValueWidget.
Inheritance
Namespace: Amazon.CDK.AWS.CloudWatch
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class SingleValueWidgetProps : Object, ISingleValueWidgetProps, IMetricWidgetPropsSyntax (vb)
Public Class SingleValueWidgetProps
Inherits Object
Implements ISingleValueWidgetProps, IMetricWidgetPropsRemarks
ExampleMetadata: infused
Examples
Dashboard dashboard;
dashboard.AddWidgets(new SingleValueWidget(new SingleValueWidgetProps {
Metrics = new [] { },
Period = Duration.Minutes(15)
}));Synopsis
Constructors
| Single |
Properties
| End | The end of the time range to use for each widget independently from those of the dashboard. |
| Full |
Whether to show as many digits as can fit, before rounding. |
| Height | Height of the widget. |
| Metrics | Metrics to display. |
| Period | The default period for all metrics in this widget. |
| Region | The region the metrics of this graph should be taken from. |
| Set |
Whether to show the value from the entire time range. |
| Sparkline | Whether to show a graph below the value illustrating the value for the whole time range. |
| Start | The start of the time range to use for each widget independently from those of the dashboard. |
| Title | Title for the graph. |
| Width | Width of the widget, in a grid of 24 units wide. |
Constructors
SingleValueWidgetProps()
public SingleValueWidgetProps()Properties
End
The end of the time range to use for each widget independently from those of the dashboard.
public string End { get; set; }Property Value
System.
Remarks
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.
FullPrecision
Whether to show as many digits as can fit, before rounding.
public Nullable<bool> FullPrecision { get; set; }Property Value
System.
Remarks
Default: false
Height
Height of the widget.
public Nullable<double> Height { get; set; }Property Value
System.
Remarks
Default: - 6 for Alarm and Graph widgets. 3 for single value widgets where most recent value of a metric is displayed.
Metrics
Period
The default period for all metrics in this widget.
public Duration Period { get; set; }Property Value
Remarks
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)
Region
The region the metrics of this graph should be taken from.
public string Region { get; set; }Property Value
System.
Remarks
Default: - Current region
SetPeriodToTimeRange
Whether to show the value from the entire time range.
public Nullable<bool> SetPeriodToTimeRange { get; set; }Property Value
System.
Remarks
Default: false
Sparkline
Whether to show a graph below the value illustrating the value for the whole time range.
public Nullable<bool> Sparkline { get; set; }Property Value
System.
Remarks
Cannot be used in combination with setPeriodToTimeRange
Default: false
Start
The start of the time range to use for each widget independently from those of the dashboard.
public string Start { get; set; }Property Value
System.
Remarks
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.
Title
Title for the graph.
public string Title { get; set; }Property Value
System.
Remarks
Default: - None
Width
Width of the widget, in a grid of 24 units wide.
public Nullable<double> Width { get; set; }Property Value
System.
Remarks
Default: 6