cloudwatch/aws.sdk.kotlin.services.cloudwatch.model/PutMetricAlarmRequest/Builder

Builder

Properties

Indicates whether actions should be executed during any changes to the alarm state. The default is TRUE.

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:

alarmDescription

var alarmDescription: String?

The description for the alarm.

alarmName

var alarmName: String?

The name for the alarm. This name must be unique within the Region.

comparisonOperator

var comparisonOperator: ComparisonOperator?

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

datapointsToAlarm

var datapointsToAlarm: Int?

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

var dimensions: List<Dimension>?

The dimensions for the metric specified in MetricName.

evaluateLowSampleCountPercentile

var evaluateLowSampleCountPercentile: String?

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.

evaluationPeriods

var evaluationPeriods: Int?

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.

extendedStatistic

var extendedStatistic: String?

The extended statistic for the metric specified in MetricName. When you call PutMetricAlarm and specify a MetricName, you must specify either Statistic or ExtendedStatistic but not both.

insufficientDataActions

var insufficientDataActions: List<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:

metricName

var metricName: String?

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

metrics

var metrics: List<MetricDataQuery>?

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.

namespace

var namespace: String?

The namespace for the metric associated specified in MetricName.

okActions

var okActions: List<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:

period

var period: Int?

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

statistic

var statistic: 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.

tags

var tags: List<Tag>?

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 cloudwatch:TagResource permission.

threshold

var threshold: Double?

The value against which the specified statistic is compared.

thresholdMetricId

var thresholdMetricId: String?

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

treatMissingData

var treatMissingData: String?

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.

unit

var unit: StandardUnit?

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 Metrics array.