AWS SDK Version 3 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.

Constants used for properties of type StateValue.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.ConstantClass
    Amazon.CloudWatch.StateValue

Namespace: Amazon.CloudWatch
Assembly: AWSSDK.CloudWatch.dll
Version: 3.x.y.z

Syntax

C#
public class StateValue : ConstantClass

The StateValue type exposes the following members

Constructors

NameDescription
Public Method StateValue(string)

This constant constructor does not need to be called if the constant you are attempting to use is already defined as a static instance of this class. This constructor should be used to construct constants that are not defined as statics, for instance if attempting to use a feature that is newer than the current version of the SDK.

Properties

NameTypeDescription
Public Property Value System.String Inherited from Amazon.Runtime.ConstantClass.

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

NameDescription
Public Method Static Method FindValue(string)

Finds the constant for the unique value.

Fields

NameTypeDescription
Field Static Field ALARM Amazon.CloudWatch.StateValue

Constant ALARM for StateValue

Field Static Field INSUFFICIENT_DATA Amazon.CloudWatch.StateValue

Constant INSUFFICIENT_DATA for StateValue

Field Static Field OK Amazon.CloudWatch.StateValue

Constant OK for StateValue

Examples

This example shows how to get information about an alarm.

Get alarm information example

var client = new AmazonCloudWatchClient();

var request = new DescribeAlarmsRequest
{
  AlarmNames = new List() 
    { "awseb-e-b36EXAMPLE-stack-CloudwatchAlarmLow-1KAKH4EXAMPLE" },
  MaxRecords = 1,
  StateValue = StateValue.ALARM
};

var response = new DescribeAlarmsResponse();

do
{
  response = client.DescribeAlarms(request);

  foreach (var alarm in response.MetricAlarms)
  {
    Console.WriteLine(alarm.AlarmName);
    Console.WriteLine(alarm.AlarmDescription);
    Console.WriteLine(alarm.MetricName + " " +
        alarm.ComparisonOperator + " " + alarm.Threshold);
    Console.WriteLine();
  }

  request.NextToken = response.NextToken;

} while (!string.IsNullOrEmpty(response.NextToken));
      

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 Standard:
Supported in: 1.3

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

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms