AWS SDK Version 2 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

.NET Framework 4.5
Container for the parameters to the SetAlarmState operation. Temporarily sets the state of an alarm. When the updated StateValue differs from the previous value, the action configured for the appropriate state is invoked. For example, if your alarm is configured to send an Amazon SNS message when an alarm is triggered, temporarily changing the alarm's state to ALARM will send an Amazon SNS message. This is not a permanent change. The next periodic alarm check (in about a minute) will set the alarm to its actual state. Because the alarm state change happens very quickly, it is typically only visibile in the alarm's History tab in the Amazon CloudWatch console or through DescribeAlarmHistory.

Inheritance Hierarchy


Namespace: Amazon.CloudWatch.Model
Assembly: AWSSDK.dll
Version: (assembly version)


public class SetAlarmStateRequest : AmazonCloudWatchRequest

The SetAlarmStateRequest type exposes the following members


Public Method SetAlarmStateRequest()


Public Property AlarmName System.String Gets and sets the property AlarmName.

The descriptive name for the alarm. This name must be unique within the user's AWS account. The maximum length is 255 characters.

Public Property StateReason System.String Gets and sets the property StateReason.

The reason that this alarm is set to this specific state (in human-readable text format)

Public Property StateReasonData System.String Gets and sets the property StateReasonData.

The reason that this alarm is set to this specific state (in machine-readable JSON format)

Public Property StateValue Amazon.CloudWatch.StateValue Gets and sets the property StateValue.

The value of the state.


This example shows how to temporarily set an alarm's state.

Set alarm state example

var client = new AmazonCloudWatchClient();

var request = new SetAlarmStateRequest
  AlarmName = "Offline Instances",
  StateReason = "Too many instances are offline.",
  StateValue = StateValue.ALARM


Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

.NET for Windows Store apps:
Supported in: Windows 8.1, Windows 8

.NET for Windows Phone:
Supported in: Windows Phone 8.1, Windows Phone 8