Package-level declarations

Types

Link copied to clipboard
class AlarmModel : KotlinCustomResource

Represents an alarm model to monitor an ITE input attribute. You can use the alarm to get notified when the value is outside a specified range. For more information, see Create an alarm model in the Developer Guide.

Link copied to clipboard
data class AlarmModelArgs(val alarmCapabilities: Output<AlarmModelAlarmCapabilitiesArgs>? = null, val alarmEventActions: Output<AlarmModelAlarmEventActionsArgs>? = null, val alarmModelDescription: Output<String>? = null, val alarmModelName: Output<String>? = null, val alarmRule: Output<AlarmModelAlarmRuleArgs>? = null, val key: Output<String>? = null, val roleArn: Output<String>? = null, val severity: Output<Int>? = null, val tags: Output<List<TagArgs>>? = null) : ConvertibleToJava<AlarmModelArgs>

Represents an alarm model to monitor an ITE input attribute. You can use the alarm to get notified when the value is outside a specified range. For more information, see Create an alarm model in the Developer Guide.

Link copied to clipboard
Link copied to clipboard
object AlarmModelMapper : ResourceMapper<AlarmModel>
Link copied to clipboard
Link copied to clipboard
class DetectorModel : KotlinCustomResource

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 in the Developer Guide. When you successfully update a detector model (using the ITE console, ITE API or CLI commands, or CFN) all detector instances created by the model are reset to their initial states. (The detector's `state`, and the values of any variables and timers are reset.) When you successfully update a detector model (using the ITE console, ITE API or CLI commands, or CFN) the version number of the detector model is incremented. (A detector model with version number 1 before the update has version number 2 after the update succeeds.) If you attempt to update a detector model using CFN and the update does not succeed, the system may, in some cases, restore the original detector model. When this occurs, the detector model's version is incremented twice (for example, from version 1 to version 3) and the detector instances are reset. Also, be aware that if you attempt to update several detector models at once using CFN, some updates may succeed and others fail. In this case, the effects on each detector model's detector instances and version number depend on whether the update succeeded or failed, with the results as stated.

Link copied to clipboard
data class DetectorModelArgs(val detectorModelDefinition: Output<DetectorModelDefinitionArgs>? = null, val detectorModelDescription: Output<String>? = null, val detectorModelName: Output<String>? = null, val evaluationMethod: Output<DetectorModelEvaluationMethod>? = null, val key: Output<String>? = null, val roleArn: Output<String>? = null, val tags: Output<List<TagArgs>>? = null) : ConvertibleToJava<DetectorModelArgs>

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 in the Developer Guide. When you successfully update a detector model (using the ITE console, ITE API or CLI commands, or CFN) all detector instances created by the model are reset to their initial states. (The detector's `state`, and the values of any variables and timers are reset.) When you successfully update a detector model (using the ITE console, ITE API or CLI commands, or CFN) the version number of the detector model is incremented. (A detector model with version number 1 before the update has version number 2 after the update succeeds.) If you attempt to update a detector model using CFN and the update does not succeed, the system may, in some cases, restore the original detector model. When this occurs, the detector model's version is incremented twice (for example, from version 1 to version 3) and the detector instances are reset. Also, be aware that if you attempt to update several detector models at once using CFN, some updates may succeed and others fail. In this case, the effects on each detector model's detector instances and version number depend on whether the update succeeded or failed, with the results as stated.

Link copied to clipboard
Link copied to clipboard
object DetectorModelMapper : ResourceMapper<DetectorModel>
Link copied to clipboard
Link copied to clipboard
class Input : KotlinCustomResource

The AWS::IoTEvents::Input resource creates an input. To monitor your devices and processes, they must have a way to get telemetry data into ITE. This is done by sending messages as inputs to ITE. For more information, see How to Use in the Developer Guide.

Link copied to clipboard
data class InputArgs(val inputDefinition: Output<InputDefinitionArgs>? = null, val inputDescription: Output<String>? = null, val inputName: Output<String>? = null, val tags: Output<List<TagArgs>>? = null) : ConvertibleToJava<InputArgs>

The AWS::IoTEvents::Input resource creates an input. To monitor your devices and processes, they must have a way to get telemetry data into ITE. This is done by sending messages as inputs to ITE. For more information, see How to Use in the Developer Guide.

Link copied to clipboard

Builder for InputArgs.

Link copied to clipboard
object InputMapper : ResourceMapper<Input>
Link copied to clipboard

Builder for Input.

Link copied to clipboard

Functions

Link copied to clipboard
suspend fun alarmModel(name: String, block: suspend AlarmModelResourceBuilder.() -> Unit): AlarmModel
Link copied to clipboard
Link copied to clipboard
fun input(name: String): Input
suspend fun input(name: String, block: suspend InputResourceBuilder.() -> Unit): Input