pulumi-aws-native-kotlin/com.pulumi.awsnative.cloudwatch.kotlin.outputs/GetAlarmResult

GetAlarmResult

data class GetAlarmResult(val actionsEnabled: Boolean? = null, val alarmActions: List<String>? = null, val alarmDescription: String? = null, val arn: String? = null, val comparisonOperator: String? = null, val datapointsToAlarm: Int? = null, val dimensions: List<AlarmDimension>? = null, val evaluateLowSampleCountPercentile: String? = null, val evaluationPeriods: Int? = null, val extendedStatistic: String? = null, val insufficientDataActions: List<String>? = null, val metricName: String? = null, val metrics: List<AlarmMetricDataQuery>? = null, val namespace: String? = null, val okActions: List<String>? = null, val period: Int? = null, val statistic: String? = null, val threshold: Double? = null, val thresholdMetricId: String? = null, val treatMissingData: String? = null, val unit: String? = null)

Constructors

Link copied to clipboard
fun GetAlarmResult(actionsEnabled: Boolean? = null, alarmActions: List<String>? = null, alarmDescription: String? = null, arn: String? = null, comparisonOperator: String? = null, datapointsToAlarm: Int? = null, dimensions: List<AlarmDimension>? = null, evaluateLowSampleCountPercentile: String? = null, evaluationPeriods: Int? = null, extendedStatistic: String? = null, insufficientDataActions: List<String>? = null, metricName: String? = null, metrics: List<AlarmMetricDataQuery>? = null, namespace: String? = null, okActions: List<String>? = null, period: Int? = null, statistic: String? = null, threshold: Double? = null, thresholdMetricId: String? = null, treatMissingData: String? = null, unit: String? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val actionsEnabled: Boolean? = null

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

Link copied to clipboard
val alarmActions: List<String>? = null

The list of actions to execute when this alarm transitions into an ALARM state from any other state.

Link copied to clipboard
val alarmDescription: String? = null

The description of the alarm.

Link copied to clipboard
val arn: String? = null

Amazon Resource Name is a unique name for each resource.

Link copied to clipboard
val comparisonOperator: String? = null

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

Link copied to clipboard
val datapointsToAlarm: Int? = null

The number of datapoints that must be breaching to trigger the alarm.

Link copied to clipboard
val dimensions: List<AlarmDimension>? = null

The dimensions for the metric associated with the alarm. For an alarm based on a math expression, you can't specify Dimensions. Instead, you use Metrics.

Link copied to clipboard
val evaluateLowSampleCountPercentile: String? = null

Used only for alarms based on percentiles.

Link copied to clipboard
val evaluationPeriods: Int? = null

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

Link copied to clipboard
val extendedStatistic: String? = null

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

Link copied to clipboard
val insufficientDataActions: List<String>? = null

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

Link copied to clipboard
val metricName: String? = null

The name of the metric associated with the alarm.

Link copied to clipboard
val metrics: List<AlarmMetricDataQuery>? = null

An array that enables you to create an alarm based on the result of a metric math expression.

Link copied to clipboard
val namespace: String? = null

The namespace of the metric associated with the alarm.

Link copied to clipboard
val okActions: List<String>? = null

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

Link copied to clipboard
val period: Int? = null

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

Link copied to clipboard
val statistic: String? = null

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

Link copied to clipboard
val threshold: Double? = null

In an alarm based on an anomaly detection model, this is the ID of the ANOMALY_DETECTION_BAND function used as the threshold for the alarm.

Link copied to clipboard
val thresholdMetricId: String? = null

In an alarm based on an anomaly detection model, this is the ID of the ANOMALY_DETECTION_BAND function used as the threshold for the alarm.

Link copied to clipboard
val treatMissingData: String? = null

Sets how this alarm is to handle missing data points. Valid values are breaching, notBreaching, ignore, and missing.

Link copied to clipboard
val unit: String? = null

The unit of the metric associated with the alarm.