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 3.5
 
Container for the parameters to the PutMetricAlarm operation. Creates or updates an alarm and associates it with the specified Amazon CloudWatch metric. Optionally, this operation can associate one or more Amazon Simple Notification Service resources with the alarm.

When this operation creates an alarm, the alarm state is immediately set to INSUFFICIENT_DATA. The alarm is evaluated and its StateValue is set appropriately. Any actions associated with the StateValue is then executed.

When updating an existing alarm, its StateValue is left unchanged. If you are using an AWS Identity and Access Management (IAM) account to create or modify an alarm, you must have the following Amazon EC2 permissions:
  • ec2:DescribeInstanceStatus and ec2:DescribeInstances for all alarms on Amazon EC2 instance status metrics.
  • ec2:StopInstances for alarms with stop actions.
  • ec2:TerminateInstances for alarms with terminate actions.
  • ec2:DescribeInstanceRecoveryAttribute, and ec2:RecoverInstances for alarms with recover actions.

If you have read/write permissions for Amazon CloudWatch but not for Amazon EC2, you can still create an alarm but the stop or terminate actions won't be performed on the Amazon EC2 instance. However, if you are later granted permission to use the associated Amazon EC2 APIs, the alarm actions you created earlier will be performed. For more information about IAM permissions, see Permissions and Policies in Using IAM.

If you are using an IAM role (e.g., an Amazon EC2 instance profile), you cannot stop or terminate the instance using alarm actions. However, you can still see the alarm state and perform any other actions such as Amazon SNS notifications or Auto Scaling policies.

If you are using temporary security credentials granted using the AWS Security Token Service (AWS STS), you cannot stop or terminate an Amazon EC2 instance using alarm actions.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.CloudWatch.AmazonCloudWatchRequest
      Amazon.CloudWatch.Model.PutMetricAlarmRequest

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

Syntax

C#
public class PutMetricAlarmRequest : AmazonCloudWatchRequest
         IRequestEvents

The PutMetricAlarmRequest type exposes the following members

Constructors

NameDescription
Public Method PutMetricAlarmRequest()

Properties

NameTypeDescription
Public Property ActionsEnabled System.Boolean Gets and sets the property ActionsEnabled.

Indicates whether or not actions should be executed during any changes to the alarm's state.

Public Property AlarmActions System.Collections.Generic.List<System.String> Gets and sets the property AlarmActions.

The list of actions to execute when this alarm transitions into an ALARM state from any other state. Each action is specified as an Amazon Resource Name (ARN).

Valid Values: arn:aws:automate:region (e.g., us-east-1):ec2:stop | arn:aws:automate:region (e.g., us-east-1):ec2:terminate | arn:aws:automate:region (e.g., us-east-1):ec2:recover

Valid Values (for use with IAM roles): arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Stop/1.0 | arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Terminate/1.0 | arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Reboot/1.0

Note: You must create at least one stop, terminate, or reboot alarm using the Amazon EC2 or CloudWatch console to create the EC2ActionsAccess IAM role for the first time. After this IAM role is created, you can create stop, terminate, or reboot alarms using the CLI.

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

The description for the alarm.

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

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

The arithmetic operation to use when comparing the specified Statistic and Threshold. The specified Statistic value is used as the first operand.

Public Property Dimensions System.Collections.Generic.List<Amazon.CloudWatch.Model.Dimension> Gets and sets the property Dimensions.

The dimensions for the alarm's associated metric.

Public Property EvaluationPeriods System.Int32 Gets and sets the property EvaluationPeriods.

The number of periods over which data is compared to the specified threshold.

Public Property InsufficientDataActions System.Collections.Generic.List<System.String> Gets and sets the property InsufficientDataActions.

The list of actions to execute when this alarm transitions into an INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN).

Valid Values: arn:aws:automate:region (e.g., us-east-1):ec2:stop | arn:aws:automate:region (e.g., us-east-1):ec2:terminate | arn:aws:automate:region (e.g., us-east-1):ec2:recover

Valid Values (for use with IAM roles): arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Stop/1.0 | arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Terminate/1.0 | arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Reboot/1.0

Note: You must create at least one stop, terminate, or reboot alarm using the Amazon EC2 or CloudWatch console to create the EC2ActionsAccess IAM role for the first time. After this IAM role is created, you can create stop, terminate, or reboot alarms using the CLI.

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

The name for the alarm's associated metric.

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

The namespace for the alarm's associated metric.

Public Property OKActions System.Collections.Generic.List<System.String> Gets and sets the property OKActions.

The list of actions to execute when this alarm transitions into an OK state from any other state. Each action is specified as an Amazon Resource Name (ARN).

Valid Values: arn:aws:automate:region (e.g., us-east-1):ec2:stop | arn:aws:automate:region (e.g., us-east-1):ec2:terminate | arn:aws:automate:region (e.g., us-east-1):ec2:recover

Valid Values (for use with IAM roles): arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Stop/1.0 | arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Terminate/1.0 | arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Reboot/1.0

Note: You must create at least one stop, terminate, or reboot alarm using the Amazon EC2 or CloudWatch console to create the EC2ActionsAccess IAM role for the first time. After this IAM role is created, you can create stop, terminate, or reboot alarms using the CLI.

Public Property Period System.Int32 Gets and sets the property Period.

The period in seconds over which the specified statistic is applied.

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

The statistic to apply to the alarm's associated metric.

Public Property Threshold System.Double Gets and sets the property Threshold.

The value against which the specified statistic is compared.

Public Property Unit Amazon.CloudWatch.StandardUnit Gets and sets the property Unit.

The statistic's unit of measure. For example, the units for the Amazon EC2 NetworkIn metric are Bytes because NetworkIn tracks the number of bytes that an instance receives on all network interfaces. You can also specify a unit when you create a custom metric. Units help provide conceptual meaning to your data. Metric data points that specify a unit of measure, such as Percent, are aggregated separately.

Note: If you specify a unit, you must use a unit that is appropriate for the metric. Otherwise, this can cause an Amazon CloudWatch alarm to get stuck in the INSUFFICIENT DATA state.

Examples

This example shows how to create an alarm for a metric.

Create metric alarm example

var client = new AmazonCloudWatchClient();

var dimension = new Dimension
{
  Name = "Desktop Machine Metrics",
  Value = "Virtual Desktop Machine Usage"
};

var request = new PutMetricAlarmRequest
{
  ActionsEnabled = true,
  AlarmActions = new List<string>() 
    { "arn:aws:sns:us-east-1:80398EXAMPLE:CodingTestResults" },
  AlarmDescription = "Too many instances offline",
  AlarmName = "Offline Instances",
  ComparisonOperator = ComparisonOperator.GreaterThanOrEqualToThreshold,
  Dimensions = new List<Dimension>() { dimension },
  EvaluationPeriods = 1,
  MetricName = "Desktop Machines Offline",
  Namespace = "Example.com Custom Metrics",
  Period = (int)TimeSpan.FromMinutes(5).TotalSeconds,
  Statistic = new Statistic("Maximum"),
  Threshold = 5,
  Unit = StandardUnit.Count
};

client.PutMetricAlarm(request);
      

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