@cdklabs/cdk-ssm-documents 0.0.17 → 0.0.20

package/.jsii

@@ -2798,7 +2798,7 @@
   },
   "name": "@cdklabs/cdk-ssm-documents",
   "readme": {
-    "markdown": "# SSM Document CDK\nThis library provides a code-based utility for implementing SSM Documents. The SSM Document objects can be used to print YAML/JSON documents and to mimic document processing locally.\n\nThis library abstracts SSM Documents at a high level, with each step as well as the document itself being objects. The properties needed to build these objects correlate to the settings that apply to them, making them simple to make.\nThis library can be used to test your document locally before deploying it to SSM.\n\nSince the library is written in JSII, it can be exported to other languages that support JSII (Java, Python).\n\nThis is what you'd use if you wanted to:\n1. The ability to test without deploying resources or executing an actual SSM on AWS.\n2. Reusability of steps between documents by reusing existing items\n3. Create logical higher-level groupings of reusable groups of steps (\"Patterns\")\n4. Simple to use interface for writing documents\n5. Import existing documents from a file (or string) and mimic them locally to test them.\n\n## Usage\n\n### Document Creation\n\nTypescript usage (Execute AWS API Step)...\nThe below creates the AutomationDocument in an AWS CDK stack.\n```ts\nimport { AutomationDocument } from './automation-document';\n\nexport class HelloWorld extends Stack {\n  constructor(app: Construct, id: string) {\n    super(app, id);\n\n    // Create AutomationDocument\n    const myDoc = new AutomationDocument(this, \"MyDoc\", {\n      documentFormat: DocumentFormat.JSON,\n      documentName: \"MyDoc\",\n      docInputs: [Input.ofTypeString('MyInput', { defaultValue: 'a' })],\n    });\n\n    // Define your steps...\n    myDoc.addStep(new PauseStep(this, \"MyPauseStep\", { name: \"MyPauseStep\" }));\n\n    myDoc.addStep(new ExecuteScriptStep(this, \"MyExecuteStep\", {\n      name: \"step1\",\n      handlerName: \"my_func\",\n      language: ScriptLanguage.PYTHON,\n      fullPathToCode: resolve(\"test/test_file.py\"),\n      // OR .inlineCode(\"def my_func(args, context):\\n  return {'MyReturn': args['MyInput'] + '-suffix'}\\n\")\n      outputs: [{\n        outputType: DataTypeEnum.STRING,\n        name: \"MyFuncOut\",\n        selector: \"$.Payload.MyReturn\"\n      }],\n      inputs: [\"MyInput\"]\n    }));\n  }\n}\n```\n\n### Document JSON/YAML Export as YAML/JSON\n\nYou can deploy the above document using CDK.\nTo print the above document object as a JSON (or YAML), do the following:\n\n```ts\nconst myDocJson = myDoc.print(); // Print YAML by setting the documentFormat to YAML\n```\n\n\n### Document Simulation\n\nTo run the document object in simulation mode, use the below. Simulation mode does NOT hit the SSM API, rather it mimics the execution that will happen in an SSM execution. The run happens locally and allows you to mock the calls to external services (AWS APIs for example) or to invoke those services using your local credentials.\n\n```ts\nimport { Simulation } from './simulation';\n\nconst myDocJson = Simulation.ofAutomation(myDoc, {}).simulate({ MyInput: \"FooBar\" });\n```\n\n### Command Documents\n\nBelow is an example of how to use the library to create Command documents.\nSimulation for command documents is not yet supported for all command plugins.\nYou can use a Docker image/container as a playground for testing the Command document execution for the supported plugins.\n\nIn this example there is a complete CDK stack. Notice that the `CommandDocument` is saved as a field so that it can be tested from the test code.\n```typescript\nexport class HelloCdkStack extends Stack {\n  readonly myCommandDoc: CommandDocument;\n  constructor(scope: Construct, id: string, props?: StackProps) {\n    super(scope, id, props);\n    this.myCommandDoc = new CommandDocument(this, \"MyCommandDoc\", {\n      docInputs: [Input.ofTypeString('FirstCommand', { defaultValue: 'a' })],\n    })\n    const runScriptStep = new RunShellScriptStep(this, \"MyShellScript\", {\n      runCommand: [\n        StringVariable.of(\"FirstCommand\"),\n        HardCodedString.of(\"mkdir asdf\"),\n      ],\n    });\n    this.myCommandDoc.addStep(runScriptStep);\n  }\n}\n```\n\nBelow is an example of how you would run a simulation against the above `CommandDocument`.\n\nCurrently, `bash` must be available in the container or the executions against the docker will not succeed.\n\n```typescript\ntest('Test command doc', () => {\n  const app = new cdk.App();\n  const stack = new HelloCdk.HelloCdkStack(app, 'MyTestStack');\n  // 1. $ docker pull amazonlinux\n  // 2. $ docker run -di amazonlinux\n  const simulation = Simulation.ofCommand(stack.myCommandDoc, {\n    simulationPlatform: Platform.LINUX,\n    environment: DockerEnvironment.fromContainer('MY_CONTAINER_ID')\n  });\n  simulation.simulate({FirstCommand: 'mkdir foobar'})\n  // 3. The document should run the first command (create 'foobar') and create file 'asdf'\n  // 4. $ docker exec -it <container name> bash\n  // 5. Ensure that 'asdf' and 'foobar' were written to /tmp\n});\n```\n\n## Patterns (High-Level Constructs)\n\nIn typical CDK style, you can assemble often used groups of steps into higher level Constructs.\n\nConsider if you typically create AutomationDocuments that start with logging the time and end with logging the total time taken. You can create a high-level Automation Document and extend that when you implement an Automation.\n\nSee the `TimedDocument` class to see such implementation.\n\nOr consider the case of multiple steps that are always run together such as rebooting and instance and waiting for it to be active.\n\nThe below example is copied from the `RebootInstanceAndWait` class:\n\n```ts\nexport class RebootInstanceAndWait extends CompositeAutomationStep {\n\n  readonly reboot: AwsApiStep;\n  readonly describe: WaitForResourceStep;\n\n  constructor(scope: Construct, id: string, instanceId: IStringVariable) {\n    super(scope, id);\n    this.reboot = new AwsApiStep(this, 'RebootInstances', {\n      service: 'ec2',\n      pascalCaseApi: 'RebootInstances',\n      apiParams: { InstanceIds: [instanceId] },\n      outputs: [],\n    });\n    this.describe = new WaitForResourceStep(this, 'DescribeInstances', {\n      service: 'ec2',\n      pascalCaseApi: 'DescribeInstances',\n      apiParams: { InstanceIds: [instanceId] },\n      selector: '$.Reservations[0].Instances[0].State.Name',\n      desiredValues: ['running'],\n    });\n  }\n\n  addToDocument(doc: AutomationDocumentBuilder): void {\n    doc.addStep(this.reboot);\n    doc.addStep(this.describe);\n  }\n}\n\n```\n\nNow, you can use `RebootInstanceAndWait` as a step in a document and the child steps will be included.\n\n## Existing Documents\n\nDo you have an existing document that you want to convert to code and/or test locally using the simulation?\n\n### Import Existing Document\n\nHere is an example of how you can import an existing document and then simulate it locally with mocked AWS resources:\n\n```ts\n// Initialize Mocks\nconst sleeper = new MockSleep();\nconst awsInvoker = new MockAwsInvoker();\nawsInvoker.whenThen(\n    // when invoked with...\n    {awsApi: 'listBuckets', awsParams: {}, service: 'S3'},\n    // then response with...\n    {Owner: {ID: \"BUCKET_ID\"}})\n\n// ======> Create document from file <=======\nconst stack: Stack = new Stack();\nconst myAutomationDoc = StringDocument.fromFile(stack, \"MyAutomationDoc\", 'test/myAutomation.json', {\n                                                                        // ======================\n});\n\n// Execute simulation\nconst simOutput = Simulation.ofAutomation(myAutomationDoc, {\n  sleepHook: sleeper,\n  awsInvoker: awsInvoker\n}).simulate({});\n\n// Assert simulation result\nassert.deepEqual(awsInvoker.previousInvocations, [\n    { awsApi: 'listBuckets', awsParams: {}, service: 'S3' }]);\nassert.deepEqual(sleeper.sleepMilliInvocations, [3000]);\nassert.deepEqual(simOutput.outputs['simulationSteps'], ['MySleep', 'GetBucketId']);\n```\n\n### Import Existing Steps\n\nYou can also grab a string step (or steps) and import them as CDK step constructs.\nThis can be used to convert existing documents into CDK with each step defined separately.\nDoing so will allow you do modify steps and reuse them in other documents.\n\nHere's a simple example of a sleep step copy and pasted from its original yaml:\n\n```ts\nStringStep.fromYaml(this, `\n    name: sleep\n    action: aws:sleep\n    inputs:\n      Duration: PT0M\n`, {});\n```\n\nThe above will return the CDK construct SleepStep.\n\n## What is Planned?\n\nThis library currently contains AutomationDocument steps.\n\nAlso planned is the ability to run Command documents.\n\nStay tuned!\n\n## Related Projects\n\n- https://github.com/udondan/cdk-ssm-document\n\n## Security\nSee [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more information.\n\n## License\nThis project is licensed under the Apache-2.0 License.\n\n"
+    "markdown": "# SSM Document CDK\nThis library provides a code-based utility for implementing SSM Documents. The SSM Document objects can be used to print YAML/JSON documents and to mimic document processing locally.\n\nThis library abstracts SSM Documents at a high level, with each step as well as the document itself being objects. The properties needed to build these objects correlate to the settings that apply to them, making them simple to make.\nThis library can be used to test your document locally before deploying it to SSM.\n\nSince the library is written in JSII, it can be exported to other languages that support JSII (Java, Python).\n\nThis is what you'd use if you wanted to:\n1. The ability to test without deploying resources or executing an actual SSM on AWS.\n2. Reusability of steps between documents by reusing existing items\n3. Create logical higher-level groupings of reusable groups of steps (\"Patterns\")\n4. Simple to use interface for writing documents\n5. Import existing documents from a file (or string) and mimic them locally to test them.\n\n## Usage\n\n### Document Creation\n\nTypescript usage (Execute AWS API Step)...\nThe below creates the AutomationDocument in an AWS CDK stack.\n```ts\nimport { AutomationDocument } from './automation-document';\n\nexport class HelloWorld extends Stack {\n  constructor(app: Construct, id: string) {\n    super(app, id);\n\n    // Create AutomationDocument\n    const myDoc = new AutomationDocument(this, \"MyDoc\", {\n      documentFormat: DocumentFormat.JSON,\n      documentName: \"MyDoc\",\n      docInputs: [Input.ofTypeString('MyInput', { defaultValue: 'a' })],\n    });\n\n    // Define your steps...\n    myDoc.addStep(new PauseStep(this, \"MyPauseStep\", { name: \"MyPauseStep\" }));\n\n    myDoc.addStep(new ExecuteScriptStep(this, \"MyExecuteStep\", {\n      name: \"step1\",\n      handlerName: \"my_func\",\n      language: ScriptLanguage.PYTHON,\n      fullPathToCode: resolve(\"test/test_file.py\"),\n      // OR .inlineCode(\"def my_func(args, context):\\n  return {'MyReturn': args['MyInput'] + '-suffix'}\\n\")\n      outputs: [{\n        outputType: DataTypeEnum.STRING,\n        name: \"MyFuncOut\",\n        selector: \"$.Payload.MyReturn\"\n      }],\n      onFailure: OnFailure.abort(),\n      inputs: [\"MyInput\"]\n    }));\n  }\n}\n```\n\n### Document JSON/YAML Export as YAML/JSON\n\nYou can deploy the above document using CDK.\nTo print the above document object as a JSON (or YAML), do the following:\n\n```ts\nconst myDocJson = myDoc.print(); // Print YAML by setting the documentFormat to YAML\n```\n\n\n### Document Simulation\n\nTo run the document object in simulation mode, use the below. Simulation mode does NOT hit the SSM API, rather it mimics the execution that will happen in an SSM execution. The run happens locally and allows you to mock the calls to external services (AWS APIs for example) or to invoke those services using your local credentials.\n\n```ts\nimport { Simulation } from './simulation';\n\nconst myDocJson = Simulation.ofAutomation(myDoc, {}).simulate({ MyInput: \"FooBar\" });\n```\n\n### Command Documents\n\nBelow is an example of how to use the library to create Command documents.\nSimulation for command documents is not yet supported for all command plugins.\nYou can use a Docker image/container as a playground for testing the Command document execution for the supported plugins.\n\nIn this example there is a complete CDK stack. Notice that the `CommandDocument` is saved as a field so that it can be tested from the test code.\n```typescript\nexport class HelloCdkStack extends Stack {\n  readonly myCommandDoc: CommandDocument;\n  constructor(scope: Construct, id: string, props?: StackProps) {\n    super(scope, id, props);\n    this.myCommandDoc = new CommandDocument(this, \"MyCommandDoc\", {\n      docInputs: [Input.ofTypeString('FirstCommand', { defaultValue: 'a' })],\n    })\n    const runScriptStep = new RunShellScriptStep(this, \"MyShellScript\", {\n      runCommand: [\n        StringVariable.of(\"FirstCommand\"),\n        HardCodedString.of(\"mkdir asdf\"),\n      ],\n    });\n    this.myCommandDoc.addStep(runScriptStep);\n  }\n}\n```\n\nBelow is an example of how you would run a simulation against the above `CommandDocument`.\n\nCurrently, `bash` must be available in the container or the executions against the docker will not succeed.\n\n```typescript\ntest('Test command doc', () => {\n  const app = new cdk.App();\n  const stack = new HelloCdk.HelloCdkStack(app, 'MyTestStack');\n  // 1. $ docker pull amazonlinux\n  // 2. $ docker run -di amazonlinux\n  const simulation = Simulation.ofCommand(stack.myCommandDoc, {\n    simulationPlatform: Platform.LINUX,\n    environment: DockerEnvironment.fromContainer('MY_CONTAINER_ID')\n  });\n  simulation.simulate({FirstCommand: 'mkdir foobar'})\n  // 3. The document should run the first command (create 'foobar') and create file 'asdf'\n  // 4. $ docker exec -it <container name> bash\n  // 5. Ensure that 'asdf' and 'foobar' were written to /tmp\n});\n```\n\n## Patterns (High-Level Constructs)\n\nIn typical CDK style, you can assemble often used groups of steps into higher level Constructs.\n\nConsider if you typically create AutomationDocuments that start with logging the time and end with logging the total time taken. You can create a high-level Automation Document and extend that when you implement an Automation.\n\nSee the `TimedDocument` class to see such implementation.\n\nOr consider the case of multiple steps that are always run together such as rebooting and instance and waiting for it to be active.\n\nThe below example is copied from the `RebootInstanceAndWait` class:\n\n```ts\nexport class RebootInstanceAndWait extends CompositeAutomationStep {\n\n  readonly reboot: AwsApiStep;\n  readonly describe: WaitForResourceStep;\n\n  constructor(scope: Construct, id: string, instanceId: IStringVariable) {\n    super(scope, id);\n    this.reboot = new AwsApiStep(this, 'RebootInstances', {\n      service: 'ec2',\n      pascalCaseApi: 'RebootInstances',\n      apiParams: { InstanceIds: [instanceId] },\n      outputs: [],\n    });\n    this.describe = new WaitForResourceStep(this, 'DescribeInstances', {\n      service: 'ec2',\n      pascalCaseApi: 'DescribeInstances',\n      apiParams: { InstanceIds: [instanceId] },\n      selector: '$.Reservations[0].Instances[0].State.Name',\n      desiredValues: ['running'],\n    });\n  }\n\n  addToDocument(doc: AutomationDocumentBuilder): void {\n    doc.addStep(this.reboot);\n    doc.addStep(this.describe);\n  }\n}\n\n```\n\nNow, you can use `RebootInstanceAndWait` as a step in a document and the child steps will be included.\n\n## Existing Documents\n\nDo you have an existing document that you want to convert to code and/or test locally using the simulation?\n\n### Import Existing Document\n\nHere is an example of how you can import an existing document and then simulate it locally with mocked AWS resources:\n\n```ts\n// Initialize Mocks\nconst sleeper = new MockSleep();\nconst awsInvoker = new MockAwsInvoker();\nawsInvoker.whenThen(\n    // when invoked with...\n    {awsApi: 'listBuckets', awsParams: {}, service: 'S3'},\n    // then response with...\n    {Owner: {ID: \"BUCKET_ID\"}})\n\n// ======> Create document from file <=======\nconst stack: Stack = new Stack();\nconst myAutomationDoc = StringDocument.fromFile(stack, \"MyAutomationDoc\", 'test/myAutomation.json', {\n                                                                        // ======================\n});\n\n// Execute simulation\nconst simOutput = Simulation.ofAutomation(myAutomationDoc, {\n  sleepHook: sleeper,\n  awsInvoker: awsInvoker\n}).simulate({});\n\n// Assert simulation result\nassert.deepEqual(awsInvoker.previousInvocations, [\n    { awsApi: 'listBuckets', awsParams: {}, service: 'S3' }]);\nassert.deepEqual(sleeper.sleepMilliInvocations, [3000]);\nassert.deepEqual(simOutput.outputs['simulationSteps'], ['MySleep', 'GetBucketId']);\n```\n\n### Import Existing Steps\n\nYou can also grab a string step (or steps) and import them as CDK step constructs.\nThis can be used to convert existing documents into CDK with each step defined separately.\nDoing so will allow you do modify steps and reuse them in other documents.\n\nHere's a simple example of a sleep step copy and pasted from its original yaml:\n\n```ts\nStringStep.fromYaml(this, `\n    name: sleep\n    action: aws:sleep\n    inputs:\n      Duration: PT0M\n`, {});\n```\n\nThe above will return the CDK construct SleepStep.\n\n## What is Planned?\n\nThis library currently contains AutomationDocument steps.\n\nAlso planned is the ability to run Command documents.\n\nStay tuned!\n\n## Related Projects\n\n- https://github.com/udondan/cdk-ssm-document\n\n## Security\nSee [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more information.\n\n## License\nThis project is licensed under the Apache-2.0 License.\n\n"
   },
   "repository": {
     "type": "git",
@@ -2826,6 +2826,68 @@
     }
   },
   "types": {
+    "@cdklabs/cdk-ssm-documents.Abort": {
+      "assembly": "@cdklabs/cdk-ssm-documents",
+      "base": "@cdklabs/cdk-ssm-documents.OnCancel",
+      "docs": {
+        "stability": "stable"
+      },
+      "fqn": "@cdklabs/cdk-ssm-documents.Abort",
+      "initializer": {
+        "docs": {
+          "stability": "stable"
+        }
+      },
+      "kind": "class",
+      "locationInModule": {
+        "filename": "src/interface/on-failure.ts",
+        "line": 122
+      },
+      "methods": [
+        {
+          "docs": {
+            "stability": "stable"
+          },
+          "locationInModule": {
+            "filename": "src/interface/on-failure.ts",
+            "line": 124
+          },
+          "name": "stepToInvoke",
+          "overrides": "@cdklabs/cdk-ssm-documents.OnFailure",
+          "parameters": [
+            {
+              "name": "_currentStep",
+              "type": {
+                "fqn": "@cdklabs/cdk-ssm-documents.AutomationStep"
+              }
+            }
+          ],
+          "returns": {
+            "type": {
+              "primitive": "string"
+            }
+          }
+        },
+        {
+          "docs": {
+            "stability": "stable"
+          },
+          "locationInModule": {
+            "filename": "src/interface/on-failure.ts",
+            "line": 128
+          },
+          "name": "toSsmValue",
+          "overrides": "@cdklabs/cdk-ssm-documents.OnFailure",
+          "returns": {
+            "type": {
+              "primitive": "string"
+            }
+          }
+        }
+      ],
+      "name": "Abort",
+      "symbolId": "src/interface/on-failure:Abort"
+    },
     "@cdklabs/cdk-ssm-documents.ActionVariable": {
       "assembly": "@cdklabs/cdk-ssm-documents",
       "base": "@cdklabs/cdk-ssm-documents.StringVariable",
@@ -5105,7 +5167,7 @@
         },
         "locationInModule": {
           "filename": "src/parent-steps/automation-step.ts",
-          "line": 65
+          "line": 66
         },
         "parameters": [
           {
@@ -5134,7 +5196,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/parent-steps/automation-step.ts",
-        "line": 53
+        "line": 54
       },
       "methods": [
         {
@@ -5143,7 +5205,7 @@
           },
           "locationInModule": {
             "filename": "src/parent-steps/automation-step.ts",
-            "line": 74
+            "line": 75
           },
           "name": "addToDocument",
           "overrides": "@cdklabs/cdk-ssm-documents.IAutomationComponent",
@@ -5162,7 +5224,7 @@
           },
           "locationInModule": {
             "filename": "src/parent-steps/automation-step.ts",
-            "line": 78
+            "line": 79
           },
           "name": "prepareSsmEntry",
           "parameters": [
@@ -5196,7 +5258,7 @@
           },
           "locationInModule": {
             "filename": "src/parent-steps/automation-step.ts",
-            "line": 125
+            "line": 126
           },
           "name": "variables",
           "returns": {
@@ -5221,7 +5283,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/parent-steps/automation-step.ts",
-            "line": 55
+            "line": 56
           },
           "name": "DEFAULT_MAX_ATTEMPTS",
           "static": true,
@@ -5237,7 +5299,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/parent-steps/automation-step.ts",
-            "line": 54
+            "line": 55
           },
           "name": "DEFAULT_TIMEOUT",
           "static": true,
@@ -5252,7 +5314,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/parent-steps/automation-step.ts",
-            "line": 58
+            "line": 59
           },
           "name": "isEnd",
           "type": {
@@ -5266,7 +5328,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/parent-steps/automation-step.ts",
-            "line": 56
+            "line": 57
           },
           "name": "maxAttempts",
           "type": {
@@ -5280,11 +5342,11 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/parent-steps/automation-step.ts",
-            "line": 57
+            "line": 61
           },
