@cdklabs/cdk-ssm-documents 0.0.19 → 0.0.20

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.
Files changed (120) hide show
  1. package/.jsii +691 -94
  2. package/API.md +1212 -426
  3. package/README.md +1 -0
  4. package/changelog.md +3 -3
  5. package/lib/construct/synth-utils.js +1 -1
  6. package/lib/document/automation-document.js +1 -1
  7. package/lib/document/command-document.js +1 -1
  8. package/lib/document/document-builder.js +2 -2
  9. package/lib/document/ssm-document.js +1 -1
  10. package/lib/domain/choice.js +1 -1
  11. package/lib/domain/data-type.js +1 -1
  12. package/lib/domain/enum/install-action.js +2 -2
  13. package/lib/domain/enum/install-uninstall-repair.js +2 -2
  14. package/lib/domain/enum/installation-type.js +2 -2
  15. package/lib/domain/enum/package-name.js +2 -2
  16. package/lib/domain/input.js +1 -1
  17. package/lib/domain/operation.js +1 -1
  18. package/lib/domain/platform.js +1 -1
  19. package/lib/domain/precondition.js +1 -1
  20. package/lib/index.d.ts +1 -0
  21. package/lib/index.js +2 -1
  22. package/lib/interface/approve-hook.js +2 -2
  23. package/lib/interface/auth-method.js +3 -3
  24. package/lib/interface/aws-invoker.js +2 -2
  25. package/lib/interface/downloadable-content.js +8 -8
  26. package/lib/interface/environment.js +3 -3
  27. package/lib/interface/execute-automation-hook/api-execute-automation-hook.js +1 -1
  28. package/lib/interface/observer.js +1 -1
  29. package/lib/interface/on-failure.d.ts +75 -0
  30. package/lib/interface/on-failure.js +141 -0
  31. package/lib/interface/pause-hook.js +2 -2
  32. package/lib/interface/run-command-hook/api-run-command-hook.js +1 -1
  33. package/lib/interface/run-document-location.js +2 -2
  34. package/lib/interface/sleep-hook.js +2 -2
  35. package/lib/interface/variables/boolean-variable.js +2 -2
  36. package/lib/interface/variables/map-list-variable.js +2 -2
  37. package/lib/interface/variables/number-variable.js +2 -2
  38. package/lib/interface/variables/secure-string-variable.js +4 -4
  39. package/lib/interface/variables/string-list-variable.js +2 -2
  40. package/lib/interface/variables/string-map-variable.js +2 -2
  41. package/lib/interface/variables/string-variable.js +4 -4
  42. package/lib/interface/variables/variable.js +2 -2
  43. package/lib/interface/webhook.js +1 -1
  44. package/lib/parent-steps/automation/approve-step.js +1 -1
  45. package/lib/parent-steps/automation/assert-aws-resource-step.js +1 -1
  46. package/lib/parent-steps/automation/aws-api-step.js +1 -1
  47. package/lib/parent-steps/automation/branch-step.js +1 -1
  48. package/lib/parent-steps/automation/change-instance-state-step.js +3 -3
  49. package/lib/parent-steps/automation/copy-image-step.js +1 -1
  50. package/lib/parent-steps/automation/create-image-step.js +1 -1
  51. package/lib/parent-steps/automation/create-stack-step.js +3 -3
  52. package/lib/parent-steps/automation/create-tags-step.js +3 -3
  53. package/lib/parent-steps/automation/delete-image-step.js +1 -1
  54. package/lib/parent-steps/automation/delete-stack-step.js +1 -1
  55. package/lib/parent-steps/automation/execute-automation-step.js +1 -1
  56. package/lib/parent-steps/automation/execute-script-step.js +1 -1
  57. package/lib/parent-steps/automation/execute-state-machine-step.js +1 -1
  58. package/lib/parent-steps/automation/invoke-lambda-function-step.js +1 -1
  59. package/lib/parent-steps/automation/invoke-webhook-step.js +1 -1
  60. package/lib/parent-steps/automation/pause-step.js +1 -1
  61. package/lib/parent-steps/automation/run-command-step.js +3 -3
  62. package/lib/parent-steps/automation/run-instance-step.js +1 -1
  63. package/lib/parent-steps/automation/sleep-step.js +1 -1
  64. package/lib/parent-steps/automation/wait-for-resource-step.js +1 -1
  65. package/lib/parent-steps/automation-step.d.ts +9 -8
  66. package/lib/parent-steps/automation-step.js +9 -8
  67. package/lib/parent-steps/command/applications-step.js +1 -1
  68. package/lib/parent-steps/command/configure-docker-step.js +1 -1
  69. package/lib/parent-steps/command/configure-package-step.js +1 -1
  70. package/lib/parent-steps/command/domain-join-step.js +1 -1
  71. package/lib/parent-steps/command/download-content-step.js +1 -1
  72. package/lib/parent-steps/command/ps-module-step.js +1 -1
  73. package/lib/parent-steps/command/run-docker-action-step.js +1 -1
  74. package/lib/parent-steps/command/run-document-step.js +1 -1
  75. package/lib/parent-steps/command/run-powershell-script-step.js +1 -1
  76. package/lib/parent-steps/command/run-shell-script-step.js +1 -1
  77. package/lib/parent-steps/command/software-inventory-step.js +1 -1
  78. package/lib/parent-steps/command/update-agent-step.js +1 -1
  79. package/lib/parent-steps/command/update-ssm-agent-step.js +1 -1
  80. package/lib/parent-steps/command-step.js +1 -1
  81. package/lib/parent-steps/step.js +1 -1
  82. package/lib/patterns/automation/composite-step.js +2 -2
  83. package/lib/patterns/automation/reboot-instance-and-wait.js +1 -1
  84. package/lib/patterns/automation/string-step.js +1 -1
  85. package/lib/patterns/document/string-document.js +1 -1
  86. package/lib/patterns/document/timed-document.js +1 -1
  87. package/lib/samples/hello-world.js +1 -1
  88. package/lib/simulation/automation/approve-simulation.js +1 -1
  89. package/lib/simulation/automation/assert-aws-resource-simulation.js +1 -1
  90. package/lib/simulation/automation/automation-simulation-base.js +1 -1
  91. package/lib/simulation/automation/aws-api-simulation.js +1 -1
  92. package/lib/simulation/automation/branch-simulation.js +1 -1
  93. package/lib/simulation/automation/change-instance-state-simulation.js +1 -1
  94. package/lib/simulation/automation/copy-image-simulation.js +1 -1
  95. package/lib/simulation/automation/create-image-simulation.js +1 -1
  96. package/lib/simulation/automation/create-stack-simulation.js +1 -1
  97. package/lib/simulation/automation/create-tags-simulation.js +1 -1
  98. package/lib/simulation/automation/delete-image-simulation.js +1 -1
  99. package/lib/simulation/automation/delete-stack-simulation.js +1 -1
  100. package/lib/simulation/automation/execute-script-simulation.js +1 -1
  101. package/lib/simulation/automation/execute-state-machine-simulation.js +1 -1
  102. package/lib/simulation/automation/invoke-lambda-function-simulation.js +1 -1
  103. package/lib/simulation/automation/invoke-webhook-simulation.js +1 -1
  104. package/lib/simulation/automation/pause-simulation.js +1 -1
  105. package/lib/simulation/automation/run-command-simulation.js +1 -1
  106. package/lib/simulation/automation/run-instance-simulation.js +1 -1
  107. package/lib/simulation/automation/sleep-simulation.js +1 -1
  108. package/lib/simulation/automation/wait-for-resource-simulation.js +1 -1
  109. package/lib/simulation/automation-step-simulation.js +18 -8
  110. package/lib/simulation/command/command-simulation-base.js +1 -1
  111. package/lib/simulation/command/ps-module-simulation.js +1 -1
  112. package/lib/simulation/command/run-powershell-script-simulation.js +1 -1
  113. package/lib/simulation/command/run-shell-script-simulation.js +1 -1
  114. package/lib/simulation/command-step-simulation.js +1 -1
  115. package/lib/simulation/document/automation-simulation.js +1 -1
  116. package/lib/simulation/document/command-simulation.js +1 -1
  117. package/lib/simulation/simulation.js +1 -1
  118. package/package.json +1 -1
  119. package/releasetag.txt +1 -1
  120. package/version.txt +1 -1
package/API.md CHANGED
@@ -476,9 +476,9 @@ Any object.
476
476
  | <code><a href="#@cdklabs/cdk-ssm-documents.ApproveStep.property.description">description</a></code> | <code>string</code> | *No description.* |
477
477
  | <code><a href="#@cdklabs/cdk-ssm-documents.ApproveStep.property.isEnd">isEnd</a></code> | <code>boolean</code> | *No description.* |
478
478
  | <code><a href="#@cdklabs/cdk-ssm-documents.ApproveStep.property.maxAttempts">maxAttempts</a></code> | <code>number</code> | *No description.* |
479
+ | <code><a href="#@cdklabs/cdk-ssm-documents.ApproveStep.property.onCancel">onCancel</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a></code> | *No description.* |
480
+ | <code><a href="#@cdklabs/cdk-ssm-documents.ApproveStep.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a></code> | *No description.* |
479
481
  | <code><a href="#@cdklabs/cdk-ssm-documents.ApproveStep.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</code> | *No description.* |
480
- | <code><a href="#@cdklabs/cdk-ssm-documents.ApproveStep.property.onCancel">onCancel</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | *No description.* |
481
- | <code><a href="#@cdklabs/cdk-ssm-documents.ApproveStep.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | *No description.* |
482
482
  | <code><a href="#@cdklabs/cdk-ssm-documents.ApproveStep.property.allStepsInExecution">allStepsInExecution</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>[]</code> | *No description.* |
483
483
  | <code><a href="#@cdklabs/cdk-ssm-documents.ApproveStep.property.nextStep">nextStep</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | *No description.* |
484
484
  | <code><a href="#@cdklabs/cdk-ssm-documents.ApproveStep.property.approvers">approvers</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.IStringListVariable">IStringListVariable</a></code> | *No description.* |
@@ -570,33 +570,33 @@ public readonly maxAttempts: number;
570
570
 
571
571
  ---
572
572
 
573
- ##### `timeoutSeconds`<sup>Required</sup> <a name="timeoutSeconds" id="@cdklabs/cdk-ssm-documents.ApproveStep.property.timeoutSeconds"></a>
573
+ ##### `onCancel`<sup>Required</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.ApproveStep.property.onCancel"></a>
574
574
 
575
575
  ```typescript
576
- public readonly timeoutSeconds: number;
576
+ public readonly onCancel: OnCancel;
577
577
  ```
578
578
 
579
- - *Type:* number
579
+ - *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a>
580
580
 
581
581
  ---
582
582
 
583
- ##### `onCancel`<sup>Optional</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.ApproveStep.property.onCancel"></a>
583
+ ##### `onFailure`<sup>Required</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.ApproveStep.property.onFailure"></a>
584
584
 
585
585
  ```typescript
586
- public readonly onCancel: AutomationStep;
586
+ public readonly onFailure: OnFailure;
587
587
  ```
588
588
 
589
- - *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
589
+ - *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a>
590
590
 
591
591
  ---
592
592
 
593
- ##### `onFailure`<sup>Optional</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.ApproveStep.property.onFailure"></a>
593
+ ##### `timeoutSeconds`<sup>Required</sup> <a name="timeoutSeconds" id="@cdklabs/cdk-ssm-documents.ApproveStep.property.timeoutSeconds"></a>
594
594
 
595
595
  ```typescript
596
- public readonly onFailure: AutomationStep;
596
+ public readonly timeoutSeconds: number;
597
597
  ```
598
598
 
599
- - *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
599
+ - *Type:* number
600
600
 
601
601
  ---
602
602
 
@@ -830,9 +830,9 @@ Any object.
830
830
  | <code><a href="#@cdklabs/cdk-ssm-documents.AssertAwsResourceStep.property.description">description</a></code> | <code>string</code> | *No description.* |
831
831
  | <code><a href="#@cdklabs/cdk-ssm-documents.AssertAwsResourceStep.property.isEnd">isEnd</a></code> | <code>boolean</code> | *No description.* |
832
832
  | <code><a href="#@cdklabs/cdk-ssm-documents.AssertAwsResourceStep.property.maxAttempts">maxAttempts</a></code> | <code>number</code> | *No description.* |
833
+ | <code><a href="#@cdklabs/cdk-ssm-documents.AssertAwsResourceStep.property.onCancel">onCancel</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a></code> | *No description.* |
834
+ | <code><a href="#@cdklabs/cdk-ssm-documents.AssertAwsResourceStep.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a></code> | *No description.* |
833
835
  | <code><a href="#@cdklabs/cdk-ssm-documents.AssertAwsResourceStep.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</code> | *No description.* |
834
- | <code><a href="#@cdklabs/cdk-ssm-documents.AssertAwsResourceStep.property.onCancel">onCancel</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | *No description.* |
835
- | <code><a href="#@cdklabs/cdk-ssm-documents.AssertAwsResourceStep.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | *No description.* |
836
836
  | <code><a href="#@cdklabs/cdk-ssm-documents.AssertAwsResourceStep.property.allStepsInExecution">allStepsInExecution</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>[]</code> | *No description.* |
837
837
  | <code><a href="#@cdklabs/cdk-ssm-documents.AssertAwsResourceStep.property.nextStep">nextStep</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | *No description.* |
838
838
  | <code><a href="#@cdklabs/cdk-ssm-documents.AssertAwsResourceStep.property.apiParams">apiParams</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.DictFormat">DictFormat</a></code> | *No description.* |
@@ -927,33 +927,33 @@ public readonly maxAttempts: number;
927
927
 
928
928
  ---
929
929
 
930
- ##### `timeoutSeconds`<sup>Required</sup> <a name="timeoutSeconds" id="@cdklabs/cdk-ssm-documents.AssertAwsResourceStep.property.timeoutSeconds"></a>
930
+ ##### `onCancel`<sup>Required</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.AssertAwsResourceStep.property.onCancel"></a>
931
931
 
932
932
  ```typescript
933
- public readonly timeoutSeconds: number;
933
+ public readonly onCancel: OnCancel;
934
934
  ```
935
935
 
936
- - *Type:* number
936
+ - *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a>
937
937
 
938
938
  ---
939
939
 
940
- ##### `onCancel`<sup>Optional</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.AssertAwsResourceStep.property.onCancel"></a>
940
+ ##### `onFailure`<sup>Required</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.AssertAwsResourceStep.property.onFailure"></a>
941
941
 
942
942
  ```typescript
943
- public readonly onCancel: AutomationStep;
943
+ public readonly onFailure: OnFailure;
944
944
  ```
945
945
 
946
- - *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
946
+ - *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a>
947
947
 
948
948
  ---
949
949
 
950
- ##### `onFailure`<sup>Optional</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.AssertAwsResourceStep.property.onFailure"></a>
950
+ ##### `timeoutSeconds`<sup>Required</sup> <a name="timeoutSeconds" id="@cdklabs/cdk-ssm-documents.AssertAwsResourceStep.property.timeoutSeconds"></a>
951
951
 
952
952
  ```typescript
953
- public readonly onFailure: AutomationStep;
953
+ public readonly timeoutSeconds: number;
954
954
  ```
955
955
 
956
- - *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
956
+ - *Type:* number
957
957
 
958
958
  ---
959
959
 
@@ -1456,9 +1456,9 @@ Any object.
1456
1456
  | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep.property.description">description</a></code> | <code>string</code> | *No description.* |
1457
1457
  | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep.property.isEnd">isEnd</a></code> | <code>boolean</code> | *No description.* |
1458
1458
  | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep.property.maxAttempts">maxAttempts</a></code> | <code>number</code> | *No description.* |
1459
+ | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep.property.onCancel">onCancel</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a></code> | *No description.* |
1460
+ | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a></code> | *No description.* |
1459
1461
  | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</code> | *No description.* |
1460
- | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep.property.onCancel">onCancel</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | *No description.* |
1461
- | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | *No description.* |
1462
1462
  | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep.property.allStepsInExecution">allStepsInExecution</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>[]</code> | *No description.* |
1463
1463
  | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep.property.nextStep">nextStep</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | *No description.* |
1464
1464
 
@@ -1546,33 +1546,33 @@ public readonly maxAttempts: number;
1546
1546
 
1547
1547
  ---
1548
1548
 
1549
- ##### `timeoutSeconds`<sup>Required</sup> <a name="timeoutSeconds" id="@cdklabs/cdk-ssm-documents.AutomationStep.property.timeoutSeconds"></a>
1549
+ ##### `onCancel`<sup>Required</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.AutomationStep.property.onCancel"></a>
1550
1550
 
1551
1551
  ```typescript
1552
- public readonly timeoutSeconds: number;
1552
+ public readonly onCancel: OnCancel;
1553
1553
  ```
1554
1554
 
1555
- - *Type:* number
1555
+ - *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a>
1556
1556
 
1557
1557
  ---
1558
1558
 
1559
- ##### `onCancel`<sup>Optional</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.AutomationStep.property.onCancel"></a>
1559
+ ##### `onFailure`<sup>Required</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.AutomationStep.property.onFailure"></a>
1560
1560
 
1561
1561
  ```typescript
1562
- public readonly onCancel: AutomationStep;
1562
+ public readonly onFailure: OnFailure;
1563
1563
  ```
1564
1564
 
1565
- - *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
1565
+ - *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a>
1566
1566
 
1567
1567
  ---
1568
1568
 
1569
- ##### `onFailure`<sup>Optional</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.AutomationStep.property.onFailure"></a>
1569
+ ##### `timeoutSeconds`<sup>Required</sup> <a name="timeoutSeconds" id="@cdklabs/cdk-ssm-documents.AutomationStep.property.timeoutSeconds"></a>
1570
1570
 
1571
1571
  ```typescript
1572
- public readonly onFailure: AutomationStep;
1572
+ public readonly timeoutSeconds: number;
1573
1573
  ```
1574
1574
 
1575
- - *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
1575
+ - *Type:* number
1576
1576
 
1577
1577
  ---
1578
1578
 
@@ -1764,9 +1764,9 @@ Any object.
1764
1764
  | <code><a href="#@cdklabs/cdk-ssm-documents.AwsApiStep.property.description">description</a></code> | <code>string</code> | *No description.* |
1765
1765
  | <code><a href="#@cdklabs/cdk-ssm-documents.AwsApiStep.property.isEnd">isEnd</a></code> | <code>boolean</code> | *No description.* |
1766
1766
  | <code><a href="#@cdklabs/cdk-ssm-documents.AwsApiStep.property.maxAttempts">maxAttempts</a></code> | <code>number</code> | *No description.* |
1767
+ | <code><a href="#@cdklabs/cdk-ssm-documents.AwsApiStep.property.onCancel">onCancel</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a></code> | *No description.* |
1768
+ | <code><a href="#@cdklabs/cdk-ssm-documents.AwsApiStep.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a></code> | *No description.* |
1767
1769
  | <code><a href="#@cdklabs/cdk-ssm-documents.AwsApiStep.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</code> | *No description.* |
1768
- | <code><a href="#@cdklabs/cdk-ssm-documents.AwsApiStep.property.onCancel">onCancel</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | *No description.* |
1769
- | <code><a href="#@cdklabs/cdk-ssm-documents.AwsApiStep.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | *No description.* |
1770
1770
  | <code><a href="#@cdklabs/cdk-ssm-documents.AwsApiStep.property.allStepsInExecution">allStepsInExecution</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>[]</code> | *No description.* |
1771
1771
  | <code><a href="#@cdklabs/cdk-ssm-documents.AwsApiStep.property.nextStep">nextStep</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | *No description.* |
1772
1772
  | <code><a href="#@cdklabs/cdk-ssm-documents.AwsApiStep.property.apiParams">apiParams</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.DictFormat">DictFormat</a></code> | *No description.* |
@@ -1859,33 +1859,33 @@ public readonly maxAttempts: number;
1859
1859
 
1860
1860
  ---
1861
1861
 
1862
- ##### `timeoutSeconds`<sup>Required</sup> <a name="timeoutSeconds" id="@cdklabs/cdk-ssm-documents.AwsApiStep.property.timeoutSeconds"></a>
1862
+ ##### `onCancel`<sup>Required</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.AwsApiStep.property.onCancel"></a>
1863
1863
 
1864
1864
  ```typescript
1865
- public readonly timeoutSeconds: number;
1865
+ public readonly onCancel: OnCancel;
1866
1866
  ```
1867
1867
 
1868
- - *Type:* number
1868
+ - *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a>
1869
1869
 
1870
1870
  ---
1871
1871
 
1872
- ##### `onCancel`<sup>Optional</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.AwsApiStep.property.onCancel"></a>
1872
+ ##### `onFailure`<sup>Required</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.AwsApiStep.property.onFailure"></a>
1873
1873
 
1874
1874
  ```typescript
1875
- public readonly onCancel: AutomationStep;
1875
+ public readonly onFailure: OnFailure;
1876
1876
  ```
1877
1877
 
1878
- - *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
1878
+ - *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a>
1879
1879
 
1880
1880
  ---
1881
1881
 
1882
- ##### `onFailure`<sup>Optional</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.AwsApiStep.property.onFailure"></a>
1882
+ ##### `timeoutSeconds`<sup>Required</sup> <a name="timeoutSeconds" id="@cdklabs/cdk-ssm-documents.AwsApiStep.property.timeoutSeconds"></a>
1883
1883
 
1884
1884
  ```typescript
1885
- public readonly onFailure: AutomationStep;
1885
+ public readonly timeoutSeconds: number;
1886
1886
  ```
1887
1887
 
1888
- - *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
1888
+ - *Type:* number
1889
1889
 
1890
1890
  ---
1891
1891
 
@@ -2127,9 +2127,9 @@ Any object.
2127
2127
  | <code><a href="#@cdklabs/cdk-ssm-documents.BranchStep.property.description">description</a></code> | <code>string</code> | *No description.* |
2128
2128
  | <code><a href="#@cdklabs/cdk-ssm-documents.BranchStep.property.isEnd">isEnd</a></code> | <code>boolean</code> | *No description.* |
2129
2129
  | <code><a href="#@cdklabs/cdk-ssm-documents.BranchStep.property.maxAttempts">maxAttempts</a></code> | <code>number</code> | *No description.* |
2130
+ | <code><a href="#@cdklabs/cdk-ssm-documents.BranchStep.property.onCancel">onCancel</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a></code> | *No description.* |
2131
+ | <code><a href="#@cdklabs/cdk-ssm-documents.BranchStep.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a></code> | *No description.* |
2130
2132
  | <code><a href="#@cdklabs/cdk-ssm-documents.BranchStep.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</code> | *No description.* |
2131
- | <code><a href="#@cdklabs/cdk-ssm-documents.BranchStep.property.onCancel">onCancel</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | *No description.* |
2132
- | <code><a href="#@cdklabs/cdk-ssm-documents.BranchStep.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | *No description.* |
2133
2133
  | <code><a href="#@cdklabs/cdk-ssm-documents.BranchStep.property.allStepsInExecution">allStepsInExecution</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>[]</code> | *No description.* |
2134
2134
  | <code><a href="#@cdklabs/cdk-ssm-documents.BranchStep.property.nextStep">nextStep</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | *No description.* |
2135
2135
  | <code><a href="#@cdklabs/cdk-ssm-documents.BranchStep.property.choices">choices</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.Choice">Choice</a>[]</code> | *No description.* |
@@ -2219,33 +2219,33 @@ public readonly maxAttempts: number;
2219
2219
 
2220
2220
  ---
2221
2221
 
2222
- ##### `timeoutSeconds`<sup>Required</sup> <a name="timeoutSeconds" id="@cdklabs/cdk-ssm-documents.BranchStep.property.timeoutSeconds"></a>
2222
+ ##### `onCancel`<sup>Required</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.BranchStep.property.onCancel"></a>
2223
2223
 
2224
2224
  ```typescript
2225
- public readonly timeoutSeconds: number;
2225
+ public readonly onCancel: OnCancel;
2226
2226
  ```
2227
2227
 
2228
- - *Type:* number
2228
+ - *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a>
2229
2229
 
2230
2230
  ---
2231
2231
 
2232
- ##### `onCancel`<sup>Optional</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.BranchStep.property.onCancel"></a>
2232
+ ##### `onFailure`<sup>Required</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.BranchStep.property.onFailure"></a>
2233
2233
 
2234
2234
  ```typescript
2235
- public readonly onCancel: AutomationStep;
2235
+ public readonly onFailure: OnFailure;
2236
2236
  ```
2237
2237
 
2238
- - *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
2238
+ - *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a>
2239
2239
 
2240
2240
  ---
2241
2241
 
2242
- ##### `onFailure`<sup>Optional</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.BranchStep.property.onFailure"></a>
2242
+ ##### `timeoutSeconds`<sup>Required</sup> <a name="timeoutSeconds" id="@cdklabs/cdk-ssm-documents.BranchStep.property.timeoutSeconds"></a>
2243
2243
 
2244
2244
  ```typescript
2245
- public readonly onFailure: AutomationStep;
2245
+ public readonly timeoutSeconds: number;
2246
2246
  ```
2247
2247
 
2248
- - *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
2248
+ - *Type:* number
2249
2249
 
2250
2250
  ---
2251
2251
 
@@ -2457,9 +2457,9 @@ Any object.
2457
2457
  | <code><a href="#@cdklabs/cdk-ssm-documents.ChangeInstanceStateStep.property.description">description</a></code> | <code>string</code> | *No description.* |
