GradientEdge CDK Utils
    Preparing search index...
    interface AlarmStatusWidgetProps {
        alarmProps: AlarmProps[];
        alarms: IAlarmRef[];
        height?: number;
        positionX: number;
        positionY: number;
        sortBy?: AlarmStatusWidgetSortBy;
        states?: AlarmState[];
        title?: string;
        type: string;
        width?: number;
    }

    Hierarchy

    • AlarmStatusWidgetProps
      • AlarmStatusWidgetProps
    Index

    Properties

    alarmProps: AlarmProps[]

    Array of alarm properties to display in the widget

    alarms: IAlarmRef[]

    CloudWatch Alarms to show in widget

    height?: number

    Height of the widget

    3
    
    positionX: number

    The X position of the widget on the dashboard grid

    positionY: number

    The Y position of the widget on the dashboard grid

    sortBy?: AlarmStatusWidgetSortBy

    Specifies how to sort the alarms in the widget.

    - alphabetical order
    
    states?: AlarmState[]

    Use this field to filter the list of alarms displayed in the widget to only those alarms currently in the specified states. You can specify one or more alarm states in the value for this field. The alarm states that you can specify are ALARM, INSUFFICIENT_DATA, and OK.

    If you omit this field or specify an empty array, all the alarms specified in alarms are displayed.

    -  all the alarms specified in alarms are displayed.
    
    title?: string

    The title of the widget

    'Alarm Status'
    
    type: string

    The widget type identifier

    width?: number

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

    6