@aws-cdk/aws-iotevents-alpha 2.9.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 CHANGED
@@ -8,7 +8,7 @@
8
8
  "url": "https://aws.amazon.com"
9
9
  },
10
10
  "dependencies": {
11
- "aws-cdk-lib": "^2.9.0",
11
+ "aws-cdk-lib": "^2.10.0",
12
12
  "constructs": "^10.0.0"
13
13
  },
14
14
  "dependencyClosure": {
@@ -2921,12 +2921,15 @@
2921
2921
  "compiledWithDeprecationWarnings": true,
2922
2922
  "pacmak": {
2923
2923
  "hasDefaultInterfaces": true
2924
+ },
2925
+ "rosetta": {
2926
+ "strict": true
2924
2927
  }
2925
2928
  }
2926
2929
  },
2927
2930
  "name": "@aws-cdk/aws-iotevents-alpha",
2928
2931
  "readme": {
2929
- "markdown": "# AWS::IoTEvents Construct Library\n\n<!--BEGIN STABILITY BANNER-->\n\n---\n\n![cdk-constructs: Experimental](https://img.shields.io/badge/cdk--constructs-experimental-important.svg?style=for-the-badge)\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## `Input`\n\nAdd an AWS IoT Events input to your stack:\n\n```ts\nimport * as iotevents from '@aws-cdk/aws-iotevents-alpha';\n\nnew iotevents.Input(this, 'MyInput', {\n inputName: 'my_input',\n attributeJsonPaths: ['payload.temperature'],\n});\n```\n"
2932
+ "markdown": "# AWS::IoTEvents Construct Library\n\n<!--BEGIN STABILITY BANNER-->\n\n---\n\n![cdk-constructs: Experimental](https://img.shields.io/badge/cdk--constructs-experimental-important.svg?style=for-the-badge)\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"
2930
2933
  },
2931
2934
  "repository": {
2932
2935
  "directory": "packages/individual-packages/aws-iotevents",
@@ -2964,6 +2967,568 @@
2964
2967
  }
2965
2968
  },
