Skip to content
v2.278.0

AlarmStatusWidgetSortBy Enum ​

The sort possibilities for AlarmStatusWidgets.

Example ​

ts
declare const dashboard: cloudwatch.Dashboard;
declare const errorAlarm: cloudwatch.Alarm;

dashboard.addWidgets(new cloudwatch.AlarmStatusWidget({
  title: "Errors",
  alarms: [errorAlarm],
  sortBy: cloudwatch.AlarmStatusWidgetSortBy.STATE_UPDATED_TIMESTAMP,
  states: [cloudwatch.AlarmState.ALARM],
}));
python
# dashboard: cloudwatch.Dashboard
# error_alarm: cloudwatch.Alarm


dashboard.add_widgets(cloudwatch.AlarmStatusWidget(
    title="Errors",
    alarms=[error_alarm],
    sort_by=cloudwatch.AlarmStatusWidgetSortBy.STATE_UPDATED_TIMESTAMP,
    states=[cloudwatch.AlarmState.ALARM]
))
java
Dashboard dashboard;
Alarm errorAlarm;


dashboard.addWidgets(AlarmStatusWidget.Builder.create()
        .title("Errors")
        .alarms(List.of(errorAlarm))
        .sortBy(AlarmStatusWidgetSortBy.STATE_UPDATED_TIMESTAMP)
        .states(List.of(AlarmState.ALARM))
        .build());
csharp
// Install: dotnet add package Amazon.CDK.Lib
Dashboard dashboard;
Alarm errorAlarm;


dashboard.AddWidgets(new AlarmStatusWidget(new AlarmStatusWidgetProps {
    Title = "Errors",
    Alarms = new [] { errorAlarm },
    SortBy = AlarmStatusWidgetSortBy.STATE_UPDATED_TIMESTAMP,
    States = new [] { AlarmState.ALARM }
}));
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
var dashboard Dashboard
var errorAlarm Alarm


dashboard.AddWidgets(cloudwatch.NewAlarmStatusWidget(&AlarmStatusWidgetProps{
	Title: jsii.String("Errors"),
	Alarms: []IAlarmRef{
		errorAlarm,
	},
	SortBy: cloudwatch.AlarmStatusWidgetSortBy_STATE_UPDATED_TIMESTAMP,
	States: []AlarmState{
		cloudwatch.AlarmState_ALARM,
	},
}))

Members ​

MemberDescription
DEFAULTChoose DEFAULT to sort them in alphabetical order by alarm name.
STATE_UPDATED_TIMESTAMPChoose STATE_UPDATED_TIMESTAMP to sort them first by alarm state, with alarms in ALARM state first, INSUFFICIENT_DATA alarms next, and OK alarms last.
TIMESTAMPChoose TIMESTAMP to sort them by the time when the alarms most recently changed state, no matter the current alarm state.

Referenced by ​