@aws-cdk/aws-iotevents-actions-alpha 2.34.2-alpha.0 → 2.37.0-alpha.0

package/.jsii

@@ -8,8 +8,8 @@
     "url": "https://aws.amazon.com"
   },
   "dependencies": {
-    "@aws-cdk/aws-iotevents-alpha": "2.34.2-alpha.0",
-    "aws-cdk-lib": "^2.34.2",
+    "@aws-cdk/aws-iotevents-alpha": "2.37.0-alpha.0",
+    "aws-cdk-lib": "^2.37.0",
     "constructs": "^10.0.0"
   },
   "dependencyClosure": {
@@ -3056,7 +3056,7 @@
     "stability": "experimental"
   },
   "homepage": "https://github.com/aws/aws-cdk",
-  "jsiiVersion": "1.63.0 (build 7c24e36)",
+  "jsiiVersion": "1.63.2 (build a8a8833)",
   "keywords": [
     "aws",
     "cdk",
@@ -3075,7 +3075,7 @@
   },
   "name": "@aws-cdk/aws-iotevents-actions-alpha",
   "readme": {
-    "markdown": "# Actions for AWS::IoTEvents Detector Model\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\nThis library contains integration classes to specify actions of state events of Detector Model in `@aws-cdk/aws-iotevents`.\nInstances of these classes should be passed to `State` defined in `@aws-cdk/aws-iotevents`\nYou can define built-in actions to use a timer or set a variable, or send data to other AWS resources.\n\nThis library contains integration classes to use a timer or set a variable, or send data to other AWS resources.\nAWS IoT Events can trigger actions when it detects a specified event or transition event.\n\nCurrently supported are:\n\n- Set variable to detector instanse\n- Invoke a Lambda function\n\n## Set variable to detector instanse\n\nThe code snippet below creates an Action that set variable to detector instanse\nwhen it is triggered.\n\n```ts\nimport * as iotevents from '@aws-cdk/aws-iotevents-alpha';\nimport * as actions from '@aws-cdk/aws-iotevents-actions-alpha';\n\ndeclare const input: iotevents.IInput;\n\nconst state = new iotevents.State({\n  stateName: 'MyState',\n  onEnter: [{\n    eventName: 'test-event',\n    condition: iotevents.Expression.currentInput(input),\n    actions: [\n      actions: [\n        new actions.SetVariableAction(\n          'MyVariable',\n          iotevents.Expression.inputAttribute(input, 'payload.temperature'),\n        ),\n      ],\n    ],\n  }],\n});\n```\n\n## Invoke a Lambda function\n\nThe code snippet below creates an Action that invoke a Lambda function\nwhen it is triggered.\n\n```ts\nimport * as iotevents from '@aws-cdk/aws-iotevents-alpha';\nimport * as actions from '@aws-cdk/aws-iotevents-actions-alpha';\nimport * as lambda from 'aws-cdk-lib/aws-lambda';\n\ndeclare const input: iotevents.IInput;\ndeclare const func: lambda.IFunction;\n\nconst state = new iotevents.State({\n  stateName: 'MyState',\n  onEnter: [{\n    eventName: 'test-event',\n    condition: iotevents.Expression.currentInput(input),\n    actions: [new actions.LambdaInvokeAction(func)],\n  }],\n});\n```\n"
+    "markdown": "# Actions for AWS::IoTEvents Detector Model\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\nThis library contains integration classes to specify actions of state events of Detector Model in `@aws-cdk/aws-iotevents`.\nInstances of these classes should be passed to `State` defined in `@aws-cdk/aws-iotevents`\nYou can define built-in actions to use a timer or set a variable, or send data to other AWS resources.\n\nThis library contains integration classes to use a timer or set a variable, or send data to other AWS resources.\nAWS IoT Events can trigger actions when it detects a specified event or transition event.\n\nCurrently supported are:\n\n- Use timer\n- Set variable to detector instanse\n- Invoke a Lambda function\n\n## Use timer\n\nThe code snippet below creates an Action that creates the timer with duration in seconds.\n\n```ts\nimport * as iotevents from '@aws-cdk/aws-iotevents-alpha';\nimport * as actions from '@aws-cdk/aws-iotevents-actions-alpha';\n\ndeclare const input: iotevents.IInput;\n\nconst state = new iotevents.State({\n  stateName: 'MyState',\n  onEnter: [{\n    eventName: 'test-event',\n    condition: iotevents.Expression.currentInput(input),\n    actions: [\n      new actions.SetTimerAction('MyTimer', {\n        duration: cdk.Duration.seconds(60),\n      }),\n    ],\n  }],\n});\n```\n\nSetting duration by [IoT Events Expression](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html):\n\n```ts\nnew actions.SetTimerAction('MyTimer', {\n  durationExpression: iotevents.Expression.inputAttribute(input, 'payload.durationSeconds'),\n})\n```\n\nAnd the timer can be reset and cleared. Below is an example of general\n[Device HeartBeat](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-examples-dhb.html)\nDetector Model:\n\n```ts\nconst online = new iotevents.State({\n  stateName: 'Online',\n  onEnter: [{\n    eventName: 'enter-event',\n    condition: iotevents.Expression.currentInput(input),\n    actions: [\n      new actions.SetTimerAction('MyTimer', {\n        duration: cdk.Duration.seconds(60),\n      }),\n    ],\n  }],\n  onInput: [{\n    eventName: 'input-event',\n    condition: iotevents.Expression.currentInput(input),\n    actions: [\n      new actions.ResetTimerAction('MyTimer'),\n    ],\n  }],\n  onExit: [{\n    eventName: 'exit-event',\n    actions: [\n      new actions.ClearTimerAction('MyTimer'),\n    ],\n  }],\n});\nconst offline = new iotevents.State({ stateName: 'Offline' });\n\nonline.transitionTo(offline, { when: iotevents.Expression.timeout('MyTimer') });\noffline.transitionTo(online, { when: iotevents.Expression.currentInput(input) });\n```\n\n## Set variable to detector instanse\n\nThe code snippet below creates an Action that set variable to detector instanse\nwhen it is triggered.\n\n```ts\nimport * as iotevents from '@aws-cdk/aws-iotevents-alpha';\nimport * as actions from '@aws-cdk/aws-iotevents-actions-alpha';\n\ndeclare const input: iotevents.IInput;\n\nconst state = new iotevents.State({\n  stateName: 'MyState',\n  onEnter: [{\n    eventName: 'test-event',\n    condition: iotevents.Expression.currentInput(input),\n    actions: [\n      new actions.SetVariableAction(\n        'MyVariable',\n        iotevents.Expression.inputAttribute(input, 'payload.temperature'),\n      ),\n    ],\n  }],\n});\n```\n\n## Invoke a Lambda function\n\nThe code snippet below creates an Action that invoke a Lambda function\nwhen it is triggered.\n\n```ts\nimport * as iotevents from '@aws-cdk/aws-iotevents-alpha';\nimport * as actions from '@aws-cdk/aws-iotevents-actions-alpha';\nimport * as lambda from 'aws-cdk-lib/aws-lambda';\n\ndeclare const input: iotevents.IInput;\ndeclare const func: lambda.IFunction;\n\nconst state = new iotevents.State({\n  stateName: 'MyState',\n  onEnter: [{\n    eventName: 'test-event',\n    condition: iotevents.Expression.currentInput(input),\n    actions: [new actions.LambdaInvokeAction(func)],\n  }],\n});\n```\n"
   },
   "repository": {
     "directory": "packages/individual-packages/aws-iotevents-actions",
@@ -3113,6 +3113,48 @@
     }
   },
   "types": {
+    "@aws-cdk/aws-iotevents-actions-alpha.ClearTimerAction": {
+      "assembly": "@aws-cdk/aws-iotevents-actions-alpha",
+      "docs": {
+        "stability": "experimental",
+        "summary": "The action to delete an existing timer.",
+        "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as iotevents_actions_alpha from '@aws-cdk/aws-iotevents-actions-alpha';\nconst clearTimerAction = new iotevents_actions_alpha.ClearTimerAction('timerName');",
+        "custom": {
+          "exampleMetadata": "fixture=_generated"
+        }
+      },
+      "fqn": "@aws-cdk/aws-iotevents-actions-alpha.ClearTimerAction",
+      "initializer": {
+        "docs": {
+          "stability": "experimental"
+        },
+        "locationInModule": {
+          "filename": "lib/clear-timer-action.ts",
+          "line": 11
+        },
+        "parameters": [
+          {
+            "docs": {
+              "summary": "the name of the timer."
+            },
+            "name": "timerName",
+            "type": {
+              "primitive": "string"
+            }
+          }
+        ]
+      },
+      "interfaces": [
+        "@aws-cdk/aws-iotevents-alpha.IAction"
+      ],
+      "kind": "class",
+      "locationInModule": {
+        "filename": "lib/clear-timer-action.ts",
+        "line": 7
+      },
+      "name": "ClearTimerAction",
+      "symbolId": "lib/clear-timer-action:ClearTimerAction"
+    },
     "@aws-cdk/aws-iotevents-actions-alpha.LambdaInvokeAction": {
       "assembly": "@aws-cdk/aws-iotevents-actions-alpha",
       "docs": {
@@ -3152,41 +3194,101 @@
         "filename": "lib/lambda-invoke-action.ts",
         "line": 8
       },
-      "methods": [
-        {
-          "docs": {
-            "stability": "experimental",
-            "summary": "Returns the AWS IoT Events action specification."
-          },
-          "locationInModule": {
-            "filename": "lib/lambda-invoke-action.ts",
-            "line": 15
-          },
-          "name": "bind",
-          "overrides": "@aws-cdk/aws-iotevents-alpha.IAction",
-          "parameters": [
-            {
-              "name": "_scope",
-              "type": {
-                "fqn": "constructs.Construct"
-              }
+      "name": "LambdaInvokeAction",
+      "symbolId": "lib/lambda-invoke-action:LambdaInvokeAction"
+    },
+    "@aws-cdk/aws-iotevents-actions-alpha.ResetTimerAction": {
+      "assembly": "@aws-cdk/aws-iotevents-actions-alpha",
+      "docs": {
+        "stability": "experimental",
+        "summary": "The action to reset an existing timer.",
+        "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as iotevents_actions_alpha from '@aws-cdk/aws-iotevents-actions-alpha';\nconst resetTimerAction = new iotevents_actions_alpha.ResetTimerAction('timerName');",
+        "custom": {
+          "exampleMetadata": "fixture=_generated"
+        }
+      },
+      "fqn": "@aws-cdk/aws-iotevents-actions-alpha.ResetTimerAction",
+      "initializer": {
+        "docs": {
+          "stability": "experimental"
+        },
+        "locationInModule": {
+          "filename": "lib/reset-timer-action.ts",
+          "line": 11
+        },
+        "parameters": [
+          {
+            "docs": {
+              "summary": "the name of the timer."
             },
-            {
-              "name": "options",
-              "type": {
-                "fqn": "@aws-cdk/aws-iotevents-alpha.ActionBindOptions"
-              }
+            "name": "timerName",
+            "type": {
+              "primitive": "string"
             }
-          ],
-          "returns": {
+          }
+        ]
+      },
+      "interfaces": [
+        "@aws-cdk/aws-iotevents-alpha.IAction"
+      ],
+      "kind": "class",
+      "locationInModule": {
+        "filename": "lib/reset-timer-action.ts",
+        "line": 7
+      },
+      "name": "ResetTimerAction",
+      "symbolId": "lib/reset-timer-action:ResetTimerAction"
+    },
+    "@aws-cdk/aws-iotevents-actions-alpha.SetTimerAction": {
+      "assembly": "@aws-cdk/aws-iotevents-actions-alpha",
+      "docs": {
+        "custom": {
+          "exampleMetadata": "infused"
+        },
+        "example": "import * as iotevents from '@aws-cdk/aws-iotevents-alpha';\nimport * as actions from '@aws-cdk/aws-iotevents-actions-alpha';\n\ndeclare const input: iotevents.IInput;\n\nconst state = new iotevents.State({\n  stateName: 'MyState',\n  onEnter: [{\n    eventName: 'test-event',\n    condition: iotevents.Expression.currentInput(input),\n    actions: [\n      new actions.SetTimerAction('MyTimer', {\n        duration: cdk.Duration.seconds(60),\n      }),\n    ],\n  }],\n});",
+        "stability": "experimental",
+        "summary": "The action to create a timer with duration in seconds."
+      },
+      "fqn": "@aws-cdk/aws-iotevents-actions-alpha.SetTimerAction",
+      "initializer": {
+        "docs": {
+          "stability": "experimental"
+        },
+        "locationInModule": {
+          "filename": "lib/set-timer-action.ts",
+          "line": 13
+        },
+        "parameters": [
+          {
+            "docs": {
+              "summary": "the name of the timer."
+            },
+            "name": "timerName",
             "type": {
-              "fqn": "@aws-cdk/aws-iotevents-alpha.ActionConfig"
+              "primitive": "string"
+            }
+          },
+          {
+            "docs": {
+              "summary": "the duration of the timer."
+            },
+            "name": "timerDuration",
+            "type": {
+              "fqn": "@aws-cdk/aws-iotevents-actions-alpha.TimerDuration"
             }
           }
-        }
+        ]
+      },
+      "interfaces": [
+        "@aws-cdk/aws-iotevents-alpha.IAction"
       ],
-      "name": "LambdaInvokeAction",
-      "symbolId": "lib/lambda-invoke-action:LambdaInvokeAction"
+      "kind": "class",
+      "locationInModule": {
+        "filename": "lib/set-timer-action.ts",
+        "line": 8
+      },
+      "name": "SetTimerAction",
+      "symbolId": "lib/set-timer-action:SetTimerAction"
     },
     "@aws-cdk/aws-iotevents-actions-alpha.SetVariableAction": {
       "assembly": "@aws-cdk/aws-iotevents-actions-alpha",
@@ -3194,7 +3296,7 @@
         "custom": {
           "exampleMetadata": "infused"
         },
-        "example": "import * as iotevents from '@aws-cdk/aws-iotevents-alpha';\nimport * as actions from '@aws-cdk/aws-iotevents-actions-alpha';\n\ndeclare const input: iotevents.IInput;\n\nconst state = new iotevents.State({\n  stateName: 'MyState',\n  onEnter: [{\n    eventName: 'test-event',\n    condition: iotevents.Expression.currentInput(input),\n    actions: [\n      actions: [\n        new actions.SetVariableAction(\n          'MyVariable',\n          iotevents.Expression.inputAttribute(input, 'payload.temperature'),\n        ),\n      ],\n    ],\n  }],\n});",
+        "example": "import * as iotevents from '@aws-cdk/aws-iotevents-alpha';\nimport * as actions from '@aws-cdk/aws-iotevents-actions-alpha';\n\ndeclare const input: iotevents.IInput;\n\nconst state = new iotevents.State({\n  stateName: 'MyState',\n  onEnter: [{\n    eventName: 'test-event',\n    condition: iotevents.Expression.currentInput(input),\n    actions: [\n      new actions.SetVariableAction(\n        'MyVariable',\n        iotevents.Expression.inputAttribute(input, 'payload.temperature'),\n      ),\n    ],\n  }],\n});",
         "stability": "experimental",
         "summary": "The action to create a variable with a specified value."
       },
@@ -3236,43 +3338,89 @@
         "filename": "lib/set-variable-action.ts",
         "line": 7
       },
+      "name": "SetVariableAction",
+      "symbolId": "lib/set-variable-action:SetVariableAction"
+    },
+    "@aws-cdk/aws-iotevents-actions-alpha.TimerDuration": {
+      "abstract": true,
+      "assembly": "@aws-cdk/aws-iotevents-actions-alpha",
+      "docs": {
+        "custom": {
+          "exampleMetadata": "infused"
+        },
+        "example": "import * as iotevents from '@aws-cdk/aws-iotevents-alpha';\nimport * as actions from '@aws-cdk/aws-iotevents-actions-alpha';\n\ndeclare const input: iotevents.IInput;\n\nconst state = new iotevents.State({\n  stateName: 'MyState',\n  onEnter: [{\n    eventName: 'test-event',\n    condition: iotevents.Expression.currentInput(input),\n    actions: [\n      new actions.SetTimerAction('MyTimer', {\n        duration: cdk.Duration.seconds(60),\n      }),\n    ],\n  }],\n});",
+        "stability": "experimental",
+        "summary": "The duration of the timer."
+      },
+      "fqn": "@aws-cdk/aws-iotevents-actions-alpha.TimerDuration",
+      "initializer": {
+        "docs": {
+          "stability": "experimental"
+        }
+      },
+      "kind": "class",
+      "locationInModule": {
+        "filename": "lib/timer-duration.ts",
+        "line": 7
+      },
       "methods": [
         {
           "docs": {
+            "remarks": "The range of the duration is 60-31622400 seconds.\nThe evaluated result of the duration expression is rounded down to the nearest whole number.\nFor example, if you set the timer to 60.99 seconds, the evaluated result of the duration expression is 60 seconds.",
             "stability": "experimental",
-            "summary": "Returns the AWS IoT Events action specification."
+            "summary": "Create a timer-duration from Duration."
           },
           "locationInModule": {
-            "filename": "lib/set-variable-action.ts",
+            "filename": "lib/timer-duration.ts",
             "line": 15
           },
-          "name": "bind",
-          "overrides": "@aws-cdk/aws-iotevents-alpha.IAction",
+          "name": "fromDuration",
           "parameters": [
             {
-              "name": "_scope",
+              "name": "duration",
               "type": {
-                "fqn": "constructs.Construct"
+                "fqn": "aws-cdk-lib.Duration"
               }
-            },
+            }
+          ],
+          "returns": {
+            "type": {
+              "fqn": "@aws-cdk/aws-iotevents-actions-alpha.TimerDuration"
+            }
+          },
+          "static": true
+        },
+        {
+          "docs": {
+            "remarks": "You can use a string expression that includes numbers, variables ($variable.<variable-name>),\nand input values ($input.<input-name>.<path-to-datum>) as the duration.\n\nThe range of the duration is 60-31622400 seconds.\nThe evaluated result of the duration expression is rounded down to the nearest whole number.\nFor example, if you set the timer to 60.99 seconds, the evaluated result of the duration expression is 60 seconds.",
+            "stability": "experimental",
+            "summary": "Create a timer-duration from Expression."
+          },
+          "locationInModule": {
+            "filename": "lib/timer-duration.ts",
+            "line": 36
+          },
+          "name": "fromExpression",
+          "parameters": [
             {
-              "name": "_options",
+              "name": "expression",
               "type": {
-                "fqn": "@aws-cdk/aws-iotevents-alpha.ActionBindOptions"
+                "fqn": "@aws-cdk/aws-iotevents-alpha.Expression"
               }
             }
           ],
           "returns": {
             "type": {
-              "fqn": "@aws-cdk/aws-iotevents-alpha.ActionConfig"
+              "fqn": "@aws-cdk/aws-iotevents-actions-alpha.TimerDuration"
             }
-          }
+          },
+          "static": true
         }
       ],
-      "name": "SetVariableAction",
-      "symbolId": "lib/set-variable-action:SetVariableAction"
+      "name": "TimerDuration",
+      "symbolId": "lib/timer-duration:TimerDuration"
     }
   },
-  "version": "2.34.2-alpha.0",
+  "version": "2.37.0-alpha.0",
   "fingerprint": "**********"
-}
+}