com.pulumi.awsnative.lightsail.kotlin.AlarmArgs.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-aws-native-kotlin Show documentation
Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.
There is a newer version: 1.11.0.0
Show newest version
@file:Suppress("NAME_SHADOWING", "DEPRECATION")

package com.pulumi.awsnative.lightsail.kotlin

import com.pulumi.awsnative.lightsail.AlarmArgs.builder
import com.pulumi.core.Output
import com.pulumi.core.Output.of
import com.pulumi.kotlin.ConvertibleToJava
import com.pulumi.kotlin.PulumiTagMarker
import kotlin.Boolean
import kotlin.Double
import kotlin.Int
import kotlin.String
import kotlin.Suppress
import kotlin.collections.List
import kotlin.jvm.JvmName

/**
 * Resource Type definition for AWS::Lightsail::Alarm
 * @property alarmName The name for the alarm. Specify the name of an existing alarm to update, and overwrite the previous configuration of the alarm.
 * @property comparisonOperator The arithmetic operation to use when comparing the specified statistic to the threshold. The specified statistic value is used as the first operand.
 * @property contactProtocols The contact protocols to use for the alarm, such as Email, SMS (text messaging), or both.
 * @property datapointsToAlarm The number of data points that must be not within the specified threshold to trigger the alarm. If you are setting an "M out of N" alarm, this value (datapointsToAlarm) is the M.
 * @property evaluationPeriods The number of most recent periods over which data is compared to the specified threshold. If you are setting an "M out of N" alarm, this value (evaluationPeriods) is the N.
 * @property metricName The name of the metric to associate with the alarm.
 * @property monitoredResourceName The name of the Lightsail resource that the alarm monitors.
 * @property notificationEnabled Indicates whether the alarm is enabled. Notifications are enabled by default if you don't specify this parameter.
 * @property notificationTriggers The alarm states that trigger a notification.
 * @property threshold The value against which the specified statistic is compared.
 * @property treatMissingData Sets how this alarm will handle missing data points.
 */
public data class AlarmArgs(
    public val alarmName: Output? = null,
    public val comparisonOperator: Output? = null,
    public val contactProtocols: Output>? = null,
    public val datapointsToAlarm: Output? = null,
    public val evaluationPeriods: Output? = null,
    public val metricName: Output? = null,
    public val monitoredResourceName: Output? = null,
    public val notificationEnabled: Output? = null,
    public val notificationTriggers: Output>? = null,
    public val threshold: Output? = null,
    public val treatMissingData: Output? = null,
) : ConvertibleToJava {
    override fun toJava(): com.pulumi.awsnative.lightsail.AlarmArgs =
        com.pulumi.awsnative.lightsail.AlarmArgs.builder()
            .alarmName(alarmName?.applyValue({ args0 -> args0 }))
            .comparisonOperator(comparisonOperator?.applyValue({ args0 -> args0 }))
            .contactProtocols(contactProtocols?.applyValue({ args0 -> args0.map({ args0 -> args0 }) }))
            .datapointsToAlarm(datapointsToAlarm?.applyValue({ args0 -> args0 }))
            .evaluationPeriods(evaluationPeriods?.applyValue({ args0 -> args0 }))
            .metricName(metricName?.applyValue({ args0 -> args0 }))
            .monitoredResourceName(monitoredResourceName?.applyValue({ args0 -> args0 }))
            .notificationEnabled(notificationEnabled?.applyValue({ args0 -> args0 }))
            .notificationTriggers(notificationTriggers?.applyValue({ args0 -> args0.map({ args0 -> args0 }) }))
            .threshold(threshold?.applyValue({ args0 -> args0 }))
            .treatMissingData(treatMissingData?.applyValue({ args0 -> args0 })).build()
}

/**
 * Builder for [AlarmArgs].
 */
@PulumiTagMarker
public class AlarmArgsBuilder internal constructor() {
    private var alarmName: Output? = null

    private var comparisonOperator: Output? = null

    private var contactProtocols: Output>? = null

    private var datapointsToAlarm: Output? = null

