Container for the parameters to the PutMetricAlarm operation. Creates or updates an alarm and associates it with the specified metric, metric math expression, anomaly detection model, or Metrics Insights query. For more information about using a Metrics Insights query for an alarm, see Create alarms on Metrics Insights queries.
Alarms based on anomaly detection models cannot have Auto Scaling actions.
When this operation creates an alarm, the alarm state is immediately set to INSUFFICIENT_DATA.
The alarm is then evaluated and its state is set appropriately. Any actions associated
with the new state are then executed.
When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm.
If you are an IAM user, you must have Amazon EC2 permissions for some alarm operations:
The
iam:CreateServiceLinkedRolepermission for all alarms with EC2 actionsThe
iam:CreateServiceLinkedRolepermissions to create an alarm with Systems Manager OpsItem or response plan actions.
The first time you create an alarm in the Amazon Web Services Management Console,
the CLI, or by using the PutMetricAlarm API, CloudWatch creates the necessary service-linked
role for you. The service-linked roles are called AWSServiceRoleForCloudWatchEvents
and AWSServiceRoleForCloudWatchAlarms_ActionSSM. For more information, see
Amazon
Web Services service-linked role.
Each PutMetricAlarm action has a maximum uncompressed payload of 120 KB.
Cross-account alarms
You can set an alarm on metrics in the current account, or in another account. To create a cross-account alarm that watches a metric in a different account, you must have completed the following pre-requisites:
The account where the metrics are located (the sharing account) must already have a sharing role named CloudWatch-CrossAccountSharingRole. If it does not already have this role, you must create it using the instructions in Set up a sharing account in Cross-account cross-Region CloudWatch console. The policy for that role must grant access to the ID of the account where you are creating the alarm.
The account where you are creating the alarm (the monitoring account) must already have a service-linked role named AWSServiceRoleForCloudWatchCrossAccount to allow CloudWatch to assume the sharing role in the sharing account. If it does not, you must create it following the directions in Set up a monitoring account in Cross-account cross-Region CloudWatch console.
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.CloudWatch.AmazonCloudWatchRequest
Amazon.CloudWatch.Model.PutMetricAlarmRequest
Namespace: Amazon.CloudWatch.Model
Assembly: AWSSDK.CloudWatch.dll
Version: 3.x.y.z
Syntax
public class PutMetricAlarmRequest : AmazonCloudWatchRequest IAmazonWebServiceRequest
The PutMetricAlarmRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
PutMetricAlarmRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
ActionsEnabled | System.Boolean |
Gets and sets the property ActionsEnabled.
Indicates whether actions should be executed during any changes to the alarm state.
The default is |
|
|
AlarmActions | System.Collections.Generic.List<System.String> |
Gets and sets the property AlarmActions.
The actions to execute when this alarm transitions to the EC2 actions:
Autoscaling action:
Lambda actions:
SNS notification action:
SSM integration actions:
|
|
|
AlarmDescription | System.String |
Gets and sets the property AlarmDescription. The description for the alarm. |
|
|
AlarmName | System.String |
Gets and sets the property AlarmName. The name for the alarm. This name must be unique within the Region. The name must contain only UTF-8 characters, and can't contain ASCII control characters |
|
|
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.
The values |
|
|
DatapointsToAlarm | System.Int32 |
Gets and sets the property DatapointsToAlarm. The number of data points that must be breaching to trigger the alarm. This is used only if you are setting an "M out of N" alarm. In that case, this value is the M. For more information, see Evaluating an Alarm in the Amazon CloudWatch User Guide. |
|
|
Dimensions | System.Collections.Generic.List<Amazon.CloudWatch.Model.Dimension> |
Gets and sets the property Dimensions.
The dimensions for the metric specified in |
|
|
EvaluateLowSampleCountPercentile | System.String |
Gets and sets the property EvaluateLowSampleCountPercentile.
Used only for alarms based on percentiles. If you specify
Valid Values: |
|
|
EvaluationPeriods | System.Int32 |
Gets and sets the property EvaluationPeriods. The number of periods over which data is compared to the specified threshold. If you are setting an alarm that requires that a number of consecutive data points be breaching to trigger the alarm, this value specifies that number. If you are setting an "M out of N" alarm, this value is the N.
An alarm's total current evaluation period can be no longer than one day, so this
number multiplied by |
|
|
ExtendedStatistic | System.String |
Gets and sets the property ExtendedStatistic.
The extended statistic for the metric specified in
If you specify
For more information about these extended statistics, see CloudWatch statistics definitions. |
|
|
InsufficientDataActions | System.Collections.Generic.List<System.String> |
Gets and sets the property InsufficientDataActions.
The actions to execute when this alarm transitions to the EC2 actions:
Autoscaling action:
Lambda actions:
SNS notification action:
SSM integration actions:
|
|
|
MetricName | System.String |
Gets and sets the property MetricName.
The name for the metric associated with the alarm. For each
If you are creating an alarm based on a math expression, you cannot specify this parameter,
or any of the |
|
|
Metrics | System.Collections.Generic.List<Amazon.CloudWatch.Model.MetricDataQuery> |
Gets and sets the property Metrics.
An array of
Each item in the
One item in the
If you use the |
|
|
Namespace | System.String |
Gets and sets the property Namespace.
The namespace for the metric associated specified in |
|
|
OKActions | System.Collections.Generic.List<System.String> |
Gets and sets the property OKActions.
The actions to execute when this alarm transitions to an EC2 actions:
Autoscaling action:
Lambda actions:
SNS notification action:
SSM integration actions:
|
|
|
Period | System.Int32 |
Gets and sets the property Period.
The length, in seconds, used each time the metric specified in
Be sure to specify 10 or 30 only for metrics that are stored by a
An alarm's total current evaluation period can be no longer than one day, so |
|
|
Statistic | Amazon.CloudWatch.Statistic |
Gets and sets the property Statistic.
The statistic for the metric specified in |
|
|
Tags | System.Collections.Generic.List<Amazon.CloudWatch.Model.Tag> |
Gets and sets the property Tags.
A list of key-value pairs to associate with the alarm. You can associate as many as
50 tags with an alarm. To be able to associate tags with the alarm when you create
the alarm, you must have the Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values. If you are using this operation to update an existing alarm, any tags you specify in this parameter are ignored. To change the tags of an existing alarm, use TagResource or UntagResource. |
|
|
Threshold | System.Double |
Gets and sets the property Threshold. The value against which the specified statistic is compared. This parameter is required for alarms based on static thresholds, but should not be used for alarms based on anomaly detection models. |
|
|
ThresholdMetricId | System.String |
Gets and sets the property ThresholdMetricId.
If this is an alarm based on an anomaly detection model, make this value match the
ID of the For an example of how to use this parameter, see the Anomaly Detection Model Alarm example on this page. If your alarm uses this parameter, it cannot have Auto Scaling actions. |
|
|
TreatMissingData | System.String |
Gets and sets the property TreatMissingData.
Sets how this alarm is to handle missing data points. If
Valid Values:
Alarms that evaluate metrics in the |
|
|
Unit | Amazon.CloudWatch.StandardUnit |
Gets and sets the property Unit.
The unit of measure for the statistic. 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. If you are creating
an alarm based on a metric math expression, you can specify the unit for each metric
(if needed) within the objects in the
If you don't specify However, if the metric is published with multiple types of units and you don't specify a unit, the alarm's behavior is not defined and it behaves unpredictably.
We recommend omitting |
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 Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5