Add test case and documentation

aws · Dec 19, 2023 · 87fd91a · 87fd91a
1 parent 0d0d6a9
commit 87fd91a
Show file tree

Hide file tree

Showing 2 changed files with 41 additions and 0 deletions.
diff --git a/packages/aws-cdk-lib/aws-stepfunctions/README.md b/packages/aws-cdk-lib/aws-stepfunctions/README.md
@@ -598,6 +598,10 @@ const custom = new sfn.CustomState(this, 'my custom task', {
   stateJson,
 });
 
+// catch errors with addCatch
+const errorHandler = new sfn.Pass(this, 'handle failure');
+custom.addCatch(errorHandler);
+
 const chain = sfn.Chain.start(custom)
   .next(finalStatus);
 

diff --git a/packages/aws-cdk-lib/aws-stepfunctions/test/custom-state.test.ts b/packages/aws-cdk-lib/aws-stepfunctions/test/custom-state.test.ts
@@ -72,4 +72,41 @@ describe('Custom State', () => {
       },
     );
   });
+
+  test('can add a catch state to thechain'), () => {
+    // WHEN
+    const fail = new sfn.Fail(stack, 'MyFail', { error: 'DidNotWork', cause: 'HumanError' })
+    const definition = new sfn.CustomState(stack, 'Custom', {
+        stateJson,
+      }).addCatch(fail);
+
+    // THEN
+    expect(render(stack, definition)).toStrictEqual(
+    {
+        StartAt: 'Custom',
+        States: {
+        'Custom': {
+            Type: 'Task',
+            Resource: 'arn:aws:states:::dynamodb:putItem',
+            Parameters: {
+                TableName: 'MyTable',
+                Item: {
+                    id: {
+                        S: 'MyEntry',
+                    },
+                },
+            },
+            ResultPath: null,
+            Catch: {
+
+            }
+        },
+        'my-pass-state': {
+            Type: 'Pass',
+            End: true,
+        },
+        },
+    },
+    );
+  };
 });