class Aws::CloudWatch::Types::PutMetricAlarmInput

@note When making an API call, you may pass PutMetricAlarmInput

data as a hash:

    {
      alarm_name: "AlarmName", # required
      alarm_description: "AlarmDescription",
      actions_enabled: false,
      ok_actions: ["ResourceName"],
      alarm_actions: ["ResourceName"],
      insufficient_data_actions: ["ResourceName"],
      metric_name: "MetricName",
      namespace: "Namespace",
      statistic: "SampleCount", # accepts SampleCount, Average, Sum, Minimum, Maximum
      extended_statistic: "ExtendedStatistic",
      dimensions: [
        {
          name: "DimensionName", # required
          value: "DimensionValue", # required
        },
      ],
      period: 1,
      unit: "Seconds", # accepts Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None
      evaluation_periods: 1, # required
      datapoints_to_alarm: 1,
      threshold: 1.0,
      comparison_operator: "GreaterThanOrEqualToThreshold", # required, accepts GreaterThanOrEqualToThreshold, GreaterThanThreshold, LessThanThreshold, LessThanOrEqualToThreshold, LessThanLowerOrGreaterThanUpperThreshold, LessThanLowerThreshold, GreaterThanUpperThreshold
      treat_missing_data: "TreatMissingData",
      evaluate_low_sample_count_percentile: "EvaluateLowSampleCountPercentile",
      metrics: [
        {
          id: "MetricId", # required
          metric_stat: {
            metric: { # required
              namespace: "Namespace",
              metric_name: "MetricName",
              dimensions: [
                {
                  name: "DimensionName", # required
                  value: "DimensionValue", # required
                },
              ],
            },
            period: 1, # required
            stat: "Stat", # required
            unit: "Seconds", # accepts Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None
          },
          expression: "MetricExpression",
          label: "MetricLabel",
          return_data: false,
          period: 1,
          account_id: "AccountId",
        },
      ],
      tags: [
        {
          key: "TagKey", # required
          value: "TagValue", # required
        },
      ],
      threshold_metric_id: "MetricId",
    }

@!attribute [rw] alarm_name

The name for the alarm. This name must be unique within the Region.
@return [String]

@!attribute [rw] alarm_description

The description for the alarm.
@return [String]

@!attribute [rw] actions_enabled

Indicates whether actions should be executed during any changes to
the alarm state. The default is `TRUE`.
@return [Boolean]

@!attribute [rw] ok_actions

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

Valid Values: `arn:aws:automate:region:ec2:stop` \|
`arn:aws:automate:region:ec2:terminate` \|
`arn:aws:automate:region:ec2:recover` \|
`arn:aws:automate:region:ec2:reboot` \|
`arn:aws:sns:region:account-id:sns-topic-name ` \|
`arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name
`

Valid Values (for use with IAM roles):
`arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0`
\|
`arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0`
\|
`arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0`
\|
`arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Recover/1.0`
@return [Array<String>]

@!attribute [rw] alarm_actions

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

Valid Values: `arn:aws:automate:region:ec2:stop` \|
`arn:aws:automate:region:ec2:terminate` \|
`arn:aws:automate:region:ec2:recover` \|
`arn:aws:automate:region:ec2:reboot` \|
`arn:aws:sns:region:account-id:sns-topic-name ` \|
`arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name
` \| `arn:aws:ssm:region:account-id:opsitem:severity ` \|
`arn:aws:ssm-incidents::account-id:response-plan:response-plan-name
`

Valid Values (for use with IAM roles):
`arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0`
\|
`arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0`
\|
`arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0`
\|
`arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Recover/1.0`
@return [Array<String>]

@!attribute [rw] insufficient_data_actions

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

Valid Values: `arn:aws:automate:region:ec2:stop` \|
`arn:aws:automate:region:ec2:terminate` \|
`arn:aws:automate:region:ec2:recover` \|
`arn:aws:automate:region:ec2:reboot` \|
`arn:aws:sns:region:account-id:sns-topic-name ` \|
`arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name
`

Valid Values (for use with IAM roles):
`>arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0`
\|
`arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0`
\|
`arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0`
@return [Array<String>]

@!attribute [rw] metric_name

The name for the metric associated with the alarm. For each
`PutMetricAlarm` operation, you must specify either `MetricName` or
a `Metrics` array.

If you are creating an alarm based on a math expression, you cannot
specify this parameter, or any of the `Dimensions`, `Period`,
`Namespace`, `Statistic`, or `ExtendedStatistic` parameters.
Instead, you specify all this information in the `Metrics` array.
@return [String]

@!attribute [rw] namespace

The namespace for the metric associated specified in `MetricName`.
@return [String]

@!attribute [rw] statistic

The statistic for the metric specified in `MetricName`, other than
percentile. For percentile statistics, use `ExtendedStatistic`. When
you call `PutMetricAlarm` and specify a `MetricName`, you must
specify either `Statistic` or `ExtendedStatistic,` but not both.
@return [String]