2458
2458
  | <code><a href="#@cdklabs/cdk-ssm-documents.ChangeInstanceStateStep.property.isEnd">isEnd</a></code> | <code>boolean</code> | *No description.* |
2459
2459
  | <code><a href="#@cdklabs/cdk-ssm-documents.ChangeInstanceStateStep.property.maxAttempts">maxAttempts</a></code> | <code>number</code> | *No description.* |
2460
+ | <code><a href="#@cdklabs/cdk-ssm-documents.ChangeInstanceStateStep.property.onCancel">onCancel</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a></code> | *No description.* |
2461
+ | <code><a href="#@cdklabs/cdk-ssm-documents.ChangeInstanceStateStep.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a></code> | *No description.* |
2460
2462
  | <code><a href="#@cdklabs/cdk-ssm-documents.ChangeInstanceStateStep.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</code> | *No description.* |
2461
- | <code><a href="#@cdklabs/cdk-ssm-documents.ChangeInstanceStateStep.property.onCancel">onCancel</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | *No description.* |
2462
- | <code><a href="#@cdklabs/cdk-ssm-documents.ChangeInstanceStateStep.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | *No description.* |
2463
2463
  | <code><a href="#@cdklabs/cdk-ssm-documents.ChangeInstanceStateStep.property.allStepsInExecution">allStepsInExecution</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>[]</code> | *No description.* |
2464
2464
  | <code><a href="#@cdklabs/cdk-ssm-documents.ChangeInstanceStateStep.property.nextStep">nextStep</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | *No description.* |
2465
2465
  | <code><a href="#@cdklabs/cdk-ssm-documents.ChangeInstanceStateStep.property.desiredState">desiredState</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.IDesiredStateVariable">IDesiredStateVariable</a></code> | *No description.* |
@@ -2552,33 +2552,33 @@ public readonly maxAttempts: number;
2552
2552
 
2553
2553
  ---
2554
2554
 
2555
- ##### `timeoutSeconds`<sup>Required</sup> <a name="timeoutSeconds" id="@cdklabs/cdk-ssm-documents.ChangeInstanceStateStep.property.timeoutSeconds"></a>
2555
+ ##### `onCancel`<sup>Required</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.ChangeInstanceStateStep.property.onCancel"></a>
2556
2556
 
2557
2557
  ```typescript
2558
- public readonly timeoutSeconds: number;
2558
+ public readonly onCancel: OnCancel;
2559
2559
  ```
2560
2560
 
2561
- - *Type:* number
2561
+ - *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a>
2562
2562
 
2563
2563
  ---
2564
2564
 
2565
- ##### `onCancel`<sup>Optional</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.ChangeInstanceStateStep.property.onCancel"></a>
2565
+ ##### `onFailure`<sup>Required</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.ChangeInstanceStateStep.property.onFailure"></a>
2566
2566
 
2567
2567
  ```typescript
2568
- public readonly onCancel: AutomationStep;
2568
+ public readonly onFailure: OnFailure;
2569
2569
  ```
2570
2570
 
2571
- - *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
2571
+ - *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a>
2572
2572
 
2573
2573
  ---
2574
2574
 
2575
- ##### `onFailure`<sup>Optional</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.ChangeInstanceStateStep.property.onFailure"></a>
2575
+ ##### `timeoutSeconds`<sup>Required</sup> <a name="timeoutSeconds" id="@cdklabs/cdk-ssm-documents.ChangeInstanceStateStep.property.timeoutSeconds"></a>
2576
2576
 
2577
2577
  ```typescript
2578
- public readonly onFailure: AutomationStep;
2578
+ public readonly timeoutSeconds: number;
2579
2579
  ```
2580
2580
 
2581
- - *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
2581
+ - *Type:* number
2582
2582
 
2583
2583
  ---
2584
2584
 
@@ -4202,9 +4202,9 @@ Any object.
4202
4202
  | <code><a href="#@cdklabs/cdk-ssm-documents.CopyImageStep.property.description">description</a></code> | <code>string</code> | *No description.* |
4203
4203
  | <code><a href="#@cdklabs/cdk-ssm-documents.CopyImageStep.property.isEnd">isEnd</a></code> | <code>boolean</code> | *No description.* |
4204
4204
  | <code><a href="#@cdklabs/cdk-ssm-documents.CopyImageStep.property.maxAttempts">maxAttempts</a></code> | <code>number</code> | *No description.* |
4205
+ | <code><a href="#@cdklabs/cdk-ssm-documents.CopyImageStep.property.onCancel">onCancel</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a></code> | *No description.* |
4206
+ | <code><a href="#@cdklabs/cdk-ssm-documents.CopyImageStep.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a></code> | *No description.* |
4205
4207
  | <code><a href="#@cdklabs/cdk-ssm-documents.CopyImageStep.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</code> | *No description.* |
4206
- | <code><a href="#@cdklabs/cdk-ssm-documents.CopyImageStep.property.onCancel">onCancel</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | *No description.* |
4207
- | <code><a href="#@cdklabs/cdk-ssm-documents.CopyImageStep.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | *No description.* |
4208
4208
  | <code><a href="#@cdklabs/cdk-ssm-documents.CopyImageStep.property.allStepsInExecution">allStepsInExecution</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>[]</code> | *No description.* |
4209
4209
  | <code><a href="#@cdklabs/cdk-ssm-documents.CopyImageStep.property.nextStep">nextStep</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | *No description.* |
4210
4210
  | <code><a href="#@cdklabs/cdk-ssm-documents.CopyImageStep.property.imageName">imageName</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.IStringVariable">IStringVariable</a></code> | *No description.* |
@@ -4299,33 +4299,33 @@ public readonly maxAttempts: number;
4299
4299
 
4300
4300
  ---
4301
4301
 
4302
- ##### `timeoutSeconds`<sup>Required</sup> <a name="timeoutSeconds" id="@cdklabs/cdk-ssm-documents.CopyImageStep.property.timeoutSeconds"></a>
4302
+ ##### `onCancel`<sup>Required</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.CopyImageStep.property.onCancel"></a>
4303
4303
 
4304
4304
  ```typescript
4305
- public readonly timeoutSeconds: number;
4305
+ public readonly onCancel: OnCancel;
4306
4306
  ```
4307
4307
 
4308
- - *Type:* number
4308
+ - *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a>
4309
4309
 
4310
4310
  ---
4311
4311
 
4312
- ##### `onCancel`<sup>Optional</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.CopyImageStep.property.onCancel"></a>
4312
+ ##### `onFailure`<sup>Required</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.CopyImageStep.property.onFailure"></a>
4313
4313
 
4314
4314
  ```typescript
4315
- public readonly onCancel: AutomationStep;
4315
+ public readonly onFailure: OnFailure;
4316
4316
  ```
4317
4317
 
4318
- - *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
4318
+ - *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a>
4319
4319
 
4320
4320
  ---
4321
4321
 
4322
- ##### `onFailure`<sup>Optional</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.CopyImageStep.property.onFailure"></a>
4322
+ ##### `timeoutSeconds`<sup>Required</sup> <a name="timeoutSeconds" id="@cdklabs/cdk-ssm-documents.CopyImageStep.property.timeoutSeconds"></a>
4323
4323
 
4324
4324
  ```typescript
4325
- public readonly onFailure: AutomationStep;
4325
+ public readonly timeoutSeconds: number;
4326
4326
  ```
4327
4327
 
4328
- - *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
4328
+ - *Type:* number
4329
4329
 
4330
4330
  ---
4331
4331
 
@@ -4587,9 +4587,9 @@ Any object.
4587
4587
  | <code><a href="#@cdklabs/cdk-ssm-documents.CreateImageStep.property.description">description</a></code> | <code>string</code> | *No description.* |
4588
4588
  | <code><a href="#@cdklabs/cdk-ssm-documents.CreateImageStep.property.isEnd">isEnd</a></code> | <code>boolean</code> | *No description.* |
4589
4589
  | <code><a href="#@cdklabs/cdk-ssm-documents.CreateImageStep.property.maxAttempts">maxAttempts</a></code> | <code>number</code> | *No description.* |
4590
+ | <code><a href="#@cdklabs/cdk-ssm-documents.CreateImageStep.property.onCancel">onCancel</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a></code> | *No description.* |
4591
+ | <code><a href="#@cdklabs/cdk-ssm-documents.CreateImageStep.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a></code> | *No description.* |
4590
4592
  | <code><a href="#@cdklabs/cdk-ssm-documents.CreateImageStep.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</code> | *No description.* |
4591
- | <code><a href="#@cdklabs/cdk-ssm-documents.CreateImageStep.property.onCancel">onCancel</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | *No description.* |
4592
- | <code><a href="#@cdklabs/cdk-ssm-documents.CreateImageStep.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | *No description.* |
4593
4593
  | <code><a href="#@cdklabs/cdk-ssm-documents.CreateImageStep.property.allStepsInExecution">allStepsInExecution</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>[]</code> | *No description.* |
4594
4594
  | <code><a href="#@cdklabs/cdk-ssm-documents.CreateImageStep.property.nextStep">nextStep</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | *No description.* |
4595
4595
  | <code><a href="#@cdklabs/cdk-ssm-documents.CreateImageStep.property.imageName">imageName</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.IStringVariable">IStringVariable</a></code> | *No description.* |
@@ -4682,33 +4682,33 @@ public readonly maxAttempts: number;
4682
4682
 
4683
4683
  ---
4684
4684
 
4685
- ##### `timeoutSeconds`<sup>Required</sup> <a name="timeoutSeconds" id="@cdklabs/cdk-ssm-documents.CreateImageStep.property.timeoutSeconds"></a>
4685
+ ##### `onCancel`<sup>Required</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.CreateImageStep.property.onCancel"></a>
4686
4686
 
4687
4687
  ```typescript
4688
- public readonly timeoutSeconds: number;
4688
+ public readonly onCancel: OnCancel;
4689
4689
  ```
4690
4690
 
4691
- - *Type:* number
4691
+ - *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a>
4692
4692
 
4693
4693
  ---
4694
4694
 
4695
- ##### `onCancel`<sup>Optional</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.CreateImageStep.property.onCancel"></a>
4695
+ ##### `onFailure`<sup>Required</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.CreateImageStep.property.onFailure"></a>
4696
4696
 
4697
4697
  ```typescript
4698
- public readonly onCancel: AutomationStep;
4698
+ public readonly onFailure: OnFailure;
4699
4699
  ```
4700
4700
 
4701
- - *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
4701
+ - *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a>
4702
4702
 
4703
4703
  ---
4704
4704
 
4705
- ##### `onFailure`<sup>Optional</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.CreateImageStep.property.onFailure"></a>
4705
+ ##### `timeoutSeconds`<sup>Required</sup> <a name="timeoutSeconds" id="@cdklabs/cdk-ssm-documents.CreateImageStep.property.timeoutSeconds"></a>
4706
4706
 
4707
4707
  ```typescript
4708
- public readonly onFailure: AutomationStep;
4708
+ public readonly timeoutSeconds: number;
4709
4709
  ```
4710
4710
 
4711
- - *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
4711
+ - *Type:* number
4712
4712
 
4713
4713
  ---
4714
4714
 
@@ -4950,9 +4950,9 @@ Any object.
4950
4950
  | <code><a href="#@cdklabs/cdk-ssm-documents.CreateStackStep.property.description">description</a></code> | <code>string</code> | *No description.* |
4951
4951
  | <code><a href="#@cdklabs/cdk-ssm-documents.CreateStackStep.property.isEnd">isEnd</a></code> | <code>boolean</code> | *No description.* |
4952
4952
  | <code><a href="#@cdklabs/cdk-ssm-documents.CreateStackStep.property.maxAttempts">maxAttempts</a></code> | <code>number</code> | *No description.* |
4953
+ | <code><a href="#@cdklabs/cdk-ssm-documents.CreateStackStep.property.onCancel">onCancel</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a></code> | *No description.* |
4954
+ | <code><a href="#@cdklabs/cdk-ssm-documents.CreateStackStep.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a></code> | *No description.* |
4953
4955
  | <code><a href="#@cdklabs/cdk-ssm-documents.CreateStackStep.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</code> | *No description.* |
4954
- | <code><a href="#@cdklabs/cdk-ssm-documents.CreateStackStep.property.onCancel">onCancel</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | *No description.* |
4955
- | <code><a href="#@cdklabs/cdk-ssm-documents.CreateStackStep.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | *No description.* |
4956
4956
  | <code><a href="#@cdklabs/cdk-ssm-documents.CreateStackStep.property.allStepsInExecution">allStepsInExecution</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>[]</code> | *No description.* |
4957
4957
  | <code><a href="#@cdklabs/cdk-ssm-documents.CreateStackStep.property.nextStep">nextStep</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | *No description.* |
4958
4958
  | <code><a href="#@cdklabs/cdk-ssm-documents.CreateStackStep.property.stackName">stackName</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.IStringVariable">IStringVariable</a></code> | *No description.* |
@@ -5054,33 +5054,33 @@ public readonly maxAttempts: number;
5054
5054
 
5055
5055
  ---
5056
5056
 
5057
- ##### `timeoutSeconds`<sup>Required</sup> <a name="timeoutSeconds" id="@cdklabs/cdk-ssm-documents.CreateStackStep.property.timeoutSeconds"></a>
5057
+ ##### `onCancel`<sup>Required</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.CreateStackStep.property.onCancel"></a>
5058
5058
 
5059
5059
  ```typescript
5060
- public readonly timeoutSeconds: number;
5060
+ public readonly onCancel: OnCancel;
5061
5061
  ```
5062
5062
 
5063
- - *Type:* number
5063
+ - *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a>
5064
5064
 
5065
5065
  ---
5066
5066
 
5067
- ##### `onCancel`<sup>Optional</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.CreateStackStep.property.onCancel"></a>
5067
+ ##### `onFailure`<sup>Required</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.CreateStackStep.property.onFailure"></a>
5068
5068
 
5069
5069
  ```typescript
5070
- public readonly onCancel: AutomationStep;
5070
+ public readonly onFailure: OnFailure;
5071
5071
  ```
5072
5072
 
5073
- - *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
5073
+ - *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a>
5074
5074
 
5075
5075
  ---
5076
5076
 
5077
- ##### `onFailure`<sup>Optional</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.CreateStackStep.property.onFailure"></a>
5077
+ ##### `timeoutSeconds`<sup>Required</sup> <a name="timeoutSeconds" id="@cdklabs/cdk-ssm-documents.CreateStackStep.property.timeoutSeconds"></a>
5078
5078
 
5079
5079
  ```typescript
5080
- public readonly onFailure: AutomationStep;
5080
+ public readonly timeoutSeconds: number;
5081
5081
  ```
5082
5082
 
5083
- - *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
5083
+ - *Type:* number
5084
5084
 
5085
5085
  ---
5086
5086
 
@@ -5412,9 +5412,9 @@ Any object.
5412
5412
  | <code><a href="#@cdklabs/cdk-ssm-documents.CreateTagsStep.property.description">description</a></code> | <code>string</code> | *No description.* |
5413
5413
  | <code><a href="#@cdklabs/cdk-ssm-documents.CreateTagsStep.property.isEnd">isEnd</a></code> | <code>boolean</code> | *No description.* |
5414
5414
  | <code><a href="#@cdklabs/cdk-ssm-documents.CreateTagsStep.property.maxAttempts">maxAttempts</a></code> | <code>number</code> | *No description.* |
5415
+ | <code><a href="#@cdklabs/cdk-ssm-documents.CreateTagsStep.property.onCancel">onCancel</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a></code> | *No description.* |
5416
+ | <code><a href="#@cdklabs/cdk-ssm-documents.CreateTagsStep.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a></code> | *No description.* |
5415
5417
  | <code><a href="#@cdklabs/cdk-ssm-documents.CreateTagsStep.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</code> | *No description.* |
5416
- | <code><a href="#@cdklabs/cdk-ssm-documents.CreateTagsStep.property.onCancel">onCancel</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | *No description.* |
5417
- | <code><a href="#@cdklabs/cdk-ssm-documents.CreateTagsStep.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | *No description.* |
5418
5418
  | <code><a href="#@cdklabs/cdk-ssm-documents.CreateTagsStep.property.allStepsInExecution">allStepsInExecution</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>[]</code> | *No description.* |
5419
5419
  | <code><a href="#@cdklabs/cdk-ssm-documents.CreateTagsStep.property.nextStep">nextStep</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | *No description.* |
5420
5420
  | <code><a href="#@cdklabs/cdk-ssm-documents.CreateTagsStep.property.resourceIds">resourceIds</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.IStringListVariable">IStringListVariable</a></code> | *No description.* |
@@ -5505,33 +5505,33 @@ public readonly maxAttempts: number;
5505
5505
 
5506
5506
  ---
5507
5507
 
5508
- ##### `timeoutSeconds`<sup>Required</sup> <a name="timeoutSeconds" id="@cdklabs/cdk-ssm-documents.CreateTagsStep.property.timeoutSeconds"></a>
5508
+ ##### `onCancel`<sup>Required</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.CreateTagsStep.property.onCancel"></a>
5509
5509
 
5510
5510
  ```typescript
5511
- public readonly timeoutSeconds: number;
5511
+ public readonly onCancel: OnCancel;
5512
5512
  ```
5513
5513
 
5514
- - *Type:* number
5514
+ - *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a>
5515
5515
 
5516
5516
  ---
5517
5517
 
5518
- ##### `onCancel`<sup>Optional</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.CreateTagsStep.property.onCancel"></a>
5518
+ ##### `onFailure`<sup>Required</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.CreateTagsStep.property.onFailure"></a>
5519
5519
 
5520
5520
  ```typescript
5521
- public readonly onCancel: AutomationStep;
5521
+ public readonly onFailure: OnFailure;
5522
5522
  ```
5523
5523
 
5524
- - *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
5524
+ - *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a>
5525
5525
 
5526
5526
  ---
5527
5527
 
5528
- ##### `onFailure`<sup>Optional</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.CreateTagsStep.property.onFailure"></a>
5528
+ ##### `timeoutSeconds`<sup>Required</sup> <a name="timeoutSeconds" id="@cdklabs/cdk-ssm-documents.CreateTagsStep.property.timeoutSeconds"></a>
5529
5529
 
5530
5530
  ```typescript
5531
- public readonly onFailure: AutomationStep;
5531
+ public readonly timeoutSeconds: number;
5532
5532
  ```
5533
5533
 
5534
- - *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
5534
+ - *Type:* number
5535
5535
 
5536
5536
  ---
5537
5537
 
@@ -5753,9 +5753,9 @@ Any object.
5753
5753
  | <code><a href="#@cdklabs/cdk-ssm-documents.DeleteImageStep.property.description">description</a></code> | <code>string</code> | *No description.* |
5754
5754
  | <code><a href="#@cdklabs/cdk-ssm-documents.DeleteImageStep.property.isEnd">isEnd</a></code> | <code>boolean</code> | *No description.* |
5755
5755
  | <code><a href="#@cdklabs/cdk-ssm-documents.DeleteImageStep.property.maxAttempts">maxAttempts</a></code> | <code>number</code> | *No description.* |
5756
+ | <code><a href="#@cdklabs/cdk-ssm-documents.DeleteImageStep.property.onCancel">onCancel</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a></code> | *No description.* |
5757
+ | <code><a href="#@cdklabs/cdk-ssm-documents.DeleteImageStep.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a></code> | *No description.* |
5756
5758
  | <code><a href="#@cdklabs/cdk-ssm-documents.DeleteImageStep.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</code> | *No description.* |
5757
- | <code><a href="#@cdklabs/cdk-ssm-documents.DeleteImageStep.property.onCancel">onCancel</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | *No description.* |
5758
- | <code><a href="#@cdklabs/cdk-ssm-documents.DeleteImageStep.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | *No description.* |
5759
5759
  | <code><a href="#@cdklabs/cdk-ssm-documents.DeleteImageStep.property.allStepsInExecution">allStepsInExecution</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>[]</code> | *No description.* |
5760
5760
  | <code><a href="#@cdklabs/cdk-ssm-documents.DeleteImageStep.property.nextStep">nextStep</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | *No description.* |
5761
5761
  | <code><a href="#@cdklabs/cdk-ssm-documents.DeleteImageStep.property.imageId">imageId</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.IStringVariable">IStringVariable</a></code> | *No description.* |
@@ -5844,33 +5844,33 @@ public readonly maxAttempts: number;
5844
5844
 
5845
5845
  ---
5846
5846
 
5847
- ##### `timeoutSeconds`<sup>Required</sup> <a name="timeoutSeconds" id="@cdklabs/cdk-ssm-documents.DeleteImageStep.property.timeoutSeconds"></a>
5847
+ ##### `onCancel`<sup>Required</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.DeleteImageStep.property.onCancel"></a>
5848
5848
 
5849
5849
  ```typescript
5850
- public readonly timeoutSeconds: number;
5850
+ public readonly onCancel: OnCancel;
5851
5851
  ```
5852
5852
 
5853
- - *Type:* number
5853
+ - *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a>
5854
5854
 
5855
5855
  ---
5856
5856
 
5857
- ##### `onCancel`<sup>Optional</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.DeleteImageStep.property.onCancel"></a>
5857
+ ##### `onFailure`<sup>Required</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.DeleteImageStep.property.onFailure"></a>
5858
5858
 
5859
5859
  ```typescript
5860
- public readonly onCancel: AutomationStep;
5860
+ public readonly onFailure: OnFailure;
5861
5861
  ```
5862
5862
 
5863
- - *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
5863
+ - *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a>
5864
5864
 
5865
5865
  ---
5866
5866
 
5867
- ##### `onFailure`<sup>Optional</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.DeleteImageStep.property.onFailure"></a>
5867
+ ##### `timeoutSeconds`<sup>Required</sup> <a name="timeoutSeconds" id="@cdklabs/cdk-ssm-documents.DeleteImageStep.property.timeoutSeconds"></a>
5868
5868
 
5869
5869
  ```typescript
5870
- public readonly onFailure: AutomationStep;
5870
+ public readonly timeoutSeconds: number;
5871
5871
  ```
5872
5872
 
5873
- - *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
5873
+ - *Type:* number
5874
5874
 
5875
5875
  ---
5876
5876
 
@@ -6072,9 +6072,9 @@ Any object.
6072
6072
  | <code><a href="#@cdklabs/cdk-ssm-documents.DeleteStackStep.property.description">description</a></code> | <code>string</code> | *No description.* |
6073
6073
  | <code><a href="#@cdklabs/cdk-ssm-documents.DeleteStackStep.property.isEnd">isEnd</a></code> | <code>boolean</code> | *No description.* |
6074
6074
  | <code><a href="#@cdklabs/cdk-ssm-documents.DeleteStackStep.property.maxAttempts">maxAttempts</a></code> | <code>number</code> | *No description.* |
6075
+ | <code><a href="#@cdklabs/cdk-ssm-documents.DeleteStackStep.property.onCancel">onCancel</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a></code> | *No description.* |
6076
+ | <code><a href="#@cdklabs/cdk-ssm-documents.DeleteStackStep.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a></code> | *No description.* |
6075
6077
  | <code><a href="#@cdklabs/cdk-ssm-documents.DeleteStackStep.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</code> | *No description.* |
6076
- | <code><a href="#@cdklabs/cdk-ssm-documents.DeleteStackStep.property.onCancel">onCancel</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | *No description.* |
6077
- | <code><a href="#@cdklabs/cdk-ssm-documents.DeleteStackStep.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | *No description.* |
6078
6078
  | <code><a href="#@cdklabs/cdk-ssm-documents.DeleteStackStep.property.allStepsInExecution">allStepsInExecution</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>[]</code> | *No description.* |
6079
6079
  | <code><a href="#@cdklabs/cdk-ssm-documents.DeleteStackStep.property.nextStep">nextStep</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | *No description.* |
6080
6080
  | <code><a href="#@cdklabs/cdk-ssm-documents.DeleteStackStep.property.stackNameVariable">stackNameVariable</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.IStringVariable">IStringVariable</a></code> | *No description.* |
@@ -6164,33 +6164,33 @@ public readonly maxAttempts: number;
6164
6164
 
6165
6165
  ---
6166
6166
 
6167
- ##### `timeoutSeconds`<sup>Required</sup> <a name="timeoutSeconds" id="@cdklabs/cdk-ssm-documents.DeleteStackStep.property.timeoutSeconds"></a>
6167
+ ##### `onCancel`<sup>Required</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.DeleteStackStep.property.onCancel"></a>
6168
6168
 
6169
6169
  ```typescript
6170
- public readonly timeoutSeconds: number;
6170
+ public readonly onCancel: OnCancel;
6171
6171
  ```
6172
6172
 
6173
- - *Type:* number
6173
+ - *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a>
6174
6174
 
6175
6175
  ---
6176
6176
 
6177
- ##### `onCancel`<sup>Optional</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.DeleteStackStep.property.onCancel"></a>
6177
+ ##### `onFailure`<sup>Required</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.DeleteStackStep.property.onFailure"></a>
6178
6178
 
6179
6179
  ```typescript
6180
- public readonly onCancel: AutomationStep;
6180
+ public readonly onFailure: OnFailure;
6181
6181
  ```
6182
6182
 
6183
- - *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
6183
+ - *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a>
6184
6184
 
6185
6185
  ---
6186
6186
 
