pulumi-aws-native-kotlin/com.pulumi.awsnative.iotevents.kotlin.outputs

Package-level declarations

Types

data class AlarmModelAcknowledgeFlow(val enabled: Boolean? = null)

Specifies whether to get notified for alarm state changes.

data class AlarmModelAlarmAction(val dynamoDBv2: AlarmModelDynamoDBv2? = null, val dynamoDb: AlarmModelDynamoDb? = null, val firehose: AlarmModelFirehose? = null, val iotEvents: AlarmModelIotEvents? = null, val iotSiteWise: AlarmModelIotSiteWise? = null, val iotTopicPublish: AlarmModelIotTopicPublish? = null, val lambda: AlarmModelLambda? = null, val sns: AlarmModelSns? = null, val sqs: AlarmModelSqs? = null)

Specifies one of the following actions to receive notifications when the alarm state changes.

AlarmModelAlarmCapabilities

data class AlarmModelAlarmCapabilities(val acknowledgeFlow: AlarmModelAcknowledgeFlow? = null, val initializationConfiguration: AlarmModelInitializationConfiguration? = null)

Contains the configuration information of alarm state changes.

AlarmModelAlarmEventActions

data class AlarmModelAlarmEventActions(val alarmActions: List<AlarmModelAlarmAction>? = null)

Contains information about one or more alarm actions.

AlarmModelAlarmRule

data class AlarmModelAlarmRule(val simpleRule: AlarmModelSimpleRule? = null)

Defines when your alarm is invoked.

AlarmModelAssetPropertyTimestamp

data class AlarmModelAssetPropertyTimestamp(val offsetInNanos: String? = null, val timeInSeconds: String)

A structure that contains timestamp information. For more information, see TimeInNanos in the API Reference. You must use expressions for all parameters in `AssetPropertyTimestamp`. The expressions accept literals, operators, functions, references, and substitution templates. Examples

AlarmModelAssetPropertyValue

data class AlarmModelAssetPropertyValue(val quality: String? = null, val timestamp: AlarmModelAssetPropertyTimestamp? = null, val value: AlarmModelAssetPropertyVariant)

A structure that contains value information. For more information, see AssetPropertyValue in the API Reference. You must use expressions for all parameters in `AssetPropertyValue`. The expressions accept literals, operators, functions, references, and substitution templates. Examples

AlarmModelAssetPropertyVariant

data class AlarmModelAssetPropertyVariant(val booleanValue: String? = null, val doubleValue: String? = null, val integerValue: String? = null, val stringValue: String? = null)

A structure that contains an asset property value. For more information, see Variant in the API Reference. You must use expressions for all parameters in `AssetPropertyVariant`. The expressions accept literals, operators, functions, references, and substitution templates. Examples

AlarmModelDynamoDb

data class AlarmModelDynamoDb(val hashKeyField: String, val hashKeyType: String? = null, val hashKeyValue: String, val operation: String? = null, val payload: AlarmModelPayload? = null, val payloadField: String? = null, val rangeKeyField: String? = null, val rangeKeyType: String? = null, val rangeKeyValue: String? = null, val tableName: String)

Defines an action to write to the Amazon DynamoDB table that you created. The standard action payload contains all the information about the detector model instance and the event that triggered the action. You can customize the payload. One column of the DynamoDB table receives all attribute-value pairs in the payload that you specify. You must use expressions for all parameters in `DynamoDBAction`. The expressions accept literals, operators, functions, references, and substitution templates. Examples

AlarmModelDynamoDBv2

data class AlarmModelDynamoDBv2(val payload: AlarmModelPayload? = null, val tableName: String)

Defines an action to write to the Amazon DynamoDB table that you created. The default action payload contains all the information about the detector model instance and the event that triggered the action. You can customize the payload. A separate column of the DynamoDB table receives one attribute-value pair in the payload that you specify. You must use expressions for all parameters in `DynamoDBv2Action`. The expressions accept literals, operators, functions, references, and substitution templates. Examples

AlarmModelFirehose

data class AlarmModelFirehose(val deliveryStreamName: String, val payload: AlarmModelPayload? = null, val separator: String? = null)

Sends information about the detector model instance and the event that triggered the action to an Amazon Kinesis Data Firehose delivery stream.

AlarmModelInitializationConfiguration

data class AlarmModelInitializationConfiguration(val disabledOnInitialization: Boolean)

Specifies the default alarm state. The configuration applies to all alarms that were created based on this alarm model.