    private var evaluationPeriods: Output? = null

    private var metricName: Output? = null

    private var monitoredResourceName: Output? = null

    private var notificationEnabled: Output? = null

    private var notificationTriggers: Output>? = null

    private var threshold: Output? = null

    private var treatMissingData: Output? = null

    /**
     * @param value The name for the alarm. Specify the name of an existing alarm to update, and overwrite the previous configuration of the alarm.
     */
    @JvmName("lonjmvyyrfvayqtr")
    public suspend fun alarmName(`value`: Output) {
        this.alarmName = value
    }

    /**
     * @param value The arithmetic operation to use when comparing the specified statistic to the threshold. The specified statistic value is used as the first operand.
     */
    @JvmName("irwgjyqnxuylftrq")
    public suspend fun comparisonOperator(`value`: Output) {
        this.comparisonOperator = value
    }

    /**
     * @param value The contact protocols to use for the alarm, such as Email, SMS (text messaging), or both.
     */
    @JvmName("qugjnarekncdthtd")
    public suspend fun contactProtocols(`value`: Output>) {
        this.contactProtocols = value
    }

    @JvmName("ydmhsaenajqibohm")
    public suspend fun contactProtocols(vararg values: Output) {
        this.contactProtocols = Output.all(values.asList())
    }

    /**
     * @param values The contact protocols to use for the alarm, such as Email, SMS (text messaging), or both.
     */
    @JvmName("shxssmpmugmqpnyb")
    public suspend fun contactProtocols(values: List>) {
        this.contactProtocols = Output.all(values)
    }

    /**
     * @param value The number of data points that must be not within the specified threshold to trigger the alarm. If you are setting an "M out of N" alarm, this value (datapointsToAlarm) is the M.
     */
    @JvmName("kxqsggvehjkbojls")
    public suspend fun datapointsToAlarm(`value`: Output) {
        this.datapointsToAlarm = value
    }

    /**
     * @param value The number of most recent periods over which data is compared to the specified threshold. If you are setting an "M out of N" alarm, this value (evaluationPeriods) is the N.
     */
    @JvmName("ujwhrwlcxjwwxqlh")
    public suspend fun evaluationPeriods(`value`: Output) {
        this.evaluationPeriods = value
    }

    /**
     * @param value The name of the metric to associate with the alarm.
     */
    @JvmName("txqqmcpgsewxxefs")
    public suspend fun metricName(`value`: Output) {
        this.metricName = value
    }

    /**
     * @param value The name of the Lightsail resource that the alarm monitors.
     */
    @JvmName("aseaeskpinykftur")
    public suspend fun monitoredResourceName(`value`: Output) {
        this.monitoredResourceName = value
    }

    /**
     * @param value Indicates whether the alarm is enabled. Notifications are enabled by default if you don't specify this parameter.
     */
    @JvmName("hmumpfdvvqnnblvm")
    public suspend fun notificationEnabled(`value`: Output) {
        this.notificationEnabled = value
    }

    /**
     * @param value The alarm states that trigger a notification.
     */
    @JvmName("sewtjbhblgepofuf")
    public suspend fun notificationTriggers(`value`: Output>) {
        this.notificationTriggers = value
    }

    @JvmName("hrjxsfgmdcxlgiqv")
    public suspend fun notificationTriggers(vararg values: Output) {
        this.notificationTriggers = Output.all(values.asList())
    }

    /**
     * @param values The alarm states that trigger a notification.
     */
    @JvmName("beghpmygqdnsbbsv")
    public suspend fun notificationTriggers(values: List>) {
        this.notificationTriggers = Output.all(values)
    }

    /**
     * @param value The value against which the specified statistic is compared.
     */
    @JvmName("llhallwnmxjhsktq")
    public suspend fun threshold(`value`: Output) {
        this.threshold = value
    }

    /**
     * @param value Sets how this alarm will handle missing data points.
     */
    @JvmName("qcjvrwpbxgvcxnho")
    public suspend fun treatMissingData(`value`: Output) {
        this.treatMissingData = value
    }