-          "name": "timeoutSeconds",
+          "name": "onCancel",
           "type": {
-            "primitive": "number"
+            "fqn": "@cdklabs/cdk-ssm-documents.OnCancel"
           }
         },
         {
@@ -5296,10 +5358,9 @@
             "filename": "src/parent-steps/automation-step.ts",
             "line": 60
           },
-          "name": "onCancel",
-          "optional": true,
+          "name": "onFailure",
           "type": {
-            "fqn": "@cdklabs/cdk-ssm-documents.AutomationStep"
+            "fqn": "@cdklabs/cdk-ssm-documents.OnFailure"
           }
         },
         {
@@ -5309,12 +5370,11 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/parent-steps/automation-step.ts",
-            "line": 59
+            "line": 58
           },
-          "name": "onFailure",
-          "optional": true,
+          "name": "timeoutSeconds",
           "type": {
-            "fqn": "@cdklabs/cdk-ssm-documents.AutomationStep"
+            "primitive": "number"
           }
         },
         {
@@ -5323,7 +5383,7 @@
           },
           "locationInModule": {
             "filename": "src/parent-steps/automation-step.ts",
-            "line": 63
+            "line": 64
           },
           "name": "allStepsInExecution",
           "optional": true,
@@ -5342,7 +5402,7 @@
           },
           "locationInModule": {
             "filename": "src/parent-steps/automation-step.ts",
-            "line": 62
+            "line": 63
           },
           "name": "nextStep",
           "optional": true,