6187
- ##### `onFailure`<sup>Optional</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.DeleteStackStep.property.onFailure"></a>
6187
+ ##### `timeoutSeconds`<sup>Required</sup> <a name="timeoutSeconds" id="@cdklabs/cdk-ssm-documents.DeleteStackStep.property.timeoutSeconds"></a>
6188
6188
 
6189
6189
  ```typescript
6190
- public readonly onFailure: AutomationStep;
6190
+ public readonly timeoutSeconds: number;
6191
6191
  ```
6192
6192
 
6193
- - *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
6193
+ - *Type:* number
6194
6194
 
6195
6195
  ---
6196
6196
 
@@ -7050,9 +7050,9 @@ Any object.
7050
7050
  | <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteAutomationStep.property.description">description</a></code> | <code>string</code> | *No description.* |
7051
7051
  | <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteAutomationStep.property.isEnd">isEnd</a></code> | <code>boolean</code> | *No description.* |
7052
7052
  | <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteAutomationStep.property.maxAttempts">maxAttempts</a></code> | <code>number</code> | *No description.* |
7053
+ | <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteAutomationStep.property.onCancel">onCancel</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a></code> | *No description.* |
7054
+ | <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteAutomationStep.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a></code> | *No description.* |
7053
7055
  | <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteAutomationStep.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</code> | *No description.* |
7054
- | <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteAutomationStep.property.onCancel">onCancel</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | *No description.* |
7055
- | <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteAutomationStep.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | *No description.* |
7056
7056
  | <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteAutomationStep.property.allStepsInExecution">allStepsInExecution</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>[]</code> | *No description.* |
7057
7057
  | <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteAutomationStep.property.nextStep">nextStep</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | *No description.* |
7058
7058
  | <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteAutomationStep.property.documentName">documentName</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.IStringVariable">IStringVariable</a></code> | *No description.* |
@@ -7150,33 +7150,33 @@ public readonly maxAttempts: number;
7150
7150
 
7151
7151
  ---
7152
7152
 
7153
- ##### `timeoutSeconds`<sup>Required</sup> <a name="timeoutSeconds" id="@cdklabs/cdk-ssm-documents.ExecuteAutomationStep.property.timeoutSeconds"></a>
7153
+ ##### `onCancel`<sup>Required</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.ExecuteAutomationStep.property.onCancel"></a>
7154
7154
 
7155
7155
  ```typescript
7156
- public readonly timeoutSeconds: number;
7156
+ public readonly onCancel: OnCancel;
7157
7157
  ```
7158
7158
 
7159
- - *Type:* number
7159
+ - *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a>
7160
7160
 
7161
7161
  ---
7162
7162
 
7163
- ##### `onCancel`<sup>Optional</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.ExecuteAutomationStep.property.onCancel"></a>
7163
+ ##### `onFailure`<sup>Required</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.ExecuteAutomationStep.property.onFailure"></a>
7164
7164
 
7165
7165
  ```typescript
7166
- public readonly onCancel: AutomationStep;
7166
+ public readonly onFailure: OnFailure;
7167
7167
  ```
7168
7168
 
7169
- - *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
7169
+ - *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a>
7170
7170
 
7171
7171
  ---
7172
7172
 
7173
- ##### `onFailure`<sup>Optional</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.ExecuteAutomationStep.property.onFailure"></a>
7173
+ ##### `timeoutSeconds`<sup>Required</sup> <a name="timeoutSeconds" id="@cdklabs/cdk-ssm-documents.ExecuteAutomationStep.property.timeoutSeconds"></a>
7174
7174
 
7175
7175
  ```typescript
7176
- public readonly onFailure: AutomationStep;
7176
+ public readonly timeoutSeconds: number;
7177
7177
  ```
7178
7178
 
7179
- - *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
7179
+ - *Type:* number
7180
7180
 
7181
7181
  ---
7182
7182
 
@@ -7483,9 +7483,9 @@ ExecuteScriptStep.getLanguage(runtime: string)
7483
7483
  | <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteScriptStep.property.description">description</a></code> | <code>string</code> | *No description.* |
7484
7484
  | <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteScriptStep.property.isEnd">isEnd</a></code> | <code>boolean</code> | *No description.* |
7485
7485
  | <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteScriptStep.property.maxAttempts">maxAttempts</a></code> | <code>number</code> | *No description.* |
7486
+ | <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteScriptStep.property.onCancel">onCancel</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a></code> | *No description.* |
7487
+ | <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteScriptStep.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a></code> | *No description.* |
7486
7488
  | <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteScriptStep.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</code> | *No description.* |
7487
- | <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteScriptStep.property.onCancel">onCancel</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | *No description.* |
7488
- | <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteScriptStep.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | *No description.* |
7489
7489
  | <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteScriptStep.property.allStepsInExecution">allStepsInExecution</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>[]</code> | *No description.* |
7490
7490
  | <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteScriptStep.property.nextStep">nextStep</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | *No description.* |
7491
7491
  | <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteScriptStep.property.fullPathToCode">fullPathToCode</a></code> | <code>string</code> | *No description.* |
@@ -7578,33 +7578,33 @@ public readonly maxAttempts: number;
7578
7578
 
7579
7579
  ---
7580
7580
 
7581
- ##### `timeoutSeconds`<sup>Required</sup> <a name="timeoutSeconds" id="@cdklabs/cdk-ssm-documents.ExecuteScriptStep.property.timeoutSeconds"></a>
7581
+ ##### `onCancel`<sup>Required</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.ExecuteScriptStep.property.onCancel"></a>
7582
7582
 
7583
7583
  ```typescript
7584
- public readonly timeoutSeconds: number;
7584
+ public readonly onCancel: OnCancel;
7585
7585
  ```
7586
7586
 
7587
- - *Type:* number
7587
+ - *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a>
7588
7588
 
7589
7589
  ---
7590
7590
 
7591
- ##### `onCancel`<sup>Optional</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.ExecuteScriptStep.property.onCancel"></a>
7591
+ ##### `onFailure`<sup>Required</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.ExecuteScriptStep.property.onFailure"></a>
7592
7592
 
7593
7593
  ```typescript
7594
- public readonly onCancel: AutomationStep;
7594
+ public readonly onFailure: OnFailure;
7595
7595
  ```
7596
7596
 
7597
- - *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
7597
+ - *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a>
7598
7598
 
7599
7599
  ---
7600
7600
 
7601
- ##### `onFailure`<sup>Optional</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.ExecuteScriptStep.property.onFailure"></a>
7601
+ ##### `timeoutSeconds`<sup>Required</sup> <a name="timeoutSeconds" id="@cdklabs/cdk-ssm-documents.ExecuteScriptStep.property.timeoutSeconds"></a>
7602
7602
 
7603
7603
  ```typescript
7604
- public readonly onFailure: AutomationStep;
7604
+ public readonly timeoutSeconds: number;
7605
7605
  ```
7606
7606
 
7607
- - *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
7607
+ - *Type:* number
7608
7608
 
7609
7609
  ---
7610
7610
 
@@ -7846,9 +7846,9 @@ Any object.
7846
7846
  | <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteStateMachineStep.property.description">description</a></code> | <code>string</code> | *No description.* |
7847
7847
  | <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteStateMachineStep.property.isEnd">isEnd</a></code> | <code>boolean</code> | *No description.* |
7848
7848
  | <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteStateMachineStep.property.maxAttempts">maxAttempts</a></code> | <code>number</code> | *No description.* |
7849
+ | <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteStateMachineStep.property.onCancel">onCancel</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a></code> | *No description.* |
7850
+ | <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteStateMachineStep.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a></code> | *No description.* |
7849
7851
  | <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteStateMachineStep.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</code> | *No description.* |
7850
- | <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteStateMachineStep.property.onCancel">onCancel</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | *No description.* |
7851
- | <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteStateMachineStep.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | *No description.* |
7852
7852
  | <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteStateMachineStep.property.allStepsInExecution">allStepsInExecution</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>[]</code> | *No description.* |
7853
7853
  | <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteStateMachineStep.property.nextStep">nextStep</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | *No description.* |
7854
7854
  | <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteStateMachineStep.property.stateMachineArn">stateMachineArn</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.IStringVariable">IStringVariable</a></code> | *No description.* |
@@ -7939,33 +7939,33 @@ public readonly maxAttempts: number;
7939
7939
 
7940
7940
  ---
7941
7941
 
7942
- ##### `timeoutSeconds`<sup>Required</sup> <a name="timeoutSeconds" id="@cdklabs/cdk-ssm-documents.ExecuteStateMachineStep.property.timeoutSeconds"></a>
7942
+ ##### `onCancel`<sup>Required</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.ExecuteStateMachineStep.property.onCancel"></a>
7943
7943
 
7944
7944
  ```typescript
7945
- public readonly timeoutSeconds: number;
7945
+ public readonly onCancel: OnCancel;
7946
7946
  ```
7947
7947
 
7948
- - *Type:* number
7948
+ - *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a>
7949
7949
 
7950
7950
  ---
7951
7951
 
7952
- ##### `onCancel`<sup>Optional</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.ExecuteStateMachineStep.property.onCancel"></a>
7952
+ ##### `onFailure`<sup>Required</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.ExecuteStateMachineStep.property.onFailure"></a>
7953
7953
 
7954
7954
  ```typescript
7955
- public readonly onCancel: AutomationStep;
7955
+ public readonly onFailure: OnFailure;
7956
7956
  ```
7957
7957
 
7958
- - *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
7958
+ - *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a>
7959
7959
 
7960
7960
  ---
7961
7961
 
7962
- ##### `onFailure`<sup>Optional</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.ExecuteStateMachineStep.property.onFailure"></a>
7962
+ ##### `timeoutSeconds`<sup>Required</sup> <a name="timeoutSeconds" id="@cdklabs/cdk-ssm-documents.ExecuteStateMachineStep.property.timeoutSeconds"></a>
7963
7963
 
7964
7964
  ```typescript
7965
- public readonly onFailure: AutomationStep;
7965
+ public readonly timeoutSeconds: number;
7966
7966
  ```
7967
7967
 
7968
- - *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
7968
+ - *Type:* number
7969
7969
 
7970
7970
  ---
7971
7971
 
@@ -8933,9 +8933,9 @@ Any object.
8933
8933
  | <code><a href="#@cdklabs/cdk-ssm-documents.InvokeLambdaFunctionStep.property.description">description</a></code> | <code>string</code> | *No description.* |
8934
8934
  | <code><a href="#@cdklabs/cdk-ssm-documents.InvokeLambdaFunctionStep.property.isEnd">isEnd</a></code> | <code>boolean</code> | *No description.* |
8935
8935
  | <code><a href="#@cdklabs/cdk-ssm-documents.InvokeLambdaFunctionStep.property.maxAttempts">maxAttempts</a></code> | <code>number</code> | *No description.* |
8936
+ | <code><a href="#@cdklabs/cdk-ssm-documents.InvokeLambdaFunctionStep.property.onCancel">onCancel</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a></code> | *No description.* |
8937
+ | <code><a href="#@cdklabs/cdk-ssm-documents.InvokeLambdaFunctionStep.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a></code> | *No description.* |
8936
8938
  | <code><a href="#@cdklabs/cdk-ssm-documents.InvokeLambdaFunctionStep.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</code> | *No description.* |
8937
- | <code><a href="#@cdklabs/cdk-ssm-documents.InvokeLambdaFunctionStep.property.onCancel">onCancel</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | *No description.* |
8938
- | <code><a href="#@cdklabs/cdk-ssm-documents.InvokeLambdaFunctionStep.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | *No description.* |
8939
8939
  | <code><a href="#@cdklabs/cdk-ssm-documents.InvokeLambdaFunctionStep.property.allStepsInExecution">allStepsInExecution</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>[]</code> | *No description.* |
8940
8940
  | <code><a href="#@cdklabs/cdk-ssm-documents.InvokeLambdaFunctionStep.property.nextStep">nextStep</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | *No description.* |
8941
8941
  | <code><a href="#@cdklabs/cdk-ssm-documents.InvokeLambdaFunctionStep.property.functionName">functionName</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.IStringVariable">IStringVariable</a></code> | *No description.* |
@@ -9030,33 +9030,33 @@ public readonly maxAttempts: number;
9030
9030
 
9031
9031
  ---
9032
9032
 
9033
- ##### `timeoutSeconds`<sup>Required</sup> <a name="timeoutSeconds" id="@cdklabs/cdk-ssm-documents.InvokeLambdaFunctionStep.property.timeoutSeconds"></a>
9033
+ ##### `onCancel`<sup>Required</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.InvokeLambdaFunctionStep.property.onCancel"></a>
9034
9034
 
9035
9035
  ```typescript
9036
- public readonly timeoutSeconds: number;
9036
+ public readonly onCancel: OnCancel;
9037
9037
  ```
9038
9038
 
9039
- - *Type:* number
9039
+ - *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a>
9040
9040
 
9041
9041
  ---
9042
9042
 
9043
- ##### `onCancel`<sup>Optional</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.InvokeLambdaFunctionStep.property.onCancel"></a>
9043
+ ##### `onFailure`<sup>Required</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.InvokeLambdaFunctionStep.property.onFailure"></a>
9044
9044
 
9045
9045
  ```typescript
9046
- public readonly onCancel: AutomationStep;
9046
+ public readonly onFailure: OnFailure;
9047
9047
  ```
9048
9048
 
9049
- - *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
9049
+ - *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a>
9050
9050
 
9051
9051
  ---
9052
9052
 
9053
- ##### `onFailure`<sup>Optional</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.InvokeLambdaFunctionStep.property.onFailure"></a>
9053
+ ##### `timeoutSeconds`<sup>Required</sup> <a name="timeoutSeconds" id="@cdklabs/cdk-ssm-documents.InvokeLambdaFunctionStep.property.timeoutSeconds"></a>
9054
9054
 
9055
9055
  ```typescript
9056
- public readonly onFailure: AutomationStep;
9056
+ public readonly timeoutSeconds: number;
9057
9057
  ```
9058
9058
 
9059
- - *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
9059
+ - *Type:* number
9060
9060
 
9061
9061
  ---
9062
9062
 
@@ -9318,9 +9318,9 @@ Any object.
9318
9318
  | <code><a href="#@cdklabs/cdk-ssm-documents.InvokeWebhookStep.property.description">description</a></code> | <code>string</code> | *No description.* |
9319
9319
  | <code><a href="#@cdklabs/cdk-ssm-documents.InvokeWebhookStep.property.isEnd">isEnd</a></code> | <code>boolean</code> | *No description.* |
9320
9320
  | <code><a href="#@cdklabs/cdk-ssm-documents.InvokeWebhookStep.property.maxAttempts">maxAttempts</a></code> | <code>number</code> | *No description.* |
9321
+ | <code><a href="#@cdklabs/cdk-ssm-documents.InvokeWebhookStep.property.onCancel">onCancel</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a></code> | *No description.* |
9322
+ | <code><a href="#@cdklabs/cdk-ssm-documents.InvokeWebhookStep.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a></code> | *No description.* |
9321
9323
  | <code><a href="#@cdklabs/cdk-ssm-documents.InvokeWebhookStep.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</code> | *No description.* |
9322
- | <code><a href="#@cdklabs/cdk-ssm-documents.InvokeWebhookStep.property.onCancel">onCancel</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | *No description.* |
9323
- | <code><a href="#@cdklabs/cdk-ssm-documents.InvokeWebhookStep.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | *No description.* |
9324
9324
  | <code><a href="#@cdklabs/cdk-ssm-documents.InvokeWebhookStep.property.allStepsInExecution">allStepsInExecution</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>[]</code> | *No description.* |
9325
9325
  | <code><a href="#@cdklabs/cdk-ssm-documents.InvokeWebhookStep.property.nextStep">nextStep</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | *No description.* |
9326
9326
  | <code><a href="#@cdklabs/cdk-ssm-documents.InvokeWebhookStep.property.integrationName">integrationName</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.IStringVariable">IStringVariable</a></code> | *No description.* |
@@ -9410,33 +9410,33 @@ public readonly maxAttempts: number;
9410
9410
 
9411
9411
  ---
9412
9412
 
9413
- ##### `timeoutSeconds`<sup>Required</sup> <a name="timeoutSeconds" id="@cdklabs/cdk-ssm-documents.InvokeWebhookStep.property.timeoutSeconds"></a>
9413
+ ##### `onCancel`<sup>Required</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.InvokeWebhookStep.property.onCancel"></a>
9414
9414
 
9415
9415
  ```typescript
9416
- public readonly timeoutSeconds: number;
9416
+ public readonly onCancel: OnCancel;
9417
9417
  ```
9418
9418
 
9419
- - *Type:* number
9419
+ - *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a>
9420
9420
 
9421
9421
  ---
9422
9422
 
9423
- ##### `onCancel`<sup>Optional</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.InvokeWebhookStep.property.onCancel"></a>
9423
+ ##### `onFailure`<sup>Required</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.InvokeWebhookStep.property.onFailure"></a>
9424
9424
 
9425
9425
  ```typescript
9426
- public readonly onCancel: AutomationStep;
9426
+ public readonly onFailure: OnFailure;
9427
9427
  ```
9428
9428
 
9429
- - *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
9429
+ - *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a>
9430
9430
 
9431
9431
  ---
9432
9432
 
9433
- ##### `onFailure`<sup>Optional</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.InvokeWebhookStep.property.onFailure"></a>
9433
+ ##### `timeoutSeconds`<sup>Required</sup> <a name="timeoutSeconds" id="@cdklabs/cdk-ssm-documents.InvokeWebhookStep.property.timeoutSeconds"></a>
9434
9434
 
9435
9435
  ```typescript
9436
- public readonly onFailure: AutomationStep;
9436
+ public readonly timeoutSeconds: number;
9437
9437
  ```
9438
9438
 
9439
- - *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
9439
+ - *Type:* number
9440
9440
 
9441
9441
  ---
9442
9442
 
@@ -9648,9 +9648,9 @@ Any object.
9648
9648
  | <code><a href="#@cdklabs/cdk-ssm-documents.PauseStep.property.description">description</a></code> | <code>string</code> | *No description.* |
9649
9649
  | <code><a href="#@cdklabs/cdk-ssm-documents.PauseStep.property.isEnd">isEnd</a></code> | <code>boolean</code> | *No description.* |
9650
9650
  | <code><a href="#@cdklabs/cdk-ssm-documents.PauseStep.property.maxAttempts">maxAttempts</a></code> | <code>number</code> | *No description.* |
9651
+ | <code><a href="#@cdklabs/cdk-ssm-documents.PauseStep.property.onCancel">onCancel</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a></code> | *No description.* |
9652
+ | <code><a href="#@cdklabs/cdk-ssm-documents.PauseStep.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a></code> | *No description.* |
9651
9653
  | <code><a href="#@cdklabs/cdk-ssm-documents.PauseStep.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</code> | *No description.* |
9652
- | <code><a href="#@cdklabs/cdk-ssm-documents.PauseStep.property.onCancel">onCancel</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | *No description.* |
9653
- | <code><a href="#@cdklabs/cdk-ssm-documents.PauseStep.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | *No description.* |
9654
9654
  | <code><a href="#@cdklabs/cdk-ssm-documents.PauseStep.property.allStepsInExecution">allStepsInExecution</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>[]</code> | *No description.* |
9655
9655
  | <code><a href="#@cdklabs/cdk-ssm-documents.PauseStep.property.nextStep">nextStep</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | *No description.* |
9656
9656
 
@@ -9738,33 +9738,33 @@ public readonly maxAttempts: number;
9738
9738
 
9739
9739
  ---
9740
9740
 
9741
- ##### `timeoutSeconds`<sup>Required</sup> <a name="timeoutSeconds" id="@cdklabs/cdk-ssm-documents.PauseStep.property.timeoutSeconds"></a>
9741
+ ##### `onCancel`<sup>Required</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.PauseStep.property.onCancel"></a>
9742
9742
 
9743
9743
  ```typescript
9744
- public readonly timeoutSeconds: number;
9744
+ public readonly onCancel: OnCancel;
9745
9745
  ```
9746
9746
 
9747
- - *Type:* number
9747
+ - *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a>
9748
9748
 
9749
9749
  ---
9750
9750
 
9751
- ##### `onCancel`<sup>Optional</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.PauseStep.property.onCancel"></a>
9751
+ ##### `onFailure`<sup>Required</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.PauseStep.property.onFailure"></a>
9752
9752
 
9753
9753
  ```typescript
9754
- public readonly onCancel: AutomationStep;
9754
+ public readonly onFailure: OnFailure;
9755
9755
  ```
9756
9756
 
9757
- - *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
9757
+ - *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a>
9758
9758
 
9759
9759
  ---
9760
9760
 
9761
- ##### `onFailure`<sup>Optional</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.PauseStep.property.onFailure"></a>
9761
+ ##### `timeoutSeconds`<sup>Required</sup> <a name="timeoutSeconds" id="@cdklabs/cdk-ssm-documents.PauseStep.property.timeoutSeconds"></a>
9762
9762
 
9763
9763
  ```typescript
9764
- public readonly onFailure: AutomationStep;
9764
+ public readonly timeoutSeconds: number;
9765
9765
  ```
9766
9766
 
9767
- - *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
9767
+ - *Type:* number
9768
9768
 
9769
9769
  ---
9770
9770
 
@@ -10436,9 +10436,9 @@ Any object.
10436
10436
  | <code><a href="#@cdklabs/cdk-ssm-documents.RunCommandStep.property.description">description</a></code> | <code>string</code> | *No description.* |
10437
10437
  | <code><a href="#@cdklabs/cdk-ssm-documents.RunCommandStep.property.isEnd">isEnd</a></code> | <code>boolean</code> | *No description.* |
10438
10438
  | <code><a href="#@cdklabs/cdk-ssm-documents.RunCommandStep.property.maxAttempts">maxAttempts</a></code> | <code>number</code> | *No description.* |
10439
+ | <code><a href="#@cdklabs/cdk-ssm-documents.RunCommandStep.property.onCancel">onCancel</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a></code> | *No description.* |
10440
+ | <code><a href="#@cdklabs/cdk-ssm-documents.RunCommandStep.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a></code> | *No description.* |
10439
10441
  | <code><a href="#@cdklabs/cdk-ssm-documents.RunCommandStep.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</code> | *No description.* |
10440
- | <code><a href="#@cdklabs/cdk-ssm-documents.RunCommandStep.property.onCancel">onCancel</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | *No description.* |
10441
- | <code><a href="#@cdklabs/cdk-ssm-documents.RunCommandStep.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | *No description.* |
10442
10442
  | <code><a href="#@cdklabs/cdk-ssm-documents.RunCommandStep.property.allStepsInExecution">allStepsInExecution</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>[]</code> | *No description.* |
10443
10443
  | <code><a href="#@cdklabs/cdk-ssm-documents.RunCommandStep.property.nextStep">nextStep</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | *No description.* |
10444
10444
  | <code><a href="#@cdklabs/cdk-ssm-documents.RunCommandStep.property.documentName">documentName</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.IStringVariable">IStringVariable</a></code> | *No description.* |
@@ -10540,33 +10540,33 @@ public readonly maxAttempts: number;
10540
10540
 
10541
10541
  ---
10542
10542
 
10543
- ##### `timeoutSeconds`<sup>Required</sup> <a name="timeoutSeconds" id="@cdklabs/cdk-ssm-documents.RunCommandStep.property.timeoutSeconds"></a>
10543
+ ##### `onCancel`<sup>Required</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.RunCommandStep.property.onCancel"></a>
10544
10544
 
10545
10545
  ```typescript
10546
- public readonly timeoutSeconds: number;
10546
+ public readonly onCancel: OnCancel;
10547
10547
  ```
10548
10548
 
10549
- - *Type:* number
10549
+ - *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a>
10550
10550
 
10551
10551
  ---
10552
10552
 
10553
- ##### `onCancel`<sup>Optional</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.RunCommandStep.property.onCancel"></a>
10553
+ ##### `onFailure`<sup>Required</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.RunCommandStep.property.onFailure"></a>
10554
10554
 
10555
10555
  ```typescript
10556
- public readonly onCancel: AutomationStep;
10556
+ public readonly onFailure: OnFailure;
10557
10557
  ```
10558
10558
 
10559
- - *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
10559
+ - *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a>
10560
10560
 
10561
10561
  ---
10562
10562
 
10563
- ##### `onFailure`<sup>Optional</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.RunCommandStep.property.onFailure"></a>
10563
+ ##### `timeoutSeconds`<sup>Required</sup> <a name="timeoutSeconds" id="@cdklabs/cdk-ssm-documents.RunCommandStep.property.timeoutSeconds"></a>
10564
10564
 
10565
10565
  ```typescript
10566
- public readonly onFailure: AutomationStep;
10566
+ public readonly timeoutSeconds: number;
10567
10567
  ```
10568
10568
 
10569
- - *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
10569
+ - *Type:* number
10570
10570
 
10571
10571
  ---
10572
10572
 
@@ -11612,9 +11612,9 @@ Any object.
11612
11612
  | <code><a href="#@cdklabs/cdk-ssm-documents.RunInstanceStep.property.description">description</a></code> | <code>string</code> | *No description.* |
11613
11613
  | <code><a href="#@cdklabs/cdk-ssm-documents.RunInstanceStep.property.isEnd">isEnd</a></code> | <code>boolean</code> | *No description.* |
