Show / Hide Table of Contents

Class AlarmWidgetProps

Properties for an AlarmWidget.

Inheritance
System.Object
AlarmWidgetProps
Implements
IAlarmWidgetProps
IMetricWidgetProps
Namespace: Amazon.CDK.AWS.CloudWatch
Assembly: Amazon.CDK.AWS.CloudWatch.dll
Syntax (csharp)
public class AlarmWidgetProps : Object, IAlarmWidgetProps, IMetricWidgetProps
Syntax (vb)
Public Class AlarmWidgetProps
    Inherits Object
    Implements IAlarmWidgetProps, IMetricWidgetProps
Remarks

ExampleMetadata: infused

Examples
Dashboard dashboard;
Alarm errorAlarm;


dashboard.AddWidgets(new AlarmWidget(new AlarmWidgetProps {
    Title = "Errors",
    Alarm = errorAlarm
}));

Synopsis

Constructors

AlarmWidgetProps()

Properties

Alarm

The alarm to show.

Height

Height of the widget.

LeftYAxis

Left Y axis.

Region

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

Title

Title for the graph.

Width

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

Constructors

AlarmWidgetProps()

public AlarmWidgetProps()

Properties

Alarm

The alarm to show.

public IAlarm Alarm { get; set; }
Property Value

IAlarm

Height

Height of the widget.

public Nullable<double> Height { get; set; }
Property Value

System.Nullable<System.Double>

Remarks

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

LeftYAxis

Left Y axis.

public IYAxisProps LeftYAxis { get; set; }
Property Value

IYAxisProps

Remarks

Default: - No minimum or maximum values for the left Y-axis

Region

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

public string Region { get; set; }
Property Value

System.String

Remarks

Default: - Current region

Title

Title for the graph.

public string Title { get; set; }
Property Value

System.String

Remarks

Default: - None

Width

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

public Nullable<double> Width { get; set; }
Property Value

System.Nullable<System.Double>

Remarks

Default: 6

Implements

IAlarmWidgetProps
IMetricWidgetProps
Back to top Generated by DocFX