@@ -5366,7 +5426,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/parent-steps/automation-step.ts",
-        "line": 9
+        "line": 10
       },
       "name": "AutomationStepProps",
       "properties": [
@@ -5380,7 +5440,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/parent-steps/automation-step.ts",
-            "line": 15
+            "line": 16
           },
           "name": "isEnd",
           "optional": true,
@@ -5398,7 +5458,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/parent-steps/automation-step.ts",
-            "line": 34
+            "line": 35
           },
           "name": "maxAttempts",
           "optional": true,
@@ -5411,17 +5471,17 @@
           "docs": {
             "default": "undefined",
             "stability": "stable",
-            "summary": "(Optional) Step to jump to in the event that this step is cancelled."
+            "summary": "(Optional) Fallback action to take in the event that this step is cancelled."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/parent-steps/automation-step.ts",
-            "line": 27
+            "line": 28
           },
           "name": "onCancel",
           "optional": true,
           "type": {
-            "fqn": "@cdklabs/cdk-ssm-documents.AutomationStep"
+            "fqn": "@cdklabs/cdk-ssm-documents.OnCancel"
           }
         },
         {
@@ -5429,17 +5489,17 @@
           "docs": {
             "default": "undefined",
             "stability": "stable",
-            "summary": "(Optional) Step to jump to in the event that this step fails."
+            "summary": "(Optional) Fallback action to take in the event that this step fails."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/parent-steps/automation-step.ts",
-            "line": 21
+            "line": 22
           },
           "name": "onFailure",
           "optional": true,
           "type": {
-            "fqn": "@cdklabs/cdk-ssm-documents.AutomationStep"
+            "fqn": "@cdklabs/cdk-ssm-documents.OnFailure"
           }
         },
         {
@@ -5453,7 +5513,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/parent-steps/automation-step.ts",
-            "line": 41
+            "line": 42
           },
           "name": "timeoutSeconds",
           "optional": true,