11614
11614
  | <code><a href="#@cdklabs/cdk-ssm-documents.RunInstanceStep.property.maxAttempts">maxAttempts</a></code> | <code>number</code> | *No description.* |
11615
+ | <code><a href="#@cdklabs/cdk-ssm-documents.RunInstanceStep.property.onCancel">onCancel</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a></code> | *No description.* |
11616
+ | <code><a href="#@cdklabs/cdk-ssm-documents.RunInstanceStep.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a></code> | *No description.* |
11615
11617
  | <code><a href="#@cdklabs/cdk-ssm-documents.RunInstanceStep.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</code> | *No description.* |
11616
- | <code><a href="#@cdklabs/cdk-ssm-documents.RunInstanceStep.property.onCancel">onCancel</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | *No description.* |
11617
- | <code><a href="#@cdklabs/cdk-ssm-documents.RunInstanceStep.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | *No description.* |
11618
11618
  | <code><a href="#@cdklabs/cdk-ssm-documents.RunInstanceStep.property.allStepsInExecution">allStepsInExecution</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>[]</code> | *No description.* |
11619
11619
  | <code><a href="#@cdklabs/cdk-ssm-documents.RunInstanceStep.property.nextStep">nextStep</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | *No description.* |
11620
11620
  | <code><a href="#@cdklabs/cdk-ssm-documents.RunInstanceStep.property.imageId">imageId</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.IStringVariable">IStringVariable</a></code> | *No description.* |
@@ -11726,33 +11726,33 @@ public readonly maxAttempts: number;
11726
11726
 
11727
11727
  ---
11728
11728
 
11729
- ##### `timeoutSeconds`<sup>Required</sup> <a name="timeoutSeconds" id="@cdklabs/cdk-ssm-documents.RunInstanceStep.property.timeoutSeconds"></a>
11729
+ ##### `onCancel`<sup>Required</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.RunInstanceStep.property.onCancel"></a>
11730
11730
 
11731
11731
  ```typescript
11732
- public readonly timeoutSeconds: number;
11732
+ public readonly onCancel: OnCancel;
11733
11733
  ```
11734
11734
 
11735
- - *Type:* number
11735
+ - *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a>
11736
11736
 
11737
11737
  ---
11738
11738
 
11739
- ##### `onCancel`<sup>Optional</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.RunInstanceStep.property.onCancel"></a>
11739
+ ##### `onFailure`<sup>Required</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.RunInstanceStep.property.onFailure"></a>
11740
11740
 
11741
11741
  ```typescript
11742
- public readonly onCancel: AutomationStep;
11742
+ public readonly onFailure: OnFailure;
11743
11743
  ```
11744
11744
 
11745
- - *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
11745
+ - *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a>
11746
11746
 
11747
11747
  ---
11748
11748
 
11749
- ##### `onFailure`<sup>Optional</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.RunInstanceStep.property.onFailure"></a>
11749
+ ##### `timeoutSeconds`<sup>Required</sup> <a name="timeoutSeconds" id="@cdklabs/cdk-ssm-documents.RunInstanceStep.property.timeoutSeconds"></a>
11750
11750
 
11751
11751
  ```typescript
11752
- public readonly onFailure: AutomationStep;
11752
+ public readonly timeoutSeconds: number;
11753
11753
  ```
11754
11754
 
11755
- - *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
11755
+ - *Type:* number
11756
11756
 
11757
11757
  ---
11758
11758
 
@@ -12832,9 +12832,9 @@ Any object.
12832
12832
  | <code><a href="#@cdklabs/cdk-ssm-documents.SleepStep.property.description">description</a></code> | <code>string</code> | *No description.* |
12833
12833
  | <code><a href="#@cdklabs/cdk-ssm-documents.SleepStep.property.isEnd">isEnd</a></code> | <code>boolean</code> | *No description.* |
12834
12834
  | <code><a href="#@cdklabs/cdk-ssm-documents.SleepStep.property.maxAttempts">maxAttempts</a></code> | <code>number</code> | *No description.* |
12835
+ | <code><a href="#@cdklabs/cdk-ssm-documents.SleepStep.property.onCancel">onCancel</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a></code> | *No description.* |
12836
+ | <code><a href="#@cdklabs/cdk-ssm-documents.SleepStep.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a></code> | *No description.* |
12835
12837
  | <code><a href="#@cdklabs/cdk-ssm-documents.SleepStep.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</code> | *No description.* |
12836
- | <code><a href="#@cdklabs/cdk-ssm-documents.SleepStep.property.onCancel">onCancel</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | *No description.* |
12837
- | <code><a href="#@cdklabs/cdk-ssm-documents.SleepStep.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | *No description.* |
12838
12838
  | <code><a href="#@cdklabs/cdk-ssm-documents.SleepStep.property.allStepsInExecution">allStepsInExecution</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>[]</code> | *No description.* |
12839
12839
  | <code><a href="#@cdklabs/cdk-ssm-documents.SleepStep.property.nextStep">nextStep</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | *No description.* |
12840
12840
  | <code><a href="#@cdklabs/cdk-ssm-documents.SleepStep.property.sleepSeconds">sleepSeconds</a></code> | <code>number</code> | *No description.* |
@@ -12923,33 +12923,33 @@ public readonly maxAttempts: number;
12923
12923
 
12924
12924
  ---
12925
12925
 
12926
- ##### `timeoutSeconds`<sup>Required</sup> <a name="timeoutSeconds" id="@cdklabs/cdk-ssm-documents.SleepStep.property.timeoutSeconds"></a>
12926
+ ##### `onCancel`<sup>Required</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.SleepStep.property.onCancel"></a>
12927
12927
 
12928
12928
  ```typescript
12929
- public readonly timeoutSeconds: number;
12929
+ public readonly onCancel: OnCancel;
12930
12930
  ```
12931
12931
 
12932
- - *Type:* number
12932
+ - *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a>
12933
12933
 
12934
12934
  ---
12935
12935
 
12936
- ##### `onCancel`<sup>Optional</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.SleepStep.property.onCancel"></a>
12936
+ ##### `onFailure`<sup>Required</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.SleepStep.property.onFailure"></a>
12937
12937
 
12938
12938
  ```typescript
12939
- public readonly onCancel: AutomationStep;
12939
+ public readonly onFailure: OnFailure;
12940
12940
  ```
12941
12941
 
12942
- - *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
12942
+ - *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a>
12943
12943
 
12944
12944
  ---
12945
12945
 
12946
- ##### `onFailure`<sup>Optional</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.SleepStep.property.onFailure"></a>
12946
+ ##### `timeoutSeconds`<sup>Required</sup> <a name="timeoutSeconds" id="@cdklabs/cdk-ssm-documents.SleepStep.property.timeoutSeconds"></a>
12947
12947
 
12948
12948
  ```typescript
12949
- public readonly onFailure: AutomationStep;
12949
+ public readonly timeoutSeconds: number;
12950
12950
  ```
12951
12951
 
12952
- - *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
12952
+ - *Type:* number
12953
12953
 
12954
12954
  ---
12955
12955
 
@@ -14987,9 +14987,9 @@ Any object.
14987
14987
  | <code><a href="#@cdklabs/cdk-ssm-documents.WaitForResourceStep.property.description">description</a></code> | <code>string</code> | *No description.* |
14988
14988
  | <code><a href="#@cdklabs/cdk-ssm-documents.WaitForResourceStep.property.isEnd">isEnd</a></code> | <code>boolean</code> | *No description.* |
14989
14989
  | <code><a href="#@cdklabs/cdk-ssm-documents.WaitForResourceStep.property.maxAttempts">maxAttempts</a></code> | <code>number</code> | *No description.* |
14990
+ | <code><a href="#@cdklabs/cdk-ssm-documents.WaitForResourceStep.property.onCancel">onCancel</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a></code> | *No description.* |
14991
+ | <code><a href="#@cdklabs/cdk-ssm-documents.WaitForResourceStep.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a></code> | *No description.* |
14990
14992
  | <code><a href="#@cdklabs/cdk-ssm-documents.WaitForResourceStep.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</code> | *No description.* |
14991
- | <code><a href="#@cdklabs/cdk-ssm-documents.WaitForResourceStep.property.onCancel">onCancel</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | *No description.* |
14992
- | <code><a href="#@cdklabs/cdk-ssm-documents.WaitForResourceStep.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | *No description.* |
14993
14993
  | <code><a href="#@cdklabs/cdk-ssm-documents.WaitForResourceStep.property.allStepsInExecution">allStepsInExecution</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>[]</code> | *No description.* |
14994
14994
  | <code><a href="#@cdklabs/cdk-ssm-documents.WaitForResourceStep.property.nextStep">nextStep</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | *No description.* |
14995
14995
  | <code><a href="#@cdklabs/cdk-ssm-documents.WaitForResourceStep.property.apiParams">apiParams</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.DictFormat">DictFormat</a></code> | *No description.* |
@@ -15085,33 +15085,33 @@ public readonly maxAttempts: number;
15085
15085
 
15086
15086
  ---
15087
15087
 
15088
- ##### `timeoutSeconds`<sup>Required</sup> <a name="timeoutSeconds" id="@cdklabs/cdk-ssm-documents.WaitForResourceStep.property.timeoutSeconds"></a>
15088
+ ##### `onCancel`<sup>Required</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.WaitForResourceStep.property.onCancel"></a>
15089
15089
 
15090
15090
  ```typescript
15091
- public readonly timeoutSeconds: number;
15091
+ public readonly onCancel: OnCancel;
15092
15092
  ```
15093
15093
 
15094
- - *Type:* number
15094
+ - *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a>
15095
15095
 
15096
15096
  ---
15097
15097
 
15098
- ##### `onCancel`<sup>Optional</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.WaitForResourceStep.property.onCancel"></a>
15098
+ ##### `onFailure`<sup>Required</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.WaitForResourceStep.property.onFailure"></a>
15099
15099
 
15100
15100
  ```typescript
15101
- public readonly onCancel: AutomationStep;
15101
+ public readonly onFailure: OnFailure;
15102
15102
  ```
15103
15103
 
15104
- - *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
15104
+ - *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a>
15105
15105
 
15106
15106
  ---
15107
15107
 
15108
- ##### `onFailure`<sup>Optional</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.WaitForResourceStep.property.onFailure"></a>
15108
+ ##### `timeoutSeconds`<sup>Required</sup> <a name="timeoutSeconds" id="@cdklabs/cdk-ssm-documents.WaitForResourceStep.property.timeoutSeconds"></a>
15109
15109
 
15110
15110
  ```typescript
15111
- public readonly onFailure: AutomationStep;
15111
+ public readonly timeoutSeconds: number;
15112
15112
  ```
15113
15113
 
15114
- - *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
15114
+ - *Type:* number
15115
15115
 
15116
15116
  ---
15117
15117
 
@@ -15585,8 +15585,8 @@ const approveStepProps: ApproveStepProps = { ... }
15585
15585
  | <code><a href="#@cdklabs/cdk-ssm-documents.ApproveStepProps.property.outputObserver">outputObserver</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.IObserver">IObserver</a></code> | (Optional) Allows for observing the output of steps as they run. |
15586
15586
  | <code><a href="#@cdklabs/cdk-ssm-documents.ApproveStepProps.property.isEnd">isEnd</a></code> | <code>boolean</code> | Whether to stop document execution after this step. |
15587
15587
  | <code><a href="#@cdklabs/cdk-ssm-documents.ApproveStepProps.property.maxAttempts">maxAttempts</a></code> | <code>number</code> | (Optional) max attempts to run this step if there are failures. |
15588
- | <code><a href="#@cdklabs/cdk-ssm-documents.ApproveStepProps.property.onCancel">onCancel</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | (Optional) Step to jump to in the event that this step is cancelled. |
15589
- | <code><a href="#@cdklabs/cdk-ssm-documents.ApproveStepProps.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | (Optional) Step to jump to in the event that this step fails. |
15588
+ | <code><a href="#@cdklabs/cdk-ssm-documents.ApproveStepProps.property.onCancel">onCancel</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a></code> | (Optional) Fallback action to take in the event that this step is cancelled. |
15589
+ | <code><a href="#@cdklabs/cdk-ssm-documents.ApproveStepProps.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a></code> | (Optional) Fallback action to take in the event that this step fails. |
15590
15590
  | <code><a href="#@cdklabs/cdk-ssm-documents.ApproveStepProps.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</code> | (Optional) timeout seconds to run this step. |
15591
15591
  | <code><a href="#@cdklabs/cdk-ssm-documents.ApproveStepProps.property.approvers">approvers</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.IStringListVariable">IStringListVariable</a></code> | A list of AWS authenticated principals who are able to either approve or reject the action. |
15592
15592
  | <code><a href="#@cdklabs/cdk-ssm-documents.ApproveStepProps.property.message">message</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.IStringVariable">IStringVariable</a></code> | (Optional) The information you want to include in the Amazon SNS topic when the approval request is sent. |
@@ -15679,26 +15679,26 @@ public readonly maxAttempts: number;
15679
15679
  ##### `onCancel`<sup>Optional</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.ApproveStepProps.property.onCancel"></a>
15680
15680
 
15681
15681
  ```typescript
15682
- public readonly onCancel: AutomationStep;
15682
+ public readonly onCancel: OnCancel;
15683
15683
  ```
15684
15684
 
15685
- - *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
15685
+ - *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a>
15686
15686
  - *Default:* undefined
15687
15687
 
15688
- (Optional) Step to jump to in the event that this step is cancelled.
15688
+ (Optional) Fallback action to take in the event that this step is cancelled.
15689
15689
 
15690
15690
  ---
15691
15691
 
15692
15692
  ##### `onFailure`<sup>Optional</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.ApproveStepProps.property.onFailure"></a>
15693
15693
 
15694
15694
  ```typescript
15695
- public readonly onFailure: AutomationStep;
15695
+ public readonly onFailure: OnFailure;
15696
15696
  ```
15697
15697
 
15698
- - *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
15698
+ - *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a>
15699
15699
  - *Default:* undefined
15700
15700
 
15701
- (Optional) Step to jump to in the event that this step fails.
15701
+ (Optional) Fallback action to take in the event that this step fails.
15702
15702
 
15703
15703
  ---
15704
15704
 
@@ -15801,8 +15801,8 @@ const assertAwsResourceStepProps: AssertAwsResourceStepProps = { ... }
15801
15801
  | <code><a href="#@cdklabs/cdk-ssm-documents.AssertAwsResourceStepProps.property.outputObserver">outputObserver</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.IObserver">IObserver</a></code> | (Optional) Allows for observing the output of steps as they run. |
15802
15802
  | <code><a href="#@cdklabs/cdk-ssm-documents.AssertAwsResourceStepProps.property.isEnd">isEnd</a></code> | <code>boolean</code> | Whether to stop document execution after this step. |
15803
15803
  | <code><a href="#@cdklabs/cdk-ssm-documents.AssertAwsResourceStepProps.property.maxAttempts">maxAttempts</a></code> | <code>number</code> | (Optional) max attempts to run this step if there are failures. |
15804
- | <code><a href="#@cdklabs/cdk-ssm-documents.AssertAwsResourceStepProps.property.onCancel">onCancel</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | (Optional) Step to jump to in the event that this step is cancelled. |
15805
- | <code><a href="#@cdklabs/cdk-ssm-documents.AssertAwsResourceStepProps.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | (Optional) Step to jump to in the event that this step fails. |
15804
+ | <code><a href="#@cdklabs/cdk-ssm-documents.AssertAwsResourceStepProps.property.onCancel">onCancel</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a></code> | (Optional) Fallback action to take in the event that this step is cancelled. |
15805
+ | <code><a href="#@cdklabs/cdk-ssm-documents.AssertAwsResourceStepProps.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a></code> | (Optional) Fallback action to take in the event that this step fails. |
15806
15806
  | <code><a href="#@cdklabs/cdk-ssm-documents.AssertAwsResourceStepProps.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</code> | (Optional) timeout seconds to run this step. |
15807
15807
  | <code><a href="#@cdklabs/cdk-ssm-documents.AssertAwsResourceStepProps.property.apiParams">apiParams</a></code> | <code>{[ key: string ]: any}</code> | (Required) API Params to submit with the request to the api. |
15808
15808
  | <code><a href="#@cdklabs/cdk-ssm-documents.AssertAwsResourceStepProps.property.pascalCaseApi">pascalCaseApi</a></code> | <code>string</code> | (Required) The AWS api represented in PascalCase. |
@@ -15897,26 +15897,26 @@ public readonly maxAttempts: number;
15897
15897
  ##### `onCancel`<sup>Optional</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.AssertAwsResourceStepProps.property.onCancel"></a>
15898
15898
 
15899
15899
  ```typescript
15900
- public readonly onCancel: AutomationStep;
15900
+ public readonly onCancel: OnCancel;
15901
15901
  ```
15902
15902
 
15903
- - *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
15903
+ - *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a>
15904
15904
  - *Default:* undefined
15905
15905
 
15906
- (Optional) Step to jump to in the event that this step is cancelled.
15906
+ (Optional) Fallback action to take in the event that this step is cancelled.
15907
15907
 
15908
15908
  ---
15909
15909
 
15910
15910
  ##### `onFailure`<sup>Optional</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.AssertAwsResourceStepProps.property.onFailure"></a>
15911
15911
 
15912
15912
  ```typescript
15913
- public readonly onFailure: AutomationStep;
15913
+ public readonly onFailure: OnFailure;
15914
15914
  ```
15915
15915
 
15916
- - *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
15916
+ - *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a>
15917
15917
  - *Default:* undefined
15918
15918
 
15919
- (Optional) Step to jump to in the event that this step fails.
15919
+ (Optional) Fallback action to take in the event that this step fails.
15920
15920
 
15921
15921
  ---
15922
15922
 
@@ -16409,8 +16409,8 @@ const automationStepProps: AutomationStepProps = { ... }
16409
16409
  | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStepProps.property.outputObserver">outputObserver</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.IObserver">IObserver</a></code> | (Optional) Allows for observing the output of steps as they run. |
16410
16410
  | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStepProps.property.isEnd">isEnd</a></code> | <code>boolean</code> | Whether to stop document execution after this step. |
16411
16411
  | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStepProps.property.maxAttempts">maxAttempts</a></code> | <code>number</code> | (Optional) max attempts to run this step if there are failures. |
16412
- | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStepProps.property.onCancel">onCancel</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | (Optional) Step to jump to in the event that this step is cancelled. |
16413
- | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStepProps.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | (Optional) Step to jump to in the event that this step fails. |
16412
+ | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStepProps.property.onCancel">onCancel</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a></code> | (Optional) Fallback action to take in the event that this step is cancelled. |
16413
+ | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStepProps.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a></code> | (Optional) Fallback action to take in the event that this step fails. |
16414
16414
  | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStepProps.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</code> | (Optional) timeout seconds to run this step. |
16415
16415
 
16416
16416
  ---
@@ -16499,26 +16499,26 @@ public readonly maxAttempts: number;
16499
16499
  ##### `onCancel`<sup>Optional</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.AutomationStepProps.property.onCancel"></a>
16500
16500
 
16501
16501
  ```typescript
16502
- public readonly onCancel: AutomationStep;
16502
+ public readonly onCancel: OnCancel;
16503
16503
  ```
16504
16504
 
16505
- - *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
16505
+ - *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a>
16506
16506
  - *Default:* undefined
16507
16507
 
16508
- (Optional) Step to jump to in the event that this step is cancelled.
16508
+ (Optional) Fallback action to take in the event that this step is cancelled.
16509
16509
 
16510
16510
  ---
16511
16511
 
16512
16512
  ##### `onFailure`<sup>Optional</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.AutomationStepProps.property.onFailure"></a>
16513
16513
 
16514
16514
  ```typescript
16515
- public readonly onFailure: AutomationStep;
16515
+ public readonly onFailure: OnFailure;
16516
16516
  ```
16517
16517
 
16518
- - *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
16518
+ - *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a>
16519
16519
  - *Default:* undefined
16520
16520
 
16521
- (Optional) Step to jump to in the event that this step fails.
16521
+ (Optional) Fallback action to take in the event that this step fails.
16522
16522
 
16523
16523
  ---
16524
16524
 
@@ -16559,8 +16559,8 @@ const awsApiStepProps: AwsApiStepProps = { ... }
16559
16559
  | <code><a href="#@cdklabs/cdk-ssm-documents.AwsApiStepProps.property.outputObserver">outputObserver</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.IObserver">IObserver</a></code> | (Optional) Allows for observing the output of steps as they run. |
16560
16560
  | <code><a href="#@cdklabs/cdk-ssm-documents.AwsApiStepProps.property.isEnd">isEnd</a></code> | <code>boolean</code> | Whether to stop document execution after this step. |
16561
16561
  | <code><a href="#@cdklabs/cdk-ssm-documents.AwsApiStepProps.property.maxAttempts">maxAttempts</a></code> | <code>number</code> | (Optional) max attempts to run this step if there are failures. |
16562
- | <code><a href="#@cdklabs/cdk-ssm-documents.AwsApiStepProps.property.onCancel">onCancel</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | (Optional) Step to jump to in the event that this step is cancelled. |
16563
- | <code><a href="#@cdklabs/cdk-ssm-documents.AwsApiStepProps.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | (Optional) Step to jump to in the event that this step fails. |
16562
+ | <code><a href="#@cdklabs/cdk-ssm-documents.AwsApiStepProps.property.onCancel">onCancel</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a></code> | (Optional) Fallback action to take in the event that this step is cancelled. |
16563
+ | <code><a href="#@cdklabs/cdk-ssm-documents.AwsApiStepProps.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a></code> | (Optional) Fallback action to take in the event that this step fails. |
16564
16564
  | <code><a href="#@cdklabs/cdk-ssm-documents.AwsApiStepProps.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</code> | (Optional) timeout seconds to run this step. |
16565
16565
  | <code><a href="#@cdklabs/cdk-ssm-documents.AwsApiStepProps.property.apiParams">apiParams</a></code> | <code>{[ key: string ]: any}</code> | (Required) API Params to submit with the request to the api. |
16566
16566
  | <code><a href="#@cdklabs/cdk-ssm-documents.AwsApiStepProps.property.pascalCaseApi">pascalCaseApi</a></code> | <code>string</code> | (Required) The AWS api represented in PascalCase. |
@@ -16654,26 +16654,26 @@ public readonly maxAttempts: number;
16654
16654
  ##### `onCancel`<sup>Optional</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.AwsApiStepProps.property.onCancel"></a>
16655
16655
 
16656
16656
  ```typescript
16657
- public readonly onCancel: AutomationStep;
16657
+ public readonly onCancel: OnCancel;
16658
16658
  ```
16659
16659
 
16660
- - *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
16660
+ - *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a>
16661
16661
  - *Default:* undefined
16662
16662
 
16663
- (Optional) Step to jump to in the event that this step is cancelled.
16663
+ (Optional) Fallback action to take in the event that this step is cancelled.
16664
16664
 
16665
16665
  ---
16666
16666
 
16667
16667
  ##### `onFailure`<sup>Optional</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.AwsApiStepProps.property.onFailure"></a>
16668
16668
 
16669
16669
  ```typescript
16670
- public readonly onFailure: AutomationStep;
16670
+ public readonly onFailure: OnFailure;
16671
16671
  ```
16672
16672
 
16673
- - *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
16673
+ - *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a>
16674
16674
  - *Default:* undefined
16675
16675
 
16676
- (Optional) Step to jump to in the event that this step fails.
16676
+ (Optional) Fallback action to take in the event that this step fails.
16677
16677
 
16678
16678
  ---
16679
16679
 
@@ -16809,8 +16809,8 @@ const awsInvocationProps: AwsInvocationProps = { ... }
16809
16809
  | <code><a href="#@cdklabs/cdk-ssm-documents.AwsInvocationProps.property.outputObserver">outputObserver</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.IObserver">IObserver</a></code> | (Optional) Allows for observing the output of steps as they run. |
16810
16810
  | <code><a href="#@cdklabs/cdk-ssm-documents.AwsInvocationProps.property.isEnd">isEnd</a></code> | <code>boolean</code> | Whether to stop document execution after this step. |
16811
16811
  | <code><a href="#@cdklabs/cdk-ssm-documents.AwsInvocationProps.property.maxAttempts">maxAttempts</a></code> | <code>number</code> | (Optional) max attempts to run this step if there are failures. |
16812
- | <code><a href="#@cdklabs/cdk-ssm-documents.AwsInvocationProps.property.onCancel">onCancel</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | (Optional) Step to jump to in the event that this step is cancelled. |
16813
- | <code><a href="#@cdklabs/cdk-ssm-documents.AwsInvocationProps.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | (Optional) Step to jump to in the event that this step fails. |
16812
+ | <code><a href="#@cdklabs/cdk-ssm-documents.AwsInvocationProps.property.onCancel">onCancel</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a></code> | (Optional) Fallback action to take in the event that this step is cancelled. |
16813
+ | <code><a href="#@cdklabs/cdk-ssm-documents.AwsInvocationProps.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a></code> | (Optional) Fallback action to take in the event that this step fails. |
16814
16814
  | <code><a href="#@cdklabs/cdk-ssm-documents.AwsInvocationProps.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</code> | (Optional) timeout seconds to run this step. |
16815
16815
  | <code><a href="#@cdklabs/cdk-ssm-documents.AwsInvocationProps.property.apiParams">apiParams</a></code> | <code>{[ key: string ]: any}</code> | (Required) API Params to submit with the request to the api. |
