@aws-cdk/aws-iotevents-alpha 2.6.0-alpha.0 → 2.10.0-alpha.0
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/.jsii +822 -90
- package/.jsii.tabl.json +530 -55
- package/.warnings.jsii.js +37 -1
- package/README.md +23 -5
- package/lib/detector-model.d.ts +121 -0
- package/lib/detector-model.js +71 -0
- package/lib/event.d.ts +21 -0
- package/lib/event.js +3 -0
- package/lib/expression.d.ts +51 -0
- package/lib/expression.js +91 -0
- package/lib/index.d.ts +4 -0
- package/lib/index.js +5 -1
- package/lib/input.js +1 -1
- package/lib/state.d.ts +55 -0
- package/lib/state.js +55 -0
- package/package.json +17 -10
- package/rosetta/default.ts-fixture +10 -0
package/.jsii
CHANGED
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
"url": "https://aws.amazon.com"
|
|
9
9
|
},
|
|
10
10
|
"dependencies": {
|
|
11
|
-
"aws-cdk-lib": "^2.
|
|
11
|
+
"aws-cdk-lib": "^2.10.0",
|
|
12
12
|
"constructs": "^10.0.0"
|
|
13
13
|
},
|
|
14
14
|
"dependencyClosure": {
|
|
@@ -1185,6 +1185,19 @@
|
|
|
1185
1185
|
}
|
|
1186
1186
|
}
|
|
1187
1187
|
},
|
|
1188
|
+
"aws-cdk-lib.aws_forecast": {
|
|
1189
|
+
"targets": {
|
|
1190
|
+
"dotnet": {
|
|
1191
|
+
"namespace": "Amazon.CDK.AWS.Forecast"
|
|
1192
|
+
},
|
|
1193
|
+
"java": {
|
|
1194
|
+
"package": "software.amazon.awscdk.services.forecast"
|
|
1195
|
+
},
|
|
1196
|
+
"python": {
|
|
1197
|
+
"module": "aws_cdk.aws_forecast"
|
|
1198
|
+
}
|
|
1199
|
+
}
|
|
1200
|
+
},
|
|
1188
1201
|
"aws-cdk-lib.aws_frauddetector": {
|
|
1189
1202
|
"targets": {
|
|
1190
1203
|
"dotnet": {
|
|
@@ -1367,6 +1380,19 @@
|
|
|
1367
1380
|
}
|
|
1368
1381
|
}
|
|
1369
1382
|
},
|
|
1383
|
+
"aws-cdk-lib.aws_inspectorv2": {
|
|
1384
|
+
"targets": {
|
|
1385
|
+
"dotnet": {
|
|
1386
|
+
"namespace": "Amazon.CDK.AWS.InspectorV2"
|
|
1387
|
+
},
|
|
1388
|
+
"java": {
|
|
1389
|
+
"package": "software.amazon.awscdk.services.inspectorv2"
|
|
1390
|
+
},
|
|
1391
|
+
"python": {
|
|
1392
|
+
"module": "aws_cdk.aws_inspectorv2"
|
|
1393
|
+
}
|
|
1394
|
+
}
|
|
1395
|
+
},
|
|
1370
1396
|
"aws-cdk-lib.aws_iot": {
|
|
1371
1397
|
"targets": {
|
|
1372
1398
|
"dotnet": {
|
|
@@ -1536,6 +1562,19 @@
|
|
|
1536
1562
|
}
|
|
1537
1563
|
}
|
|
1538
1564
|
},
|
|
1565
|
+
"aws-cdk-lib.aws_kinesisanalyticsv2": {
|
|
1566
|
+
"targets": {
|
|
1567
|
+
"dotnet": {
|
|
1568
|
+
"namespace": "Amazon.CDK.AWS.KinesisAnalyticsV2"
|
|
1569
|
+
},
|
|
1570
|
+
"java": {
|
|
1571
|
+
"package": "software.amazon.awscdk.services.kinesisanalyticsv2"
|
|
1572
|
+
},
|
|
1573
|
+
"python": {
|
|
1574
|
+
"module": "aws_cdk.aws_kinesisanalyticsv2"
|
|
1575
|
+
}
|
|
1576
|
+
}
|
|
1577
|
+
},
|
|
1539
1578
|
"aws-cdk-lib.aws_kinesisfirehose": {
|
|
1540
1579
|
"targets": {
|
|
1541
1580
|
"dotnet": {
|
|
@@ -1549,6 +1588,19 @@
|
|
|
1549
1588
|
}
|
|
1550
1589
|
}
|
|
1551
1590
|
},
|
|
1591
|
+
"aws-cdk-lib.aws_kinesisvideo": {
|
|
1592
|
+
"targets": {
|
|
1593
|
+
"dotnet": {
|
|
1594
|
+
"namespace": "Amazon.CDK.AWS.KinesisVideo"
|
|
1595
|
+
},
|
|
1596
|
+
"java": {
|
|
1597
|
+
"package": "software.amazon.awscdk.services.kinesisvideo"
|
|
1598
|
+
},
|
|
1599
|
+
"python": {
|
|
1600
|
+
"module": "aws_cdk.aws_kinesisvideo"
|
|
1601
|
+
}
|
|
1602
|
+
}
|
|
1603
|
+
},
|
|
1552
1604
|
"aws-cdk-lib.aws_kms": {
|
|
1553
1605
|
"targets": {
|
|
1554
1606
|
"dotnet": {
|
|
@@ -2855,7 +2907,7 @@
|
|
|
2855
2907
|
"stability": "experimental"
|
|
2856
2908
|
},
|
|
2857
2909
|
"homepage": "https://github.com/aws/aws-cdk",
|
|
2858
|
-
"jsiiVersion": "1.
|
|
2910
|
+
"jsiiVersion": "1.52.1 (build 5ccc8f6)",
|
|
2859
2911
|
"keywords": [
|
|
2860
2912
|
"aws",
|
|
2861
2913
|
"cdk",
|
|
@@ -2869,12 +2921,15 @@
|
|
|
2869
2921
|
"compiledWithDeprecationWarnings": true,
|
|
2870
2922
|
"pacmak": {
|
|
2871
2923
|
"hasDefaultInterfaces": true
|
|
2924
|
+
},
|
|
2925
|
+
"rosetta": {
|
|
2926
|
+
"strict": true
|
|
2872
2927
|
}
|
|
2873
2928
|
}
|
|
2874
2929
|
},
|
|
2875
2930
|
"name": "@aws-cdk/aws-iotevents-alpha",
|
|
2876
2931
|
"readme": {
|
|
2877
|
-
"markdown": "# AWS::IoTEvents Construct Library\n\n<!--BEGIN STABILITY BANNER-->\n\n---\n\n\n\n> The APIs of higher level constructs in this module are experimental and under active development.\n> They are subject to non-backward compatible changes or removal in any future version. These are\n> not subject to the [Semantic Versioning](https://semver.org/) model and breaking changes will be\n> announced in the release notes. This means that while you may use them, you may need to update\n> your source code when upgrading to a newer version of this package.\n\n---\n\n<!--END STABILITY BANNER-->\n\nAWS IoT Events enables you to monitor your equipment or device fleets for\nfailures or changes in operation, and to trigger actions when such events\noccur.\n\n## Installation\n\nInstall the module:\n\n```console\n$ npm i @aws-cdk/aws-iotevents\n```\n\nImport it into your code:\n\n```ts nofixture\nimport * as iotevents from '@aws-cdk/aws-iotevents-alpha';\n```\n\n## `
|
|
2932
|
+
"markdown": "# AWS::IoTEvents Construct Library\n\n<!--BEGIN STABILITY BANNER-->\n\n---\n\n\n\n> The APIs of higher level constructs in this module are experimental and under active development.\n> They are subject to non-backward compatible changes or removal in any future version. These are\n> not subject to the [Semantic Versioning](https://semver.org/) model and breaking changes will be\n> announced in the release notes. This means that while you may use them, you may need to update\n> your source code when upgrading to a newer version of this package.\n\n---\n\n<!--END STABILITY BANNER-->\n\nAWS IoT Events enables you to monitor your equipment or device fleets for\nfailures or changes in operation, and to trigger actions when such events\noccur.\n\n## Installation\n\nInstall the module:\n\n```console\n$ npm i @aws-cdk/aws-iotevents\n```\n\nImport it into your code:\n\n```ts nofixture\nimport * as iotevents from '@aws-cdk/aws-iotevents-alpha';\n```\n\n## `DetectorModel`\n\nThe following example creates an AWS IoT Events detector model to your stack.\nThe detector model need a reference to at least one AWS IoT Events input.\nAWS IoT Events inputs enable the detector to get MQTT payload values from IoT Core rules.\n\n```ts\nimport * as iotevents from '@aws-cdk/aws-iotevents-alpha';\n\nconst input = new iotevents.Input(this, 'MyInput', {\n inputName: 'my_input', // optional\n attributeJsonPaths: ['payload.deviceId', 'payload.temperature'],\n});\n\nconst onlineState = new iotevents.State({\n stateName: 'online',\n onEnter: [{\n eventName: 'test-event',\n condition: iotevents.Expression.currentInput(input),\n }],\n});\n\nnew iotevents.DetectorModel(this, 'MyDetectorModel', {\n detectorModelName: 'test-detector-model', // optional\n description: 'test-detector-model-description', // optional property, default is none\n evaluationMethod: iotevents.EventEvaluation.SERIAL, // optional property, default is iotevents.EventEvaluation.BATCH\n detectorKey: 'payload.deviceId', // optional property, default is none and single detector instance will be created and all inputs will be routed to it\n initialState: onlineState,\n});\n```\n"
|
|
2878
2933
|
},
|
|
2879
2934
|
"repository": {
|
|
2880
2935
|
"directory": "packages/individual-packages/aws-iotevents",
|
|
@@ -2912,64 +2967,25 @@
|
|
|
2912
2967
|
}
|
|
2913
2968
|
},
|
|
2914
2969
|
"types": {
|
|
2915
|
-
"@aws-cdk/aws-iotevents-alpha.
|
|
2916
|
-
"assembly": "@aws-cdk/aws-iotevents-alpha",
|
|
2917
|
-
"docs": {
|
|
2918
|
-
"stability": "experimental",
|
|
2919
|
-
"summary": "Represents an AWS IoT Events input."
|
|
2920
|
-
},
|
|
2921
|
-
"fqn": "@aws-cdk/aws-iotevents-alpha.IInput",
|
|
2922
|
-
"interfaces": [
|
|
2923
|
-
"aws-cdk-lib.IResource"
|
|
2924
|
-
],
|
|
2925
|
-
"kind": "interface",
|
|
2926
|
-
"locationInModule": {
|
|
2927
|
-
"filename": "lib/input.ts",
|
|
2928
|
-
"line": 8
|
|
2929
|
-
},
|
|
2930
|
-
"name": "IInput",
|
|
2931
|
-
"properties": [
|
|
2932
|
-
{
|
|
2933
|
-
"abstract": true,
|
|
2934
|
-
"docs": {
|
|
2935
|
-
"custom": {
|
|
2936
|
-
"attribute": "true"
|
|
2937
|
-
},
|
|
2938
|
-
"stability": "experimental",
|
|
2939
|
-
"summary": "The name of the input."
|
|
2940
|
-
},
|
|
2941
|
-
"immutable": true,
|
|
2942
|
-
"locationInModule": {
|
|
2943
|
-
"filename": "lib/input.ts",
|
|
2944
|
-
"line": 13
|
|
2945
|
-
},
|
|
2946
|
-
"name": "inputName",
|
|
2947
|
-
"type": {
|
|
2948
|
-
"primitive": "string"
|
|
2949
|
-
}
|
|
2950
|
-
}
|
|
2951
|
-
],
|
|
2952
|
-
"symbolId": "lib/input:IInput"
|
|
2953
|
-
},
|
|
2954
|
-
"@aws-cdk/aws-iotevents-alpha.Input": {
|
|
2970
|
+
"@aws-cdk/aws-iotevents-alpha.DetectorModel": {
|
|
2955
2971
|
"assembly": "@aws-cdk/aws-iotevents-alpha",
|
|
2956
2972
|
"base": "aws-cdk-lib.Resource",
|
|
2957
2973
|
"docs": {
|
|
2958
2974
|
"custom": {
|
|
2959
2975
|
"exampleMetadata": "infused"
|
|
2960
2976
|
},
|
|
2961
|
-
"example": "import * as iotevents from '@aws-cdk/aws-iotevents-alpha';\n\
|
|
2977
|
+
"example": "import * as iotevents from '@aws-cdk/aws-iotevents-alpha';\n\nconst input = new iotevents.Input(this, 'MyInput', {\n inputName: 'my_input', // optional\n attributeJsonPaths: ['payload.deviceId', 'payload.temperature'],\n});\n\nconst onlineState = new iotevents.State({\n stateName: 'online',\n onEnter: [{\n eventName: 'test-event',\n condition: iotevents.Expression.currentInput(input),\n }],\n});\n\nnew iotevents.DetectorModel(this, 'MyDetectorModel', {\n detectorModelName: 'test-detector-model', // optional\n description: 'test-detector-model-description', // optional property, default is none\n evaluationMethod: iotevents.EventEvaluation.SERIAL, // optional property, default is iotevents.EventEvaluation.BATCH\n detectorKey: 'payload.deviceId', // optional property, default is none and single detector instance will be created and all inputs will be routed to it\n initialState: onlineState,\n});",
|
|
2962
2978
|
"stability": "experimental",
|
|
2963
|
-
"summary": "Defines an AWS IoT Events
|
|
2979
|
+
"summary": "Defines an AWS IoT Events detector model in this stack."
|
|
2964
2980
|
},
|
|
2965
|
-
"fqn": "@aws-cdk/aws-iotevents-alpha.
|
|
2981
|
+
"fqn": "@aws-cdk/aws-iotevents-alpha.DetectorModel",
|
|
2966
2982
|
"initializer": {
|
|
2967
2983
|
"docs": {
|
|
2968
2984
|
"stability": "experimental"
|
|
2969
2985
|
},
|
|
2970
2986
|
"locationInModule": {
|
|
2971
|
-
"filename": "lib/
|
|
2972
|
-
"line":
|
|
2987
|
+
"filename": "lib/detector-model.ts",
|
|
2988
|
+
"line": 106
|
|
2973
2989
|
},
|
|
2974
2990
|
"parameters": [
|
|
2975
2991
|
{
|
|
@@ -2987,30 +3003,30 @@
|
|
|
2987
3003
|
{
|
|
2988
3004
|
"name": "props",
|
|
2989
3005
|
"type": {
|
|
2990
|
-
"fqn": "@aws-cdk/aws-iotevents-alpha.
|
|
3006
|
+
"fqn": "@aws-cdk/aws-iotevents-alpha.DetectorModelProps"
|
|
2991
3007
|
}
|
|
2992
3008
|
}
|
|
2993
3009
|
]
|
|
2994
3010
|
},
|
|
2995
3011
|
"interfaces": [
|
|
2996
|
-
"@aws-cdk/aws-iotevents-alpha.
|
|
3012
|
+
"@aws-cdk/aws-iotevents-alpha.IDetectorModel"
|
|
2997
3013
|
],
|
|
2998
3014
|
"kind": "class",
|
|
2999
3015
|
"locationInModule": {
|
|
3000
|
-
"filename": "lib/
|
|
3001
|
-
"line":
|
|
3016
|
+
"filename": "lib/detector-model.ts",
|
|
3017
|
+
"line": 94
|
|
3002
3018
|
},
|
|
3003
3019
|
"methods": [
|
|
3004
3020
|
{
|
|
3005
3021
|
"docs": {
|
|
3006
3022
|
"stability": "experimental",
|
|
3007
|
-
"summary": "Import an existing
|
|
3023
|
+
"summary": "Import an existing detector model."
|
|
3008
3024
|
},
|
|
3009
3025
|
"locationInModule": {
|
|
3010
|
-
"filename": "lib/
|
|
3011
|
-
"line":
|
|
3026
|
+
"filename": "lib/detector-model.ts",
|
|
3027
|
+
"line": 98
|
|
3012
3028
|
},
|
|
3013
|
-
"name": "
|
|
3029
|
+
"name": "fromDetectorModelName",
|
|
3014
3030
|
"parameters": [
|
|
3015
3031
|
{
|
|
3016
3032
|
"name": "scope",
|
|
@@ -3025,7 +3041,7 @@
|
|
|
3025
3041
|
}
|
|
3026
3042
|
},
|
|
3027
3043
|
{
|
|
3028
|
-
"name": "
|
|
3044
|
+
"name": "detectorModelName",
|
|
3029
3045
|
"type": {
|
|
3030
3046
|
"primitive": "string"
|
|
3031
3047
|
}
|
|
@@ -3033,96 +3049,812 @@
|
|
|
3033
3049
|
],
|
|
3034
3050
|
"returns": {
|
|
3035
3051
|
"type": {
|
|
3036
|
-
"fqn": "@aws-cdk/aws-iotevents-alpha.
|
|
3052
|
+
"fqn": "@aws-cdk/aws-iotevents-alpha.IDetectorModel"
|
|
3037
3053
|
}
|
|
3038
3054
|
},
|
|
3039
3055
|
"static": true
|
|
3040
3056
|
}
|
|
3041
3057
|
],
|
|
3042
|
-
"name": "
|
|
3058
|
+
"name": "DetectorModel",
|
|
3043
3059
|
"properties": [
|
|
3044
3060
|
{
|
|
3045
3061
|
"docs": {
|
|
3046
3062
|
"stability": "experimental",
|
|
3047
|
-
"summary": "The name of the
|
|
3063
|
+
"summary": "The name of the detector model."
|
|
3048
3064
|
},
|
|
3049
3065
|
"immutable": true,
|
|
3050
3066
|
"locationInModule": {
|
|
3051
|
-
"filename": "lib/
|
|
3052
|
-
"line":
|
|
3067
|
+
"filename": "lib/detector-model.ts",
|
|
3068
|
+
"line": 104
|
|
3053
3069
|
},
|
|
3054
|
-
"name": "
|
|
3055
|
-
"overrides": "@aws-cdk/aws-iotevents-alpha.
|
|
3070
|
+
"name": "detectorModelName",
|
|
3071
|
+
"overrides": "@aws-cdk/aws-iotevents-alpha.IDetectorModel",
|
|
3056
3072
|
"type": {
|
|
3057
3073
|
"primitive": "string"
|
|
3058
3074
|
}
|
|
3059
3075
|
}
|
|
3060
3076
|
],
|
|
3061
|
-
"symbolId": "lib/
|
|
3077
|
+
"symbolId": "lib/detector-model:DetectorModel"
|
|
3062
3078
|
},
|
|
3063
|
-
"@aws-cdk/aws-iotevents-alpha.
|
|
3079
|
+
"@aws-cdk/aws-iotevents-alpha.DetectorModelProps": {
|
|
3064
3080
|
"assembly": "@aws-cdk/aws-iotevents-alpha",
|
|
3065
3081
|
"datatype": true,
|
|
3066
3082
|
"docs": {
|
|
3067
3083
|
"custom": {
|
|
3068
3084
|
"exampleMetadata": "infused"
|
|
3069
3085
|
},
|
|
3070
|
-
"example": "import * as iotevents from '@aws-cdk/aws-iotevents-alpha';\n\
|
|
3086
|
+
"example": "import * as iotevents from '@aws-cdk/aws-iotevents-alpha';\n\nconst input = new iotevents.Input(this, 'MyInput', {\n inputName: 'my_input', // optional\n attributeJsonPaths: ['payload.deviceId', 'payload.temperature'],\n});\n\nconst onlineState = new iotevents.State({\n stateName: 'online',\n onEnter: [{\n eventName: 'test-event',\n condition: iotevents.Expression.currentInput(input),\n }],\n});\n\nnew iotevents.DetectorModel(this, 'MyDetectorModel', {\n detectorModelName: 'test-detector-model', // optional\n description: 'test-detector-model-description', // optional property, default is none\n evaluationMethod: iotevents.EventEvaluation.SERIAL, // optional property, default is iotevents.EventEvaluation.BATCH\n detectorKey: 'payload.deviceId', // optional property, default is none and single detector instance will be created and all inputs will be routed to it\n initialState: onlineState,\n});",
|
|
3071
3087
|
"stability": "experimental",
|
|
3072
|
-
"summary": "Properties for defining an AWS IoT Events
|
|
3088
|
+
"summary": "Properties for defining an AWS IoT Events detector model."
|
|
3073
3089
|
},
|
|
3074
|
-
"fqn": "@aws-cdk/aws-iotevents-alpha.
|
|
3090
|
+
"fqn": "@aws-cdk/aws-iotevents-alpha.DetectorModelProps",
|
|
3075
3091
|
"kind": "interface",
|
|
3076
3092
|
"locationInModule": {
|
|
3077
|
-
"filename": "lib/
|
|
3078
|
-
"line":
|
|
3093
|
+
"filename": "lib/detector-model.ts",
|
|
3094
|
+
"line": 38
|
|
3079
3095
|
},
|
|
3080
|
-
"name": "
|
|
3096
|
+
"name": "DetectorModelProps",
|
|
3081
3097
|
"properties": [
|
|
3082
3098
|
{
|
|
3083
3099
|
"abstract": true,
|
|
3084
3100
|
"docs": {
|
|
3085
|
-
"remarks": "Use this to specify an attribute from the JSON payload that is made available\nby the input. Inputs are derived from messages sent to AWS IoT Events (BatchPutMessage).\nEach such message contains a JSON payload. The attribute (and its paired value)\nspecified here are available for use in the condition expressions used by detectors.",
|
|
3086
3101
|
"stability": "experimental",
|
|
3087
|
-
"summary": "
|
|
3102
|
+
"summary": "The state that is entered at the creation of each detector."
|
|
3088
3103
|
},
|
|
3089
3104
|
"immutable": true,
|
|
3090
3105
|
"locationInModule": {
|
|
3091
|
-
"filename": "lib/
|
|
3092
|
-
"line":
|
|
3106
|
+
"filename": "lib/detector-model.ts",
|
|
3107
|
+
"line": 81
|
|
3093
3108
|
},
|
|
3094
|
-
"name": "
|
|
3109
|
+
"name": "initialState",
|
|
3095
3110
|
"type": {
|
|
3096
|
-
"
|
|
3097
|
-
"elementtype": {
|
|
3098
|
-
"primitive": "string"
|
|
3099
|
-
},
|
|
3100
|
-
"kind": "array"
|
|
3101
|
-
}
|
|
3111
|
+
"fqn": "@aws-cdk/aws-iotevents-alpha.State"
|
|
3102
3112
|
}
|
|
3103
3113
|
},
|
|
3104
3114
|
{
|
|
3105
3115
|
"abstract": true,
|
|
3106
3116
|
"docs": {
|
|
3107
|
-
"default": "
|
|
3117
|
+
"default": "none",
|
|
3108
3118
|
"stability": "experimental",
|
|
3109
|
-
"summary": "
|
|
3119
|
+
"summary": "A brief description of the detector model."
|
|
3110
3120
|
},
|
|
3111
3121
|
"immutable": true,
|
|
3112
3122
|
"locationInModule": {
|
|
3113
|
-
"filename": "lib/
|
|
3114
|
-
"line":
|
|
3123
|
+
"filename": "lib/detector-model.ts",
|
|
3124
|
+
"line": 51
|
|
3115
3125
|
},
|
|
3116
|
-
"name": "
|
|
3126
|
+
"name": "description",
|
|
3127
|
+
"optional": true,
|
|
3128
|
+
"type": {
|
|
3129
|
+
"primitive": "string"
|
|
3130
|
+
}
|
|
3131
|
+
},
|
|
3132
|
+
{
|
|
3133
|
+
"abstract": true,
|
|
3134
|
+
"docs": {
|
|
3135
|
+
"default": "- none (single detector instance will be created and all inputs will be routed to it)",
|
|
3136
|
+
"remarks": "When a device or system sends input, a new\ndetector instance with a unique key value is created. AWS IoT Events can continue to route\ninput to its corresponding detector instance based on this identifying information.\n\nThis parameter uses a JSON-path expression to select the attribute-value pair in the message\npayload that is used for identification. To route the message to the correct detector instance,\nthe device must send a message payload that contains the same attribute-value.",
|
|
3137
|
+
"stability": "experimental",
|
|
3138
|
+
"summary": "The value used to identify a detector instance."
|
|
3139
|
+
},
|
|
3140
|
+
"immutable": true,
|
|
3141
|
+
"locationInModule": {
|
|
3142
|
+
"filename": "lib/detector-model.ts",
|
|
3143
|
+
"line": 76
|
|
3144
|
+
},
|
|
3145
|
+
"name": "detectorKey",
|
|
3146
|
+
"optional": true,
|
|
3147
|
+
"type": {
|
|
3148
|
+
"primitive": "string"
|
|
3149
|
+
}
|
|
3150
|
+
},
|
|
3151
|
+
{
|
|
3152
|
+
"abstract": true,
|
|
3153
|
+
"docs": {
|
|
3154
|
+
"default": "- CloudFormation will generate a unique name of the detector model",
|
|
3155
|
+
"stability": "experimental",
|
|
3156
|
+
"summary": "The name of the detector model."
|
|
3157
|
+
},
|
|
3158
|
+
"immutable": true,
|
|
3159
|
+
"locationInModule": {
|
|
3160
|
+
"filename": "lib/detector-model.ts",
|
|
3161
|
+
"line": 44
|
|
3162
|
+
},
|
|
3163
|
+
"name": "detectorModelName",
|
|
3117
3164
|
"optional": true,
|
|
3118
3165
|
"type": {
|
|
3119
3166
|
"primitive": "string"
|
|
3120
3167
|
}
|
|
3168
|
+
},
|
|
3169
|
+
{
|
|
3170
|
+
"abstract": true,
|
|
3171
|
+
"docs": {
|
|
3172
|
+
"default": "EventEvaluation.BATCH",
|
|
3173
|
+
"remarks": "When setting to SERIAL, variables are updated and event conditions are evaluated in the order\nthat the events are defined.\nWhen setting to BATCH, variables within a state are updated and events within a state are\nperformed only after all event conditions are evaluated.",
|
|
3174
|
+
"stability": "experimental",
|
|
3175
|
+
"summary": "Information about the order in which events are evaluated and how actions are executed."
|
|
3176
|
+
},
|
|
3177
|
+
"immutable": true,
|
|
3178
|
+
"locationInModule": {
|
|
3179
|
+
"filename": "lib/detector-model.ts",
|
|
3180
|
+
"line": 63
|
|
3181
|
+
},
|
|
3182
|
+
"name": "evaluationMethod",
|
|
3183
|
+
"optional": true,
|
|
3184
|
+
"type": {
|
|
3185
|
+
"fqn": "@aws-cdk/aws-iotevents-alpha.EventEvaluation"
|
|
3186
|
+
}
|
|
3187
|
+
},
|
|
3188
|
+
{
|
|
3189
|
+
"abstract": true,
|
|
3190
|
+
"docs": {
|
|
3191
|
+
"default": "- a role will be created with default permissions",
|
|
3192
|
+
"stability": "experimental",
|
|
3193
|
+
"summary": "The role that grants permission to AWS IoT Events to perform its operations."
|
|
3194
|
+
},
|
|
3195
|
+
"immutable": true,
|
|
3196
|
+
"locationInModule": {
|
|
3197
|
+
"filename": "lib/detector-model.ts",
|
|
3198
|
+
"line": 88
|
|
3199
|
+
},
|
|
3200
|
+
"name": "role",
|
|
3201
|
+
"optional": true,
|
|
3202
|
+
"type": {
|
|
3203
|
+
"fqn": "aws-cdk-lib.aws_iam.IRole"
|
|
3204
|
+
}
|
|
3121
3205
|
}
|
|
3122
3206
|
],
|
|
3123
|
-
"symbolId": "lib/
|
|
3207
|
+
"symbolId": "lib/detector-model:DetectorModelProps"
|
|
3208
|
+
},
|
|
3209
|
+
"@aws-cdk/aws-iotevents-alpha.Event": {
|
|
3210
|
+
"assembly": "@aws-cdk/aws-iotevents-alpha",
|
|
3211
|
+
"datatype": true,
|
|
3212
|
+
"docs": {
|
|
3213
|
+
"stability": "experimental",
|
|
3214
|
+
"summary": "Specifies the actions to be performed when the condition evaluates to TRUE.",
|
|
3215
|
+
"example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as iotevents_alpha from '@aws-cdk/aws-iotevents-alpha';\n\ndeclare const expression: iotevents_alpha.Expression;\nconst event: iotevents_alpha.Event = {\n eventName: 'eventName',\n\n // the properties below are optional\n condition: expression,\n};",
|
|
3216
|
+
"custom": {
|
|
3217
|
+
"exampleMetadata": "fixture=_generated"
|
|
3218
|
+
}
|
|
3219
|
+
},
|
|
3220
|
+
"fqn": "@aws-cdk/aws-iotevents-alpha.Event",
|
|
3221
|
+
"kind": "interface",
|
|
3222
|
+
"locationInModule": {
|
|
3223
|
+
"filename": "lib/event.ts",
|
|
3224
|
+
"line": 6
|
|
3225
|
+
},
|
|
3226
|
+
"name": "Event",
|
|
3227
|
+
"properties": [
|
|
3228
|
+
{
|
|
3229
|
+
"abstract": true,
|
|
3230
|
+
"docs": {
|
|
3231
|
+
"stability": "experimental",
|
|
3232
|
+
"summary": "The name of the event."
|
|
3233
|
+
},
|
|
3234
|
+
"immutable": true,
|
|
3235
|
+
"locationInModule": {
|
|
3236
|
+
"filename": "lib/event.ts",
|
|
3237
|
+
"line": 10
|
|
3238
|
+
},
|
|
3239
|
+
"name": "eventName",
|
|
3240
|
+
"type": {
|
|
3241
|
+
"primitive": "string"
|
|
3242
|
+
}
|
|
3243
|
+
},
|
|
3244
|
+
{
|
|
3245
|
+
"abstract": true,
|
|
3246
|
+
"docs": {
|
|
3247
|
+
"default": "- none (the actions are always executed)",
|
|
3248
|
+
"stability": "experimental",
|
|
3249
|
+
"summary": "The Boolean expression that, when TRUE, causes the actions to be performed."
|
|
3250
|
+
},
|
|
3251
|
+
"immutable": true,
|
|
3252
|
+
"locationInModule": {
|
|
3253
|
+
"filename": "lib/event.ts",
|
|
3254
|
+
"line": 17
|
|
3255
|
+
},
|
|
3256
|
+
"name": "condition",
|
|
3257
|
+
"optional": true,
|
|
3258
|
+
"type": {
|
|
3259
|
+
"fqn": "@aws-cdk/aws-iotevents-alpha.Expression"
|
|
3260
|
+
}
|
|
3261
|
+
}
|
|
3262
|
+
],
|
|
3263
|
+
"symbolId": "lib/event:Event"
|
|
3264
|
+
},
|
|
3265
|
+
"@aws-cdk/aws-iotevents-alpha.EventEvaluation": {
|
|
3266
|
+
"assembly": "@aws-cdk/aws-iotevents-alpha",
|
|
3267
|
+
"docs": {
|
|
3268
|
+
"custom": {
|
|
3269
|
+
"exampleMetadata": "infused"
|
|
3270
|
+
},
|
|
3271
|
+
"example": "import * as iotevents from '@aws-cdk/aws-iotevents-alpha';\n\nconst input = new iotevents.Input(this, 'MyInput', {\n inputName: 'my_input', // optional\n attributeJsonPaths: ['payload.deviceId', 'payload.temperature'],\n});\n\nconst onlineState = new iotevents.State({\n stateName: 'online',\n onEnter: [{\n eventName: 'test-event',\n condition: iotevents.Expression.currentInput(input),\n }],\n});\n\nnew iotevents.DetectorModel(this, 'MyDetectorModel', {\n detectorModelName: 'test-detector-model', // optional\n description: 'test-detector-model-description', // optional property, default is none\n evaluationMethod: iotevents.EventEvaluation.SERIAL, // optional property, default is iotevents.EventEvaluation.BATCH\n detectorKey: 'payload.deviceId', // optional property, default is none and single detector instance will be created and all inputs will be routed to it\n initialState: onlineState,\n});",
|
|
3272
|
+
"stability": "experimental",
|
|
3273
|
+
"summary": "Information about the order in which events are evaluated and how actions are executed."
|
|
3274
|
+
},
|
|
3275
|
+
"fqn": "@aws-cdk/aws-iotevents-alpha.EventEvaluation",
|
|
3276
|
+
"kind": "enum",
|
|
3277
|
+
"locationInModule": {
|
|
3278
|
+
"filename": "lib/detector-model.ts",
|
|
3279
|
+
"line": 22
|
|
3280
|
+
},
|
|
3281
|
+
"members": [
|
|
3282
|
+
{
|
|
3283
|
+
"docs": {
|
|
3284
|
+
"stability": "experimental",
|
|
3285
|
+
"summary": "When setting to SERIAL, variables are updated and event conditions are evaluated in the order that the events are defined."
|
|
3286
|
+
},
|
|
3287
|
+
"name": "BATCH"
|
|
3288
|
+
},
|
|
3289
|
+
{
|
|
3290
|
+
"docs": {
|
|
3291
|
+
"stability": "experimental",
|
|
3292
|
+
"summary": "When setting to BATCH, variables within a state are updated and events within a state are performed only after all event conditions are evaluated."
|
|
3293
|
+
},
|
|
3294
|
+
"name": "SERIAL"
|
|
3295
|
+
}
|
|
3296
|
+
],
|
|
3297
|
+
"name": "EventEvaluation",
|
|
3298
|
+
"symbolId": "lib/detector-model:EventEvaluation"
|
|
3299
|
+
},
|
|
3300
|
+
"@aws-cdk/aws-iotevents-alpha.Expression": {
|
|
3301
|
+
"abstract": true,
|
|
3302
|
+
"assembly": "@aws-cdk/aws-iotevents-alpha",
|
|
3303
|
+
"docs": {
|
|
3304
|
+
"custom": {
|
|
3305
|
+
"exampleMetadata": "infused"
|
|
3306
|
+
},
|
|
3307
|
+
"example": "import * as iotevents from '@aws-cdk/aws-iotevents-alpha';\n\nconst input = new iotevents.Input(this, 'MyInput', {\n inputName: 'my_input', // optional\n attributeJsonPaths: ['payload.deviceId', 'payload.temperature'],\n});\n\nconst onlineState = new iotevents.State({\n stateName: 'online',\n onEnter: [{\n eventName: 'test-event',\n condition: iotevents.Expression.currentInput(input),\n }],\n});\n\nnew iotevents.DetectorModel(this, 'MyDetectorModel', {\n detectorModelName: 'test-detector-model', // optional\n description: 'test-detector-model-description', // optional property, default is none\n evaluationMethod: iotevents.EventEvaluation.SERIAL, // optional property, default is iotevents.EventEvaluation.BATCH\n detectorKey: 'payload.deviceId', // optional property, default is none and single detector instance will be created and all inputs will be routed to it\n initialState: onlineState,\n});",
|
|
3308
|
+
"see": "https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html",
|
|
3309
|
+
"stability": "experimental",
|
|
3310
|
+
"summary": "Expression for events in Detector Model state."
|
|
3311
|
+
},
|
|
3312
|
+
"fqn": "@aws-cdk/aws-iotevents-alpha.Expression",
|
|
3313
|
+
"initializer": {
|
|
3314
|
+
"docs": {
|
|
3315
|
+
"stability": "experimental"
|
|
3316
|
+
},
|
|
3317
|
+
"locationInModule": {
|
|
3318
|
+
"filename": "lib/expression.ts",
|
|
3319
|
+
"line": 44
|
|
3320
|
+
}
|
|
3321
|
+
},
|
|
3322
|
+
"kind": "class",
|
|
3323
|
+
"locationInModule": {
|
|
3324
|
+
"filename": "lib/expression.ts",
|
|
3325
|
+
"line": 7
|
|
3326
|
+
},
|
|
3327
|
+
"methods": [
|
|
3328
|
+
{
|
|
3329
|
+
"docs": {
|
|
3330
|
+
"stability": "experimental",
|
|
3331
|
+
"summary": "Create a expression for the AND operator."
|
|
3332
|
+
},
|
|
3333
|
+
"locationInModule": {
|
|
3334
|
+
"filename": "lib/expression.ts",
|
|
3335
|
+
"line": 40
|
|
3336
|
+
},
|
|
3337
|
+
"name": "and",
|
|
3338
|
+
"parameters": [
|
|
3339
|
+
{
|
|
3340
|
+
"name": "left",
|
|
3341
|
+
"type": {
|
|
3342
|
+
"fqn": "@aws-cdk/aws-iotevents-alpha.Expression"
|
|
3343
|
+
}
|
|
3344
|
+
},
|
|
3345
|
+
{
|
|
3346
|
+
"name": "right",
|
|
3347
|
+
"type": {
|
|
3348
|
+
"fqn": "@aws-cdk/aws-iotevents-alpha.Expression"
|
|
3349
|
+
}
|
|
3350
|
+
}
|
|
3351
|
+
],
|
|
3352
|
+
"returns": {
|
|
3353
|
+
"type": {
|
|
3354
|
+
"fqn": "@aws-cdk/aws-iotevents-alpha.Expression"
|
|
3355
|
+
}
|
|
3356
|
+
},
|
|
3357
|
+
"static": true
|
|
3358
|
+
},
|
|
3359
|
+
{
|
|
3360
|
+
"docs": {
|
|
3361
|
+
"remarks": "It is evaluated to true if the specified input message was received.",
|
|
3362
|
+
"stability": "experimental",
|
|
3363
|
+
"summary": "Create a expression for function `currentInput()`."
|
|
3364
|
+
},
|
|
3365
|
+
"locationInModule": {
|
|
3366
|
+
"filename": "lib/expression.ts",
|
|
3367
|
+
"line": 19
|
|
3368
|
+
},
|
|
3369
|
+
"name": "currentInput",
|
|
3370
|
+
"parameters": [
|
|
3371
|
+
{
|
|
3372
|
+
"name": "input",
|
|
3373
|
+
"type": {
|
|
3374
|
+
"fqn": "@aws-cdk/aws-iotevents-alpha.IInput"
|
|
3375
|
+
}
|
|
3376
|
+
}
|
|
3377
|
+
],
|
|
3378
|
+
"returns": {
|
|
3379
|
+
"type": {
|
|
3380
|
+
"fqn": "@aws-cdk/aws-iotevents-alpha.Expression"
|
|
3381
|
+
}
|
|
3382
|
+
},
|
|
3383
|
+
"static": true
|
|
3384
|
+
},
|
|
3385
|
+
{
|
|
3386
|
+
"docs": {
|
|
3387
|
+
"stability": "experimental",
|
|
3388
|
+
"summary": "Create a expression for the Equal operator."
|
|
3389
|
+
},
|
|
3390
|
+
"locationInModule": {
|
|
3391
|
+
"filename": "lib/expression.ts",
|
|
3392
|
+
"line": 33
|
|
3393
|
+
},
|
|
3394
|
+
"name": "eq",
|
|
3395
|
+
"parameters": [
|
|
3396
|
+
{
|
|
3397
|
+
"name": "left",
|
|
3398
|
+
"type": {
|
|
3399
|
+
"fqn": "@aws-cdk/aws-iotevents-alpha.Expression"
|
|
3400
|
+
}
|
|
3401
|
+
},
|
|
3402
|
+
{
|
|
3403
|
+
"name": "right",
|
|
3404
|
+
"type": {
|
|
3405
|
+
"fqn": "@aws-cdk/aws-iotevents-alpha.Expression"
|
|
3406
|
+
}
|
|
3407
|
+
}
|
|
3408
|
+
],
|
|
3409
|
+
"returns": {
|
|
3410
|
+
"type": {
|
|
3411
|
+
"fqn": "@aws-cdk/aws-iotevents-alpha.Expression"
|
|
3412
|
+
}
|
|
3413
|
+
},
|
|
3414
|
+
"static": true
|
|
3415
|
+
},
|
|
3416
|
+
{
|
|
3417
|
+
"docs": {
|
|
3418
|
+
"stability": "experimental",
|
|
3419
|
+
"summary": "Create a expression from the given string."
|
|
3420
|
+
},
|
|
3421
|
+
"locationInModule": {
|
|
3422
|
+
"filename": "lib/expression.ts",
|
|
3423
|
+
"line": 11
|
|
3424
|
+
},
|
|
3425
|
+
"name": "fromString",
|
|
3426
|
+
"parameters": [
|
|
3427
|
+
{
|
|
3428
|
+
"name": "value",
|
|
3429
|
+
"type": {
|
|
3430
|
+
"primitive": "string"
|
|
3431
|
+
}
|
|
3432
|
+
}
|
|
3433
|
+
],
|
|
3434
|
+
"returns": {
|
|
3435
|
+
"type": {
|
|
3436
|
+
"fqn": "@aws-cdk/aws-iotevents-alpha.Expression"
|
|
3437
|
+
}
|
|
3438
|
+
},
|
|
3439
|
+
"static": true
|
|
3440
|
+
},
|
|
3441
|
+
{
|
|
3442
|
+
"docs": {
|
|
3443
|
+
"stability": "experimental",
|
|
3444
|
+
"summary": "Create a expression for get an input attribute as `$input.TemperatureInput.temperatures[2]`."
|
|
3445
|
+
},
|
|
3446
|
+
"locationInModule": {
|
|
3447
|
+
"filename": "lib/expression.ts",
|
|
3448
|
+
"line": 26
|
|
3449
|
+
},
|
|
3450
|
+
"name": "inputAttribute",
|
|
3451
|
+
"parameters": [
|
|
3452
|
+
{
|
|
3453
|
+
"name": "input",
|
|
3454
|
+
"type": {
|
|
3455
|
+
"fqn": "@aws-cdk/aws-iotevents-alpha.IInput"
|
|
3456
|
+
}
|
|
3457
|
+
},
|
|
3458
|
+
{
|
|
3459
|
+
"name": "path",
|
|
3460
|
+
"type": {
|
|
3461
|
+
"primitive": "string"
|
|
3462
|
+
}
|
|
3463
|
+
}
|
|
3464
|
+
],
|
|
3465
|
+
"returns": {
|
|
3466
|
+
"type": {
|
|
3467
|
+
"fqn": "@aws-cdk/aws-iotevents-alpha.Expression"
|
|
3468
|
+
}
|
|
3469
|
+
},
|
|
3470
|
+
"static": true
|
|
3471
|
+
},
|
|
3472
|
+
{
|
|
3473
|
+
"abstract": true,
|
|
3474
|
+
"docs": {
|
|
3475
|
+
"stability": "experimental",
|
|
3476
|
+
"summary": "this is called to evaluate the expression."
|
|
3477
|
+
},
|
|
3478
|
+
"locationInModule": {
|
|
3479
|
+
"filename": "lib/expression.ts",
|
|
3480
|
+
"line": 50
|
|
3481
|
+
},
|
|
3482
|
+
"name": "evaluate",
|
|
3483
|
+
"returns": {
|
|
3484
|
+
"type": {
|
|
3485
|
+
"primitive": "string"
|
|
3486
|
+
}
|
|
3487
|
+
}
|
|
3488
|
+
}
|
|
3489
|
+
],
|
|
3490
|
+
"name": "Expression",
|
|
3491
|
+
"symbolId": "lib/expression:Expression"
|
|
3492
|
+
},
|
|
3493
|
+
"@aws-cdk/aws-iotevents-alpha.IDetectorModel": {
|
|
3494
|
+
"assembly": "@aws-cdk/aws-iotevents-alpha",
|
|
3495
|
+
"docs": {
|
|
3496
|
+
"stability": "experimental",
|
|
3497
|
+
"summary": "Represents an AWS IoT Events detector model."
|
|
3498
|
+
},
|
|
3499
|
+
"fqn": "@aws-cdk/aws-iotevents-alpha.IDetectorModel",
|
|
3500
|
+
"interfaces": [
|
|
3501
|
+
"aws-cdk-lib.IResource"
|
|
3502
|
+
],
|
|
3503
|
+
"kind": "interface",
|
|
3504
|
+
"locationInModule": {
|
|
3505
|
+
"filename": "lib/detector-model.ts",
|
|
3506
|
+
"line": 10
|
|
3507
|
+
},
|
|
3508
|
+
"name": "IDetectorModel",
|
|
3509
|
+
"properties": [
|
|
3510
|
+
{
|
|
3511
|
+
"abstract": true,
|
|
3512
|
+
"docs": {
|
|
3513
|
+
"custom": {
|
|
3514
|
+
"attribute": "true"
|
|
3515
|
+
},
|
|
3516
|
+
"stability": "experimental",
|
|
3517
|
+
"summary": "The name of the detector model."
|
|
3518
|
+
},
|
|
3519
|
+
"immutable": true,
|
|
3520
|
+
"locationInModule": {
|
|
3521
|
+
"filename": "lib/detector-model.ts",
|
|
3522
|
+
"line": 16
|
|
3523
|
+
},
|
|
3524
|
+
"name": "detectorModelName",
|
|
3525
|
+
"type": {
|
|
3526
|
+
"primitive": "string"
|
|
3527
|
+
}
|
|
3528
|
+
}
|
|
3529
|
+
],
|
|
3530
|
+
"symbolId": "lib/detector-model:IDetectorModel"
|
|
3531
|
+
},
|
|
3532
|
+
"@aws-cdk/aws-iotevents-alpha.IInput": {
|
|
3533
|
+
"assembly": "@aws-cdk/aws-iotevents-alpha",
|
|
3534
|
+
"docs": {
|
|
3535
|
+
"stability": "experimental",
|
|
3536
|
+
"summary": "Represents an AWS IoT Events input."
|
|
3537
|
+
},
|
|
3538
|
+
"fqn": "@aws-cdk/aws-iotevents-alpha.IInput",
|
|
3539
|
+
"interfaces": [
|
|
3540
|
+
"aws-cdk-lib.IResource"
|
|
3541
|
+
],
|
|
3542
|
+
"kind": "interface",
|
|
3543
|
+
"locationInModule": {
|
|
3544
|
+
"filename": "lib/input.ts",
|
|
3545
|
+
"line": 8
|
|
3546
|
+
},
|
|
3547
|
+
"name": "IInput",
|
|
3548
|
+
"properties": [
|
|
3549
|
+
{
|
|
3550
|
+
"abstract": true,
|
|
3551
|
+
"docs": {
|
|
3552
|
+
"custom": {
|
|
3553
|
+
"attribute": "true"
|
|
3554
|
+
},
|
|
3555
|
+
"stability": "experimental",
|
|
3556
|
+
"summary": "The name of the input."
|
|
3557
|
+
},
|
|
3558
|
+
"immutable": true,
|
|
3559
|
+
"locationInModule": {
|
|
3560
|
+
"filename": "lib/input.ts",
|
|
3561
|
+
"line": 13
|
|
3562
|
+
},
|
|
3563
|
+
"name": "inputName",
|
|
3564
|
+
"type": {
|
|
3565
|
+
"primitive": "string"
|
|
3566
|
+
}
|
|
3567
|
+
}
|
|
3568
|
+
],
|
|
3569
|
+
"symbolId": "lib/input:IInput"
|
|
3570
|
+
},
|
|
3571
|
+
"@aws-cdk/aws-iotevents-alpha.Input": {
|
|
3572
|
+
"assembly": "@aws-cdk/aws-iotevents-alpha",
|
|
3573
|
+
"base": "aws-cdk-lib.Resource",
|
|
3574
|
+
"docs": {
|
|
3575
|
+
"custom": {
|
|
3576
|
+
"exampleMetadata": "infused"
|
|
3577
|
+
},
|
|
3578
|
+
"example": "import * as iotevents from '@aws-cdk/aws-iotevents-alpha';\n\nconst input = new iotevents.Input(this, 'MyInput', {\n inputName: 'my_input', // optional\n attributeJsonPaths: ['payload.deviceId', 'payload.temperature'],\n});\n\nconst onlineState = new iotevents.State({\n stateName: 'online',\n onEnter: [{\n eventName: 'test-event',\n condition: iotevents.Expression.currentInput(input),\n }],\n});\n\nnew iotevents.DetectorModel(this, 'MyDetectorModel', {\n detectorModelName: 'test-detector-model', // optional\n description: 'test-detector-model-description', // optional property, default is none\n evaluationMethod: iotevents.EventEvaluation.SERIAL, // optional property, default is iotevents.EventEvaluation.BATCH\n detectorKey: 'payload.deviceId', // optional property, default is none and single detector instance will be created and all inputs will be routed to it\n initialState: onlineState,\n});",
|
|
3579
|
+
"stability": "experimental",
|
|
3580
|
+
"summary": "Defines an AWS IoT Events input in this stack."
|
|
3581
|
+
},
|
|
3582
|
+
"fqn": "@aws-cdk/aws-iotevents-alpha.Input",
|
|
3583
|
+
"initializer": {
|
|
3584
|
+
"docs": {
|
|
3585
|
+
"stability": "experimental"
|
|
3586
|
+
},
|
|
3587
|
+
"locationInModule": {
|
|
3588
|
+
"filename": "lib/input.ts",
|
|
3589
|
+
"line": 53
|
|
3590
|
+
},
|
|
3591
|
+
"parameters": [
|
|
3592
|
+
{
|
|
3593
|
+
"name": "scope",
|
|
3594
|
+
"type": {
|
|
3595
|
+
"fqn": "constructs.Construct"
|
|
3596
|
+
}
|
|
3597
|
+
},
|
|
3598
|
+
{
|
|
3599
|
+
"name": "id",
|
|
3600
|
+
"type": {
|
|
3601
|
+
"primitive": "string"
|
|
3602
|
+
}
|
|
3603
|
+
},
|
|
3604
|
+
{
|
|
3605
|
+
"name": "props",
|
|
3606
|
+
"type": {
|
|
3607
|
+
"fqn": "@aws-cdk/aws-iotevents-alpha.InputProps"
|
|
3608
|
+
}
|
|
3609
|
+
}
|
|
3610
|
+
]
|
|
3611
|
+
},
|
|
3612
|
+
"interfaces": [
|
|
3613
|
+
"@aws-cdk/aws-iotevents-alpha.IInput"
|
|
3614
|
+
],
|
|
3615
|
+
"kind": "class",
|
|
3616
|
+
"locationInModule": {
|
|
3617
|
+
"filename": "lib/input.ts",
|
|
3618
|
+
"line": 40
|
|
3619
|
+
},
|
|
3620
|
+
"methods": [
|
|
3621
|
+
{
|
|
3622
|
+
"docs": {
|
|
3623
|
+
"stability": "experimental",
|
|
3624
|
+
"summary": "Import an existing input."
|
|
3625
|
+
},
|
|
3626
|
+
"locationInModule": {
|
|
3627
|
+
"filename": "lib/input.ts",
|
|
3628
|
+
"line": 44
|
|
3629
|
+
},
|
|
3630
|
+
"name": "fromInputName",
|
|
3631
|
+
"parameters": [
|
|
3632
|
+
{
|
|
3633
|
+
"name": "scope",
|
|
3634
|
+
"type": {
|
|
3635
|
+
"fqn": "constructs.Construct"
|
|
3636
|
+
}
|
|
3637
|
+
},
|
|
3638
|
+
{
|
|
3639
|
+
"name": "id",
|
|
3640
|
+
"type": {
|
|
3641
|
+
"primitive": "string"
|
|
3642
|
+
}
|
|
3643
|
+
},
|
|
3644
|
+
{
|
|
3645
|
+
"name": "inputName",
|
|
3646
|
+
"type": {
|
|
3647
|
+
"primitive": "string"
|
|
3648
|
+
}
|
|
3649
|
+
}
|
|
3650
|
+
],
|
|
3651
|
+
"returns": {
|
|
3652
|
+
"type": {
|
|
3653
|
+
"fqn": "@aws-cdk/aws-iotevents-alpha.IInput"
|
|
3654
|
+
}
|
|
3655
|
+
},
|
|
3656
|
+
"static": true
|
|
3657
|
+
}
|
|
3658
|
+
],
|
|
3659
|
+
"name": "Input",
|
|
3660
|
+
"properties": [
|
|
3661
|
+
{
|
|
3662
|
+
"docs": {
|
|
3663
|
+
"stability": "experimental",
|
|
3664
|
+
"summary": "The name of the input."
|
|
3665
|
+
},
|
|
3666
|
+
"immutable": true,
|
|
3667
|
+
"locationInModule": {
|
|
3668
|
+
"filename": "lib/input.ts",
|
|
3669
|
+
"line": 51
|
|
3670
|
+
},
|
|
3671
|
+
"name": "inputName",
|
|
3672
|
+
"overrides": "@aws-cdk/aws-iotevents-alpha.IInput",
|
|
3673
|
+
"type": {
|
|
3674
|
+
"primitive": "string"
|
|
3675
|
+
}
|
|
3676
|
+
}
|
|
3677
|
+
],
|
|
3678
|
+
"symbolId": "lib/input:Input"
|
|
3679
|
+
},
|
|
3680
|
+
"@aws-cdk/aws-iotevents-alpha.InputProps": {
|
|
3681
|
+
"assembly": "@aws-cdk/aws-iotevents-alpha",
|
|
3682
|
+
"datatype": true,
|
|
3683
|
+
"docs": {
|
|
3684
|
+
"custom": {
|
|
3685
|
+
"exampleMetadata": "infused"
|
|
3686
|
+
},
|
|
3687
|
+
"example": "import * as iotevents from '@aws-cdk/aws-iotevents-alpha';\n\nconst input = new iotevents.Input(this, 'MyInput', {\n inputName: 'my_input', // optional\n attributeJsonPaths: ['payload.deviceId', 'payload.temperature'],\n});\n\nconst onlineState = new iotevents.State({\n stateName: 'online',\n onEnter: [{\n eventName: 'test-event',\n condition: iotevents.Expression.currentInput(input),\n }],\n});\n\nnew iotevents.DetectorModel(this, 'MyDetectorModel', {\n detectorModelName: 'test-detector-model', // optional\n description: 'test-detector-model-description', // optional property, default is none\n evaluationMethod: iotevents.EventEvaluation.SERIAL, // optional property, default is iotevents.EventEvaluation.BATCH\n detectorKey: 'payload.deviceId', // optional property, default is none and single detector instance will be created and all inputs will be routed to it\n initialState: onlineState,\n});",
|
|
3688
|
+
"stability": "experimental",
|
|
3689
|
+
"summary": "Properties for defining an AWS IoT Events input."
|
|
3690
|
+
},
|
|
3691
|
+
"fqn": "@aws-cdk/aws-iotevents-alpha.InputProps",
|
|
3692
|
+
"kind": "interface",
|
|
3693
|
+
"locationInModule": {
|
|
3694
|
+
"filename": "lib/input.ts",
|
|
3695
|
+
"line": 19
|
|
3696
|
+
},
|
|
3697
|
+
"name": "InputProps",
|
|
3698
|
+
"properties": [
|
|
3699
|
+
{
|
|
3700
|
+
"abstract": true,
|
|
3701
|
+
"docs": {
|
|
3702
|
+
"remarks": "Use this to specify an attribute from the JSON payload that is made available\nby the input. Inputs are derived from messages sent to AWS IoT Events (BatchPutMessage).\nEach such message contains a JSON payload. The attribute (and its paired value)\nspecified here are available for use in the condition expressions used by detectors.",
|
|
3703
|
+
"stability": "experimental",
|
|
3704
|
+
"summary": "An expression that specifies an attribute-value pair in a JSON structure."
|
|
3705
|
+
},
|
|
3706
|
+
"immutable": true,
|
|
3707
|
+
"locationInModule": {
|
|
3708
|
+
"filename": "lib/input.ts",
|
|
3709
|
+
"line": 34
|
|
3710
|
+
},
|
|
3711
|
+
"name": "attributeJsonPaths",
|
|
3712
|
+
"type": {
|
|
3713
|
+
"collection": {
|
|
3714
|
+
"elementtype": {
|
|
3715
|
+
"primitive": "string"
|
|
3716
|
+
},
|
|
3717
|
+
"kind": "array"
|
|
3718
|
+
}
|
|
3719
|
+
}
|
|
3720
|
+
},
|
|
3721
|
+
{
|
|
3722
|
+
"abstract": true,
|
|
3723
|
+
"docs": {
|
|
3724
|
+
"default": "- CloudFormation will generate a unique name of the input",
|
|
3725
|
+
"stability": "experimental",
|
|
3726
|
+
"summary": "The name of the input."
|
|
3727
|
+
},
|
|
3728
|
+
"immutable": true,
|
|
3729
|
+
"locationInModule": {
|
|
3730
|
+
"filename": "lib/input.ts",
|
|
3731
|
+
"line": 25
|
|
3732
|
+
},
|
|
3733
|
+
"name": "inputName",
|
|
3734
|
+
"optional": true,
|
|
3735
|
+
"type": {
|
|
3736
|
+
"primitive": "string"
|
|
3737
|
+
}
|
|
3738
|
+
}
|
|
3739
|
+
],
|
|
3740
|
+
"symbolId": "lib/input:InputProps"
|
|
3741
|
+
},
|
|
3742
|
+
"@aws-cdk/aws-iotevents-alpha.State": {
|
|
3743
|
+
"assembly": "@aws-cdk/aws-iotevents-alpha",
|
|
3744
|
+
"docs": {
|
|
3745
|
+
"custom": {
|
|
3746
|
+
"exampleMetadata": "infused"
|
|
3747
|
+
},
|
|
3748
|
+
"example": "import * as iotevents from '@aws-cdk/aws-iotevents-alpha';\n\nconst input = new iotevents.Input(this, 'MyInput', {\n inputName: 'my_input', // optional\n attributeJsonPaths: ['payload.deviceId', 'payload.temperature'],\n});\n\nconst onlineState = new iotevents.State({\n stateName: 'online',\n onEnter: [{\n eventName: 'test-event',\n condition: iotevents.Expression.currentInput(input),\n }],\n});\n\nnew iotevents.DetectorModel(this, 'MyDetectorModel', {\n detectorModelName: 'test-detector-model', // optional\n description: 'test-detector-model-description', // optional property, default is none\n evaluationMethod: iotevents.EventEvaluation.SERIAL, // optional property, default is iotevents.EventEvaluation.BATCH\n detectorKey: 'payload.deviceId', // optional property, default is none and single detector instance will be created and all inputs will be routed to it\n initialState: onlineState,\n});",
|
|
3749
|
+
"stability": "experimental",
|
|
3750
|
+
"summary": "Defines a state of a detector."
|
|
3751
|
+
},
|
|
3752
|
+
"fqn": "@aws-cdk/aws-iotevents-alpha.State",
|
|
3753
|
+
"initializer": {
|
|
3754
|
+
"docs": {
|
|
3755
|
+
"stability": "experimental"
|
|
3756
|
+
},
|
|
3757
|
+
"locationInModule": {
|
|
3758
|
+
"filename": "lib/state.ts",
|
|
3759
|
+
"line": 31
|
|
3760
|
+
},
|
|
3761
|
+
"parameters": [
|
|
3762
|
+
{
|
|
3763
|
+
"name": "props",
|
|
3764
|
+
"type": {
|
|
3765
|
+
"fqn": "@aws-cdk/aws-iotevents-alpha.StateProps"
|
|
3766
|
+
}
|
|
3767
|
+
}
|
|
3768
|
+
]
|
|
3769
|
+
},
|
|
3770
|
+
"kind": "class",
|
|
3771
|
+
"locationInModule": {
|
|
3772
|
+
"filename": "lib/state.ts",
|
|
3773
|
+
"line": 25
|
|
3774
|
+
},
|
|
3775
|
+
"name": "State",
|
|
3776
|
+
"properties": [
|
|
3777
|
+
{
|
|
3778
|
+
"docs": {
|
|
3779
|
+
"stability": "experimental",
|
|
3780
|
+
"summary": "The name of the state."
|
|
3781
|
+
},
|
|
3782
|
+
"immutable": true,
|
|
3783
|
+
"locationInModule": {
|
|
3784
|
+
"filename": "lib/state.ts",
|
|
3785
|
+
"line": 29
|
|
3786
|
+
},
|
|
3787
|
+
"name": "stateName",
|
|
3788
|
+
"type": {
|
|
3789
|
+
"primitive": "string"
|
|
3790
|
+
}
|
|
3791
|
+
}
|
|
3792
|
+
],
|
|
3793
|
+
"symbolId": "lib/state:State"
|
|
3794
|
+
},
|
|
3795
|
+
"@aws-cdk/aws-iotevents-alpha.StateProps": {
|
|
3796
|
+
"assembly": "@aws-cdk/aws-iotevents-alpha",
|
|
3797
|
+
"datatype": true,
|
|
3798
|
+
"docs": {
|
|
3799
|
+
"custom": {
|
|
3800
|
+
"exampleMetadata": "infused"
|
|
3801
|
+
},
|
|
3802
|
+
"example": "import * as iotevents from '@aws-cdk/aws-iotevents-alpha';\n\nconst input = new iotevents.Input(this, 'MyInput', {\n inputName: 'my_input', // optional\n attributeJsonPaths: ['payload.deviceId', 'payload.temperature'],\n});\n\nconst onlineState = new iotevents.State({\n stateName: 'online',\n onEnter: [{\n eventName: 'test-event',\n condition: iotevents.Expression.currentInput(input),\n }],\n});\n\nnew iotevents.DetectorModel(this, 'MyDetectorModel', {\n detectorModelName: 'test-detector-model', // optional\n description: 'test-detector-model-description', // optional property, default is none\n evaluationMethod: iotevents.EventEvaluation.SERIAL, // optional property, default is iotevents.EventEvaluation.BATCH\n detectorKey: 'payload.deviceId', // optional property, default is none and single detector instance will be created and all inputs will be routed to it\n initialState: onlineState,\n});",
|
|
3803
|
+
"stability": "experimental",
|
|
3804
|
+
"summary": "Properties for defining a state of a detector."
|
|
3805
|
+
},
|
|
3806
|
+
"fqn": "@aws-cdk/aws-iotevents-alpha.StateProps",
|
|
3807
|
+
"kind": "interface",
|
|
3808
|
+
"locationInModule": {
|
|
3809
|
+
"filename": "lib/state.ts",
|
|
3810
|
+
"line": 7
|
|
3811
|
+
},
|
|
3812
|
+
"name": "StateProps",
|
|
3813
|
+
"properties": [
|
|
3814
|
+
{
|
|
3815
|
+
"abstract": true,
|
|
3816
|
+
"docs": {
|
|
3817
|
+
"stability": "experimental",
|
|
3818
|
+
"summary": "The name of the state."
|
|
3819
|
+
},
|
|
3820
|
+
"immutable": true,
|
|
3821
|
+
"locationInModule": {
|
|
3822
|
+
"filename": "lib/state.ts",
|
|
3823
|
+
"line": 11
|
|
3824
|
+
},
|
|
3825
|
+
"name": "stateName",
|
|
3826
|
+
"type": {
|
|
3827
|
+
"primitive": "string"
|
|
3828
|
+
}
|
|
3829
|
+
},
|
|
3830
|
+
{
|
|
3831
|
+
"abstract": true,
|
|
3832
|
+
"docs": {
|
|
3833
|
+
"default": "- events on enter will not be set",
|
|
3834
|
+
"remarks": "the conditions of the events are evaluated when the state is entered.\nIf the condition is `TRUE`, the actions of the event are performed.",
|
|
3835
|
+
"stability": "experimental",
|
|
3836
|
+
"summary": "Specifies the events on enter."
|
|
3837
|
+
},
|
|
3838
|
+
"immutable": true,
|
|
3839
|
+
"locationInModule": {
|
|
3840
|
+
"filename": "lib/state.ts",
|
|
3841
|
+
"line": 19
|
|
3842
|
+
},
|
|
3843
|
+
"name": "onEnter",
|
|
3844
|
+
"optional": true,
|
|
3845
|
+
"type": {
|
|
3846
|
+
"collection": {
|
|
3847
|
+
"elementtype": {
|
|
3848
|
+
"fqn": "@aws-cdk/aws-iotevents-alpha.Event"
|
|
3849
|
+
},
|
|
3850
|
+
"kind": "array"
|
|
3851
|
+
}
|
|
3852
|
+
}
|
|
3853
|
+
}
|
|
3854
|
+
],
|
|
3855
|
+
"symbolId": "lib/state:StateProps"
|
|
3124
3856
|
}
|
|
3125
3857
|
},
|
|
3126
|
-
"version": "2.
|
|
3858
|
+
"version": "2.10.0-alpha.0",
|
|
3127
3859
|
"fingerprint": "**********"
|
|
3128
3860
|
}
|