@@ -5540,7 +5600,7 @@
           },
           "locationInModule": {
             "filename": "src/simulation/automation-step-simulation.ts",
-            "line": 196
+            "line": 206
           },
           "name": "prependSelf",
           "parameters": [
@@ -8922,6 +8982,68 @@
       ],
       "symbolId": "src/parent-steps/command/configure-package-step:ConfigurePackageStepProps"
     },
+    "@cdklabs/cdk-ssm-documents.Continue": {
+      "assembly": "@cdklabs/cdk-ssm-documents",
+      "base": "@cdklabs/cdk-ssm-documents.OnFailure",
+      "docs": {
+        "stability": "stable"
+      },
+      "fqn": "@cdklabs/cdk-ssm-documents.Continue",
+      "initializer": {
+        "docs": {
+          "stability": "stable"
+        }
+      },
+      "kind": "class",
+      "locationInModule": {
+        "filename": "src/interface/on-failure.ts",
+        "line": 133
+      },
+      "methods": [
+        {
+          "docs": {
+            "stability": "stable"
+          },
+          "locationInModule": {
+            "filename": "src/interface/on-failure.ts",
+            "line": 135
+          },
+          "name": "stepToInvoke",
+          "overrides": "@cdklabs/cdk-ssm-documents.OnFailure",
+          "parameters": [
+            {
+              "name": "currentStep",
+              "type": {
+                "fqn": "@cdklabs/cdk-ssm-documents.AutomationStep"
+              }
+            }
+          ],
+          "returns": {
+            "type": {
+              "primitive": "string"
+            }
+          }
+        },
+        {
+          "docs": {
+            "stability": "stable"
+          },
+          "locationInModule": {
+            "filename": "src/interface/on-failure.ts",
+            "line": 139
+          },
+          "name": "toSsmValue",
+          "overrides": "@cdklabs/cdk-ssm-documents.OnFailure",
+          "returns": {
+            "type": {
+              "primitive": "string"
+            }
+          }
+        }
+      ],
+      "name": "Continue",
+      "symbolId": "src/interface/on-failure:Continue"
+    },
     "@cdklabs/cdk-ssm-documents.CopyImageSimulation": {
       "assembly": "@cdklabs/cdk-ssm-documents",
       "base": "@cdklabs/cdk-ssm-documents.AutomationSimulationBase",
@@ -21469,107 +21591,355 @@
       "name": "NumberVariable",
       "symbolId": "src/interface/variables/number-variable:NumberVariable"
     },