2966
2969
  "types": {
2970
+ "@aws-cdk/aws-iotevents-alpha.DetectorModel": {
2971
+ "assembly": "@aws-cdk/aws-iotevents-alpha",
2972
+ "base": "aws-cdk-lib.Resource",
2973
+ "docs": {
2974
+ "custom": {
2975
+ "exampleMetadata": "infused"
2976
+ },
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});",
2978
+ "stability": "experimental",
2979
+ "summary": "Defines an AWS IoT Events detector model in this stack."
2980
+ },
2981
+ "fqn": "@aws-cdk/aws-iotevents-alpha.DetectorModel",
2982
+ "initializer": {
2983
+ "docs": {
2984
+ "stability": "experimental"
2985
+ },
2986
+ "locationInModule": {
2987
+ "filename": "lib/detector-model.ts",
2988
+ "line": 106
2989
+ },
2990
+ "parameters": [
2991
+ {
2992
+ "name": "scope",
2993
+ "type": {
2994
+ "fqn": "constructs.Construct"
2995
+ }
2996
+ },
2997
+ {
2998
+ "name": "id",
2999
+ "type": {
3000
+ "primitive": "string"
3001
+ }
3002
+ },
3003
+ {
3004
+ "name": "props",
3005
+ "type": {
3006
+ "fqn": "@aws-cdk/aws-iotevents-alpha.DetectorModelProps"
3007
+ }
3008
+ }
3009
+ ]
3010
+ },
3011
+ "interfaces": [
3012
+ "@aws-cdk/aws-iotevents-alpha.IDetectorModel"
3013
+ ],
3014
+ "kind": "class",
3015
+ "locationInModule": {
3016
+ "filename": "lib/detector-model.ts",
3017
+ "line": 94
3018
+ },
3019
+ "methods": [
3020
+ {
3021
+ "docs": {
3022
+ "stability": "experimental",
3023
+ "summary": "Import an existing detector model."
3024
+ },
3025
+ "locationInModule": {
3026
+ "filename": "lib/detector-model.ts",
3027
+ "line": 98
3028
+ },
3029
+ "name": "fromDetectorModelName",
3030
+ "parameters": [
3031
+ {
3032
+ "name": "scope",
3033
+ "type": {
3034
+ "fqn": "constructs.Construct"
3035
+ }
3036
+ },
3037
+ {
3038
+ "name": "id",
3039
+ "type": {
3040
+ "primitive": "string"
3041
+ }
3042
+ },
3043
+ {
3044
+ "name": "detectorModelName",
3045
+ "type": {
3046
+ "primitive": "string"
3047
+ }
3048
+ }
3049
+ ],
3050
+ "returns": {
3051
+ "type": {
3052
+ "fqn": "@aws-cdk/aws-iotevents-alpha.IDetectorModel"
3053
+ }
3054
+ },
3055
+ "static": true
3056
+ }
3057
+ ],
3058
+ "name": "DetectorModel",
3059
+ "properties": [
3060
+ {
3061
+ "docs": {
3062
+ "stability": "experimental",
3063
+ "summary": "The name of the detector model."
3064
+ },
3065
+ "immutable": true,
3066
+ "locationInModule": {
3067
+ "filename": "lib/detector-model.ts",
3068
+ "line": 104
3069
+ },
3070
+ "name": "detectorModelName",
3071
+ "overrides": "@aws-cdk/aws-iotevents-alpha.IDetectorModel",
3072
+ "type": {
3073
+ "primitive": "string"
3074
+ }
3075
+ }
3076
+ ],
3077
+ "symbolId": "lib/detector-model:DetectorModel"
3078
+ },
3079
+ "@aws-cdk/aws-iotevents-alpha.DetectorModelProps": {
3080
+ "assembly": "@aws-cdk/aws-iotevents-alpha",
3081
+ "datatype": true,
3082
+ "docs": {
3083
+ "custom": {
3084
+ "exampleMetadata": "infused"
3085
+ },
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});",
3087
+ "stability": "experimental",
3088
+ "summary": "Properties for defining an AWS IoT Events detector model."
3089
+ },
3090
+ "fqn": "@aws-cdk/aws-iotevents-alpha.DetectorModelProps",
3091
+ "kind": "interface",
3092
+ "locationInModule": {
3093
+ "filename": "lib/detector-model.ts",
3094
+ "line": 38
3095
+ },
3096
+ "name": "DetectorModelProps",
3097
+ "properties": [
3098
+ {
3099
+ "abstract": true,
3100
+ "docs": {
3101
+ "stability": "experimental",
3102
+ "summary": "The state that is entered at the creation of each detector."
3103
+ },
3104
+ "immutable": true,
3105
+ "locationInModule": {
3106
+ "filename": "lib/detector-model.ts",
3107
+ "line": 81
3108
+ },
3109
+ "name": "initialState",
3110
+ "type": {
3111
+ "fqn": "@aws-cdk/aws-iotevents-alpha.State"
3112
+ }
3113
+ },
3114
+ {
3115
+ "abstract": true,
3116
+ "docs": {
3117
+ "default": "none",
3118
+ "stability": "experimental",
3119
+ "summary": "A brief description of the detector model."
3120
+ },
3121
+ "immutable": true,
3122
+ "locationInModule": {
3123
+ "filename": "lib/detector-model.ts",
3124
+ "line": 51
3125
+ },
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",
3164
+ "optional": true,
3165
+ "type": {
3166
+ "primitive": "string"
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
+ }
3205
+ }
3206
+ ],
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
+ },
2967
3532
  "@aws-cdk/aws-iotevents-alpha.IInput": {
2968
3533
  "assembly": "@aws-cdk/aws-iotevents-alpha",
2969
3534
  "docs": {
@@ -3010,7 +3575,7 @@
3010
3575
  "custom": {
3011
3576
  "exampleMetadata": "infused"
3012
3577
  },
3013
- "example": "import * as iotevents from '@aws-cdk/aws-iotevents-alpha';\n\nnew iotevents.Input(this, 'MyInput', {\n inputName: 'my_input',\n attributeJsonPaths: ['payload.temperature'],\n});",
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});",
3014
3579
  "stability": "experimental",
3015
3580
  "summary": "Defines an AWS IoT Events input in this stack."
3016
3581
  },
@@ -3119,7 +3684,7 @@
3119
3684
  "custom": {
3120
3685
  "exampleMetadata": "infused"
3121
3686
  },
3122
- "example": "import * as iotevents from '@aws-cdk/aws-iotevents-alpha';\n\nnew iotevents.Input(this, 'MyInput', {\n inputName: 'my_input',\n attributeJsonPaths: ['payload.temperature'],\n});",
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});",
3123
3688
  "stability": "experimental",
3124
3689
  "summary": "Properties for defining an AWS IoT Events input."
3125
3690
  },
@@ -3173,8 +3738,123 @@
3173
3738
  }
3174
3739
  ],
3175
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"
3176
3856
  }
3177
3857
  },
3178
- "version": "2.9.0-alpha.0",
3858
+ "version": "2.10.0-alpha.0",
3179
3859
  "fingerprint": "**********"
3180
3860
  }