com.pulumi.awsnative.iotevents.kotlin.IoteventsFunctions.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: 0.122.0.0
Show newest version
@file:Suppress("NAME_SHADOWING", "DEPRECATION")

package com.pulumi.awsnative.iotevents.kotlin

import com.pulumi.awsnative.iotevents.IoteventsFunctions.getAlarmModelPlain
import com.pulumi.awsnative.iotevents.IoteventsFunctions.getDetectorModelPlain
import com.pulumi.awsnative.iotevents.IoteventsFunctions.getInputPlain
import com.pulumi.awsnative.iotevents.kotlin.inputs.GetAlarmModelPlainArgs
import com.pulumi.awsnative.iotevents.kotlin.inputs.GetAlarmModelPlainArgsBuilder
import com.pulumi.awsnative.iotevents.kotlin.inputs.GetDetectorModelPlainArgs
import com.pulumi.awsnative.iotevents.kotlin.inputs.GetDetectorModelPlainArgsBuilder
import com.pulumi.awsnative.iotevents.kotlin.inputs.GetInputPlainArgs
import com.pulumi.awsnative.iotevents.kotlin.inputs.GetInputPlainArgsBuilder
import com.pulumi.awsnative.iotevents.kotlin.outputs.GetAlarmModelResult
import com.pulumi.awsnative.iotevents.kotlin.outputs.GetDetectorModelResult
import com.pulumi.awsnative.iotevents.kotlin.outputs.GetInputResult
import kotlinx.coroutines.future.await
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import com.pulumi.awsnative.iotevents.kotlin.outputs.GetAlarmModelResult.Companion.toKotlin as getAlarmModelResultToKotlin
import com.pulumi.awsnative.iotevents.kotlin.outputs.GetDetectorModelResult.Companion.toKotlin as getDetectorModelResultToKotlin
import com.pulumi.awsnative.iotevents.kotlin.outputs.GetInputResult.Companion.toKotlin as getInputResultToKotlin

public object IoteventsFunctions {
    /**
     * The AWS::IoTEvents::AlarmModel resource creates a alarm model. AWS IoT Events alarms help you monitor your data for changes. The data can be metrics that you measure for your equipment and processes. You can create alarms that send notifications when a threshold is breached. Alarms help you detect issues, streamline maintenance, and optimize performance of your equipment and processes.
     * Alarms are instances of alarm models. The alarm model specifies what to detect, when to send notifications, who gets notified, and more. You can also specify one or more supported actions that occur when the alarm state changes. AWS IoT Events routes input attributes derived from your data to the appropriate alarms. If the data that you're monitoring is outside the specified range, the alarm is invoked. You can also acknowledge the alarms or set them to the snooze mode.
     * @param argument null
     * @return null
     */
    public suspend fun getAlarmModel(argument: GetAlarmModelPlainArgs): GetAlarmModelResult =
        getAlarmModelResultToKotlin(getAlarmModelPlain(argument.toJava()).await())

    /**
     * @see [getAlarmModel].
     * @param alarmModelName The name of the alarm model.
     * @return null
     */
    public suspend fun getAlarmModel(alarmModelName: String): GetAlarmModelResult {
        val argument = GetAlarmModelPlainArgs(
            alarmModelName = alarmModelName,
        )
        return getAlarmModelResultToKotlin(getAlarmModelPlain(argument.toJava()).await())
    }

    /**
     * @see [getAlarmModel].
     * @param argument Builder for [com.pulumi.awsnative.iotevents.kotlin.inputs.GetAlarmModelPlainArgs].
     * @return null
     */
    public suspend fun getAlarmModel(argument: suspend GetAlarmModelPlainArgsBuilder.() -> Unit): GetAlarmModelResult {
        val builder = GetAlarmModelPlainArgsBuilder()
        builder.argument()
        val builtArgument = builder.build()
        return getAlarmModelResultToKotlin(getAlarmModelPlain(builtArgument.toJava()).await())
    }

    /**
     * The AWS::IoTEvents::DetectorModel resource creates a detector model. You create a *detector model* (a model of your equipment or process) using *states*. For each state, you define conditional (Boolean) logic that evaluates the incoming inputs to detect significant events. When an event is detected, it can change the state or trigger custom-built or predefined actions using other AWS services. You can define additional events that trigger actions when entering or exiting a state and, optionally, when a condition is met. For more information, see [How to Use AWS IoT Events](https://docs.aws.amazon.com/iotevents/latest/developerguide/how-to-use-iotevents.html) in the *AWS IoT Events Developer Guide*.
     * @param argument null
     * @return null
     */
    public suspend fun getDetectorModel(argument: GetDetectorModelPlainArgs): GetDetectorModelResult =
        getDetectorModelResultToKotlin(getDetectorModelPlain(argument.toJava()).await())

    /**
     * @see [getDetectorModel].
     * @param detectorModelName The name of the detector model.
     * @return null
     */
    public suspend fun getDetectorModel(detectorModelName: String): GetDetectorModelResult {
        val argument = GetDetectorModelPlainArgs(
            detectorModelName = detectorModelName,
        )
        return getDetectorModelResultToKotlin(getDetectorModelPlain(argument.toJava()).await())
    }

    /**
     * @see [getDetectorModel].
     * @param argument Builder for [com.pulumi.awsnative.iotevents.kotlin.inputs.GetDetectorModelPlainArgs].
     * @return null
     */
    public suspend fun getDetectorModel(argument: suspend GetDetectorModelPlainArgsBuilder.() -> Unit): GetDetectorModelResult {
        val builder = GetDetectorModelPlainArgsBuilder()
        builder.argument()
        val builtArgument = builder.build()
        return getDetectorModelResultToKotlin(getDetectorModelPlain(builtArgument.toJava()).await())
    }

    /**
     * The AWS::IoTEvents::Input resource creates an input. To monitor your devices and processes, they must have a way to get telemetry data into AWS IoT Events. This is done by sending messages as *inputs* to AWS IoT Events. For more information, see [How to Use AWS IoT Events](https://docs.aws.amazon.com/iotevents/latest/developerguide/how-to-use-iotevents.html) in the *AWS IoT Events Developer Guide*.
     * @param argument null
     * @return null
     */
    public suspend fun getInput(argument: GetInputPlainArgs): GetInputResult =
        getInputResultToKotlin(getInputPlain(argument.toJava()).await())

    /**
     * @see [getInput].
     * @param inputName The name of the input.
     * @return null
     */
    public suspend fun getInput(inputName: String): GetInputResult {
        val argument = GetInputPlainArgs(
            inputName = inputName,
        )
        return getInputResultToKotlin(getInputPlain(argument.toJava()).await())
    }

    /**
     * @see [getInput].
     * @param argument Builder for [com.pulumi.awsnative.iotevents.kotlin.inputs.GetInputPlainArgs].
     * @return null
     */
    public suspend fun getInput(argument: suspend GetInputPlainArgsBuilder.() -> Unit): GetInputResult {
        val builder = GetInputPlainArgsBuilder()
        builder.argument()
        val builtArgument = builder.build()
        return getInputResultToKotlin(getInputPlain(builtArgument.toJava()).await())
    }
}