@awboost/cfntypes 0.100.15 → 0.100.16
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/resources.generated.d.ts +375 -260
- package/lib/resources.generated.js.map +1 -1
- package/package.json +1 -1
@@ -75587,14 +75587,13 @@ export type IoTCoreDeviceAdvisorSuiteDefinitionTag = {
|
|
75587
75587
|
Value: string;
|
75588
75588
|
};
|
75589
75589
|
/**
|
75590
|
-
*
|
75591
|
-
|
75592
|
-
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.
|
75590
|
+
* Resource type definition for `AWS::IoTEvents::AlarmModel`.
|
75591
|
+
* 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](https://docs.aws.amazon.com/iotevents/latest/developerguide/create-alarms.html) in the *Developer Guide*.
|
75593
75592
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-alarmmodel.html}
|
75594
75593
|
*/
|
75595
75594
|
export type IoTEventsAlarmModelProps = {
|
75596
75595
|
/**
|
75597
|
-
* Contains the configuration information of alarm state changes
|
75596
|
+
* Contains the configuration information of alarm state changes.
|
75598
75597
|
*/
|
75599
75598
|
AlarmCapabilities?: IoTEventsAlarmModelAlarmCapabilities;
|
75600
75599
|
/**
|
@@ -75602,7 +75601,7 @@ export type IoTEventsAlarmModelProps = {
|
|
75602
75601
|
*/
|
75603
75602
|
AlarmEventActions?: IoTEventsAlarmModelAlarmEventActions;
|
75604
75603
|
/**
|
75605
|
-
*
|
75604
|
+
* The description of the alarm model.
|
75606
75605
|
* @maxLength `1024`
|
75607
75606
|
*/
|
75608
75607
|
AlarmModelDescription?: string;
|
@@ -75618,32 +75617,27 @@ export type IoTEventsAlarmModelProps = {
|
|
75618
75617
|
*/
|
75619
75618
|
AlarmRule: IoTEventsAlarmModelAlarmRule;
|
75620
75619
|
/**
|
75621
|
-
|
75622
|
-
|
75623
|
-
|
75624
|
-
|
75625
|
-
|
75626
|
-
* @pattern `^((`[\w\- ]+`)|([\w\-]+))(\.((`[\w\- ]+`)|([\w\-]+)))*$`
|
75627
|
-
*/
|
75620
|
+
* An input attribute used as a key to create an alarm. ITE routes [inputs](https://docs.aws.amazon.com/iotevents/latest/apireference/API_Input.html) associated with this key to the alarm.
|
75621
|
+
* @minLength `1`
|
75622
|
+
* @maxLength `128`
|
75623
|
+
* @pattern `^((`[\w\- ]+`)|([\w\-]+))(\.((`[\w\- ]+`)|([\w\-]+)))*$`
|
75624
|
+
*/
|
75628
75625
|
Key?: string;
|
75629
75626
|
/**
|
75630
|
-
* The ARN of the role that
|
75627
|
+
* The ARN of the IAM role that allows the alarm to perform actions and access AWS resources. For more information, see [Amazon Resource Names (ARNs)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the *General Reference*.
|
75631
75628
|
* @minLength `1`
|
75632
75629
|
* @maxLength `2048`
|
75633
75630
|
*/
|
75634
75631
|
RoleArn: string;
|
75635
75632
|
/**
|
75636
|
-
|
75637
|
-
|
75638
|
-
|
75639
|
-
|
75640
|
-
* @max `2147483647`
|
75641
|
-
*/
|
75633
|
+
* A non-negative integer that reflects the severity level of the alarm.
|
75634
|
+
* @min `0`
|
75635
|
+
* @max `2147483647`
|
75636
|
+
*/
|
75642
75637
|
Severity?: number;
|
75643
75638
|
/**
|
75644
|
-
*
|
75645
|
-
|
75646
|
-
For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).
|
75639
|
+
* A list of key-value pairs that contain metadata for the alarm model. The tags help you manage the alarm model. For more information, see [Tagging your resources](https://docs.aws.amazon.com/iotevents/latest/developerguide/tagging-iotevents.html) in the *Developer Guide*.
|
75640
|
+
You can create up to 50 tags for one alarm model.
|
75647
75641
|
*/
|
75648
75642
|
Tags?: IoTEventsAlarmModelTag[];
|
75649
75643
|
};
|
@@ -75654,52 +75648,92 @@ export type IoTEventsAlarmModelProps = {
|
|
75654
75648
|
*/
|
75655
75649
|
export type IoTEventsAlarmModelAcknowledgeFlow = {
|
75656
75650
|
/**
|
75657
|
-
* The value must be TRUE or FALSE
|
75651
|
+
* The value must be ``TRUE`` or ``FALSE``. If ``TRUE``, you receive a notification when the alarm state changes. You must choose to acknowledge the notification before the alarm state can return to ``NORMAL``. If ``FALSE``, you won't receive notifications. The alarm automatically changes to the ``NORMAL`` state when the input property value returns to the specified range.
|
75658
75652
|
*/
|
75659
75653
|
Enabled?: boolean;
|
75660
75654
|
};
|
75661
75655
|
/**
|
75662
75656
|
* Type definition for `AWS::IoTEvents::AlarmModel.AlarmAction`.
|
75663
|
-
*
|
75657
|
+
* Specifies one of the following actions to receive notifications when the alarm state changes.
|
75664
75658
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-alarmaction.html}
|
75665
75659
|
*/
|
75666
75660
|
export type IoTEventsAlarmModelAlarmAction = {
|
75667
75661
|
/**
|
75668
|
-
|
75669
|
-
|
75662
|
+
* 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](https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html). One column of the DynamoDB table receives all attribute-value pairs in the payload that you specify.
|
75663
|
+
You must use expressions for all parameters in ``DynamoDBAction``. The expressions accept literals, operators, functions, references, and substitution templates.
|
75664
|
+
**Examples**
|
75665
|
+
+ For literal values, the expressions must contain single quotes. For example, the value for the ``hashKeyType`` parameter can be ``'STRING'``.
|
75666
|
+
+ For references, you must specify either variables or input values. For example, the value for the ``hashKeyField`` parameter can be ``$input.GreenhouseInput.name``.
|
75667
|
+
+ For a substitution template, you must use ``${}``, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.
|
75668
|
+
In the following example, the value for the ``hashKeyValue`` parameter uses a substitution template.
|
75669
|
+
``'${$input.GreenhouseInput.temperature * 6 / 5 + 32} in Fahrenheit'``
|
75670
|
+
+ For a string concatenation, you must use ``+``. A string concatenation can also contain a combination of literals, operators, functions, references, and substitution templates.
|
75671
|
+
In the following example, the value for the ``tableName`` parameter uses a string concatenation.
|
75672
|
+
``'GreenhouseTemperatureTable ' + $input.GreenhouseInput.date``
|
75673
|
+
|
75674
|
+
For more information, see [Expressions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) in the *Developer Guide*.
|
75675
|
+
If the defined payload type is a string, ``DynamoDBAction`` writes non-JSON data to the DynamoDB table as binary data. The DynamoDB console displays the data as Base64-encoded text. The value for the ``payloadField`` parameter is ``<payload-field>_raw``.
|
75676
|
+
*/
|
75670
75677
|
DynamoDB?: IoTEventsAlarmModelDynamoDB;
|
75671
75678
|
/**
|
75672
|
-
* Defines an action to write to the Amazon DynamoDB table that you created. The default action payload contains all
|
75673
|
-
|
75674
|
-
|
75679
|
+
* 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](https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html). A separate column of the DynamoDB table receives one attribute-value pair in the payload that you specify.
|
75680
|
+
You must use expressions for all parameters in ``DynamoDBv2Action``. The expressions accept literals, operators, functions, references, and substitution templates.
|
75681
|
+
**Examples**
|
75682
|
+
+ For literal values, the expressions must contain single quotes. For example, the value for the ``tableName`` parameter can be ``'GreenhouseTemperatureTable'``.
|
75683
|
+
+ For references, you must specify either variables or input values. For example, the value for the ``tableName`` parameter can be ``$variable.ddbtableName``.
|
75684
|
+
+ For a substitution template, you must use ``${}``, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.
|
75685
|
+
In the following example, the value for the ``contentExpression`` parameter in ``Payload`` uses a substitution template.
|
75686
|
+
``'{\"sensorID\": \"${$input.GreenhouseInput.sensor_id}\", \"temperature\": \"${$input.GreenhouseInput.temperature * 9 / 5 + 32}\"}'``
|
75687
|
+
+ For a string concatenation, you must use ``+``. A string concatenation can also contain a combination of literals, operators, functions, references, and substitution templates.
|
75688
|
+
In the following example, the value for the ``tableName`` parameter uses a string concatenation.
|
75689
|
+
``'GreenhouseTemperatureTable ' + $input.GreenhouseInput.date``
|
75690
|
+
|
75691
|
+
For more information, see [Expressions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) in the *Developer Guide*.
|
75692
|
+
The value for the ``type`` parameter in ``Payload`` must be ``JSON``.
|
75675
75693
|
*/
|
75676
75694
|
DynamoDBv2?: IoTEventsAlarmModelDynamoDBv2;
|
75677
75695
|
/**
|
75678
|
-
* Sends information about the
|
75696
|
+
* Sends information about the detector model instance and the event that triggered the action to an Amazon Kinesis Data Firehose delivery stream.
|
75679
75697
|
*/
|
75680
75698
|
Firehose?: IoTEventsAlarmModelFirehose;
|
75681
75699
|
/**
|
75682
|
-
* Sends an
|
75700
|
+
* Sends an ITE input, passing in information about the detector model instance and the event that triggered the action.
|
75683
75701
|
*/
|
75684
75702
|
IotEvents?: IoTEventsAlarmModelIotEvents;
|
75685
75703
|
/**
|
75686
|
-
|
75687
|
-
|
75704
|
+
* Sends information about the detector model instance and the event that triggered the action to a specified asset property in ITSW.
|
75705
|
+
You must use expressions for all parameters in ``IotSiteWiseAction``. The expressions accept literals, operators, functions, references, and substitutions templates.
|
75706
|
+
**Examples**
|
75707
|
+
+ For literal values, the expressions must contain single quotes. For example, the value for the ``propertyAlias`` parameter can be ``'/company/windfarm/3/turbine/7/temperature'``.
|
75708
|
+
+ For references, you must specify either variables or input values. For example, the value for the ``assetId`` parameter can be ``$input.TurbineInput.assetId1``.
|
75709
|
+
+ For a substitution template, you must use ``${}``, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.
|
75710
|
+
In the following example, the value for the ``propertyAlias`` parameter uses a substitution template.
|
75711
|
+
``'company/windfarm/${$input.TemperatureInput.sensorData.windfarmID}/turbine/ ${$input.TemperatureInput.sensorData.turbineID}/temperature'``
|
75712
|
+
|
75713
|
+
You must specify either ``propertyAlias`` or both ``assetId`` and ``propertyId`` to identify the target asset property in ITSW.
|
75714
|
+
For more information, see [Expressions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) in the *Developer Guide*.
|
75715
|
+
*/
|
75688
75716
|
IotSiteWise?: IoTEventsAlarmModelIotSiteWise;
|
75689
75717
|
/**
|
75690
|
-
* Information required to publish the MQTT message through the
|
75718
|
+
* Information required to publish the MQTT message through the IoT message broker.
|
75691
75719
|
*/
|
75692
75720
|
IotTopicPublish?: IoTEventsAlarmModelIotTopicPublish;
|
75721
|
+
/**
|
75722
|
+
* Calls a Lambda function, passing in information about the detector model instance and the event that triggered the action.
|
75723
|
+
*/
|
75693
75724
|
Lambda?: IoTEventsAlarmModelLambda;
|
75694
75725
|
/**
|
75695
75726
|
* Information required to publish the Amazon SNS message.
|
75696
75727
|
*/
|
75697
75728
|
Sns?: IoTEventsAlarmModelSns;
|
75729
|
+
/**
|
75730
|
+
* Sends information about the detector model instance and the event that triggered the action to an Amazon SQS queue.
|
75731
|
+
*/
|
75698
75732
|
Sqs?: IoTEventsAlarmModelSqs;
|
75699
75733
|
};
|
75700
75734
|
/**
|
75701
75735
|
* Type definition for `AWS::IoTEvents::AlarmModel.AlarmCapabilities`.
|
75702
|
-
* Contains the configuration information of alarm state changes
|
75736
|
+
* Contains the configuration information of alarm state changes.
|
75703
75737
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-alarmcapabilities.html}
|
75704
75738
|
*/
|
75705
75739
|
export type IoTEventsAlarmModelAlarmCapabilities = {
|
@@ -75736,79 +75770,115 @@ export type IoTEventsAlarmModelAlarmRule = {
|
|
75736
75770
|
};
|
75737
75771
|
/**
|
75738
75772
|
* Type definition for `AWS::IoTEvents::AlarmModel.AssetPropertyTimestamp`.
|
75739
|
-
* A structure that contains timestamp information. For more information, see [TimeInNanos](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_TimeInNanos.html) in the *
|
75773
|
+
* A structure that contains timestamp information. For more information, see [TimeInNanos](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_TimeInNanos.html) in the *API Reference*.
|
75774
|
+
You must use expressions for all parameters in ``AssetPropertyTimestamp``. The expressions accept literals, operators, functions, references, and substitution templates.
|
75775
|
+
**Examples**
|
75776
|
+
+ For literal values, the expressions must contain single quotes. For example, the value for the ``timeInSeconds`` parameter can be ``'1586400675'``.
|
75777
|
+
+ For references, you must specify either variables or input values. For example, the value for the ``offsetInNanos`` parameter can be ``$variable.time``.
|
75778
|
+
+ For a substitution template, you must use ``${}``, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.
|
75779
|
+
In the following example, the value for the ``timeInSeconds`` parameter uses a substitution template.
|
75780
|
+
``'${$input.TemperatureInput.sensorData.timestamp / 1000}'``
|
75781
|
+
|
75782
|
+
For more information, see [Expressions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) in the *Developer Guide*.
|
75740
75783
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-assetpropertytimestamp.html}
|
75741
75784
|
*/
|
75742
75785
|
export type IoTEventsAlarmModelAssetPropertyTimestamp = {
|
75743
75786
|
/**
|
75744
|
-
* The
|
75787
|
+
* The nanosecond offset converted from ``timeInSeconds``. The valid range is between 0-999999999.
|
75745
75788
|
*/
|
75746
75789
|
OffsetInNanos?: string;
|
75747
75790
|
/**
|
75748
|
-
* The
|
75791
|
+
* The timestamp, in seconds, in the Unix epoch format. The valid range is between 1-31556889864403199.
|
75749
75792
|
*/
|
75750
75793
|
TimeInSeconds: string;
|
75751
75794
|
};
|
75752
75795
|
/**
|
75753
75796
|
* Type definition for `AWS::IoTEvents::AlarmModel.AssetPropertyValue`.
|
75754
|
-
* A structure that contains value information. For more information, see [AssetPropertyValue](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_AssetPropertyValue.html) in the *
|
75797
|
+
* A structure that contains value information. For more information, see [AssetPropertyValue](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_AssetPropertyValue.html) in the *API Reference*.
|
75798
|
+
You must use expressions for all parameters in ``AssetPropertyValue``. The expressions accept literals, operators, functions, references, and substitution templates.
|
75799
|
+
**Examples**
|
75800
|
+
+ For literal values, the expressions must contain single quotes. For example, the value for the ``quality`` parameter can be ``'GOOD'``.
|
75801
|
+
+ For references, you must specify either variables or input values. For example, the value for the ``quality`` parameter can be ``$input.TemperatureInput.sensorData.quality``.
|
75802
|
+
|
75803
|
+
For more information, see [Expressions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) in the *Developer Guide*.
|
75755
75804
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-assetpropertyvalue.html}
|
75756
75805
|
*/
|
75757
75806
|
export type IoTEventsAlarmModelAssetPropertyValue = {
|
75758
75807
|
/**
|
75759
|
-
* The quality of the asset property value. The value must be
|
75808
|
+
* The quality of the asset property value. The value must be ``'GOOD'``, ``'BAD'``, or ``'UNCERTAIN'``.
|
75760
75809
|
*/
|
75761
75810
|
Quality?: string;
|
75762
75811
|
/**
|
75763
|
-
*
|
75812
|
+
* The timestamp associated with the asset property value. The default is the current event time.
|
75764
75813
|
*/
|
75765
75814
|
Timestamp?: IoTEventsAlarmModelAssetPropertyTimestamp;
|
75766
75815
|
/**
|
75767
|
-
*
|
75816
|
+
* The value to send to an asset property.
|
75768
75817
|
*/
|
75769
75818
|
Value: IoTEventsAlarmModelAssetPropertyVariant;
|
75770
75819
|
};
|
75771
75820
|
/**
|
75772
75821
|
* Type definition for `AWS::IoTEvents::AlarmModel.AssetPropertyVariant`.
|
75773
|
-
* A structure that contains an asset property value. For more information, see [Variant](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_Variant.html) in the *
|
75822
|
+
* A structure that contains an asset property value. For more information, see [Variant](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_Variant.html) in the *API Reference*.
|
75823
|
+
You must use expressions for all parameters in ``AssetPropertyVariant``. The expressions accept literals, operators, functions, references, and substitution templates.
|
75824
|
+
**Examples**
|
75825
|
+
+ For literal values, the expressions must contain single quotes. For example, the value for the ``integerValue`` parameter can be ``'100'``.
|
75826
|
+
+ For references, you must specify either variables or parameters. For example, the value for the ``booleanValue`` parameter can be ``$variable.offline``.
|
75827
|
+
+ For a substitution template, you must use ``${}``, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.
|
75828
|
+
In the following example, the value for the ``doubleValue`` parameter uses a substitution template.
|
75829
|
+
``'${$input.TemperatureInput.sensorData.temperature * 6 / 5 + 32}'``
|
75830
|
+
|
75831
|
+
For more information, see [Expressions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) in the *Developer Guide*.
|
75832
|
+
You must specify one of the following value types, depending on the ``dataType`` of the specified asset property. For more information, see [AssetProperty](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_AssetProperty.html) in the *API Reference*.
|
75774
75833
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-assetpropertyvariant.html}
|
75775
75834
|
*/
|
75776
75835
|
export type IoTEventsAlarmModelAssetPropertyVariant = {
|
75777
75836
|
/**
|
75778
|
-
* The asset property value is a Boolean value that must be
|
75837
|
+
* The asset property value is a Boolean value that must be ``'TRUE'`` or ``'FALSE'``. You must use an expression, and the evaluated result should be a Boolean value.
|
75779
75838
|
*/
|
75780
75839
|
BooleanValue?: string;
|
75781
75840
|
/**
|
75782
|
-
* The asset property value is a double. You
|
75841
|
+
* The asset property value is a double. You must use an expression, and the evaluated result should be a double.
|
75783
75842
|
*/
|
75784
75843
|
DoubleValue?: string;
|
75785
75844
|
/**
|
75786
|
-
* The asset property value is an integer. You
|
75845
|
+
* The asset property value is an integer. You must use an expression, and the evaluated result should be an integer.
|
75787
75846
|
*/
|
75788
75847
|
IntegerValue?: string;
|
75789
75848
|
/**
|
75790
|
-
* The asset property value is a string. You
|
75849
|
+
* The asset property value is a string. You must use an expression, and the evaluated result should be a string.
|
75791
75850
|
*/
|
75792
75851
|
StringValue?: string;
|
75793
75852
|
};
|
75794
75853
|
/**
|
75795
75854
|
* Type definition for `AWS::IoTEvents::AlarmModel.DynamoDB`.
|
75796
|
-
*
|
75855
|
+
* 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](https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html). One column of the DynamoDB table receives all attribute-value pairs in the payload that you specify.
|
75856
|
+
You must use expressions for all parameters in ``DynamoDBAction``. The expressions accept literals, operators, functions, references, and substitution templates.
|
75857
|
+
**Examples**
|
75858
|
+
+ For literal values, the expressions must contain single quotes. For example, the value for the ``hashKeyType`` parameter can be ``'STRING'``.
|
75859
|
+
+ For references, you must specify either variables or input values. For example, the value for the ``hashKeyField`` parameter can be ``$input.GreenhouseInput.name``.
|
75860
|
+
+ For a substitution template, you must use ``${}``, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.
|
75861
|
+
In the following example, the value for the ``hashKeyValue`` parameter uses a substitution template.
|
75862
|
+
``'${$input.GreenhouseInput.temperature * 6 / 5 + 32} in Fahrenheit'``
|
75863
|
+
+ For a string concatenation, you must use ``+``. A string concatenation can also contain a combination of literals, operators, functions, references, and substitution templates.
|
75864
|
+
In the following example, the value for the ``tableName`` parameter uses a string concatenation.
|
75865
|
+
``'GreenhouseTemperatureTable ' + $input.GreenhouseInput.date``
|
75866
|
+
|
75867
|
+
For more information, see [Expressions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) in the *Developer Guide*.
|
75868
|
+
If the defined payload type is a string, ``DynamoDBAction`` writes non-JSON data to the DynamoDB table as binary data. The DynamoDB console displays the data as Base64-encoded text. The value for the ``payloadField`` parameter is ``<payload-field>_raw``.
|
75797
75869
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-dynamodb.html}
|
75798
75870
|
*/
|
75799
75871
|
export type IoTEventsAlarmModelDynamoDB = {
|
75800
75872
|
/**
|
75801
|
-
* The name of the hash key (also called the partition key).
|
75873
|
+
* The name of the hash key (also called the partition key). The ``hashKeyField`` value must match the partition key of the target DynamoDB table.
|
75802
75874
|
*/
|
75803
75875
|
HashKeyField: string;
|
75804
75876
|
/**
|
75805
75877
|
* The data type for the hash key (also called the partition key). You can specify the following values:
|
75806
|
-
|
75807
|
-
|
75808
|
-
|
75809
|
-
|
75810
|
-
|
75811
|
-
If you don't specify `hashKeyType`, the default value is `STRING`.
|
75878
|
+
+ ``'STRING'`` - The hash key is a string.
|
75879
|
+
+ ``'NUMBER'`` - The hash key is a number.
|
75880
|
+
|
75881
|
+
If you don't specify ``hashKeyType``, the default value is ``'STRING'``.
|
75812
75882
|
*/
|
75813
75883
|
HashKeyType?: string;
|
75814
75884
|
/**
|
@@ -75817,40 +75887,33 @@ export type IoTEventsAlarmModelDynamoDB = {
|
|
75817
75887
|
HashKeyValue: string;
|
75818
75888
|
/**
|
75819
75889
|
* The type of operation to perform. You can specify the following values:
|
75820
|
-
|
75821
|
-
|
75822
|
-
|
75823
|
-
|
75824
|
-
|
75825
|
-
* `DELETE` - Delete an existing item of the DynamoDB table. This item's partition key must match the specified hash key. If you specified a range key, the range key must match the item's sort key.
|
75826
|
-
|
75827
|
-
If you don't specify this parameter, AWS IoT Events triggers the `INSERT` operation.
|
75890
|
+
+ ``'INSERT'`` - Insert data as a new item into the DynamoDB table. This item uses the specified hash key as a partition key. If you specified a range key, the item uses the range key as a sort key.
|
75891
|
+
+ ``'UPDATE'`` - Update an existing item of the DynamoDB table with new data. This item's partition key must match the specified hash key. If you specified a range key, the range key must match the item's sort key.
|
75892
|
+
+ ``'DELETE'`` - Delete an existing item of the DynamoDB table. This item's partition key must match the specified hash key. If you specified a range key, the range key must match the item's sort key.
|
75893
|
+
|
75894
|
+
If you don't specify this parameter, ITE triggers the ``'INSERT'`` operation.
|
75828
75895
|
*/
|
75829
75896
|
Operation?: string;
|
75830
75897
|
/**
|
75831
75898
|
* Information needed to configure the payload.
|
75832
|
-
|
75833
|
-
By default, AWS IoT Events generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the alarm model instance and the event triggered the action. To configure the action payload, you can use `contentExpression`.
|
75899
|
+
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``.
|
75834
75900
|
*/
|
75835
75901
|
Payload?: IoTEventsAlarmModelPayload;
|
75836
75902
|
/**
|
75837
75903
|
* The name of the DynamoDB column that receives the action payload.
|
75838
|
-
|
75839
|
-
If you don't specify this parameter, the name of the DynamoDB column is `payload`.
|
75904
|
+
If you don't specify this parameter, the name of the DynamoDB column is ``payload``.
|
75840
75905
|
*/
|
75841
75906
|
PayloadField?: string;
|
75842
75907
|
/**
|
75843
|
-
* The name of the range key (also called the sort key).
|
75908
|
+
* The name of the range key (also called the sort key). The ``rangeKeyField`` value must match the sort key of the target DynamoDB table.
|
75844
75909
|
*/
|
75845
75910
|
RangeKeyField?: string;
|
75846
75911
|
/**
|
75847
75912
|
* The data type for the range key (also called the sort key), You can specify the following values:
|
75848
|
-
|
75849
|
-
|
75850
|
-
|
75851
|
-
|
75852
|
-
|
75853
|
-
If you don't specify `rangeKeyField`, the default value is `STRING`.
|
75913
|
+
+ ``'STRING'`` - The range key is a string.
|
75914
|
+
+ ``'NUMBER'`` - The range key is number.
|
75915
|
+
|
75916
|
+
If you don't specify ``rangeKeyField``, the default value is ``'STRING'``.
|
75854
75917
|
*/
|
75855
75918
|
RangeKeyType?: string;
|
75856
75919
|
/**
|
@@ -75858,22 +75921,32 @@ export type IoTEventsAlarmModelDynamoDB = {
|
|
75858
75921
|
*/
|
75859
75922
|
RangeKeyValue?: string;
|
75860
75923
|
/**
|
75861
|
-
* The name of the DynamoDB table.
|
75924
|
+
* The name of the DynamoDB table. The ``tableName`` value must match the table name of the target DynamoDB table.
|
75862
75925
|
*/
|
75863
75926
|
TableName: string;
|
75864
75927
|
};
|
75865
75928
|
/**
|
75866
75929
|
* Type definition for `AWS::IoTEvents::AlarmModel.DynamoDBv2`.
|
75867
|
-
* Defines an action to write to the Amazon DynamoDB table that you created. The default action payload contains all
|
75868
|
-
|
75869
|
-
|
75930
|
+
* 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](https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html). A separate column of the DynamoDB table receives one attribute-value pair in the payload that you specify.
|
75931
|
+
You must use expressions for all parameters in ``DynamoDBv2Action``. The expressions accept literals, operators, functions, references, and substitution templates.
|
75932
|
+
**Examples**
|
75933
|
+
+ For literal values, the expressions must contain single quotes. For example, the value for the ``tableName`` parameter can be ``'GreenhouseTemperatureTable'``.
|
75934
|
+
+ For references, you must specify either variables or input values. For example, the value for the ``tableName`` parameter can be ``$variable.ddbtableName``.
|
75935
|
+
+ For a substitution template, you must use ``${}``, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.
|
75936
|
+
In the following example, the value for the ``contentExpression`` parameter in ``Payload`` uses a substitution template.
|
75937
|
+
``'{\"sensorID\": \"${$input.GreenhouseInput.sensor_id}\", \"temperature\": \"${$input.GreenhouseInput.temperature * 9 / 5 + 32}\"}'``
|
75938
|
+
+ For a string concatenation, you must use ``+``. A string concatenation can also contain a combination of literals, operators, functions, references, and substitution templates.
|
75939
|
+
In the following example, the value for the ``tableName`` parameter uses a string concatenation.
|
75940
|
+
``'GreenhouseTemperatureTable ' + $input.GreenhouseInput.date``
|
75941
|
+
|
75942
|
+
For more information, see [Expressions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) in the *Developer Guide*.
|
75943
|
+
The value for the ``type`` parameter in ``Payload`` must be ``JSON``.
|
75870
75944
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-dynamodbv2.html}
|
75871
75945
|
*/
|
75872
75946
|
export type IoTEventsAlarmModelDynamoDBv2 = {
|
75873
75947
|
/**
|
75874
75948
|
* Information needed to configure the payload.
|
75875
|
-
|
75876
|
-
By default, AWS IoT Events generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the alarm model instance and the event triggered the action. To configure the action payload, you can use `contentExpression`.
|
75949
|
+
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``.
|
75877
75950
|
*/
|
75878
75951
|
Payload?: IoTEventsAlarmModelPayload;
|
75879
75952
|
/**
|
@@ -75883,7 +75956,7 @@ export type IoTEventsAlarmModelDynamoDBv2 = {
|
|
75883
75956
|
};
|
75884
75957
|
/**
|
75885
75958
|
* Type definition for `AWS::IoTEvents::AlarmModel.Firehose`.
|
75886
|
-
* Sends information about the
|
75959
|
+
* Sends information about the detector model instance and the event that triggered the action to an Amazon Kinesis Data Firehose delivery stream.
|
75887
75960
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-firehose.html}
|
75888
75961
|
*/
|
75889
75962
|
export type IoTEventsAlarmModelFirehose = {
|
@@ -75892,10 +75965,8 @@ export type IoTEventsAlarmModelFirehose = {
|
|
75892
75965
|
*/
|
75893
75966
|
DeliveryStreamName: string;
|
75894
75967
|
/**
|
75895
|
-
|
75896
|
-
|
75897
|
-
By default, AWS IoT Events generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the alarm model instance and the event triggered the action. To configure the action payload, you can use `contentExpression`.
|
75898
|
-
*/
|
75968
|
+
* You can configure the action payload when you send a message to an Amazon Data Firehose delivery stream.
|
75969
|
+
*/
|
75899
75970
|
Payload?: IoTEventsAlarmModelPayload;
|
75900
75971
|
/**
|
75901
75972
|
* A character separator that is used to separate records written to the Kinesis Data Firehose delivery stream. Valid values are: '\n' (newline), '\t' (tab), '\r\n' (Windows newline), ',' (comma).
|
@@ -75910,78 +75981,85 @@ export type IoTEventsAlarmModelFirehose = {
|
|
75910
75981
|
*/
|
75911
75982
|
export type IoTEventsAlarmModelInitializationConfiguration = {
|
75912
75983
|
/**
|
75913
|
-
* The value must be TRUE or FALSE
|
75984
|
+
* The value must be ``TRUE`` or ``FALSE``. If ``FALSE``, all alarm instances created based on the alarm model are activated. The default value is ``TRUE``.
|
75914
75985
|
*/
|
75915
75986
|
DisabledOnInitialization: boolean;
|
75916
75987
|
};
|
75917
75988
|
/**
|
75918
75989
|
* Type definition for `AWS::IoTEvents::AlarmModel.IotEvents`.
|
75919
|
-
* Sends an
|
75990
|
+
* Sends an ITE input, passing in information about the detector model instance and the event that triggered the action.
|
75920
75991
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-iotevents.html}
|
75921
75992
|
*/
|
75922
75993
|
export type IoTEventsAlarmModelIotEvents = {
|
75923
75994
|
/**
|
75924
|
-
* The name of the
|
75995
|
+
* The name of the ITE input where the data is sent.
|
75925
75996
|
* @minLength `1`
|
75926
75997
|
* @maxLength `128`
|
75927
75998
|
* @pattern `^[a-zA-Z][a-zA-Z0-9_]*$`
|
75928
75999
|
*/
|
75929
76000
|
InputName: string;
|
75930
76001
|
/**
|
75931
|
-
|
75932
|
-
|
75933
|
-
By default, AWS IoT Events generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the alarm model instance and the event triggered the action. To configure the action payload, you can use `contentExpression`.
|
75934
|
-
*/
|
76002
|
+
* You can configure the action payload when you send a message to an ITE input.
|
76003
|
+
*/
|
75935
76004
|
Payload?: IoTEventsAlarmModelPayload;
|
75936
76005
|
};
|
75937
76006
|
/**
|
75938
76007
|
* Type definition for `AWS::IoTEvents::AlarmModel.IotSiteWise`.
|
75939
|
-
* Sends information about the
|
76008
|
+
* Sends information about the detector model instance and the event that triggered the action to a specified asset property in ITSW.
|
76009
|
+
You must use expressions for all parameters in ``IotSiteWiseAction``. The expressions accept literals, operators, functions, references, and substitutions templates.
|
76010
|
+
**Examples**
|
76011
|
+
+ For literal values, the expressions must contain single quotes. For example, the value for the ``propertyAlias`` parameter can be ``'/company/windfarm/3/turbine/7/temperature'``.
|
76012
|
+
+ For references, you must specify either variables or input values. For example, the value for the ``assetId`` parameter can be ``$input.TurbineInput.assetId1``.
|
76013
|
+
+ For a substitution template, you must use ``${}``, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.
|
76014
|
+
In the following example, the value for the ``propertyAlias`` parameter uses a substitution template.
|
76015
|
+
``'company/windfarm/${$input.TemperatureInput.sensorData.windfarmID}/turbine/ ${$input.TemperatureInput.sensorData.turbineID}/temperature'``
|
76016
|
+
|
76017
|
+
You must specify either ``propertyAlias`` or both ``assetId`` and ``propertyId`` to identify the target asset property in ITSW.
|
76018
|
+
For more information, see [Expressions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) in the *Developer Guide*.
|
75940
76019
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-iotsitewise.html}
|
75941
76020
|
*/
|
75942
76021
|
export type IoTEventsAlarmModelIotSiteWise = {
|
75943
76022
|
/**
|
75944
|
-
* The ID of the asset that has the specified property.
|
76023
|
+
* The ID of the asset that has the specified property.
|
75945
76024
|
*/
|
75946
76025
|
AssetId?: string;
|
75947
76026
|
/**
|
75948
|
-
* A unique identifier for this entry. You can use the entry ID to track which data entry causes an error in case of failure. The default is a new unique identifier.
|
76027
|
+
* A unique identifier for this entry. You can use the entry ID to track which data entry causes an error in case of failure. The default is a new unique identifier.
|
75949
76028
|
*/
|
75950
76029
|
EntryId?: string;
|
75951
76030
|
/**
|
75952
|
-
* The alias of the asset property.
|
76031
|
+
* The alias of the asset property.
|
75953
76032
|
*/
|
75954
76033
|
PropertyAlias?: string;
|
75955
76034
|
/**
|
75956
|
-
* The ID of the asset property.
|
76035
|
+
* The ID of the asset property.
|
75957
76036
|
*/
|
75958
76037
|
PropertyId?: string;
|
75959
76038
|
/**
|
75960
|
-
*
|
76039
|
+
* The value to send to the asset property. This value contains timestamp, quality, and value (TQV) information.
|
75961
76040
|
*/
|
75962
76041
|
PropertyValue?: IoTEventsAlarmModelAssetPropertyValue;
|
75963
76042
|
};
|
75964
76043
|
/**
|
75965
76044
|
* Type definition for `AWS::IoTEvents::AlarmModel.IotTopicPublish`.
|
75966
|
-
* Information required to publish the MQTT message through the
|
76045
|
+
* Information required to publish the MQTT message through the IoT message broker.
|
75967
76046
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-iottopicpublish.html}
|
75968
76047
|
*/
|
75969
76048
|
export type IoTEventsAlarmModelIotTopicPublish = {
|
75970
76049
|
/**
|
75971
|
-
* The MQTT topic of the message. You can use a string expression that includes variables (
|
76050
|
+
* The MQTT topic of the message. You can use a string expression that includes variables (``$variable.<variable-name>``) and input values (``$input.<input-name>.<path-to-datum>``) as the topic string.
|
75972
76051
|
* @minLength `1`
|
75973
76052
|
* @maxLength `128`
|
75974
76053
|
*/
|
75975
76054
|
MqttTopic: string;
|
75976
76055
|
/**
|
75977
|
-
|
75978
|
-
|
75979
|
-
By default, AWS IoT Events generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the alarm model instance and the event triggered the action. To configure the action payload, you can use `contentExpression`.
|
75980
|
-
*/
|
76056
|
+
* You can configure the action payload when you publish a message to an IoTCore topic.
|
76057
|
+
*/
|
75981
76058
|
Payload?: IoTEventsAlarmModelPayload;
|
75982
76059
|
};
|
75983
76060
|
/**
|
75984
76061
|
* Type definition for `AWS::IoTEvents::AlarmModel.Lambda`.
|
76062
|
+
* Calls a Lambda function, passing in information about the detector model instance and the event that triggered the action.
|
75985
76063
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-lambda.html}
|
75986
76064
|
*/
|
75987
76065
|
export type IoTEventsAlarmModelLambda = {
|
@@ -75992,27 +76070,24 @@ export type IoTEventsAlarmModelLambda = {
|
|
75992
76070
|
*/
|
75993
76071
|
FunctionArn: string;
|
75994
76072
|
/**
|
75995
|
-
|
75996
|
-
|
75997
|
-
By default, AWS IoT Events generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the alarm model instance and the event triggered the action. To configure the action payload, you can use `contentExpression`.
|
75998
|
-
*/
|
76073
|
+
* You can configure the action payload when you send a message to a Lambda function.
|
76074
|
+
*/
|
75999
76075
|
Payload?: IoTEventsAlarmModelPayload;
|
76000
76076
|
};
|
76001
76077
|
/**
|
76002
76078
|
* Type definition for `AWS::IoTEvents::AlarmModel.Payload`.
|
76003
76079
|
* Information needed to configure the payload.
|
76004
|
-
|
76005
|
-
By default, AWS IoT Events generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the alarm model instance and the event triggered the action. To configure the action payload, you can use `contentExpression`.
|
76080
|
+
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``.
|
76006
76081
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-payload.html}
|
76007
76082
|
*/
|
76008
76083
|
export type IoTEventsAlarmModelPayload = {
|
76009
76084
|
/**
|
76010
|
-
* The content of the payload. You can use a string expression that includes quoted strings (
|
76085
|
+
* The content of the payload. You can use a string expression that includes quoted strings (``'<string>'``), variables (``$variable.<variable-name>``), input values (``$input.<input-name>.<path-to-datum>``), string concatenations, and quoted strings that contain ``${}`` as the content. The recommended maximum size of a content expression is 1 KB.
|
76011
76086
|
* @minLength `1`
|
76012
76087
|
*/
|
76013
76088
|
ContentExpression: string;
|
76014
76089
|
/**
|
76015
|
-
* The value of the payload type can be either
|
76090
|
+
* The value of the payload type can be either ``STRING`` or ``JSON``.
|
76016
76091
|
*/
|
76017
76092
|
Type: string;
|
76018
76093
|
};
|
@@ -76027,13 +76102,13 @@ export type IoTEventsAlarmModelSimpleRule = {
|
|
76027
76102
|
*/
|
76028
76103
|
ComparisonOperator: "GREATER" | "GREATER_OR_EQUAL" | "LESS" | "LESS_OR_EQUAL" | "EQUAL" | "NOT_EQUAL";
|
76029
76104
|
/**
|
76030
|
-
* The value on the left side of the comparison operator. You can specify an
|
76105
|
+
* The value on the left side of the comparison operator. You can specify an ITE input attribute as an input property.
|
76031
76106
|
* @minLength `1`
|
76032
76107
|
* @maxLength `512`
|
76033
76108
|
*/
|
76034
76109
|
InputProperty: string;
|
76035
76110
|
/**
|
76036
|
-
* The value on the right side of the comparison operator. You can enter a number or specify an
|
76111
|
+
* The value on the right side of the comparison operator. You can enter a number or specify an ITE input attribute.
|
76037
76112
|
* @minLength `1`
|
76038
76113
|
* @maxLength `512`
|
76039
76114
|
*/
|
@@ -76046,10 +76121,8 @@ export type IoTEventsAlarmModelSimpleRule = {
|
|
76046
76121
|
*/
|
76047
76122
|
export type IoTEventsAlarmModelSns = {
|
76048
76123
|
/**
|
76049
|
-
|
76050
|
-
|
76051
|
-
By default, AWS IoT Events generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the alarm model instance and the event triggered the action. To configure the action payload, you can use `contentExpression`.
|
76052
|
-
*/
|
76124
|
+
* You can configure the action payload when you send a message as an Amazon SNS push notification.
|
76125
|
+
*/
|
76053
76126
|
Payload?: IoTEventsAlarmModelPayload;
|
76054
76127
|
/**
|
76055
76128
|
* The ARN of the Amazon SNS target where the message is sent.
|
@@ -76060,41 +76133,44 @@ export type IoTEventsAlarmModelSns = {
|
|
76060
76133
|
};
|
76061
76134
|
/**
|
76062
76135
|
* Type definition for `AWS::IoTEvents::AlarmModel.Sqs`.
|
76136
|
+
* Sends information about the detector model instance and the event that triggered the action to an Amazon SQS queue.
|
76063
76137
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-sqs.html}
|
76064
76138
|
*/
|
76065
76139
|
export type IoTEventsAlarmModelSqs = {
|
76066
76140
|
/**
|
76067
|
-
|
76068
|
-
|
76069
|
-
By default, AWS IoT Events generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the alarm model instance and the event triggered the action. To configure the action payload, you can use `contentExpression`.
|
76070
|
-
*/
|
76141
|
+
* You can configure the action payload when you send a message to an Amazon SQS queue.
|
76142
|
+
*/
|
76071
76143
|
Payload?: IoTEventsAlarmModelPayload;
|
76072
76144
|
/**
|
76073
76145
|
* The URL of the SQS queue where the data is written.
|
76074
76146
|
*/
|
76075
76147
|
QueueUrl: string;
|
76076
76148
|
/**
|
76077
|
-
* Set this to
|
76149
|
+
* Set this to TRUE if you want the data to be base-64 encoded before it is written to the queue. Otherwise, set this to FALSE.
|
76078
76150
|
*/
|
76079
76151
|
UseBase64?: boolean;
|
76080
76152
|
};
|
76081
76153
|
/**
|
76082
76154
|
* Type definition for `AWS::IoTEvents::AlarmModel.Tag`.
|
76083
|
-
*
|
76155
|
+
* Metadata that can be used to manage the resource.
|
76084
76156
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-tag.html}
|
76085
76157
|
*/
|
76086
76158
|
export type IoTEventsAlarmModelTag = {
|
76087
76159
|
/**
|
76088
|
-
*
|
76160
|
+
* The tag's key.
|
76089
76161
|
*/
|
76090
76162
|
Key: string;
|
76091
76163
|
/**
|
76092
|
-
*
|
76164
|
+
* The tag's value.
|
76093
76165
|
*/
|
76094
76166
|
Value: string;
|
76095
76167
|
};
|
76096
76168
|
/**
|
76097
|
-
* 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
|
76169
|
+
* 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](https://docs.aws.amazon.com/iotevents/latest/developerguide/how-to-use-iotevents.html) in the *Developer Guide*.
|
76170
|
+
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.)
|
76171
|
+
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.)
|
76172
|
+
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.
|
76173
|
+
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.
|
76098
76174
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-detectormodel.html}
|
76099
76175
|
*/
|
76100
76176
|
export type IoTEventsDetectorModelProps = {
|
@@ -76119,30 +76195,28 @@ export type IoTEventsDetectorModelProps = {
|
|
76119
76195
|
*/
|
76120
76196
|
EvaluationMethod?: "BATCH" | "SERIAL";
|
76121
76197
|
/**
|
76122
|
-
* The value used to identify a detector instance. When a device or system sends input, a new detector instance with a unique key value is created.
|
76123
|
-
|
76124
|
-
This parameter uses a JSON-path expression to select the attribute-value pair in the message payload that is used for identification. To route the message to the correct detector instance, the device must send a message payload that contains the same attribute-value.
|
76198
|
+
* The value used to identify a detector instance. When a device or system sends input, a new detector instance with a unique key value is created. ITE can continue to route input to its corresponding detector instance based on this identifying information.
|
76199
|
+
This parameter uses a JSON-path expression to select the attribute-value pair in the message payload that is used for identification. To route the message to the correct detector instance, the device must send a message payload that contains the same attribute-value.
|
76125
76200
|
* @minLength `1`
|
76126
76201
|
* @maxLength `128`
|
76127
76202
|
* @pattern `^((`[\w\- ]+`)|([\w\-]+))(\.((`[\w\- ]+`)|([\w\-]+)))*$`
|
76128
76203
|
*/
|
76129
76204
|
Key?: string;
|
76130
76205
|
/**
|
76131
|
-
* The ARN of the role that grants permission to
|
76206
|
+
* The ARN of the role that grants permission to ITE to perform its operations.
|
76132
76207
|
* @minLength `1`
|
76133
76208
|
* @maxLength `2048`
|
76134
76209
|
*/
|
76135
76210
|
RoleArn: string;
|
76136
76211
|
/**
|
76137
76212
|
* An array of key-value pairs to apply to this resource.
|
76138
|
-
|
76139
|
-
For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).
|
76213
|
+
For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).
|
76140
76214
|
*/
|
76141
76215
|
Tags?: IoTEventsDetectorModelTag[];
|
76142
76216
|
};
|
76143
76217
|
/**
|
76144
76218
|
* Type definition for `AWS::IoTEvents::DetectorModel.Action`.
|
76145
|
-
*
|
76219
|
+
* An action to be performed when the ``condition`` is TRUE.
|
76146
76220
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-action.html}
|
76147
76221
|
*/
|
76148
76222
|
export type IoTEventsDetectorModelAction = {
|
@@ -76151,34 +76225,35 @@ export type IoTEventsDetectorModelAction = {
|
|
76151
76225
|
*/
|
76152
76226
|
ClearTimer?: IoTEventsDetectorModelClearTimer;
|
76153
76227
|
/**
|
76154
|
-
* Writes to the DynamoDB table that you created. The default action payload contains all attribute-value pairs that have the information about the detector model instance and the event that triggered the action. You can
|
76228
|
+
* Writes to the DynamoDB table that you created. The default action payload contains all attribute-value pairs that have the information about the detector model instance and the event that triggered the action. You can customize the [payload](https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html). One column of the DynamoDB table receives all attribute-value pairs in the payload that you specify. For more information, see [Actions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-event-actions.html) in *Developer Guide*.
|
76155
76229
|
*/
|
76156
76230
|
DynamoDB?: IoTEventsDetectorModelDynamoDB;
|
76157
76231
|
/**
|
76158
|
-
|
76159
|
-
|
76160
|
-
You can use expressions for parameters that are strings. For more information, see [Expressions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) in the *AWS IoT Events Developer Guide*.
|
76161
|
-
*/
|
76232
|
+
* Writes to the DynamoDB table that you created. The default action payload contains all attribute-value pairs that have the information about the detector model instance and the event that triggered the action. You can customize the [payload](https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html). A separate column of the DynamoDB table receives one attribute-value pair in the payload that you specify. For more information, see [Actions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-event-actions.html) in *Developer Guide*.
|
76233
|
+
*/
|
76162
76234
|
DynamoDBv2?: IoTEventsDetectorModelDynamoDBv2;
|
76163
76235
|
/**
|
76164
76236
|
* Sends information about the detector model instance and the event that triggered the action to an Amazon Kinesis Data Firehose delivery stream.
|
76165
76237
|
*/
|
76166
76238
|
Firehose?: IoTEventsDetectorModelFirehose;
|
76167
76239
|
/**
|
76168
|
-
* Sends
|
76240
|
+
* Sends ITE input, which passes information about the detector model instance and the event that triggered the action.
|
76169
76241
|
*/
|
76170
76242
|
IotEvents?: IoTEventsDetectorModelIotEvents;
|
76171
76243
|
/**
|
76172
|
-
* Sends information about the detector model instance and the event that triggered the action to
|
76244
|
+
* Sends information about the detector model instance and the event that triggered the action to an asset property in ITSW .
|
76173
76245
|
*/
|
76174
76246
|
IotSiteWise?: IoTEventsDetectorModelIotSiteWise;
|
76175
76247
|
/**
|
76176
|
-
*
|
76248
|
+
* Publishes an MQTT message with the given topic to the IoT message broker.
|
76177
76249
|
*/
|
76178
76250
|
IotTopicPublish?: IoTEventsDetectorModelIotTopicPublish;
|
76251
|
+
/**
|
76252
|
+
* Calls a Lambda function, passing in information about the detector model instance and the event that triggered the action.
|
76253
|
+
*/
|
76179
76254
|
Lambda?: IoTEventsDetectorModelLambda;
|
76180
76255
|
/**
|
76181
|
-
* Information
|
76256
|
+
* Information needed to reset the timer.
|
76182
76257
|
*/
|
76183
76258
|
ResetTimer?: IoTEventsDetectorModelResetTimer;
|
76184
76259
|
/**
|
@@ -76186,69 +76261,97 @@ export type IoTEventsDetectorModelAction = {
|
|
76186
76261
|
*/
|
76187
76262
|
SetTimer?: IoTEventsDetectorModelSetTimer;
|
76188
76263
|
/**
|
76189
|
-
*
|
76264
|
+
* Sets a variable to a specified value.
|
76190
76265
|
*/
|
76191
76266
|
SetVariable?: IoTEventsDetectorModelSetVariable;
|
76192
76267
|
/**
|
76193
|
-
*
|
76268
|
+
* Sends an Amazon SNS message.
|
76194
76269
|
*/
|
76195
76270
|
Sns?: IoTEventsDetectorModelSns;
|
76271
|
+
/**
|
76272
|
+
* Sends an Amazon SNS message.
|
76273
|
+
*/
|
76196
76274
|
Sqs?: IoTEventsDetectorModelSqs;
|
76197
76275
|
};
|
76198
76276
|
/**
|
76199
76277
|
* Type definition for `AWS::IoTEvents::DetectorModel.AssetPropertyTimestamp`.
|
76200
|
-
* A structure that contains timestamp information. For more information, see [TimeInNanos](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_TimeInNanos.html) in the *
|
76278
|
+
* A structure that contains timestamp information. For more information, see [TimeInNanos](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_TimeInNanos.html) in the *API Reference*.
|
76279
|
+
You must use expressions for all parameters in ``AssetPropertyTimestamp``. The expressions accept literals, operators, functions, references, and substitution templates.
|
76280
|
+
**Examples**
|
76281
|
+
+ For literal values, the expressions must contain single quotes. For example, the value for the ``timeInSeconds`` parameter can be ``'1586400675'``.
|
76282
|
+
+ For references, you must specify either variables or input values. For example, the value for the ``offsetInNanos`` parameter can be ``$variable.time``.
|
76283
|
+
+ For a substitution template, you must use ``${}``, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.
|
76284
|
+
In the following example, the value for the ``timeInSeconds`` parameter uses a substitution template.
|
76285
|
+
``'${$input.TemperatureInput.sensorData.timestamp / 1000}'``
|
76286
|
+
|
76287
|
+
For more information, see [Expressions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) in the *Developer Guide*.
|
76201
76288
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-assetpropertytimestamp.html}
|
76202
76289
|
*/
|
76203
76290
|
export type IoTEventsDetectorModelAssetPropertyTimestamp = {
|
76204
76291
|
/**
|
76205
|
-
* The
|
76292
|
+
* The nanosecond offset converted from ``timeInSeconds``. The valid range is between 0-999999999.
|
76206
76293
|
*/
|
76207
76294
|
OffsetInNanos?: string;
|
76208
76295
|
/**
|
76209
|
-
* The
|
76296
|
+
* The timestamp, in seconds, in the Unix epoch format. The valid range is between 1-31556889864403199.
|
76210
76297
|
*/
|
76211
76298
|
TimeInSeconds: string;
|
76212
76299
|
};
|
76213
76300
|
/**
|
76214
76301
|
* Type definition for `AWS::IoTEvents::DetectorModel.AssetPropertyValue`.
|
76215
|
-
* A structure that contains value information. For more information, see [AssetPropertyValue](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_AssetPropertyValue.html) in the *
|
76302
|
+
* A structure that contains value information. For more information, see [AssetPropertyValue](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_AssetPropertyValue.html) in the *API Reference*.
|
76303
|
+
You must use expressions for all parameters in ``AssetPropertyValue``. The expressions accept literals, operators, functions, references, and substitution templates.
|
76304
|
+
**Examples**
|
76305
|
+
+ For literal values, the expressions must contain single quotes. For example, the value for the ``quality`` parameter can be ``'GOOD'``.
|
76306
|
+
+ For references, you must specify either variables or input values. For example, the value for the ``quality`` parameter can be ``$input.TemperatureInput.sensorData.quality``.
|
76307
|
+
|
76308
|
+
For more information, see [Expressions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) in the *Developer Guide*.
|
76216
76309
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-assetpropertyvalue.html}
|
76217
76310
|
*/
|
76218
76311
|
export type IoTEventsDetectorModelAssetPropertyValue = {
|
76219
76312
|
/**
|
76220
|
-
* The quality of the asset property value. The value must be
|
76313
|
+
* The quality of the asset property value. The value must be ``'GOOD'``, ``'BAD'``, or ``'UNCERTAIN'``.
|
76221
76314
|
*/
|
76222
76315
|
Quality?: string;
|
76223
76316
|
/**
|
76224
|
-
*
|
76317
|
+
* The timestamp associated with the asset property value. The default is the current event time.
|
76225
76318
|
*/
|
76226
76319
|
Timestamp?: IoTEventsDetectorModelAssetPropertyTimestamp;
|
76227
76320
|
/**
|
76228
|
-
*
|
76321
|
+
* The value to send to an asset property.
|
76229
76322
|
*/
|
76230
76323
|
Value: IoTEventsDetectorModelAssetPropertyVariant;
|
76231
76324
|
};
|
76232
76325
|
/**
|
76233
76326
|
* Type definition for `AWS::IoTEvents::DetectorModel.AssetPropertyVariant`.
|
76234
|
-
* A structure that contains an asset property value. For more information, see [Variant](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_Variant.html) in the *
|
76327
|
+
* A structure that contains an asset property value. For more information, see [Variant](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_Variant.html) in the *API Reference*.
|
76328
|
+
You must use expressions for all parameters in ``AssetPropertyVariant``. The expressions accept literals, operators, functions, references, and substitution templates.
|
76329
|
+
**Examples**
|
76330
|
+
+ For literal values, the expressions must contain single quotes. For example, the value for the ``integerValue`` parameter can be ``'100'``.
|
76331
|
+
+ For references, you must specify either variables or parameters. For example, the value for the ``booleanValue`` parameter can be ``$variable.offline``.
|
76332
|
+
+ For a substitution template, you must use ``${}``, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.
|
76333
|
+
In the following example, the value for the ``doubleValue`` parameter uses a substitution template.
|
76334
|
+
``'${$input.TemperatureInput.sensorData.temperature * 6 / 5 + 32}'``
|
76335
|
+
|
76336
|
+
For more information, see [Expressions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) in the *Developer Guide*.
|
76337
|
+
You must specify one of the following value types, depending on the ``dataType`` of the specified asset property. For more information, see [AssetProperty](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_AssetProperty.html) in the *API Reference*.
|
76235
76338
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-assetpropertyvariant.html}
|
76236
76339
|
*/
|
76237
76340
|
export type IoTEventsDetectorModelAssetPropertyVariant = {
|
76238
76341
|
/**
|
76239
|
-
* The asset property value is a Boolean value that must be
|
76342
|
+
* The asset property value is a Boolean value that must be ``'TRUE'`` or ``'FALSE'``. You must use an expression, and the evaluated result should be a Boolean value.
|
76240
76343
|
*/
|
76241
76344
|
BooleanValue?: string;
|
76242
76345
|
/**
|
76243
|
-
* The asset property value is a double. You
|
76346
|
+
* The asset property value is a double. You must use an expression, and the evaluated result should be a double.
|
76244
76347
|
*/
|
76245
76348
|
DoubleValue?: string;
|
76246
76349
|
/**
|
76247
|
-
* The asset property value is an integer. You
|
76350
|
+
* The asset property value is an integer. You must use an expression, and the evaluated result should be an integer.
|
76248
76351
|
*/
|
76249
76352
|
IntegerValue?: string;
|
76250
76353
|
/**
|
76251
|
-
* The asset property value is a string. You
|
76354
|
+
* The asset property value is a string. You must use an expression, and the evaluated result should be a string.
|
76252
76355
|
*/
|
76253
76356
|
StringValue?: string;
|
76254
76357
|
};
|
@@ -76259,6 +76362,7 @@ export type IoTEventsDetectorModelAssetPropertyVariant = {
|
|
76259
76362
|
*/
|
76260
76363
|
export type IoTEventsDetectorModelClearTimer = {
|
76261
76364
|
/**
|
76365
|
+
* The name of the timer to clear.
|
76262
76366
|
* @minLength `1`
|
76263
76367
|
* @maxLength `128`
|
76264
76368
|
*/
|
@@ -76284,22 +76388,33 @@ export type IoTEventsDetectorModelDetectorModelDefinition = {
|
|
76284
76388
|
};
|
76285
76389
|
/**
|
76286
76390
|
* Type definition for `AWS::IoTEvents::DetectorModel.DynamoDB`.
|
76287
|
-
*
|
76391
|
+
* 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](https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html). One column of the DynamoDB table receives all attribute-value pairs in the payload that you specify.
|
76392
|
+
You must use expressions for all parameters in ``DynamoDBAction``. The expressions accept literals, operators, functions, references, and substitution templates.
|
76393
|
+
**Examples**
|
76394
|
+
+ For literal values, the expressions must contain single quotes. For example, the value for the ``hashKeyType`` parameter can be ``'STRING'``.
|
76395
|
+
+ For references, you must specify either variables or input values. For example, the value for the ``hashKeyField`` parameter can be ``$input.GreenhouseInput.name``.
|
76396
|
+
+ For a substitution template, you must use ``${}``, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.
|
76397
|
+
In the following example, the value for the ``hashKeyValue`` parameter uses a substitution template.
|
76398
|
+
``'${$input.GreenhouseInput.temperature * 6 / 5 + 32} in Fahrenheit'``
|
76399
|
+
+ For a string concatenation, you must use ``+``. A string concatenation can also contain a combination of literals, operators, functions, references, and substitution templates.
|
76400
|
+
In the following example, the value for the ``tableName`` parameter uses a string concatenation.
|
76401
|
+
``'GreenhouseTemperatureTable ' + $input.GreenhouseInput.date``
|
76402
|
+
|
76403
|
+
For more information, see [Expressions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) in the *Developer Guide*.
|
76404
|
+
If the defined payload type is a string, ``DynamoDBAction`` writes non-JSON data to the DynamoDB table as binary data. The DynamoDB console displays the data as Base64-encoded text. The value for the ``payloadField`` parameter is ``<payload-field>_raw``.
|
76288
76405
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-dynamodb.html}
|
76289
76406
|
*/
|
76290
76407
|
export type IoTEventsDetectorModelDynamoDB = {
|
76291
76408
|
/**
|
76292
|
-
* The name of the hash key (also called the partition key).
|
76409
|
+
* The name of the hash key (also called the partition key). The ``hashKeyField`` value must match the partition key of the target DynamoDB table.
|
76293
76410
|
*/
|
76294
76411
|
HashKeyField: string;
|
76295
76412
|
/**
|
76296
76413
|
* The data type for the hash key (also called the partition key). You can specify the following values:
|
76297
|
-
|
76298
|
-
|
76299
|
-
|
76300
|
-
|
76301
|
-
|
76302
|
-
If you don't specify `hashKeyType`, the default value is `STRING`.
|
76414
|
+
+ ``'STRING'`` - The hash key is a string.
|
76415
|
+
+ ``'NUMBER'`` - The hash key is a number.
|
76416
|
+
|
76417
|
+
If you don't specify ``hashKeyType``, the default value is ``'STRING'``.
|
76303
76418
|
*/
|
76304
76419
|
HashKeyType?: string;
|
76305
76420
|
/**
|
@@ -76308,40 +76423,33 @@ export type IoTEventsDetectorModelDynamoDB = {
|
|
76308
76423
|
HashKeyValue: string;
|
76309
76424
|
/**
|
76310
76425
|
* The type of operation to perform. You can specify the following values:
|
76311
|
-
|
76312
|
-
|
76313
|
-
|
76314
|
-
|
76315
|
-
|
76316
|
-
* `DELETE` - Delete an existing item of the DynamoDB table. This item's partition key must match the specified hash key. If you specified a range key, the range key must match the item's sort key.
|
76317
|
-
|
76318
|
-
If you don't specify this parameter, AWS IoT Events triggers the `INSERT` operation.
|
76426
|
+
+ ``'INSERT'`` - Insert data as a new item into the DynamoDB table. This item uses the specified hash key as a partition key. If you specified a range key, the item uses the range key as a sort key.
|
76427
|
+
+ ``'UPDATE'`` - Update an existing item of the DynamoDB table with new data. This item's partition key must match the specified hash key. If you specified a range key, the range key must match the item's sort key.
|
76428
|
+
+ ``'DELETE'`` - Delete an existing item of the DynamoDB table. This item's partition key must match the specified hash key. If you specified a range key, the range key must match the item's sort key.
|
76429
|
+
|
76430
|
+
If you don't specify this parameter, ITE triggers the ``'INSERT'`` operation.
|
76319
76431
|
*/
|
76320
76432
|
Operation?: string;
|
76321
76433
|
/**
|
76322
76434
|
* Information needed to configure the payload.
|
76323
|
-
|
76324
|
-
By default, AWS IoT Events 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`.
|
76435
|
+
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``.
|
76325
76436
|
*/
|
76326
76437
|
Payload?: IoTEventsDetectorModelPayload;
|
76327
76438
|
/**
|
76328
76439
|
* The name of the DynamoDB column that receives the action payload.
|
76329
|
-
|
76330
|
-
If you don't specify this parameter, the name of the DynamoDB column is `payload`.
|
76440
|
+
If you don't specify this parameter, the name of the DynamoDB column is ``payload``.
|
76331
76441
|
*/
|
76332
76442
|
PayloadField?: string;
|
76333
76443
|
/**
|
76334
|
-
* The name of the range key (also called the sort key).
|
76444
|
+
* The name of the range key (also called the sort key). The ``rangeKeyField`` value must match the sort key of the target DynamoDB table.
|
76335
76445
|
*/
|
76336
76446
|
RangeKeyField?: string;
|
76337
76447
|
/**
|
76338
76448
|
* The data type for the range key (also called the sort key), You can specify the following values:
|
76339
|
-
|
76340
|
-
|
76341
|
-
|
76342
|
-
|
76343
|
-
|
76344
|
-
If you don't specify `rangeKeyField`, the default value is `STRING`.
|
76449
|
+
+ ``'STRING'`` - The range key is a string.
|
76450
|
+
+ ``'NUMBER'`` - The range key is number.
|
76451
|
+
|
76452
|
+
If you don't specify ``rangeKeyField``, the default value is ``'STRING'``.
|
76345
76453
|
*/
|
76346
76454
|
RangeKeyType?: string;
|
76347
76455
|
/**
|
@@ -76349,22 +76457,32 @@ export type IoTEventsDetectorModelDynamoDB = {
|
|
76349
76457
|
*/
|
76350
76458
|
RangeKeyValue?: string;
|
76351
76459
|
/**
|
76352
|
-
* The name of the DynamoDB table.
|
76460
|
+
* The name of the DynamoDB table. The ``tableName`` value must match the table name of the target DynamoDB table.
|
76353
76461
|
*/
|
76354
76462
|
TableName: string;
|
76355
76463
|
};
|
76356
76464
|
/**
|
76357
76465
|
* Type definition for `AWS::IoTEvents::DetectorModel.DynamoDBv2`.
|
76358
|
-
* Defines an action to write to the Amazon DynamoDB table that you created. The default action payload contains all
|
76359
|
-
|
76360
|
-
|
76466
|
+
* 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](https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html). A separate column of the DynamoDB table receives one attribute-value pair in the payload that you specify.
|
76467
|
+
You must use expressions for all parameters in ``DynamoDBv2Action``. The expressions accept literals, operators, functions, references, and substitution templates.
|
76468
|
+
**Examples**
|
76469
|
+
+ For literal values, the expressions must contain single quotes. For example, the value for the ``tableName`` parameter can be ``'GreenhouseTemperatureTable'``.
|
76470
|
+
+ For references, you must specify either variables or input values. For example, the value for the ``tableName`` parameter can be ``$variable.ddbtableName``.
|
76471
|
+
+ For a substitution template, you must use ``${}``, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.
|
76472
|
+
In the following example, the value for the ``contentExpression`` parameter in ``Payload`` uses a substitution template.
|
76473
|
+
``'{\"sensorID\": \"${$input.GreenhouseInput.sensor_id}\", \"temperature\": \"${$input.GreenhouseInput.temperature * 9 / 5 + 32}\"}'``
|
76474
|
+
+ For a string concatenation, you must use ``+``. A string concatenation can also contain a combination of literals, operators, functions, references, and substitution templates.
|
76475
|
+
In the following example, the value for the ``tableName`` parameter uses a string concatenation.
|
76476
|
+
``'GreenhouseTemperatureTable ' + $input.GreenhouseInput.date``
|
76477
|
+
|
76478
|
+
For more information, see [Expressions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) in the *Developer Guide*.
|
76479
|
+
The value for the ``type`` parameter in ``Payload`` must be ``JSON``.
|
76361
76480
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-dynamodbv2.html}
|
76362
76481
|
*/
|
76363
76482
|
export type IoTEventsDetectorModelDynamoDBv2 = {
|
76364
76483
|
/**
|
76365
76484
|
* Information needed to configure the payload.
|
76366
|
-
|
76367
|
-
By default, AWS IoT Events 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`.
|
76485
|
+
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``.
|
76368
76486
|
*/
|
76369
76487
|
Payload?: IoTEventsDetectorModelPayload;
|
76370
76488
|
/**
|
@@ -76374,7 +76492,7 @@ export type IoTEventsDetectorModelDynamoDBv2 = {
|
|
76374
76492
|
};
|
76375
76493
|
/**
|
76376
76494
|
* Type definition for `AWS::IoTEvents::DetectorModel.Event`.
|
76377
|
-
* Specifies the
|
76495
|
+
* Specifies the ``actions`` to be performed when the ``condition`` evaluates to TRUE.
|
76378
76496
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-event.html}
|
76379
76497
|
*/
|
76380
76498
|
export type IoTEventsDetectorModelEvent = {
|
@@ -76383,7 +76501,7 @@ export type IoTEventsDetectorModelEvent = {
|
|
76383
76501
|
*/
|
76384
76502
|
Actions?: IoTEventsDetectorModelAction[];
|
76385
76503
|
/**
|
76386
|
-
* The Boolean expression that, when
|
76504
|
+
* Optional. The Boolean expression that, when TRUE, causes the ``actions`` to be performed. If not present, the actions are performed (=TRUE). If the expression result is not a Boolean value, the actions are not performed (=FALSE).
|
76387
76505
|
* @maxLength `512`
|
76388
76506
|
*/
|
76389
76507
|
Condition?: string;
|
@@ -76404,10 +76522,8 @@ export type IoTEventsDetectorModelFirehose = {
|
|
76404
76522
|
*/
|
76405
76523
|
DeliveryStreamName: string;
|
76406
76524
|
/**
|
76407
|
-
|
76408
|
-
|
76409
|
-
By default, AWS IoT Events 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`.
|
76410
|
-
*/
|
76525
|
+
* You can configure the action payload when you send a message to an Amazon Data Firehose delivery stream.
|
76526
|
+
*/
|
76411
76527
|
Payload?: IoTEventsDetectorModelPayload;
|
76412
76528
|
/**
|
76413
76529
|
* A character separator that is used to separate records written to the Kinesis Data Firehose delivery stream. Valid values are: '\n' (newline), '\t' (tab), '\r\n' (Windows newline), ',' (comma).
|
@@ -76417,72 +76533,79 @@ export type IoTEventsDetectorModelFirehose = {
|
|
76417
76533
|
};
|
76418
76534
|
/**
|
76419
76535
|
* Type definition for `AWS::IoTEvents::DetectorModel.IotEvents`.
|
76420
|
-
* Sends an
|
76536
|
+
* Sends an ITE input, passing in information about the detector model instance and the event that triggered the action.
|
76421
76537
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-iotevents.html}
|
76422
76538
|
*/
|
76423
76539
|
export type IoTEventsDetectorModelIotEvents = {
|
76424
76540
|
/**
|
76425
|
-
* The name of the
|
76541
|
+
* The name of the ITE input where the data is sent.
|
76426
76542
|
* @minLength `1`
|
76427
76543
|
* @maxLength `128`
|
76428
76544
|
* @pattern `^[a-zA-Z][a-zA-Z0-9_]*$`
|
76429
76545
|
*/
|
76430
76546
|
InputName: string;
|
76431
76547
|
/**
|
76432
|
-
|
76433
|
-
|
76434
|
-
By default, AWS IoT Events 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`.
|
76435
|
-
*/
|
76548
|
+
* You can configure the action payload when you send a message to an ITE input.
|
76549
|
+
*/
|
76436
76550
|
Payload?: IoTEventsDetectorModelPayload;
|
76437
76551
|
};
|
76438
76552
|
/**
|
76439
76553
|
* Type definition for `AWS::IoTEvents::DetectorModel.IotSiteWise`.
|
76440
|
-
* Sends information about the detector model instance and the event that triggered the action to a specified asset property in
|
76554
|
+
* Sends information about the detector model instance and the event that triggered the action to a specified asset property in ITSW.
|
76555
|
+
You must use expressions for all parameters in ``IotSiteWiseAction``. The expressions accept literals, operators, functions, references, and substitutions templates.
|
76556
|
+
**Examples**
|
76557
|
+
+ For literal values, the expressions must contain single quotes. For example, the value for the ``propertyAlias`` parameter can be ``'/company/windfarm/3/turbine/7/temperature'``.
|
76558
|
+
+ For references, you must specify either variables or input values. For example, the value for the ``assetId`` parameter can be ``$input.TurbineInput.assetId1``.
|
76559
|
+
+ For a substitution template, you must use ``${}``, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.
|
76560
|
+
In the following example, the value for the ``propertyAlias`` parameter uses a substitution template.
|
76561
|
+
``'company/windfarm/${$input.TemperatureInput.sensorData.windfarmID}/turbine/ ${$input.TemperatureInput.sensorData.turbineID}/temperature'``
|
76562
|
+
|
76563
|
+
You must specify either ``propertyAlias`` or both ``assetId`` and ``propertyId`` to identify the target asset property in ITSW.
|
76564
|
+
For more information, see [Expressions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) in the *Developer Guide*.
|
76441
76565
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-iotsitewise.html}
|
76442
76566
|
*/
|
76443
76567
|
export type IoTEventsDetectorModelIotSiteWise = {
|
76444
76568
|
/**
|
76445
|
-
* The ID of the asset that has the specified property.
|
76569
|
+
* The ID of the asset that has the specified property.
|
76446
76570
|
*/
|
76447
76571
|
AssetId?: string;
|
76448
76572
|
/**
|
76449
|
-
* A unique identifier for this entry. You can use the entry ID to track which data entry causes an error in case of failure. The default is a new unique identifier.
|
76573
|
+
* A unique identifier for this entry. You can use the entry ID to track which data entry causes an error in case of failure. The default is a new unique identifier.
|
76450
76574
|
*/
|
76451
76575
|
EntryId?: string;
|
76452
76576
|
/**
|
76453
|
-
* The alias of the asset property.
|
76577
|
+
* The alias of the asset property.
|
76454
76578
|
*/
|
76455
76579
|
PropertyAlias?: string;
|
76456
76580
|
/**
|
76457
|
-
* The ID of the asset property.
|
76581
|
+
* The ID of the asset property.
|
76458
76582
|
*/
|
76459
76583
|
PropertyId?: string;
|
76460
76584
|
/**
|
76461
|
-
*
|
76585
|
+
* The value to send to the asset property. This value contains timestamp, quality, and value (TQV) information.
|
76462
76586
|
*/
|
76463
76587
|
PropertyValue: IoTEventsDetectorModelAssetPropertyValue;
|
76464
76588
|
};
|
76465
76589
|
/**
|
76466
76590
|
* Type definition for `AWS::IoTEvents::DetectorModel.IotTopicPublish`.
|
76467
|
-
* Information required to publish the MQTT message through the
|
76591
|
+
* Information required to publish the MQTT message through the IoT message broker.
|
76468
76592
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-iottopicpublish.html}
|
76469
76593
|
*/
|
76470
76594
|
export type IoTEventsDetectorModelIotTopicPublish = {
|
76471
76595
|
/**
|
76472
|
-
* The MQTT topic of the message. You can use a string expression that includes variables (
|
76596
|
+
* The MQTT topic of the message. You can use a string expression that includes variables (``$variable.<variable-name>``) and input values (``$input.<input-name>.<path-to-datum>``) as the topic string.
|
76473
76597
|
* @minLength `1`
|
76474
76598
|
* @maxLength `128`
|
76475
76599
|
*/
|
76476
76600
|
MqttTopic: string;
|
76477
76601
|
/**
|
76478
|
-
|
76479
|
-
|
76480
|
-
By default, AWS IoT Events 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`.
|
76481
|
-
*/
|
76602
|
+
* You can configure the action payload when you publish a message to an IoTCore topic.
|
76603
|
+
*/
|
76482
76604
|
Payload?: IoTEventsDetectorModelPayload;
|
76483
76605
|
};
|
76484
76606
|
/**
|
76485
76607
|
* Type definition for `AWS::IoTEvents::DetectorModel.Lambda`.
|
76608
|
+
* Calls a Lambda function, passing in information about the detector model instance and the event that triggered the action.
|
76486
76609
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-lambda.html}
|
76487
76610
|
*/
|
76488
76611
|
export type IoTEventsDetectorModelLambda = {
|
@@ -76493,64 +76616,61 @@ export type IoTEventsDetectorModelLambda = {
|
|
76493
76616
|
*/
|
76494
76617
|
FunctionArn: string;
|
76495
76618
|
/**
|
76496
|
-
|
76497
|
-
|
76498
|
-
By default, AWS IoT Events 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`.
|
76499
|
-
*/
|
76619
|
+
* You can configure the action payload when you send a message to a Lambda function.
|
76620
|
+
*/
|
76500
76621
|
Payload?: IoTEventsDetectorModelPayload;
|
76501
76622
|
};
|
76502
76623
|
/**
|
76503
76624
|
* Type definition for `AWS::IoTEvents::DetectorModel.OnEnter`.
|
76504
|
-
* When entering this state, perform these
|
76625
|
+
* When entering this state, perform these ``actions`` if the ``condition`` is TRUE.
|
76505
76626
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-onenter.html}
|
76506
76627
|
*/
|
76507
76628
|
export type IoTEventsDetectorModelOnEnter = {
|
76508
76629
|
/**
|
76509
|
-
* Specifies the
|
76630
|
+
* Specifies the actions that are performed when the state is entered and the ``condition`` is ``TRUE``.
|
76510
76631
|
*/
|
76511
76632
|
Events?: IoTEventsDetectorModelEvent[];
|
76512
76633
|
};
|
76513
76634
|
/**
|
76514
76635
|
* Type definition for `AWS::IoTEvents::DetectorModel.OnExit`.
|
76515
|
-
* When exiting this state, perform these
|
76636
|
+
* When exiting this state, perform these ``actions`` if the specified ``condition`` is ``TRUE``.
|
76516
76637
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-onexit.html}
|
76517
76638
|
*/
|
76518
76639
|
export type IoTEventsDetectorModelOnExit = {
|
76519
76640
|
/**
|
76520
|
-
* Specifies the
|
76641
|
+
* Specifies the ``actions`` that are performed when the state is exited and the ``condition`` is ``TRUE``.
|
76521
76642
|
*/
|
76522
76643
|
Events?: IoTEventsDetectorModelEvent[];
|
76523
76644
|
};
|
76524
76645
|
/**
|
76525
76646
|
* Type definition for `AWS::IoTEvents::DetectorModel.OnInput`.
|
76526
|
-
*
|
76647
|
+
* Specifies the actions performed when the ``condition`` evaluates to TRUE.
|
76527
76648
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-oninput.html}
|
76528
76649
|
*/
|
76529
76650
|
export type IoTEventsDetectorModelOnInput = {
|
76530
76651
|
/**
|
76531
|
-
* Specifies the
|
76652
|
+
* Specifies the actions performed when the ``condition`` evaluates to TRUE.
|
76532
76653
|
*/
|
76533
76654
|
Events?: IoTEventsDetectorModelEvent[];
|
76534
76655
|
/**
|
76535
|
-
* Specifies the
|
76656
|
+
* Specifies the actions performed, and the next state entered, when a ``condition`` evaluates to TRUE.
|
76536
76657
|
*/
|
76537
76658
|
TransitionEvents?: IoTEventsDetectorModelTransitionEvent[];
|
76538
76659
|
};
|
76539
76660
|
/**
|
76540
76661
|
* Type definition for `AWS::IoTEvents::DetectorModel.Payload`.
|
76541
76662
|
* Information needed to configure the payload.
|
76542
|
-
|
76543
|
-
By default, AWS IoT Events 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`.
|
76663
|
+
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``.
|
76544
76664
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-payload.html}
|
76545
76665
|
*/
|
76546
76666
|
export type IoTEventsDetectorModelPayload = {
|
76547
76667
|
/**
|
76548
|
-
* The content of the payload. You can use a string expression that includes quoted strings (
|
76668
|
+
* The content of the payload. You can use a string expression that includes quoted strings (``'<string>'``), variables (``$variable.<variable-name>``), input values (``$input.<input-name>.<path-to-datum>``), string concatenations, and quoted strings that contain ``${}`` as the content. The recommended maximum size of a content expression is 1 KB.
|
76549
76669
|
* @minLength `1`
|
76550
76670
|
*/
|
76551
76671
|
ContentExpression: string;
|
76552
76672
|
/**
|
76553
|
-
* The value of the payload type can be either
|
76673
|
+
* The value of the payload type can be either ``STRING`` or ``JSON``.
|
76554
76674
|
*/
|
76555
76675
|
Type: string;
|
76556
76676
|
};
|
@@ -76574,13 +76694,13 @@ export type IoTEventsDetectorModelResetTimer = {
|
|
76574
76694
|
*/
|
76575
76695
|
export type IoTEventsDetectorModelSetTimer = {
|
76576
76696
|
/**
|
76577
|
-
* The duration of the timer, in seconds. You can use a string expression that includes numbers, variables (
|
76697
|
+
* The duration of the timer, in seconds. You can use a string expression that includes numbers, variables (``$variable.<variable-name>``), and input values (``$input.<input-name>.<path-to-datum>``) as the duration. The range of the duration is 1-31622400 seconds. To ensure accuracy, the minimum duration is 60 seconds. The evaluated result of the duration is rounded down to the nearest whole number.
|
76578
76698
|
* @minLength `1`
|
76579
76699
|
* @maxLength `1024`
|
76580
76700
|
*/
|
76581
76701
|
DurationExpression?: string;
|
76582
76702
|
/**
|
76583
|
-
* The number of seconds until the timer expires. The minimum value is
|
76703
|
+
* The number of seconds until the timer expires. The minimum value is 60 seconds to ensure accuracy. The maximum value is 31622400 seconds.
|
76584
76704
|
* @min `60`
|
76585
76705
|
* @max `31622400`
|
76586
76706
|
*/
|
@@ -76619,10 +76739,8 @@ export type IoTEventsDetectorModelSetVariable = {
|
|
76619
76739
|
*/
|
76620
76740
|
export type IoTEventsDetectorModelSns = {
|
76621
76741
|
/**
|
76622
|
-
|
76623
|
-
|
76624
|
-
By default, AWS IoT Events 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`.
|
76625
|
-
*/
|
76742
|
+
* You can configure the action payload when you send a message as an Amazon SNS push notification.
|
76743
|
+
*/
|
76626
76744
|
Payload?: IoTEventsDetectorModelPayload;
|
76627
76745
|
/**
|
76628
76746
|
* The ARN of the Amazon SNS target where the message is sent.
|
@@ -76633,21 +76751,20 @@ export type IoTEventsDetectorModelSns = {
|
|
76633
76751
|
};
|
76634
76752
|
/**
|
76635
76753
|
* Type definition for `AWS::IoTEvents::DetectorModel.Sqs`.
|
76754
|
+
* Sends information about the detector model instance and the event that triggered the action to an Amazon SQS queue.
|
76636
76755
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-sqs.html}
|
76637
76756
|
*/
|
76638
76757
|
export type IoTEventsDetectorModelSqs = {
|
76639
76758
|
/**
|
76640
|
-
|
76641
|
-
|
76642
|
-
By default, AWS IoT Events 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`.
|
76643
|
-
*/
|
76759
|
+
* You can configure the action payload when you send a message to an Amazon SQS queue.
|
76760
|
+
*/
|
76644
76761
|
Payload?: IoTEventsDetectorModelPayload;
|
76645
76762
|
/**
|
76646
76763
|
* The URL of the SQS queue where the data is written.
|
76647
76764
|
*/
|
76648
76765
|
QueueUrl: string;
|
76649
76766
|
/**
|
76650
|
-
* Set this to
|
76767
|
+
* Set this to TRUE if you want the data to be base-64 encoded before it is written to the queue. Otherwise, set this to FALSE.
|
76651
76768
|
*/
|
76652
76769
|
UseBase64?: boolean;
|
76653
76770
|
};
|
@@ -76658,15 +76775,15 @@ export type IoTEventsDetectorModelSqs = {
|
|
76658
76775
|
*/
|
76659
76776
|
export type IoTEventsDetectorModelState = {
|
76660
76777
|
/**
|
76661
|
-
* When entering this state, perform these
|
76778
|
+
* When entering this state, perform these ``actions`` if the ``condition`` is TRUE.
|
76662
76779
|
*/
|
76663
76780
|
OnEnter?: IoTEventsDetectorModelOnEnter;
|
76664
76781
|
/**
|
76665
|
-
* When exiting this state, perform these
|
76782
|
+
* When exiting this state, perform these ``actions`` if the specified ``condition`` is ``TRUE``.
|
76666
76783
|
*/
|
76667
76784
|
OnExit?: IoTEventsDetectorModelOnExit;
|
76668
76785
|
/**
|
76669
|
-
* When an input is received and the
|
76786
|
+
* When an input is received and the ``condition`` is TRUE, perform the specified ``actions``.
|
76670
76787
|
*/
|
76671
76788
|
OnInput?: IoTEventsDetectorModelOnInput;
|
76672
76789
|
/**
|
@@ -76678,22 +76795,22 @@ export type IoTEventsDetectorModelState = {
|
|
76678
76795
|
};
|
76679
76796
|
/**
|
76680
76797
|
* Type definition for `AWS::IoTEvents::DetectorModel.Tag`.
|
76681
|
-
*
|
76798
|
+
* Metadata that can be used to manage the resource.
|
76682
76799
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-tag.html}
|
76683
76800
|
*/
|
76684
76801
|
export type IoTEventsDetectorModelTag = {
|
76685
76802
|
/**
|
76686
|
-
*
|
76803
|
+
* The tag's key.
|
76687
76804
|
*/
|
76688
76805
|
Key: string;
|
76689
76806
|
/**
|
76690
|
-
*
|
76807
|
+
* The tag's value.
|
76691
76808
|
*/
|
76692
76809
|
Value: string;
|
76693
76810
|
};
|
76694
76811
|
/**
|
76695
76812
|
* Type definition for `AWS::IoTEvents::DetectorModel.TransitionEvent`.
|
76696
|
-
* Specifies the
|
76813
|
+
* Specifies the actions performed and the next state entered when a ``condition`` evaluates to TRUE.
|
76697
76814
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-transitionevent.html}
|
76698
76815
|
*/
|
76699
76816
|
export type IoTEventsDetectorModelTransitionEvent = {
|
@@ -76702,12 +76819,12 @@ export type IoTEventsDetectorModelTransitionEvent = {
|
|
76702
76819
|
*/
|
76703
76820
|
Actions?: IoTEventsDetectorModelAction[];
|
76704
76821
|
/**
|
76705
|
-
* A Boolean expression that when
|
76822
|
+
* Required. A Boolean expression that when TRUE causes the actions to be performed and the ``nextState`` to be entered.
|
76706
76823
|
* @maxLength `512`
|
76707
76824
|
*/
|
76708
76825
|
Condition: string;
|
76709
76826
|
/**
|
76710
|
-
* The name of the event.
|
76827
|
+
* The name of the transition event.
|
76711
76828
|
* @minLength `1`
|
76712
76829
|
* @maxLength `128`
|
76713
76830
|
*/
|
@@ -76720,7 +76837,7 @@ export type IoTEventsDetectorModelTransitionEvent = {
|
|
76720
76837
|
NextState: string;
|
76721
76838
|
};
|
76722
76839
|
/**
|
76723
|
-
* The AWS::IoTEvents::Input resource creates an input. To monitor your devices and processes, they must have a way to get telemetry data into
|
76840
|
+
* 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](https://docs.aws.amazon.com/iotevents/latest/developerguide/how-to-use-iotevents.html) in the *Developer Guide*.
|
76724
76841
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-input.html}
|
76725
76842
|
*/
|
76726
76843
|
export type IoTEventsInputProps = {
|
@@ -76743,21 +76860,19 @@ export type IoTEventsInputProps = {
|
|
76743
76860
|
InputName?: string;
|
76744
76861
|
/**
|
76745
76862
|
* An array of key-value pairs to apply to this resource.
|
76746
|
-
|
76747
|
-
For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).
|
76863
|
+
For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).
|
76748
76864
|
*/
|
76749
76865
|
Tags?: IoTEventsInputTag[];
|
76750
76866
|
};
|
76751
76867
|
/**
|
76752
76868
|
* Type definition for `AWS::IoTEvents::Input.Attribute`.
|
76753
|
-
* The attributes from the JSON payload that are made available by the input. Inputs are derived from messages sent to the
|
76869
|
+
* 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.
|
76754
76870
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-input-attribute.html}
|
76755
76871
|
*/
|
76756
76872
|
export type IoTEventsInputAttribute = {
|
76757
76873
|
/**
|
76758
|
-
* An expression that specifies an attribute-value pair in a JSON structure. Use this to specify an attribute from the JSON payload that is made available by the input. Inputs are derived from messages sent to
|
76759
|
-
|
76760
|
-
_Syntax_: `<field-name>.<field-name>...`
|
76874
|
+
* An expression that specifies an attribute-value pair in a JSON structure. Use this to specify an attribute from the JSON payload that is made available by the input. Inputs are derived from messages sent to ITE (``BatchPutMessage``). Each such message contains a JSON payload. The attribute (and its paired value) specified here are available for use in the ``condition`` expressions used by detectors.
|
76875
|
+
Syntax: ``<field-name>.<field-name>...``
|
76761
76876
|
* @minLength `1`
|
76762
76877
|
* @maxLength `128`
|
76763
76878
|
* @pattern `^((`[a-zA-Z0-9_\- ]+`)|([a-zA-Z0-9_\-]+))(\.((`[a-zA-Z0-9_\- ]+`)|([a-zA-Z0-9_\-]+)))*$`
|
@@ -76771,7 +76886,7 @@ export type IoTEventsInputAttribute = {
|
|
76771
76886
|
*/
|
76772
76887
|
export type IoTEventsInputInputDefinition = {
|
76773
76888
|
/**
|
76774
|
-
* The attributes from the JSON payload that are made available by the input. Inputs are derived from messages sent to the
|
76889
|
+
* 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, and those attributes (and their paired values) specified here are available for use in the ``condition`` expressions used by detectors that monitor this input.
|
76775
76890
|
* @minLength `1`
|
76776
76891
|
* @maxLength `200`
|
76777
76892
|
*/
|
@@ -76779,16 +76894,16 @@ export type IoTEventsInputInputDefinition = {
|
|
76779
76894
|
};
|
76780
76895
|
/**
|
76781
76896
|
* Type definition for `AWS::IoTEvents::Input.Tag`.
|
76782
|
-
*
|
76897
|
+
* Metadata that can be used to manage the resource.
|
76783
76898
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-input-tag.html}
|
76784
76899
|
*/
|
76785
76900
|
export type IoTEventsInputTag = {
|
76786
76901
|
/**
|
76787
|
-
*
|
76902
|
+
* The tag's key.
|
76788
76903
|
*/
|
76789
76904
|
Key: string;
|
76790
76905
|
/**
|
76791
|
-
*
|
76906
|
+
* The tag's value.
|
76792
76907
|
*/
|
76793
76908
|
Value: string;
|
76794
76909
|
};
|