@!attribute [rw] extended_statistic

The percentile statistic for the metric specified in `MetricName`.
Specify a value between p0.0 and p100. When you call
`PutMetricAlarm` and specify a `MetricName`, you must specify either
`Statistic` or `ExtendedStatistic,` but not both.
@return [String]

@!attribute [rw] dimensions

The dimensions for the metric specified in `MetricName`.
@return [Array<Types::Dimension>]

@!attribute [rw] period

The length, in seconds, used each time the metric specified in
`MetricName` is evaluated. Valid values are 10, 30, and any multiple
of 60.

`Period` is required for alarms based on static thresholds. If you
are creating an alarm based on a metric math expression, you specify
the period for each metric within the objects in the `Metrics`
array.

Be sure to specify 10 or 30 only for metrics that are stored by a
`PutMetricData` call with a `StorageResolution` of 1. If you specify
a period of 10 or 30 for a metric that does not have sub-minute
resolution, the alarm still attempts to gather data at the period
rate that you specify. In this case, it does not receive data for
the attempts that do not correspond to a one-minute data resolution,
and the alarm might often lapse into INSUFFICENT\_DATA status.
Specifying 10 or 30 also sets this alarm as a high-resolution alarm,
which has a higher charge than other alarms. For more information
about pricing, see [Amazon CloudWatch Pricing][1].

An alarm's total current evaluation period can be no longer than
one day, so `Period` multiplied by `EvaluationPeriods` cannot be
more than 86,400 seconds.

[1]: https://aws.amazon.com/cloudwatch/pricing/
@return [Integer]

@!attribute [rw] 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 don't specify `Unit`, CloudWatch retrieves all unit types
that have been published for the metric and attempts to evaluate the
alarm. Usually, metrics are published with only one unit, so the
alarm works as intended.

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 predictably.

We recommend omitting `Unit` so that you don't inadvertently
specify an incorrect unit that is not published for this metric.
Doing so causes the alarm to be stuck in the `INSUFFICIENT DATA`
state.
@return [String]

@!attribute [rw] evaluation_periods

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 `Period` cannot be more than
86,400 seconds.
@return [Integer]

@!attribute [rw] datapoints_to_alarm

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][1] in the *Amazon CloudWatch User Guide*.

[1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarm-evaluation
@return [Integer]

@!attribute [rw] 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.
@return [Float]

@!attribute [rw] comparison_operator

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

The values `LessThanLowerOrGreaterThanUpperThreshold`,
`LessThanLowerThreshold`, and `GreaterThanUpperThreshold` are used
only for alarms based on anomaly detection models.
@return [String]

@!attribute [rw] treat_missing_data

Sets how this alarm is to handle missing data points. If
`TreatMissingData` is omitted, the default behavior of `missing` is
used. For more information, see [Configuring How CloudWatch Alarms
Treats Missing Data][1].

Valid Values: `breaching | notBreaching | ignore | missing`

[1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarms-and-missing-data
@return [String]

@!attribute [rw] evaluate_low_sample_count_percentile

Used only for alarms based on percentiles. If you specify `ignore`,
the alarm state does not change during periods with too few data
points to be statistically significant. If you specify `evaluate` or
omit this parameter, the alarm is always evaluated and possibly
changes state no matter how many data points are available. For more
information, see [Percentile-Based CloudWatch Alarms and Low Data
Samples][1].

Valid Values: `evaluate | ignore`

[1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#percentiles-with-low-samples
@return [String]

@!attribute [rw] metrics

An array of `MetricDataQuery` structures that enable you to create
an alarm based on the result of a metric math expression. For each
`PutMetricAlarm` operation, you must specify either `MetricName` or
a `Metrics` array.

Each item in the `Metrics` array either retrieves a metric or
performs a math expression.

One item in the `Metrics` array is the expression that the alarm
watches. You designate this expression by setting `ReturnData` to
true for this object in the array. For more information, see
[MetricDataQuery][1].

If you use the `Metrics` parameter, you cannot include the
`MetricName`, `Dimensions`, `Period`, `Namespace`, `Statistic`, or
`ExtendedStatistic` parameters of `PutMetricAlarm` in the same
operation. Instead, you retrieve the metrics you are using in your
math expression as part of the `Metrics` array.

[1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDataQuery.html
@return [Array<Types::MetricDataQuery>]

@!attribute [rw] tags

A list of key-value pairs to associate with the alarm. You can
associate as many as 50 tags with an alarm.

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][1] or [UntagResource][2].

[1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_TagResource.html
[2]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_UntagResource.html
@return [Array<Types::Tag>]

@!attribute [rw] threshold_metric_id

If this is an alarm based on an anomaly detection model, make this
value match the ID of the `ANOMALY_DETECTION_BAND` function.

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.
@return [String]

@see docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/PutMetricAlarmInput AWS API Documentation

Constants

SENSITIVE