AlarmModelIotEvents

data class AlarmModelIotEvents(val inputName: String, val payload: AlarmModelPayload? = null)

Sends an ITE input, passing in information about the detector model instance and the event that triggered the action.

AlarmModelIotSiteWise

data class AlarmModelIotSiteWise(val assetId: String? = null, val entryId: String? = null, val propertyAlias: String? = null, val propertyId: String? = null, val propertyValue: AlarmModelAssetPropertyValue? = null)

Sends information about the detector model instance and the event that triggered the action to a specified asset property in ITSW. You must use expressions for all parameters in `IotSiteWiseAction`. The expressions accept literals, operators, functions, references, and substitutions templates. Examples

AlarmModelIotTopicPublish

data class AlarmModelIotTopicPublish(val mqttTopic: String, val payload: AlarmModelPayload? = null)

Information required to publish the MQTT message through the IoT message broker.

AlarmModelLambda

data class AlarmModelLambda(val functionArn: String, val payload: AlarmModelPayload? = null)

Calls a Lambda function, passing in information about the detector model instance and the event that triggered the action.

AlarmModelPayload

data class AlarmModelPayload(val contentExpression: String, val type: String)

Information needed to configure the payload. By default, ITE generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the detector model instance and the event triggered the action. To configure the action payload, you can use `contentExpression`.

AlarmModelSimpleRule

data class AlarmModelSimpleRule(val comparisonOperator: AlarmModelSimpleRuleComparisonOperator, val inputProperty: String, val threshold: String)

A rule that compares an input property value to a threshold value with a comparison operator.

AlarmModelSns

data class AlarmModelSns(val payload: AlarmModelPayload? = null, val targetArn: String)

Information required to publish the Amazon SNS message.

AlarmModelSqs

data class AlarmModelSqs(val payload: AlarmModelPayload? = null, val queueUrl: String, val useBase64: Boolean? = null)

Sends information about the detector model instance and the event that triggered the action to an Amazon SQS queue.

DetectorModelAction

data class DetectorModelAction(val clearTimer: DetectorModelClearTimer? = null, val dynamoDBv2: DetectorModelDynamoDBv2? = null, val dynamoDb: DetectorModelDynamoDb? = null, val firehose: DetectorModelFirehose? = null, val iotEvents: DetectorModelIotEvents? = null, val iotSiteWise: DetectorModelIotSiteWise? = null, val iotTopicPublish: DetectorModelIotTopicPublish? = null, val lambda: DetectorModelLambda? = null, val resetTimer: DetectorModelResetTimer? = null, val setTimer: DetectorModelSetTimer? = null, val setVariable: DetectorModelSetVariable? = null, val sns: DetectorModelSns? = null, val sqs: DetectorModelSqs? = null)

An action to be performed when the `condition` is TRUE.

DetectorModelAssetPropertyTimestamp

data class DetectorModelAssetPropertyTimestamp(val offsetInNanos: String? = null, val timeInSeconds: String)

DetectorModelAssetPropertyValue

data class DetectorModelAssetPropertyValue(val quality: String? = null, val timestamp: DetectorModelAssetPropertyTimestamp? = null, val value: DetectorModelAssetPropertyVariant)

DetectorModelAssetPropertyVariant

data class DetectorModelAssetPropertyVariant(val booleanValue: String? = null, val doubleValue: String? = null, val integerValue: String? = null, val stringValue: String? = null)

DetectorModelClearTimer

data class DetectorModelClearTimer(val timerName: String)

Information needed to clear the timer.

DetectorModelDefinition

data class DetectorModelDefinition(val initialStateName: String, val states: List<DetectorModelState>)

Information that defines how a detector operates.

DetectorModelDynamoDb

data class DetectorModelDynamoDb(val hashKeyField: String, val hashKeyType: String? = null, val hashKeyValue: String, val operation: String? = null, val payload: DetectorModelPayload? = null, val payloadField: String? = null, val rangeKeyField: String? = null, val rangeKeyType: String? = null, val rangeKeyValue: String? = null, val tableName: String)

DetectorModelDynamoDBv2

data class DetectorModelDynamoDBv2(val payload: DetectorModelPayload? = null, val tableName: String)

DetectorModelEvent

data class DetectorModelEvent(val actions: List<DetectorModelAction>? = null, val condition: String? = null, val eventName: String)

Specifies the `actions` to be performed when the `condition` evaluates to TRUE.

DetectorModelFirehose

