@aws-cdk/aws-iotevents-alpha 2.9.0-alpha.0 → 2.13.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 +1036 -90
- package/.jsii.tabl.json +699 -52
- package/.warnings.jsii.js +45 -1
- package/README.md +55 -5
- package/lib/detector-model.d.ts +91 -0
- package/lib/detector-model.js +70 -0
- package/lib/event.d.ts +16 -0
- package/lib/event.js +3 -0
- package/lib/expression.d.ts +33 -0
- package/lib/expression.js +75 -0
- package/lib/index.d.ts +4 -0
- package/lib/index.js +5 -1
- package/lib/input.d.ts +37 -30
- package/lib/input.js +33 -15
- package/lib/state.d.ts +70 -0
- package/lib/state.js +99 -0
- package/package.json +16 -9
- 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.13.0",
|
|
12
12
|
"constructs": "^10.0.0"
|
|
13
13
|
},
|
|
14
14
|
"dependencyClosure": {
|
|
@@ -1523,6 +1523,19 @@
|
|
|
1523
1523
|
}
|
|
1524
1524
|
}
|
|
1525
1525
|
},
|
|
1526
|
+
"aws-cdk-lib.aws_kafkaconnect": {
|
|
1527
|
+
"targets": {
|
|
1528
|
+
"dotnet": {
|
|
1529
|
+
"namespace": "Amazon.CDK.AWS.KafkaConnect"
|
|
1530
|
+
},
|
|
1531
|
+
"java": {
|
|
1532
|
+
"package": "software.amazon.awscdk.services.kafkaconnect"
|
|
1533
|
+
},
|
|
1534
|
+
"python": {
|
|
1535
|
+
"module": "aws_cdk.aws_kafkaconnect"
|
|
1536
|
+
}
|
|
1537
|
+
}
|
|
1538
|
+
},
|
|
1526
1539
|
"aws-cdk-lib.aws_kendra": {
|
|
1527
1540
|
"targets": {
|
|
1528
1541
|
"dotnet": {
|
|
@@ -2907,7 +2920,7 @@
|
|
|
2907
2920
|
"stability": "experimental"
|
|
2908
2921
|
},
|
|
2909
2922
|
"homepage": "https://github.com/aws/aws-cdk",
|
|
2910
|
-
"jsiiVersion": "1.
|
|
2923
|
+
"jsiiVersion": "1.54.0 (build b1b977a)",
|
|
2911
2924
|
"keywords": [
|
|
2912
2925
|
"aws",
|
|
2913
2926
|
"cdk",
|
|
@@ -2921,12 +2934,15 @@
|
|
|
2921
2934
|
"compiledWithDeprecationWarnings": true,
|
|
2922
2935
|
"pacmak": {
|
|
2923
2936
|
"hasDefaultInterfaces": true
|
|
2937
|
+
},
|
|
2938
|
+
"rosetta": {
|
|
2939
|
+
"strict": true
|
|
2924
2940
|
}
|
|
2925
2941
|
}
|
|
2926
2942
|
},
|
|
2927
2943
|
"name": "@aws-cdk/aws-iotevents-alpha",
|
|
2928
2944
|
"readme": {
|
|
2929
|
-
"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## `
|
|
2945
|
+
"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 warmState = new iotevents.State({\n stateName: 'warm',\n onEnter: [{\n eventName: 'test-event',\n condition: iotevents.Expression.currentInput(input),\n }],\n});\nconst coldState = new iotevents.State({\n stateName: 'cold',\n});\n\n// transit to coldState when temperature is 10\nwarmState.transitionTo(coldState, {\n eventName: 'to_coldState', // optional property, default by combining the names of the States\n when: iotevents.Expression.eq(\n iotevents.Expression.inputAttribute(input, 'payload.temperature'),\n iotevents.Expression.fromString('10'),\n ),\n});\n// transit to warmState when temperature is 20\ncoldState.transitionTo(warmState, {\n when: iotevents.Expression.eq(\n iotevents.Expression.inputAttribute(input, 'payload.temperature'),\n iotevents.Expression.fromString('20'),\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: warmState,\n});\n```\n\nTo grant permissions to put messages in the input,\nyou can use the `grantWrite()` method:\n\n```ts\nimport * as iam from 'aws-cdk-lib/aws-iam';\nimport * as iotevents from '@aws-cdk/aws-iotevents-alpha';\n\ndeclare const grantable: iam.IGrantable;\nconst input = iotevents.Input.fromInputName(this, 'MyInput', 'my_input');\n\ninput.grantWrite(grantable);\n```\n"
|
|
2930
2946
|
},
|
|
2931
2947
|
"repository": {
|
|
2932
2948
|
"directory": "packages/individual-packages/aws-iotevents",
|
|
@@ -2964,64 +2980,25 @@
|
|
|
2964
2980
|
}
|
|
2965
2981
|
},
|
|
2966
2982
|
"types": {
|
|
2967
|
-
"@aws-cdk/aws-iotevents-alpha.
|
|
2968
|
-
"assembly": "@aws-cdk/aws-iotevents-alpha",
|
|
2969
|
-
"docs": {
|
|
2970
|
-
"stability": "experimental",
|
|
2971
|
-
"summary": "Represents an AWS IoT Events input."
|
|
2972
|
-
},
|
|
2973
|
-
"fqn": "@aws-cdk/aws-iotevents-alpha.IInput",
|
|
2974
|
-
"interfaces": [
|
|
2975
|
-
"aws-cdk-lib.IResource"
|
|
2976
|
-
],
|
|
2977
|
-
"kind": "interface",
|
|
2978
|
-
"locationInModule": {
|
|
2979
|
-
"filename": "lib/input.ts",
|
|
2980
|
-
"line": 8
|
|
2981
|
-
},
|
|
2982
|
-
"name": "IInput",
|
|
2983
|
-
"properties": [
|
|
2984
|
-
{
|
|
2985
|
-
"abstract": true,
|
|
2986
|
-
"docs": {
|
|
2987
|
-
"custom": {
|
|
2988
|
-
"attribute": "true"
|
|
2989
|
-
},
|
|
2990
|
-
"stability": "experimental",
|
|
2991
|
-
"summary": "The name of the input."
|
|
2992
|
-
},
|
|
2993
|
-
"immutable": true,
|
|
2994
|
-
"locationInModule": {
|
|
2995
|
-
"filename": "lib/input.ts",
|
|
2996
|
-
"line": 13
|
|
2997
|
-
},
|
|
2998
|
-
"name": "inputName",
|
|
2999
|
-
"type": {
|
|
3000
|
-
"primitive": "string"
|
|
3001
|
-
}
|
|
3002
|
-
}
|
|
3003
|
-
],
|
|
3004
|
-
"symbolId": "lib/input:IInput"
|
|
3005
|
-
},
|
|
3006
|
-
"@aws-cdk/aws-iotevents-alpha.Input": {
|
|
2983
|
+
"@aws-cdk/aws-iotevents-alpha.DetectorModel": {
|
|
3007
2984
|
"assembly": "@aws-cdk/aws-iotevents-alpha",
|
|
3008
2985
|
"base": "aws-cdk-lib.Resource",
|
|
3009
2986
|
"docs": {
|
|
3010
2987
|
"custom": {
|
|
3011
2988
|
"exampleMetadata": "infused"
|
|
3012
2989
|
},
|
|
3013
|
-
"example": "import * as iotevents from '@aws-cdk/aws-iotevents-alpha';\n\
|
|
2990
|
+
"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 warmState = new iotevents.State({\n stateName: 'warm',\n onEnter: [{\n eventName: 'test-event',\n condition: iotevents.Expression.currentInput(input),\n }],\n});\nconst coldState = new iotevents.State({\n stateName: 'cold',\n});\n\n// transit to coldState when temperature is 10\nwarmState.transitionTo(coldState, {\n eventName: 'to_coldState', // optional property, default by combining the names of the States\n when: iotevents.Expression.eq(\n iotevents.Expression.inputAttribute(input, 'payload.temperature'),\n iotevents.Expression.fromString('10'),\n ),\n});\n// transit to warmState when temperature is 20\ncoldState.transitionTo(warmState, {\n when: iotevents.Expression.eq(\n iotevents.Expression.inputAttribute(input, 'payload.temperature'),\n iotevents.Expression.fromString('20'),\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: warmState,\n});",
|
|
3014
2991
|
"stability": "experimental",
|
|
3015
|
-
"summary": "Defines an AWS IoT Events
|
|
2992
|
+
"summary": "Defines an AWS IoT Events detector model in this stack."
|
|
3016
2993
|
},
|
|
3017
|
-
"fqn": "@aws-cdk/aws-iotevents-alpha.
|
|
2994
|
+
"fqn": "@aws-cdk/aws-iotevents-alpha.DetectorModel",
|
|
3018
2995
|
"initializer": {
|
|
3019
2996
|
"docs": {
|
|
3020
2997
|
"stability": "experimental"
|
|
3021
2998
|
},
|
|
3022
2999
|
"locationInModule": {
|
|
3023
|
-
"filename": "lib/
|
|
3024
|
-
"line":
|
|
3000
|
+
"filename": "lib/detector-model.ts",
|
|
3001
|
+
"line": 107
|
|
3025
3002
|
},
|
|
3026
3003
|
"parameters": [
|
|
3027
3004
|
{
|
|
@@ -3039,30 +3016,30 @@
|
|
|
3039
3016
|
{
|
|
3040
3017
|
"name": "props",
|
|
3041
3018
|
"type": {
|
|
3042
|
-
"fqn": "@aws-cdk/aws-iotevents-alpha.
|
|
3019
|
+
"fqn": "@aws-cdk/aws-iotevents-alpha.DetectorModelProps"
|
|
3043
3020
|
}
|
|
3044
3021
|
}
|
|
3045
3022
|
]
|
|
3046
3023
|
},
|
|
3047
3024
|
"interfaces": [
|
|
3048
|
-
"@aws-cdk/aws-iotevents-alpha.
|
|
3025
|
+
"@aws-cdk/aws-iotevents-alpha.IDetectorModel"
|
|
3049
3026
|
],
|
|
3050
3027
|
"kind": "class",
|
|
3051
3028
|
"locationInModule": {
|
|
3052
|
-
"filename": "lib/
|
|
3053
|
-
"line":
|
|
3029
|
+
"filename": "lib/detector-model.ts",
|
|
3030
|
+
"line": 95
|
|
3054
3031
|
},
|
|
3055
3032
|
"methods": [
|
|
3056
3033
|
{
|
|
3057
3034
|
"docs": {
|
|
3058
3035
|
"stability": "experimental",
|
|
3059
|
-
"summary": "Import an existing
|
|
3036
|
+
"summary": "Import an existing detector model."
|
|
3060
3037
|
},
|
|
3061
3038
|
"locationInModule": {
|
|
3062
|
-
"filename": "lib/
|
|
3063
|
-
"line":
|
|
3039
|
+
"filename": "lib/detector-model.ts",
|
|
3040
|
+
"line": 99
|
|
3064
3041
|
},
|
|
3065
|
-
"name": "
|
|
3042
|
+
"name": "fromDetectorModelName",
|
|
3066
3043
|
"parameters": [
|
|
3067
3044
|
{
|
|
3068
3045
|
"name": "scope",
|
|
@@ -3077,7 +3054,7 @@
|
|
|
3077
3054
|
}
|
|
3078
3055
|
},
|
|
3079
3056
|
{
|
|
3080
|
-
"name": "
|
|
3057
|
+
"name": "detectorModelName",
|
|
3081
3058
|
"type": {
|
|
3082
3059
|
"primitive": "string"
|
|
3083
3060
|
}
|
|
@@ -3085,96 +3062,1065 @@
|
|
|
3085
3062
|
],
|
|
3086
3063
|
"returns": {
|
|
3087
3064
|
"type": {
|
|
3088
|
-
"fqn": "@aws-cdk/aws-iotevents-alpha.
|
|
3065
|
+
"fqn": "@aws-cdk/aws-iotevents-alpha.IDetectorModel"
|
|
3089
3066
|
}
|
|
3090
3067
|
},
|
|
3091
3068
|
"static": true
|
|
3092
3069
|
}
|
|
3093
3070
|
],
|
|
3094
|
-
"name": "
|
|
3071
|
+
"name": "DetectorModel",
|
|
3095
3072
|
"properties": [
|
|
3096
3073
|
{
|
|
3097
3074
|
"docs": {
|
|
3098
3075
|
"stability": "experimental",
|
|
3099
|
-
"summary": "The name of the
|
|
3076
|
+
"summary": "The name of the detector model."
|
|
3100
3077
|
},
|
|
3101
3078
|
"immutable": true,
|
|
3102
3079
|
"locationInModule": {
|
|
3103
|
-
"filename": "lib/
|
|
3104
|
-
"line":
|
|
3080
|
+
"filename": "lib/detector-model.ts",
|
|
3081
|
+
"line": 105
|
|
3105
3082
|
},
|
|
3106
|
-
"name": "
|
|
3107
|
-
"overrides": "@aws-cdk/aws-iotevents-alpha.
|
|
3083
|
+
"name": "detectorModelName",
|
|
3084
|
+
"overrides": "@aws-cdk/aws-iotevents-alpha.IDetectorModel",
|
|
3108
3085
|
"type": {
|
|
3109
3086
|
"primitive": "string"
|
|
3110
3087
|
}
|
|
3111
3088
|
}
|
|
3112
3089
|
],
|
|
3113
|
-
"symbolId": "lib/
|
|
3090
|
+
"symbolId": "lib/detector-model:DetectorModel"
|
|
3114
3091
|
},
|
|
3115
|
-
"@aws-cdk/aws-iotevents-alpha.
|
|
3092
|
+
"@aws-cdk/aws-iotevents-alpha.DetectorModelProps": {
|
|
3116
3093
|
"assembly": "@aws-cdk/aws-iotevents-alpha",
|
|
3117
3094
|
"datatype": true,
|
|
3118
3095
|
"docs": {
|
|
3119
3096
|
"custom": {
|
|
3120
3097
|
"exampleMetadata": "infused"
|
|
3121
3098
|
},
|
|
3122
|
-
"example": "import * as iotevents from '@aws-cdk/aws-iotevents-alpha';\n\
|
|
3099
|
+
"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 warmState = new iotevents.State({\n stateName: 'warm',\n onEnter: [{\n eventName: 'test-event',\n condition: iotevents.Expression.currentInput(input),\n }],\n});\nconst coldState = new iotevents.State({\n stateName: 'cold',\n});\n\n// transit to coldState when temperature is 10\nwarmState.transitionTo(coldState, {\n eventName: 'to_coldState', // optional property, default by combining the names of the States\n when: iotevents.Expression.eq(\n iotevents.Expression.inputAttribute(input, 'payload.temperature'),\n iotevents.Expression.fromString('10'),\n ),\n});\n// transit to warmState when temperature is 20\ncoldState.transitionTo(warmState, {\n when: iotevents.Expression.eq(\n iotevents.Expression.inputAttribute(input, 'payload.temperature'),\n iotevents.Expression.fromString('20'),\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: warmState,\n});",
|
|
3123
3100
|
"stability": "experimental",
|
|
3124
|
-
"summary": "Properties for defining an AWS IoT Events
|
|
3101
|
+
"summary": "Properties for defining an AWS IoT Events detector model."
|
|
3125
3102
|
},
|
|
3126
|
-
"fqn": "@aws-cdk/aws-iotevents-alpha.
|
|
3103
|
+
"fqn": "@aws-cdk/aws-iotevents-alpha.DetectorModelProps",
|
|
3127
3104
|
"kind": "interface",
|
|
3128
3105
|
"locationInModule": {
|
|
3129
|
-
"filename": "lib/
|
|
3130
|
-
"line":
|
|
3106
|
+
"filename": "lib/detector-model.ts",
|
|
3107
|
+
"line": 39
|
|
3131
3108
|
},
|
|
3132
|
-
"name": "
|
|
3109
|
+
"name": "DetectorModelProps",
|
|
3133
3110
|
"properties": [
|
|
3134
3111
|
{
|
|
3135
3112
|
"abstract": true,
|
|
3136
3113
|
"docs": {
|
|
3137
|
-
"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.",
|
|
3138
3114
|
"stability": "experimental",
|
|
3139
|
-
"summary": "
|
|
3115
|
+
"summary": "The state that is entered at the creation of each detector."
|
|
3140
3116
|
},
|
|
3141
3117
|
"immutable": true,
|
|
3142
3118
|
"locationInModule": {
|
|
3143
|
-
"filename": "lib/
|
|
3144
|
-
"line":
|
|
3119
|
+
"filename": "lib/detector-model.ts",
|
|
3120
|
+
"line": 82
|
|
3145
3121
|
},
|
|
3146
|
-
"name": "
|
|
3122
|
+
"name": "initialState",
|
|
3147
3123
|
"type": {
|
|
3148
|
-
"
|
|
3149
|
-
"elementtype": {
|
|
3150
|
-
"primitive": "string"
|
|
3151
|
-
},
|
|
3152
|
-
"kind": "array"
|
|
3153
|
-
}
|
|
3124
|
+
"fqn": "@aws-cdk/aws-iotevents-alpha.State"
|
|
3154
3125
|
}
|
|
3155
3126
|
},
|
|
3156
3127
|
{
|
|
3157
3128
|
"abstract": true,
|
|
3158
3129
|
"docs": {
|
|
3159
|
-
"default": "
|
|
3130
|
+
"default": "none",
|
|
3160
3131
|
"stability": "experimental",
|
|
3161
|
-
"summary": "
|
|
3132
|
+
"summary": "A brief description of the detector model."
|
|
3162
3133
|
},
|
|
3163
3134
|
"immutable": true,
|
|
3164
3135
|
"locationInModule": {
|
|
3165
|
-
"filename": "lib/
|
|
3166
|
-
"line":
|
|
3136
|
+
"filename": "lib/detector-model.ts",
|
|
3137
|
+
"line": 52
|
|
3167
3138
|
},
|
|
3168
|
-
"name": "
|
|
3139
|
+
"name": "description",
|
|
3140
|
+
"optional": true,
|
|
3141
|
+
"type": {
|
|
3142
|
+
"primitive": "string"
|
|
3143
|
+
}
|
|
3144
|
+
},
|
|
3145
|
+
{
|
|
3146
|
+
"abstract": true,
|
|
3147
|
+
"docs": {
|
|
3148
|
+
"default": "- none (single detector instance will be created and all inputs will be routed to it)",
|
|
3149
|
+
"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.",
|
|
3150
|
+
"stability": "experimental",
|
|
3151
|
+
"summary": "The value used to identify a detector instance."
|
|
3152
|
+
},
|
|
3153
|
+
"immutable": true,
|
|
3154
|
+
"locationInModule": {
|
|
3155
|
+
"filename": "lib/detector-model.ts",
|
|
3156
|
+
"line": 77
|
|
3157
|
+
},
|
|
3158
|
+
"name": "detectorKey",
|
|
3159
|
+
"optional": true,
|
|
3160
|
+
"type": {
|
|
3161
|
+
"primitive": "string"
|
|
3162
|
+
}
|
|
3163
|
+
},
|
|
3164
|
+
{
|
|
3165
|
+
"abstract": true,
|
|
3166
|
+
"docs": {
|
|
3167
|
+
"default": "- CloudFormation will generate a unique name of the detector model",
|
|
3168
|
+
"stability": "experimental",
|
|
3169
|
+
"summary": "The name of the detector model."
|
|
3170
|
+
},
|
|
3171
|
+
"immutable": true,
|
|
3172
|
+
"locationInModule": {
|
|
3173
|
+
"filename": "lib/detector-model.ts",
|
|
3174
|
+
"line": 45
|
|
3175
|
+
},
|
|
3176
|
+
"name": "detectorModelName",
|
|
3177
|
+
"optional": true,
|
|
3178
|
+
"type": {
|
|
3179
|
+
"primitive": "string"
|
|
3180
|
+
}
|
|
3181
|
+
},
|
|
3182
|
+
{
|
|
3183
|
+
"abstract": true,
|
|
3184
|
+
"docs": {
|
|
3185
|
+
"default": "EventEvaluation.BATCH",
|
|
3186
|
+
"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.",
|
|
3187
|
+
"stability": "experimental",
|
|
3188
|
+
"summary": "Information about the order in which events are evaluated and how actions are executed."
|
|
3189
|
+
},
|
|
3190
|
+
"immutable": true,
|
|
3191
|
+
"locationInModule": {
|
|
3192
|
+
"filename": "lib/detector-model.ts",
|
|
3193
|
+
"line": 64
|
|
3194
|
+
},
|
|
3195
|
+
"name": "evaluationMethod",
|
|
3196
|
+
"optional": true,
|
|
3197
|
+
"type": {
|
|
3198
|
+
"fqn": "@aws-cdk/aws-iotevents-alpha.EventEvaluation"
|
|
3199
|
+
}
|
|
3200
|
+
},
|
|
3201
|
+
{
|
|
3202
|
+
"abstract": true,
|
|
3203
|
+
"docs": {
|
|
3204
|
+
"default": "- a role will be created with default permissions",
|
|
3205
|
+
"stability": "experimental",
|
|
3206
|
+
"summary": "The role that grants permission to AWS IoT Events to perform its operations."
|
|
3207
|
+
},
|
|
3208
|
+
"immutable": true,
|
|
3209
|
+
"locationInModule": {
|
|
3210
|
+
"filename": "lib/detector-model.ts",
|
|
3211
|
+
"line": 89
|
|
3212
|
+
},
|
|
3213
|
+
"name": "role",
|
|
3169
3214
|
"optional": true,
|
|
3215
|
+
"type": {
|
|
3216
|
+
"fqn": "aws-cdk-lib.aws_iam.IRole"
|
|
3217
|
+
}
|
|
3218
|
+
}
|
|
3219
|
+
],
|
|
3220
|
+
"symbolId": "lib/detector-model:DetectorModelProps"
|
|
3221
|
+
},
|
|
3222
|
+
"@aws-cdk/aws-iotevents-alpha.Event": {
|
|
3223
|
+
"assembly": "@aws-cdk/aws-iotevents-alpha",
|
|
3224
|
+
"datatype": true,
|
|
3225
|
+
"docs": {
|
|
3226
|
+
"stability": "experimental",
|
|
3227
|
+
"summary": "Specifies the actions to be performed when the condition evaluates to TRUE.",
|
|
3228
|
+
"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};",
|
|
3229
|
+
"custom": {
|
|
3230
|
+
"exampleMetadata": "fixture=_generated"
|
|
3231
|
+
}
|
|
3232
|
+
},
|
|
3233
|
+
"fqn": "@aws-cdk/aws-iotevents-alpha.Event",
|
|
3234
|
+
"kind": "interface",
|
|
3235
|
+
"locationInModule": {
|
|
3236
|
+
"filename": "lib/event.ts",
|
|
3237
|
+
"line": 6
|
|
3238
|
+
},
|
|
3239
|
+
"name": "Event",
|
|
3240
|
+
"properties": [
|
|
3241
|
+
{
|
|
3242
|
+
"abstract": true,
|
|
3243
|
+
"docs": {
|
|
3244
|
+
"stability": "experimental",
|
|
3245
|
+
"summary": "The name of the event."
|
|
3246
|
+
},
|
|
3247
|
+
"immutable": true,
|
|
3248
|
+
"locationInModule": {
|
|
3249
|
+
"filename": "lib/event.ts",
|
|
3250
|
+
"line": 10
|
|
3251
|
+
},
|
|
3252
|
+
"name": "eventName",
|
|
3170
3253
|
"type": {
|
|
3171
3254
|
"primitive": "string"
|
|
3172
3255
|
}
|
|
3256
|
+
},
|
|
3257
|
+
{
|
|
3258
|
+
"abstract": true,
|
|
3259
|
+
"docs": {
|
|
3260
|
+
"default": "- none (the actions are always executed)",
|
|
3261
|
+
"stability": "experimental",
|
|
3262
|
+
"summary": "The Boolean expression that, when TRUE, causes the actions to be performed."
|
|
3263
|
+
},
|
|
3264
|
+
"immutable": true,
|
|
3265
|
+
"locationInModule": {
|
|
3266
|
+
"filename": "lib/event.ts",
|
|
3267
|
+
"line": 17
|
|
3268
|
+
},
|
|
3269
|
+
"name": "condition",
|
|
3270
|
+
"optional": true,
|
|
3271
|
+
"type": {
|
|
3272
|
+
"fqn": "@aws-cdk/aws-iotevents-alpha.Expression"
|
|
3273
|
+
}
|
|
3173
3274
|
}
|
|
3174
3275
|
],
|
|
3175
|
-
"symbolId": "lib/
|
|
3276
|
+
"symbolId": "lib/event:Event"
|
|
3277
|
+
},
|
|
3278
|
+
"@aws-cdk/aws-iotevents-alpha.EventEvaluation": {
|
|
3279
|
+
"assembly": "@aws-cdk/aws-iotevents-alpha",
|
|
3280
|
+
"docs": {
|
|
3281
|
+
"custom": {
|
|
3282
|
+
"exampleMetadata": "infused"
|
|
3283
|
+
},
|
|
3284
|
+
"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 warmState = new iotevents.State({\n stateName: 'warm',\n onEnter: [{\n eventName: 'test-event',\n condition: iotevents.Expression.currentInput(input),\n }],\n});\nconst coldState = new iotevents.State({\n stateName: 'cold',\n});\n\n// transit to coldState when temperature is 10\nwarmState.transitionTo(coldState, {\n eventName: 'to_coldState', // optional property, default by combining the names of the States\n when: iotevents.Expression.eq(\n iotevents.Expression.inputAttribute(input, 'payload.temperature'),\n iotevents.Expression.fromString('10'),\n ),\n});\n// transit to warmState when temperature is 20\ncoldState.transitionTo(warmState, {\n when: iotevents.Expression.eq(\n iotevents.Expression.inputAttribute(input, 'payload.temperature'),\n iotevents.Expression.fromString('20'),\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: warmState,\n});",
|
|
3285
|
+
"stability": "experimental",
|
|
3286
|
+
"summary": "Information about the order in which events are evaluated and how actions are executed."
|
|
3287
|
+
},
|
|
3288
|
+
"fqn": "@aws-cdk/aws-iotevents-alpha.EventEvaluation",
|
|
3289
|
+
"kind": "enum",
|
|
3290
|
+
"locationInModule": {
|
|
3291
|
+
"filename": "lib/detector-model.ts",
|
|
3292
|
+
"line": 22
|
|
3293
|
+
},
|
|
3294
|
+
"members": [
|
|
3295
|
+
{
|
|
3296
|
+
"docs": {
|
|
3297
|
+
"stability": "experimental",
|
|
3298
|
+
"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."
|
|
3299
|
+
},
|
|
3300
|
+
"name": "BATCH"
|
|
3301
|
+
},
|
|
3302
|
+
{
|
|
3303
|
+
"docs": {
|
|
3304
|
+
"stability": "experimental",
|
|
3305
|
+
"summary": "When setting to SERIAL, variables are updated and event conditions are evaluated in the order that the events are defined."
|
|
3306
|
+
},
|
|
3307
|
+
"name": "SERIAL"
|
|
3308
|
+
}
|
|
3309
|
+
],
|
|
3310
|
+
"name": "EventEvaluation",
|
|
3311
|
+
"symbolId": "lib/detector-model:EventEvaluation"
|
|
3312
|
+
},
|
|
3313
|
+
"@aws-cdk/aws-iotevents-alpha.Expression": {
|
|
3314
|
+
"abstract": true,
|
|
3315
|
+
"assembly": "@aws-cdk/aws-iotevents-alpha",
|
|
3316
|
+
"docs": {
|
|
3317
|
+
"custom": {
|
|
3318
|
+
"exampleMetadata": "infused"
|
|
3319
|
+
},
|
|
3320
|
+
"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 warmState = new iotevents.State({\n stateName: 'warm',\n onEnter: [{\n eventName: 'test-event',\n condition: iotevents.Expression.currentInput(input),\n }],\n});\nconst coldState = new iotevents.State({\n stateName: 'cold',\n});\n\n// transit to coldState when temperature is 10\nwarmState.transitionTo(coldState, {\n eventName: 'to_coldState', // optional property, default by combining the names of the States\n when: iotevents.Expression.eq(\n iotevents.Expression.inputAttribute(input, 'payload.temperature'),\n iotevents.Expression.fromString('10'),\n ),\n});\n// transit to warmState when temperature is 20\ncoldState.transitionTo(warmState, {\n when: iotevents.Expression.eq(\n iotevents.Expression.inputAttribute(input, 'payload.temperature'),\n iotevents.Expression.fromString('20'),\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: warmState,\n});",
|
|
3321
|
+
"see": "https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html",
|
|
3322
|
+
"stability": "experimental",
|
|
3323
|
+
"summary": "Expression for events in Detector Model state."
|
|
3324
|
+
},
|
|
3325
|
+
"fqn": "@aws-cdk/aws-iotevents-alpha.Expression",
|
|
3326
|
+
"initializer": {
|
|
3327
|
+
"docs": {
|
|
3328
|
+
"stability": "experimental"
|
|
3329
|
+
},
|
|
3330
|
+
"locationInModule": {
|
|
3331
|
+
"filename": "lib/expression.ts",
|
|
3332
|
+
"line": 44
|
|
3333
|
+
}
|
|
3334
|
+
},
|
|
3335
|
+
"kind": "class",
|
|
3336
|
+
"locationInModule": {
|
|
3337
|
+
"filename": "lib/expression.ts",
|
|
3338
|
+
"line": 7
|
|
3339
|
+
},
|
|
3340
|
+
"methods": [
|
|
3341
|
+
{
|
|
3342
|
+
"docs": {
|
|
3343
|
+
"stability": "experimental",
|
|
3344
|
+
"summary": "Create a expression for the AND operator."
|
|
3345
|
+
},
|
|
3346
|
+
"locationInModule": {
|
|
3347
|
+
"filename": "lib/expression.ts",
|
|
3348
|
+
"line": 40
|
|
3349
|
+
},
|
|
3350
|
+
"name": "and",
|
|
3351
|
+
"parameters": [
|
|
3352
|
+
{
|
|
3353
|
+
"name": "left",
|
|
3354
|
+
"type": {
|
|
3355
|
+
"fqn": "@aws-cdk/aws-iotevents-alpha.Expression"
|
|
3356
|
+
}
|
|
3357
|
+
},
|
|
3358
|
+
{
|
|
3359
|
+
"name": "right",
|
|
3360
|
+
"type": {
|
|
3361
|
+
"fqn": "@aws-cdk/aws-iotevents-alpha.Expression"
|
|
3362
|
+
}
|
|
3363
|
+
}
|
|
3364
|
+
],
|
|
3365
|
+
"returns": {
|
|
3366
|
+
"type": {
|
|
3367
|
+
"fqn": "@aws-cdk/aws-iotevents-alpha.Expression"
|
|
3368
|
+
}
|
|
3369
|
+
},
|
|
3370
|
+
"static": true
|
|
3371
|
+
},
|
|
3372
|
+
{
|
|
3373
|
+
"docs": {
|
|
3374
|
+
"remarks": "It is evaluated to true if the specified input message was received.",
|
|
3375
|
+
"stability": "experimental",
|
|
3376
|
+
"summary": "Create a expression for function `currentInput()`."
|
|
3377
|
+
},
|
|
3378
|
+
"locationInModule": {
|
|
3379
|
+
"filename": "lib/expression.ts",
|
|
3380
|
+
"line": 19
|
|
3381
|
+
},
|
|
3382
|
+
"name": "currentInput",
|
|
3383
|
+
"parameters": [
|
|
3384
|
+
{
|
|
3385
|
+
"name": "input",
|
|
3386
|
+
"type": {
|
|
3387
|
+
"fqn": "@aws-cdk/aws-iotevents-alpha.IInput"
|
|
3388
|
+
}
|
|
3389
|
+
}
|
|
3390
|
+
],
|
|
3391
|
+
"returns": {
|
|
3392
|
+
"type": {
|
|
3393
|
+
"fqn": "@aws-cdk/aws-iotevents-alpha.Expression"
|
|
3394
|
+
}
|
|
3395
|
+
},
|
|
3396
|
+
"static": true
|
|
3397
|
+
},
|
|
3398
|
+
{
|
|
3399
|
+
"docs": {
|
|
3400
|
+
"stability": "experimental",
|
|
3401
|
+
"summary": "Create a expression for the Equal operator."
|
|
3402
|
+
},
|
|
3403
|
+
"locationInModule": {
|
|
3404
|
+
"filename": "lib/expression.ts",
|
|
3405
|
+
"line": 33
|
|
3406
|
+
},
|
|
3407
|
+
"name": "eq",
|
|
3408
|
+
"parameters": [
|
|
3409
|
+
{
|
|
3410
|
+
"name": "left",
|
|
3411
|
+
"type": {
|
|
3412
|
+
"fqn": "@aws-cdk/aws-iotevents-alpha.Expression"
|
|
3413
|
+
}
|
|
3414
|
+
},
|
|
3415
|
+
{
|
|
3416
|
+
"name": "right",
|
|
3417
|
+
"type": {
|
|
3418
|
+
"fqn": "@aws-cdk/aws-iotevents-alpha.Expression"
|
|
3419
|
+
}
|
|
3420
|
+
}
|
|
3421
|
+
],
|
|
3422
|
+
"returns": {
|
|
3423
|
+
"type": {
|
|
3424
|
+
"fqn": "@aws-cdk/aws-iotevents-alpha.Expression"
|
|
3425
|
+
}
|
|
3426
|
+
},
|
|
3427
|
+
"static": true
|
|
3428
|
+
},
|
|
3429
|
+
{
|
|
3430
|
+
"docs": {
|
|
3431
|
+
"stability": "experimental",
|
|
3432
|
+
"summary": "Create a expression from the given string."
|
|
3433
|
+
},
|
|
3434
|
+
"locationInModule": {
|
|
3435
|
+
"filename": "lib/expression.ts",
|
|
3436
|
+
"line": 11
|
|
3437
|
+
},
|
|
3438
|
+
"name": "fromString",
|
|
3439
|
+
"parameters": [
|
|
3440
|
+
{
|
|
3441
|
+
"name": "value",
|
|
3442
|
+
"type": {
|
|
3443
|
+
"primitive": "string"
|
|
3444
|
+
}
|
|
3445
|
+
}
|
|
3446
|
+
],
|
|
3447
|
+
"returns": {
|
|
3448
|
+
"type": {
|
|
3449
|
+
"fqn": "@aws-cdk/aws-iotevents-alpha.Expression"
|
|
3450
|
+
}
|
|
3451
|
+
},
|
|
3452
|
+
"static": true
|
|
3453
|
+
},
|
|
3454
|
+
{
|
|
3455
|
+
"docs": {
|
|
3456
|
+
"stability": "experimental",
|
|
3457
|
+
"summary": "Create a expression for get an input attribute as `$input.TemperatureInput.temperatures[2]`."
|
|
3458
|
+
},
|
|
3459
|
+
"locationInModule": {
|
|
3460
|
+
"filename": "lib/expression.ts",
|
|
3461
|
+
"line": 26
|
|
3462
|
+
},
|
|
3463
|
+
"name": "inputAttribute",
|
|
3464
|
+
"parameters": [
|
|
3465
|
+
{
|
|
3466
|
+
"name": "input",
|
|
3467
|
+
"type": {
|
|
3468
|
+
"fqn": "@aws-cdk/aws-iotevents-alpha.IInput"
|
|
3469
|
+
}
|
|
3470
|
+
},
|
|
3471
|
+
{
|
|
3472
|
+
"name": "path",
|
|
3473
|
+
"type": {
|
|
3474
|
+
"primitive": "string"
|
|
3475
|
+
}
|
|
3476
|
+
}
|
|
3477
|
+
],
|
|
3478
|
+
"returns": {
|
|
3479
|
+
"type": {
|
|
3480
|
+
"fqn": "@aws-cdk/aws-iotevents-alpha.Expression"
|
|
3481
|
+
}
|
|
3482
|
+
},
|
|
3483
|
+
"static": true
|
|
3484
|
+
},
|
|
3485
|
+
{
|
|
3486
|
+
"abstract": true,
|
|
3487
|
+
"docs": {
|
|
3488
|
+
"stability": "experimental",
|
|
3489
|
+
"summary": "This is called to evaluate the expression."
|
|
3490
|
+
},
|
|
3491
|
+
"locationInModule": {
|
|
3492
|
+
"filename": "lib/expression.ts",
|
|
3493
|
+
"line": 50
|
|
3494
|
+
},
|
|
3495
|
+
"name": "evaluate",
|
|
3496
|
+
"returns": {
|
|
3497
|
+
"type": {
|
|
3498
|
+
"primitive": "string"
|
|
3499
|
+
}
|
|
3500
|
+
}
|
|
3501
|
+
}
|
|
3502
|
+
],
|
|
3503
|
+
"name": "Expression",
|
|
3504
|
+
"symbolId": "lib/expression:Expression"
|
|
3505
|
+
},
|
|
3506
|
+
"@aws-cdk/aws-iotevents-alpha.IDetectorModel": {
|
|
3507
|
+
"assembly": "@aws-cdk/aws-iotevents-alpha",
|
|
3508
|
+
"docs": {
|
|
3509
|
+
"stability": "experimental",
|
|
3510
|
+
"summary": "Represents an AWS IoT Events detector model."
|
|
3511
|
+
},
|
|
3512
|
+
"fqn": "@aws-cdk/aws-iotevents-alpha.IDetectorModel",
|
|
3513
|
+
"interfaces": [
|
|
3514
|
+
"aws-cdk-lib.IResource"
|
|
3515
|
+
],
|
|
3516
|
+
"kind": "interface",
|
|
3517
|
+
"locationInModule": {
|
|
3518
|
+
"filename": "lib/detector-model.ts",
|
|
3519
|
+
"line": 10
|
|
3520
|
+
},
|
|
3521
|
+
"name": "IDetectorModel",
|
|
3522
|
+
"properties": [
|
|
3523
|
+
{
|
|
3524
|
+
"abstract": true,
|
|
3525
|
+
"docs": {
|
|
3526
|
+
"custom": {
|
|
3527
|
+
"attribute": "true"
|
|
3528
|
+
},
|
|
3529
|
+
"stability": "experimental",
|
|
3530
|
+
"summary": "The name of the detector model."
|
|
3531
|
+
},
|
|
3532
|
+
"immutable": true,
|
|
3533
|
+
"locationInModule": {
|
|
3534
|
+
"filename": "lib/detector-model.ts",
|
|
3535
|
+
"line": 16
|
|
3536
|
+
},
|
|
3537
|
+
"name": "detectorModelName",
|
|
3538
|
+
"type": {
|
|
3539
|
+
"primitive": "string"
|
|
3540
|
+
}
|
|
3541
|
+
}
|
|
3542
|
+
],
|
|
3543
|
+
"symbolId": "lib/detector-model:IDetectorModel"
|
|
3544
|
+
},
|
|
3545
|
+
"@aws-cdk/aws-iotevents-alpha.IInput": {
|
|
3546
|
+
"assembly": "@aws-cdk/aws-iotevents-alpha",
|
|
3547
|
+
"docs": {
|
|
3548
|
+
"stability": "experimental",
|
|
3549
|
+
"summary": "Represents an AWS IoT Events input."
|
|
3550
|
+
},
|
|
3551
|
+
"fqn": "@aws-cdk/aws-iotevents-alpha.IInput",
|
|
3552
|
+
"interfaces": [
|
|
3553
|
+
"aws-cdk-lib.IResource"
|
|
3554
|
+
],
|
|
3555
|
+
"kind": "interface",
|
|
3556
|
+
"locationInModule": {
|
|
3557
|
+
"filename": "lib/input.ts",
|
|
3558
|
+
"line": 9
|
|
3559
|
+
},
|
|
3560
|
+
"methods": [
|
|
3561
|
+
{
|
|
3562
|
+
"abstract": true,
|
|
3563
|
+
"docs": {
|
|
3564
|
+
"stability": "experimental",
|
|
3565
|
+
"summary": "Grant the indicated permissions on this input to the given IAM principal (Role/Group/User)."
|
|
3566
|
+
},
|
|
3567
|
+
"locationInModule": {
|
|
3568
|
+
"filename": "lib/input.ts",
|
|
3569
|
+
"line": 37
|
|
3570
|
+
},
|
|
3571
|
+
"name": "grant",
|
|
3572
|
+
"parameters": [
|
|
3573
|
+
{
|
|
3574
|
+
"docs": {
|
|
3575
|
+
"summary": "the principal."
|
|
3576
|
+
},
|
|
3577
|
+
"name": "grantee",
|
|
3578
|
+
"type": {
|
|
3579
|
+
"fqn": "aws-cdk-lib.aws_iam.IGrantable"
|
|
3580
|
+
}
|
|
3581
|
+
},
|
|
3582
|
+
{
|
|
3583
|
+
"docs": {
|
|
3584
|
+
"summary": "the set of actions to allow (i.e. \"iotevents:BatchPutMessage\")."
|
|
3585
|
+
},
|
|
3586
|
+
"name": "actions",
|
|
3587
|
+
"type": {
|
|
3588
|
+
"primitive": "string"
|
|
3589
|
+
},
|
|
3590
|
+
"variadic": true
|
|
3591
|
+
}
|
|
3592
|
+
],
|
|
3593
|
+
"returns": {
|
|
3594
|
+
"type": {
|
|
3595
|
+
"fqn": "aws-cdk-lib.aws_iam.Grant"
|
|
3596
|
+
}
|
|
3597
|
+
},
|
|
3598
|
+
"variadic": true
|
|
3599
|
+
},
|
|
3600
|
+
{
|
|
3601
|
+
"abstract": true,
|
|
3602
|
+
"docs": {
|
|
3603
|
+
"stability": "experimental",
|
|
3604
|
+
"summary": "Grant write permissions on this input and its contents to an IAM principal (Role/Group/User)."
|
|
3605
|
+
},
|
|
3606
|
+
"locationInModule": {
|
|
3607
|
+
"filename": "lib/input.ts",
|
|
3608
|
+
"line": 29
|
|
3609
|
+
},
|
|
3610
|
+
"name": "grantWrite",
|
|
3611
|
+
"parameters": [
|
|
3612
|
+
{
|
|
3613
|
+
"docs": {
|
|
3614
|
+
"summary": "the principal."
|
|
3615
|
+
},
|
|
3616
|
+
"name": "grantee",
|
|
3617
|
+
"type": {
|
|
3618
|
+
"fqn": "aws-cdk-lib.aws_iam.IGrantable"
|
|
3619
|
+
}
|
|
3620
|
+
}
|
|
3621
|
+
],
|
|
3622
|
+
"returns": {
|
|
3623
|
+
"type": {
|
|
3624
|
+
"fqn": "aws-cdk-lib.aws_iam.Grant"
|
|
3625
|
+
}
|
|
3626
|
+
}
|
|
3627
|
+
}
|
|
3628
|
+
],
|
|
3629
|
+
"name": "IInput",
|
|
3630
|
+
"properties": [
|
|
3631
|
+
{
|
|
3632
|
+
"abstract": true,
|
|
3633
|
+
"docs": {
|
|
3634
|
+
"custom": {
|
|
3635
|
+
"attribute": "true"
|
|
3636
|
+
},
|
|
3637
|
+
"stability": "experimental",
|
|
3638
|
+
"summary": "The ARN of the input."
|
|
3639
|
+
},
|
|
3640
|
+
"immutable": true,
|
|
3641
|
+
"locationInModule": {
|
|
3642
|
+
"filename": "lib/input.ts",
|
|
3643
|
+
"line": 22
|
|
3644
|
+
},
|
|
3645
|
+
"name": "inputArn",
|
|
3646
|
+
"type": {
|
|
3647
|
+
"primitive": "string"
|
|
3648
|
+
}
|
|
3649
|
+
},
|
|
3650
|
+
{
|
|
3651
|
+
"abstract": true,
|
|
3652
|
+
"docs": {
|
|
3653
|
+
"custom": {
|
|
3654
|
+
"attribute": "true"
|
|
3655
|
+
},
|
|
3656
|
+
"stability": "experimental",
|
|
3657
|
+
"summary": "The name of the input."
|
|
3658
|
+
},
|
|
3659
|
+
"immutable": true,
|
|
3660
|
+
"locationInModule": {
|
|
3661
|
+
"filename": "lib/input.ts",
|
|
3662
|
+
"line": 15
|
|
3663
|
+
},
|
|
3664
|
+
"name": "inputName",
|
|
3665
|
+
"type": {
|
|
3666
|
+
"primitive": "string"
|
|
3667
|
+
}
|
|
3668
|
+
}
|
|
3669
|
+
],
|
|
3670
|
+
"symbolId": "lib/input:IInput"
|
|
3671
|
+
},
|
|
3672
|
+
"@aws-cdk/aws-iotevents-alpha.Input": {
|
|
3673
|
+
"assembly": "@aws-cdk/aws-iotevents-alpha",
|
|
3674
|
+
"base": "aws-cdk-lib.Resource",
|
|
3675
|
+
"docs": {
|
|
3676
|
+
"custom": {
|
|
3677
|
+
"exampleMetadata": "infused"
|
|
3678
|
+
},
|
|
3679
|
+
"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 warmState = new iotevents.State({\n stateName: 'warm',\n onEnter: [{\n eventName: 'test-event',\n condition: iotevents.Expression.currentInput(input),\n }],\n});\nconst coldState = new iotevents.State({\n stateName: 'cold',\n});\n\n// transit to coldState when temperature is 10\nwarmState.transitionTo(coldState, {\n eventName: 'to_coldState', // optional property, default by combining the names of the States\n when: iotevents.Expression.eq(\n iotevents.Expression.inputAttribute(input, 'payload.temperature'),\n iotevents.Expression.fromString('10'),\n ),\n});\n// transit to warmState when temperature is 20\ncoldState.transitionTo(warmState, {\n when: iotevents.Expression.eq(\n iotevents.Expression.inputAttribute(input, 'payload.temperature'),\n iotevents.Expression.fromString('20'),\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: warmState,\n});",
|
|
3680
|
+
"stability": "experimental",
|
|
3681
|
+
"summary": "Defines an AWS IoT Events input in this stack."
|
|
3682
|
+
},
|
|
3683
|
+
"fqn": "@aws-cdk/aws-iotevents-alpha.Input",
|
|
3684
|
+
"initializer": {
|
|
3685
|
+
"docs": {
|
|
3686
|
+
"stability": "experimental"
|
|
3687
|
+
},
|
|
3688
|
+
"locationInModule": {
|
|
3689
|
+
"filename": "lib/input.ts",
|
|
3690
|
+
"line": 101
|
|
3691
|
+
},
|
|
3692
|
+
"parameters": [
|
|
3693
|
+
{
|
|
3694
|
+
"name": "scope",
|
|
3695
|
+
"type": {
|
|
3696
|
+
"fqn": "constructs.Construct"
|
|
3697
|
+
}
|
|
3698
|
+
},
|
|
3699
|
+
{
|
|
3700
|
+
"name": "id",
|
|
3701
|
+
"type": {
|
|
3702
|
+
"primitive": "string"
|
|
3703
|
+
}
|
|
3704
|
+
},
|
|
3705
|
+
{
|
|
3706
|
+
"name": "props",
|
|
3707
|
+
"type": {
|
|
3708
|
+
"fqn": "@aws-cdk/aws-iotevents-alpha.InputProps"
|
|
3709
|
+
}
|
|
3710
|
+
}
|
|
3711
|
+
]
|
|
3712
|
+
},
|
|
3713
|
+
"interfaces": [
|
|
3714
|
+
"@aws-cdk/aws-iotevents-alpha.IInput"
|
|
3715
|
+
],
|
|
3716
|
+
"kind": "class",
|
|
3717
|
+
"locationInModule": {
|
|
3718
|
+
"filename": "lib/input.ts",
|
|
3719
|
+
"line": 82
|
|
3720
|
+
},
|
|
3721
|
+
"methods": [
|
|
3722
|
+
{
|
|
3723
|
+
"docs": {
|
|
3724
|
+
"stability": "experimental",
|
|
3725
|
+
"summary": "Import an existing input."
|
|
3726
|
+
},
|
|
3727
|
+
"locationInModule": {
|
|
3728
|
+
"filename": "lib/input.ts",
|
|
3729
|
+
"line": 86
|
|
3730
|
+
},
|
|
3731
|
+
"name": "fromInputName",
|
|
3732
|
+
"parameters": [
|
|
3733
|
+
{
|
|
3734
|
+
"name": "scope",
|
|
3735
|
+
"type": {
|
|
3736
|
+
"fqn": "constructs.Construct"
|
|
3737
|
+
}
|
|
3738
|
+
},
|
|
3739
|
+
{
|
|
3740
|
+
"name": "id",
|
|
3741
|
+
"type": {
|
|
3742
|
+
"primitive": "string"
|
|
3743
|
+
}
|
|
3744
|
+
},
|
|
3745
|
+
{
|
|
3746
|
+
"name": "inputName",
|
|
3747
|
+
"type": {
|
|
3748
|
+
"primitive": "string"
|
|
3749
|
+
}
|
|
3750
|
+
}
|
|
3751
|
+
],
|
|
3752
|
+
"returns": {
|
|
3753
|
+
"type": {
|
|
3754
|
+
"fqn": "@aws-cdk/aws-iotevents-alpha.IInput"
|
|
3755
|
+
}
|
|
3756
|
+
},
|
|
3757
|
+
"static": true
|
|
3758
|
+
},
|
|
3759
|
+
{
|
|
3760
|
+
"docs": {
|
|
3761
|
+
"stability": "experimental",
|
|
3762
|
+
"summary": "Grant the indicated permissions on this input to the given IAM principal (Role/Group/User)."
|
|
3763
|
+
},
|
|
3764
|
+
"locationInModule": {
|
|
3765
|
+
"filename": "lib/input.ts",
|
|
3766
|
+
"line": 49
|
|
3767
|
+
},
|
|
3768
|
+
"name": "grant",
|
|
3769
|
+
"overrides": "@aws-cdk/aws-iotevents-alpha.IInput",
|
|
3770
|
+
"parameters": [
|
|
3771
|
+
{
|
|
3772
|
+
"name": "grantee",
|
|
3773
|
+
"type": {
|
|
3774
|
+
"fqn": "aws-cdk-lib.aws_iam.IGrantable"
|
|
3775
|
+
}
|
|
3776
|
+
},
|
|
3777
|
+
{
|
|
3778
|
+
"name": "actions",
|
|
3779
|
+
"type": {
|
|
3780
|
+
"primitive": "string"
|
|
3781
|
+
},
|
|
3782
|
+
"variadic": true
|
|
3783
|
+
}
|
|
3784
|
+
],
|
|
3785
|
+
"returns": {
|
|
3786
|
+
"type": {
|
|
3787
|
+
"fqn": "aws-cdk-lib.aws_iam.Grant"
|
|
3788
|
+
}
|
|
3789
|
+
},
|
|
3790
|
+
"variadic": true
|
|
3791
|
+
},
|
|
3792
|
+
{
|
|
3793
|
+
"docs": {
|
|
3794
|
+
"stability": "experimental",
|
|
3795
|
+
"summary": "Grant write permissions on this input and its contents to an IAM principal (Role/Group/User)."
|
|
3796
|
+
},
|
|
3797
|
+
"locationInModule": {
|
|
3798
|
+
"filename": "lib/input.ts",
|
|
3799
|
+
"line": 45
|
|
3800
|
+
},
|
|
3801
|
+
"name": "grantWrite",
|
|
3802
|
+
"overrides": "@aws-cdk/aws-iotevents-alpha.IInput",
|
|
3803
|
+
"parameters": [
|
|
3804
|
+
{
|
|
3805
|
+
"name": "grantee",
|
|
3806
|
+
"type": {
|
|
3807
|
+
"fqn": "aws-cdk-lib.aws_iam.IGrantable"
|
|
3808
|
+
}
|
|
3809
|
+
}
|
|
3810
|
+
],
|
|
3811
|
+
"returns": {
|
|
3812
|
+
"type": {
|
|
3813
|
+
"fqn": "aws-cdk-lib.aws_iam.Grant"
|
|
3814
|
+
}
|
|
3815
|
+
}
|
|
3816
|
+
}
|
|
3817
|
+
],
|
|
3818
|
+
"name": "Input",
|
|
3819
|
+
"properties": [
|
|
3820
|
+
{
|
|
3821
|
+
"docs": {
|
|
3822
|
+
"stability": "experimental",
|
|
3823
|
+
"summary": "The ARN of the input."
|
|
3824
|
+
},
|
|
3825
|
+
"immutable": true,
|
|
3826
|
+
"locationInModule": {
|
|
3827
|
+
"filename": "lib/input.ts",
|
|
3828
|
+
"line": 99
|
|
3829
|
+
},
|
|
3830
|
+
"name": "inputArn",
|
|
3831
|
+
"overrides": "@aws-cdk/aws-iotevents-alpha.IInput",
|
|
3832
|
+
"type": {
|
|
3833
|
+
"primitive": "string"
|
|
3834
|
+
}
|
|
3835
|
+
},
|
|
3836
|
+
{
|
|
3837
|
+
"docs": {
|
|
3838
|
+
"stability": "experimental",
|
|
3839
|
+
"summary": "The name of the input."
|
|
3840
|
+
},
|
|
3841
|
+
"immutable": true,
|
|
3842
|
+
"locationInModule": {
|
|
3843
|
+
"filename": "lib/input.ts",
|
|
3844
|
+
"line": 97
|
|
3845
|
+
},
|
|
3846
|
+
"name": "inputName",
|
|
3847
|
+
"overrides": "@aws-cdk/aws-iotevents-alpha.IInput",
|
|
3848
|
+
"type": {
|
|
3849
|
+
"primitive": "string"
|
|
3850
|
+
}
|
|
3851
|
+
}
|
|
3852
|
+
],
|
|
3853
|
+
"symbolId": "lib/input:Input"
|
|
3854
|
+
},
|
|
3855
|
+
"@aws-cdk/aws-iotevents-alpha.InputProps": {
|
|
3856
|
+
"assembly": "@aws-cdk/aws-iotevents-alpha",
|
|
3857
|
+
"datatype": true,
|
|
3858
|
+
"docs": {
|
|
3859
|
+
"custom": {
|
|
3860
|
+
"exampleMetadata": "infused"
|
|
3861
|
+
},
|
|
3862
|
+
"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 warmState = new iotevents.State({\n stateName: 'warm',\n onEnter: [{\n eventName: 'test-event',\n condition: iotevents.Expression.currentInput(input),\n }],\n});\nconst coldState = new iotevents.State({\n stateName: 'cold',\n});\n\n// transit to coldState when temperature is 10\nwarmState.transitionTo(coldState, {\n eventName: 'to_coldState', // optional property, default by combining the names of the States\n when: iotevents.Expression.eq(\n iotevents.Expression.inputAttribute(input, 'payload.temperature'),\n iotevents.Expression.fromString('10'),\n ),\n});\n// transit to warmState when temperature is 20\ncoldState.transitionTo(warmState, {\n when: iotevents.Expression.eq(\n iotevents.Expression.inputAttribute(input, 'payload.temperature'),\n iotevents.Expression.fromString('20'),\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: warmState,\n});",
|
|
3863
|
+
"stability": "experimental",
|
|
3864
|
+
"summary": "Properties for defining an AWS IoT Events input."
|
|
3865
|
+
},
|
|
3866
|
+
"fqn": "@aws-cdk/aws-iotevents-alpha.InputProps",
|
|
3867
|
+
"kind": "interface",
|
|
3868
|
+
"locationInModule": {
|
|
3869
|
+
"filename": "lib/input.ts",
|
|
3870
|
+
"line": 61
|
|
3871
|
+
},
|
|
3872
|
+
"name": "InputProps",
|
|
3873
|
+
"properties": [
|
|
3874
|
+
{
|
|
3875
|
+
"abstract": true,
|
|
3876
|
+
"docs": {
|
|
3877
|
+
"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.",
|
|
3878
|
+
"stability": "experimental",
|
|
3879
|
+
"summary": "An expression that specifies an attribute-value pair in a JSON structure."
|
|
3880
|
+
},
|
|
3881
|
+
"immutable": true,
|
|
3882
|
+
"locationInModule": {
|
|
3883
|
+
"filename": "lib/input.ts",
|
|
3884
|
+
"line": 76
|
|
3885
|
+
},
|
|
3886
|
+
"name": "attributeJsonPaths",
|
|
3887
|
+
"type": {
|
|
3888
|
+
"collection": {
|
|
3889
|
+
"elementtype": {
|
|
3890
|
+
"primitive": "string"
|
|
3891
|
+
},
|
|
3892
|
+
"kind": "array"
|
|
3893
|
+
}
|
|
3894
|
+
}
|
|
3895
|
+
},
|
|
3896
|
+
{
|
|
3897
|
+
"abstract": true,
|
|
3898
|
+
"docs": {
|
|
3899
|
+
"default": "- CloudFormation will generate a unique name of the input",
|
|
3900
|
+
"stability": "experimental",
|
|
3901
|
+
"summary": "The name of the input."
|
|
3902
|
+
},
|
|
3903
|
+
"immutable": true,
|
|
3904
|
+
"locationInModule": {
|
|
3905
|
+
"filename": "lib/input.ts",
|
|
3906
|
+
"line": 67
|
|
3907
|
+
},
|
|
3908
|
+
"name": "inputName",
|
|
3909
|
+
"optional": true,
|
|
3910
|
+
"type": {
|
|
3911
|
+
"primitive": "string"
|
|
3912
|
+
}
|
|
3913
|
+
}
|
|
3914
|
+
],
|
|
3915
|
+
"symbolId": "lib/input:InputProps"
|
|
3916
|
+
},
|
|
3917
|
+
"@aws-cdk/aws-iotevents-alpha.State": {
|
|
3918
|
+
"assembly": "@aws-cdk/aws-iotevents-alpha",
|
|
3919
|
+
"docs": {
|
|
3920
|
+
"custom": {
|
|
3921
|
+
"exampleMetadata": "infused"
|
|
3922
|
+
},
|
|
3923
|
+
"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 warmState = new iotevents.State({\n stateName: 'warm',\n onEnter: [{\n eventName: 'test-event',\n condition: iotevents.Expression.currentInput(input),\n }],\n});\nconst coldState = new iotevents.State({\n stateName: 'cold',\n});\n\n// transit to coldState when temperature is 10\nwarmState.transitionTo(coldState, {\n eventName: 'to_coldState', // optional property, default by combining the names of the States\n when: iotevents.Expression.eq(\n iotevents.Expression.inputAttribute(input, 'payload.temperature'),\n iotevents.Expression.fromString('10'),\n ),\n});\n// transit to warmState when temperature is 20\ncoldState.transitionTo(warmState, {\n when: iotevents.Expression.eq(\n iotevents.Expression.inputAttribute(input, 'payload.temperature'),\n iotevents.Expression.fromString('20'),\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: warmState,\n});",
|
|
3924
|
+
"stability": "experimental",
|
|
3925
|
+
"summary": "Defines a state of a detector."
|
|
3926
|
+
},
|
|
3927
|
+
"fqn": "@aws-cdk/aws-iotevents-alpha.State",
|
|
3928
|
+
"initializer": {
|
|
3929
|
+
"docs": {
|
|
3930
|
+
"stability": "experimental"
|
|
3931
|
+
},
|
|
3932
|
+
"locationInModule": {
|
|
3933
|
+
"filename": "lib/state.ts",
|
|
3934
|
+
"line": 72
|
|
3935
|
+
},
|
|
3936
|
+
"parameters": [
|
|
3937
|
+
{
|
|
3938
|
+
"name": "props",
|
|
3939
|
+
"type": {
|
|
3940
|
+
"fqn": "@aws-cdk/aws-iotevents-alpha.StateProps"
|
|
3941
|
+
}
|
|
3942
|
+
}
|
|
3943
|
+
]
|
|
3944
|
+
},
|
|
3945
|
+
"kind": "class",
|
|
3946
|
+
"locationInModule": {
|
|
3947
|
+
"filename": "lib/state.ts",
|
|
3948
|
+
"line": 64
|
|
3949
|
+
},
|
|
3950
|
+
"methods": [
|
|
3951
|
+
{
|
|
3952
|
+
"docs": {
|
|
3953
|
+
"remarks": "The transition event will be triggered if condition is evaluated to TRUE.",
|
|
3954
|
+
"stability": "experimental",
|
|
3955
|
+
"summary": "Add a transition event to the state."
|
|
3956
|
+
},
|
|
3957
|
+
"locationInModule": {
|
|
3958
|
+
"filename": "lib/state.ts",
|
|
3959
|
+
"line": 83
|
|
3960
|
+
},
|
|
3961
|
+
"name": "transitionTo",
|
|
3962
|
+
"parameters": [
|
|
3963
|
+
{
|
|
3964
|
+
"docs": {
|
|
3965
|
+
"summary": "the state that will be transit to when the event triggered."
|
|
3966
|
+
},
|
|
3967
|
+
"name": "targetState",
|
|
3968
|
+
"type": {
|
|
3969
|
+
"fqn": "@aws-cdk/aws-iotevents-alpha.State"
|
|
3970
|
+
}
|
|
3971
|
+
},
|
|
3972
|
+
{
|
|
3973
|
+
"docs": {
|
|
3974
|
+
"summary": "transition options including the condition that causes the state transition."
|
|
3975
|
+
},
|
|
3976
|
+
"name": "options",
|
|
3977
|
+
"type": {
|
|
3978
|
+
"fqn": "@aws-cdk/aws-iotevents-alpha.TransitionOptions"
|
|
3979
|
+
}
|
|
3980
|
+
}
|
|
3981
|
+
]
|
|
3982
|
+
}
|
|
3983
|
+
],
|
|
3984
|
+
"name": "State",
|
|
3985
|
+
"properties": [
|
|
3986
|
+
{
|
|
3987
|
+
"docs": {
|
|
3988
|
+
"stability": "experimental",
|
|
3989
|
+
"summary": "The name of the state."
|
|
3990
|
+
},
|
|
3991
|
+
"immutable": true,
|
|
3992
|
+
"locationInModule": {
|
|
3993
|
+
"filename": "lib/state.ts",
|
|
3994
|
+
"line": 68
|
|
3995
|
+
},
|
|
3996
|
+
"name": "stateName",
|
|
3997
|
+
"type": {
|
|
3998
|
+
"primitive": "string"
|
|
3999
|
+
}
|
|
4000
|
+
}
|
|
4001
|
+
],
|
|
4002
|
+
"symbolId": "lib/state:State"
|
|
4003
|
+
},
|
|
4004
|
+
"@aws-cdk/aws-iotevents-alpha.StateProps": {
|
|
4005
|
+
"assembly": "@aws-cdk/aws-iotevents-alpha",
|
|
4006
|
+
"datatype": true,
|
|
4007
|
+
"docs": {
|
|
4008
|
+
"custom": {
|
|
4009
|
+
"exampleMetadata": "infused"
|
|
4010
|
+
},
|
|
4011
|
+
"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 warmState = new iotevents.State({\n stateName: 'warm',\n onEnter: [{\n eventName: 'test-event',\n condition: iotevents.Expression.currentInput(input),\n }],\n});\nconst coldState = new iotevents.State({\n stateName: 'cold',\n});\n\n// transit to coldState when temperature is 10\nwarmState.transitionTo(coldState, {\n eventName: 'to_coldState', // optional property, default by combining the names of the States\n when: iotevents.Expression.eq(\n iotevents.Expression.inputAttribute(input, 'payload.temperature'),\n iotevents.Expression.fromString('10'),\n ),\n});\n// transit to warmState when temperature is 20\ncoldState.transitionTo(warmState, {\n when: iotevents.Expression.eq(\n iotevents.Expression.inputAttribute(input, 'payload.temperature'),\n iotevents.Expression.fromString('20'),\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: warmState,\n});",
|
|
4012
|
+
"stability": "experimental",
|
|
4013
|
+
"summary": "Properties for defining a state of a detector."
|
|
4014
|
+
},
|
|
4015
|
+
"fqn": "@aws-cdk/aws-iotevents-alpha.StateProps",
|
|
4016
|
+
"kind": "interface",
|
|
4017
|
+
"locationInModule": {
|
|
4018
|
+
"filename": "lib/state.ts",
|
|
4019
|
+
"line": 46
|
|
4020
|
+
},
|
|
4021
|
+
"name": "StateProps",
|
|
4022
|
+
"properties": [
|
|
4023
|
+
{
|
|
4024
|
+
"abstract": true,
|
|
4025
|
+
"docs": {
|
|
4026
|
+
"stability": "experimental",
|
|
4027
|
+
"summary": "The name of the state."
|
|
4028
|
+
},
|
|
4029
|
+
"immutable": true,
|
|
4030
|
+
"locationInModule": {
|
|
4031
|
+
"filename": "lib/state.ts",
|
|
4032
|
+
"line": 50
|
|
4033
|
+
},
|
|
4034
|
+
"name": "stateName",
|
|
4035
|
+
"type": {
|
|
4036
|
+
"primitive": "string"
|
|
4037
|
+
}
|
|
4038
|
+
},
|
|
4039
|
+
{
|
|
4040
|
+
"abstract": true,
|
|
4041
|
+
"docs": {
|
|
4042
|
+
"default": "- events on enter will not be set",
|
|
4043
|
+
"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.",
|
|
4044
|
+
"stability": "experimental",
|
|
4045
|
+
"summary": "Specifies the events on enter."
|
|
4046
|
+
},
|
|
4047
|
+
"immutable": true,
|
|
4048
|
+
"locationInModule": {
|
|
4049
|
+
"filename": "lib/state.ts",
|
|
4050
|
+
"line": 58
|
|
4051
|
+
},
|
|
4052
|
+
"name": "onEnter",
|
|
4053
|
+
"optional": true,
|
|
4054
|
+
"type": {
|
|
4055
|
+
"collection": {
|
|
4056
|
+
"elementtype": {
|
|
4057
|
+
"fqn": "@aws-cdk/aws-iotevents-alpha.Event"
|
|
4058
|
+
},
|
|
4059
|
+
"kind": "array"
|
|
4060
|
+
}
|
|
4061
|
+
}
|
|
4062
|
+
}
|
|
4063
|
+
],
|
|
4064
|
+
"symbolId": "lib/state:StateProps"
|
|
4065
|
+
},
|
|
4066
|
+
"@aws-cdk/aws-iotevents-alpha.TransitionOptions": {
|
|
4067
|
+
"assembly": "@aws-cdk/aws-iotevents-alpha",
|
|
4068
|
+
"datatype": true,
|
|
4069
|
+
"docs": {
|
|
4070
|
+
"custom": {
|
|
4071
|
+
"exampleMetadata": "infused"
|
|
4072
|
+
},
|
|
4073
|
+
"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 warmState = new iotevents.State({\n stateName: 'warm',\n onEnter: [{\n eventName: 'test-event',\n condition: iotevents.Expression.currentInput(input),\n }],\n});\nconst coldState = new iotevents.State({\n stateName: 'cold',\n});\n\n// transit to coldState when temperature is 10\nwarmState.transitionTo(coldState, {\n eventName: 'to_coldState', // optional property, default by combining the names of the States\n when: iotevents.Expression.eq(\n iotevents.Expression.inputAttribute(input, 'payload.temperature'),\n iotevents.Expression.fromString('10'),\n ),\n});\n// transit to warmState when temperature is 20\ncoldState.transitionTo(warmState, {\n when: iotevents.Expression.eq(\n iotevents.Expression.inputAttribute(input, 'payload.temperature'),\n iotevents.Expression.fromString('20'),\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: warmState,\n});",
|
|
4074
|
+
"stability": "experimental",
|
|
4075
|
+
"summary": "Properties for options of state transition."
|
|
4076
|
+
},
|
|
4077
|
+
"fqn": "@aws-cdk/aws-iotevents-alpha.TransitionOptions",
|
|
4078
|
+
"kind": "interface",
|
|
4079
|
+
"locationInModule": {
|
|
4080
|
+
"filename": "lib/state.ts",
|
|
4081
|
+
"line": 8
|
|
4082
|
+
},
|
|
4083
|
+
"name": "TransitionOptions",
|
|
4084
|
+
"properties": [
|
|
4085
|
+
{
|
|
4086
|
+
"abstract": true,
|
|
4087
|
+
"docs": {
|
|
4088
|
+
"remarks": "When this was evaluated to TRUE, the state transition and the actions are triggered.",
|
|
4089
|
+
"stability": "experimental",
|
|
4090
|
+
"summary": "The condition that is used to determine to cause the state transition and the actions."
|
|
4091
|
+
},
|
|
4092
|
+
"immutable": true,
|
|
4093
|
+
"locationInModule": {
|
|
4094
|
+
"filename": "lib/state.ts",
|
|
4095
|
+
"line": 20
|
|
4096
|
+
},
|
|
4097
|
+
"name": "when",
|
|
4098
|
+
"type": {
|
|
4099
|
+
"fqn": "@aws-cdk/aws-iotevents-alpha.Expression"
|
|
4100
|
+
}
|
|
4101
|
+
},
|
|
4102
|
+
{
|
|
4103
|
+
"abstract": true,
|
|
4104
|
+
"docs": {
|
|
4105
|
+
"default": "string combining the names of the States as `${originStateName}_to_${targetStateName}`",
|
|
4106
|
+
"stability": "experimental",
|
|
4107
|
+
"summary": "The name of the event."
|
|
4108
|
+
},
|
|
4109
|
+
"immutable": true,
|
|
4110
|
+
"locationInModule": {
|
|
4111
|
+
"filename": "lib/state.ts",
|
|
4112
|
+
"line": 14
|
|
4113
|
+
},
|
|
4114
|
+
"name": "eventName",
|
|
4115
|
+
"optional": true,
|
|
4116
|
+
"type": {
|
|
4117
|
+
"primitive": "string"
|
|
4118
|
+
}
|
|
4119
|
+
}
|
|
4120
|
+
],
|
|
4121
|
+
"symbolId": "lib/state:TransitionOptions"
|
|
3176
4122
|
}
|
|
3177
4123
|
},
|
|
3178
|
-
"version": "2.
|
|
4124
|
+
"version": "2.13.0-alpha.0",
|
|
3179
4125
|
"fingerprint": "**********"
|
|
3180
4126
|
}
|