# AlarmStatusWidgetSortBy

The sort possibilities for AlarmStatusWidgets.

- Source: [`aws-cloudwatch/lib/alarm-status-widget.ts`](https://github.com/aws/aws-cdk/blob/v2.278.0/packages/aws-cdk-lib/aws-cloudwatch/lib/alarm-status-widget.ts#L8)
- Type last changed: v2.18.0 · 29 Mar 2022

## Example

TypeScript:

```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:

```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:

```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());
```

C# / .NET:

```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 }
}));
```

Golang:

```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

| Member | Description |
| --- | --- |
| `DEFAULT` | Choose DEFAULT to sort them in alphabetical order by alarm name. |
| `STATE_UPDATED_TIMESTAMP` | Choose STATE_UPDATED_TIMESTAMP to sort them first by alarm state, with alarms in ALARM state first, INSUFFICIENT_DATA alarms next, and OK alarms last. |
| `TIMESTAMP` | Choose TIMESTAMP to sort them by the time when the alarms most recently changed state, no matter the current alarm state. |

## Referenced by

- [`AlarmStatusWidgetProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_cloudwatch.AlarmStatusWidgetProps.html).sortBy