data class DetectorModelFirehose(val deliveryStreamName: String, val payload: DetectorModelPayload? = null, val separator: String? = null)

Sends information about the detector model instance and the event that triggered the action to an Amazon Kinesis Data Firehose delivery stream.

DetectorModelIotEvents

data class DetectorModelIotEvents(val inputName: String, val payload: DetectorModelPayload? = null)

Sends an ITE input, passing in information about the detector model instance and the event that triggered the action.

DetectorModelIotSiteWise

data class DetectorModelIotSiteWise(val assetId: String? = null, val entryId: String? = null, val propertyAlias: String? = null, val propertyId: String? = null, val propertyValue: DetectorModelAssetPropertyValue)

DetectorModelIotTopicPublish

data class DetectorModelIotTopicPublish(val mqttTopic: String, val payload: DetectorModelPayload? = null)

Information required to publish the MQTT message through the IoT message broker.

DetectorModelLambda

data class DetectorModelLambda(val functionArn: String, val payload: DetectorModelPayload? = null)

Calls a Lambda function, passing in information about the detector model instance and the event that triggered the action.

DetectorModelOnEnter

data class DetectorModelOnEnter(val events: List<DetectorModelEvent>? = null)

When entering this state, perform these `actions` if the `condition` is TRUE.

DetectorModelOnExit

data class DetectorModelOnExit(val events: List<DetectorModelEvent>? = null)

When exiting this state, perform these `actions` if the specified `condition` is `TRUE`.

DetectorModelOnInput

data class DetectorModelOnInput(val events: List<DetectorModelEvent>? = null, val transitionEvents: List<DetectorModelTransitionEvent>? = null)

Specifies the actions performed when the `condition` evaluates to TRUE.

DetectorModelPayload

data class DetectorModelPayload(val contentExpression: String, val type: String)

DetectorModelResetTimer

data class DetectorModelResetTimer(val timerName: String)

Information required to reset the timer. The timer is reset to the previously evaluated result of the duration. The duration expression isn't reevaluated when you reset the timer.

DetectorModelSetTimer

data class DetectorModelSetTimer(val durationExpression: String? = null, val seconds: Int? = null, val timerName: String)

Information needed to set the timer.

DetectorModelSetVariable

data class DetectorModelSetVariable(val value: String, val variableName: String)

Information about the variable and its new value.

DetectorModelSns

data class DetectorModelSns(val payload: DetectorModelPayload? = null, val targetArn: String)

Information required to publish the Amazon SNS message.

DetectorModelSqs

data class DetectorModelSqs(val payload: DetectorModelPayload? = null, val queueUrl: String, val useBase64: Boolean? = null)

Sends information about the detector model instance and the event that triggered the action to an Amazon SQS queue.

DetectorModelState

data class DetectorModelState(val onEnter: DetectorModelOnEnter? = null, val onExit: DetectorModelOnExit? = null, val onInput: DetectorModelOnInput? = null, val stateName: String)

Information that defines a state of a detector.

DetectorModelTransitionEvent

data class DetectorModelTransitionEvent(val actions: List<DetectorModelAction>? = null, val condition: String, val eventName: String, val nextState: String)

Specifies the actions performed and the next state entered when a `condition` evaluates to TRUE.

GetAlarmModelResult

data class GetAlarmModelResult(val alarmCapabilities: AlarmModelAlarmCapabilities? = null, val alarmEventActions: AlarmModelAlarmEventActions? = null, val alarmModelDescription: String? = null, val alarmRule: AlarmModelAlarmRule? = null, val roleArn: String? = null, val severity: Int? = null, val tags: List<Tag>? = null)

GetDetectorModelResult

data class GetDetectorModelResult(val detectorModelDefinition: DetectorModelDefinition? = null, val detectorModelDescription: String? = null, val evaluationMethod: DetectorModelEvaluationMethod? = null, val roleArn: String? = null, val tags: List<Tag>? = null)

GetInputResult

data class GetInputResult(val inputDefinition: InputDefinition? = null, val inputDescription: String? = null, val tags: List<Tag>? = null)

InputAttribute

data class InputAttribute(val jsonPath: String)

The attributes from the JSON payload that are made available by the input. Inputs are derived from messages sent to the ITE system using `BatchPutMessage`. Each such message contains a JSON payload. Those attributes (and their paired values) specified here are available for use in the `condition` expressions used by detectors.

InputDefinition

data class InputDefinition(val attributes: List<InputAttribute>)

The definition of the input.