Container for the parameters to the SetAlarmState operation.
Temporarily sets the state of an alarm for testing purposes. When the updated state
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 state to ALARM sends
an SNS message.
Metric alarms returns to their actual state quickly, often within seconds. Because the metric alarm state change happens quickly, it is typically only visible in the alarm's History tab in the Amazon CloudWatch console or through DescribeAlarmHistory.
If you use SetAlarmState on a composite alarm, the composite alarm is not guaranteed
to return to its actual state. It returns to its actual state only once any of its
children alarms change state. It is also reevaluated if you update its configuration.
If an alarm triggers EC2 Auto Scaling policies or application Auto Scaling policies,
you must include information in the StateReasonData parameter to enable the
policy to take the correct action.
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.CloudWatch.AmazonCloudWatchRequest
Amazon.CloudWatch.Model.SetAlarmStateRequest
Namespace: Amazon.CloudWatch.Model
Assembly: AWSSDK.CloudWatch.dll
Version: 3.x.y.z
Syntax
public class SetAlarmStateRequest : AmazonCloudWatchRequest IAmazonWebServiceRequest
The SetAlarmStateRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
SetAlarmStateRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
AlarmName | System.String |
Gets and sets the property AlarmName. The name of the alarm. |
|
|
StateReason | System.String |
Gets and sets the property StateReason. The reason that this alarm is set to this specific state, in text format. |
|
|
StateReasonData | System.String |
Gets and sets the property StateReasonData. The reason that this alarm is set to this specific state, in JSON format. For SNS or EC2 alarm actions, this is just informational. But for EC2 Auto Scaling or application Auto Scaling alarm actions, the Auto Scaling policy uses the information in this field to take the correct action. |
|
|
StateValue | Amazon.CloudWatch.StateValue |
Gets and sets the property StateValue. The value of the state. |
Examples
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
};
client.SetAlarmState(request);
Version Information
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5