Interface ISingleValueWidgetProps

Properties for a SingleValueWidget.

Inherited Members
Namespace: Amazon.CDK.AWS.CloudWatch
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface ISingleValueWidgetProps : IMetricWidgetProps
Syntax (vb)
Public Interface ISingleValueWidgetProps Inherits IMetricWidgetProps
Remarks

ExampleMetadata: infused

Examples
Dashboard dashboard;


            dashboard.AddWidgets(new SingleValueWidget(new SingleValueWidgetProps {
                Metrics = new [] {  },

                Period = Duration.Minutes(15)
            }));

Synopsis

Properties

End

The end of the time range to use for each widget independently from those of the dashboard.
FullPrecision

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

Metrics to display.
Period

The default period for all metrics in this widget.
SetPeriodToTimeRange

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.

Properties

End

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

string? End { get; }
Property Value

string

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.

bool? FullPrecision { get; }
Property Value

bool?

Remarks

Default: false

Metrics

Metrics to display.

IMetric[] Metrics { get; }
Property Value

IMetric[]

Remarks

ExampleMetadata: infused

Period

The default period for all metrics in this widget.

Duration? Period { get; }
Property Value

Duration

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)

SetPeriodToTimeRange

Whether to show the value from the entire time range.

bool? SetPeriodToTimeRange { get; }
Property Value

bool?

Remarks

Default: false

Sparkline

Whether to show a graph below the value illustrating the value for the whole time range.

bool? Sparkline { get; }
Property Value

bool?

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.

string? Start { get; }
Property Value

string

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.