Class AlarmWidget

Simple widget that displays an array of cloudwatch alarm status in the dashboard grid.

Hierarchy (view full)

SimpleWidget
- AlarmWidget

Index

Constructors

Methods

addWidgetJson computeProperties computeType height width

Constructors

constructor

new AlarmWidget(args): AlarmWidget
Parameters
- args: AlarmWidgetArgs
Returns AlarmWidget
Overrides SimpleWidget.constructor
- Defined in classic/cloudwatch/widgets_simple.ts:128

Methods

addWidgetJson

addWidgetJson(widgetJsons, xOffset, yOffset, region): void
For internal use only.
Parameters
- widgetJsons: WidgetJson[]
- xOffset: number
- yOffset: number
- region: Output<Region>
Returns void
Inherited from SimpleWidget.addWidgetJson
- Defined in classic/cloudwatch/widgets_simple.ts:75

`Protected` computeProperties

computeProperties(region): Input<AlarmWidgetPropertiesJson>
Parameters
- region: Output<Region>
Returns Input<AlarmWidgetPropertiesJson>
Overrides SimpleWidget.computeProperties
- Defined in classic/cloudwatch/widgets_simple.ts:142

`Protected` computeType

computeType(): Input<"alarm">
Returns Input<"alarm">
Overrides SimpleWidget.computeType
- Defined in classic/cloudwatch/widgets_simple.ts:138

height

height(): number
The height of the widget in grid units. The default is 6.

Valid Values: 1–1000

Returns number
Overrides SimpleWidget.height
- Defined in classic/cloudwatch/widgets_simple.ts:134

width

width(): number
The width of the widget in grid units (in a 24-column grid). The default is 6.

Valid Values: 1–24

Type: Integer

Returns number
Inherited from SimpleWidget.width
- Defined in classic/cloudwatch/widgets_simple.ts:61

Generated using TypeDoc