You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::CloudWatch::Types::PutMetricAlarmInput

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing PutMetricAlarmInput as input to an Aws::Client method, you can use a vanilla Hash:

{
  alarm_name: "AlarmName", # required
  alarm_description: "AlarmDescription",
  actions_enabled: false,
  ok_actions: ["ResourceName"],
  alarm_actions: ["ResourceName"],
  insufficient_data_actions: ["ResourceName"],
  metric_name: "MetricName", # required
  namespace: "Namespace", # required
  statistic: "SampleCount", # accepts SampleCount, Average, Sum, Minimum, Maximum
  extended_statistic: "ExtendedStatistic",
  dimensions: [
    {
      name: "DimensionName", # required
      value: "DimensionValue", # required
    },
  ],
  period: 1, # 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
  evaluation_periods: 1, # required
  threshold: 1.0, # required
  comparison_operator: "GreaterThanOrEqualToThreshold", # required, accepts GreaterThanOrEqualToThreshold, GreaterThanThreshold, LessThanThreshold, LessThanOrEqualToThreshold
  treat_missing_data: "TreatMissingData",
  evaluate_low_sample_count_percentile: "EvaluateLowSampleCountPercentile",
}

Instance Attribute Summary collapse

Instance Attribute Details

#actions_enabledBoolean

Indicates whether actions should be executed during any changes to the alarm state.

Returns:

  • (Boolean)

    Indicates whether actions should be executed during any changes to the alarm state.

#alarm_actionsArray<String>

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

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

Returns:

  • (Array<String>)

    The actions to execute when this alarm transitions to the ALARM state from any other state.

#alarm_descriptionString

The description for the alarm.

Returns:

  • (String)

    The description for the alarm.

#alarm_nameString

The name for the alarm. This name must be unique within the AWS account.

Returns:

  • (String)

    The name for the alarm.

#comparison_operatorString

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

Possible values:

  • GreaterThanOrEqualToThreshold
  • GreaterThanThreshold
  • LessThanThreshold
  • LessThanOrEqualToThreshold

Returns:

  • (String)

    The arithmetic operation to use when comparing the specified statistic and threshold.

#dimensionsArray<Types::Dimension>

The dimensions for the metric associated with the alarm.

Returns:

  • (Array<Types::Dimension>)

    The dimensions for the metric associated with the alarm.

#evaluate_low_sample_count_percentileString

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.

Valid Values: evaluate | ignore

Returns:

  • (String)

    Used only for alarms based on percentiles.

#evaluation_periodsInteger

The number of periods over which data is compared to the specified threshold. 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.

Returns:

  • (Integer)

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

#extended_statisticString

The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.

Returns:

  • (String)

    The percentile statistic for the metric associated with the alarm.

#insufficient_data_actionsArray<String>

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

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

Returns:

  • (Array<String>)

    The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state.

#metric_nameString

The name for the metric associated with the alarm.

Returns:

  • (String)

    The name for the metric associated with the alarm.

#namespaceString

The namespace for the metric associated with the alarm.

Returns:

  • (String)

    The namespace for the metric associated with the alarm.

#ok_actionsArray<String>

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

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

Returns:

  • (Array<String>)

    The actions to execute when this alarm transitions to an OK state from any other state.

#periodInteger

The period, in seconds, over which the specified statistic is applied. Valid values are 10, 30, and any multiple of 60.

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

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.

Returns:

  • (Integer)

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

#statisticString

The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use ExtendedStatistic.

Possible values:

  • SampleCount
  • Average
  • Sum
  • Minimum
  • Maximum

Returns:

  • (String)

    The statistic for the metric associated with the alarm, other than percentile.

#thresholdFloat

The value against which the specified statistic is compared.

Returns:

  • (Float)

    The value against which the specified statistic is compared.

#treat_missing_dataString

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.

Valid Values: breaching | notBreaching | ignore | missing

Returns:

  • (String)

    Sets how this alarm is to handle missing data points.

#unitString

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 specify a unit, you must use a unit that is appropriate for the metric. Otherwise, the CloudWatch alarm can get stuck in the INSUFFICIENT DATA state.

Possible values:

  • 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

Returns:

  • (String)

    The unit of measure for the statistic.