aws-cdk-lib 2.75.1__py3-none-any.whl → 2.76.0__py3-none-any.whl

aws_cdk/triggers/__init__.py

@@ -15,15 +15,10 @@ The `TriggerFunction` construct will define an AWS Lambda function which is
 triggered *during* deployment:
 
 ```python
-# Example automatically generated from non-compiling source. May contain errors.
-import aws_cdk.aws_lambda as lambda_
 import aws_cdk.triggers as triggers
-from aws_cdk import Stack
 
-# stack: Stack
 
-
-triggers.TriggerFunction(stack, "MyTrigger",
+triggers.TriggerFunction(self, "MyTrigger",
     runtime=lambda_.Runtime.NODEJS_14_X,
     handler="index.handler",
     code=lambda_.Code.from_asset(__dirname + "/my-trigger")
@@ -36,21 +31,16 @@ be invoked when the stack is deployed.
 It is also possible to trigger a predefined Lambda function by using the `Trigger` construct:
 
 ```python
-# Example automatically generated from non-compiling source. May contain errors.
-import aws_cdk.aws_lambda as lambda_
 import aws_cdk.triggers as triggers
-from aws_cdk.core import Stack
-
-# stack: Stack
 
 
-func = lambda_.Function(stack, "MyFunction",
+func = lambda_.Function(self, "MyFunction",
     handler="index.handler",
     runtime=lambda_.Runtime.NODEJS_14_X,
     code=lambda_.Code.from_inline("foo")
 )
 
-triggers.Trigger(stack, "MyTrigger",
+triggers.Trigger(self, "MyTrigger",
     handler=func,
     timeout=Duration.minutes(10),
     invocation_type=triggers.InvocationType.EVENT
@@ -85,8 +75,6 @@ parallel, and then the trigger `myTrigger` will be executed. Only then the
 resources under `goodbye` will be provisioned:
 
 ```python
-# Example automatically generated from non-compiling source. May contain errors.
-from constructs import Construct, Node
 import aws_cdk.triggers as triggers
 
 # my_trigger: triggers.Trigger
@@ -238,6 +226,25 @@ class InvocationType(enum.Enum):
     '''The invocation type to apply to a trigger.
 
     This determines whether the trigger function should await the result of the to be triggered function or not.
+
+    :exampleMetadata: infused
+
+    Example::
+
+        import aws_cdk.triggers as triggers
+        
+        
+        func = lambda_.Function(self, "MyFunction",
+            handler="index.handler",
+            runtime=lambda_.Runtime.NODEJS_14_X,
+            code=lambda_.Code.from_inline("foo")
+        )
+        
+        triggers.Trigger(self, "MyTrigger",
+            handler=func,
+            timeout=Duration.minutes(10),
+            invocation_type=triggers.InvocationType.EVENT
+        )
     '''
 
     EVENT = "EVENT"
@@ -264,29 +271,23 @@ class Trigger(
 ):
     '''Triggers an AWS Lambda function during deployment.
 
-    :exampleMetadata: fixture=_generated
+    :exampleMetadata: infused
 
     Example::
 
-        # The code below shows an example of how to instantiate this type.
-        # The values are placeholders you should change.
-        import aws_cdk as cdk
-        from aws_cdk import aws_lambda as lambda_
-        from aws_cdk import triggers
-        import constructs as constructs
+        import aws_cdk.triggers as triggers
         
-        # construct: constructs.Construct
-        # function_: lambda.Function
         
-        trigger = triggers.Trigger(self, "MyTrigger",
-            handler=function_,
+        func = lambda_.Function(self, "MyFunction",
+            handler="index.handler",
+            runtime=lambda_.Runtime.NODEJS_14_X,
+            code=lambda_.Code.from_inline("foo")
+        )
         
-            # the properties below are optional
-            execute_after=[construct],
-            execute_before=[construct],
-            execute_on_handler_change=False,
-            invocation_type=triggers.InvocationType.EVENT,
-            timeout=cdk.Duration.minutes(30)
+        triggers.Trigger(self, "MyTrigger",
+            handler=func,
+            timeout=Duration.minutes(10),
+            invocation_type=triggers.InvocationType.EVENT
         )
     '''
 
@@ -368,15 +369,10 @@ class TriggerFunction(
 
     Example::
 
-        # Example automatically generated from non-compiling source. May contain errors.
-        import aws_cdk.aws_lambda as lambda_
         import aws_cdk.triggers as triggers
-        from aws_cdk import Stack
-        
-        # stack: Stack
         
         
-        triggers.TriggerFunction(stack, "MyTrigger",
+        triggers.TriggerFunction(self, "MyTrigger",
             runtime=lambda_.Runtime.NODEJS_14_X,
             handler="index.handler",
             code=lambda_.Code.from_asset(__dirname + "/my-trigger")
@@ -717,29 +713,23 @@ class TriggerProps(TriggerOptions):
         :param invocation_type: The invocation type to invoke the Lambda function with. Default: RequestResponse
         :param timeout: The timeout of the invocation call of the Lambda function to be triggered. Default: Duration.minutes(2)
 
-        :exampleMetadata: fixture=_generated
+        :exampleMetadata: infused
 
         Example::
 
-            # The code below shows an example of how to instantiate this type.
-            # The values are placeholders you should change.
-            import aws_cdk as cdk
-            from aws_cdk import aws_lambda as lambda_
-            from aws_cdk import triggers
-            import constructs as constructs
+            import aws_cdk.triggers as triggers
             
-            # construct: constructs.Construct
-            # function_: lambda.Function
             
-            trigger_props = triggers.TriggerProps(
-                handler=function_,
+            func = lambda_.Function(self, "MyFunction",
+                handler="index.handler",
+                runtime=lambda_.Runtime.NODEJS_14_X,
+                code=lambda_.Code.from_inline("foo")
+            )
             
-                # the properties below are optional
-                execute_after=[construct],
-                execute_before=[construct],
-                execute_on_handler_change=False,
-                invocation_type=triggers.InvocationType.EVENT,
-                timeout=cdk.Duration.minutes(30)
+            triggers.Trigger(self, "MyTrigger",
+                handler=func,
+                timeout=Duration.minutes(10),
+                invocation_type=triggers.InvocationType.EVENT
             )
         '''
         if __debug__:
@@ -990,15 +980,10 @@ class TriggerFunctionProps(_FunctionProps_a308e854, TriggerOptions):
 
         Example::
 
-            # Example automatically generated from non-compiling source. May contain errors.
-            import aws_cdk.aws_lambda as lambda_
             import aws_cdk.triggers as triggers
-            from aws_cdk import Stack
-            
-            # stack: Stack
             
             
-            triggers.TriggerFunction(stack, "MyTrigger",
+            triggers.TriggerFunction(self, "MyTrigger",
                 runtime=lambda_.Runtime.NODEJS_14_X,
                 handler="index.handler",
                 code=lambda_.Code.from_asset(__dirname + "/my-trigger")