View source: R/cloudwatch_operations.R
cloudwatch_put_metric_alarm | R Documentation |
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.
See https://www.paws-r-sdk.com/docs/cloudwatch_put_metric_alarm/ for full documentation.
cloudwatch_put_metric_alarm(
AlarmName,
AlarmDescription = NULL,
ActionsEnabled = NULL,
OKActions = NULL,
AlarmActions = NULL,
InsufficientDataActions = NULL,
MetricName = NULL,
Namespace = NULL,
Statistic = NULL,
ExtendedStatistic = NULL,
Dimensions = NULL,
Period = NULL,
Unit = NULL,
EvaluationPeriods,
DatapointsToAlarm = NULL,
Threshold = NULL,
ComparisonOperator,
TreatMissingData = NULL,
EvaluateLowSampleCountPercentile = NULL,
Metrics = NULL,
Tags = NULL,
ThresholdMetricId = NULL
)
AlarmName |
[required] 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 |
AlarmDescription |
The description for the alarm. |
ActionsEnabled |
Indicates whether actions should be executed during any changes to the
alarm state. The default is |
OKActions |
The actions to execute when this alarm transitions to an EC2 actions:
Autoscaling action:
Lambda actions:
SNS notification action:
SSM integration actions:
|
AlarmActions |
The actions to execute when this alarm transitions to the EC2 actions:
Autoscaling action:
Lambda actions:
SNS notification action:
SSM integration actions:
|
InsufficientDataActions |
The actions to execute when this alarm transitions to the
EC2 actions:
Autoscaling action:
Lambda actions:
SNS notification action:
SSM integration actions:
|
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 |
Namespace |
The namespace for the metric associated specified in |
Statistic |
The statistic for the metric specified in |
ExtendedStatistic |
The extended statistic for the metric specified in If you specify
For more information about these extended statistics, see CloudWatch statistics definitions. |
Dimensions |
The dimensions for the metric specified in |
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 |
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 |
EvaluationPeriods |
[required] 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 |
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. |
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. |
ComparisonOperator |
[required] The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand. The values |
TreatMissingData |
Sets how this alarm is to handle missing data points. If
Valid Values: Alarms that evaluate metrics in the |
EvaluateLowSampleCountPercentile |
Used only for alarms based on percentiles. If you specify Valid Values: |
Metrics |
An array of Each item in the One item in the If you use the |
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 |
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. |
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.