    /**
     * @param value The name for the alarm. Specify the name of an existing alarm to update, and overwrite the previous configuration of the alarm.
     */
    @JvmName("bkqtcjhuffjehvak")
    public suspend fun alarmName(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.alarmName = mapped
    }

    /**
     * @param value The arithmetic operation to use when comparing the specified statistic to the threshold. The specified statistic value is used as the first operand.
     */
    @JvmName("aurpybhxagvxnwnn")
    public suspend fun comparisonOperator(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.comparisonOperator = mapped
    }

    /**
     * @param value The contact protocols to use for the alarm, such as Email, SMS (text messaging), or both.
     */
    @JvmName("gkkaloujvebjpper")
    public suspend fun contactProtocols(`value`: List?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.contactProtocols = mapped
    }

    /**
     * @param values The contact protocols to use for the alarm, such as Email, SMS (text messaging), or both.
     */
    @JvmName("jsnqmsnvwpmwyhmt")
    public suspend fun contactProtocols(vararg values: String) {
        val toBeMapped = values.toList()
        val mapped = toBeMapped.let({ args0 -> of(args0) })
        this.contactProtocols = mapped
    }

    /**
     * @param value The number of data points that must be not within the specified threshold to trigger the alarm. If you are setting an "M out of N" alarm, this value (datapointsToAlarm) is the M.
     */
    @JvmName("cfokfdusagyebggs")
    public suspend fun datapointsToAlarm(`value`: Int?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.datapointsToAlarm = mapped
    }

    /**
     * @param value The number of most recent periods over which data is compared to the specified threshold. If you are setting an "M out of N" alarm, this value (evaluationPeriods) is the N.
     */
    @JvmName("bbeacqcdwnebyyes")
    public suspend fun evaluationPeriods(`value`: Int?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.evaluationPeriods = mapped
    }

    /**
     * @param value The name of the metric to associate with the alarm.
     */
    @JvmName("vebpfcjpdcxivlrs")
    public suspend fun metricName(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.metricName = mapped
    }

    /**
     * @param value The name of the Lightsail resource that the alarm monitors.
     */
    @JvmName("pfmvwmagngmxdipm")
    public suspend fun monitoredResourceName(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.monitoredResourceName = mapped
    }

    /**
     * @param value Indicates whether the alarm is enabled. Notifications are enabled by default if you don't specify this parameter.
     */
    @JvmName("fxqkvjjccugrqttu")
    public suspend fun notificationEnabled(`value`: Boolean?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.notificationEnabled = mapped
    }

    /**
     * @param value The alarm states that trigger a notification.
     */
    @JvmName("hwdbleqwsdnvkyyh")
    public suspend fun notificationTriggers(`value`: List?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.notificationTriggers = mapped
    }

    /**
     * @param values The alarm states that trigger a notification.
     */
    @JvmName("glhgwsitqwrkujrj")
    public suspend fun notificationTriggers(vararg values: String) {
        val toBeMapped = values.toList()
        val mapped = toBeMapped.let({ args0 -> of(args0) })
        this.notificationTriggers = mapped
    }

    /**
     * @param value The value against which the specified statistic is compared.
     */
    @JvmName("ndxvhqyyxxggloty")
    public suspend fun threshold(`value`: Double?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.threshold = mapped
    }

    /**
     * @param value Sets how this alarm will handle missing data points.
     */
    @JvmName("vldtnavnikopifbw")
    public suspend fun treatMissingData(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.treatMissingData = mapped
    }

    internal fun build(): AlarmArgs = AlarmArgs(
        alarmName = alarmName,
        comparisonOperator = comparisonOperator,
        contactProtocols = contactProtocols,
        datapointsToAlarm = datapointsToAlarm,
        evaluationPeriods = evaluationPeriods,
        metricName = metricName,
        monitoredResourceName = monitoredResourceName,
        notificationEnabled = notificationEnabled,
        notificationTriggers = notificationTriggers,
        threshold = threshold,
        treatMissingData = treatMissingData,
    )
}