16816
16816
  | <code><a href="#@cdklabs/cdk-ssm-documents.AwsInvocationProps.property.pascalCaseApi">pascalCaseApi</a></code> | <code>string</code> | (Required) The AWS api represented in PascalCase. |
@@ -16903,26 +16903,26 @@ public readonly maxAttempts: number;
16903
16903
  ##### `onCancel`<sup>Optional</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.AwsInvocationProps.property.onCancel"></a>
16904
16904
 
16905
16905
  ```typescript
16906
- public readonly onCancel: AutomationStep;
16906
+ public readonly onCancel: OnCancel;
16907
16907
  ```
16908
16908
 
16909
- - *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
16909
+ - *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a>
16910
16910
  - *Default:* undefined
16911
16911
 
16912
- (Optional) Step to jump to in the event that this step is cancelled.
16912
+ (Optional) Fallback action to take in the event that this step is cancelled.
16913
16913
 
16914
16914
  ---
16915
16915
 
16916
16916
  ##### `onFailure`<sup>Optional</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.AwsInvocationProps.property.onFailure"></a>
16917
16917
 
16918
16918
  ```typescript
16919
- public readonly onFailure: AutomationStep;
16919
+ public readonly onFailure: OnFailure;
16920
16920
  ```
16921
16921
 
16922
- - *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
16922
+ - *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a>
16923
16923
  - *Default:* undefined
16924
16924
 
16925
- (Optional) Step to jump to in the event that this step fails.
16925
+ (Optional) Fallback action to take in the event that this step fails.
16926
16926
 
16927
16927
  ---
16928
16928
 
@@ -17167,8 +17167,8 @@ const branchStepProps: BranchStepProps = { ... }
17167
17167
  | <code><a href="#@cdklabs/cdk-ssm-documents.BranchStepProps.property.outputObserver">outputObserver</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.IObserver">IObserver</a></code> | (Optional) Allows for observing the output of steps as they run. |
17168
17168
  | <code><a href="#@cdklabs/cdk-ssm-documents.BranchStepProps.property.isEnd">isEnd</a></code> | <code>boolean</code> | Whether to stop document execution after this step. |
17169
17169
  | <code><a href="#@cdklabs/cdk-ssm-documents.BranchStepProps.property.maxAttempts">maxAttempts</a></code> | <code>number</code> | (Optional) max attempts to run this step if there are failures. |
17170
- | <code><a href="#@cdklabs/cdk-ssm-documents.BranchStepProps.property.onCancel">onCancel</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | (Optional) Step to jump to in the event that this step is cancelled. |
17171
- | <code><a href="#@cdklabs/cdk-ssm-documents.BranchStepProps.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | (Optional) Step to jump to in the event that this step fails. |
17170
+ | <code><a href="#@cdklabs/cdk-ssm-documents.BranchStepProps.property.onCancel">onCancel</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a></code> | (Optional) Fallback action to take in the event that this step is cancelled. |
17171
+ | <code><a href="#@cdklabs/cdk-ssm-documents.BranchStepProps.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a></code> | (Optional) Fallback action to take in the event that this step fails. |
17172
17172
  | <code><a href="#@cdklabs/cdk-ssm-documents.BranchStepProps.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</code> | (Optional) timeout seconds to run this step. |
17173
17173
  | <code><a href="#@cdklabs/cdk-ssm-documents.BranchStepProps.property.choices">choices</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.Choice">Choice</a>[]</code> | (Required) list of choices. |
17174
17174
  | <code><a href="#@cdklabs/cdk-ssm-documents.BranchStepProps.property.defaultStepName">defaultStepName</a></code> | <code>string</code> | (Optional) default step in all of the choices evaluate to false. |
@@ -17259,26 +17259,26 @@ public readonly maxAttempts: number;
17259
17259
  ##### `onCancel`<sup>Optional</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.BranchStepProps.property.onCancel"></a>
17260
17260
 
17261
17261
  ```typescript
17262
- public readonly onCancel: AutomationStep;
17262
+ public readonly onCancel: OnCancel;
17263
17263
  ```
17264
17264
 
17265
- - *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
17265
+ - *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a>
17266
17266
  - *Default:* undefined
17267
17267
 
17268
- (Optional) Step to jump to in the event that this step is cancelled.
17268
+ (Optional) Fallback action to take in the event that this step is cancelled.
17269
17269
 
17270
17270
  ---
17271
17271
 
17272
17272
  ##### `onFailure`<sup>Optional</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.BranchStepProps.property.onFailure"></a>
17273
17273
 
17274
17274
  ```typescript
17275
- public readonly onFailure: AutomationStep;
17275
+ public readonly onFailure: OnFailure;
17276
17276
  ```
17277
17277
 
17278
- - *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
17278
+ - *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a>
17279
17279
  - *Default:* undefined
17280
17280
 
17281
- (Optional) Step to jump to in the event that this step fails.
17281
+ (Optional) Fallback action to take in the event that this step fails.
17282
17282
 
17283
17283
  ---
17284
17284
 