-    "@cdklabs/cdk-ssm-documents.OnFailureVariable": {
+    "@cdklabs/cdk-ssm-documents.OnCancel": {
+      "abstract": true,
       "assembly": "@cdklabs/cdk-ssm-documents",
-      "base": "@cdklabs/cdk-ssm-documents.StringVariable",
+      "base": "@cdklabs/cdk-ssm-documents.OnFailure",
       "docs": {
-        "stability": "stable"
+        "remarks": "See docs here: https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-actions.html#canProp\nThe supported actions are abort (default) or invoking a specific step.\nThis behavior can be adopted by using the static methods available on OnCancel.",
+        "stability": "stable",
+        "summary": "Steps can specify an action to take onCancel."
       },
-      "fqn": "@cdklabs/cdk-ssm-documents.OnFailureVariable",
+      "fqn": "@cdklabs/cdk-ssm-documents.OnCancel",
       "initializer": {
         "docs": {
           "stability": "stable"
-        },
-        "locationInModule": {
-          "filename": "src/interface/variables/variable.ts",
-          "line": 72
-        },
-        "parameters": [
-          {
-            "name": "reference",
-            "type": {
-              "primitive": "string"
-            }
-          }
-        ]
+        }
       },
-      "interfaces": [
-        "@cdklabs/cdk-ssm-documents.IOnFailureVariable"
-      ],
       "kind": "class",
       "locationInModule": {
-        "filename": "src/parent-steps/automation/create-stack-step.ts",
-        "line": 52
+        "filename": "src/interface/on-failure.ts",
+        "line": 49
       },
       "methods": [
         {
           "docs": {
-            "stability": "stable"
+            "remarks": "(This is the default behavior.)",
+            "stability": "stable",
+            "summary": "To abort execution if a cancellation occurs during execution of the current step."
           },
           "locationInModule": {
-            "filename": "src/parent-steps/automation/create-stack-step.ts",
+            "filename": "src/interface/on-failure.ts",
+            "line": 71
+          },
+          "name": "abort",
+          "overrides": "@cdklabs/cdk-ssm-documents.OnFailure",
+          "returns": {
+            "type": {
+              "fqn": "@cdklabs/cdk-ssm-documents.OnCancel"
+            }
+          },
+          "static": true
+        },
+        {
+          "docs": {
+            "remarks": "Provide the step object to execute for the onCancel action.\nIf you don't have a handle to the step object, use the invokeStepByName function.\nNot all action types may be invoked during cancellation. See documentation referenced on this class.",
+            "stability": "stable",
+            "summary": "Invoke a specific step."
+          },
+          "locationInModule": {
+            "filename": "src/interface/on-failure.ts",
             "line": 55
           },
-          "name": "assertType",
-          "overrides": "@cdklabs/cdk-ssm-documents.StringVariable",
+          "name": "invokeStep",
+          "overrides": "@cdklabs/cdk-ssm-documents.OnFailure",
           "parameters": [
             {
-              "name": "value",
+              "name": "step",
               "type": {
-                "primitive": "any"
+                "fqn": "@cdklabs/cdk-ssm-documents.AutomationStep"
               }
             }
           ],
-          "protected": true
-        }
-      ],
-      "name": "OnFailureVariable",
-      "properties": [
+          "returns": {
+            "type": {
+              "fqn": "@cdklabs/cdk-ssm-documents.OnCancel"
+            }
+          },
+          "static": true
+        },
         {
           "docs": {
-            "stability": "stable"
+            "remarks": "Not all action types may be invoked during cancellation. See documentation referenced on this class.",
+            "stability": "stable",
+            "summary": "Invoke a specific step by the step name for the OnCancel action."
           },
-          "immutable": true,
           "locationInModule": {
-            "filename": "src/parent-steps/automation/create-stack-step.ts",
-            "line": 53
+            "filename": "src/interface/on-failure.ts",
+            "line": 63
           },
-          "name": "validValues",
-          "type": {
-            "collection": {
-              "elementtype": {
+          "name": "invokeStepByName",
+          "overrides": "@cdklabs/cdk-ssm-documents.OnFailure",
+          "parameters": [
+            {
+              "name": "stepName",
+              "type": {
                 "primitive": "string"
-              },
-              "kind": "array"
+              }
             }
-          }
+          ],
+          "returns": {
+            "type": {
+              "fqn": "@cdklabs/cdk-ssm-documents.OnCancel"
+            }
+          },
+          "static": true
         }
       ],
-      "symbolId": "src/parent-steps/automation/create-stack-step:OnFailureVariable"
+      "name": "OnCancel",
+      "symbolId": "src/interface/on-failure:OnCancel"
     },
