Class SingleValueWidgetProps

Properties for a SingleValueWidget.

Inheritance
object
SingleValueWidgetProps
Inherited Members
Namespace: Amazon.CDK.AWS.CloudWatch
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class SingleValueWidgetProps : ISingleValueWidgetProps, IMetricWidgetProps
Syntax (vb)
Public Class SingleValueWidgetProps Implements ISingleValueWidgetProps, IMetricWidgetProps
Remarks

ExampleMetadata: infused

Examples
Dashboard dashboard;


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

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

Synopsis

Constructors

SingleValueWidgetProps()

Properties for a SingleValueWidget.

Properties

AccountId

The AWS account ID where the metrics are located.
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.
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.
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.
Title

Title for the graph.
Width

Width of the widget, in a grid of 24 units wide.

Constructors

SingleValueWidgetProps()

Properties for a SingleValueWidget.

public SingleValueWidgetProps()
Remarks

ExampleMetadata: infused

Examples
Dashboard dashboard;


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

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

Properties

AccountId

The AWS account ID where the metrics are located.

public string? AccountId { get; set; }
Property Value

string

Remarks

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

Default: - Current account

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

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.

public bool? FullPrecision { get; set; }
Property Value

bool?

Remarks

Default: false

Height

Height of the widget.

public double? Height { get; set; }
Property Value

double?

Remarks

Default: - 6 for Alarm and Graph widgets. 3 for single value widgets where most recent value of a metric is displayed.

Metrics

Metrics to display.

public IMetric[] Metrics { get; set; }
Property Value

IMetric[]

Remarks

ExampleMetadata: infused

Period

The default period for all metrics in this widget.

public Duration? Period { get; set; }
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)

Region

The region the metrics of this graph should be taken from.

public string? Region { get; set; }
Property Value

string

Remarks

Default: - Current region

SetPeriodToTimeRange

Whether to show the value from the entire time range.

public bool? SetPeriodToTimeRange { get; set; }
Property Value

bool?

Remarks

Default: false

Sparkline

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

public bool? Sparkline { get; set; }
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.

public string? Start { get; set; }
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.

Title

Title for the graph.

public string? Title { get; set; }
Property Value

string

Remarks

Default: - None

Width

Width of the widget, in a grid of 24 units wide.

public double? Width { get; set; }
Property Value

double?

Remarks

Default: 6

Implements