@@ -17346,8 +17346,8 @@ const changeInstanceStateSimulationProps: ChangeInstanceStateSimulationProps = {
17346
17346
  | <code><a href="#@cdklabs/cdk-ssm-documents.ChangeInstanceStateSimulationProps.property.outputObserver">outputObserver</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.IObserver">IObserver</a></code> | (Optional) Allows for observing the output of steps as they run. |
17347
17347
  | <code><a href="#@cdklabs/cdk-ssm-documents.ChangeInstanceStateSimulationProps.property.isEnd">isEnd</a></code> | <code>boolean</code> | Whether to stop document execution after this step. |
17348
17348
  | <code><a href="#@cdklabs/cdk-ssm-documents.ChangeInstanceStateSimulationProps.property.maxAttempts">maxAttempts</a></code> | <code>number</code> | (Optional) max attempts to run this step if there are failures. |
17349
- | <code><a href="#@cdklabs/cdk-ssm-documents.ChangeInstanceStateSimulationProps.property.onCancel">onCancel</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | (Optional) Step to jump to in the event that this step is cancelled. |
17350
- | <code><a href="#@cdklabs/cdk-ssm-documents.ChangeInstanceStateSimulationProps.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | (Optional) Step to jump to in the event that this step fails. |
17349
+ | <code><a href="#@cdklabs/cdk-ssm-documents.ChangeInstanceStateSimulationProps.property.onCancel">onCancel</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a></code> | (Optional) Fallback action to take in the event that this step is cancelled. |
17350
+ | <code><a href="#@cdklabs/cdk-ssm-documents.ChangeInstanceStateSimulationProps.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a></code> | (Optional) Fallback action to take in the event that this step fails. |
17351
17351
  | <code><a href="#@cdklabs/cdk-ssm-documents.ChangeInstanceStateSimulationProps.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</code> | (Optional) timeout seconds to run this step. |
17352
17352
  | <code><a href="#@cdklabs/cdk-ssm-documents.ChangeInstanceStateSimulationProps.property.awsInvoker">awsInvoker</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.IAwsInvoker">IAwsInvoker</a></code> | (Optional) Use this as a hook to inject an alternate IAwsInvoker (for mocking the AWS API call). |
17353
17353
 
@@ -17437,26 +17437,26 @@ public readonly maxAttempts: number;
17437
17437
  ##### `onCancel`<sup>Optional</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.ChangeInstanceStateSimulationProps.property.onCancel"></a>
17438
17438
 
17439
17439
  ```typescript
17440
- public readonly onCancel: AutomationStep;
17440
+ public readonly onCancel: OnCancel;
17441
17441
  ```
17442
17442
 
17443
- - *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
17443
+ - *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a>
17444
17444
  - *Default:* undefined
17445
17445
 
17446
- (Optional) Step to jump to in the event that this step is cancelled.
17446
+ (Optional) Fallback action to take in the event that this step is cancelled.
17447
17447
 
17448
17448
  ---
17449
17449
 
17450
17450
  ##### `onFailure`<sup>Optional</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.ChangeInstanceStateSimulationProps.property.onFailure"></a>
17451
17451
 
17452
17452
  ```typescript
17453
- public readonly onFailure: AutomationStep;
17453
+ public readonly onFailure: OnFailure;
17454
17454
  ```
17455
17455
 
17456
- - *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
17456
+ - *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a>
17457
17457
  - *Default:* undefined
17458
17458
 
17459
- (Optional) Step to jump to in the event that this step fails.
17459
+ (Optional) Fallback action to take in the event that this step fails.
17460
17460
 
17461
17461
  ---
17462
17462
 
@@ -17510,8 +17510,8 @@ const changeInstanceStateStepProps: ChangeInstanceStateStepProps = { ... }
17510
17510
  | <code><a href="#@cdklabs/cdk-ssm-documents.ChangeInstanceStateStepProps.property.outputObserver">outputObserver</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.IObserver">IObserver</a></code> | (Optional) Allows for observing the output of steps as they run. |
17511
17511
  | <code><a href="#@cdklabs/cdk-ssm-documents.ChangeInstanceStateStepProps.property.isEnd">isEnd</a></code> | <code>boolean</code> | Whether to stop document execution after this step. |
17512
17512
  | <code><a href="#@cdklabs/cdk-ssm-documents.ChangeInstanceStateStepProps.property.maxAttempts">maxAttempts</a></code> | <code>number</code> | (Optional) max attempts to run this step if there are failures. |
17513
- | <code><a href="#@cdklabs/cdk-ssm-documents.ChangeInstanceStateStepProps.property.onCancel">onCancel</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | (Optional) Step to jump to in the event that this step is cancelled. |
17514
- | <code><a href="#@cdklabs/cdk-ssm-documents.ChangeInstanceStateStepProps.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | (Optional) Step to jump to in the event that this step fails. |
17513
+ | <code><a href="#@cdklabs/cdk-ssm-documents.ChangeInstanceStateStepProps.property.onCancel">onCancel</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a></code> | (Optional) Fallback action to take in the event that this step is cancelled. |
17514
+ | <code><a href="#@cdklabs/cdk-ssm-documents.ChangeInstanceStateStepProps.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a></code> | (Optional) Fallback action to take in the event that this step fails. |
17515
17515
  | <code><a href="#@cdklabs/cdk-ssm-documents.ChangeInstanceStateStepProps.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</code> | (Optional) timeout seconds to run this step. |
17516
17516
  | <code><a href="#@cdklabs/cdk-ssm-documents.ChangeInstanceStateStepProps.property.desiredState">desiredState</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.IDesiredStateVariable">IDesiredStateVariable</a></code> | The desired state. |
17517
17517
  | <code><a href="#@cdklabs/cdk-ssm-documents.ChangeInstanceStateStepProps.property.instanceIds">instanceIds</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.IStringListVariable">IStringListVariable</a></code> | The IDs of the instances. |
@@ -17605,26 +17605,26 @@ public readonly maxAttempts: number;
17605
17605
  ##### `onCancel`<sup>Optional</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.ChangeInstanceStateStepProps.property.onCancel"></a>
17606
17606
 
17607
17607
  ```typescript
17608
- public readonly onCancel: AutomationStep;
17608
+ public readonly onCancel: OnCancel;
17609
17609
  ```
17610
17610
 
17611
- - *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
17611
+ - *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a>
17612
17612
  - *Default:* undefined
17613
17613
 
17614
- (Optional) Step to jump to in the event that this step is cancelled.
17614
+ (Optional) Fallback action to take in the event that this step is cancelled.
17615
17615
 
17616
17616
  ---
17617
17617
 
17618
17618
  ##### `onFailure`<sup>Optional</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.ChangeInstanceStateStepProps.property.onFailure"></a>
17619
17619
 
17620
17620
  ```typescript
17621
- public readonly onFailure: AutomationStep;
17621
+ public readonly onFailure: OnFailure;
17622
17622
  ```
17623
17623
 
17624
- - *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
17624
+ - *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a>
17625
17625
  - *Default:* undefined
17626
17626
 
17627
- (Optional) Step to jump to in the event that this step fails.
17627
+ (Optional) Fallback action to take in the event that this step fails.
17628
17628
 
17629
17629
  ---
17630
17630
 
@@ -18618,8 +18618,8 @@ const copyImageStepProps: CopyImageStepProps = { ... }
18618
18618
  | <code><a href="#@cdklabs/cdk-ssm-documents.CopyImageStepProps.property.outputObserver">outputObserver</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.IObserver">IObserver</a></code> | (Optional) Allows for observing the output of steps as they run. |
18619
18619
  | <code><a href="#@cdklabs/cdk-ssm-documents.CopyImageStepProps.property.isEnd">isEnd</a></code> | <code>boolean</code> | Whether to stop document execution after this step. |
18620
18620
  | <code><a href="#@cdklabs/cdk-ssm-documents.CopyImageStepProps.property.maxAttempts">maxAttempts</a></code> | <code>number</code> | (Optional) max attempts to run this step if there are failures. |
18621
- | <code><a href="#@cdklabs/cdk-ssm-documents.CopyImageStepProps.property.onCancel">onCancel</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | (Optional) Step to jump to in the event that this step is cancelled. |
18622
- | <code><a href="#@cdklabs/cdk-ssm-documents.CopyImageStepProps.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | (Optional) Step to jump to in the event that this step fails. |
18621
+ | <code><a href="#@cdklabs/cdk-ssm-documents.CopyImageStepProps.property.onCancel">onCancel</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a></code> | (Optional) Fallback action to take in the event that this step is cancelled. |
18622
+ | <code><a href="#@cdklabs/cdk-ssm-documents.CopyImageStepProps.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a></code> | (Optional) Fallback action to take in the event that this step fails. |
18623
18623
  | <code><a href="#@cdklabs/cdk-ssm-documents.CopyImageStepProps.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</code> | (Optional) timeout seconds to run this step. |
18624
18624
  | <code><a href="#@cdklabs/cdk-ssm-documents.CopyImageStepProps.property.imageName">imageName</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.IStringVariable">IStringVariable</a></code> | The name for the image. |
18625
18625
  | <code><a href="#@cdklabs/cdk-ssm-documents.CopyImageStepProps.property.sourceImageId">sourceImageId</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.IStringVariable">IStringVariable</a></code> | The AMI ID to copy from the source Region. |
@@ -18715,26 +18715,26 @@ public readonly maxAttempts: number;
18715
18715
  ##### `onCancel`<sup>Optional</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.CopyImageStepProps.property.onCancel"></a>
18716
18716
 
18717
18717
  ```typescript
18718
- public readonly onCancel: AutomationStep;
18718
+ public readonly onCancel: OnCancel;
18719
18719
  ```
18720
18720
 
18721
- - *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
18721
+ - *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a>
18722
18722
  - *Default:* undefined
18723
18723
 
18724
- (Optional) Step to jump to in the event that this step is cancelled.
18724
+ (Optional) Fallback action to take in the event that this step is cancelled.
18725
18725
 
18726
18726
  ---
18727
18727
 
18728
18728
  ##### `onFailure`<sup>Optional</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.CopyImageStepProps.property.onFailure"></a>
18729
18729
 
18730
18730
  ```typescript
18731
- public readonly onFailure: AutomationStep;
18731
+ public readonly onFailure: OnFailure;
18732
18732
  ```
18733
18733
 
18734
- - *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
18734
+ - *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a>
18735
18735
  - *Default:* undefined
18736
18736
 
18737
- (Optional) Step to jump to in the event that this step fails.
18737
+ (Optional) Fallback action to take in the event that this step fails.
18738
18738
 
18739
18739
  ---
18740
18740
 
@@ -18859,8 +18859,8 @@ const createImageStepProps: CreateImageStepProps = { ... }
18859
18859
  | <code><a href="#@cdklabs/cdk-ssm-documents.CreateImageStepProps.property.outputObserver">outputObserver</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.IObserver">IObserver</a></code> | (Optional) Allows for observing the output of steps as they run. |
18860
18860
  | <code><a href="#@cdklabs/cdk-ssm-documents.CreateImageStepProps.property.isEnd">isEnd</a></code> | <code>boolean</code> | Whether to stop document execution after this step. |
18861
18861
  | <code><a href="#@cdklabs/cdk-ssm-documents.CreateImageStepProps.property.maxAttempts">maxAttempts</a></code> | <code>number</code> | (Optional) max attempts to run this step if there are failures. |
18862
- | <code><a href="#@cdklabs/cdk-ssm-documents.CreateImageStepProps.property.onCancel">onCancel</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | (Optional) Step to jump to in the event that this step is cancelled. |
18863
- | <code><a href="#@cdklabs/cdk-ssm-documents.CreateImageStepProps.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | (Optional) Step to jump to in the event that this step fails. |
18862
+ | <code><a href="#@cdklabs/cdk-ssm-documents.CreateImageStepProps.property.onCancel">onCancel</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a></code> | (Optional) Fallback action to take in the event that this step is cancelled. |
18863
+ | <code><a href="#@cdklabs/cdk-ssm-documents.CreateImageStepProps.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a></code> | (Optional) Fallback action to take in the event that this step fails. |
18864
18864
  | <code><a href="#@cdklabs/cdk-ssm-documents.CreateImageStepProps.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</code> | (Optional) timeout seconds to run this step. |
18865
18865
  | <code><a href="#@cdklabs/cdk-ssm-documents.CreateImageStepProps.property.imageName">imageName</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.IStringVariable">IStringVariable</a></code> | The name for the image. |
18866
18866
  | <code><a href="#@cdklabs/cdk-ssm-documents.CreateImageStepProps.property.instanceId">instanceId</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.IStringVariable">IStringVariable</a></code> | The ID of the instance. |
@@ -18954,26 +18954,26 @@ public readonly maxAttempts: number;
18954
18954
  ##### `onCancel`<sup>Optional</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.CreateImageStepProps.property.onCancel"></a>
18955
18955
 
18956
18956
  ```typescript
18957
- public readonly onCancel: AutomationStep;
18957
+ public readonly onCancel: OnCancel;
18958
18958
  ```
18959
18959
 
18960
- - *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
18960
+ - *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a>
18961
18961
  - *Default:* undefined
18962
18962
 
18963
- (Optional) Step to jump to in the event that this step is cancelled.
18963
+ (Optional) Fallback action to take in the event that this step is cancelled.
18964
18964
 
18965
18965
  ---
18966
18966
 
18967
18967
  ##### `onFailure`<sup>Optional</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.CreateImageStepProps.property.onFailure"></a>
18968
18968
 
18969
18969
  ```typescript
18970
- public readonly onFailure: AutomationStep;
18970
+ public readonly onFailure: OnFailure;
18971
18971
  ```
18972
18972
 
18973
- - *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
18973
+ - *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a>
18974
18974
  - *Default:* undefined
18975
18975
 
18976
- (Optional) Step to jump to in the event that this step fails.
18976
+ (Optional) Fallback action to take in the event that this step fails.
18977
18977
 
18978
18978
  ---
18979
18979
 
@@ -19142,8 +19142,8 @@ const createStackStepProps: CreateStackStepProps = { ... }
19142
19142
  | <code><a href="#@cdklabs/cdk-ssm-documents.CreateStackStepProps.property.outputObserver">outputObserver</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.IObserver">IObserver</a></code> | (Optional) Allows for observing the output of steps as they run. |
19143
19143
  | <code><a href="#@cdklabs/cdk-ssm-documents.CreateStackStepProps.property.isEnd">isEnd</a></code> | <code>boolean</code> | Whether to stop document execution after this step. |
19144
19144
  | <code><a href="#@cdklabs/cdk-ssm-documents.CreateStackStepProps.property.maxAttempts">maxAttempts</a></code> | <code>number</code> | (Optional) max attempts to run this step if there are failures. |
19145
- | <code><a href="#@cdklabs/cdk-ssm-documents.CreateStackStepProps.property.onCancel">onCancel</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | (Optional) Step to jump to in the event that this step is cancelled. |
19146
- | <code><a href="#@cdklabs/cdk-ssm-documents.CreateStackStepProps.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | (Optional) Step to jump to in the event that this step fails. |
19145
+ | <code><a href="#@cdklabs/cdk-ssm-documents.CreateStackStepProps.property.onCancel">onCancel</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a></code> | (Optional) Fallback action to take in the event that this step is cancelled. |
19146
+ | <code><a href="#@cdklabs/cdk-ssm-documents.CreateStackStepProps.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a></code> | (Optional) Fallback action to take in the event that this step fails. |
19147
19147
  | <code><a href="#@cdklabs/cdk-ssm-documents.CreateStackStepProps.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</code> | (Optional) timeout seconds to run this step. |
19148
19148
  | <code><a href="#@cdklabs/cdk-ssm-documents.CreateStackStepProps.property.stackName">stackName</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.IStringVariable">IStringVariable</a></code> | The name that is associated with the stack. |
19149
19149
  | <code><a href="#@cdklabs/cdk-ssm-documents.CreateStackStepProps.property.template">template</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.BodyOrUrlProp">BodyOrUrlProp</a></code> | Template body or URL. |
@@ -19244,26 +19244,26 @@ public readonly maxAttempts: number;
19244
19244
  ##### `onCancel`<sup>Optional</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.CreateStackStepProps.property.onCancel"></a>
19245
19245
 
19246
19246
  ```typescript
19247
- public readonly onCancel: AutomationStep;
19247
+ public readonly onCancel: OnCancel;
19248
19248
  ```
19249
19249
 
19250
- - *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
19250
+ - *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a>
19251
19251
  - *Default:* undefined
19252
19252
 
19253
- (Optional) Step to jump to in the event that this step is cancelled.
19253
+ (Optional) Fallback action to take in the event that this step is cancelled.
19254
19254
 
19255
19255
  ---
19256
19256
 
19257
19257
  ##### `onFailure`<sup>Optional</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.CreateStackStepProps.property.onFailure"></a>
19258
19258
 
19259
19259
  ```typescript
19260
- public readonly onFailure: AutomationStep;
19260
+ public readonly onFailure: OnFailure;
19261
19261
  ```
19262
19262
 
19263
- - *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
19263
+ - *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a>
19264
19264
  - *Default:* undefined
19265
19265
 
19266
- (Optional) Step to jump to in the event that this step fails.
19266
+ (Optional) Fallback action to take in the event that this step fails.
19267
19267
 
19268
19268
  ---
19269
19269
 
@@ -19529,8 +19529,8 @@ const createTagsStepProps: CreateTagsStepProps = { ... }
19529
19529
  | <code><a href="#@cdklabs/cdk-ssm-documents.CreateTagsStepProps.property.outputObserver">outputObserver</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.IObserver">IObserver</a></code> | (Optional) Allows for observing the output of steps as they run. |
19530
19530
  | <code><a href="#@cdklabs/cdk-ssm-documents.CreateTagsStepProps.property.isEnd">isEnd</a></code> | <code>boolean</code> | Whether to stop document execution after this step. |
19531
19531
  | <code><a href="#@cdklabs/cdk-ssm-documents.CreateTagsStepProps.property.maxAttempts">maxAttempts</a></code> | <code>number</code> | (Optional) max attempts to run this step if there are failures. |
19532
- | <code><a href="#@cdklabs/cdk-ssm-documents.CreateTagsStepProps.property.onCancel">onCancel</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | (Optional) Step to jump to in the event that this step is cancelled. |
19533
- | <code><a href="#@cdklabs/cdk-ssm-documents.CreateTagsStepProps.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | (Optional) Step to jump to in the event that this step fails. |
19532
+ | <code><a href="#@cdklabs/cdk-ssm-documents.CreateTagsStepProps.property.onCancel">onCancel</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a></code> | (Optional) Fallback action to take in the event that this step is cancelled. |
19533
+ | <code><a href="#@cdklabs/cdk-ssm-documents.CreateTagsStepProps.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a></code> | (Optional) Fallback action to take in the event that this step fails. |
19534
19534
  | <code><a href="#@cdklabs/cdk-ssm-documents.CreateTagsStepProps.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</code> | (Optional) timeout seconds to run this step. |
19535
19535
  | <code><a href="#@cdklabs/cdk-ssm-documents.CreateTagsStepProps.property.resourceIds">resourceIds</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.IStringListVariable">IStringListVariable</a></code> | The IDs of the resource(s) to be tagged. |
19536
19536
  | <code><a href="#@cdklabs/cdk-ssm-documents.CreateTagsStepProps.property.tags">tags</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.IMapListVariable">IMapListVariable</a></code> | The tags to associate with the resource(s). |
@@ -19622,26 +19622,26 @@ public readonly maxAttempts: number;
19622
19622
  ##### `onCancel`<sup>Optional</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.CreateTagsStepProps.property.onCancel"></a>
19623
19623
 
19624
19624
  ```typescript
19625
- public readonly onCancel: AutomationStep;
19625
+ public readonly onCancel: OnCancel;
19626
19626
  ```
19627
19627
 
19628
- - *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
19628
+ - *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a>
19629
19629
  - *Default:* undefined
19630
19630
 
19631
- (Optional) Step to jump to in the event that this step is cancelled.
19631
+ (Optional) Fallback action to take in the event that this step is cancelled.
19632
19632
 
19633
19633
  ---
19634
19634
 
19635
19635
  ##### `onFailure`<sup>Optional</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.CreateTagsStepProps.property.onFailure"></a>
19636
19636
 
19637
19637
  ```typescript
19638
- public readonly onFailure: AutomationStep;
19638
+ public readonly onFailure: OnFailure;
19639
19639
  ```
19640
19640
 
19641
- - *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
19641
+ - *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a>
19642
19642
  - *Default:* undefined
19643
19643
 
19644
- (Optional) Step to jump to in the event that this step fails.
19644
+ (Optional) Fallback action to take in the event that this step fails.
19645
19645
 
19646
19646
  ---
19647
19647
 
@@ -19772,8 +19772,8 @@ const deleteImageStepProps: DeleteImageStepProps = { ... }
19772
19772
  | <code><a href="#@cdklabs/cdk-ssm-documents.DeleteImageStepProps.property.outputObserver">outputObserver</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.IObserver">IObserver</a></code> | (Optional) Allows for observing the output of steps as they run. |
19773
19773
  | <code><a href="#@cdklabs/cdk-ssm-documents.DeleteImageStepProps.property.isEnd">isEnd</a></code> | <code>boolean</code> | Whether to stop document execution after this step. |
19774
19774
  | <code><a href="#@cdklabs/cdk-ssm-documents.DeleteImageStepProps.property.maxAttempts">maxAttempts</a></code> | <code>number</code> | (Optional) max attempts to run this step if there are failures. |
19775
- | <code><a href="#@cdklabs/cdk-ssm-documents.DeleteImageStepProps.property.onCancel">onCancel</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | (Optional) Step to jump to in the event that this step is cancelled. |
19776
- | <code><a href="#@cdklabs/cdk-ssm-documents.DeleteImageStepProps.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | (Optional) Step to jump to in the event that this step fails. |
19775
+ | <code><a href="#@cdklabs/cdk-ssm-documents.DeleteImageStepProps.property.onCancel">onCancel</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a></code> | (Optional) Fallback action to take in the event that this step is cancelled. |
19776
+ | <code><a href="#@cdklabs/cdk-ssm-documents.DeleteImageStepProps.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a></code> | (Optional) Fallback action to take in the event that this step fails. |
19777
19777
  | <code><a href="#@cdklabs/cdk-ssm-documents.DeleteImageStepProps.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</code> | (Optional) timeout seconds to run this step. |
19778
19778
  | <code><a href="#@cdklabs/cdk-ssm-documents.DeleteImageStepProps.property.imageId">imageId</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.IStringVariable">IStringVariable</a></code> | The ID of the image to be deleted. |
19779
19779
 
@@ -19863,26 +19863,26 @@ public readonly maxAttempts: number;
19863
19863
  ##### `onCancel`<sup>Optional</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.DeleteImageStepProps.property.onCancel"></a>
19864
19864
 
19865
19865
  ```typescript
19866
- public readonly onCancel: AutomationStep;
19866
+ public readonly onCancel: OnCancel;
19867
19867
  ```
19868
19868
 
19869
- - *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
19869
+ - *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a>
19870
19870
  - *Default:* undefined
19871
19871
 
19872
- (Optional) Step to jump to in the event that this step is cancelled.
19872
+ (Optional) Fallback action to take in the event that this step is cancelled.
19873
19873
 
19874
19874
  ---
19875
19875
 
19876
19876
  ##### `onFailure`<sup>Optional</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.DeleteImageStepProps.property.onFailure"></a>
19877
19877
 
19878
19878
  ```typescript
19879
- public readonly onFailure: AutomationStep;
19879
+ public readonly onFailure: OnFailure;
19880
19880
  ```
19881
19881
 
19882
- - *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
19882
+ - *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a>
19883
19883
  - *Default:* undefined
19884
19884
 
19885
- (Optional) Step to jump to in the event that this step fails.
19885
+ (Optional) Fallback action to take in the event that this step fails.
19886
19886
 
19887
19887
  ---
19888
19888
 
@@ -19935,8 +19935,8 @@ const deleteStackStepProps: DeleteStackStepProps = { ... }
19935
19935
  | <code><a href="#@cdklabs/cdk-ssm-documents.DeleteStackStepProps.property.outputObserver">outputObserver</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.IObserver">IObserver</a></code> | (Optional) Allows for observing the output of steps as they run. |
19936
19936
  | <code><a href="#@cdklabs/cdk-ssm-documents.DeleteStackStepProps.property.isEnd">isEnd</a></code> | <code>boolean</code> | Whether to stop document execution after this step. |
19937
19937
  | <code><a href="#@cdklabs/cdk-ssm-documents.DeleteStackStepProps.property.maxAttempts">maxAttempts</a></code> | <code>number</code> | (Optional) max attempts to run this step if there are failures. |
19938
- | <code><a href="#@cdklabs/cdk-ssm-documents.DeleteStackStepProps.property.onCancel">onCancel</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | (Optional) Step to jump to in the event that this step is cancelled. |
19939
- | <code><a href="#@cdklabs/cdk-ssm-documents.DeleteStackStepProps.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | (Optional) Step to jump to in the event that this step fails. |
19938
+ | <code><a href="#@cdklabs/cdk-ssm-documents.DeleteStackStepProps.property.onCancel">onCancel</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a></code> | (Optional) Fallback action to take in the event that this step is cancelled. |
19939
+ | <code><a href="#@cdklabs/cdk-ssm-documents.DeleteStackStepProps.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a></code> | (Optional) Fallback action to take in the event that this step fails. |
19940
19940
  | <code><a href="#@cdklabs/cdk-ssm-documents.DeleteStackStepProps.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</code> | (Optional) timeout seconds to run this step. |
19941
19941
  | <code><a href="#@cdklabs/cdk-ssm-documents.DeleteStackStepProps.property.stackNameVariable">stackNameVariable</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.IStringVariable">IStringVariable</a></code> | (Optional) Variable that is fed into this step declaring which stack to delete. |
19942
19942
  | <code><a href="#@cdklabs/cdk-ssm-documents.DeleteStackStepProps.property.roleArn">roleArn</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.IStringVariable">IStringVariable</a></code> | (Optional) The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that CloudFormation assumes to create the stack. |
@@ -20027,26 +20027,26 @@ public readonly maxAttempts: number;
20027
20027
  ##### `onCancel`<sup>Optional</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.DeleteStackStepProps.property.onCancel"></a>
20028
20028
 
20029
20029
  ```typescript
20030
- public readonly onCancel: AutomationStep;
20030
+ public readonly onCancel: OnCancel;
20031
20031
  ```
20032
20032
 
20033
- - *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
20033
+ - *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a>
20034
20034
  - *Default:* undefined
20035
20035
 
20036
- (Optional) Step to jump to in the event that this step is cancelled.
20036
+ (Optional) Fallback action to take in the event that this step is cancelled.
20037
20037
 
20038
20038
  ---
20039
20039
 
20040
20040
  ##### `onFailure`<sup>Optional</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.DeleteStackStepProps.property.onFailure"></a>
20041
20041
 
20042
20042
  ```typescript
20043
- public readonly onFailure: AutomationStep;
20043
+ public readonly onFailure: OnFailure;
20044
20044
  ```
20045
20045
 
20046
- - *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
20046
+ - *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a>
20047
20047
  - *Default:* undefined
20048
20048
 
20049
- (Optional) Step to jump to in the event that this step fails.
20049
+ (Optional) Fallback action to take in the event that this step fails.
20050
20050
 
20051
20051
  ---
20052
20052
 
@@ -20913,8 +20913,8 @@ const executeAutomationStepProps: ExecuteAutomationStepProps = { ... }
20913
20913
  | <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteAutomationStepProps.property.outputObserver">outputObserver</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.IObserver">IObserver</a></code> | (Optional) Allows for observing the output of steps as they run. |
20914
20914
  | <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteAutomationStepProps.property.isEnd">isEnd</a></code> | <code>boolean</code> | Whether to stop document execution after this step. |
20915
20915
  | <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteAutomationStepProps.property.maxAttempts">maxAttempts</a></code> | <code>number</code> | (Optional) max attempts to run this step if there are failures. |
20916
- | <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteAutomationStepProps.property.onCancel">onCancel</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | (Optional) Step to jump to in the event that this step is cancelled. |
20917
- | <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteAutomationStepProps.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | (Optional) Step to jump to in the event that this step fails. |
20916
+ | <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteAutomationStepProps.property.onCancel">onCancel</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a></code> | (Optional) Fallback action to take in the event that this step is cancelled. |
20917
+ | <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteAutomationStepProps.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a></code> | (Optional) Fallback action to take in the event that this step fails. |
20918
20918
  | <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteAutomationStepProps.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</code> | (Optional) timeout seconds to run this step. |
20919
20919
  | <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteAutomationStepProps.property.documentName">documentName</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.IStringVariable">IStringVariable</a></code> | *No description.* |
20920
20920
  | <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteAutomationStepProps.property.documentVersion">documentVersion</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.IStringVariable">IStringVariable</a></code> | *No description.* |
@@ -21013,26 +21013,26 @@ public readonly maxAttempts: number;
21013
21013
  ##### `onCancel`<sup>Optional</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.ExecuteAutomationStepProps.property.onCancel"></a>
21014
21014
 
21015
21015
  ```typescript
21016
- public readonly onCancel: AutomationStep;
21016
+ public readonly onCancel: OnCancel;
21017
21017
  ```
21018
21018
 
21019
- - *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
21019
+ - *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a>
21020
21020
  - *Default:* undefined
21021
21021
 
21022
- (Optional) Step to jump to in the event that this step is cancelled.
21022
+ (Optional) Fallback action to take in the event that this step is cancelled.
21023
21023
 
21024
21024
  ---
21025
21025
 
21026
21026
  ##### `onFailure`<sup>Optional</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.ExecuteAutomationStepProps.property.onFailure"></a>
21027
21027
 
21028
21028
  ```typescript
21029
- public readonly onFailure: AutomationStep;
21029
+ public readonly onFailure: OnFailure;
21030
21030
  ```
21031
21031
 
21032
- - *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
21032
+ - *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a>
21033
21033
  - *Default:* undefined
21034
21034
 
21035
- (Optional) Step to jump to in the event that this step fails.
21035
+ (Optional) Fallback action to take in the event that this step fails.
21036
21036
 
21037
21037
  ---
21038
21038
 
@@ -21173,8 +21173,8 @@ const executeScriptStepProps: ExecuteScriptStepProps = { ... }
21173
21173
  | <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteScriptStepProps.property.outputObserver">outputObserver</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.IObserver">IObserver</a></code> | (Optional) Allows for observing the output of steps as they run. |
21174
21174
  | <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteScriptStepProps.property.isEnd">isEnd</a></code> | <code>boolean</code> | Whether to stop document execution after this step. |
21175
21175
  | <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteScriptStepProps.property.maxAttempts">maxAttempts</a></code> | <code>number</code> | (Optional) max attempts to run this step if there are failures. |
21176
- | <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteScriptStepProps.property.onCancel">onCancel</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | (Optional) Step to jump to in the event that this step is cancelled. |
21177
- | <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteScriptStepProps.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | (Optional) Step to jump to in the event that this step fails. |
21176
+ | <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteScriptStepProps.property.onCancel">onCancel</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a></code> | (Optional) Fallback action to take in the event that this step is cancelled. |
21177
+ | <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteScriptStepProps.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a></code> | (Optional) Fallback action to take in the event that this step fails. |
21178
21178
  | <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteScriptStepProps.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</code> | (Optional) timeout seconds to run this step. |
21179
21179
  | <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteScriptStepProps.property.inputs">inputs</a></code> | <code>string[]</code> | (Optional) Inputs that the function needs in order to execute. |
21180
21180
  | <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteScriptStepProps.property.language">language</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.ScriptLanguage">ScriptLanguage</a></code> | (Required) Language used to execute the script. |
@@ -21269,26 +21269,26 @@ public readonly maxAttempts: number;
21269
21269
  ##### `onCancel`<sup>Optional</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.ExecuteScriptStepProps.property.onCancel"></a>
21270
21270
 
21271
21271
  ```typescript
21272
- public readonly onCancel: AutomationStep;
21272
+ public readonly onCancel: OnCancel;
21273
21273
  ```
21274
21274
 
21275
- - *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
21275
+ - *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a>
21276
21276
  - *Default:* undefined
21277
21277
 
21278
- (Optional) Step to jump to in the event that this step is cancelled.
21278
+ (Optional) Fallback action to take in the event that this step is cancelled.
21279
21279
 
21280
21280
  ---
21281
21281
 
21282
21282
  ##### `onFailure`<sup>Optional</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.ExecuteScriptStepProps.property.onFailure"></a>
21283
21283
 
21284
21284
  ```typescript
21285
- public readonly onFailure: AutomationStep;
21285
+ public readonly onFailure: OnFailure;
21286
21286
  ```
21287
21287
 
21288
- - *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
21288
+ - *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a>
21289
21289
  - *Default:* undefined
21290
21290
 
21291
- (Optional) Step to jump to in the event that this step fails.
21291
+ (Optional) Fallback action to take in the event that this step fails.
21292
21292
 
21293
21293
  ---
21294
21294
 
@@ -21414,8 +21414,8 @@ const executeStateMachineStepProps: ExecuteStateMachineStepProps = { ... }
21414
21414
  | <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteStateMachineStepProps.property.outputObserver">outputObserver</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.IObserver">IObserver</a></code> | (Optional) Allows for observing the output of steps as they run. |
21415
21415
  | <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteStateMachineStepProps.property.isEnd">isEnd</a></code> | <code>boolean</code> | Whether to stop document execution after this step. |
21416
21416
  | <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteStateMachineStepProps.property.maxAttempts">maxAttempts</a></code> | <code>number</code> | (Optional) max attempts to run this step if there are failures. |
21417
- | <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteStateMachineStepProps.property.onCancel">onCancel</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | (Optional) Step to jump to in the event that this step is cancelled. |
21418
- | <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteStateMachineStepProps.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | (Optional) Step to jump to in the event that this step fails. |
21417
+ | <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteStateMachineStepProps.property.onCancel">onCancel</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a></code> | (Optional) Fallback action to take in the event that this step is cancelled. |
21418
+ | <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteStateMachineStepProps.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a></code> | (Optional) Fallback action to take in the event that this step fails. |
21419
21419
  | <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteStateMachineStepProps.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</code> | (Optional) timeout seconds to run this step. |
21420
21420
  | <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteStateMachineStepProps.property.stateMachineArn">stateMachineArn</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.IStringVariable">IStringVariable</a></code> | The Amazon Resource Name (ARN) of the Step Functions state machine. |
21421
21421
  | <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteStateMachineStepProps.property.executionName">executionName</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.IStringVariable">IStringVariable</a></code> | (Optional) The name of the execution. |
@@ -21507,26 +21507,26 @@ public readonly maxAttempts: number;
21507
21507
  ##### `onCancel`<sup>Optional</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.ExecuteStateMachineStepProps.property.onCancel"></a>
21508
21508
 
21509
21509
  ```typescript
21510
- public readonly onCancel: AutomationStep;
21510
+ public readonly onCancel: OnCancel;
21511
21511
  ```
21512
21512
 
21513
- - *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
21513
+ - *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a>
21514
21514
  - *Default:* undefined
21515
21515
 
21516
- (Optional) Step to jump to in the event that this step is cancelled.
21516
+ (Optional) Fallback action to take in the event that this step is cancelled.
21517
21517
 
21518
21518
  ---
21519
21519
 
21520
21520
  ##### `onFailure`<sup>Optional</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.ExecuteStateMachineStepProps.property.onFailure"></a>
21521
21521
 
21522
21522
  ```typescript
21523
- public readonly onFailure: AutomationStep;
21523
+ public readonly onFailure: OnFailure;
21524
21524
  ```
21525
21525
 
21526
- - *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
21526
+ - *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a>
21527
21527
  - *Default:* undefined
21528
21528
 
21529
- (Optional) Step to jump to in the event that this step fails.
21529
+ (Optional) Fallback action to take in the event that this step fails.
21530
21530
 
21531
21531
  ---
21532
21532
 
@@ -22202,8 +22202,8 @@ const invokeLambdaFunctionStepProps: InvokeLambdaFunctionStepProps = { ... }
22202
22202
  | <code><a href="#@cdklabs/cdk-ssm-documents.InvokeLambdaFunctionStepProps.property.outputObserver">outputObserver</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.IObserver">IObserver</a></code> | (Optional) Allows for observing the output of steps as they run. |
22203
22203
  | <code><a href="#@cdklabs/cdk-ssm-documents.InvokeLambdaFunctionStepProps.property.isEnd">isEnd</a></code> | <code>boolean</code> | Whether to stop document execution after this step. |
22204
22204
  | <code><a href="#@cdklabs/cdk-ssm-documents.InvokeLambdaFunctionStepProps.property.maxAttempts">maxAttempts</a></code> | <code>number</code> | (Optional) max attempts to run this step if there are failures. |
22205
- | <code><a href="#@cdklabs/cdk-ssm-documents.InvokeLambdaFunctionStepProps.property.onCancel">onCancel</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | (Optional) Step to jump to in the event that this step is cancelled. |
22206
- | <code><a href="#@cdklabs/cdk-ssm-documents.InvokeLambdaFunctionStepProps.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | (Optional) Step to jump to in the event that this step fails. |
22205
+ | <code><a href="#@cdklabs/cdk-ssm-documents.InvokeLambdaFunctionStepProps.property.onCancel">onCancel</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a></code> | (Optional) Fallback action to take in the event that this step is cancelled. |
22206
+ | <code><a href="#@cdklabs/cdk-ssm-documents.InvokeLambdaFunctionStepProps.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a></code> | (Optional) Fallback action to take in the event that this step fails. |
22207
22207
  | <code><a href="#@cdklabs/cdk-ssm-documents.InvokeLambdaFunctionStepProps.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</code> | (Optional) timeout seconds to run this step. |
22208
22208
  | <code><a href="#@cdklabs/cdk-ssm-documents.InvokeLambdaFunctionStepProps.property.functionName">functionName</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.IStringVariable">IStringVariable</a></code> | The name of the Lambda function. |
22209
22209
  | <code><a href="#@cdklabs/cdk-ssm-documents.InvokeLambdaFunctionStepProps.property.clientContext">clientContext</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.IStringVariable">IStringVariable</a></code> | (Optional) The client-specific information. |
@@ -22298,26 +22298,26 @@ public readonly maxAttempts: number;
22298
22298
  ##### `onCancel`<sup>Optional</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.InvokeLambdaFunctionStepProps.property.onCancel"></a>
22299
22299
 
22300
22300
  ```typescript
22301
- public readonly onCancel: AutomationStep;
22301
+ public readonly onCancel: OnCancel;
22302
22302
  ```
22303
22303
 
22304
- - *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
22304
+ - *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a>
22305
22305
  - *Default:* undefined
22306
22306
 
22307
- (Optional) Step to jump to in the event that this step is cancelled.
22307
+ (Optional) Fallback action to take in the event that this step is cancelled.
22308
22308
 
22309
22309
  ---
22310
22310
 
22311
22311
  ##### `onFailure`<sup>Optional</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.InvokeLambdaFunctionStepProps.property.onFailure"></a>
22312
22312
 
22313
22313
  ```typescript
22314
- public readonly onFailure: AutomationStep;
22314
+ public readonly onFailure: OnFailure;
22315
22315
  ```
22316
22316
 
22317
- - *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
22317
+ - *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a>
22318
22318
  - *Default:* undefined
22319
22319
 
22320
- (Optional) Step to jump to in the event that this step fails.
22320
+ (Optional) Fallback action to take in the event that this step fails.
22321
22321
 
22322
22322
  ---
22323
22323
 
@@ -22561,8 +22561,8 @@ const invokeWebhookStepProps: InvokeWebhookStepProps = { ... }
22561
22561
  | <code><a href="#@cdklabs/cdk-ssm-documents.InvokeWebhookStepProps.property.outputObserver">outputObserver</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.IObserver">IObserver</a></code> | (Optional) Allows for observing the output of steps as they run. |
22562
22562
  | <code><a href="#@cdklabs/cdk-ssm-documents.InvokeWebhookStepProps.property.isEnd">isEnd</a></code> | <code>boolean</code> | Whether to stop document execution after this step. |
22563
22563
  | <code><a href="#@cdklabs/cdk-ssm-documents.InvokeWebhookStepProps.property.maxAttempts">maxAttempts</a></code> | <code>number</code> | (Optional) max attempts to run this step if there are failures. |
22564
- | <code><a href="#@cdklabs/cdk-ssm-documents.InvokeWebhookStepProps.property.onCancel">onCancel</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | (Optional) Step to jump to in the event that this step is cancelled. |
22565
- | <code><a href="#@cdklabs/cdk-ssm-documents.InvokeWebhookStepProps.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | (Optional) Step to jump to in the event that this step fails. |
22564
+ | <code><a href="#@cdklabs/cdk-ssm-documents.InvokeWebhookStepProps.property.onCancel">onCancel</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a></code> | (Optional) Fallback action to take in the event that this step is cancelled. |
22565
+ | <code><a href="#@cdklabs/cdk-ssm-documents.InvokeWebhookStepProps.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a></code> | (Optional) Fallback action to take in the event that this step fails. |
22566
22566
  | <code><a href="#@cdklabs/cdk-ssm-documents.InvokeWebhookStepProps.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</code> | (Optional) timeout seconds to run this step. |
22567
22567
  | <code><a href="#@cdklabs/cdk-ssm-documents.InvokeWebhookStepProps.property.integrationName">integrationName</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.IStringVariable">IStringVariable</a></code> | The name of the Automation integration. |
22568
22568
  | <code><a href="#@cdklabs/cdk-ssm-documents.InvokeWebhookStepProps.property.body">body</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.IStringVariable">IStringVariable</a></code> | (Optional) The payload you want to send when your webhook integration is invoked. |
@@ -22653,26 +22653,26 @@ public readonly maxAttempts: number;
22653
22653
  ##### `onCancel`<sup>Optional</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.InvokeWebhookStepProps.property.onCancel"></a>
22654
22654
 
22655
22655
  ```typescript
22656
- public readonly onCancel: AutomationStep;
22656
+ public readonly onCancel: OnCancel;
22657
22657
  ```
22658
22658
 
22659
- - *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
22659
+ - *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a>
22660
22660
  - *Default:* undefined
22661
22661
 
22662
- (Optional) Step to jump to in the event that this step is cancelled.
22662
+ (Optional) Fallback action to take in the event that this step is cancelled.
22663
22663
 
22664
22664
  ---
22665
22665
 
22666
22666
  ##### `onFailure`<sup>Optional</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.InvokeWebhookStepProps.property.onFailure"></a>
22667
22667
 
22668
22668
  ```typescript
22669
- public readonly onFailure: AutomationStep;
22669
+ public readonly onFailure: OnFailure;
22670
22670
  ```
22671
22671
 
22672
- - *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
22672
+ - *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a>
22673
22673
  - *Default:* undefined
22674
22674
 
22675
- (Optional) Step to jump to in the event that this step fails.
22675
+ (Optional) Fallback action to take in the event that this step fails.
22676
22676
 
22677
22677
  ---
22678
22678
 
@@ -23697,8 +23697,8 @@ const runCommandStepProps: RunCommandStepProps = { ... }
23697
23697
  | <code><a href="#@cdklabs/cdk-ssm-documents.RunCommandStepProps.property.outputObserver">outputObserver</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.IObserver">IObserver</a></code> | (Optional) Allows for observing the output of steps as they run. |
23698
23698
  | <code><a href="#@cdklabs/cdk-ssm-documents.RunCommandStepProps.property.isEnd">isEnd</a></code> | <code>boolean</code> | Whether to stop document execution after this step. |
23699
23699
  | <code><a href="#@cdklabs/cdk-ssm-documents.RunCommandStepProps.property.maxAttempts">maxAttempts</a></code> | <code>number</code> | (Optional) max attempts to run this step if there are failures. |
23700
- | <code><a href="#@cdklabs/cdk-ssm-documents.RunCommandStepProps.property.onCancel">onCancel</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | (Optional) Step to jump to in the event that this step is cancelled. |
23701
- | <code><a href="#@cdklabs/cdk-ssm-documents.RunCommandStepProps.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | (Optional) Step to jump to in the event that this step fails. |
23700
+ | <code><a href="#@cdklabs/cdk-ssm-documents.RunCommandStepProps.property.onCancel">onCancel</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a></code> | (Optional) Fallback action to take in the event that this step is cancelled. |
23701
+ | <code><a href="#@cdklabs/cdk-ssm-documents.RunCommandStepProps.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a></code> | (Optional) Fallback action to take in the event that this step fails. |
23702
23702
  | <code><a href="#@cdklabs/cdk-ssm-documents.RunCommandStepProps.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</code> | (Optional) timeout seconds to run this step. |
23703
23703
  | <code><a href="#@cdklabs/cdk-ssm-documents.RunCommandStepProps.property.documentName">documentName</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.IStringVariable">IStringVariable</a></code> | If the Command type document is owned by you or AWS, specify the name of the document. |
23704
23704
  | <code><a href="#@cdklabs/cdk-ssm-documents.RunCommandStepProps.property.targets">targets</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.IStringListVariable">IStringListVariable</a> \| <a href="#@cdklabs/cdk-ssm-documents.IMapListVariable">IMapListVariable</a></code> | The instance IDs where you want the command to run. You can specify a maximum of 50 IDs. |
@@ -23801,26 +23801,26 @@ public readonly maxAttempts: number;
23801
23801
  ##### `onCancel`<sup>Optional</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.RunCommandStepProps.property.onCancel"></a>
23802
23802
 
23803
23803
  ```typescript
23804
- public readonly onCancel: AutomationStep;
23804
+ public readonly onCancel: OnCancel;
23805
23805
  ```
23806
23806
 
23807
- - *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
23807
+ - *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a>
23808
23808
  - *Default:* undefined
23809
23809
 
23810
- (Optional) Step to jump to in the event that this step is cancelled.
23810
+ (Optional) Fallback action to take in the event that this step is cancelled.
23811
23811
 
23812
23812
  ---
23813
23813
 
23814
23814
  ##### `onFailure`<sup>Optional</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.RunCommandStepProps.property.onFailure"></a>
23815
23815
 
23816
23816
  ```typescript
23817
- public readonly onFailure: AutomationStep;
23817
+ public readonly onFailure: OnFailure;
23818
23818
  ```
23819
23819
 
23820
- - *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
23820
+ - *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a>
23821
23821
  - *Default:* undefined
23822
23822
 
23823
- (Optional) Step to jump to in the event that this step fails.
23823
+ (Optional) Fallback action to take in the event that this step fails.
23824
23824
 
23825
23825
  ---
23826
23826
 
@@ -24499,8 +24499,8 @@ const runInstanceStepProps: RunInstanceStepProps = { ... }
24499
24499
  | <code><a href="#@cdklabs/cdk-ssm-documents.RunInstanceStepProps.property.outputObserver">outputObserver</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.IObserver">IObserver</a></code> | (Optional) Allows for observing the output of steps as they run. |
24500
24500
  | <code><a href="#@cdklabs/cdk-ssm-documents.RunInstanceStepProps.property.isEnd">isEnd</a></code> | <code>boolean</code> | Whether to stop document execution after this step. |
24501
24501
  | <code><a href="#@cdklabs/cdk-ssm-documents.RunInstanceStepProps.property.maxAttempts">maxAttempts</a></code> | <code>number</code> | (Optional) max attempts to run this step if there are failures. |
24502
- | <code><a href="#@cdklabs/cdk-ssm-documents.RunInstanceStepProps.property.onCancel">onCancel</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | (Optional) Step to jump to in the event that this step is cancelled. |
24503
- | <code><a href="#@cdklabs/cdk-ssm-documents.RunInstanceStepProps.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | (Optional) Step to jump to in the event that this step fails. |
24502
+ | <code><a href="#@cdklabs/cdk-ssm-documents.RunInstanceStepProps.property.onCancel">onCancel</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a></code> | (Optional) Fallback action to take in the event that this step is cancelled. |
24503
+ | <code><a href="#@cdklabs/cdk-ssm-documents.RunInstanceStepProps.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a></code> | (Optional) Fallback action to take in the event that this step fails. |
24504
24504
  | <code><a href="#@cdklabs/cdk-ssm-documents.RunInstanceStepProps.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</code> | (Optional) timeout seconds to run this step. |
24505
24505
  | <code><a href="#@cdklabs/cdk-ssm-documents.RunInstanceStepProps.property.imageId">imageId</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.IStringVariable">IStringVariable</a></code> | The ID of the Amazon Machine Image (AMI). |
24506
24506
  | <code><a href="#@cdklabs/cdk-ssm-documents.RunInstanceStepProps.property.additionalInfo">additionalInfo</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.IStringVariable">IStringVariable</a></code> | (Optional) Reserved. |
@@ -24613,26 +24613,26 @@ public readonly maxAttempts: number;
24613
24613
  ##### `onCancel`<sup>Optional</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.RunInstanceStepProps.property.onCancel"></a>
24614
24614
 
24615
24615
  ```typescript
24616
- public readonly onCancel: AutomationStep;
24616
+ public readonly onCancel: OnCancel;
24617
24617
  ```
24618
24618
 
24619
- - *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
24619
+ - *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a>
24620
24620
  - *Default:* undefined
24621
24621
 
24622
- (Optional) Step to jump to in the event that this step is cancelled.
24622
+ (Optional) Fallback action to take in the event that this step is cancelled.
24623
24623
 
24624
24624
  ---
24625
24625
 
24626
24626
  ##### `onFailure`<sup>Optional</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.RunInstanceStepProps.property.onFailure"></a>
24627
24627
 
24628
24628
  ```typescript
24629
- public readonly onFailure: AutomationStep;
24629
+ public readonly onFailure: OnFailure;
24630
24630
  ```
24631
24631
 
24632
- - *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
24632
+ - *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a>
24633
24633
  - *Default:* undefined
24634
24634
 
24635
- (Optional) Step to jump to in the event that this step fails.
24635
+ (Optional) Fallback action to take in the event that this step fails.
24636
24636
 
24637
24637
  ---
24638
24638
 
@@ -25654,8 +25654,8 @@ const sleepStepProps: SleepStepProps = { ... }
25654
25654
  | <code><a href="#@cdklabs/cdk-ssm-documents.SleepStepProps.property.outputObserver">outputObserver</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.IObserver">IObserver</a></code> | (Optional) Allows for observing the output of steps as they run. |
25655
25655
  | <code><a href="#@cdklabs/cdk-ssm-documents.SleepStepProps.property.isEnd">isEnd</a></code> | <code>boolean</code> | Whether to stop document execution after this step. |
25656
25656
  | <code><a href="#@cdklabs/cdk-ssm-documents.SleepStepProps.property.maxAttempts">maxAttempts</a></code> | <code>number</code> | (Optional) max attempts to run this step if there are failures. |
25657
- | <code><a href="#@cdklabs/cdk-ssm-documents.SleepStepProps.property.onCancel">onCancel</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | (Optional) Step to jump to in the event that this step is cancelled. |
25658
- | <code><a href="#@cdklabs/cdk-ssm-documents.SleepStepProps.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | (Optional) Step to jump to in the event that this step fails. |
25657
+ | <code><a href="#@cdklabs/cdk-ssm-documents.SleepStepProps.property.onCancel">onCancel</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a></code> | (Optional) Fallback action to take in the event that this step is cancelled. |
25658
+ | <code><a href="#@cdklabs/cdk-ssm-documents.SleepStepProps.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a></code> | (Optional) Fallback action to take in the event that this step fails. |
25659
25659
  | <code><a href="#@cdklabs/cdk-ssm-documents.SleepStepProps.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</code> | (Optional) timeout seconds to run this step. |
25660
25660
  | <code><a href="#@cdklabs/cdk-ssm-documents.SleepStepProps.property.sleepSeconds">sleepSeconds</a></code> | <code>number</code> | (Required) The amount of seconds to sleep for. |
25661
25661
 
@@ -25745,26 +25745,26 @@ public readonly maxAttempts: number;
25745
25745
  ##### `onCancel`<sup>Optional</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.SleepStepProps.property.onCancel"></a>
25746
25746
 
25747
25747
  ```typescript
25748
- public readonly onCancel: AutomationStep;
25748
+ public readonly onCancel: OnCancel;
25749
25749
  ```
25750
25750
 
25751
- - *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
25751
+ - *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a>
25752
25752
  - *Default:* undefined
25753
25753
 
25754
- (Optional) Step to jump to in the event that this step is cancelled.
25754
+ (Optional) Fallback action to take in the event that this step is cancelled.
25755
25755
 
25756
25756
  ---
25757
25757
 
25758
25758
  ##### `onFailure`<sup>Optional</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.SleepStepProps.property.onFailure"></a>
25759
25759
 
25760
25760
  ```typescript
25761
- public readonly onFailure: AutomationStep;
25761
+ public readonly onFailure: OnFailure;
25762
25762
  ```
25763
25763
 
25764
- - *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
25764
+ - *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a>
25765
25765
  - *Default:* undefined
25766
25766
 
25767
- (Optional) Step to jump to in the event that this step fails.
25767
+ (Optional) Fallback action to take in the event that this step fails.
25768
25768
 
25769
25769
  ---
25770
25770
 
@@ -27202,8 +27202,8 @@ const waitForResourceStepProps: WaitForResourceStepProps = { ... }
27202
27202
  | <code><a href="#@cdklabs/cdk-ssm-documents.WaitForResourceStepProps.property.outputObserver">outputObserver</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.IObserver">IObserver</a></code> | (Optional) Allows for observing the output of steps as they run. |
27203
27203
  | <code><a href="#@cdklabs/cdk-ssm-documents.WaitForResourceStepProps.property.isEnd">isEnd</a></code> | <code>boolean</code> | Whether to stop document execution after this step. |
27204
27204
  | <code><a href="#@cdklabs/cdk-ssm-documents.WaitForResourceStepProps.property.maxAttempts">maxAttempts</a></code> | <code>number</code> | (Optional) max attempts to run this step if there are failures. |
27205
- | <code><a href="#@cdklabs/cdk-ssm-documents.WaitForResourceStepProps.property.onCancel">onCancel</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | (Optional) Step to jump to in the event that this step is cancelled. |
27206
- | <code><a href="#@cdklabs/cdk-ssm-documents.WaitForResourceStepProps.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | (Optional) Step to jump to in the event that this step fails. |
27205
+ | <code><a href="#@cdklabs/cdk-ssm-documents.WaitForResourceStepProps.property.onCancel">onCancel</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a></code> | (Optional) Fallback action to take in the event that this step is cancelled. |
27206
+ | <code><a href="#@cdklabs/cdk-ssm-documents.WaitForResourceStepProps.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a></code> | (Optional) Fallback action to take in the event that this step fails. |
27207
27207
  | <code><a href="#@cdklabs/cdk-ssm-documents.WaitForResourceStepProps.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</code> | (Optional) timeout seconds to run this step. |
27208
27208
  | <code><a href="#@cdklabs/cdk-ssm-documents.WaitForResourceStepProps.property.apiParams">apiParams</a></code> | <code>{[ key: string ]: any}</code> | (Required) API Params to submit with the request to the api. |
27209
27209
  | <code><a href="#@cdklabs/cdk-ssm-documents.WaitForResourceStepProps.property.pascalCaseApi">pascalCaseApi</a></code> | <code>string</code> | (Required) The AWS api represented in PascalCase. |
@@ -27299,26 +27299,26 @@ public readonly maxAttempts: number;
27299
27299
  ##### `onCancel`<sup>Optional</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.WaitForResourceStepProps.property.onCancel"></a>
27300
27300
 
27301
27301
  ```typescript
27302
- public readonly onCancel: AutomationStep;
27302
+ public readonly onCancel: OnCancel;
27303
27303
  ```
27304
27304
 
27305
- - *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
27305
+ - *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a>
27306
27306
  - *Default:* undefined
27307
27307
 
27308
- (Optional) Step to jump to in the event that this step is cancelled.
27308
+ (Optional) Fallback action to take in the event that this step is cancelled.
27309
27309
 
27310
27310
  ---
27311
27311
 
27312
27312
  ##### `onFailure`<sup>Optional</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.WaitForResourceStepProps.property.onFailure"></a>
27313
27313
 
27314
27314
  ```typescript
27315
- public readonly onFailure: AutomationStep;
27315
+ public readonly onFailure: OnFailure;
27316
27316
  ```
27317
27317
 
27318
- - *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
27318
+ - *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a>
27319
27319
  - *Default:* undefined
27320
27320
 
27321
- (Optional) Step to jump to in the event that this step fails.
27321
+ (Optional) Fallback action to take in the event that this step fails.
27322
27322
 
27323
27323
  ---
27324
27324
 
@@ -27464,6 +27464,121 @@ This is not used by SSM and is therefore not declared in the SSM yaml/json.
27464
27464
 
27465
27465
  ## Classes <a name="Classes" id="Classes"></a>
27466
27466
 
27467
+ ### Abort <a name="Abort" id="@cdklabs/cdk-ssm-documents.Abort"></a>
27468
+
27469
+ #### Initializers <a name="Initializers" id="@cdklabs/cdk-ssm-documents.Abort.Initializer"></a>
27470
+
27471
+ ```typescript
27472
+ import { Abort } from '@cdklabs/cdk-ssm-documents'
27473
+
27474
+ new Abort()
27475
+ ```
27476
+
27477
+ | **Name** | **Type** | **Description** |
27478
+ | --- | --- | --- |
27479
+
27480
+ ---
27481
+
27482
+ #### Methods <a name="Methods" id="Methods"></a>
27483
+
27484
+ | **Name** | **Description** |
27485
+ | --- | --- |
27486
+ | <code><a href="#@cdklabs/cdk-ssm-documents.Abort.stepToInvoke">stepToInvoke</a></code> | *No description.* |
27487
+ | <code><a href="#@cdklabs/cdk-ssm-documents.Abort.toSsmValue">toSsmValue</a></code> | *No description.* |
27488
+
27489
+ ---
27490
+
27491
+ ##### `stepToInvoke` <a name="stepToInvoke" id="@cdklabs/cdk-ssm-documents.Abort.stepToInvoke"></a>
27492
+
27493
+ ```typescript
27494
+ public stepToInvoke(_currentStep: AutomationStep): string
27495
+ ```
27496
+
27497
+ ###### `_currentStep`<sup>Required</sup> <a name="_currentStep" id="@cdklabs/cdk-ssm-documents.Abort.stepToInvoke.parameter._currentStep"></a>
27498
+
27499
+ - *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
27500
+
27501
+ ---
27502
+
27503
+ ##### `toSsmValue` <a name="toSsmValue" id="@cdklabs/cdk-ssm-documents.Abort.toSsmValue"></a>
27504
+
27505
+ ```typescript
27506
+ public toSsmValue(): string
27507
+ ```
27508
+
27509
+ #### Static Functions <a name="Static Functions" id="Static Functions"></a>
27510
+
27511
+ | **Name** | **Description** |
27512
+ | --- | --- |
27513
+ | <code><a href="#@cdklabs/cdk-ssm-documents.Abort.abort">abort</a></code> | To abort execution if a cancellation occurs during execution of the current step. |
27514
+ | <code><a href="#@cdklabs/cdk-ssm-documents.Abort.continue">continue</a></code> | To continue execution of the subsequent step if a failure occurs during execution of the current step. |
27515
+ | <code><a href="#@cdklabs/cdk-ssm-documents.Abort.invokeStep">invokeStep</a></code> | Invoke a specific step. |
27516
+ | <code><a href="#@cdklabs/cdk-ssm-documents.Abort.invokeStepByName">invokeStepByName</a></code> | Invoke a specific step by the step name for the OnCancel action. |
27517
+
27518
+ ---
27519
+
27520
+ ##### `abort` <a name="abort" id="@cdklabs/cdk-ssm-documents.Abort.abort"></a>
27521
+
27522
+ ```typescript
27523
+ import { Abort } from '@cdklabs/cdk-ssm-documents'
27524
+
27525
+ Abort.abort()
27526
+ ```
27527
+
27528
+ To abort execution if a cancellation occurs during execution of the current step.
27529
+
27530
+ (This is the default behavior.)
27531
+
27532
+ ##### `continue` <a name="continue" id="@cdklabs/cdk-ssm-documents.Abort.continue"></a>
27533
+
27534
+ ```typescript
27535
+ import { Abort } from '@cdklabs/cdk-ssm-documents'
27536
+
27537
+ Abort.continue()
27538
+ ```
27539
+
27540
+ To continue execution of the subsequent step if a failure occurs during execution of the current step.
27541
+
27542
+ ##### `invokeStep` <a name="invokeStep" id="@cdklabs/cdk-ssm-documents.Abort.invokeStep"></a>
27543
+
27544
+ ```typescript
27545
+ import { Abort } from '@cdklabs/cdk-ssm-documents'
27546
+
27547
+ Abort.invokeStep(step: AutomationStep)
27548
+ ```
27549
+
27550
+ Invoke a specific step.
27551
+
27552
+ Provide the step object to execute for the onCancel action.
27553
+ If you don't have a handle to the step object, use the invokeStepByName function.
27554
+ Not all action types may be invoked during cancellation. See documentation referenced on this class.
27555
+
27556
+ ###### `step`<sup>Required</sup> <a name="step" id="@cdklabs/cdk-ssm-documents.Abort.invokeStep.parameter.step"></a>
27557
+
27558
+ - *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
27559
+
27560
+ ---
27561
+
27562
+ ##### `invokeStepByName` <a name="invokeStepByName" id="@cdklabs/cdk-ssm-documents.Abort.invokeStepByName"></a>
27563
+
27564
+ ```typescript
27565
+ import { Abort } from '@cdklabs/cdk-ssm-documents'
27566
+
27567
+ Abort.invokeStepByName(stepName: string)
27568
+ ```
27569
+
27570
+ Invoke a specific step by the step name for the OnCancel action.
27571
+
27572
+ Not all action types may be invoked during cancellation. See documentation referenced on this class.
27573
+
27574
+ ###### `stepName`<sup>Required</sup> <a name="stepName" id="@cdklabs/cdk-ssm-documents.Abort.invokeStepByName.parameter.stepName"></a>
27575
+
27576
+ - *Type:* string
27577
+
27578
+ ---
27579
+
27580
+
27581
+
27467
27582
  ### ActionVariable <a name="ActionVariable" id="@cdklabs/cdk-ssm-documents.ActionVariable"></a>
27468
27583
 
27469
27584
  - *Implements:* <a href="#@cdklabs/cdk-ssm-documents.IActionVariable">IActionVariable</a>
@@ -29242,6 +29357,118 @@ public readonly step: CommandStep;
29242
29357
  ---
29243
29358
 
29244
29359
 
29360
+ ### Continue <a name="Continue" id="@cdklabs/cdk-ssm-documents.Continue"></a>
29361
+
29362
+ #### Initializers <a name="Initializers" id="@cdklabs/cdk-ssm-documents.Continue.Initializer"></a>
29363
+
29364
+ ```typescript
29365
+ import { Continue } from '@cdklabs/cdk-ssm-documents'
29366
+
29367
+ new Continue()
29368
+ ```
29369
+
29370
+ | **Name** | **Type** | **Description** |
29371
+ | --- | --- | --- |
29372
+
29373
+ ---
29374
+
29375
+ #### Methods <a name="Methods" id="Methods"></a>
29376
+
29377
+ | **Name** | **Description** |
29378
+ | --- | --- |
29379
+ | <code><a href="#@cdklabs/cdk-ssm-documents.Continue.stepToInvoke">stepToInvoke</a></code> | *No description.* |
29380
+ | <code><a href="#@cdklabs/cdk-ssm-documents.Continue.toSsmValue">toSsmValue</a></code> | *No description.* |
29381
+
29382
+ ---
29383
+
29384
+ ##### `stepToInvoke` <a name="stepToInvoke" id="@cdklabs/cdk-ssm-documents.Continue.stepToInvoke"></a>
29385
+
29386
+ ```typescript
29387
+ public stepToInvoke(currentStep: AutomationStep): string
29388
+ ```
29389
+
29390
+ ###### `currentStep`<sup>Required</sup> <a name="currentStep" id="@cdklabs/cdk-ssm-documents.Continue.stepToInvoke.parameter.currentStep"></a>
29391
+
29392
+ - *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
29393
+
29394
+ ---
29395
+
29396
+ ##### `toSsmValue` <a name="toSsmValue" id="@cdklabs/cdk-ssm-documents.Continue.toSsmValue"></a>
29397
+
29398
+ ```typescript
29399
+ public toSsmValue(): string
29400
+ ```
29401
+
29402
+ #### Static Functions <a name="Static Functions" id="Static Functions"></a>
29403
+
29404
+ | **Name** | **Description** |
29405
+ | --- | --- |
29406
+ | <code><a href="#@cdklabs/cdk-ssm-documents.Continue.abort">abort</a></code> | To abort execution if a failure occurs during execution of the current step. |
29407
+ | <code><a href="#@cdklabs/cdk-ssm-documents.Continue.continue">continue</a></code> | To continue execution of the subsequent step if a failure occurs during execution of the current step. |
29408
+ | <code><a href="#@cdklabs/cdk-ssm-documents.Continue.invokeStep">invokeStep</a></code> | Invoke a specific step. |
29409
+ | <code><a href="#@cdklabs/cdk-ssm-documents.Continue.invokeStepByName">invokeStepByName</a></code> | Invoke a specific step by the step name for the OnFailure action. |
29410
+
29411
+ ---
29412
+
29413
+ ##### `abort` <a name="abort" id="@cdklabs/cdk-ssm-documents.Continue.abort"></a>
29414
+
29415
+ ```typescript
29416
+ import { Continue } from '@cdklabs/cdk-ssm-documents'
29417
+
29418
+ Continue.abort()
29419
+ ```
29420
+
29421
+ To abort execution if a failure occurs during execution of the current step.
29422
+
29423
+ (This is the default behavior.)
29424
+
29425
+ ##### `continue` <a name="continue" id="@cdklabs/cdk-ssm-documents.Continue.continue"></a>
29426
+
29427
+ ```typescript
29428
+ import { Continue } from '@cdklabs/cdk-ssm-documents'
29429
+
29430
+ Continue.continue()
29431
+ ```
29432
+
29433
+ To continue execution of the subsequent step if a failure occurs during execution of the current step.
29434
+
29435
+ ##### `invokeStep` <a name="invokeStep" id="@cdklabs/cdk-ssm-documents.Continue.invokeStep"></a>
29436
+
29437
+ ```typescript
29438
+ import { Continue } from '@cdklabs/cdk-ssm-documents'
29439
+
29440
+ Continue.invokeStep(step: AutomationStep)
29441
+ ```
29442
+
29443
+ Invoke a specific step.
29444
+
29445
+ Provide the step object to execute for the onFailure action.
29446
+ If you don't have a handle to the step object, use the invokeStepByName function.
29447
+
29448
+ ###### `step`<sup>Required</sup> <a name="step" id="@cdklabs/cdk-ssm-documents.Continue.invokeStep.parameter.step"></a>
29449
+
29450
+ - *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
29451
+
29452
+ ---
29453
+
29454
+ ##### `invokeStepByName` <a name="invokeStepByName" id="@cdklabs/cdk-ssm-documents.Continue.invokeStepByName"></a>
29455
+
29456
+ ```typescript
29457
+ import { Continue } from '@cdklabs/cdk-ssm-documents'
29458
+
29459
+ Continue.invokeStepByName(stepName: string)
29460
+ ```
29461
+
29462
+ Invoke a specific step by the step name for the OnFailure action.
29463
+
29464
+ ###### `stepName`<sup>Required</sup> <a name="stepName" id="@cdklabs/cdk-ssm-documents.Continue.invokeStepByName.parameter.stepName"></a>
29465
+
29466
+ - *Type:* string
29467
+
29468
+ ---
29469
+
29470
+
29471
+
29245
29472
  ### CopyImageSimulation <a name="CopyImageSimulation" id="@cdklabs/cdk-ssm-documents.CopyImageSimulation"></a>
29246
29473
 
29247
29474
  AutomationStep implemenation for aws:copyImage https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-action-copyimage.html.
@@ -35532,6 +35759,245 @@ public readonly reference: string;
35532
35759
  ---
35533
35760
 
35534
35761
 
35762
+ ### OnCancel <a name="OnCancel" id="@cdklabs/cdk-ssm-documents.OnCancel"></a>
35763
+
35764
+ Steps can specify an action to take onCancel.
35765
+
35766
+ See docs here: https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-actions.html#canProp
35767
+ The supported actions are abort (default) or invoking a specific step.
35768
+ This behavior can be adopted by using the static methods available on OnCancel.
35769
+
35770
+ #### Initializers <a name="Initializers" id="@cdklabs/cdk-ssm-documents.OnCancel.Initializer"></a>
35771
+
35772
+ ```typescript
35773
+ import { OnCancel } from '@cdklabs/cdk-ssm-documents'
35774
+
35775
+ new OnCancel()
35776
+ ```
35777
+
35778
+ | **Name** | **Type** | **Description** |
35779
+ | --- | --- | --- |
35780
+
35781
+ ---
35782
+
35783
+ #### Methods <a name="Methods" id="Methods"></a>
35784
+
35785
+ | **Name** | **Description** |
35786
+ | --- | --- |
35787
+ | <code><a href="#@cdklabs/cdk-ssm-documents.OnCancel.stepToInvoke">stepToInvoke</a></code> | *No description.* |
35788
+ | <code><a href="#@cdklabs/cdk-ssm-documents.OnCancel.toSsmValue">toSsmValue</a></code> | *No description.* |
35789
+
35790
+ ---
35791
+
35792
+ ##### `stepToInvoke` <a name="stepToInvoke" id="@cdklabs/cdk-ssm-documents.OnCancel.stepToInvoke"></a>
35793
+
35794
+ ```typescript
35795
+ public stepToInvoke(currentStep: AutomationStep): string
35796
+ ```
35797
+
35798
+ ###### `currentStep`<sup>Required</sup> <a name="currentStep" id="@cdklabs/cdk-ssm-documents.OnCancel.stepToInvoke.parameter.currentStep"></a>
35799
+
35800
+ - *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
35801
+
35802
+ ---
35803
+
35804
+ ##### `toSsmValue` <a name="toSsmValue" id="@cdklabs/cdk-ssm-documents.OnCancel.toSsmValue"></a>
35805
+
35806
+ ```typescript
35807
+ public toSsmValue(): string
35808
+ ```
35809
+
35810
+ #### Static Functions <a name="Static Functions" id="Static Functions"></a>
35811
+
35812
+ | **Name** | **Description** |
35813
+ | --- | --- |
35814
+ | <code><a href="#@cdklabs/cdk-ssm-documents.OnCancel.abort">abort</a></code> | To abort execution if a cancellation occurs during execution of the current step. |
35815
+ | <code><a href="#@cdklabs/cdk-ssm-documents.OnCancel.continue">continue</a></code> | To continue execution of the subsequent step if a failure occurs during execution of the current step. |
35816
+ | <code><a href="#@cdklabs/cdk-ssm-documents.OnCancel.invokeStep">invokeStep</a></code> | Invoke a specific step. |
35817
+ | <code><a href="#@cdklabs/cdk-ssm-documents.OnCancel.invokeStepByName">invokeStepByName</a></code> | Invoke a specific step by the step name for the OnCancel action. |
35818
+
35819
+ ---
35820
+
35821
+ ##### `abort` <a name="abort" id="@cdklabs/cdk-ssm-documents.OnCancel.abort"></a>
35822
+
35823
+ ```typescript
35824
+ import { OnCancel } from '@cdklabs/cdk-ssm-documents'
35825
+
35826
+ OnCancel.abort()
35827
+ ```
35828
+
35829
+ To abort execution if a cancellation occurs during execution of the current step.
35830
+
35831
+ (This is the default behavior.)
35832
+
35833
+ ##### `continue` <a name="continue" id="@cdklabs/cdk-ssm-documents.OnCancel.continue"></a>
35834
+
35835
+ ```typescript
35836
+ import { OnCancel } from '@cdklabs/cdk-ssm-documents'
35837
+
35838
+ OnCancel.continue()
35839
+ ```
35840
+
35841
+ To continue execution of the subsequent step if a failure occurs during execution of the current step.
35842
+
35843
+ ##### `invokeStep` <a name="invokeStep" id="@cdklabs/cdk-ssm-documents.OnCancel.invokeStep"></a>
35844
+
35845
+ ```typescript
35846
+ import { OnCancel } from '@cdklabs/cdk-ssm-documents'
35847
+
35848
+ OnCancel.invokeStep(step: AutomationStep)
35849
+ ```
35850
+
35851
+ Invoke a specific step.
35852
+
35853
+ Provide the step object to execute for the onCancel action.
35854
+ If you don't have a handle to the step object, use the invokeStepByName function.
35855
+ Not all action types may be invoked during cancellation. See documentation referenced on this class.
35856
+
35857
+ ###### `step`<sup>Required</sup> <a name="step" id="@cdklabs/cdk-ssm-documents.OnCancel.invokeStep.parameter.step"></a>
35858
+
35859
+ - *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
35860
+
35861
+ ---
35862
+
35863
+ ##### `invokeStepByName` <a name="invokeStepByName" id="@cdklabs/cdk-ssm-documents.OnCancel.invokeStepByName"></a>
35864
+
35865
+ ```typescript
35866
+ import { OnCancel } from '@cdklabs/cdk-ssm-documents'
35867
+
35868
+ OnCancel.invokeStepByName(stepName: string)
35869
+ ```
35870
+
35871
+ Invoke a specific step by the step name for the OnCancel action.
35872
+
35873
+ Not all action types may be invoked during cancellation. See documentation referenced on this class.
35874
+
35875
+ ###### `stepName`<sup>Required</sup> <a name="stepName" id="@cdklabs/cdk-ssm-documents.OnCancel.invokeStepByName.parameter.stepName"></a>
35876
+
35877
+ - *Type:* string
35878
+
35879
+ ---
35880
+
35881
+
35882
+
35883
+ ### OnFailure <a name="OnFailure" id="@cdklabs/cdk-ssm-documents.OnFailure"></a>
35884
+
35885
+ Steps can specify an action to take onFailure.
35886
+
35887
+ See docs here: https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-actions.html#failProp
35888
+ The supported actions are abort (default), continue, or invoking a specific step.
35889
+ This behavior can be adopted by using the static methods available on OnFailure.
35890
+
35891
+ #### Initializers <a name="Initializers" id="@cdklabs/cdk-ssm-documents.OnFailure.Initializer"></a>
35892
+
35893
+ ```typescript
35894
+ import { OnFailure } from '@cdklabs/cdk-ssm-documents'
35895
+
35896
+ new OnFailure()
35897
+ ```
35898
+
35899
+ | **Name** | **Type** | **Description** |
35900
+ | --- | --- | --- |
35901
+
35902
+ ---
35903
+
35904
+ #### Methods <a name="Methods" id="Methods"></a>
35905
+
35906
+ | **Name** | **Description** |
35907
+ | --- | --- |
35908
+ | <code><a href="#@cdklabs/cdk-ssm-documents.OnFailure.stepToInvoke">stepToInvoke</a></code> | *No description.* |
35909
+ | <code><a href="#@cdklabs/cdk-ssm-documents.OnFailure.toSsmValue">toSsmValue</a></code> | *No description.* |
35910
+
35911
+ ---
35912
+
35913
+ ##### `stepToInvoke` <a name="stepToInvoke" id="@cdklabs/cdk-ssm-documents.OnFailure.stepToInvoke"></a>
35914
+
35915
+ ```typescript
35916
+ public stepToInvoke(currentStep: AutomationStep): string
35917
+ ```
35918
+
35919
+ ###### `currentStep`<sup>Required</sup> <a name="currentStep" id="@cdklabs/cdk-ssm-documents.OnFailure.stepToInvoke.parameter.currentStep"></a>
35920
+
35921
+ - *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
35922
+
35923
+ ---
35924
+
35925
+ ##### `toSsmValue` <a name="toSsmValue" id="@cdklabs/cdk-ssm-documents.OnFailure.toSsmValue"></a>
35926
+
35927
+ ```typescript
35928
+ public toSsmValue(): string
35929
+ ```
35930
+
35931
+ #### Static Functions <a name="Static Functions" id="Static Functions"></a>
35932
+
35933
+ | **Name** | **Description** |
35934
+ | --- | --- |
35935
+ | <code><a href="#@cdklabs/cdk-ssm-documents.OnFailure.abort">abort</a></code> | To abort execution if a failure occurs during execution of the current step. |
35936
+ | <code><a href="#@cdklabs/cdk-ssm-documents.OnFailure.continue">continue</a></code> | To continue execution of the subsequent step if a failure occurs during execution of the current step. |
35937
+ | <code><a href="#@cdklabs/cdk-ssm-documents.OnFailure.invokeStep">invokeStep</a></code> | Invoke a specific step. |
35938
+ | <code><a href="#@cdklabs/cdk-ssm-documents.OnFailure.invokeStepByName">invokeStepByName</a></code> | Invoke a specific step by the step name for the OnFailure action. |
35939
+
35940
+ ---
35941
+
35942
+ ##### `abort` <a name="abort" id="@cdklabs/cdk-ssm-documents.OnFailure.abort"></a>
35943
+
35944
+ ```typescript
35945
+ import { OnFailure } from '@cdklabs/cdk-ssm-documents'
35946
+
35947
+ OnFailure.abort()
35948
+ ```
35949
+
35950
+ To abort execution if a failure occurs during execution of the current step.
35951
+
35952
+ (This is the default behavior.)
35953
+
35954
+ ##### `continue` <a name="continue" id="@cdklabs/cdk-ssm-documents.OnFailure.continue"></a>
35955
+
35956
+ ```typescript
35957
+ import { OnFailure } from '@cdklabs/cdk-ssm-documents'
35958
+
35959
+ OnFailure.continue()
35960
+ ```
35961
+
35962
+ To continue execution of the subsequent step if a failure occurs during execution of the current step.
35963
+
35964
+ ##### `invokeStep` <a name="invokeStep" id="@cdklabs/cdk-ssm-documents.OnFailure.invokeStep"></a>
35965
+
35966
+ ```typescript
35967
+ import { OnFailure } from '@cdklabs/cdk-ssm-documents'
35968
+
35969
+ OnFailure.invokeStep(step: AutomationStep)
35970
+ ```
35971
+
35972
+ Invoke a specific step.
35973
+
35974
+ Provide the step object to execute for the onFailure action.
35975
+ If you don't have a handle to the step object, use the invokeStepByName function.
35976
+
35977
+ ###### `step`<sup>Required</sup> <a name="step" id="@cdklabs/cdk-ssm-documents.OnFailure.invokeStep.parameter.step"></a>
35978
+
35979
+ - *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
35980
+
35981
+ ---
35982
+
35983
+ ##### `invokeStepByName` <a name="invokeStepByName" id="@cdklabs/cdk-ssm-documents.OnFailure.invokeStepByName"></a>
35984
+
35985
+ ```typescript
35986
+ import { OnFailure } from '@cdklabs/cdk-ssm-documents'
35987
+
35988
+ OnFailure.invokeStepByName(stepName: string)
35989
+ ```
35990
+
35991
+ Invoke a specific step by the step name for the OnFailure action.
35992
+
35993
+ ###### `stepName`<sup>Required</sup> <a name="stepName" id="@cdklabs/cdk-ssm-documents.OnFailure.invokeStepByName.parameter.stepName"></a>
35994
+
35995
+ - *Type:* string
35996
+
35997
+ ---
35998
+
35999
+
36000
+
35535
36001
  ### OnFailureVariable <a name="OnFailureVariable" id="@cdklabs/cdk-ssm-documents.OnFailureVariable"></a>
35536
36002
 
35537
36003
  - *Implements:* <a href="#@cdklabs/cdk-ssm-documents.IOnFailureVariable">IOnFailureVariable</a>
@@ -37496,6 +37962,326 @@ public readonly secureToken: string;
37496
37962
  ---
37497
37963
 
37498
37964
 
37965
+ ### StepFallback <a name="StepFallback" id="@cdklabs/cdk-ssm-documents.StepFallback"></a>
37966
+
37967
+ #### Initializers <a name="Initializers" id="@cdklabs/cdk-ssm-documents.StepFallback.Initializer"></a>
37968
+
37969
+ ```typescript
37970
+ import { StepFallback } from '@cdklabs/cdk-ssm-documents'
37971
+
37972
+ new StepFallback(step: AutomationStep, validateStepAction: boolean)
37973
+ ```
37974
+
37975
+ | **Name** | **Type** | **Description** |
37976
+ | --- | --- | --- |
37977
+ | <code><a href="#@cdklabs/cdk-ssm-documents.StepFallback.Initializer.parameter.step">step</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | *No description.* |
37978
+ | <code><a href="#@cdklabs/cdk-ssm-documents.StepFallback.Initializer.parameter.validateStepAction">validateStepAction</a></code> | <code>boolean</code> | *No description.* |
37979
+
37980
+ ---
37981
+
37982
+ ##### `step`<sup>Required</sup> <a name="step" id="@cdklabs/cdk-ssm-documents.StepFallback.Initializer.parameter.step"></a>
37983
+
37984
+ - *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
37985
+
37986
+ ---
37987
+
37988
+ ##### `validateStepAction`<sup>Required</sup> <a name="validateStepAction" id="@cdklabs/cdk-ssm-documents.StepFallback.Initializer.parameter.validateStepAction"></a>
37989
+
37990
+ - *Type:* boolean
37991
+
37992
+ ---
37993
+
37994
+ #### Methods <a name="Methods" id="Methods"></a>
37995
+
37996
+ | **Name** | **Description** |
37997
+ | --- | --- |
37998
+ | <code><a href="#@cdklabs/cdk-ssm-documents.StepFallback.stepToInvoke">stepToInvoke</a></code> | *No description.* |
37999
+ | <code><a href="#@cdklabs/cdk-ssm-documents.StepFallback.toSsmValue">toSsmValue</a></code> | *No description.* |
38000
+
38001
+ ---
38002
+
38003
+ ##### `stepToInvoke` <a name="stepToInvoke" id="@cdklabs/cdk-ssm-documents.StepFallback.stepToInvoke"></a>
38004
+
38005
+ ```typescript
38006
+ public stepToInvoke(_currentStep: AutomationStep): string
38007
+ ```
38008
+
38009
+ ###### `_currentStep`<sup>Required</sup> <a name="_currentStep" id="@cdklabs/cdk-ssm-documents.StepFallback.stepToInvoke.parameter._currentStep"></a>
38010
+
38011
+ - *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
38012
+
38013
+ ---
38014
+
38015
+ ##### `toSsmValue` <a name="toSsmValue" id="@cdklabs/cdk-ssm-documents.StepFallback.toSsmValue"></a>
38016
+
38017
+ ```typescript
38018
+ public toSsmValue(): string
38019
+ ```
38020
+
38021
+ #### Static Functions <a name="Static Functions" id="Static Functions"></a>
38022
+
38023
+ | **Name** | **Description** |
38024
+ | --- | --- |
38025
+ | <code><a href="#@cdklabs/cdk-ssm-documents.StepFallback.abort">abort</a></code> | To abort execution if a cancellation occurs during execution of the current step. |
38026
+ | <code><a href="#@cdklabs/cdk-ssm-documents.StepFallback.continue">continue</a></code> | To continue execution of the subsequent step if a failure occurs during execution of the current step. |
38027
+ | <code><a href="#@cdklabs/cdk-ssm-documents.StepFallback.invokeStep">invokeStep</a></code> | Invoke a specific step. |
38028
+ | <code><a href="#@cdklabs/cdk-ssm-documents.StepFallback.invokeStepByName">invokeStepByName</a></code> | Invoke a specific step by the step name for the OnCancel action. |
38029
+
38030
+ ---
38031
+
38032
+ ##### `abort` <a name="abort" id="@cdklabs/cdk-ssm-documents.StepFallback.abort"></a>
38033
+
38034
+ ```typescript
38035
+ import { StepFallback } from '@cdklabs/cdk-ssm-documents'
38036
+
38037
+ StepFallback.abort()
38038
+ ```
38039
+
38040
+ To abort execution if a cancellation occurs during execution of the current step.
38041
+
38042
+ (This is the default behavior.)
38043
+
38044
+ ##### `continue` <a name="continue" id="@cdklabs/cdk-ssm-documents.StepFallback.continue"></a>
38045
+
38046
+ ```typescript
38047
+ import { StepFallback } from '@cdklabs/cdk-ssm-documents'
38048
+
38049
+ StepFallback.continue()
38050
+ ```
38051
+
38052
+ To continue execution of the subsequent step if a failure occurs during execution of the current step.
38053
+
38054
+ ##### `invokeStep` <a name="invokeStep" id="@cdklabs/cdk-ssm-documents.StepFallback.invokeStep"></a>
38055
+
38056
+ ```typescript
38057
+ import { StepFallback } from '@cdklabs/cdk-ssm-documents'
38058
+
38059
+ StepFallback.invokeStep(step: AutomationStep)
38060
+ ```
38061
+
38062
+ Invoke a specific step.
38063
+
38064
+ Provide the step object to execute for the onCancel action.
38065
+ If you don't have a handle to the step object, use the invokeStepByName function.
38066
+ Not all action types may be invoked during cancellation. See documentation referenced on this class.
38067
+
38068
+ ###### `step`<sup>Required</sup> <a name="step" id="@cdklabs/cdk-ssm-documents.StepFallback.invokeStep.parameter.step"></a>
38069
+
38070
+ - *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
38071
+
38072
+ ---
38073
+
38074
+ ##### `invokeStepByName` <a name="invokeStepByName" id="@cdklabs/cdk-ssm-documents.StepFallback.invokeStepByName"></a>
38075
+
38076
+ ```typescript
38077
+ import { StepFallback } from '@cdklabs/cdk-ssm-documents'
38078
+
38079
+ StepFallback.invokeStepByName(stepName: string)
38080
+ ```
38081
+
38082
+ Invoke a specific step by the step name for the OnCancel action.
38083
+
38084
+ Not all action types may be invoked during cancellation. See documentation referenced on this class.
38085
+
38086
+ ###### `stepName`<sup>Required</sup> <a name="stepName" id="@cdklabs/cdk-ssm-documents.StepFallback.invokeStepByName.parameter.stepName"></a>
38087
+
38088
+ - *Type:* string
38089
+
38090
+ ---
38091
+
38092
+ #### Properties <a name="Properties" id="Properties"></a>
38093
+
38094
+ | **Name** | **Type** | **Description** |
38095
+ | --- | --- | --- |
38096
+ | <code><a href="#@cdklabs/cdk-ssm-documents.StepFallback.property.step">step</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a></code> | *No description.* |
38097
+
38098
+ ---
38099
+
38100
+ ##### `step`<sup>Required</sup> <a name="step" id="@cdklabs/cdk-ssm-documents.StepFallback.property.step"></a>
38101
+
38102
+ ```typescript
38103
+ public readonly step: AutomationStep;
38104
+ ```
38105
+
38106
+ - *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
38107
+
38108
+ ---
38109
+
38110
+ #### Constants <a name="Constants" id="Constants"></a>
38111
+
38112
+ | **Name** | **Type** | **Description** |
38113
+ | --- | --- | --- |
38114
+ | <code><a href="#@cdklabs/cdk-ssm-documents.StepFallback.property.ILLEGAL_FALLBACK_ACTIONS">ILLEGAL_FALLBACK_ACTIONS</a></code> | <code>string[]</code> | *No description.* |
38115
+
38116
+ ---
38117
+
38118
+ ##### `ILLEGAL_FALLBACK_ACTIONS`<sup>Required</sup> <a name="ILLEGAL_FALLBACK_ACTIONS" id="@cdklabs/cdk-ssm-documents.StepFallback.property.ILLEGAL_FALLBACK_ACTIONS"></a>
38119
+
38120
+ ```typescript
38121
+ public readonly ILLEGAL_FALLBACK_ACTIONS: string[];
38122
+ ```
38123
+
38124
+ - *Type:* string[]
38125
+
38126
+ ---
38127
+
38128
+ ### StepNameFallback <a name="StepNameFallback" id="@cdklabs/cdk-ssm-documents.StepNameFallback"></a>
38129
+
38130
+ #### Initializers <a name="Initializers" id="@cdklabs/cdk-ssm-documents.StepNameFallback.Initializer"></a>
38131
+
38132
+ ```typescript
38133
+ import { StepNameFallback } from '@cdklabs/cdk-ssm-documents'
38134
+
38135
+ new StepNameFallback(step: string, validateStepAction: boolean)
38136
+ ```
38137
+
38138
+ | **Name** | **Type** | **Description** |
38139
+ | --- | --- | --- |
38140
+ | <code><a href="#@cdklabs/cdk-ssm-documents.StepNameFallback.Initializer.parameter.step">step</a></code> | <code>string</code> | *No description.* |
38141
+ | <code><a href="#@cdklabs/cdk-ssm-documents.StepNameFallback.Initializer.parameter.validateStepAction">validateStepAction</a></code> | <code>boolean</code> | *No description.* |
38142
+
38143
+ ---
38144
+
38145
+ ##### `step`<sup>Required</sup> <a name="step" id="@cdklabs/cdk-ssm-documents.StepNameFallback.Initializer.parameter.step"></a>
38146
+
38147
+ - *Type:* string
38148
+
38149
+ ---
38150
+
38151
+ ##### `validateStepAction`<sup>Required</sup> <a name="validateStepAction" id="@cdklabs/cdk-ssm-documents.StepNameFallback.Initializer.parameter.validateStepAction"></a>
38152
+
38153
+ - *Type:* boolean
38154
+
38155
+ ---
38156
+
38157
+ #### Methods <a name="Methods" id="Methods"></a>
38158
+
38159
+ | **Name** | **Description** |
38160
+ | --- | --- |
38161
+ | <code><a href="#@cdklabs/cdk-ssm-documents.StepNameFallback.stepToInvoke">stepToInvoke</a></code> | *No description.* |
38162
+ | <code><a href="#@cdklabs/cdk-ssm-documents.StepNameFallback.toSsmValue">toSsmValue</a></code> | *No description.* |
38163
+
38164
+ ---
38165
+
38166
+ ##### `stepToInvoke` <a name="stepToInvoke" id="@cdklabs/cdk-ssm-documents.StepNameFallback.stepToInvoke"></a>
38167
+
38168
+ ```typescript
38169
+ public stepToInvoke(currentStep: AutomationStep): string
38170
+ ```
38171
+
38172
+ ###### `currentStep`<sup>Required</sup> <a name="currentStep" id="@cdklabs/cdk-ssm-documents.StepNameFallback.stepToInvoke.parameter.currentStep"></a>
38173
+
38174
+ - *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
38175
+
38176
+ ---
38177
+
38178
+ ##### `toSsmValue` <a name="toSsmValue" id="@cdklabs/cdk-ssm-documents.StepNameFallback.toSsmValue"></a>
38179
+
38180
+ ```typescript
38181
+ public toSsmValue(): string
38182
+ ```
38183
+
38184
+ #### Static Functions <a name="Static Functions" id="Static Functions"></a>
38185
+
38186
+ | **Name** | **Description** |
38187
+ | --- | --- |
38188
+ | <code><a href="#@cdklabs/cdk-ssm-documents.StepNameFallback.abort">abort</a></code> | To abort execution if a cancellation occurs during execution of the current step. |
38189
+ | <code><a href="#@cdklabs/cdk-ssm-documents.StepNameFallback.continue">continue</a></code> | To continue execution of the subsequent step if a failure occurs during execution of the current step. |
38190
+ | <code><a href="#@cdklabs/cdk-ssm-documents.StepNameFallback.invokeStep">invokeStep</a></code> | Invoke a specific step. |
38191
+ | <code><a href="#@cdklabs/cdk-ssm-documents.StepNameFallback.invokeStepByName">invokeStepByName</a></code> | Invoke a specific step by the step name for the OnCancel action. |
38192
+
38193
+ ---
38194
+
38195
+ ##### `abort` <a name="abort" id="@cdklabs/cdk-ssm-documents.StepNameFallback.abort"></a>
38196
+
38197
+ ```typescript
38198
+ import { StepNameFallback } from '@cdklabs/cdk-ssm-documents'
38199
+
38200
+ StepNameFallback.abort()
38201
+ ```
38202
+
38203
+ To abort execution if a cancellation occurs during execution of the current step.
38204
+
38205
+ (This is the default behavior.)
38206
+
38207
+ ##### `continue` <a name="continue" id="@cdklabs/cdk-ssm-documents.StepNameFallback.continue"></a>
38208
+
38209
+ ```typescript
38210
+ import { StepNameFallback } from '@cdklabs/cdk-ssm-documents'
38211
+
38212
+ StepNameFallback.continue()
38213
+ ```
38214
+
38215
+ To continue execution of the subsequent step if a failure occurs during execution of the current step.
38216
+
38217
+ ##### `invokeStep` <a name="invokeStep" id="@cdklabs/cdk-ssm-documents.StepNameFallback.invokeStep"></a>
38218
+
38219
+ ```typescript
38220
+ import { StepNameFallback } from '@cdklabs/cdk-ssm-documents'
38221
+
38222
+ StepNameFallback.invokeStep(step: AutomationStep)
38223
+ ```
38224
+
38225
+ Invoke a specific step.
38226
+
38227
+ Provide the step object to execute for the onCancel action.
38228
+ If you don't have a handle to the step object, use the invokeStepByName function.
38229
+ Not all action types may be invoked during cancellation. See documentation referenced on this class.
38230
+
38231
+ ###### `step`<sup>Required</sup> <a name="step" id="@cdklabs/cdk-ssm-documents.StepNameFallback.invokeStep.parameter.step"></a>
38232
+
38233
+ - *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
38234
+
38235
+ ---
38236
+
38237
+ ##### `invokeStepByName` <a name="invokeStepByName" id="@cdklabs/cdk-ssm-documents.StepNameFallback.invokeStepByName"></a>
38238
+
38239
+ ```typescript
38240
+ import { StepNameFallback } from '@cdklabs/cdk-ssm-documents'
38241
+
38242
+ StepNameFallback.invokeStepByName(stepName: string)
38243
+ ```
38244
+
38245
+ Invoke a specific step by the step name for the OnCancel action.
38246
+
38247
+ Not all action types may be invoked during cancellation. See documentation referenced on this class.
38248
+
38249
+ ###### `stepName`<sup>Required</sup> <a name="stepName" id="@cdklabs/cdk-ssm-documents.StepNameFallback.invokeStepByName.parameter.stepName"></a>
38250
+
38251
+ - *Type:* string
38252
+
38253
+ ---
38254
+
38255
+ #### Properties <a name="Properties" id="Properties"></a>
38256
+
38257
+ | **Name** | **Type** | **Description** |
38258
+ | --- | --- | --- |
38259
+ | <code><a href="#@cdklabs/cdk-ssm-documents.StepNameFallback.property.step">step</a></code> | <code>string</code> | *No description.* |
38260
+ | <code><a href="#@cdklabs/cdk-ssm-documents.StepNameFallback.property.validateStepAction">validateStepAction</a></code> | <code>boolean</code> | *No description.* |
38261
+
38262
+ ---
38263
+
38264
+ ##### `step`<sup>Required</sup> <a name="step" id="@cdklabs/cdk-ssm-documents.StepNameFallback.property.step"></a>
38265
+
38266
+ ```typescript
38267
+ public readonly step: string;
38268
+ ```
38269
+
38270
+ - *Type:* string
38271
+
38272
+ ---
38273
+
38274
+ ##### `validateStepAction`<sup>Required</sup> <a name="validateStepAction" id="@cdklabs/cdk-ssm-documents.StepNameFallback.property.validateStepAction"></a>
38275
+
38276
+ ```typescript
38277
+ public readonly validateStepAction: boolean;
38278
+ ```
38279
+
38280
+ - *Type:* boolean
38281
+
38282
+ ---
38283
+
38284
+
37499
38285
  ### StringDocument <a name="StringDocument" id="@cdklabs/cdk-ssm-documents.StringDocument"></a>
37500
38286
 
37501
38287
  This AutomationDocument supports declaring your document from an existing document (JSON/YAML String/File).