-    "@cdklabs/cdk-ssm-documents.Operation": {
+    "@cdklabs/cdk-ssm-documents.OnFailure": {
+      "abstract": true,
       "assembly": "@cdklabs/cdk-ssm-documents",
       "docs": {
-        "remarks": "See https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-action-branch.html\nor https://docs.aws.amazon.com/systems-manager/latest/userguide/document-schemas-features.html",
+        "remarks": "See docs here: https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-actions.html#failProp\nThe supported actions are abort (default), continue, or invoking a specific step.\nThis behavior can be adopted by using the static methods available on OnFailure.",
         "stability": "stable",
-        "summary": "Operation to use for comparing a Choice's or Preconditions with provided value."
+        "summary": "Steps can specify an action to take onFailure."
       },
-      "fqn": "@cdklabs/cdk-ssm-documents.Operation",
-      "kind": "enum",
+      "fqn": "@cdklabs/cdk-ssm-documents.OnFailure",
+      "initializer": {
+        "docs": {
+          "stability": "stable"
+        }
+      },
+      "kind": "class",
       "locationInModule": {
-        "filename": "src/domain/operation.ts",
-        "line": 6
+        "filename": "src/interface/on-failure.ts",
+        "line": 9
       },
-      "members": [
+      "methods": [
         {
           "docs": {
-            "stability": "stable"
+            "remarks": "(This is the default behavior.)",
+            "stability": "stable",
+            "summary": "To abort execution if a failure occurs during execution of the current step."
           },
-          "name": "BOOLEAN_EQUALS"
-        },
-        {
-          "docs": {
-            "stability": "stable"
+          "locationInModule": {
+            "filename": "src/interface/on-failure.ts",
+            "line": 29
+          },
+          "name": "abort",
+          "returns": {
+            "type": {
+              "fqn": "@cdklabs/cdk-ssm-documents.OnCancel"
+            }
+          },
+          "static": true
+        },
+        {
+          "docs": {
+            "stability": "stable",
+            "summary": "To continue execution of the subsequent step if a failure occurs during execution of the current step."
+          },
+          "locationInModule": {
+            "filename": "src/interface/on-failure.ts",
+            "line": 36
+          },
+          "name": "continue",
+          "returns": {
+            "type": {
+              "fqn": "@cdklabs/cdk-ssm-documents.OnFailure"
+            }
+          },
+          "static": true
+        },
+        {
+          "docs": {
+            "remarks": "Provide the step object to execute for the onFailure action.\nIf you don't have a handle to the step object, use the invokeStepByName function.",
+            "stability": "stable",
+            "summary": "Invoke a specific step."
+          },
+          "locationInModule": {
+            "filename": "src/interface/on-failure.ts",
+            "line": 14
+          },
+          "name": "invokeStep",
+          "parameters": [
+            {
+              "name": "step",
+              "type": {
+                "fqn": "@cdklabs/cdk-ssm-documents.AutomationStep"
+              }
+            }
+          ],
+          "returns": {
+            "type": {
+              "fqn": "@cdklabs/cdk-ssm-documents.OnCancel"
+            }
+          },
+          "static": true
+        },
+        {
+          "docs": {
+            "stability": "stable",
+            "summary": "Invoke a specific step by the step name for the OnFailure action."
+          },
+          "locationInModule": {
+            "filename": "src/interface/on-failure.ts",
+            "line": 21
+          },
+          "name": "invokeStepByName",
+          "parameters": [
+            {
+              "name": "stepName",
+              "type": {
+                "primitive": "string"
+              }
+            }
+          ],
+          "returns": {
+            "type": {
+              "fqn": "@cdklabs/cdk-ssm-documents.OnCancel"
+            }
+          },
+          "static": true
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "stable"
+          },
+          "locationInModule": {
+            "filename": "src/interface/on-failure.ts",
+            "line": 39
+          },
+          "name": "stepToInvoke",
+          "parameters": [
+            {
+              "name": "currentStep",
+              "type": {
+                "fqn": "@cdklabs/cdk-ssm-documents.AutomationStep"
+              }
+            }
+          ],
+          "returns": {
+            "type": {
+              "primitive": "string"
+            }
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "stable"
+          },
+          "locationInModule": {
+            "filename": "src/interface/on-failure.ts",
+            "line": 40
+          },
+          "name": "toSsmValue",
+          "returns": {
+            "type": {
+              "primitive": "string"
+            }
+          }
+        }
+      ],
+      "name": "OnFailure",
+      "symbolId": "src/interface/on-failure:OnFailure"
+    },
+    "@cdklabs/cdk-ssm-documents.OnFailureVariable": {
+      "assembly": "@cdklabs/cdk-ssm-documents",
+      "base": "@cdklabs/cdk-ssm-documents.StringVariable",
+      "docs": {
+        "stability": "stable"
+      },
+      "fqn": "@cdklabs/cdk-ssm-documents.OnFailureVariable",
+      "initializer": {
+        "docs": {
+          "stability": "stable"
+        },
+        "locationInModule": {
+          "filename": "src/interface/variables/variable.ts",
+          "line": 72
+        },
+        "parameters": [
+          {
+            "name": "reference",
+            "type": {
+              "primitive": "string"
+            }
+          }
+        ]
+      },
+      "interfaces": [
+        "@cdklabs/cdk-ssm-documents.IOnFailureVariable"
+      ],
+      "kind": "class",
+      "locationInModule": {
+        "filename": "src/parent-steps/automation/create-stack-step.ts",
+        "line": 52
+      },
+      "methods": [
+        {
+          "docs": {
+            "stability": "stable"
+          },
+          "locationInModule": {
+            "filename": "src/parent-steps/automation/create-stack-step.ts",
+            "line": 55
+          },
+          "name": "assertType",
+          "overrides": "@cdklabs/cdk-ssm-documents.StringVariable",
+          "parameters": [
+            {
+              "name": "value",
+              "type": {
+                "primitive": "any"
+              }
+            }
+          ],
+          "protected": true
+        }
+      ],
+      "name": "OnFailureVariable",
+      "properties": [
+        {
+          "docs": {
+            "stability": "stable"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/parent-steps/automation/create-stack-step.ts",
+            "line": 53
+          },
+          "name": "validValues",
+          "type": {
+            "collection": {
+              "elementtype": {
+                "primitive": "string"
+              },
+              "kind": "array"
+            }
+          }
+        }
+      ],
+      "symbolId": "src/parent-steps/automation/create-stack-step:OnFailureVariable"
+    },
+    "@cdklabs/cdk-ssm-documents.Operation": {
+      "assembly": "@cdklabs/cdk-ssm-documents",
+      "docs": {
+        "remarks": "See https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-action-branch.html\nor https://docs.aws.amazon.com/systems-manager/latest/userguide/document-schemas-features.html",
+        "stability": "stable",
+        "summary": "Operation to use for comparing a Choice's or Preconditions with provided value."
+      },
+      "fqn": "@cdklabs/cdk-ssm-documents.Operation",
+      "kind": "enum",
+      "locationInModule": {
+        "filename": "src/domain/operation.ts",
+        "line": 6
+      },
+      "members": [
+        {
+          "docs": {
+            "stability": "stable"
+          },
+          "name": "BOOLEAN_EQUALS"
+        },
+        {
+          "docs": {
+            "stability": "stable"
           },
           "name": "CONTAINS"
         },
@@ -29503,6 +29873,233 @@
       ],
       "symbolId": "src/parent-steps/step:Step"
     },
+    "@cdklabs/cdk-ssm-documents.StepFallback": {
+      "assembly": "@cdklabs/cdk-ssm-documents",
+      "base": "@cdklabs/cdk-ssm-documents.OnCancel",
+      "docs": {
+        "stability": "stable"
+      },
+      "fqn": "@cdklabs/cdk-ssm-documents.StepFallback",
+      "initializer": {
+        "docs": {
+          "stability": "stable"
+        },
+        "locationInModule": {
+          "filename": "src/interface/on-failure.ts",
+          "line": 80
+        },
+        "parameters": [
+          {
+            "name": "step",
+            "type": {
+              "fqn": "@cdklabs/cdk-ssm-documents.AutomationStep"
+            }
+          },
+          {
+            "name": "validateStepAction",
+            "type": {
+              "primitive": "boolean"
+            }
+          }
+        ]
+      },
+      "kind": "class",
+      "locationInModule": {
+        "filename": "src/interface/on-failure.ts",
+        "line": 76
+      },
+      "methods": [
+        {
+          "docs": {
+            "stability": "stable"
+          },
+          "locationInModule": {
+            "filename": "src/interface/on-failure.ts",
+            "line": 88
+          },
+          "name": "stepToInvoke",
+          "overrides": "@cdklabs/cdk-ssm-documents.OnFailure",
+          "parameters": [
+            {
+              "name": "_currentStep",
+              "type": {
+                "fqn": "@cdklabs/cdk-ssm-documents.AutomationStep"
+              }
+            }
+          ],
+          "returns": {
+            "type": {
+              "primitive": "string"
+            }
+          }
+        },
+        {
+          "docs": {
+            "stability": "stable"
+          },
+          "locationInModule": {
+            "filename": "src/interface/on-failure.ts",
+            "line": 92
+          },
+          "name": "toSsmValue",
+          "overrides": "@cdklabs/cdk-ssm-documents.OnFailure",
+          "returns": {
+            "type": {
+              "primitive": "string"
+            }
+          }
+        }
+      ],
+      "name": "StepFallback",
+      "properties": [
+        {
+          "const": true,
+          "docs": {
+            "stability": "stable"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/interface/on-failure.ts",
+            "line": 77
+          },
+          "name": "ILLEGAL_FALLBACK_ACTIONS",
+          "static": true,
+          "type": {
+            "collection": {
+              "elementtype": {
+                "primitive": "string"
+              },
+              "kind": "array"
+            }
+          }
+        },
+        {
+          "docs": {
+            "stability": "stable"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/interface/on-failure.ts",
+            "line": 79
+          },
+          "name": "step",
+          "type": {
+            "fqn": "@cdklabs/cdk-ssm-documents.AutomationStep"
+          }
+        }
+      ],
+      "symbolId": "src/interface/on-failure:StepFallback"
+    },
+    "@cdklabs/cdk-ssm-documents.StepNameFallback": {
+      "assembly": "@cdklabs/cdk-ssm-documents",
+      "base": "@cdklabs/cdk-ssm-documents.OnCancel",
+      "docs": {
+        "stability": "stable"
+      },
+      "fqn": "@cdklabs/cdk-ssm-documents.StepNameFallback",
+      "initializer": {
+        "docs": {
+          "stability": "stable"
+        },
+        "locationInModule": {
+          "filename": "src/interface/on-failure.ts",
+          "line": 100
+        },
+        "parameters": [
+          {
+            "name": "step",
+            "type": {
+              "primitive": "string"
+            }
+          },
+          {
+            "name": "validateStepAction",
+            "type": {
+              "primitive": "boolean"
+            }
+          }
+        ]
+      },
+      "kind": "class",
+      "locationInModule": {
+        "filename": "src/interface/on-failure.ts",
+        "line": 97
+      },
+      "methods": [
+        {
+          "docs": {
+            "stability": "stable"
+          },
+          "locationInModule": {
+            "filename": "src/interface/on-failure.ts",
+            "line": 106
+          },
+          "name": "stepToInvoke",
+          "overrides": "@cdklabs/cdk-ssm-documents.OnFailure",
+          "parameters": [
+            {
+              "name": "currentStep",
+              "type": {
+                "fqn": "@cdklabs/cdk-ssm-documents.AutomationStep"
+              }
+            }
+          ],
+          "returns": {
+            "type": {
+              "primitive": "string"
+            }
+          }
+        },
+        {
+          "docs": {
+            "stability": "stable"
+          },
+          "locationInModule": {
+            "filename": "src/interface/on-failure.ts",
+            "line": 117
+          },
+          "name": "toSsmValue",
+          "overrides": "@cdklabs/cdk-ssm-documents.OnFailure",
+          "returns": {
+            "type": {
+              "primitive": "string"
+            }
+          }
+        }
+      ],
+      "name": "StepNameFallback",
+      "properties": [
+        {
+          "docs": {
+            "stability": "stable"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/interface/on-failure.ts",
+            "line": 98
+          },
+          "name": "step",
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "docs": {
+            "stability": "stable"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/interface/on-failure.ts",
+            "line": 99
+          },
+          "name": "validateStepAction",
+          "type": {
+            "primitive": "boolean"
+          }
+        }
+      ],
+      "symbolId": "src/interface/on-failure:StepNameFallback"
+    },
     "@cdklabs/cdk-ssm-documents.StepProps": {
       "assembly": "@cdklabs/cdk-ssm-documents",
       "datatype": true,
@@ -31926,6 +32523,6 @@
       "symbolId": "src/interface/webhook:WebhookImpl"
     }
   },
-  "version": "0.0.17",
-  "fingerprint": "Cbm5rB3vy6Ylc6yZkxhAveizr62LIo+7P/e8Nq62CGc="
+  "version": "0.0.20",
+  "fingerprint": "kEtZVw41lvIaUPez+KQLdZLZffNQOKTGpKdQUgc8zns="
 }