com.pulumi.awsnative.cloudwatch.kotlin.outputs.GetAlarmResult.kt Maven / Gradle / Ivy
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.awsnative.cloudwatch.kotlin.outputs
import com.pulumi.awsnative.kotlin.outputs.Tag
import kotlin.Boolean
import kotlin.Double
import kotlin.Int
import kotlin.String
import kotlin.Suppress
import kotlin.collections.List
/**
*
* @property actionsEnabled Indicates whether actions should be executed during any changes to the alarm state. The default is TRUE.
* @property alarmActions The list of actions to execute when this alarm transitions into an ALARM state from any other state. Specify each action as an Amazon Resource Name (ARN). For more information about creating alarms and the actions that you can specify, see [PutMetricAlarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_PutMetricAlarm.html) in the *API Reference*.
* @property alarmDescription The description of the alarm.
* @property arn The ARN of the CloudWatch alarm, such as `arn:aws:cloudwatch:us-west-2:123456789012:alarm:myCloudWatchAlarm-CPUAlarm-UXMMZK36R55Z` .
* @property comparisonOperator The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand.
* @property datapointsToAlarm The number of datapoints 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, and the value that you set for ``EvaluationPeriods`` is the N value. For more information, see [Evaluating an Alarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarm-evaluation) in the *User Guide*.
* If you omit this parameter, CW uses the same value here that you set for ``EvaluationPeriods``, and the alarm goes to alarm state if that many consecutive periods are breaching.
* @property dimensions 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``.
* @property evaluateLowSampleCountPercentile Used only for alarms based on percentiles. If ``ignore``, the alarm state does not change during periods with too few data points to be statistically significant. If ``evaluate`` or this parameter is not used, the alarm is always evaluated and possibly changes state no matter how many data points are available.
* @property evaluationPeriods 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, and ``DatapointsToAlarm`` is the M.
* For more information, see [Evaluating an Alarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarm-evaluation) in the *User Guide*.
* @property extendedStatistic The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.
* For an alarm based on a metric, you must specify either ``Statistic`` or ``ExtendedStatistic`` but not both.
* For an alarm based on a math expression, you can't specify ``ExtendedStatistic``. Instead, you use ``Metrics``.
* @property insufficientDataActions 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).
* @property metricName The name of the metric associated with the alarm. This is required for an alarm based on a metric. For an alarm based on a math expression, you use ``Metrics`` instead and you can't specify ``MetricName``.
* @property metrics An array that enables you to create an alarm based on the result of a metric math expression. Each item in the array either retrieves a metric or performs a math expression.
* If you specify the ``Metrics`` parameter, you cannot specify ``MetricName``, ``Dimensions``, ``Period``, ``Namespace``, ``Statistic``, ``ExtendedStatistic``, or ``Unit``.
* @property namespace The namespace of the metric associated with the alarm. This is required for an alarm based on a metric. For an alarm based on a math expression, you can't specify ``Namespace`` and you use ``Metrics`` instead.
* For a list of namespaces for metrics from AWS services, see [Services That Publish Metrics.](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html)
* @property okActions The actions to execute when this alarm transitions to the ``OK`` state from any other state. Each action is specified as an Amazon Resource Name (ARN).
* @property period The period, in seconds, over which the statistic is applied. This is required for an alarm based on a metric. Valid values are 10, 30, 60, and any multiple of 60.
* For an alarm based on a math expression, you can't specify ``Period``, and instead you use the ``Metrics`` parameter.
* *Minimum:* 10
* @property statistic The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use ``ExtendedStatistic``.
* For an alarm based on a metric, you must specify either ``Statistic`` or ``ExtendedStatistic`` but not both.
* For an alarm based on a math expression, you can't specify ``Statistic``. Instead, you use ``Metrics``.
* @property 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 ``cloudwatch:TagResource`` permission.
* 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.
* @property threshold The value to compare with the specified statistic.
* @property thresholdMetricId 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.
* @property treatMissingData Sets how this alarm is to handle missing data points. Valid values are ``breaching``, ``notBreaching``, ``ignore``, and ``missing``. For more information, see [Configuring How Alarms Treat Missing Data](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarms-and-missing-data) in the *Amazon User Guide*.
* If you omit this parameter, the default behavior of ``missing`` is used.
* @property unit The unit of the metric associated with the alarm. Specify this only if you are creating an alarm based on a single metric. Do not specify this if you are specifying a ``Metrics`` array.
* You can specify the following 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, or None.
*/
public data class GetAlarmResult(
public val actionsEnabled: Boolean? = null,
public val alarmActions: List? = null,
public val alarmDescription: String? = null,
public val arn: String? = null,
public val comparisonOperator: String? = null,
public val datapointsToAlarm: Int? = null,
public val dimensions: List? = null,
public val evaluateLowSampleCountPercentile: String? = null,
public val evaluationPeriods: Int? = null,
public val extendedStatistic: String? = null,
public val insufficientDataActions: List? = null,
public val metricName: String? = null,
public val metrics: List? = null,
public val namespace: String? = null,
public val okActions: List? = null,
public val period: Int? = null,
public val statistic: String? = null,
public val tags: List? = null,
public val threshold: Double? = null,
public val thresholdMetricId: String? = null,
public val treatMissingData: String? = null,
public val unit: String? = null,
) {
public companion object {
public fun toKotlin(javaType: com.pulumi.awsnative.cloudwatch.outputs.GetAlarmResult): GetAlarmResult = GetAlarmResult(
actionsEnabled = javaType.actionsEnabled().map({ args0 -> args0 }).orElse(null),
alarmActions = javaType.alarmActions().map({ args0 -> args0 }),
alarmDescription = javaType.alarmDescription().map({ args0 -> args0 }).orElse(null),
arn = javaType.arn().map({ args0 -> args0 }).orElse(null),
comparisonOperator = javaType.comparisonOperator().map({ args0 -> args0 }).orElse(null),
datapointsToAlarm = javaType.datapointsToAlarm().map({ args0 -> args0 }).orElse(null),
dimensions = javaType.dimensions().map({ args0 ->
args0.let({ args0 ->
com.pulumi.awsnative.cloudwatch.kotlin.outputs.AlarmDimension.Companion.toKotlin(args0)
})
}),
evaluateLowSampleCountPercentile = javaType.evaluateLowSampleCountPercentile().map({ args0 ->
args0
}).orElse(null),
evaluationPeriods = javaType.evaluationPeriods().map({ args0 -> args0 }).orElse(null),
extendedStatistic = javaType.extendedStatistic().map({ args0 -> args0 }).orElse(null),
insufficientDataActions = javaType.insufficientDataActions().map({ args0 -> args0 }),
metricName = javaType.metricName().map({ args0 -> args0 }).orElse(null),
metrics = javaType.metrics().map({ args0 ->
args0.let({ args0 ->
com.pulumi.awsnative.cloudwatch.kotlin.outputs.AlarmMetricDataQuery.Companion.toKotlin(args0)
})
}),
namespace = javaType.namespace().map({ args0 -> args0 }).orElse(null),
okActions = javaType.okActions().map({ args0 -> args0 }),
period = javaType.period().map({ args0 -> args0 }).orElse(null),
statistic = javaType.statistic().map({ args0 -> args0 }).orElse(null),
tags = javaType.tags().map({ args0 ->
args0.let({ args0 ->
com.pulumi.awsnative.kotlin.outputs.Tag.Companion.toKotlin(args0)
})
}),
threshold = javaType.threshold().map({ args0 -> args0 }).orElse(null),
thresholdMetricId = javaType.thresholdMetricId().map({ args0 -> args0 }).orElse(null),
treatMissingData = javaType.treatMissingData().map({ args0 -> args0 }).orElse(null),
unit = javaType.unit().map({ args0 -> args0 }).orElse(null),
)
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy