@cdklabs/cdk-ssm-documents 0.0.18 → 0.0.21
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.
- package/.jsii +841 -79
- package/API.md +1932 -426
- package/README.md +5 -1
- package/changelog.md +3 -3
- package/lib/construct/synth-utils.js +1 -1
- package/lib/document/automation-document.js +1 -1
- package/lib/document/command-document.js +1 -1
- package/lib/document/document-builder.js +2 -2
- package/lib/document/ssm-document.js +1 -1
- package/lib/domain/choice.js +1 -1
- package/lib/domain/data-type.js +1 -1
- package/lib/domain/enum/install-action.js +2 -2
- package/lib/domain/enum/install-uninstall-repair.js +2 -2
- package/lib/domain/enum/installation-type.js +2 -2
- package/lib/domain/enum/package-name.js +2 -2
- package/lib/domain/input.js +1 -1
- package/lib/domain/operation.js +1 -1
- package/lib/domain/platform.js +1 -1
- package/lib/domain/precondition.js +1 -1
- package/lib/index.d.ts +2 -0
- package/lib/index.js +3 -1
- package/lib/interface/approve-hook.js +2 -2
- package/lib/interface/auth-method.js +3 -3
- package/lib/interface/aws-invoker.js +2 -2
- package/lib/interface/downloadable-content.js +8 -8
- package/lib/interface/environment.js +3 -3
- package/lib/interface/execute-automation-hook/api-execute-automation-hook.js +1 -1
- package/lib/interface/observer.js +1 -1
- package/lib/interface/on-failure.d.ts +75 -0
- package/lib/interface/on-failure.js +141 -0
- package/lib/interface/pause-hook.js +2 -2
- package/lib/interface/run-command-hook/api-run-command-hook.js +1 -1
- package/lib/interface/run-document-location.js +2 -2
- package/lib/interface/sleep-hook.js +2 -2
- package/lib/interface/step-ref.d.ts +21 -0
- package/lib/interface/step-ref.js +40 -0
- package/lib/interface/variables/boolean-variable.js +2 -2
- package/lib/interface/variables/map-list-variable.js +2 -2
- package/lib/interface/variables/number-variable.js +2 -2
- package/lib/interface/variables/secure-string-variable.js +4 -4
- package/lib/interface/variables/string-list-variable.js +2 -2
- package/lib/interface/variables/string-map-variable.js +2 -2
- package/lib/interface/variables/string-variable.js +4 -4
- package/lib/interface/variables/variable.js +2 -2
- package/lib/interface/webhook.js +1 -1
- package/lib/parent-steps/automation/approve-step.js +1 -1
- package/lib/parent-steps/automation/assert-aws-resource-step.js +1 -1
- package/lib/parent-steps/automation/aws-api-step.js +1 -1
- package/lib/parent-steps/automation/branch-step.js +1 -1
- package/lib/parent-steps/automation/change-instance-state-step.js +3 -3
- package/lib/parent-steps/automation/copy-image-step.js +1 -1
- package/lib/parent-steps/automation/create-image-step.js +1 -1
- package/lib/parent-steps/automation/create-stack-step.js +3 -3
- package/lib/parent-steps/automation/create-tags-step.js +3 -3
- package/lib/parent-steps/automation/delete-image-step.js +1 -1
- package/lib/parent-steps/automation/delete-stack-step.js +1 -1
- package/lib/parent-steps/automation/execute-automation-step.js +1 -1
- package/lib/parent-steps/automation/execute-script-step.js +1 -1
- package/lib/parent-steps/automation/execute-state-machine-step.js +1 -1
- package/lib/parent-steps/automation/invoke-lambda-function-step.js +1 -1
- package/lib/parent-steps/automation/invoke-webhook-step.js +1 -1
- package/lib/parent-steps/automation/pause-step.js +1 -1
- package/lib/parent-steps/automation/run-command-step.js +3 -3
- package/lib/parent-steps/automation/run-instance-step.js +1 -1
- package/lib/parent-steps/automation/sleep-step.js +1 -1
- package/lib/parent-steps/automation/wait-for-resource-step.js +1 -1
- package/lib/parent-steps/automation-step.d.ts +33 -24
- package/lib/parent-steps/automation-step.js +16 -11
- package/lib/parent-steps/command/applications-step.js +1 -1
- package/lib/parent-steps/command/configure-docker-step.js +1 -1
- package/lib/parent-steps/command/configure-package-step.js +1 -1
- package/lib/parent-steps/command/domain-join-step.js +1 -1
- package/lib/parent-steps/command/download-content-step.js +1 -1
- package/lib/parent-steps/command/ps-module-step.js +1 -1
- package/lib/parent-steps/command/run-docker-action-step.js +1 -1
- package/lib/parent-steps/command/run-document-step.js +1 -1
- package/lib/parent-steps/command/run-powershell-script-step.js +1 -1
- package/lib/parent-steps/command/run-shell-script-step.js +1 -1
- package/lib/parent-steps/command/software-inventory-step.js +1 -1
- package/lib/parent-steps/command/update-agent-step.js +1 -1
- package/lib/parent-steps/command/update-ssm-agent-step.js +1 -1
- package/lib/parent-steps/command-step.js +1 -1
- package/lib/parent-steps/step.js +1 -1
- package/lib/patterns/automation/composite-step.js +2 -2
- package/lib/patterns/automation/reboot-instance-and-wait.js +1 -1
- package/lib/patterns/automation/string-step.js +1 -1
- package/lib/patterns/document/string-document.js +1 -1
- package/lib/patterns/document/timed-document.js +1 -1
- package/lib/samples/hello-world.js +1 -1
- package/lib/simulation/automation/approve-simulation.js +1 -1
- package/lib/simulation/automation/assert-aws-resource-simulation.js +1 -1
- package/lib/simulation/automation/automation-simulation-base.js +1 -1
- package/lib/simulation/automation/aws-api-simulation.js +1 -1
- package/lib/simulation/automation/branch-simulation.js +1 -1
- package/lib/simulation/automation/change-instance-state-simulation.js +1 -1
- package/lib/simulation/automation/copy-image-simulation.js +1 -1
- package/lib/simulation/automation/create-image-simulation.js +1 -1
- package/lib/simulation/automation/create-stack-simulation.js +1 -1
- package/lib/simulation/automation/create-tags-simulation.js +1 -1
- package/lib/simulation/automation/delete-image-simulation.js +1 -1
- package/lib/simulation/automation/delete-stack-simulation.js +1 -1
- package/lib/simulation/automation/execute-script-simulation.js +1 -1
- package/lib/simulation/automation/execute-state-machine-simulation.js +1 -1
- package/lib/simulation/automation/invoke-lambda-function-simulation.js +1 -1
- package/lib/simulation/automation/invoke-webhook-simulation.js +1 -1
- package/lib/simulation/automation/pause-simulation.js +1 -1
- package/lib/simulation/automation/run-command-simulation.js +1 -1
- package/lib/simulation/automation/run-instance-simulation.js +1 -1
- package/lib/simulation/automation/sleep-simulation.js +1 -1
- package/lib/simulation/automation/wait-for-resource-simulation.js +1 -1
- package/lib/simulation/automation-step-simulation.js +18 -8
- package/lib/simulation/command/command-simulation-base.js +1 -1
- package/lib/simulation/command/ps-module-simulation.js +1 -1
- package/lib/simulation/command/run-powershell-script-simulation.js +1 -1
- package/lib/simulation/command/run-shell-script-simulation.js +1 -1
- package/lib/simulation/command-step-simulation.js +1 -1
- package/lib/simulation/document/automation-simulation.js +3 -3
- package/lib/simulation/document/command-simulation.js +1 -1
- package/lib/simulation/simulation.js +1 -1
- package/package.json +1 -1
- package/releasetag.txt +1 -1
- package/version.txt +1 -1
package/API.md
CHANGED
|
@@ -476,9 +476,10 @@ 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.
|
|
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
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.ApproveStep.property.explicitNextStep">explicitNextStep</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a></code> | *No description.* |
|
|
482
483
|
| <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
484
|
| <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
485
|
| <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 +571,43 @@ public readonly maxAttempts: number;
|
|
|
570
571
|
|
|
571
572
|
---
|
|
572
573
|
|
|
573
|
-
##### `
|
|
574
|
+
##### `onCancel`<sup>Required</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.ApproveStep.property.onCancel"></a>
|
|
574
575
|
|
|
575
576
|
```typescript
|
|
576
|
-
public readonly
|
|
577
|
+
public readonly onCancel: OnCancel;
|
|
577
578
|
```
|
|
578
579
|
|
|
579
|
-
- *Type:*
|
|
580
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a>
|
|
580
581
|
|
|
581
582
|
---
|
|
582
583
|
|
|
583
|
-
##### `
|
|
584
|
+
##### `onFailure`<sup>Required</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.ApproveStep.property.onFailure"></a>
|
|
584
585
|
|
|
585
586
|
```typescript
|
|
586
|
-
public readonly
|
|
587
|
+
public readonly onFailure: OnFailure;
|
|
587
588
|
```
|
|
588
589
|
|
|
589
|
-
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.
|
|
590
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a>
|
|
590
591
|
|
|
591
592
|
---
|
|
592
593
|
|
|
593
|
-
##### `
|
|
594
|
+
##### `timeoutSeconds`<sup>Required</sup> <a name="timeoutSeconds" id="@cdklabs/cdk-ssm-documents.ApproveStep.property.timeoutSeconds"></a>
|
|
594
595
|
|
|
595
596
|
```typescript
|
|
596
|
-
public readonly
|
|
597
|
+
public readonly timeoutSeconds: number;
|
|
597
598
|
```
|
|
598
599
|
|
|
599
|
-
- *Type:*
|
|
600
|
+
- *Type:* number
|
|
601
|
+
|
|
602
|
+
---
|
|
603
|
+
|
|
604
|
+
##### `explicitNextStep`<sup>Optional</sup> <a name="explicitNextStep" id="@cdklabs/cdk-ssm-documents.ApproveStep.property.explicitNextStep"></a>
|
|
605
|
+
|
|
606
|
+
```typescript
|
|
607
|
+
public readonly explicitNextStep: StepRef;
|
|
608
|
+
```
|
|
609
|
+
|
|
610
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a>
|
|
600
611
|
|
|
601
612
|
---
|
|
602
613
|
|
|
@@ -830,9 +841,10 @@ Any object.
|
|
|
830
841
|
| <code><a href="#@cdklabs/cdk-ssm-documents.AssertAwsResourceStep.property.description">description</a></code> | <code>string</code> | *No description.* |
|
|
831
842
|
| <code><a href="#@cdklabs/cdk-ssm-documents.AssertAwsResourceStep.property.isEnd">isEnd</a></code> | <code>boolean</code> | *No description.* |
|
|
832
843
|
| <code><a href="#@cdklabs/cdk-ssm-documents.AssertAwsResourceStep.property.maxAttempts">maxAttempts</a></code> | <code>number</code> | *No description.* |
|
|
844
|
+
| <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.* |
|
|
845
|
+
| <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
846
|
| <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.
|
|
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.* |
|
|
847
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.AssertAwsResourceStep.property.explicitNextStep">explicitNextStep</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a></code> | *No description.* |
|
|
836
848
|
| <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
849
|
| <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
850
|
| <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 +939,43 @@ public readonly maxAttempts: number;
|
|
|
927
939
|
|
|
928
940
|
---
|
|
929
941
|
|
|
930
|
-
##### `
|
|
942
|
+
##### `onCancel`<sup>Required</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.AssertAwsResourceStep.property.onCancel"></a>
|
|
931
943
|
|
|
932
944
|
```typescript
|
|
933
|
-
public readonly
|
|
945
|
+
public readonly onCancel: OnCancel;
|
|
934
946
|
```
|
|
935
947
|
|
|
936
|
-
- *Type:*
|
|
948
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a>
|
|
937
949
|
|
|
938
950
|
---
|
|
939
951
|
|
|
940
|
-
##### `
|
|
952
|
+
##### `onFailure`<sup>Required</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.AssertAwsResourceStep.property.onFailure"></a>
|
|
941
953
|
|
|
942
954
|
```typescript
|
|
943
|
-
public readonly
|
|
955
|
+
public readonly onFailure: OnFailure;
|
|
944
956
|
```
|
|
945
957
|
|
|
946
|
-
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.
|
|
958
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a>
|
|
947
959
|
|
|
948
960
|
---
|
|
949
961
|
|
|
950
|
-
##### `
|
|
962
|
+
##### `timeoutSeconds`<sup>Required</sup> <a name="timeoutSeconds" id="@cdklabs/cdk-ssm-documents.AssertAwsResourceStep.property.timeoutSeconds"></a>
|
|
951
963
|
|
|
952
964
|
```typescript
|
|
953
|
-
public readonly
|
|
965
|
+
public readonly timeoutSeconds: number;
|
|
954
966
|
```
|
|
955
967
|
|
|
956
|
-
- *Type:*
|
|
968
|
+
- *Type:* number
|
|
969
|
+
|
|
970
|
+
---
|
|
971
|
+
|
|
972
|
+
##### `explicitNextStep`<sup>Optional</sup> <a name="explicitNextStep" id="@cdklabs/cdk-ssm-documents.AssertAwsResourceStep.property.explicitNextStep"></a>
|
|
973
|
+
|
|
974
|
+
```typescript
|
|
975
|
+
public readonly explicitNextStep: StepRef;
|
|
976
|
+
```
|
|
977
|
+
|
|
978
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a>
|
|
957
979
|
|
|
958
980
|
---
|
|
959
981
|
|
|
@@ -1456,9 +1478,10 @@ Any object.
|
|
|
1456
1478
|
| <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep.property.description">description</a></code> | <code>string</code> | *No description.* |
|
|
1457
1479
|
| <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep.property.isEnd">isEnd</a></code> | <code>boolean</code> | *No description.* |
|
|
1458
1480
|
| <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep.property.maxAttempts">maxAttempts</a></code> | <code>number</code> | *No description.* |
|
|
1481
|
+
| <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.* |
|
|
1482
|
+
| <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
1483
|
| <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.
|
|
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.* |
|
|
1484
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep.property.explicitNextStep">explicitNextStep</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a></code> | *No description.* |
|
|
1462
1485
|
| <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
1486
|
| <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
1487
|
|
|
@@ -1546,33 +1569,43 @@ public readonly maxAttempts: number;
|
|
|
1546
1569
|
|
|
1547
1570
|
---
|
|
1548
1571
|
|
|
1549
|
-
##### `
|
|
1572
|
+
##### `onCancel`<sup>Required</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.AutomationStep.property.onCancel"></a>
|
|
1550
1573
|
|
|
1551
1574
|
```typescript
|
|
1552
|
-
public readonly
|
|
1575
|
+
public readonly onCancel: OnCancel;
|
|
1553
1576
|
```
|
|
1554
1577
|
|
|
1555
|
-
- *Type:*
|
|
1578
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a>
|
|
1556
1579
|
|
|
1557
1580
|
---
|
|
1558
1581
|
|
|
1559
|
-
##### `
|
|
1582
|
+
##### `onFailure`<sup>Required</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.AutomationStep.property.onFailure"></a>
|
|
1560
1583
|
|
|
1561
1584
|
```typescript
|
|
1562
|
-
public readonly
|
|
1585
|
+
public readonly onFailure: OnFailure;
|
|
1563
1586
|
```
|
|
1564
1587
|
|
|
1565
|
-
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.
|
|
1588
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a>
|
|
1566
1589
|
|
|
1567
1590
|
---
|
|
1568
1591
|
|
|
1569
|
-
##### `
|
|
1592
|
+
##### `timeoutSeconds`<sup>Required</sup> <a name="timeoutSeconds" id="@cdklabs/cdk-ssm-documents.AutomationStep.property.timeoutSeconds"></a>
|
|
1570
1593
|
|
|
1571
1594
|
```typescript
|
|
1572
|
-
public readonly
|
|
1595
|
+
public readonly timeoutSeconds: number;
|
|
1573
1596
|
```
|
|
1574
1597
|
|
|
1575
|
-
- *Type:*
|
|
1598
|
+
- *Type:* number
|
|
1599
|
+
|
|
1600
|
+
---
|
|
1601
|
+
|
|
1602
|
+
##### `explicitNextStep`<sup>Optional</sup> <a name="explicitNextStep" id="@cdklabs/cdk-ssm-documents.AutomationStep.property.explicitNextStep"></a>
|
|
1603
|
+
|
|
1604
|
+
```typescript
|
|
1605
|
+
public readonly explicitNextStep: StepRef;
|
|
1606
|
+
```
|
|
1607
|
+
|
|
1608
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a>
|
|
1576
1609
|
|
|
1577
1610
|
---
|
|
1578
1611
|
|
|
@@ -1764,9 +1797,10 @@ Any object.
|
|
|
1764
1797
|
| <code><a href="#@cdklabs/cdk-ssm-documents.AwsApiStep.property.description">description</a></code> | <code>string</code> | *No description.* |
|
|
1765
1798
|
| <code><a href="#@cdklabs/cdk-ssm-documents.AwsApiStep.property.isEnd">isEnd</a></code> | <code>boolean</code> | *No description.* |
|
|
1766
1799
|
| <code><a href="#@cdklabs/cdk-ssm-documents.AwsApiStep.property.maxAttempts">maxAttempts</a></code> | <code>number</code> | *No description.* |
|
|
1800
|
+
| <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.* |
|
|
1801
|
+
| <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
1802
|
| <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.
|
|
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.* |
|
|
1803
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.AwsApiStep.property.explicitNextStep">explicitNextStep</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a></code> | *No description.* |
|
|
1770
1804
|
| <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
1805
|
| <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
1806
|
| <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 +1893,43 @@ public readonly maxAttempts: number;
|
|
|
1859
1893
|
|
|
1860
1894
|
---
|
|
1861
1895
|
|
|
1862
|
-
##### `
|
|
1896
|
+
##### `onCancel`<sup>Required</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.AwsApiStep.property.onCancel"></a>
|
|
1863
1897
|
|
|
1864
1898
|
```typescript
|
|
1865
|
-
public readonly
|
|
1899
|
+
public readonly onCancel: OnCancel;
|
|
1866
1900
|
```
|
|
1867
1901
|
|
|
1868
|
-
- *Type:*
|
|
1902
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a>
|
|
1869
1903
|
|
|
1870
1904
|
---
|
|
1871
1905
|
|
|
1872
|
-
##### `
|
|
1906
|
+
##### `onFailure`<sup>Required</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.AwsApiStep.property.onFailure"></a>
|
|
1873
1907
|
|
|
1874
1908
|
```typescript
|
|
1875
|
-
public readonly
|
|
1909
|
+
public readonly onFailure: OnFailure;
|
|
1876
1910
|
```
|
|
1877
1911
|
|
|
1878
|
-
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.
|
|
1912
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a>
|
|
1913
|
+
|
|
1914
|
+
---
|
|
1915
|
+
|
|
1916
|
+
##### `timeoutSeconds`<sup>Required</sup> <a name="timeoutSeconds" id="@cdklabs/cdk-ssm-documents.AwsApiStep.property.timeoutSeconds"></a>
|
|
1917
|
+
|
|
1918
|
+
```typescript
|
|
1919
|
+
public readonly timeoutSeconds: number;
|
|
1920
|
+
```
|
|
1921
|
+
|
|
1922
|
+
- *Type:* number
|
|
1879
1923
|
|
|
1880
1924
|
---
|
|
1881
1925
|
|
|
1882
|
-
##### `
|
|
1926
|
+
##### `explicitNextStep`<sup>Optional</sup> <a name="explicitNextStep" id="@cdklabs/cdk-ssm-documents.AwsApiStep.property.explicitNextStep"></a>
|
|
1883
1927
|
|
|
1884
1928
|
```typescript
|
|
1885
|
-
public readonly
|
|
1929
|
+
public readonly explicitNextStep: StepRef;
|
|
1886
1930
|
```
|
|
1887
1931
|
|
|
1888
|
-
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.
|
|
1932
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a>
|
|
1889
1933
|
|
|
1890
1934
|
---
|
|
1891
1935
|
|
|
@@ -2127,9 +2171,10 @@ Any object.
|
|
|
2127
2171
|
| <code><a href="#@cdklabs/cdk-ssm-documents.BranchStep.property.description">description</a></code> | <code>string</code> | *No description.* |
|
|
2128
2172
|
| <code><a href="#@cdklabs/cdk-ssm-documents.BranchStep.property.isEnd">isEnd</a></code> | <code>boolean</code> | *No description.* |
|
|
2129
2173
|
| <code><a href="#@cdklabs/cdk-ssm-documents.BranchStep.property.maxAttempts">maxAttempts</a></code> | <code>number</code> | *No description.* |
|
|
2174
|
+
| <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.* |
|
|
2175
|
+
| <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
2176
|
| <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.
|
|
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.* |
|
|
2177
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.BranchStep.property.explicitNextStep">explicitNextStep</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a></code> | *No description.* |
|
|
2133
2178
|
| <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
2179
|
| <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
2180
|
| <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 +2264,43 @@ public readonly maxAttempts: number;
|
|
|
2219
2264
|
|
|
2220
2265
|
---
|
|
2221
2266
|
|
|
2222
|
-
##### `
|
|
2267
|
+
##### `onCancel`<sup>Required</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.BranchStep.property.onCancel"></a>
|
|
2223
2268
|
|
|
2224
2269
|
```typescript
|
|
2225
|
-
public readonly
|
|
2270
|
+
public readonly onCancel: OnCancel;
|
|
2226
2271
|
```
|
|
2227
2272
|
|
|
2228
|
-
- *Type:*
|
|
2273
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a>
|
|
2229
2274
|
|
|
2230
2275
|
---
|
|
2231
2276
|
|
|
2232
|
-
##### `
|
|
2277
|
+
##### `onFailure`<sup>Required</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.BranchStep.property.onFailure"></a>
|
|
2233
2278
|
|
|
2234
2279
|
```typescript
|
|
2235
|
-
public readonly
|
|
2280
|
+
public readonly onFailure: OnFailure;
|
|
2236
2281
|
```
|
|
2237
2282
|
|
|
2238
|
-
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.
|
|
2283
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a>
|
|
2239
2284
|
|
|
2240
2285
|
---
|
|
2241
2286
|
|
|
2242
|
-
##### `
|
|
2287
|
+
##### `timeoutSeconds`<sup>Required</sup> <a name="timeoutSeconds" id="@cdklabs/cdk-ssm-documents.BranchStep.property.timeoutSeconds"></a>
|
|
2243
2288
|
|
|
2244
2289
|
```typescript
|
|
2245
|
-
public readonly
|
|
2290
|
+
public readonly timeoutSeconds: number;
|
|
2246
2291
|
```
|
|
2247
2292
|
|
|
2248
|
-
- *Type:*
|
|
2293
|
+
- *Type:* number
|
|
2294
|
+
|
|
2295
|
+
---
|
|
2296
|
+
|
|
2297
|
+
##### `explicitNextStep`<sup>Optional</sup> <a name="explicitNextStep" id="@cdklabs/cdk-ssm-documents.BranchStep.property.explicitNextStep"></a>
|
|
2298
|
+
|
|
2299
|
+
```typescript
|
|
2300
|
+
public readonly explicitNextStep: StepRef;
|
|
2301
|
+
```
|
|
2302
|
+
|
|
2303
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a>
|
|
2249
2304
|
|
|
2250
2305
|
---
|
|
2251
2306
|
|
|
@@ -2457,9 +2512,10 @@ Any object.
|
|
|
2457
2512
|
| <code><a href="#@cdklabs/cdk-ssm-documents.ChangeInstanceStateStep.property.description">description</a></code> | <code>string</code> | *No description.* |
|
|
2458
2513
|
| <code><a href="#@cdklabs/cdk-ssm-documents.ChangeInstanceStateStep.property.isEnd">isEnd</a></code> | <code>boolean</code> | *No description.* |
|
|
2459
2514
|
| <code><a href="#@cdklabs/cdk-ssm-documents.ChangeInstanceStateStep.property.maxAttempts">maxAttempts</a></code> | <code>number</code> | *No description.* |
|
|
2515
|
+
| <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.* |
|
|
2516
|
+
| <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
2517
|
| <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.
|
|
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.* |
|
|
2518
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.ChangeInstanceStateStep.property.explicitNextStep">explicitNextStep</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a></code> | *No description.* |
|
|
2463
2519
|
| <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
2520
|
| <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
2521
|
| <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 +2608,43 @@ public readonly maxAttempts: number;
|
|
|
2552
2608
|
|
|
2553
2609
|
---
|
|
2554
2610
|
|
|
2555
|
-
##### `
|
|
2611
|
+
##### `onCancel`<sup>Required</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.ChangeInstanceStateStep.property.onCancel"></a>
|
|
2556
2612
|
|
|
2557
2613
|
```typescript
|
|
2558
|
-
public readonly
|
|
2614
|
+
public readonly onCancel: OnCancel;
|
|
2559
2615
|
```
|
|
2560
2616
|
|
|
2561
|
-
- *Type:*
|
|
2617
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a>
|
|
2562
2618
|
|
|
2563
2619
|
---
|
|
2564
2620
|
|
|
2565
|
-
##### `
|
|
2621
|
+
##### `onFailure`<sup>Required</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.ChangeInstanceStateStep.property.onFailure"></a>
|
|
2566
2622
|
|
|
2567
2623
|
```typescript
|
|
2568
|
-
public readonly
|
|
2624
|
+
public readonly onFailure: OnFailure;
|
|
2569
2625
|
```
|
|
2570
2626
|
|
|
2571
|
-
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.
|
|
2627
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a>
|
|
2572
2628
|
|
|
2573
2629
|
---
|
|
2574
2630
|
|
|
2575
|
-
##### `
|
|
2631
|
+
##### `timeoutSeconds`<sup>Required</sup> <a name="timeoutSeconds" id="@cdklabs/cdk-ssm-documents.ChangeInstanceStateStep.property.timeoutSeconds"></a>
|
|
2576
2632
|
|
|
2577
2633
|
```typescript
|
|
2578
|
-
public readonly
|
|
2634
|
+
public readonly timeoutSeconds: number;
|
|
2579
2635
|
```
|
|
2580
2636
|
|
|
2581
|
-
- *Type:*
|
|
2637
|
+
- *Type:* number
|
|
2638
|
+
|
|
2639
|
+
---
|
|
2640
|
+
|
|
2641
|
+
##### `explicitNextStep`<sup>Optional</sup> <a name="explicitNextStep" id="@cdklabs/cdk-ssm-documents.ChangeInstanceStateStep.property.explicitNextStep"></a>
|
|
2642
|
+
|
|
2643
|
+
```typescript
|
|
2644
|
+
public readonly explicitNextStep: StepRef;
|
|
2645
|
+
```
|
|
2646
|
+
|
|
2647
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a>
|
|
2582
2648
|
|
|
2583
2649
|
---
|
|
2584
2650
|
|
|
@@ -4202,9 +4268,10 @@ Any object.
|
|
|
4202
4268
|
| <code><a href="#@cdklabs/cdk-ssm-documents.CopyImageStep.property.description">description</a></code> | <code>string</code> | *No description.* |
|
|
4203
4269
|
| <code><a href="#@cdklabs/cdk-ssm-documents.CopyImageStep.property.isEnd">isEnd</a></code> | <code>boolean</code> | *No description.* |
|
|
4204
4270
|
| <code><a href="#@cdklabs/cdk-ssm-documents.CopyImageStep.property.maxAttempts">maxAttempts</a></code> | <code>number</code> | *No description.* |
|
|
4271
|
+
| <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.* |
|
|
4272
|
+
| <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
4273
|
| <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.
|
|
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.* |
|
|
4274
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.CopyImageStep.property.explicitNextStep">explicitNextStep</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a></code> | *No description.* |
|
|
4208
4275
|
| <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
4276
|
| <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
4277
|
| <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 +4366,43 @@ public readonly maxAttempts: number;
|
|
|
4299
4366
|
|
|
4300
4367
|
---
|
|
4301
4368
|
|
|
4302
|
-
##### `
|
|
4369
|
+
##### `onCancel`<sup>Required</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.CopyImageStep.property.onCancel"></a>
|
|
4303
4370
|
|
|
4304
4371
|
```typescript
|
|
4305
|
-
public readonly
|
|
4372
|
+
public readonly onCancel: OnCancel;
|
|
4306
4373
|
```
|
|
4307
4374
|
|
|
4308
|
-
- *Type:*
|
|
4375
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a>
|
|
4309
4376
|
|
|
4310
4377
|
---
|
|
4311
4378
|
|
|
4312
|
-
##### `
|
|
4379
|
+
##### `onFailure`<sup>Required</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.CopyImageStep.property.onFailure"></a>
|
|
4313
4380
|
|
|
4314
4381
|
```typescript
|
|
4315
|
-
public readonly
|
|
4382
|
+
public readonly onFailure: OnFailure;
|
|
4316
4383
|
```
|
|
4317
4384
|
|
|
4318
|
-
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.
|
|
4385
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a>
|
|
4319
4386
|
|
|
4320
4387
|
---
|
|
4321
4388
|
|
|
4322
|
-
##### `
|
|
4389
|
+
##### `timeoutSeconds`<sup>Required</sup> <a name="timeoutSeconds" id="@cdklabs/cdk-ssm-documents.CopyImageStep.property.timeoutSeconds"></a>
|
|
4323
4390
|
|
|
4324
4391
|
```typescript
|
|
4325
|
-
public readonly
|
|
4392
|
+
public readonly timeoutSeconds: number;
|
|
4326
4393
|
```
|
|
4327
4394
|
|
|
4328
|
-
- *Type:*
|
|
4395
|
+
- *Type:* number
|
|
4396
|
+
|
|
4397
|
+
---
|
|
4398
|
+
|
|
4399
|
+
##### `explicitNextStep`<sup>Optional</sup> <a name="explicitNextStep" id="@cdklabs/cdk-ssm-documents.CopyImageStep.property.explicitNextStep"></a>
|
|
4400
|
+
|
|
4401
|
+
```typescript
|
|
4402
|
+
public readonly explicitNextStep: StepRef;
|
|
4403
|
+
```
|
|
4404
|
+
|
|
4405
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a>
|
|
4329
4406
|
|
|
4330
4407
|
---
|
|
4331
4408
|
|
|
@@ -4587,9 +4664,10 @@ Any object.
|
|
|
4587
4664
|
| <code><a href="#@cdklabs/cdk-ssm-documents.CreateImageStep.property.description">description</a></code> | <code>string</code> | *No description.* |
|
|
4588
4665
|
| <code><a href="#@cdklabs/cdk-ssm-documents.CreateImageStep.property.isEnd">isEnd</a></code> | <code>boolean</code> | *No description.* |
|
|
4589
4666
|
| <code><a href="#@cdklabs/cdk-ssm-documents.CreateImageStep.property.maxAttempts">maxAttempts</a></code> | <code>number</code> | *No description.* |
|
|
4667
|
+
| <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.* |
|
|
4668
|
+
| <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
4669
|
| <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.
|
|
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.* |
|
|
4670
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.CreateImageStep.property.explicitNextStep">explicitNextStep</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a></code> | *No description.* |
|
|
4593
4671
|
| <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
4672
|
| <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
4673
|
| <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 +4760,43 @@ public readonly maxAttempts: number;
|
|
|
4682
4760
|
|
|
4683
4761
|
---
|
|
4684
4762
|
|
|
4685
|
-
##### `
|
|
4763
|
+
##### `onCancel`<sup>Required</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.CreateImageStep.property.onCancel"></a>
|
|
4686
4764
|
|
|
4687
4765
|
```typescript
|
|
4688
|
-
public readonly
|
|
4766
|
+
public readonly onCancel: OnCancel;
|
|
4689
4767
|
```
|
|
4690
4768
|
|
|
4691
|
-
- *Type:*
|
|
4769
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a>
|
|
4692
4770
|
|
|
4693
4771
|
---
|
|
4694
4772
|
|
|
4695
|
-
##### `
|
|
4773
|
+
##### `onFailure`<sup>Required</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.CreateImageStep.property.onFailure"></a>
|
|
4696
4774
|
|
|
4697
4775
|
```typescript
|
|
4698
|
-
public readonly
|
|
4776
|
+
public readonly onFailure: OnFailure;
|
|
4699
4777
|
```
|
|
4700
4778
|
|
|
4701
|
-
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.
|
|
4779
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a>
|
|
4702
4780
|
|
|
4703
4781
|
---
|
|
4704
4782
|
|
|
4705
|
-
##### `
|
|
4783
|
+
##### `timeoutSeconds`<sup>Required</sup> <a name="timeoutSeconds" id="@cdklabs/cdk-ssm-documents.CreateImageStep.property.timeoutSeconds"></a>
|
|
4706
4784
|
|
|
4707
4785
|
```typescript
|
|
4708
|
-
public readonly
|
|
4786
|
+
public readonly timeoutSeconds: number;
|
|
4709
4787
|
```
|
|
4710
4788
|
|
|
4711
|
-
- *Type:*
|
|
4789
|
+
- *Type:* number
|
|
4790
|
+
|
|
4791
|
+
---
|
|
4792
|
+
|
|
4793
|
+
##### `explicitNextStep`<sup>Optional</sup> <a name="explicitNextStep" id="@cdklabs/cdk-ssm-documents.CreateImageStep.property.explicitNextStep"></a>
|
|
4794
|
+
|
|
4795
|
+
```typescript
|
|
4796
|
+
public readonly explicitNextStep: StepRef;
|
|
4797
|
+
```
|
|
4798
|
+
|
|
4799
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a>
|
|
4712
4800
|
|
|
4713
4801
|
---
|
|
4714
4802
|
|
|
@@ -4950,9 +5038,10 @@ Any object.
|
|
|
4950
5038
|
| <code><a href="#@cdklabs/cdk-ssm-documents.CreateStackStep.property.description">description</a></code> | <code>string</code> | *No description.* |
|
|
4951
5039
|
| <code><a href="#@cdklabs/cdk-ssm-documents.CreateStackStep.property.isEnd">isEnd</a></code> | <code>boolean</code> | *No description.* |
|
|
4952
5040
|
| <code><a href="#@cdklabs/cdk-ssm-documents.CreateStackStep.property.maxAttempts">maxAttempts</a></code> | <code>number</code> | *No description.* |
|
|
5041
|
+
| <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.* |
|
|
5042
|
+
| <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
5043
|
| <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.
|
|
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.* |
|
|
5044
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.CreateStackStep.property.explicitNextStep">explicitNextStep</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a></code> | *No description.* |
|
|
4956
5045
|
| <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
5046
|
| <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
5047
|
| <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 +5143,43 @@ public readonly maxAttempts: number;
|
|
|
5054
5143
|
|
|
5055
5144
|
---
|
|
5056
5145
|
|
|
5057
|
-
##### `
|
|
5146
|
+
##### `onCancel`<sup>Required</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.CreateStackStep.property.onCancel"></a>
|
|
5058
5147
|
|
|
5059
5148
|
```typescript
|
|
5060
|
-
public readonly
|
|
5149
|
+
public readonly onCancel: OnCancel;
|
|
5061
5150
|
```
|
|
5062
5151
|
|
|
5063
|
-
- *Type:*
|
|
5152
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a>
|
|
5064
5153
|
|
|
5065
5154
|
---
|
|
5066
5155
|
|
|
5067
|
-
##### `
|
|
5156
|
+
##### `onFailure`<sup>Required</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.CreateStackStep.property.onFailure"></a>
|
|
5068
5157
|
|
|
5069
5158
|
```typescript
|
|
5070
|
-
public readonly
|
|
5159
|
+
public readonly onFailure: OnFailure;
|
|
5071
5160
|
```
|
|
5072
5161
|
|
|
5073
|
-
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.
|
|
5162
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a>
|
|
5074
5163
|
|
|
5075
5164
|
---
|
|
5076
5165
|
|
|
5077
|
-
##### `
|
|
5166
|
+
##### `timeoutSeconds`<sup>Required</sup> <a name="timeoutSeconds" id="@cdklabs/cdk-ssm-documents.CreateStackStep.property.timeoutSeconds"></a>
|
|
5078
5167
|
|
|
5079
5168
|
```typescript
|
|
5080
|
-
public readonly
|
|
5169
|
+
public readonly timeoutSeconds: number;
|
|
5081
5170
|
```
|
|
5082
5171
|
|
|
5083
|
-
- *Type:*
|
|
5172
|
+
- *Type:* number
|
|
5173
|
+
|
|
5174
|
+
---
|
|
5175
|
+
|
|
5176
|
+
##### `explicitNextStep`<sup>Optional</sup> <a name="explicitNextStep" id="@cdklabs/cdk-ssm-documents.CreateStackStep.property.explicitNextStep"></a>
|
|
5177
|
+
|
|
5178
|
+
```typescript
|
|
5179
|
+
public readonly explicitNextStep: StepRef;
|
|
5180
|
+
```
|
|
5181
|
+
|
|
5182
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a>
|
|
5084
5183
|
|
|
5085
5184
|
---
|
|
5086
5185
|
|
|
@@ -5412,9 +5511,10 @@ Any object.
|
|
|
5412
5511
|
| <code><a href="#@cdklabs/cdk-ssm-documents.CreateTagsStep.property.description">description</a></code> | <code>string</code> | *No description.* |
|
|
5413
5512
|
| <code><a href="#@cdklabs/cdk-ssm-documents.CreateTagsStep.property.isEnd">isEnd</a></code> | <code>boolean</code> | *No description.* |
|
|
5414
5513
|
| <code><a href="#@cdklabs/cdk-ssm-documents.CreateTagsStep.property.maxAttempts">maxAttempts</a></code> | <code>number</code> | *No description.* |
|
|
5514
|
+
| <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.* |
|
|
5515
|
+
| <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
5516
|
| <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.
|
|
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.* |
|
|
5517
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.CreateTagsStep.property.explicitNextStep">explicitNextStep</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a></code> | *No description.* |
|
|
5418
5518
|
| <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
5519
|
| <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
5520
|
| <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 +5605,43 @@ public readonly maxAttempts: number;
|
|
|
5505
5605
|
|
|
5506
5606
|
---
|
|
5507
5607
|
|
|
5508
|
-
##### `
|
|
5608
|
+
##### `onCancel`<sup>Required</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.CreateTagsStep.property.onCancel"></a>
|
|
5509
5609
|
|
|
5510
5610
|
```typescript
|
|
5511
|
-
public readonly
|
|
5611
|
+
public readonly onCancel: OnCancel;
|
|
5512
5612
|
```
|
|
5513
5613
|
|
|
5514
|
-
- *Type:*
|
|
5614
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a>
|
|
5515
5615
|
|
|
5516
5616
|
---
|
|
5517
5617
|
|
|
5518
|
-
##### `
|
|
5618
|
+
##### `onFailure`<sup>Required</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.CreateTagsStep.property.onFailure"></a>
|
|
5519
5619
|
|
|
5520
5620
|
```typescript
|
|
5521
|
-
public readonly
|
|
5621
|
+
public readonly onFailure: OnFailure;
|
|
5522
5622
|
```
|
|
5523
5623
|
|
|
5524
|
-
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.
|
|
5624
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a>
|
|
5525
5625
|
|
|
5526
5626
|
---
|
|
5527
5627
|
|
|
5528
|
-
##### `
|
|
5628
|
+
##### `timeoutSeconds`<sup>Required</sup> <a name="timeoutSeconds" id="@cdklabs/cdk-ssm-documents.CreateTagsStep.property.timeoutSeconds"></a>
|
|
5529
5629
|
|
|
5530
5630
|
```typescript
|
|
5531
|
-
public readonly
|
|
5631
|
+
public readonly timeoutSeconds: number;
|
|
5532
5632
|
```
|
|
5533
5633
|
|
|
5534
|
-
- *Type:*
|
|
5634
|
+
- *Type:* number
|
|
5635
|
+
|
|
5636
|
+
---
|
|
5637
|
+
|
|
5638
|
+
##### `explicitNextStep`<sup>Optional</sup> <a name="explicitNextStep" id="@cdklabs/cdk-ssm-documents.CreateTagsStep.property.explicitNextStep"></a>
|
|
5639
|
+
|
|
5640
|
+
```typescript
|
|
5641
|
+
public readonly explicitNextStep: StepRef;
|
|
5642
|
+
```
|
|
5643
|
+
|
|
5644
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a>
|
|
5535
5645
|
|
|
5536
5646
|
---
|
|
5537
5647
|
|
|
@@ -5753,9 +5863,10 @@ Any object.
|
|
|
5753
5863
|
| <code><a href="#@cdklabs/cdk-ssm-documents.DeleteImageStep.property.description">description</a></code> | <code>string</code> | *No description.* |
|
|
5754
5864
|
| <code><a href="#@cdklabs/cdk-ssm-documents.DeleteImageStep.property.isEnd">isEnd</a></code> | <code>boolean</code> | *No description.* |
|
|
5755
5865
|
| <code><a href="#@cdklabs/cdk-ssm-documents.DeleteImageStep.property.maxAttempts">maxAttempts</a></code> | <code>number</code> | *No description.* |
|
|
5866
|
+
| <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.* |
|
|
5867
|
+
| <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
5868
|
| <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.
|
|
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.* |
|
|
5869
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.DeleteImageStep.property.explicitNextStep">explicitNextStep</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a></code> | *No description.* |
|
|
5759
5870
|
| <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
5871
|
| <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
5872
|
| <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 +5955,43 @@ public readonly maxAttempts: number;
|
|
|
5844
5955
|
|
|
5845
5956
|
---
|
|
5846
5957
|
|
|
5847
|
-
##### `
|
|
5958
|
+
##### `onCancel`<sup>Required</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.DeleteImageStep.property.onCancel"></a>
|
|
5848
5959
|
|
|
5849
5960
|
```typescript
|
|
5850
|
-
public readonly
|
|
5961
|
+
public readonly onCancel: OnCancel;
|
|
5851
5962
|
```
|
|
5852
5963
|
|
|
5853
|
-
- *Type:*
|
|
5964
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a>
|
|
5854
5965
|
|
|
5855
5966
|
---
|
|
5856
5967
|
|
|
5857
|
-
##### `
|
|
5968
|
+
##### `onFailure`<sup>Required</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.DeleteImageStep.property.onFailure"></a>
|
|
5858
5969
|
|
|
5859
5970
|
```typescript
|
|
5860
|
-
public readonly
|
|
5971
|
+
public readonly onFailure: OnFailure;
|
|
5861
5972
|
```
|
|
5862
5973
|
|
|
5863
|
-
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.
|
|
5974
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a>
|
|
5864
5975
|
|
|
5865
5976
|
---
|
|
5866
5977
|
|
|
5867
|
-
##### `
|
|
5978
|
+
##### `timeoutSeconds`<sup>Required</sup> <a name="timeoutSeconds" id="@cdklabs/cdk-ssm-documents.DeleteImageStep.property.timeoutSeconds"></a>
|
|
5868
5979
|
|
|
5869
5980
|
```typescript
|
|
5870
|
-
public readonly
|
|
5981
|
+
public readonly timeoutSeconds: number;
|
|
5871
5982
|
```
|
|
5872
5983
|
|
|
5873
|
-
- *Type:*
|
|
5984
|
+
- *Type:* number
|
|
5985
|
+
|
|
5986
|
+
---
|
|
5987
|
+
|
|
5988
|
+
##### `explicitNextStep`<sup>Optional</sup> <a name="explicitNextStep" id="@cdklabs/cdk-ssm-documents.DeleteImageStep.property.explicitNextStep"></a>
|
|
5989
|
+
|
|
5990
|
+
```typescript
|
|
5991
|
+
public readonly explicitNextStep: StepRef;
|
|
5992
|
+
```
|
|
5993
|
+
|
|
5994
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a>
|
|
5874
5995
|
|
|
5875
5996
|
---
|
|
5876
5997
|
|
|
@@ -6072,9 +6193,10 @@ Any object.
|
|
|
6072
6193
|
| <code><a href="#@cdklabs/cdk-ssm-documents.DeleteStackStep.property.description">description</a></code> | <code>string</code> | *No description.* |
|
|
6073
6194
|
| <code><a href="#@cdklabs/cdk-ssm-documents.DeleteStackStep.property.isEnd">isEnd</a></code> | <code>boolean</code> | *No description.* |
|
|
6074
6195
|
| <code><a href="#@cdklabs/cdk-ssm-documents.DeleteStackStep.property.maxAttempts">maxAttempts</a></code> | <code>number</code> | *No description.* |
|
|
6196
|
+
| <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.* |
|
|
6197
|
+
| <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
6198
|
| <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.
|
|
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.* |
|
|
6199
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.DeleteStackStep.property.explicitNextStep">explicitNextStep</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a></code> | *No description.* |
|
|
6078
6200
|
| <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
6201
|
| <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
6202
|
| <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 +6286,43 @@ public readonly maxAttempts: number;
|
|
|
6164
6286
|
|
|
6165
6287
|
---
|
|
6166
6288
|
|
|
6167
|
-
##### `
|
|
6289
|
+
##### `onCancel`<sup>Required</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.DeleteStackStep.property.onCancel"></a>
|
|
6168
6290
|
|
|
6169
6291
|
```typescript
|
|
6170
|
-
public readonly
|
|
6292
|
+
public readonly onCancel: OnCancel;
|
|
6171
6293
|
```
|
|
6172
6294
|
|
|
6173
|
-
- *Type:*
|
|
6295
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a>
|
|
6174
6296
|
|
|
6175
6297
|
---
|
|
6176
6298
|
|
|
6177
|
-
##### `
|
|
6299
|
+
##### `onFailure`<sup>Required</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.DeleteStackStep.property.onFailure"></a>
|
|
6178
6300
|
|
|
6179
6301
|
```typescript
|
|
6180
|
-
public readonly
|
|
6302
|
+
public readonly onFailure: OnFailure;
|
|
6181
6303
|
```
|
|
6182
6304
|
|
|
6183
|
-
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.
|
|
6305
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a>
|
|
6184
6306
|
|
|
6185
6307
|
---
|
|
6186
6308
|
|
|
6187
|
-
##### `
|
|
6309
|
+
##### `timeoutSeconds`<sup>Required</sup> <a name="timeoutSeconds" id="@cdklabs/cdk-ssm-documents.DeleteStackStep.property.timeoutSeconds"></a>
|
|
6188
6310
|
|
|
6189
6311
|
```typescript
|
|
6190
|
-
public readonly
|
|
6312
|
+
public readonly timeoutSeconds: number;
|
|
6191
6313
|
```
|
|
6192
6314
|
|
|
6193
|
-
- *Type:*
|
|
6315
|
+
- *Type:* number
|
|
6316
|
+
|
|
6317
|
+
---
|
|
6318
|
+
|
|
6319
|
+
##### `explicitNextStep`<sup>Optional</sup> <a name="explicitNextStep" id="@cdklabs/cdk-ssm-documents.DeleteStackStep.property.explicitNextStep"></a>
|
|
6320
|
+
|
|
6321
|
+
```typescript
|
|
6322
|
+
public readonly explicitNextStep: StepRef;
|
|
6323
|
+
```
|
|
6324
|
+
|
|
6325
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a>
|
|
6194
6326
|
|
|
6195
6327
|
---
|
|
6196
6328
|
|
|
@@ -7050,9 +7182,10 @@ Any object.
|
|
|
7050
7182
|
| <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteAutomationStep.property.description">description</a></code> | <code>string</code> | *No description.* |
|
|
7051
7183
|
| <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteAutomationStep.property.isEnd">isEnd</a></code> | <code>boolean</code> | *No description.* |
|
|
7052
7184
|
| <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteAutomationStep.property.maxAttempts">maxAttempts</a></code> | <code>number</code> | *No description.* |
|
|
7185
|
+
| <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.* |
|
|
7186
|
+
| <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
7187
|
| <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.
|
|
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.* |
|
|
7188
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteAutomationStep.property.explicitNextStep">explicitNextStep</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a></code> | *No description.* |
|
|
7056
7189
|
| <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
7190
|
| <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
7191
|
| <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 +7283,43 @@ public readonly maxAttempts: number;
|
|
|
7150
7283
|
|
|
7151
7284
|
---
|
|
7152
7285
|
|
|
7153
|
-
##### `
|
|
7286
|
+
##### `onCancel`<sup>Required</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.ExecuteAutomationStep.property.onCancel"></a>
|
|
7154
7287
|
|
|
7155
7288
|
```typescript
|
|
7156
|
-
public readonly
|
|
7289
|
+
public readonly onCancel: OnCancel;
|
|
7157
7290
|
```
|
|
7158
7291
|
|
|
7159
|
-
- *Type:*
|
|
7292
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a>
|
|
7160
7293
|
|
|
7161
7294
|
---
|
|
7162
7295
|
|
|
7163
|
-
##### `
|
|
7296
|
+
##### `onFailure`<sup>Required</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.ExecuteAutomationStep.property.onFailure"></a>
|
|
7164
7297
|
|
|
7165
7298
|
```typescript
|
|
7166
|
-
public readonly
|
|
7299
|
+
public readonly onFailure: OnFailure;
|
|
7167
7300
|
```
|
|
7168
7301
|
|
|
7169
|
-
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.
|
|
7302
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a>
|
|
7303
|
+
|
|
7304
|
+
---
|
|
7305
|
+
|
|
7306
|
+
##### `timeoutSeconds`<sup>Required</sup> <a name="timeoutSeconds" id="@cdklabs/cdk-ssm-documents.ExecuteAutomationStep.property.timeoutSeconds"></a>
|
|
7307
|
+
|
|
7308
|
+
```typescript
|
|
7309
|
+
public readonly timeoutSeconds: number;
|
|
7310
|
+
```
|
|
7311
|
+
|
|
7312
|
+
- *Type:* number
|
|
7170
7313
|
|
|
7171
7314
|
---
|
|
7172
7315
|
|
|
7173
|
-
##### `
|
|
7316
|
+
##### `explicitNextStep`<sup>Optional</sup> <a name="explicitNextStep" id="@cdklabs/cdk-ssm-documents.ExecuteAutomationStep.property.explicitNextStep"></a>
|
|
7174
7317
|
|
|
7175
7318
|
```typescript
|
|
7176
|
-
public readonly
|
|
7319
|
+
public readonly explicitNextStep: StepRef;
|
|
7177
7320
|
```
|
|
7178
7321
|
|
|
7179
|
-
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.
|
|
7322
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a>
|
|
7180
7323
|
|
|
7181
7324
|
---
|
|
7182
7325
|
|
|
@@ -7483,9 +7626,10 @@ ExecuteScriptStep.getLanguage(runtime: string)
|
|
|
7483
7626
|
| <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteScriptStep.property.description">description</a></code> | <code>string</code> | *No description.* |
|
|
7484
7627
|
| <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteScriptStep.property.isEnd">isEnd</a></code> | <code>boolean</code> | *No description.* |
|
|
7485
7628
|
| <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteScriptStep.property.maxAttempts">maxAttempts</a></code> | <code>number</code> | *No description.* |
|
|
7629
|
+
| <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.* |
|
|
7630
|
+
| <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
7631
|
| <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.
|
|
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.* |
|
|
7632
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteScriptStep.property.explicitNextStep">explicitNextStep</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a></code> | *No description.* |
|
|
7489
7633
|
| <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
7634
|
| <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
7635
|
| <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteScriptStep.property.fullPathToCode">fullPathToCode</a></code> | <code>string</code> | *No description.* |
|
|
@@ -7578,33 +7722,43 @@ public readonly maxAttempts: number;
|
|
|
7578
7722
|
|
|
7579
7723
|
---
|
|
7580
7724
|
|
|
7581
|
-
##### `
|
|
7725
|
+
##### `onCancel`<sup>Required</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.ExecuteScriptStep.property.onCancel"></a>
|
|
7582
7726
|
|
|
7583
7727
|
```typescript
|
|
7584
|
-
public readonly
|
|
7728
|
+
public readonly onCancel: OnCancel;
|
|
7585
7729
|
```
|
|
7586
7730
|
|
|
7587
|
-
- *Type:*
|
|
7731
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a>
|
|
7588
7732
|
|
|
7589
7733
|
---
|
|
7590
7734
|
|
|
7591
|
-
##### `
|
|
7735
|
+
##### `onFailure`<sup>Required</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.ExecuteScriptStep.property.onFailure"></a>
|
|
7592
7736
|
|
|
7593
7737
|
```typescript
|
|
7594
|
-
public readonly
|
|
7738
|
+
public readonly onFailure: OnFailure;
|
|
7595
7739
|
```
|
|
7596
7740
|
|
|
7597
|
-
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.
|
|
7741
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a>
|
|
7598
7742
|
|
|
7599
7743
|
---
|
|
7600
7744
|
|
|
7601
|
-
##### `
|
|
7745
|
+
##### `timeoutSeconds`<sup>Required</sup> <a name="timeoutSeconds" id="@cdklabs/cdk-ssm-documents.ExecuteScriptStep.property.timeoutSeconds"></a>
|
|
7602
7746
|
|
|
7603
7747
|
```typescript
|
|
7604
|
-
public readonly
|
|
7748
|
+
public readonly timeoutSeconds: number;
|
|
7605
7749
|
```
|
|
7606
7750
|
|
|
7607
|
-
- *Type:*
|
|
7751
|
+
- *Type:* number
|
|
7752
|
+
|
|
7753
|
+
---
|
|
7754
|
+
|
|
7755
|
+
##### `explicitNextStep`<sup>Optional</sup> <a name="explicitNextStep" id="@cdklabs/cdk-ssm-documents.ExecuteScriptStep.property.explicitNextStep"></a>
|
|
7756
|
+
|
|
7757
|
+
```typescript
|
|
7758
|
+
public readonly explicitNextStep: StepRef;
|
|
7759
|
+
```
|
|
7760
|
+
|
|
7761
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a>
|
|
7608
7762
|
|
|
7609
7763
|
---
|
|
7610
7764
|
|
|
@@ -7846,9 +8000,10 @@ Any object.
|
|
|
7846
8000
|
| <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteStateMachineStep.property.description">description</a></code> | <code>string</code> | *No description.* |
|
|
7847
8001
|
| <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteStateMachineStep.property.isEnd">isEnd</a></code> | <code>boolean</code> | *No description.* |
|
|
7848
8002
|
| <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteStateMachineStep.property.maxAttempts">maxAttempts</a></code> | <code>number</code> | *No description.* |
|
|
8003
|
+
| <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.* |
|
|
8004
|
+
| <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
8005
|
| <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.
|
|
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.* |
|
|
8006
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteStateMachineStep.property.explicitNextStep">explicitNextStep</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a></code> | *No description.* |
|
|
7852
8007
|
| <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
8008
|
| <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
8009
|
| <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 +8094,43 @@ public readonly maxAttempts: number;
|
|
|
7939
8094
|
|
|
7940
8095
|
---
|
|
7941
8096
|
|
|
7942
|
-
##### `
|
|
8097
|
+
##### `onCancel`<sup>Required</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.ExecuteStateMachineStep.property.onCancel"></a>
|
|
7943
8098
|
|
|
7944
8099
|
```typescript
|
|
7945
|
-
public readonly
|
|
8100
|
+
public readonly onCancel: OnCancel;
|
|
7946
8101
|
```
|
|
7947
8102
|
|
|
7948
|
-
- *Type:*
|
|
8103
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a>
|
|
7949
8104
|
|
|
7950
8105
|
---
|
|
7951
8106
|
|
|
7952
|
-
##### `
|
|
8107
|
+
##### `onFailure`<sup>Required</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.ExecuteStateMachineStep.property.onFailure"></a>
|
|
7953
8108
|
|
|
7954
8109
|
```typescript
|
|
7955
|
-
public readonly
|
|
8110
|
+
public readonly onFailure: OnFailure;
|
|
7956
8111
|
```
|
|
7957
8112
|
|
|
7958
|
-
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.
|
|
8113
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a>
|
|
7959
8114
|
|
|
7960
8115
|
---
|
|
7961
8116
|
|
|
7962
|
-
##### `
|
|
8117
|
+
##### `timeoutSeconds`<sup>Required</sup> <a name="timeoutSeconds" id="@cdklabs/cdk-ssm-documents.ExecuteStateMachineStep.property.timeoutSeconds"></a>
|
|
7963
8118
|
|
|
7964
8119
|
```typescript
|
|
7965
|
-
public readonly
|
|
8120
|
+
public readonly timeoutSeconds: number;
|
|
7966
8121
|
```
|
|
7967
8122
|
|
|
7968
|
-
- *Type:*
|
|
8123
|
+
- *Type:* number
|
|
8124
|
+
|
|
8125
|
+
---
|
|
8126
|
+
|
|
8127
|
+
##### `explicitNextStep`<sup>Optional</sup> <a name="explicitNextStep" id="@cdklabs/cdk-ssm-documents.ExecuteStateMachineStep.property.explicitNextStep"></a>
|
|
8128
|
+
|
|
8129
|
+
```typescript
|
|
8130
|
+
public readonly explicitNextStep: StepRef;
|
|
8131
|
+
```
|
|
8132
|
+
|
|
8133
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a>
|
|
7969
8134
|
|
|
7970
8135
|
---
|
|
7971
8136
|
|
|
@@ -8933,9 +9098,10 @@ Any object.
|
|
|
8933
9098
|
| <code><a href="#@cdklabs/cdk-ssm-documents.InvokeLambdaFunctionStep.property.description">description</a></code> | <code>string</code> | *No description.* |
|
|
8934
9099
|
| <code><a href="#@cdklabs/cdk-ssm-documents.InvokeLambdaFunctionStep.property.isEnd">isEnd</a></code> | <code>boolean</code> | *No description.* |
|
|
8935
9100
|
| <code><a href="#@cdklabs/cdk-ssm-documents.InvokeLambdaFunctionStep.property.maxAttempts">maxAttempts</a></code> | <code>number</code> | *No description.* |
|
|
9101
|
+
| <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.* |
|
|
9102
|
+
| <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
9103
|
| <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.
|
|
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.* |
|
|
9104
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.InvokeLambdaFunctionStep.property.explicitNextStep">explicitNextStep</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a></code> | *No description.* |
|
|
8939
9105
|
| <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
9106
|
| <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
9107
|
| <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 +9196,43 @@ public readonly maxAttempts: number;
|
|
|
9030
9196
|
|
|
9031
9197
|
---
|
|
9032
9198
|
|
|
9033
|
-
##### `
|
|
9199
|
+
##### `onCancel`<sup>Required</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.InvokeLambdaFunctionStep.property.onCancel"></a>
|
|
9034
9200
|
|
|
9035
9201
|
```typescript
|
|
9036
|
-
public readonly
|
|
9202
|
+
public readonly onCancel: OnCancel;
|
|
9037
9203
|
```
|
|
9038
9204
|
|
|
9039
|
-
- *Type:*
|
|
9205
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a>
|
|
9040
9206
|
|
|
9041
9207
|
---
|
|
9042
9208
|
|
|
9043
|
-
##### `
|
|
9209
|
+
##### `onFailure`<sup>Required</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.InvokeLambdaFunctionStep.property.onFailure"></a>
|
|
9044
9210
|
|
|
9045
9211
|
```typescript
|
|
9046
|
-
public readonly
|
|
9212
|
+
public readonly onFailure: OnFailure;
|
|
9047
9213
|
```
|
|
9048
9214
|
|
|
9049
|
-
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.
|
|
9215
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a>
|
|
9050
9216
|
|
|
9051
9217
|
---
|
|
9052
9218
|
|
|
9053
|
-
##### `
|
|
9219
|
+
##### `timeoutSeconds`<sup>Required</sup> <a name="timeoutSeconds" id="@cdklabs/cdk-ssm-documents.InvokeLambdaFunctionStep.property.timeoutSeconds"></a>
|
|
9054
9220
|
|
|
9055
9221
|
```typescript
|
|
9056
|
-
public readonly
|
|
9222
|
+
public readonly timeoutSeconds: number;
|
|
9057
9223
|
```
|
|
9058
9224
|
|
|
9059
|
-
- *Type:*
|
|
9225
|
+
- *Type:* number
|
|
9226
|
+
|
|
9227
|
+
---
|
|
9228
|
+
|
|
9229
|
+
##### `explicitNextStep`<sup>Optional</sup> <a name="explicitNextStep" id="@cdklabs/cdk-ssm-documents.InvokeLambdaFunctionStep.property.explicitNextStep"></a>
|
|
9230
|
+
|
|
9231
|
+
```typescript
|
|
9232
|
+
public readonly explicitNextStep: StepRef;
|
|
9233
|
+
```
|
|
9234
|
+
|
|
9235
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a>
|
|
9060
9236
|
|
|
9061
9237
|
---
|
|
9062
9238
|
|
|
@@ -9318,9 +9494,10 @@ Any object.
|
|
|
9318
9494
|
| <code><a href="#@cdklabs/cdk-ssm-documents.InvokeWebhookStep.property.description">description</a></code> | <code>string</code> | *No description.* |
|
|
9319
9495
|
| <code><a href="#@cdklabs/cdk-ssm-documents.InvokeWebhookStep.property.isEnd">isEnd</a></code> | <code>boolean</code> | *No description.* |
|
|
9320
9496
|
| <code><a href="#@cdklabs/cdk-ssm-documents.InvokeWebhookStep.property.maxAttempts">maxAttempts</a></code> | <code>number</code> | *No description.* |
|
|
9497
|
+
| <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.* |
|
|
9498
|
+
| <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
9499
|
| <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.
|
|
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.* |
|
|
9500
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.InvokeWebhookStep.property.explicitNextStep">explicitNextStep</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a></code> | *No description.* |
|
|
9324
9501
|
| <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
9502
|
| <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
9503
|
| <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 +9587,43 @@ public readonly maxAttempts: number;
|
|
|
9410
9587
|
|
|
9411
9588
|
---
|
|
9412
9589
|
|
|
9413
|
-
##### `
|
|
9590
|
+
##### `onCancel`<sup>Required</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.InvokeWebhookStep.property.onCancel"></a>
|
|
9414
9591
|
|
|
9415
9592
|
```typescript
|
|
9416
|
-
public readonly
|
|
9593
|
+
public readonly onCancel: OnCancel;
|
|
9417
9594
|
```
|
|
9418
9595
|
|
|
9419
|
-
- *Type:*
|
|
9596
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a>
|
|
9420
9597
|
|
|
9421
9598
|
---
|
|
9422
9599
|
|
|
9423
|
-
##### `
|
|
9600
|
+
##### `onFailure`<sup>Required</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.InvokeWebhookStep.property.onFailure"></a>
|
|
9424
9601
|
|
|
9425
9602
|
```typescript
|
|
9426
|
-
public readonly
|
|
9603
|
+
public readonly onFailure: OnFailure;
|
|
9427
9604
|
```
|
|
9428
9605
|
|
|
9429
|
-
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.
|
|
9606
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a>
|
|
9430
9607
|
|
|
9431
9608
|
---
|
|
9432
9609
|
|
|
9433
|
-
##### `
|
|
9610
|
+
##### `timeoutSeconds`<sup>Required</sup> <a name="timeoutSeconds" id="@cdklabs/cdk-ssm-documents.InvokeWebhookStep.property.timeoutSeconds"></a>
|
|
9434
9611
|
|
|
9435
9612
|
```typescript
|
|
9436
|
-
public readonly
|
|
9613
|
+
public readonly timeoutSeconds: number;
|
|
9437
9614
|
```
|
|
9438
9615
|
|
|
9439
|
-
- *Type:*
|
|
9616
|
+
- *Type:* number
|
|
9617
|
+
|
|
9618
|
+
---
|
|
9619
|
+
|
|
9620
|
+
##### `explicitNextStep`<sup>Optional</sup> <a name="explicitNextStep" id="@cdklabs/cdk-ssm-documents.InvokeWebhookStep.property.explicitNextStep"></a>
|
|
9621
|
+
|
|
9622
|
+
```typescript
|
|
9623
|
+
public readonly explicitNextStep: StepRef;
|
|
9624
|
+
```
|
|
9625
|
+
|
|
9626
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a>
|
|
9440
9627
|
|
|
9441
9628
|
---
|
|
9442
9629
|
|
|
@@ -9648,9 +9835,10 @@ Any object.
|
|
|
9648
9835
|
| <code><a href="#@cdklabs/cdk-ssm-documents.PauseStep.property.description">description</a></code> | <code>string</code> | *No description.* |
|
|
9649
9836
|
| <code><a href="#@cdklabs/cdk-ssm-documents.PauseStep.property.isEnd">isEnd</a></code> | <code>boolean</code> | *No description.* |
|
|
9650
9837
|
| <code><a href="#@cdklabs/cdk-ssm-documents.PauseStep.property.maxAttempts">maxAttempts</a></code> | <code>number</code> | *No description.* |
|
|
9838
|
+
| <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.* |
|
|
9839
|
+
| <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
9840
|
| <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.
|
|
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.* |
|
|
9841
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.PauseStep.property.explicitNextStep">explicitNextStep</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a></code> | *No description.* |
|
|
9654
9842
|
| <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
9843
|
| <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
9844
|
|
|
@@ -9738,33 +9926,43 @@ public readonly maxAttempts: number;
|
|
|
9738
9926
|
|
|
9739
9927
|
---
|
|
9740
9928
|
|
|
9741
|
-
##### `
|
|
9929
|
+
##### `onCancel`<sup>Required</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.PauseStep.property.onCancel"></a>
|
|
9742
9930
|
|
|
9743
9931
|
```typescript
|
|
9744
|
-
public readonly
|
|
9932
|
+
public readonly onCancel: OnCancel;
|
|
9745
9933
|
```
|
|
9746
9934
|
|
|
9747
|
-
- *Type:*
|
|
9935
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a>
|
|
9748
9936
|
|
|
9749
9937
|
---
|
|
9750
9938
|
|
|
9751
|
-
##### `
|
|
9939
|
+
##### `onFailure`<sup>Required</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.PauseStep.property.onFailure"></a>
|
|
9752
9940
|
|
|
9753
9941
|
```typescript
|
|
9754
|
-
public readonly
|
|
9942
|
+
public readonly onFailure: OnFailure;
|
|
9755
9943
|
```
|
|
9756
9944
|
|
|
9757
|
-
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.
|
|
9945
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a>
|
|
9758
9946
|
|
|
9759
9947
|
---
|
|
9760
9948
|
|
|
9761
|
-
##### `
|
|
9949
|
+
##### `timeoutSeconds`<sup>Required</sup> <a name="timeoutSeconds" id="@cdklabs/cdk-ssm-documents.PauseStep.property.timeoutSeconds"></a>
|
|
9762
9950
|
|
|
9763
9951
|
```typescript
|
|
9764
|
-
public readonly
|
|
9952
|
+
public readonly timeoutSeconds: number;
|
|
9765
9953
|
```
|
|
9766
9954
|
|
|
9767
|
-
- *Type:*
|
|
9955
|
+
- *Type:* number
|
|
9956
|
+
|
|
9957
|
+
---
|
|
9958
|
+
|
|
9959
|
+
##### `explicitNextStep`<sup>Optional</sup> <a name="explicitNextStep" id="@cdklabs/cdk-ssm-documents.PauseStep.property.explicitNextStep"></a>
|
|
9960
|
+
|
|
9961
|
+
```typescript
|
|
9962
|
+
public readonly explicitNextStep: StepRef;
|
|
9963
|
+
```
|
|
9964
|
+
|
|
9965
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a>
|
|
9768
9966
|
|
|
9769
9967
|
---
|
|
9770
9968
|
|
|
@@ -10436,9 +10634,10 @@ Any object.
|
|
|
10436
10634
|
| <code><a href="#@cdklabs/cdk-ssm-documents.RunCommandStep.property.description">description</a></code> | <code>string</code> | *No description.* |
|
|
10437
10635
|
| <code><a href="#@cdklabs/cdk-ssm-documents.RunCommandStep.property.isEnd">isEnd</a></code> | <code>boolean</code> | *No description.* |
|
|
10438
10636
|
| <code><a href="#@cdklabs/cdk-ssm-documents.RunCommandStep.property.maxAttempts">maxAttempts</a></code> | <code>number</code> | *No description.* |
|
|
10637
|
+
| <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.* |
|
|
10638
|
+
| <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
10639
|
| <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.
|
|
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.* |
|
|
10640
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.RunCommandStep.property.explicitNextStep">explicitNextStep</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a></code> | *No description.* |
|
|
10442
10641
|
| <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
10642
|
| <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
10643
|
| <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 +10739,43 @@ public readonly maxAttempts: number;
|
|
|
10540
10739
|
|
|
10541
10740
|
---
|
|
10542
10741
|
|
|
10543
|
-
##### `
|
|
10742
|
+
##### `onCancel`<sup>Required</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.RunCommandStep.property.onCancel"></a>
|
|
10544
10743
|
|
|
10545
10744
|
```typescript
|
|
10546
|
-
public readonly
|
|
10745
|
+
public readonly onCancel: OnCancel;
|
|
10547
10746
|
```
|
|
10548
10747
|
|
|
10549
|
-
- *Type:*
|
|
10748
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a>
|
|
10550
10749
|
|
|
10551
10750
|
---
|
|
10552
10751
|
|
|
10553
|
-
##### `
|
|
10752
|
+
##### `onFailure`<sup>Required</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.RunCommandStep.property.onFailure"></a>
|
|
10554
10753
|
|
|
10555
10754
|
```typescript
|
|
10556
|
-
public readonly
|
|
10755
|
+
public readonly onFailure: OnFailure;
|
|
10557
10756
|
```
|
|
10558
10757
|
|
|
10559
|
-
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.
|
|
10758
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a>
|
|
10560
10759
|
|
|
10561
10760
|
---
|
|
10562
10761
|
|
|
10563
|
-
##### `
|
|
10762
|
+
##### `timeoutSeconds`<sup>Required</sup> <a name="timeoutSeconds" id="@cdklabs/cdk-ssm-documents.RunCommandStep.property.timeoutSeconds"></a>
|
|
10564
10763
|
|
|
10565
10764
|
```typescript
|
|
10566
|
-
public readonly
|
|
10765
|
+
public readonly timeoutSeconds: number;
|
|
10567
10766
|
```
|
|
10568
10767
|
|
|
10569
|
-
- *Type:*
|
|
10768
|
+
- *Type:* number
|
|
10769
|
+
|
|
10770
|
+
---
|
|
10771
|
+
|
|
10772
|
+
##### `explicitNextStep`<sup>Optional</sup> <a name="explicitNextStep" id="@cdklabs/cdk-ssm-documents.RunCommandStep.property.explicitNextStep"></a>
|
|
10773
|
+
|
|
10774
|
+
```typescript
|
|
10775
|
+
public readonly explicitNextStep: StepRef;
|
|
10776
|
+
```
|
|
10777
|
+
|
|
10778
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a>
|
|
10570
10779
|
|
|
10571
10780
|
---
|
|
10572
10781
|
|
|
@@ -11612,9 +11821,10 @@ Any object.
|
|
|
11612
11821
|
| <code><a href="#@cdklabs/cdk-ssm-documents.RunInstanceStep.property.description">description</a></code> | <code>string</code> | *No description.* |
|
|
11613
11822
|
| <code><a href="#@cdklabs/cdk-ssm-documents.RunInstanceStep.property.isEnd">isEnd</a></code> | <code>boolean</code> | *No description.* |
|
|
11614
11823
|
| <code><a href="#@cdklabs/cdk-ssm-documents.RunInstanceStep.property.maxAttempts">maxAttempts</a></code> | <code>number</code> | *No description.* |
|
|
11824
|
+
| <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.* |
|
|
11825
|
+
| <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
11826
|
| <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.
|
|
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.* |
|
|
11827
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.RunInstanceStep.property.explicitNextStep">explicitNextStep</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a></code> | *No description.* |
|
|
11618
11828
|
| <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
11829
|
| <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
11830
|
| <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 +11936,43 @@ public readonly maxAttempts: number;
|
|
|
11726
11936
|
|
|
11727
11937
|
---
|
|
11728
11938
|
|
|
11729
|
-
##### `
|
|
11939
|
+
##### `onCancel`<sup>Required</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.RunInstanceStep.property.onCancel"></a>
|
|
11730
11940
|
|
|
11731
11941
|
```typescript
|
|
11732
|
-
public readonly
|
|
11942
|
+
public readonly onCancel: OnCancel;
|
|
11733
11943
|
```
|
|
11734
11944
|
|
|
11735
|
-
- *Type:*
|
|
11945
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a>
|
|
11736
11946
|
|
|
11737
11947
|
---
|
|
11738
11948
|
|
|
11739
|
-
##### `
|
|
11949
|
+
##### `onFailure`<sup>Required</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.RunInstanceStep.property.onFailure"></a>
|
|
11740
11950
|
|
|
11741
11951
|
```typescript
|
|
11742
|
-
public readonly
|
|
11952
|
+
public readonly onFailure: OnFailure;
|
|
11743
11953
|
```
|
|
11744
11954
|
|
|
11745
|
-
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.
|
|
11955
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a>
|
|
11746
11956
|
|
|
11747
11957
|
---
|
|
11748
11958
|
|
|
11749
|
-
##### `
|
|
11959
|
+
##### `timeoutSeconds`<sup>Required</sup> <a name="timeoutSeconds" id="@cdklabs/cdk-ssm-documents.RunInstanceStep.property.timeoutSeconds"></a>
|
|
11750
11960
|
|
|
11751
11961
|
```typescript
|
|
11752
|
-
public readonly
|
|
11962
|
+
public readonly timeoutSeconds: number;
|
|
11753
11963
|
```
|
|
11754
11964
|
|
|
11755
|
-
- *Type:*
|
|
11965
|
+
- *Type:* number
|
|
11966
|
+
|
|
11967
|
+
---
|
|
11968
|
+
|
|
11969
|
+
##### `explicitNextStep`<sup>Optional</sup> <a name="explicitNextStep" id="@cdklabs/cdk-ssm-documents.RunInstanceStep.property.explicitNextStep"></a>
|
|
11970
|
+
|
|
11971
|
+
```typescript
|
|
11972
|
+
public readonly explicitNextStep: StepRef;
|
|
11973
|
+
```
|
|
11974
|
+
|
|
11975
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a>
|
|
11756
11976
|
|
|
11757
11977
|
---
|
|
11758
11978
|
|
|
@@ -12832,9 +13052,10 @@ Any object.
|
|
|
12832
13052
|
| <code><a href="#@cdklabs/cdk-ssm-documents.SleepStep.property.description">description</a></code> | <code>string</code> | *No description.* |
|
|
12833
13053
|
| <code><a href="#@cdklabs/cdk-ssm-documents.SleepStep.property.isEnd">isEnd</a></code> | <code>boolean</code> | *No description.* |
|
|
12834
13054
|
| <code><a href="#@cdklabs/cdk-ssm-documents.SleepStep.property.maxAttempts">maxAttempts</a></code> | <code>number</code> | *No description.* |
|
|
13055
|
+
| <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.* |
|
|
13056
|
+
| <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
13057
|
| <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.
|
|
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.* |
|
|
13058
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.SleepStep.property.explicitNextStep">explicitNextStep</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a></code> | *No description.* |
|
|
12838
13059
|
| <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
13060
|
| <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
13061
|
| <code><a href="#@cdklabs/cdk-ssm-documents.SleepStep.property.sleepSeconds">sleepSeconds</a></code> | <code>number</code> | *No description.* |
|
|
@@ -12923,33 +13144,43 @@ public readonly maxAttempts: number;
|
|
|
12923
13144
|
|
|
12924
13145
|
---
|
|
12925
13146
|
|
|
12926
|
-
##### `
|
|
13147
|
+
##### `onCancel`<sup>Required</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.SleepStep.property.onCancel"></a>
|
|
12927
13148
|
|
|
12928
13149
|
```typescript
|
|
12929
|
-
public readonly
|
|
13150
|
+
public readonly onCancel: OnCancel;
|
|
12930
13151
|
```
|
|
12931
13152
|
|
|
12932
|
-
- *Type:*
|
|
13153
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a>
|
|
12933
13154
|
|
|
12934
13155
|
---
|
|
12935
13156
|
|
|
12936
|
-
##### `
|
|
13157
|
+
##### `onFailure`<sup>Required</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.SleepStep.property.onFailure"></a>
|
|
12937
13158
|
|
|
12938
13159
|
```typescript
|
|
12939
|
-
public readonly
|
|
13160
|
+
public readonly onFailure: OnFailure;
|
|
12940
13161
|
```
|
|
12941
13162
|
|
|
12942
|
-
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.
|
|
13163
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a>
|
|
12943
13164
|
|
|
12944
13165
|
---
|
|
12945
13166
|
|
|
12946
|
-
##### `
|
|
13167
|
+
##### `timeoutSeconds`<sup>Required</sup> <a name="timeoutSeconds" id="@cdklabs/cdk-ssm-documents.SleepStep.property.timeoutSeconds"></a>
|
|
12947
13168
|
|
|
12948
13169
|
```typescript
|
|
12949
|
-
public readonly
|
|
13170
|
+
public readonly timeoutSeconds: number;
|
|
12950
13171
|
```
|
|
12951
13172
|
|
|
12952
|
-
- *Type:*
|
|
13173
|
+
- *Type:* number
|
|
13174
|
+
|
|
13175
|
+
---
|
|
13176
|
+
|
|
13177
|
+
##### `explicitNextStep`<sup>Optional</sup> <a name="explicitNextStep" id="@cdklabs/cdk-ssm-documents.SleepStep.property.explicitNextStep"></a>
|
|
13178
|
+
|
|
13179
|
+
```typescript
|
|
13180
|
+
public readonly explicitNextStep: StepRef;
|
|
13181
|
+
```
|
|
13182
|
+
|
|
13183
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a>
|
|
12953
13184
|
|
|
12954
13185
|
---
|
|
12955
13186
|
|
|
@@ -14987,9 +15218,10 @@ Any object.
|
|
|
14987
15218
|
| <code><a href="#@cdklabs/cdk-ssm-documents.WaitForResourceStep.property.description">description</a></code> | <code>string</code> | *No description.* |
|
|
14988
15219
|
| <code><a href="#@cdklabs/cdk-ssm-documents.WaitForResourceStep.property.isEnd">isEnd</a></code> | <code>boolean</code> | *No description.* |
|
|
14989
15220
|
| <code><a href="#@cdklabs/cdk-ssm-documents.WaitForResourceStep.property.maxAttempts">maxAttempts</a></code> | <code>number</code> | *No description.* |
|
|
15221
|
+
| <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.* |
|
|
15222
|
+
| <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
15223
|
| <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.
|
|
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.* |
|
|
15224
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.WaitForResourceStep.property.explicitNextStep">explicitNextStep</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a></code> | *No description.* |
|
|
14993
15225
|
| <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
15226
|
| <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
15227
|
| <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 +15317,43 @@ public readonly maxAttempts: number;
|
|
|
15085
15317
|
|
|
15086
15318
|
---
|
|
15087
15319
|
|
|
15088
|
-
##### `
|
|
15320
|
+
##### `onCancel`<sup>Required</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.WaitForResourceStep.property.onCancel"></a>
|
|
15089
15321
|
|
|
15090
15322
|
```typescript
|
|
15091
|
-
public readonly
|
|
15323
|
+
public readonly onCancel: OnCancel;
|
|
15092
15324
|
```
|
|
15093
15325
|
|
|
15094
|
-
- *Type:*
|
|
15326
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a>
|
|
15095
15327
|
|
|
15096
15328
|
---
|
|
15097
15329
|
|
|
15098
|
-
##### `
|
|
15330
|
+
##### `onFailure`<sup>Required</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.WaitForResourceStep.property.onFailure"></a>
|
|
15099
15331
|
|
|
15100
15332
|
```typescript
|
|
15101
|
-
public readonly
|
|
15333
|
+
public readonly onFailure: OnFailure;
|
|
15102
15334
|
```
|
|
15103
15335
|
|
|
15104
|
-
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.
|
|
15336
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a>
|
|
15105
15337
|
|
|
15106
15338
|
---
|
|
15107
15339
|
|
|
15108
|
-
##### `
|
|
15340
|
+
##### `timeoutSeconds`<sup>Required</sup> <a name="timeoutSeconds" id="@cdklabs/cdk-ssm-documents.WaitForResourceStep.property.timeoutSeconds"></a>
|
|
15109
15341
|
|
|
15110
15342
|
```typescript
|
|
15111
|
-
public readonly
|
|
15343
|
+
public readonly timeoutSeconds: number;
|
|
15112
15344
|
```
|
|
15113
15345
|
|
|
15114
|
-
- *Type:*
|
|
15346
|
+
- *Type:* number
|
|
15347
|
+
|
|
15348
|
+
---
|
|
15349
|
+
|
|
15350
|
+
##### `explicitNextStep`<sup>Optional</sup> <a name="explicitNextStep" id="@cdklabs/cdk-ssm-documents.WaitForResourceStep.property.explicitNextStep"></a>
|
|
15351
|
+
|
|
15352
|
+
```typescript
|
|
15353
|
+
public readonly explicitNextStep: StepRef;
|
|
15354
|
+
```
|
|
15355
|
+
|
|
15356
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a>
|
|
15115
15357
|
|
|
15116
15358
|
---
|
|
15117
15359
|
|
|
@@ -15583,10 +15825,11 @@ const approveStepProps: ApproveStepProps = { ... }
|
|
|
15583
15825
|
| <code><a href="#@cdklabs/cdk-ssm-documents.ApproveStepProps.property.inputObserver">inputObserver</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.IObserver">IObserver</a></code> | (Optional) Allows for observing the input to steps as they run. |
|
|
15584
15826
|
| <code><a href="#@cdklabs/cdk-ssm-documents.ApproveStepProps.property.name">name</a></code> | <code>string</code> | (Optional) Name of the current step. |
|
|
15585
15827
|
| <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. |
|
|
15828
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.ApproveStepProps.property.explicitNextStep">explicitNextStep</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a></code> | (Optional) explicit step to go to after this step completes. |
|
|
15586
15829
|
| <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
15830
|
| <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.
|
|
15589
|
-
| <code><a href="#@cdklabs/cdk-ssm-documents.ApproveStepProps.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.
|
|
15831
|
+
| <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. |
|
|
15832
|
+
| <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
15833
|
| <code><a href="#@cdklabs/cdk-ssm-documents.ApproveStepProps.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</code> | (Optional) timeout seconds to run this step. |
|
|
15591
15834
|
| <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
15835
|
| <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. |
|
|
@@ -15650,6 +15893,21 @@ public readonly outputObserver: IObserver;
|
|
|
15650
15893
|
|
|
15651
15894
|
---
|
|
15652
15895
|
|
|
15896
|
+
##### `explicitNextStep`<sup>Optional</sup> <a name="explicitNextStep" id="@cdklabs/cdk-ssm-documents.ApproveStepProps.property.explicitNextStep"></a>
|
|
15897
|
+
|
|
15898
|
+
```typescript
|
|
15899
|
+
public readonly explicitNextStep: StepRef;
|
|
15900
|
+
```
|
|
15901
|
+
|
|
15902
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a>
|
|
15903
|
+
- *Default:* will implicitly choose the next step in the sequence that the steps are added to the document.
|
|
15904
|
+
|
|
15905
|
+
(Optional) explicit step to go to after this step completes.
|
|
15906
|
+
|
|
15907
|
+
https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-actions.html#nextProp
|
|
15908
|
+
|
|
15909
|
+
---
|
|
15910
|
+
|
|
15653
15911
|
##### `isEnd`<sup>Optional</sup> <a name="isEnd" id="@cdklabs/cdk-ssm-documents.ApproveStepProps.property.isEnd"></a>
|
|
15654
15912
|
|
|
15655
15913
|
```typescript
|
|
@@ -15679,26 +15937,26 @@ public readonly maxAttempts: number;
|
|
|
15679
15937
|
##### `onCancel`<sup>Optional</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.ApproveStepProps.property.onCancel"></a>
|
|
15680
15938
|
|
|
15681
15939
|
```typescript
|
|
15682
|
-
public readonly onCancel:
|
|
15940
|
+
public readonly onCancel: OnCancel;
|
|
15683
15941
|
```
|
|
15684
15942
|
|
|
15685
|
-
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.
|
|
15943
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a>
|
|
15686
15944
|
- *Default:* undefined
|
|
15687
15945
|
|
|
15688
|
-
(Optional)
|
|
15946
|
+
(Optional) Fallback action to take in the event that this step is cancelled.
|
|
15689
15947
|
|
|
15690
15948
|
---
|
|
15691
15949
|
|
|
15692
15950
|
##### `onFailure`<sup>Optional</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.ApproveStepProps.property.onFailure"></a>
|
|
15693
15951
|
|
|
15694
15952
|
```typescript
|
|
15695
|
-
public readonly onFailure:
|
|
15953
|
+
public readonly onFailure: OnFailure;
|
|
15696
15954
|
```
|
|
15697
15955
|
|
|
15698
|
-
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.
|
|
15956
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a>
|
|
15699
15957
|
- *Default:* undefined
|
|
15700
15958
|
|
|
15701
|
-
(Optional)
|
|
15959
|
+
(Optional) Fallback action to take in the event that this step fails.
|
|
15702
15960
|
|
|
15703
15961
|
---
|
|
15704
15962
|
|
|
@@ -15799,10 +16057,11 @@ const assertAwsResourceStepProps: AssertAwsResourceStepProps = { ... }
|
|
|
15799
16057
|
| <code><a href="#@cdklabs/cdk-ssm-documents.AssertAwsResourceStepProps.property.inputObserver">inputObserver</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.IObserver">IObserver</a></code> | (Optional) Allows for observing the input to steps as they run. |
|
|
15800
16058
|
| <code><a href="#@cdklabs/cdk-ssm-documents.AssertAwsResourceStepProps.property.name">name</a></code> | <code>string</code> | (Optional) Name of the current step. |
|
|
15801
16059
|
| <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. |
|
|
16060
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.AssertAwsResourceStepProps.property.explicitNextStep">explicitNextStep</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a></code> | (Optional) explicit step to go to after this step completes. |
|
|
15802
16061
|
| <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
16062
|
| <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.
|
|
15805
|
-
| <code><a href="#@cdklabs/cdk-ssm-documents.AssertAwsResourceStepProps.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.
|
|
16063
|
+
| <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. |
|
|
16064
|
+
| <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
16065
|
| <code><a href="#@cdklabs/cdk-ssm-documents.AssertAwsResourceStepProps.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</code> | (Optional) timeout seconds to run this step. |
|
|
15807
16066
|
| <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
16067
|
| <code><a href="#@cdklabs/cdk-ssm-documents.AssertAwsResourceStepProps.property.pascalCaseApi">pascalCaseApi</a></code> | <code>string</code> | (Required) The AWS api represented in PascalCase. |
|
|
@@ -15868,6 +16127,21 @@ public readonly outputObserver: IObserver;
|
|
|
15868
16127
|
|
|
15869
16128
|
---
|
|
15870
16129
|
|
|
16130
|
+
##### `explicitNextStep`<sup>Optional</sup> <a name="explicitNextStep" id="@cdklabs/cdk-ssm-documents.AssertAwsResourceStepProps.property.explicitNextStep"></a>
|
|
16131
|
+
|
|
16132
|
+
```typescript
|
|
16133
|
+
public readonly explicitNextStep: StepRef;
|
|
16134
|
+
```
|
|
16135
|
+
|
|
16136
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a>
|
|
16137
|
+
- *Default:* will implicitly choose the next step in the sequence that the steps are added to the document.
|
|
16138
|
+
|
|
16139
|
+
(Optional) explicit step to go to after this step completes.
|
|
16140
|
+
|
|
16141
|
+
https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-actions.html#nextProp
|
|
16142
|
+
|
|
16143
|
+
---
|
|
16144
|
+
|
|
15871
16145
|
##### `isEnd`<sup>Optional</sup> <a name="isEnd" id="@cdklabs/cdk-ssm-documents.AssertAwsResourceStepProps.property.isEnd"></a>
|
|
15872
16146
|
|
|
15873
16147
|
```typescript
|
|
@@ -15897,26 +16171,26 @@ public readonly maxAttempts: number;
|
|
|
15897
16171
|
##### `onCancel`<sup>Optional</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.AssertAwsResourceStepProps.property.onCancel"></a>
|
|
15898
16172
|
|
|
15899
16173
|
```typescript
|
|
15900
|
-
public readonly onCancel:
|
|
16174
|
+
public readonly onCancel: OnCancel;
|
|
15901
16175
|
```
|
|
15902
16176
|
|
|
15903
|
-
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.
|
|
16177
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a>
|
|
15904
16178
|
- *Default:* undefined
|
|
15905
16179
|
|
|
15906
|
-
(Optional)
|
|
16180
|
+
(Optional) Fallback action to take in the event that this step is cancelled.
|
|
15907
16181
|
|
|
15908
16182
|
---
|
|
15909
16183
|
|
|
15910
16184
|
##### `onFailure`<sup>Optional</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.AssertAwsResourceStepProps.property.onFailure"></a>
|
|
15911
16185
|
|
|
15912
16186
|
```typescript
|
|
15913
|
-
public readonly onFailure:
|
|
16187
|
+
public readonly onFailure: OnFailure;
|
|
15914
16188
|
```
|
|
15915
16189
|
|
|
15916
|
-
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.
|
|
16190
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a>
|
|
15917
16191
|
- *Default:* undefined
|
|
15918
16192
|
|
|
15919
|
-
(Optional)
|
|
16193
|
+
(Optional) Fallback action to take in the event that this step fails.
|
|
15920
16194
|
|
|
15921
16195
|
---
|
|
15922
16196
|
|
|
@@ -16407,10 +16681,11 @@ const automationStepProps: AutomationStepProps = { ... }
|
|
|
16407
16681
|
| <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStepProps.property.inputObserver">inputObserver</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.IObserver">IObserver</a></code> | (Optional) Allows for observing the input to steps as they run. |
|
|
16408
16682
|
| <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStepProps.property.name">name</a></code> | <code>string</code> | (Optional) Name of the current step. |
|
|
16409
16683
|
| <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. |
|
|
16684
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStepProps.property.explicitNextStep">explicitNextStep</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a></code> | (Optional) explicit step to go to after this step completes. |
|
|
16410
16685
|
| <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
16686
|
| <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.
|
|
16413
|
-
| <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStepProps.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.
|
|
16687
|
+
| <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. |
|
|
16688
|
+
| <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
16689
|
| <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStepProps.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</code> | (Optional) timeout seconds to run this step. |
|
|
16415
16690
|
|
|
16416
16691
|
---
|
|
@@ -16470,6 +16745,21 @@ public readonly outputObserver: IObserver;
|
|
|
16470
16745
|
|
|
16471
16746
|
---
|
|
16472
16747
|
|
|
16748
|
+
##### `explicitNextStep`<sup>Optional</sup> <a name="explicitNextStep" id="@cdklabs/cdk-ssm-documents.AutomationStepProps.property.explicitNextStep"></a>
|
|
16749
|
+
|
|
16750
|
+
```typescript
|
|
16751
|
+
public readonly explicitNextStep: StepRef;
|
|
16752
|
+
```
|
|
16753
|
+
|
|
16754
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a>
|
|
16755
|
+
- *Default:* will implicitly choose the next step in the sequence that the steps are added to the document.
|
|
16756
|
+
|
|
16757
|
+
(Optional) explicit step to go to after this step completes.
|
|
16758
|
+
|
|
16759
|
+
https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-actions.html#nextProp
|
|
16760
|
+
|
|
16761
|
+
---
|
|
16762
|
+
|
|
16473
16763
|
##### `isEnd`<sup>Optional</sup> <a name="isEnd" id="@cdklabs/cdk-ssm-documents.AutomationStepProps.property.isEnd"></a>
|
|
16474
16764
|
|
|
16475
16765
|
```typescript
|
|
@@ -16499,26 +16789,26 @@ public readonly maxAttempts: number;
|
|
|
16499
16789
|
##### `onCancel`<sup>Optional</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.AutomationStepProps.property.onCancel"></a>
|
|
16500
16790
|
|
|
16501
16791
|
```typescript
|
|
16502
|
-
public readonly onCancel:
|
|
16792
|
+
public readonly onCancel: OnCancel;
|
|
16503
16793
|
```
|
|
16504
16794
|
|
|
16505
|
-
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.
|
|
16795
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a>
|
|
16506
16796
|
- *Default:* undefined
|
|
16507
16797
|
|
|
16508
|
-
(Optional)
|
|
16798
|
+
(Optional) Fallback action to take in the event that this step is cancelled.
|
|
16509
16799
|
|
|
16510
16800
|
---
|
|
16511
16801
|
|
|
16512
16802
|
##### `onFailure`<sup>Optional</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.AutomationStepProps.property.onFailure"></a>
|
|
16513
16803
|
|
|
16514
16804
|
```typescript
|
|
16515
|
-
public readonly onFailure:
|
|
16805
|
+
public readonly onFailure: OnFailure;
|
|
16516
16806
|
```
|
|
16517
16807
|
|
|
16518
|
-
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.
|
|
16808
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a>
|
|
16519
16809
|
- *Default:* undefined
|
|
16520
16810
|
|
|
16521
|
-
(Optional)
|
|
16811
|
+
(Optional) Fallback action to take in the event that this step fails.
|
|
16522
16812
|
|
|
16523
16813
|
---
|
|
16524
16814
|
|
|
@@ -16557,10 +16847,11 @@ const awsApiStepProps: AwsApiStepProps = { ... }
|
|
|
16557
16847
|
| <code><a href="#@cdklabs/cdk-ssm-documents.AwsApiStepProps.property.inputObserver">inputObserver</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.IObserver">IObserver</a></code> | (Optional) Allows for observing the input to steps as they run. |
|
|
16558
16848
|
| <code><a href="#@cdklabs/cdk-ssm-documents.AwsApiStepProps.property.name">name</a></code> | <code>string</code> | (Optional) Name of the current step. |
|
|
16559
16849
|
| <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. |
|
|
16850
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.AwsApiStepProps.property.explicitNextStep">explicitNextStep</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a></code> | (Optional) explicit step to go to after this step completes. |
|
|
16560
16851
|
| <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
16852
|
| <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.
|
|
16563
|
-
| <code><a href="#@cdklabs/cdk-ssm-documents.AwsApiStepProps.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.
|
|
16853
|
+
| <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. |
|
|
16854
|
+
| <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
16855
|
| <code><a href="#@cdklabs/cdk-ssm-documents.AwsApiStepProps.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</code> | (Optional) timeout seconds to run this step. |
|
|
16565
16856
|
| <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
16857
|
| <code><a href="#@cdklabs/cdk-ssm-documents.AwsApiStepProps.property.pascalCaseApi">pascalCaseApi</a></code> | <code>string</code> | (Required) The AWS api represented in PascalCase. |
|
|
@@ -16625,6 +16916,21 @@ public readonly outputObserver: IObserver;
|
|
|
16625
16916
|
|
|
16626
16917
|
---
|
|
16627
16918
|
|
|
16919
|
+
##### `explicitNextStep`<sup>Optional</sup> <a name="explicitNextStep" id="@cdklabs/cdk-ssm-documents.AwsApiStepProps.property.explicitNextStep"></a>
|
|
16920
|
+
|
|
16921
|
+
```typescript
|
|
16922
|
+
public readonly explicitNextStep: StepRef;
|
|
16923
|
+
```
|
|
16924
|
+
|
|
16925
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a>
|
|
16926
|
+
- *Default:* will implicitly choose the next step in the sequence that the steps are added to the document.
|
|
16927
|
+
|
|
16928
|
+
(Optional) explicit step to go to after this step completes.
|
|
16929
|
+
|
|
16930
|
+
https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-actions.html#nextProp
|
|
16931
|
+
|
|
16932
|
+
---
|
|
16933
|
+
|
|
16628
16934
|
##### `isEnd`<sup>Optional</sup> <a name="isEnd" id="@cdklabs/cdk-ssm-documents.AwsApiStepProps.property.isEnd"></a>
|
|
16629
16935
|
|
|
16630
16936
|
```typescript
|
|
@@ -16654,26 +16960,26 @@ public readonly maxAttempts: number;
|
|
|
16654
16960
|
##### `onCancel`<sup>Optional</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.AwsApiStepProps.property.onCancel"></a>
|
|
16655
16961
|
|
|
16656
16962
|
```typescript
|
|
16657
|
-
public readonly onCancel:
|
|
16963
|
+
public readonly onCancel: OnCancel;
|
|
16658
16964
|
```
|
|
16659
16965
|
|
|
16660
|
-
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.
|
|
16966
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a>
|
|
16661
16967
|
- *Default:* undefined
|
|
16662
16968
|
|
|
16663
|
-
(Optional)
|
|
16969
|
+
(Optional) Fallback action to take in the event that this step is cancelled.
|
|
16664
16970
|
|
|
16665
16971
|
---
|
|
16666
16972
|
|
|
16667
16973
|
##### `onFailure`<sup>Optional</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.AwsApiStepProps.property.onFailure"></a>
|
|
16668
16974
|
|
|
16669
16975
|
```typescript
|
|
16670
|
-
public readonly onFailure:
|
|
16976
|
+
public readonly onFailure: OnFailure;
|
|
16671
16977
|
```
|
|
16672
16978
|
|
|
16673
|
-
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.
|
|
16979
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a>
|
|
16674
16980
|
- *Default:* undefined
|
|
16675
16981
|
|
|
16676
|
-
(Optional)
|
|
16982
|
+
(Optional) Fallback action to take in the event that this step fails.
|
|
16677
16983
|
|
|
16678
16984
|
---
|
|
16679
16985
|
|
|
@@ -16807,10 +17113,11 @@ const awsInvocationProps: AwsInvocationProps = { ... }
|
|
|
16807
17113
|
| <code><a href="#@cdklabs/cdk-ssm-documents.AwsInvocationProps.property.inputObserver">inputObserver</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.IObserver">IObserver</a></code> | (Optional) Allows for observing the input to steps as they run. |
|
|
16808
17114
|
| <code><a href="#@cdklabs/cdk-ssm-documents.AwsInvocationProps.property.name">name</a></code> | <code>string</code> | (Optional) Name of the current step. |
|
|
16809
17115
|
| <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. |
|
|
17116
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.AwsInvocationProps.property.explicitNextStep">explicitNextStep</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a></code> | (Optional) explicit step to go to after this step completes. |
|
|
16810
17117
|
| <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
17118
|
| <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.
|
|
16813
|
-
| <code><a href="#@cdklabs/cdk-ssm-documents.AwsInvocationProps.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.
|
|
17119
|
+
| <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. |
|
|
17120
|
+
| <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
17121
|
| <code><a href="#@cdklabs/cdk-ssm-documents.AwsInvocationProps.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</code> | (Optional) timeout seconds to run this step. |
|
|
16815
17122
|
| <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
17123
|
| <code><a href="#@cdklabs/cdk-ssm-documents.AwsInvocationProps.property.pascalCaseApi">pascalCaseApi</a></code> | <code>string</code> | (Required) The AWS api represented in PascalCase. |
|
|
@@ -16874,6 +17181,21 @@ public readonly outputObserver: IObserver;
|
|
|
16874
17181
|
|
|
16875
17182
|
---
|
|
16876
17183
|
|
|
17184
|
+
##### `explicitNextStep`<sup>Optional</sup> <a name="explicitNextStep" id="@cdklabs/cdk-ssm-documents.AwsInvocationProps.property.explicitNextStep"></a>
|
|
17185
|
+
|
|
17186
|
+
```typescript
|
|
17187
|
+
public readonly explicitNextStep: StepRef;
|
|
17188
|
+
```
|
|
17189
|
+
|
|
17190
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a>
|
|
17191
|
+
- *Default:* will implicitly choose the next step in the sequence that the steps are added to the document.
|
|
17192
|
+
|
|
17193
|
+
(Optional) explicit step to go to after this step completes.
|
|
17194
|
+
|
|
17195
|
+
https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-actions.html#nextProp
|
|
17196
|
+
|
|
17197
|
+
---
|
|
17198
|
+
|
|
16877
17199
|
##### `isEnd`<sup>Optional</sup> <a name="isEnd" id="@cdklabs/cdk-ssm-documents.AwsInvocationProps.property.isEnd"></a>
|
|
16878
17200
|
|
|
16879
17201
|
```typescript
|
|
@@ -16903,26 +17225,26 @@ public readonly maxAttempts: number;
|
|
|
16903
17225
|
##### `onCancel`<sup>Optional</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.AwsInvocationProps.property.onCancel"></a>
|
|
16904
17226
|
|
|
16905
17227
|
```typescript
|
|
16906
|
-
public readonly onCancel:
|
|
17228
|
+
public readonly onCancel: OnCancel;
|
|
16907
17229
|
```
|
|
16908
17230
|
|
|
16909
|
-
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.
|
|
17231
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a>
|
|
16910
17232
|
- *Default:* undefined
|
|
16911
17233
|
|
|
16912
|
-
(Optional)
|
|
17234
|
+
(Optional) Fallback action to take in the event that this step is cancelled.
|
|
16913
17235
|
|
|
16914
17236
|
---
|
|
16915
17237
|
|
|
16916
17238
|
##### `onFailure`<sup>Optional</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.AwsInvocationProps.property.onFailure"></a>
|
|
16917
17239
|
|
|
16918
17240
|
```typescript
|
|
16919
|
-
public readonly onFailure:
|
|
17241
|
+
public readonly onFailure: OnFailure;
|
|
16920
17242
|
```
|
|
16921
17243
|
|
|
16922
|
-
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.
|
|
17244
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a>
|
|
16923
17245
|
- *Default:* undefined
|
|
16924
17246
|
|
|
16925
|
-
(Optional)
|
|
17247
|
+
(Optional) Fallback action to take in the event that this step fails.
|
|
16926
17248
|
|
|
16927
17249
|
---
|
|
16928
17250
|
|
|
@@ -17165,10 +17487,11 @@ const branchStepProps: BranchStepProps = { ... }
|
|
|
17165
17487
|
| <code><a href="#@cdklabs/cdk-ssm-documents.BranchStepProps.property.inputObserver">inputObserver</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.IObserver">IObserver</a></code> | (Optional) Allows for observing the input to steps as they run. |
|
|
17166
17488
|
| <code><a href="#@cdklabs/cdk-ssm-documents.BranchStepProps.property.name">name</a></code> | <code>string</code> | (Optional) Name of the current step. |
|
|
17167
17489
|
| <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. |
|
|
17490
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.BranchStepProps.property.explicitNextStep">explicitNextStep</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a></code> | (Optional) explicit step to go to after this step completes. |
|
|
17168
17491
|
| <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
17492
|
| <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.
|
|
17171
|
-
| <code><a href="#@cdklabs/cdk-ssm-documents.BranchStepProps.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.
|
|
17493
|
+
| <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. |
|
|
17494
|
+
| <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
17495
|
| <code><a href="#@cdklabs/cdk-ssm-documents.BranchStepProps.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</code> | (Optional) timeout seconds to run this step. |
|
|
17173
17496
|
| <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
17497
|
| <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. |
|
|
@@ -17230,6 +17553,21 @@ public readonly outputObserver: IObserver;
|
|
|
17230
17553
|
|
|
17231
17554
|
---
|
|
17232
17555
|
|
|
17556
|
+
##### `explicitNextStep`<sup>Optional</sup> <a name="explicitNextStep" id="@cdklabs/cdk-ssm-documents.BranchStepProps.property.explicitNextStep"></a>
|
|
17557
|
+
|
|
17558
|
+
```typescript
|
|
17559
|
+
public readonly explicitNextStep: StepRef;
|
|
17560
|
+
```
|
|
17561
|
+
|
|
17562
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a>
|
|
17563
|
+
- *Default:* will implicitly choose the next step in the sequence that the steps are added to the document.
|
|
17564
|
+
|
|
17565
|
+
(Optional) explicit step to go to after this step completes.
|
|
17566
|
+
|
|
17567
|
+
https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-actions.html#nextProp
|
|
17568
|
+
|
|
17569
|
+
---
|
|
17570
|
+
|
|
17233
17571
|
##### `isEnd`<sup>Optional</sup> <a name="isEnd" id="@cdklabs/cdk-ssm-documents.BranchStepProps.property.isEnd"></a>
|
|
17234
17572
|
|
|
17235
17573
|
```typescript
|
|
@@ -17259,26 +17597,26 @@ public readonly maxAttempts: number;
|
|
|
17259
17597
|
##### `onCancel`<sup>Optional</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.BranchStepProps.property.onCancel"></a>
|
|
17260
17598
|
|
|
17261
17599
|
```typescript
|
|
17262
|
-
public readonly onCancel:
|
|
17600
|
+
public readonly onCancel: OnCancel;
|
|
17263
17601
|
```
|
|
17264
17602
|
|
|
17265
|
-
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.
|
|
17603
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a>
|
|
17266
17604
|
- *Default:* undefined
|
|
17267
17605
|
|
|
17268
|
-
(Optional)
|
|
17606
|
+
(Optional) Fallback action to take in the event that this step is cancelled.
|
|
17269
17607
|
|
|
17270
17608
|
---
|
|
17271
17609
|
|
|
17272
17610
|
##### `onFailure`<sup>Optional</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.BranchStepProps.property.onFailure"></a>
|
|
17273
17611
|
|
|
17274
17612
|
```typescript
|
|
17275
|
-
public readonly onFailure:
|
|
17613
|
+
public readonly onFailure: OnFailure;
|
|
17276
17614
|
```
|
|
17277
17615
|
|
|
17278
|
-
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.
|
|
17616
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a>
|
|
17279
17617
|
- *Default:* undefined
|
|
17280
17618
|
|
|
17281
|
-
(Optional)
|
|
17619
|
+
(Optional) Fallback action to take in the event that this step fails.
|
|
17282
17620
|
|
|
17283
17621
|
---
|
|
17284
17622
|
|
|
@@ -17344,10 +17682,11 @@ const changeInstanceStateSimulationProps: ChangeInstanceStateSimulationProps = {
|
|
|
17344
17682
|
| <code><a href="#@cdklabs/cdk-ssm-documents.ChangeInstanceStateSimulationProps.property.inputObserver">inputObserver</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.IObserver">IObserver</a></code> | (Optional) Allows for observing the input to steps as they run. |
|
|
17345
17683
|
| <code><a href="#@cdklabs/cdk-ssm-documents.ChangeInstanceStateSimulationProps.property.name">name</a></code> | <code>string</code> | (Optional) Name of the current step. |
|
|
17346
17684
|
| <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. |
|
|
17685
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.ChangeInstanceStateSimulationProps.property.explicitNextStep">explicitNextStep</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a></code> | (Optional) explicit step to go to after this step completes. |
|
|
17347
17686
|
| <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
17687
|
| <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.
|
|
17350
|
-
| <code><a href="#@cdklabs/cdk-ssm-documents.ChangeInstanceStateSimulationProps.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.
|
|
17688
|
+
| <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. |
|
|
17689
|
+
| <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
17690
|
| <code><a href="#@cdklabs/cdk-ssm-documents.ChangeInstanceStateSimulationProps.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</code> | (Optional) timeout seconds to run this step. |
|
|
17352
17691
|
| <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
17692
|
|
|
@@ -17408,6 +17747,21 @@ public readonly outputObserver: IObserver;
|
|
|
17408
17747
|
|
|
17409
17748
|
---
|
|
17410
17749
|
|
|
17750
|
+
##### `explicitNextStep`<sup>Optional</sup> <a name="explicitNextStep" id="@cdklabs/cdk-ssm-documents.ChangeInstanceStateSimulationProps.property.explicitNextStep"></a>
|
|
17751
|
+
|
|
17752
|
+
```typescript
|
|
17753
|
+
public readonly explicitNextStep: StepRef;
|
|
17754
|
+
```
|
|
17755
|
+
|
|
17756
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a>
|
|
17757
|
+
- *Default:* will implicitly choose the next step in the sequence that the steps are added to the document.
|
|
17758
|
+
|
|
17759
|
+
(Optional) explicit step to go to after this step completes.
|
|
17760
|
+
|
|
17761
|
+
https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-actions.html#nextProp
|
|
17762
|
+
|
|
17763
|
+
---
|
|
17764
|
+
|
|
17411
17765
|
##### `isEnd`<sup>Optional</sup> <a name="isEnd" id="@cdklabs/cdk-ssm-documents.ChangeInstanceStateSimulationProps.property.isEnd"></a>
|
|
17412
17766
|
|
|
17413
17767
|
```typescript
|
|
@@ -17437,26 +17791,26 @@ public readonly maxAttempts: number;
|
|
|
17437
17791
|
##### `onCancel`<sup>Optional</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.ChangeInstanceStateSimulationProps.property.onCancel"></a>
|
|
17438
17792
|
|
|
17439
17793
|
```typescript
|
|
17440
|
-
public readonly onCancel:
|
|
17794
|
+
public readonly onCancel: OnCancel;
|
|
17441
17795
|
```
|
|
17442
17796
|
|
|
17443
|
-
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.
|
|
17797
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a>
|
|
17444
17798
|
- *Default:* undefined
|
|
17445
17799
|
|
|
17446
|
-
(Optional)
|
|
17800
|
+
(Optional) Fallback action to take in the event that this step is cancelled.
|
|
17447
17801
|
|
|
17448
17802
|
---
|
|
17449
17803
|
|
|
17450
17804
|
##### `onFailure`<sup>Optional</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.ChangeInstanceStateSimulationProps.property.onFailure"></a>
|
|
17451
17805
|
|
|
17452
17806
|
```typescript
|
|
17453
|
-
public readonly onFailure:
|
|
17807
|
+
public readonly onFailure: OnFailure;
|
|
17454
17808
|
```
|
|
17455
17809
|
|
|
17456
|
-
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.
|
|
17810
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a>
|
|
17457
17811
|
- *Default:* undefined
|
|
17458
17812
|
|
|
17459
|
-
(Optional)
|
|
17813
|
+
(Optional) Fallback action to take in the event that this step fails.
|
|
17460
17814
|
|
|
17461
17815
|
---
|
|
17462
17816
|
|
|
@@ -17508,10 +17862,11 @@ const changeInstanceStateStepProps: ChangeInstanceStateStepProps = { ... }
|
|
|
17508
17862
|
| <code><a href="#@cdklabs/cdk-ssm-documents.ChangeInstanceStateStepProps.property.inputObserver">inputObserver</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.IObserver">IObserver</a></code> | (Optional) Allows for observing the input to steps as they run. |
|
|
17509
17863
|
| <code><a href="#@cdklabs/cdk-ssm-documents.ChangeInstanceStateStepProps.property.name">name</a></code> | <code>string</code> | (Optional) Name of the current step. |
|
|
17510
17864
|
| <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. |
|
|
17865
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.ChangeInstanceStateStepProps.property.explicitNextStep">explicitNextStep</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a></code> | (Optional) explicit step to go to after this step completes. |
|
|
17511
17866
|
| <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
17867
|
| <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.
|
|
17514
|
-
| <code><a href="#@cdklabs/cdk-ssm-documents.ChangeInstanceStateStepProps.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.
|
|
17868
|
+
| <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. |
|
|
17869
|
+
| <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
17870
|
| <code><a href="#@cdklabs/cdk-ssm-documents.ChangeInstanceStateStepProps.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</code> | (Optional) timeout seconds to run this step. |
|
|
17516
17871
|
| <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
17872
|
| <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. |
|
|
@@ -17576,6 +17931,21 @@ public readonly outputObserver: IObserver;
|
|
|
17576
17931
|
|
|
17577
17932
|
---
|
|
17578
17933
|
|
|
17934
|
+
##### `explicitNextStep`<sup>Optional</sup> <a name="explicitNextStep" id="@cdklabs/cdk-ssm-documents.ChangeInstanceStateStepProps.property.explicitNextStep"></a>
|
|
17935
|
+
|
|
17936
|
+
```typescript
|
|
17937
|
+
public readonly explicitNextStep: StepRef;
|
|
17938
|
+
```
|
|
17939
|
+
|
|
17940
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a>
|
|
17941
|
+
- *Default:* will implicitly choose the next step in the sequence that the steps are added to the document.
|
|
17942
|
+
|
|
17943
|
+
(Optional) explicit step to go to after this step completes.
|
|
17944
|
+
|
|
17945
|
+
https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-actions.html#nextProp
|
|
17946
|
+
|
|
17947
|
+
---
|
|
17948
|
+
|
|
17579
17949
|
##### `isEnd`<sup>Optional</sup> <a name="isEnd" id="@cdklabs/cdk-ssm-documents.ChangeInstanceStateStepProps.property.isEnd"></a>
|
|
17580
17950
|
|
|
17581
17951
|
```typescript
|
|
@@ -17605,26 +17975,26 @@ public readonly maxAttempts: number;
|
|
|
17605
17975
|
##### `onCancel`<sup>Optional</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.ChangeInstanceStateStepProps.property.onCancel"></a>
|
|
17606
17976
|
|
|
17607
17977
|
```typescript
|
|
17608
|
-
public readonly onCancel:
|
|
17978
|
+
public readonly onCancel: OnCancel;
|
|
17609
17979
|
```
|
|
17610
17980
|
|
|
17611
|
-
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.
|
|
17981
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a>
|
|
17612
17982
|
- *Default:* undefined
|
|
17613
17983
|
|
|
17614
|
-
(Optional)
|
|
17984
|
+
(Optional) Fallback action to take in the event that this step is cancelled.
|
|
17615
17985
|
|
|
17616
17986
|
---
|
|
17617
17987
|
|
|
17618
17988
|
##### `onFailure`<sup>Optional</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.ChangeInstanceStateStepProps.property.onFailure"></a>
|
|
17619
17989
|
|
|
17620
17990
|
```typescript
|
|
17621
|
-
public readonly onFailure:
|
|
17991
|
+
public readonly onFailure: OnFailure;
|
|
17622
17992
|
```
|
|
17623
17993
|
|
|
17624
|
-
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.
|
|
17994
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a>
|
|
17625
17995
|
- *Default:* undefined
|
|
17626
17996
|
|
|
17627
|
-
(Optional)
|
|
17997
|
+
(Optional) Fallback action to take in the event that this step fails.
|
|
17628
17998
|
|
|
17629
17999
|
---
|
|
17630
18000
|
|
|
@@ -18616,10 +18986,11 @@ const copyImageStepProps: CopyImageStepProps = { ... }
|
|
|
18616
18986
|
| <code><a href="#@cdklabs/cdk-ssm-documents.CopyImageStepProps.property.inputObserver">inputObserver</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.IObserver">IObserver</a></code> | (Optional) Allows for observing the input to steps as they run. |
|
|
18617
18987
|
| <code><a href="#@cdklabs/cdk-ssm-documents.CopyImageStepProps.property.name">name</a></code> | <code>string</code> | (Optional) Name of the current step. |
|
|
18618
18988
|
| <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. |
|
|
18989
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.CopyImageStepProps.property.explicitNextStep">explicitNextStep</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a></code> | (Optional) explicit step to go to after this step completes. |
|
|
18619
18990
|
| <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
18991
|
| <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.
|
|
18622
|
-
| <code><a href="#@cdklabs/cdk-ssm-documents.CopyImageStepProps.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.
|
|
18992
|
+
| <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. |
|
|
18993
|
+
| <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
18994
|
| <code><a href="#@cdklabs/cdk-ssm-documents.CopyImageStepProps.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</code> | (Optional) timeout seconds to run this step. |
|
|
18624
18995
|
| <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
18996
|
| <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. |
|
|
@@ -18686,6 +19057,21 @@ public readonly outputObserver: IObserver;
|
|
|
18686
19057
|
|
|
18687
19058
|
---
|
|
18688
19059
|
|
|
19060
|
+
##### `explicitNextStep`<sup>Optional</sup> <a name="explicitNextStep" id="@cdklabs/cdk-ssm-documents.CopyImageStepProps.property.explicitNextStep"></a>
|
|
19061
|
+
|
|
19062
|
+
```typescript
|
|
19063
|
+
public readonly explicitNextStep: StepRef;
|
|
19064
|
+
```
|
|
19065
|
+
|
|
19066
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a>
|
|
19067
|
+
- *Default:* will implicitly choose the next step in the sequence that the steps are added to the document.
|
|
19068
|
+
|
|
19069
|
+
(Optional) explicit step to go to after this step completes.
|
|
19070
|
+
|
|
19071
|
+
https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-actions.html#nextProp
|
|
19072
|
+
|
|
19073
|
+
---
|
|
19074
|
+
|
|
18689
19075
|
##### `isEnd`<sup>Optional</sup> <a name="isEnd" id="@cdklabs/cdk-ssm-documents.CopyImageStepProps.property.isEnd"></a>
|
|
18690
19076
|
|
|
18691
19077
|
```typescript
|
|
@@ -18715,26 +19101,26 @@ public readonly maxAttempts: number;
|
|
|
18715
19101
|
##### `onCancel`<sup>Optional</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.CopyImageStepProps.property.onCancel"></a>
|
|
18716
19102
|
|
|
18717
19103
|
```typescript
|
|
18718
|
-
public readonly onCancel:
|
|
19104
|
+
public readonly onCancel: OnCancel;
|
|
18719
19105
|
```
|
|
18720
19106
|
|
|
18721
|
-
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.
|
|
19107
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a>
|
|
18722
19108
|
- *Default:* undefined
|
|
18723
19109
|
|
|
18724
|
-
(Optional)
|
|
19110
|
+
(Optional) Fallback action to take in the event that this step is cancelled.
|
|
18725
19111
|
|
|
18726
19112
|
---
|
|
18727
19113
|
|
|
18728
19114
|
##### `onFailure`<sup>Optional</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.CopyImageStepProps.property.onFailure"></a>
|
|
18729
19115
|
|
|
18730
19116
|
```typescript
|
|
18731
|
-
public readonly onFailure:
|
|
19117
|
+
public readonly onFailure: OnFailure;
|
|
18732
19118
|
```
|
|
18733
19119
|
|
|
18734
|
-
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.
|
|
19120
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a>
|
|
18735
19121
|
- *Default:* undefined
|
|
18736
19122
|
|
|
18737
|
-
(Optional)
|
|
19123
|
+
(Optional) Fallback action to take in the event that this step fails.
|
|
18738
19124
|
|
|
18739
19125
|
---
|
|
18740
19126
|
|
|
@@ -18857,10 +19243,11 @@ const createImageStepProps: CreateImageStepProps = { ... }
|
|
|
18857
19243
|
| <code><a href="#@cdklabs/cdk-ssm-documents.CreateImageStepProps.property.inputObserver">inputObserver</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.IObserver">IObserver</a></code> | (Optional) Allows for observing the input to steps as they run. |
|
|
18858
19244
|
| <code><a href="#@cdklabs/cdk-ssm-documents.CreateImageStepProps.property.name">name</a></code> | <code>string</code> | (Optional) Name of the current step. |
|
|
18859
19245
|
| <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. |
|
|
19246
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.CreateImageStepProps.property.explicitNextStep">explicitNextStep</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a></code> | (Optional) explicit step to go to after this step completes. |
|
|
18860
19247
|
| <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
19248
|
| <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.
|
|
18863
|
-
| <code><a href="#@cdklabs/cdk-ssm-documents.CreateImageStepProps.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.
|
|
19249
|
+
| <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. |
|
|
19250
|
+
| <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
19251
|
| <code><a href="#@cdklabs/cdk-ssm-documents.CreateImageStepProps.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</code> | (Optional) timeout seconds to run this step. |
|
|
18865
19252
|
| <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
19253
|
| <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. |
|
|
@@ -18925,6 +19312,21 @@ public readonly outputObserver: IObserver;
|
|
|
18925
19312
|
|
|
18926
19313
|
---
|
|
18927
19314
|
|
|
19315
|
+
##### `explicitNextStep`<sup>Optional</sup> <a name="explicitNextStep" id="@cdklabs/cdk-ssm-documents.CreateImageStepProps.property.explicitNextStep"></a>
|
|
19316
|
+
|
|
19317
|
+
```typescript
|
|
19318
|
+
public readonly explicitNextStep: StepRef;
|
|
19319
|
+
```
|
|
19320
|
+
|
|
19321
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a>
|
|
19322
|
+
- *Default:* will implicitly choose the next step in the sequence that the steps are added to the document.
|
|
19323
|
+
|
|
19324
|
+
(Optional) explicit step to go to after this step completes.
|
|
19325
|
+
|
|
19326
|
+
https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-actions.html#nextProp
|
|
19327
|
+
|
|
19328
|
+
---
|
|
19329
|
+
|
|
18928
19330
|
##### `isEnd`<sup>Optional</sup> <a name="isEnd" id="@cdklabs/cdk-ssm-documents.CreateImageStepProps.property.isEnd"></a>
|
|
18929
19331
|
|
|
18930
19332
|
```typescript
|
|
@@ -18954,26 +19356,26 @@ public readonly maxAttempts: number;
|
|
|
18954
19356
|
##### `onCancel`<sup>Optional</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.CreateImageStepProps.property.onCancel"></a>
|
|
18955
19357
|
|
|
18956
19358
|
```typescript
|
|
18957
|
-
public readonly onCancel:
|
|
19359
|
+
public readonly onCancel: OnCancel;
|
|
18958
19360
|
```
|
|
18959
19361
|
|
|
18960
|
-
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.
|
|
19362
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a>
|
|
18961
19363
|
- *Default:* undefined
|
|
18962
19364
|
|
|
18963
|
-
(Optional)
|
|
19365
|
+
(Optional) Fallback action to take in the event that this step is cancelled.
|
|
18964
19366
|
|
|
18965
19367
|
---
|
|
18966
19368
|
|
|
18967
19369
|
##### `onFailure`<sup>Optional</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.CreateImageStepProps.property.onFailure"></a>
|
|
18968
19370
|
|
|
18969
19371
|
```typescript
|
|
18970
|
-
public readonly onFailure:
|
|
19372
|
+
public readonly onFailure: OnFailure;
|
|
18971
19373
|
```
|
|
18972
19374
|
|
|
18973
|
-
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.
|
|
19375
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a>
|
|
18974
19376
|
- *Default:* undefined
|
|
18975
19377
|
|
|
18976
|
-
(Optional)
|
|
19378
|
+
(Optional) Fallback action to take in the event that this step fails.
|
|
18977
19379
|
|
|
18978
19380
|
---
|
|
18979
19381
|
|
|
@@ -19140,10 +19542,11 @@ const createStackStepProps: CreateStackStepProps = { ... }
|
|
|
19140
19542
|
| <code><a href="#@cdklabs/cdk-ssm-documents.CreateStackStepProps.property.inputObserver">inputObserver</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.IObserver">IObserver</a></code> | (Optional) Allows for observing the input to steps as they run. |
|
|
19141
19543
|
| <code><a href="#@cdklabs/cdk-ssm-documents.CreateStackStepProps.property.name">name</a></code> | <code>string</code> | (Optional) Name of the current step. |
|
|
19142
19544
|
| <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. |
|
|
19545
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.CreateStackStepProps.property.explicitNextStep">explicitNextStep</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a></code> | (Optional) explicit step to go to after this step completes. |
|
|
19143
19546
|
| <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
19547
|
| <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.
|
|
19146
|
-
| <code><a href="#@cdklabs/cdk-ssm-documents.CreateStackStepProps.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.
|
|
19548
|
+
| <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. |
|
|
19549
|
+
| <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
19550
|
| <code><a href="#@cdklabs/cdk-ssm-documents.CreateStackStepProps.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</code> | (Optional) timeout seconds to run this step. |
|
|
19148
19551
|
| <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
19552
|
| <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. |
|
|
@@ -19215,6 +19618,21 @@ public readonly outputObserver: IObserver;
|
|
|
19215
19618
|
|
|
19216
19619
|
---
|
|
19217
19620
|
|
|
19621
|
+
##### `explicitNextStep`<sup>Optional</sup> <a name="explicitNextStep" id="@cdklabs/cdk-ssm-documents.CreateStackStepProps.property.explicitNextStep"></a>
|
|
19622
|
+
|
|
19623
|
+
```typescript
|
|
19624
|
+
public readonly explicitNextStep: StepRef;
|
|
19625
|
+
```
|
|
19626
|
+
|
|
19627
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a>
|
|
19628
|
+
- *Default:* will implicitly choose the next step in the sequence that the steps are added to the document.
|
|
19629
|
+
|
|
19630
|
+
(Optional) explicit step to go to after this step completes.
|
|
19631
|
+
|
|
19632
|
+
https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-actions.html#nextProp
|
|
19633
|
+
|
|
19634
|
+
---
|
|
19635
|
+
|
|
19218
19636
|
##### `isEnd`<sup>Optional</sup> <a name="isEnd" id="@cdklabs/cdk-ssm-documents.CreateStackStepProps.property.isEnd"></a>
|
|
19219
19637
|
|
|
19220
19638
|
```typescript
|
|
@@ -19244,26 +19662,26 @@ public readonly maxAttempts: number;
|
|
|
19244
19662
|
##### `onCancel`<sup>Optional</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.CreateStackStepProps.property.onCancel"></a>
|
|
19245
19663
|
|
|
19246
19664
|
```typescript
|
|
19247
|
-
public readonly onCancel:
|
|
19665
|
+
public readonly onCancel: OnCancel;
|
|
19248
19666
|
```
|
|
19249
19667
|
|
|
19250
|
-
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.
|
|
19668
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a>
|
|
19251
19669
|
- *Default:* undefined
|
|
19252
19670
|
|
|
19253
|
-
(Optional)
|
|
19671
|
+
(Optional) Fallback action to take in the event that this step is cancelled.
|
|
19254
19672
|
|
|
19255
19673
|
---
|
|
19256
19674
|
|
|
19257
19675
|
##### `onFailure`<sup>Optional</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.CreateStackStepProps.property.onFailure"></a>
|
|
19258
19676
|
|
|
19259
19677
|
```typescript
|
|
19260
|
-
public readonly onFailure:
|
|
19678
|
+
public readonly onFailure: OnFailure;
|
|
19261
19679
|
```
|
|
19262
19680
|
|
|
19263
|
-
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.
|
|
19681
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a>
|
|
19264
19682
|
- *Default:* undefined
|
|
19265
19683
|
|
|
19266
|
-
(Optional)
|
|
19684
|
+
(Optional) Fallback action to take in the event that this step fails.
|
|
19267
19685
|
|
|
19268
19686
|
---
|
|
19269
19687
|
|
|
@@ -19527,10 +19945,11 @@ const createTagsStepProps: CreateTagsStepProps = { ... }
|
|
|
19527
19945
|
| <code><a href="#@cdklabs/cdk-ssm-documents.CreateTagsStepProps.property.inputObserver">inputObserver</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.IObserver">IObserver</a></code> | (Optional) Allows for observing the input to steps as they run. |
|
|
19528
19946
|
| <code><a href="#@cdklabs/cdk-ssm-documents.CreateTagsStepProps.property.name">name</a></code> | <code>string</code> | (Optional) Name of the current step. |
|
|
19529
19947
|
| <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. |
|
|
19948
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.CreateTagsStepProps.property.explicitNextStep">explicitNextStep</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a></code> | (Optional) explicit step to go to after this step completes. |
|
|
19530
19949
|
| <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
19950
|
| <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.
|
|
19533
|
-
| <code><a href="#@cdklabs/cdk-ssm-documents.CreateTagsStepProps.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.
|
|
19951
|
+
| <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. |
|
|
19952
|
+
| <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
19953
|
| <code><a href="#@cdklabs/cdk-ssm-documents.CreateTagsStepProps.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</code> | (Optional) timeout seconds to run this step. |
|
|
19535
19954
|
| <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
19955
|
| <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). |
|
|
@@ -19593,6 +20012,21 @@ public readonly outputObserver: IObserver;
|
|
|
19593
20012
|
|
|
19594
20013
|
---
|
|
19595
20014
|
|
|
20015
|
+
##### `explicitNextStep`<sup>Optional</sup> <a name="explicitNextStep" id="@cdklabs/cdk-ssm-documents.CreateTagsStepProps.property.explicitNextStep"></a>
|
|
20016
|
+
|
|
20017
|
+
```typescript
|
|
20018
|
+
public readonly explicitNextStep: StepRef;
|
|
20019
|
+
```
|
|
20020
|
+
|
|
20021
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a>
|
|
20022
|
+
- *Default:* will implicitly choose the next step in the sequence that the steps are added to the document.
|
|
20023
|
+
|
|
20024
|
+
(Optional) explicit step to go to after this step completes.
|
|
20025
|
+
|
|
20026
|
+
https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-actions.html#nextProp
|
|
20027
|
+
|
|
20028
|
+
---
|
|
20029
|
+
|
|
19596
20030
|
##### `isEnd`<sup>Optional</sup> <a name="isEnd" id="@cdklabs/cdk-ssm-documents.CreateTagsStepProps.property.isEnd"></a>
|
|
19597
20031
|
|
|
19598
20032
|
```typescript
|
|
@@ -19622,26 +20056,26 @@ public readonly maxAttempts: number;
|
|
|
19622
20056
|
##### `onCancel`<sup>Optional</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.CreateTagsStepProps.property.onCancel"></a>
|
|
19623
20057
|
|
|
19624
20058
|
```typescript
|
|
19625
|
-
public readonly onCancel:
|
|
20059
|
+
public readonly onCancel: OnCancel;
|
|
19626
20060
|
```
|
|
19627
20061
|
|
|
19628
|
-
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.
|
|
20062
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a>
|
|
19629
20063
|
- *Default:* undefined
|
|
19630
20064
|
|
|
19631
|
-
(Optional)
|
|
20065
|
+
(Optional) Fallback action to take in the event that this step is cancelled.
|
|
19632
20066
|
|
|
19633
20067
|
---
|
|
19634
20068
|
|
|
19635
20069
|
##### `onFailure`<sup>Optional</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.CreateTagsStepProps.property.onFailure"></a>
|
|
19636
20070
|
|
|
19637
20071
|
```typescript
|
|
19638
|
-
public readonly onFailure:
|
|
20072
|
+
public readonly onFailure: OnFailure;
|
|
19639
20073
|
```
|
|
19640
20074
|
|
|
19641
|
-
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.
|
|
20075
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a>
|
|
19642
20076
|
- *Default:* undefined
|
|
19643
20077
|
|
|
19644
|
-
(Optional)
|
|
20078
|
+
(Optional) Fallback action to take in the event that this step fails.
|
|
19645
20079
|
|
|
19646
20080
|
---
|
|
19647
20081
|
|
|
@@ -19770,10 +20204,11 @@ const deleteImageStepProps: DeleteImageStepProps = { ... }
|
|
|
19770
20204
|
| <code><a href="#@cdklabs/cdk-ssm-documents.DeleteImageStepProps.property.inputObserver">inputObserver</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.IObserver">IObserver</a></code> | (Optional) Allows for observing the input to steps as they run. |
|
|
19771
20205
|
| <code><a href="#@cdklabs/cdk-ssm-documents.DeleteImageStepProps.property.name">name</a></code> | <code>string</code> | (Optional) Name of the current step. |
|
|
19772
20206
|
| <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. |
|
|
20207
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.DeleteImageStepProps.property.explicitNextStep">explicitNextStep</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a></code> | (Optional) explicit step to go to after this step completes. |
|
|
19773
20208
|
| <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
20209
|
| <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.
|
|
19776
|
-
| <code><a href="#@cdklabs/cdk-ssm-documents.DeleteImageStepProps.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.
|
|
20210
|
+
| <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. |
|
|
20211
|
+
| <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
20212
|
| <code><a href="#@cdklabs/cdk-ssm-documents.DeleteImageStepProps.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</code> | (Optional) timeout seconds to run this step. |
|
|
19778
20213
|
| <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
20214
|
|
|
@@ -19834,6 +20269,21 @@ public readonly outputObserver: IObserver;
|
|
|
19834
20269
|
|
|
19835
20270
|
---
|
|
19836
20271
|
|
|
20272
|
+
##### `explicitNextStep`<sup>Optional</sup> <a name="explicitNextStep" id="@cdklabs/cdk-ssm-documents.DeleteImageStepProps.property.explicitNextStep"></a>
|
|
20273
|
+
|
|
20274
|
+
```typescript
|
|
20275
|
+
public readonly explicitNextStep: StepRef;
|
|
20276
|
+
```
|
|
20277
|
+
|
|
20278
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a>
|
|
20279
|
+
- *Default:* will implicitly choose the next step in the sequence that the steps are added to the document.
|
|
20280
|
+
|
|
20281
|
+
(Optional) explicit step to go to after this step completes.
|
|
20282
|
+
|
|
20283
|
+
https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-actions.html#nextProp
|
|
20284
|
+
|
|
20285
|
+
---
|
|
20286
|
+
|
|
19837
20287
|
##### `isEnd`<sup>Optional</sup> <a name="isEnd" id="@cdklabs/cdk-ssm-documents.DeleteImageStepProps.property.isEnd"></a>
|
|
19838
20288
|
|
|
19839
20289
|
```typescript
|
|
@@ -19863,26 +20313,26 @@ public readonly maxAttempts: number;
|
|
|
19863
20313
|
##### `onCancel`<sup>Optional</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.DeleteImageStepProps.property.onCancel"></a>
|
|
19864
20314
|
|
|
19865
20315
|
```typescript
|
|
19866
|
-
public readonly onCancel:
|
|
20316
|
+
public readonly onCancel: OnCancel;
|
|
19867
20317
|
```
|
|
19868
20318
|
|
|
19869
|
-
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.
|
|
20319
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a>
|
|
19870
20320
|
- *Default:* undefined
|
|
19871
20321
|
|
|
19872
|
-
(Optional)
|
|
20322
|
+
(Optional) Fallback action to take in the event that this step is cancelled.
|
|
19873
20323
|
|
|
19874
20324
|
---
|
|
19875
20325
|
|
|
19876
20326
|
##### `onFailure`<sup>Optional</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.DeleteImageStepProps.property.onFailure"></a>
|
|
19877
20327
|
|
|
19878
20328
|
```typescript
|
|
19879
|
-
public readonly onFailure:
|
|
20329
|
+
public readonly onFailure: OnFailure;
|
|
19880
20330
|
```
|
|
19881
20331
|
|
|
19882
|
-
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.
|
|
20332
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a>
|
|
19883
20333
|
- *Default:* undefined
|
|
19884
20334
|
|
|
19885
|
-
(Optional)
|
|
20335
|
+
(Optional) Fallback action to take in the event that this step fails.
|
|
19886
20336
|
|
|
19887
20337
|
---
|
|
19888
20338
|
|
|
@@ -19933,10 +20383,11 @@ const deleteStackStepProps: DeleteStackStepProps = { ... }
|
|
|
19933
20383
|
| <code><a href="#@cdklabs/cdk-ssm-documents.DeleteStackStepProps.property.inputObserver">inputObserver</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.IObserver">IObserver</a></code> | (Optional) Allows for observing the input to steps as they run. |
|
|
19934
20384
|
| <code><a href="#@cdklabs/cdk-ssm-documents.DeleteStackStepProps.property.name">name</a></code> | <code>string</code> | (Optional) Name of the current step. |
|
|
19935
20385
|
| <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. |
|
|
20386
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.DeleteStackStepProps.property.explicitNextStep">explicitNextStep</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a></code> | (Optional) explicit step to go to after this step completes. |
|
|
19936
20387
|
| <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
20388
|
| <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.
|
|
19939
|
-
| <code><a href="#@cdklabs/cdk-ssm-documents.DeleteStackStepProps.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.
|
|
20389
|
+
| <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. |
|
|
20390
|
+
| <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
20391
|
| <code><a href="#@cdklabs/cdk-ssm-documents.DeleteStackStepProps.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</code> | (Optional) timeout seconds to run this step. |
|
|
19941
20392
|
| <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
20393
|
| <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. |
|
|
@@ -19998,6 +20449,21 @@ public readonly outputObserver: IObserver;
|
|
|
19998
20449
|
|
|
19999
20450
|
---
|
|
20000
20451
|
|
|
20452
|
+
##### `explicitNextStep`<sup>Optional</sup> <a name="explicitNextStep" id="@cdklabs/cdk-ssm-documents.DeleteStackStepProps.property.explicitNextStep"></a>
|
|
20453
|
+
|
|
20454
|
+
```typescript
|
|
20455
|
+
public readonly explicitNextStep: StepRef;
|
|
20456
|
+
```
|
|
20457
|
+
|
|
20458
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a>
|
|
20459
|
+
- *Default:* will implicitly choose the next step in the sequence that the steps are added to the document.
|
|
20460
|
+
|
|
20461
|
+
(Optional) explicit step to go to after this step completes.
|
|
20462
|
+
|
|
20463
|
+
https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-actions.html#nextProp
|
|
20464
|
+
|
|
20465
|
+
---
|
|
20466
|
+
|
|
20001
20467
|
##### `isEnd`<sup>Optional</sup> <a name="isEnd" id="@cdklabs/cdk-ssm-documents.DeleteStackStepProps.property.isEnd"></a>
|
|
20002
20468
|
|
|
20003
20469
|
```typescript
|
|
@@ -20027,26 +20493,26 @@ public readonly maxAttempts: number;
|
|
|
20027
20493
|
##### `onCancel`<sup>Optional</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.DeleteStackStepProps.property.onCancel"></a>
|
|
20028
20494
|
|
|
20029
20495
|
```typescript
|
|
20030
|
-
public readonly onCancel:
|
|
20496
|
+
public readonly onCancel: OnCancel;
|
|
20031
20497
|
```
|
|
20032
20498
|
|
|
20033
|
-
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.
|
|
20499
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a>
|
|
20034
20500
|
- *Default:* undefined
|
|
20035
20501
|
|
|
20036
|
-
(Optional)
|
|
20502
|
+
(Optional) Fallback action to take in the event that this step is cancelled.
|
|
20037
20503
|
|
|
20038
20504
|
---
|
|
20039
20505
|
|
|
20040
20506
|
##### `onFailure`<sup>Optional</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.DeleteStackStepProps.property.onFailure"></a>
|
|
20041
20507
|
|
|
20042
20508
|
```typescript
|
|
20043
|
-
public readonly onFailure:
|
|
20509
|
+
public readonly onFailure: OnFailure;
|
|
20044
20510
|
```
|
|
20045
20511
|
|
|
20046
|
-
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.
|
|
20512
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a>
|
|
20047
20513
|
- *Default:* undefined
|
|
20048
20514
|
|
|
20049
|
-
(Optional)
|
|
20515
|
+
(Optional) Fallback action to take in the event that this step fails.
|
|
20050
20516
|
|
|
20051
20517
|
---
|
|
20052
20518
|
|
|
@@ -20911,10 +21377,11 @@ const executeAutomationStepProps: ExecuteAutomationStepProps = { ... }
|
|
|
20911
21377
|
| <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteAutomationStepProps.property.inputObserver">inputObserver</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.IObserver">IObserver</a></code> | (Optional) Allows for observing the input to steps as they run. |
|
|
20912
21378
|
| <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteAutomationStepProps.property.name">name</a></code> | <code>string</code> | (Optional) Name of the current step. |
|
|
20913
21379
|
| <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. |
|
|
21380
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteAutomationStepProps.property.explicitNextStep">explicitNextStep</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a></code> | (Optional) explicit step to go to after this step completes. |
|
|
20914
21381
|
| <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
21382
|
| <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.
|
|
20917
|
-
| <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteAutomationStepProps.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.
|
|
21383
|
+
| <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. |
|
|
21384
|
+
| <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
21385
|
| <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteAutomationStepProps.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</code> | (Optional) timeout seconds to run this step. |
|
|
20919
21386
|
| <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
21387
|
| <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.* |
|
|
@@ -20984,6 +21451,21 @@ public readonly outputObserver: IObserver;
|
|
|
20984
21451
|
|
|
20985
21452
|
---
|
|
20986
21453
|
|
|
21454
|
+
##### `explicitNextStep`<sup>Optional</sup> <a name="explicitNextStep" id="@cdklabs/cdk-ssm-documents.ExecuteAutomationStepProps.property.explicitNextStep"></a>
|
|
21455
|
+
|
|
21456
|
+
```typescript
|
|
21457
|
+
public readonly explicitNextStep: StepRef;
|
|
21458
|
+
```
|
|
21459
|
+
|
|
21460
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a>
|
|
21461
|
+
- *Default:* will implicitly choose the next step in the sequence that the steps are added to the document.
|
|
21462
|
+
|
|
21463
|
+
(Optional) explicit step to go to after this step completes.
|
|
21464
|
+
|
|
21465
|
+
https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-actions.html#nextProp
|
|
21466
|
+
|
|
21467
|
+
---
|
|
21468
|
+
|
|
20987
21469
|
##### `isEnd`<sup>Optional</sup> <a name="isEnd" id="@cdklabs/cdk-ssm-documents.ExecuteAutomationStepProps.property.isEnd"></a>
|
|
20988
21470
|
|
|
20989
21471
|
```typescript
|
|
@@ -21013,26 +21495,26 @@ public readonly maxAttempts: number;
|
|
|
21013
21495
|
##### `onCancel`<sup>Optional</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.ExecuteAutomationStepProps.property.onCancel"></a>
|
|
21014
21496
|
|
|
21015
21497
|
```typescript
|
|
21016
|
-
public readonly onCancel:
|
|
21498
|
+
public readonly onCancel: OnCancel;
|
|
21017
21499
|
```
|
|
21018
21500
|
|
|
21019
|
-
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.
|
|
21501
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a>
|
|
21020
21502
|
- *Default:* undefined
|
|
21021
21503
|
|
|
21022
|
-
(Optional)
|
|
21504
|
+
(Optional) Fallback action to take in the event that this step is cancelled.
|
|
21023
21505
|
|
|
21024
21506
|
---
|
|
21025
21507
|
|
|
21026
21508
|
##### `onFailure`<sup>Optional</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.ExecuteAutomationStepProps.property.onFailure"></a>
|
|
21027
21509
|
|
|
21028
21510
|
```typescript
|
|
21029
|
-
public readonly onFailure:
|
|
21511
|
+
public readonly onFailure: OnFailure;
|
|
21030
21512
|
```
|
|
21031
21513
|
|
|
21032
|
-
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.
|
|
21514
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a>
|
|
21033
21515
|
- *Default:* undefined
|
|
21034
21516
|
|
|
21035
|
-
(Optional)
|
|
21517
|
+
(Optional) Fallback action to take in the event that this step fails.
|
|
21036
21518
|
|
|
21037
21519
|
---
|
|
21038
21520
|
|
|
@@ -21171,10 +21653,11 @@ const executeScriptStepProps: ExecuteScriptStepProps = { ... }
|
|
|
21171
21653
|
| <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteScriptStepProps.property.inputObserver">inputObserver</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.IObserver">IObserver</a></code> | (Optional) Allows for observing the input to steps as they run. |
|
|
21172
21654
|
| <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteScriptStepProps.property.name">name</a></code> | <code>string</code> | (Optional) Name of the current step. |
|
|
21173
21655
|
| <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. |
|
|
21656
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteScriptStepProps.property.explicitNextStep">explicitNextStep</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a></code> | (Optional) explicit step to go to after this step completes. |
|
|
21174
21657
|
| <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
21658
|
| <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.
|
|
21177
|
-
| <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteScriptStepProps.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.
|
|
21659
|
+
| <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. |
|
|
21660
|
+
| <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
21661
|
| <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteScriptStepProps.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</code> | (Optional) timeout seconds to run this step. |
|
|
21179
21662
|
| <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
21663
|
| <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. |
|
|
@@ -21240,6 +21723,21 @@ public readonly outputObserver: IObserver;
|
|
|
21240
21723
|
|
|
21241
21724
|
---
|
|
21242
21725
|
|
|
21726
|
+
##### `explicitNextStep`<sup>Optional</sup> <a name="explicitNextStep" id="@cdklabs/cdk-ssm-documents.ExecuteScriptStepProps.property.explicitNextStep"></a>
|
|
21727
|
+
|
|
21728
|
+
```typescript
|
|
21729
|
+
public readonly explicitNextStep: StepRef;
|
|
21730
|
+
```
|
|
21731
|
+
|
|
21732
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a>
|
|
21733
|
+
- *Default:* will implicitly choose the next step in the sequence that the steps are added to the document.
|
|
21734
|
+
|
|
21735
|
+
(Optional) explicit step to go to after this step completes.
|
|
21736
|
+
|
|
21737
|
+
https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-actions.html#nextProp
|
|
21738
|
+
|
|
21739
|
+
---
|
|
21740
|
+
|
|
21243
21741
|
##### `isEnd`<sup>Optional</sup> <a name="isEnd" id="@cdklabs/cdk-ssm-documents.ExecuteScriptStepProps.property.isEnd"></a>
|
|
21244
21742
|
|
|
21245
21743
|
```typescript
|
|
@@ -21269,26 +21767,26 @@ public readonly maxAttempts: number;
|
|
|
21269
21767
|
##### `onCancel`<sup>Optional</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.ExecuteScriptStepProps.property.onCancel"></a>
|
|
21270
21768
|
|
|
21271
21769
|
```typescript
|
|
21272
|
-
public readonly onCancel:
|
|
21770
|
+
public readonly onCancel: OnCancel;
|
|
21273
21771
|
```
|
|
21274
21772
|
|
|
21275
|
-
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.
|
|
21773
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a>
|
|
21276
21774
|
- *Default:* undefined
|
|
21277
21775
|
|
|
21278
|
-
(Optional)
|
|
21776
|
+
(Optional) Fallback action to take in the event that this step is cancelled.
|
|
21279
21777
|
|
|
21280
21778
|
---
|
|
21281
21779
|
|
|
21282
21780
|
##### `onFailure`<sup>Optional</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.ExecuteScriptStepProps.property.onFailure"></a>
|
|
21283
21781
|
|
|
21284
21782
|
```typescript
|
|
21285
|
-
public readonly onFailure:
|
|
21783
|
+
public readonly onFailure: OnFailure;
|
|
21286
21784
|
```
|
|
21287
21785
|
|
|
21288
|
-
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.
|
|
21786
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a>
|
|
21289
21787
|
- *Default:* undefined
|
|
21290
21788
|
|
|
21291
|
-
(Optional)
|
|
21789
|
+
(Optional) Fallback action to take in the event that this step fails.
|
|
21292
21790
|
|
|
21293
21791
|
---
|
|
21294
21792
|
|
|
@@ -21412,10 +21910,11 @@ const executeStateMachineStepProps: ExecuteStateMachineStepProps = { ... }
|
|
|
21412
21910
|
| <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteStateMachineStepProps.property.inputObserver">inputObserver</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.IObserver">IObserver</a></code> | (Optional) Allows for observing the input to steps as they run. |
|
|
21413
21911
|
| <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteStateMachineStepProps.property.name">name</a></code> | <code>string</code> | (Optional) Name of the current step. |
|
|
21414
21912
|
| <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. |
|
|
21913
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteStateMachineStepProps.property.explicitNextStep">explicitNextStep</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a></code> | (Optional) explicit step to go to after this step completes. |
|
|
21415
21914
|
| <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
21915
|
| <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.
|
|
21418
|
-
| <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteStateMachineStepProps.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.
|
|
21916
|
+
| <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. |
|
|
21917
|
+
| <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
21918
|
| <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteStateMachineStepProps.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</code> | (Optional) timeout seconds to run this step. |
|
|
21420
21919
|
| <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
21920
|
| <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. |
|
|
@@ -21478,6 +21977,21 @@ public readonly outputObserver: IObserver;
|
|
|
21478
21977
|
|
|
21479
21978
|
---
|
|
21480
21979
|
|
|
21980
|
+
##### `explicitNextStep`<sup>Optional</sup> <a name="explicitNextStep" id="@cdklabs/cdk-ssm-documents.ExecuteStateMachineStepProps.property.explicitNextStep"></a>
|
|
21981
|
+
|
|
21982
|
+
```typescript
|
|
21983
|
+
public readonly explicitNextStep: StepRef;
|
|
21984
|
+
```
|
|
21985
|
+
|
|
21986
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a>
|
|
21987
|
+
- *Default:* will implicitly choose the next step in the sequence that the steps are added to the document.
|
|
21988
|
+
|
|
21989
|
+
(Optional) explicit step to go to after this step completes.
|
|
21990
|
+
|
|
21991
|
+
https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-actions.html#nextProp
|
|
21992
|
+
|
|
21993
|
+
---
|
|
21994
|
+
|
|
21481
21995
|
##### `isEnd`<sup>Optional</sup> <a name="isEnd" id="@cdklabs/cdk-ssm-documents.ExecuteStateMachineStepProps.property.isEnd"></a>
|
|
21482
21996
|
|
|
21483
21997
|
```typescript
|
|
@@ -21507,26 +22021,26 @@ public readonly maxAttempts: number;
|
|
|
21507
22021
|
##### `onCancel`<sup>Optional</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.ExecuteStateMachineStepProps.property.onCancel"></a>
|
|
21508
22022
|
|
|
21509
22023
|
```typescript
|
|
21510
|
-
public readonly onCancel:
|
|
22024
|
+
public readonly onCancel: OnCancel;
|
|
21511
22025
|
```
|
|
21512
22026
|
|
|
21513
|
-
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.
|
|
22027
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a>
|
|
21514
22028
|
- *Default:* undefined
|
|
21515
22029
|
|
|
21516
|
-
(Optional)
|
|
22030
|
+
(Optional) Fallback action to take in the event that this step is cancelled.
|
|
21517
22031
|
|
|
21518
22032
|
---
|
|
21519
22033
|
|
|
21520
22034
|
##### `onFailure`<sup>Optional</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.ExecuteStateMachineStepProps.property.onFailure"></a>
|
|
21521
22035
|
|
|
21522
22036
|
```typescript
|
|
21523
|
-
public readonly onFailure:
|
|
22037
|
+
public readonly onFailure: OnFailure;
|
|
21524
22038
|
```
|
|
21525
22039
|
|
|
21526
|
-
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.
|
|
22040
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a>
|
|
21527
22041
|
- *Default:* undefined
|
|
21528
22042
|
|
|
21529
|
-
(Optional)
|
|
22043
|
+
(Optional) Fallback action to take in the event that this step fails.
|
|
21530
22044
|
|
|
21531
22045
|
---
|
|
21532
22046
|
|
|
@@ -22200,10 +22714,11 @@ const invokeLambdaFunctionStepProps: InvokeLambdaFunctionStepProps = { ... }
|
|
|
22200
22714
|
| <code><a href="#@cdklabs/cdk-ssm-documents.InvokeLambdaFunctionStepProps.property.inputObserver">inputObserver</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.IObserver">IObserver</a></code> | (Optional) Allows for observing the input to steps as they run. |
|
|
22201
22715
|
| <code><a href="#@cdklabs/cdk-ssm-documents.InvokeLambdaFunctionStepProps.property.name">name</a></code> | <code>string</code> | (Optional) Name of the current step. |
|
|
22202
22716
|
| <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. |
|
|
22717
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.InvokeLambdaFunctionStepProps.property.explicitNextStep">explicitNextStep</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a></code> | (Optional) explicit step to go to after this step completes. |
|
|
22203
22718
|
| <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
22719
|
| <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.
|
|
22206
|
-
| <code><a href="#@cdklabs/cdk-ssm-documents.InvokeLambdaFunctionStepProps.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.
|
|
22720
|
+
| <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. |
|
|
22721
|
+
| <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
22722
|
| <code><a href="#@cdklabs/cdk-ssm-documents.InvokeLambdaFunctionStepProps.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</code> | (Optional) timeout seconds to run this step. |
|
|
22208
22723
|
| <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
22724
|
| <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. |
|
|
@@ -22269,6 +22784,21 @@ public readonly outputObserver: IObserver;
|
|
|
22269
22784
|
|
|
22270
22785
|
---
|
|
22271
22786
|
|
|
22787
|
+
##### `explicitNextStep`<sup>Optional</sup> <a name="explicitNextStep" id="@cdklabs/cdk-ssm-documents.InvokeLambdaFunctionStepProps.property.explicitNextStep"></a>
|
|
22788
|
+
|
|
22789
|
+
```typescript
|
|
22790
|
+
public readonly explicitNextStep: StepRef;
|
|
22791
|
+
```
|
|
22792
|
+
|
|
22793
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a>
|
|
22794
|
+
- *Default:* will implicitly choose the next step in the sequence that the steps are added to the document.
|
|
22795
|
+
|
|
22796
|
+
(Optional) explicit step to go to after this step completes.
|
|
22797
|
+
|
|
22798
|
+
https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-actions.html#nextProp
|
|
22799
|
+
|
|
22800
|
+
---
|
|
22801
|
+
|
|
22272
22802
|
##### `isEnd`<sup>Optional</sup> <a name="isEnd" id="@cdklabs/cdk-ssm-documents.InvokeLambdaFunctionStepProps.property.isEnd"></a>
|
|
22273
22803
|
|
|
22274
22804
|
```typescript
|
|
@@ -22298,26 +22828,26 @@ public readonly maxAttempts: number;
|
|
|
22298
22828
|
##### `onCancel`<sup>Optional</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.InvokeLambdaFunctionStepProps.property.onCancel"></a>
|
|
22299
22829
|
|
|
22300
22830
|
```typescript
|
|
22301
|
-
public readonly onCancel:
|
|
22831
|
+
public readonly onCancel: OnCancel;
|
|
22302
22832
|
```
|
|
22303
22833
|
|
|
22304
|
-
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.
|
|
22834
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a>
|
|
22305
22835
|
- *Default:* undefined
|
|
22306
22836
|
|
|
22307
|
-
(Optional)
|
|
22837
|
+
(Optional) Fallback action to take in the event that this step is cancelled.
|
|
22308
22838
|
|
|
22309
22839
|
---
|
|
22310
22840
|
|
|
22311
22841
|
##### `onFailure`<sup>Optional</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.InvokeLambdaFunctionStepProps.property.onFailure"></a>
|
|
22312
22842
|
|
|
22313
22843
|
```typescript
|
|
22314
|
-
public readonly onFailure:
|
|
22844
|
+
public readonly onFailure: OnFailure;
|
|
22315
22845
|
```
|
|
22316
22846
|
|
|
22317
|
-
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.
|
|
22847
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a>
|
|
22318
22848
|
- *Default:* undefined
|
|
22319
22849
|
|
|
22320
|
-
(Optional)
|
|
22850
|
+
(Optional) Fallback action to take in the event that this step fails.
|
|
22321
22851
|
|
|
22322
22852
|
---
|
|
22323
22853
|
|
|
@@ -22559,10 +23089,11 @@ const invokeWebhookStepProps: InvokeWebhookStepProps = { ... }
|
|
|
22559
23089
|
| <code><a href="#@cdklabs/cdk-ssm-documents.InvokeWebhookStepProps.property.inputObserver">inputObserver</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.IObserver">IObserver</a></code> | (Optional) Allows for observing the input to steps as they run. |
|
|
22560
23090
|
| <code><a href="#@cdklabs/cdk-ssm-documents.InvokeWebhookStepProps.property.name">name</a></code> | <code>string</code> | (Optional) Name of the current step. |
|
|
22561
23091
|
| <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. |
|
|
23092
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.InvokeWebhookStepProps.property.explicitNextStep">explicitNextStep</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a></code> | (Optional) explicit step to go to after this step completes. |
|
|
22562
23093
|
| <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
23094
|
| <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.
|
|
22565
|
-
| <code><a href="#@cdklabs/cdk-ssm-documents.InvokeWebhookStepProps.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.
|
|
23095
|
+
| <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. |
|
|
23096
|
+
| <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
23097
|
| <code><a href="#@cdklabs/cdk-ssm-documents.InvokeWebhookStepProps.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</code> | (Optional) timeout seconds to run this step. |
|
|
22567
23098
|
| <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
23099
|
| <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. |
|
|
@@ -22624,6 +23155,21 @@ public readonly outputObserver: IObserver;
|
|
|
22624
23155
|
|
|
22625
23156
|
---
|
|
22626
23157
|
|
|
23158
|
+
##### `explicitNextStep`<sup>Optional</sup> <a name="explicitNextStep" id="@cdklabs/cdk-ssm-documents.InvokeWebhookStepProps.property.explicitNextStep"></a>
|
|
23159
|
+
|
|
23160
|
+
```typescript
|
|
23161
|
+
public readonly explicitNextStep: StepRef;
|
|
23162
|
+
```
|
|
23163
|
+
|
|
23164
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a>
|
|
23165
|
+
- *Default:* will implicitly choose the next step in the sequence that the steps are added to the document.
|
|
23166
|
+
|
|
23167
|
+
(Optional) explicit step to go to after this step completes.
|
|
23168
|
+
|
|
23169
|
+
https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-actions.html#nextProp
|
|
23170
|
+
|
|
23171
|
+
---
|
|
23172
|
+
|
|
22627
23173
|
##### `isEnd`<sup>Optional</sup> <a name="isEnd" id="@cdklabs/cdk-ssm-documents.InvokeWebhookStepProps.property.isEnd"></a>
|
|
22628
23174
|
|
|
22629
23175
|
```typescript
|
|
@@ -22653,26 +23199,26 @@ public readonly maxAttempts: number;
|
|
|
22653
23199
|
##### `onCancel`<sup>Optional</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.InvokeWebhookStepProps.property.onCancel"></a>
|
|
22654
23200
|
|
|
22655
23201
|
```typescript
|
|
22656
|
-
public readonly onCancel:
|
|
23202
|
+
public readonly onCancel: OnCancel;
|
|
22657
23203
|
```
|
|
22658
23204
|
|
|
22659
|
-
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.
|
|
23205
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a>
|
|
22660
23206
|
- *Default:* undefined
|
|
22661
23207
|
|
|
22662
|
-
(Optional)
|
|
23208
|
+
(Optional) Fallback action to take in the event that this step is cancelled.
|
|
22663
23209
|
|
|
22664
23210
|
---
|
|
22665
23211
|
|
|
22666
23212
|
##### `onFailure`<sup>Optional</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.InvokeWebhookStepProps.property.onFailure"></a>
|
|
22667
23213
|
|
|
22668
23214
|
```typescript
|
|
22669
|
-
public readonly onFailure:
|
|
23215
|
+
public readonly onFailure: OnFailure;
|
|
22670
23216
|
```
|
|
22671
23217
|
|
|
22672
|
-
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.
|
|
23218
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a>
|
|
22673
23219
|
- *Default:* undefined
|
|
22674
23220
|
|
|
22675
|
-
(Optional)
|
|
23221
|
+
(Optional) Fallback action to take in the event that this step fails.
|
|
22676
23222
|
|
|
22677
23223
|
---
|
|
22678
23224
|
|
|
@@ -23695,10 +24241,11 @@ const runCommandStepProps: RunCommandStepProps = { ... }
|
|
|
23695
24241
|
| <code><a href="#@cdklabs/cdk-ssm-documents.RunCommandStepProps.property.inputObserver">inputObserver</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.IObserver">IObserver</a></code> | (Optional) Allows for observing the input to steps as they run. |
|
|
23696
24242
|
| <code><a href="#@cdklabs/cdk-ssm-documents.RunCommandStepProps.property.name">name</a></code> | <code>string</code> | (Optional) Name of the current step. |
|
|
23697
24243
|
| <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. |
|
|
24244
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.RunCommandStepProps.property.explicitNextStep">explicitNextStep</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a></code> | (Optional) explicit step to go to after this step completes. |
|
|
23698
24245
|
| <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
24246
|
| <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.
|
|
23701
|
-
| <code><a href="#@cdklabs/cdk-ssm-documents.RunCommandStepProps.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.
|
|
24247
|
+
| <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. |
|
|
24248
|
+
| <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
24249
|
| <code><a href="#@cdklabs/cdk-ssm-documents.RunCommandStepProps.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</code> | (Optional) timeout seconds to run this step. |
|
|
23703
24250
|
| <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
24251
|
| <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. |
|
|
@@ -23772,6 +24319,21 @@ public readonly outputObserver: IObserver;
|
|
|
23772
24319
|
|
|
23773
24320
|
---
|
|
23774
24321
|
|
|
24322
|
+
##### `explicitNextStep`<sup>Optional</sup> <a name="explicitNextStep" id="@cdklabs/cdk-ssm-documents.RunCommandStepProps.property.explicitNextStep"></a>
|
|
24323
|
+
|
|
24324
|
+
```typescript
|
|
24325
|
+
public readonly explicitNextStep: StepRef;
|
|
24326
|
+
```
|
|
24327
|
+
|
|
24328
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a>
|
|
24329
|
+
- *Default:* will implicitly choose the next step in the sequence that the steps are added to the document.
|
|
24330
|
+
|
|
24331
|
+
(Optional) explicit step to go to after this step completes.
|
|
24332
|
+
|
|
24333
|
+
https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-actions.html#nextProp
|
|
24334
|
+
|
|
24335
|
+
---
|
|
24336
|
+
|
|
23775
24337
|
##### `isEnd`<sup>Optional</sup> <a name="isEnd" id="@cdklabs/cdk-ssm-documents.RunCommandStepProps.property.isEnd"></a>
|
|
23776
24338
|
|
|
23777
24339
|
```typescript
|
|
@@ -23801,26 +24363,26 @@ public readonly maxAttempts: number;
|
|
|
23801
24363
|
##### `onCancel`<sup>Optional</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.RunCommandStepProps.property.onCancel"></a>
|
|
23802
24364
|
|
|
23803
24365
|
```typescript
|
|
23804
|
-
public readonly onCancel:
|
|
24366
|
+
public readonly onCancel: OnCancel;
|
|
23805
24367
|
```
|
|
23806
24368
|
|
|
23807
|
-
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.
|
|
24369
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a>
|
|
23808
24370
|
- *Default:* undefined
|
|
23809
24371
|
|
|
23810
|
-
(Optional)
|
|
24372
|
+
(Optional) Fallback action to take in the event that this step is cancelled.
|
|
23811
24373
|
|
|
23812
24374
|
---
|
|
23813
24375
|
|
|
23814
24376
|
##### `onFailure`<sup>Optional</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.RunCommandStepProps.property.onFailure"></a>
|
|
23815
24377
|
|
|
23816
24378
|
```typescript
|
|
23817
|
-
public readonly onFailure:
|
|
24379
|
+
public readonly onFailure: OnFailure;
|
|
23818
24380
|
```
|
|
23819
24381
|
|
|
23820
|
-
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.
|
|
24382
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a>
|
|
23821
24383
|
- *Default:* undefined
|
|
23822
24384
|
|
|
23823
|
-
(Optional)
|
|
24385
|
+
(Optional) Fallback action to take in the event that this step fails.
|
|
23824
24386
|
|
|
23825
24387
|
---
|
|
23826
24388
|
|
|
@@ -24497,10 +25059,11 @@ const runInstanceStepProps: RunInstanceStepProps = { ... }
|
|
|
24497
25059
|
| <code><a href="#@cdklabs/cdk-ssm-documents.RunInstanceStepProps.property.inputObserver">inputObserver</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.IObserver">IObserver</a></code> | (Optional) Allows for observing the input to steps as they run. |
|
|
24498
25060
|
| <code><a href="#@cdklabs/cdk-ssm-documents.RunInstanceStepProps.property.name">name</a></code> | <code>string</code> | (Optional) Name of the current step. |
|
|
24499
25061
|
| <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. |
|
|
25062
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.RunInstanceStepProps.property.explicitNextStep">explicitNextStep</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a></code> | (Optional) explicit step to go to after this step completes. |
|
|
24500
25063
|
| <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
25064
|
| <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.
|
|
24503
|
-
| <code><a href="#@cdklabs/cdk-ssm-documents.RunInstanceStepProps.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.
|
|
25065
|
+
| <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. |
|
|
25066
|
+
| <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
25067
|
| <code><a href="#@cdklabs/cdk-ssm-documents.RunInstanceStepProps.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</code> | (Optional) timeout seconds to run this step. |
|
|
24505
25068
|
| <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
25069
|
| <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. |
|
|
@@ -24584,6 +25147,21 @@ public readonly outputObserver: IObserver;
|
|
|
24584
25147
|
|
|
24585
25148
|
---
|
|
24586
25149
|
|
|
25150
|
+
##### `explicitNextStep`<sup>Optional</sup> <a name="explicitNextStep" id="@cdklabs/cdk-ssm-documents.RunInstanceStepProps.property.explicitNextStep"></a>
|
|
25151
|
+
|
|
25152
|
+
```typescript
|
|
25153
|
+
public readonly explicitNextStep: StepRef;
|
|
25154
|
+
```
|
|
25155
|
+
|
|
25156
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a>
|
|
25157
|
+
- *Default:* will implicitly choose the next step in the sequence that the steps are added to the document.
|
|
25158
|
+
|
|
25159
|
+
(Optional) explicit step to go to after this step completes.
|
|
25160
|
+
|
|
25161
|
+
https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-actions.html#nextProp
|
|
25162
|
+
|
|
25163
|
+
---
|
|
25164
|
+
|
|
24587
25165
|
##### `isEnd`<sup>Optional</sup> <a name="isEnd" id="@cdklabs/cdk-ssm-documents.RunInstanceStepProps.property.isEnd"></a>
|
|
24588
25166
|
|
|
24589
25167
|
```typescript
|
|
@@ -24613,26 +25191,26 @@ public readonly maxAttempts: number;
|
|
|
24613
25191
|
##### `onCancel`<sup>Optional</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.RunInstanceStepProps.property.onCancel"></a>
|
|
24614
25192
|
|
|
24615
25193
|
```typescript
|
|
24616
|
-
public readonly onCancel:
|
|
25194
|
+
public readonly onCancel: OnCancel;
|
|
24617
25195
|
```
|
|
24618
25196
|
|
|
24619
|
-
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.
|
|
25197
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a>
|
|
24620
25198
|
- *Default:* undefined
|
|
24621
25199
|
|
|
24622
|
-
(Optional)
|
|
25200
|
+
(Optional) Fallback action to take in the event that this step is cancelled.
|
|
24623
25201
|
|
|
24624
25202
|
---
|
|
24625
25203
|
|
|
24626
25204
|
##### `onFailure`<sup>Optional</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.RunInstanceStepProps.property.onFailure"></a>
|
|
24627
25205
|
|
|
24628
25206
|
```typescript
|
|
24629
|
-
public readonly onFailure:
|
|
25207
|
+
public readonly onFailure: OnFailure;
|
|
24630
25208
|
```
|
|
24631
25209
|
|
|
24632
|
-
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.
|
|
25210
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a>
|
|
24633
25211
|
- *Default:* undefined
|
|
24634
25212
|
|
|
24635
|
-
(Optional)
|
|
25213
|
+
(Optional) Fallback action to take in the event that this step fails.
|
|
24636
25214
|
|
|
24637
25215
|
---
|
|
24638
25216
|
|
|
@@ -25652,10 +26230,11 @@ const sleepStepProps: SleepStepProps = { ... }
|
|
|
25652
26230
|
| <code><a href="#@cdklabs/cdk-ssm-documents.SleepStepProps.property.inputObserver">inputObserver</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.IObserver">IObserver</a></code> | (Optional) Allows for observing the input to steps as they run. |
|
|
25653
26231
|
| <code><a href="#@cdklabs/cdk-ssm-documents.SleepStepProps.property.name">name</a></code> | <code>string</code> | (Optional) Name of the current step. |
|
|
25654
26232
|
| <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. |
|
|
26233
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.SleepStepProps.property.explicitNextStep">explicitNextStep</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a></code> | (Optional) explicit step to go to after this step completes. |
|
|
25655
26234
|
| <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
26235
|
| <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.
|
|
25658
|
-
| <code><a href="#@cdklabs/cdk-ssm-documents.SleepStepProps.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.
|
|
26236
|
+
| <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. |
|
|
26237
|
+
| <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
26238
|
| <code><a href="#@cdklabs/cdk-ssm-documents.SleepStepProps.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</code> | (Optional) timeout seconds to run this step. |
|
|
25660
26239
|
| <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
26240
|
|
|
@@ -25716,6 +26295,21 @@ public readonly outputObserver: IObserver;
|
|
|
25716
26295
|
|
|
25717
26296
|
---
|
|
25718
26297
|
|
|
26298
|
+
##### `explicitNextStep`<sup>Optional</sup> <a name="explicitNextStep" id="@cdklabs/cdk-ssm-documents.SleepStepProps.property.explicitNextStep"></a>
|
|
26299
|
+
|
|
26300
|
+
```typescript
|
|
26301
|
+
public readonly explicitNextStep: StepRef;
|
|
26302
|
+
```
|
|
26303
|
+
|
|
26304
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a>
|
|
26305
|
+
- *Default:* will implicitly choose the next step in the sequence that the steps are added to the document.
|
|
26306
|
+
|
|
26307
|
+
(Optional) explicit step to go to after this step completes.
|
|
26308
|
+
|
|
26309
|
+
https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-actions.html#nextProp
|
|
26310
|
+
|
|
26311
|
+
---
|
|
26312
|
+
|
|
25719
26313
|
##### `isEnd`<sup>Optional</sup> <a name="isEnd" id="@cdklabs/cdk-ssm-documents.SleepStepProps.property.isEnd"></a>
|
|
25720
26314
|
|
|
25721
26315
|
```typescript
|
|
@@ -25745,26 +26339,26 @@ public readonly maxAttempts: number;
|
|
|
25745
26339
|
##### `onCancel`<sup>Optional</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.SleepStepProps.property.onCancel"></a>
|
|
25746
26340
|
|
|
25747
26341
|
```typescript
|
|
25748
|
-
public readonly onCancel:
|
|
26342
|
+
public readonly onCancel: OnCancel;
|
|
25749
26343
|
```
|
|
25750
26344
|
|
|
25751
|
-
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.
|
|
26345
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a>
|
|
25752
26346
|
- *Default:* undefined
|
|
25753
26347
|
|
|
25754
|
-
(Optional)
|
|
26348
|
+
(Optional) Fallback action to take in the event that this step is cancelled.
|
|
25755
26349
|
|
|
25756
26350
|
---
|
|
25757
26351
|
|
|
25758
26352
|
##### `onFailure`<sup>Optional</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.SleepStepProps.property.onFailure"></a>
|
|
25759
26353
|
|
|
25760
26354
|
```typescript
|
|
25761
|
-
public readonly onFailure:
|
|
26355
|
+
public readonly onFailure: OnFailure;
|
|
25762
26356
|
```
|
|
25763
26357
|
|
|
25764
|
-
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.
|
|
26358
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a>
|
|
25765
26359
|
- *Default:* undefined
|
|
25766
26360
|
|
|
25767
|
-
(Optional)
|
|
26361
|
+
(Optional) Fallback action to take in the event that this step fails.
|
|
25768
26362
|
|
|
25769
26363
|
---
|
|
25770
26364
|
|
|
@@ -27200,10 +27794,11 @@ const waitForResourceStepProps: WaitForResourceStepProps = { ... }
|
|
|
27200
27794
|
| <code><a href="#@cdklabs/cdk-ssm-documents.WaitForResourceStepProps.property.inputObserver">inputObserver</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.IObserver">IObserver</a></code> | (Optional) Allows for observing the input to steps as they run. |
|
|
27201
27795
|
| <code><a href="#@cdklabs/cdk-ssm-documents.WaitForResourceStepProps.property.name">name</a></code> | <code>string</code> | (Optional) Name of the current step. |
|
|
27202
27796
|
| <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. |
|
|
27797
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.WaitForResourceStepProps.property.explicitNextStep">explicitNextStep</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a></code> | (Optional) explicit step to go to after this step completes. |
|
|
27203
27798
|
| <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
27799
|
| <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.
|
|
27206
|
-
| <code><a href="#@cdklabs/cdk-ssm-documents.WaitForResourceStepProps.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.
|
|
27800
|
+
| <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. |
|
|
27801
|
+
| <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
27802
|
| <code><a href="#@cdklabs/cdk-ssm-documents.WaitForResourceStepProps.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</code> | (Optional) timeout seconds to run this step. |
|
|
27208
27803
|
| <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
27804
|
| <code><a href="#@cdklabs/cdk-ssm-documents.WaitForResourceStepProps.property.pascalCaseApi">pascalCaseApi</a></code> | <code>string</code> | (Required) The AWS api represented in PascalCase. |
|
|
@@ -27270,6 +27865,21 @@ public readonly outputObserver: IObserver;
|
|
|
27270
27865
|
|
|
27271
27866
|
---
|
|
27272
27867
|
|
|
27868
|
+
##### `explicitNextStep`<sup>Optional</sup> <a name="explicitNextStep" id="@cdklabs/cdk-ssm-documents.WaitForResourceStepProps.property.explicitNextStep"></a>
|
|
27869
|
+
|
|
27870
|
+
```typescript
|
|
27871
|
+
public readonly explicitNextStep: StepRef;
|
|
27872
|
+
```
|
|
27873
|
+
|
|
27874
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a>
|
|
27875
|
+
- *Default:* will implicitly choose the next step in the sequence that the steps are added to the document.
|
|
27876
|
+
|
|
27877
|
+
(Optional) explicit step to go to after this step completes.
|
|
27878
|
+
|
|
27879
|
+
https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-actions.html#nextProp
|
|
27880
|
+
|
|
27881
|
+
---
|
|
27882
|
+
|
|
27273
27883
|
##### `isEnd`<sup>Optional</sup> <a name="isEnd" id="@cdklabs/cdk-ssm-documents.WaitForResourceStepProps.property.isEnd"></a>
|
|
27274
27884
|
|
|
27275
27885
|
```typescript
|
|
@@ -27299,26 +27909,26 @@ public readonly maxAttempts: number;
|
|
|
27299
27909
|
##### `onCancel`<sup>Optional</sup> <a name="onCancel" id="@cdklabs/cdk-ssm-documents.WaitForResourceStepProps.property.onCancel"></a>
|
|
27300
27910
|
|
|
27301
27911
|
```typescript
|
|
27302
|
-
public readonly onCancel:
|
|
27912
|
+
public readonly onCancel: OnCancel;
|
|
27303
27913
|
```
|
|
27304
27914
|
|
|
27305
|
-
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.
|
|
27915
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a>
|
|
27306
27916
|
- *Default:* undefined
|
|
27307
27917
|
|
|
27308
|
-
(Optional)
|
|
27918
|
+
(Optional) Fallback action to take in the event that this step is cancelled.
|
|
27309
27919
|
|
|
27310
27920
|
---
|
|
27311
27921
|
|
|
27312
27922
|
##### `onFailure`<sup>Optional</sup> <a name="onFailure" id="@cdklabs/cdk-ssm-documents.WaitForResourceStepProps.property.onFailure"></a>
|
|
27313
27923
|
|
|
27314
27924
|
```typescript
|
|
27315
|
-
public readonly onFailure:
|
|
27925
|
+
public readonly onFailure: OnFailure;
|
|
27316
27926
|
```
|
|
27317
27927
|
|
|
27318
|
-
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.
|
|
27928
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a>
|
|
27319
27929
|
- *Default:* undefined
|
|
27320
27930
|
|
|
27321
|
-
(Optional)
|
|
27931
|
+
(Optional) Fallback action to take in the event that this step fails.
|
|
27322
27932
|
|
|
27323
27933
|
---
|
|
27324
27934
|
|
|
@@ -27464,6 +28074,121 @@ This is not used by SSM and is therefore not declared in the SSM yaml/json.
|
|
|
27464
28074
|
|
|
27465
28075
|
## Classes <a name="Classes" id="Classes"></a>
|
|
27466
28076
|
|
|
28077
|
+
### Abort <a name="Abort" id="@cdklabs/cdk-ssm-documents.Abort"></a>
|
|
28078
|
+
|
|
28079
|
+
#### Initializers <a name="Initializers" id="@cdklabs/cdk-ssm-documents.Abort.Initializer"></a>
|
|
28080
|
+
|
|
28081
|
+
```typescript
|
|
28082
|
+
import { Abort } from '@cdklabs/cdk-ssm-documents'
|
|
28083
|
+
|
|
28084
|
+
new Abort()
|
|
28085
|
+
```
|
|
28086
|
+
|
|
28087
|
+
| **Name** | **Type** | **Description** |
|
|
28088
|
+
| --- | --- | --- |
|
|
28089
|
+
|
|
28090
|
+
---
|
|
28091
|
+
|
|
28092
|
+
#### Methods <a name="Methods" id="Methods"></a>
|
|
28093
|
+
|
|
28094
|
+
| **Name** | **Description** |
|
|
28095
|
+
| --- | --- |
|
|
28096
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.Abort.stepToInvoke">stepToInvoke</a></code> | *No description.* |
|
|
28097
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.Abort.toSsmValue">toSsmValue</a></code> | *No description.* |
|
|
28098
|
+
|
|
28099
|
+
---
|
|
28100
|
+
|
|
28101
|
+
##### `stepToInvoke` <a name="stepToInvoke" id="@cdklabs/cdk-ssm-documents.Abort.stepToInvoke"></a>
|
|
28102
|
+
|
|
28103
|
+
```typescript
|
|
28104
|
+
public stepToInvoke(_currentStep: AutomationStep): string
|
|
28105
|
+
```
|
|
28106
|
+
|
|
28107
|
+
###### `_currentStep`<sup>Required</sup> <a name="_currentStep" id="@cdklabs/cdk-ssm-documents.Abort.stepToInvoke.parameter._currentStep"></a>
|
|
28108
|
+
|
|
28109
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
|
|
28110
|
+
|
|
28111
|
+
---
|
|
28112
|
+
|
|
28113
|
+
##### `toSsmValue` <a name="toSsmValue" id="@cdklabs/cdk-ssm-documents.Abort.toSsmValue"></a>
|
|
28114
|
+
|
|
28115
|
+
```typescript
|
|
28116
|
+
public toSsmValue(): string
|
|
28117
|
+
```
|
|
28118
|
+
|
|
28119
|
+
#### Static Functions <a name="Static Functions" id="Static Functions"></a>
|
|
28120
|
+
|
|
28121
|
+
| **Name** | **Description** |
|
|
28122
|
+
| --- | --- |
|
|
28123
|
+
| <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. |
|
|
28124
|
+
| <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. |
|
|
28125
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.Abort.invokeStep">invokeStep</a></code> | Invoke a specific step. |
|
|
28126
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.Abort.invokeStepByName">invokeStepByName</a></code> | Invoke a specific step by the step name for the OnCancel action. |
|
|
28127
|
+
|
|
28128
|
+
---
|
|
28129
|
+
|
|
28130
|
+
##### `abort` <a name="abort" id="@cdklabs/cdk-ssm-documents.Abort.abort"></a>
|
|
28131
|
+
|
|
28132
|
+
```typescript
|
|
28133
|
+
import { Abort } from '@cdklabs/cdk-ssm-documents'
|
|
28134
|
+
|
|
28135
|
+
Abort.abort()
|
|
28136
|
+
```
|
|
28137
|
+
|
|
28138
|
+
To abort execution if a cancellation occurs during execution of the current step.
|
|
28139
|
+
|
|
28140
|
+
(This is the default behavior.)
|
|
28141
|
+
|
|
28142
|
+
##### `continue` <a name="continue" id="@cdklabs/cdk-ssm-documents.Abort.continue"></a>
|
|
28143
|
+
|
|
28144
|
+
```typescript
|
|
28145
|
+
import { Abort } from '@cdklabs/cdk-ssm-documents'
|
|
28146
|
+
|
|
28147
|
+
Abort.continue()
|
|
28148
|
+
```
|
|
28149
|
+
|
|
28150
|
+
To continue execution of the subsequent step if a failure occurs during execution of the current step.
|
|
28151
|
+
|
|
28152
|
+
##### `invokeStep` <a name="invokeStep" id="@cdklabs/cdk-ssm-documents.Abort.invokeStep"></a>
|
|
28153
|
+
|
|
28154
|
+
```typescript
|
|
28155
|
+
import { Abort } from '@cdklabs/cdk-ssm-documents'
|
|
28156
|
+
|
|
28157
|
+
Abort.invokeStep(step: AutomationStep)
|
|
28158
|
+
```
|
|
28159
|
+
|
|
28160
|
+
Invoke a specific step.
|
|
28161
|
+
|
|
28162
|
+
Provide the step object to execute for the onCancel action.
|
|
28163
|
+
If you don't have a handle to the step object, use the invokeStepByName function.
|
|
28164
|
+
Not all action types may be invoked during cancellation. See documentation referenced on this class.
|
|
28165
|
+
|
|
28166
|
+
###### `step`<sup>Required</sup> <a name="step" id="@cdklabs/cdk-ssm-documents.Abort.invokeStep.parameter.step"></a>
|
|
28167
|
+
|
|
28168
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
|
|
28169
|
+
|
|
28170
|
+
---
|
|
28171
|
+
|
|
28172
|
+
##### `invokeStepByName` <a name="invokeStepByName" id="@cdklabs/cdk-ssm-documents.Abort.invokeStepByName"></a>
|
|
28173
|
+
|
|
28174
|
+
```typescript
|
|
28175
|
+
import { Abort } from '@cdklabs/cdk-ssm-documents'
|
|
28176
|
+
|
|
28177
|
+
Abort.invokeStepByName(stepName: string)
|
|
28178
|
+
```
|
|
28179
|
+
|
|
28180
|
+
Invoke a specific step by the step name for the OnCancel action.
|
|
28181
|
+
|
|
28182
|
+
Not all action types may be invoked during cancellation. See documentation referenced on this class.
|
|
28183
|
+
|
|
28184
|
+
###### `stepName`<sup>Required</sup> <a name="stepName" id="@cdklabs/cdk-ssm-documents.Abort.invokeStepByName.parameter.stepName"></a>
|
|
28185
|
+
|
|
28186
|
+
- *Type:* string
|
|
28187
|
+
|
|
28188
|
+
---
|
|
28189
|
+
|
|
28190
|
+
|
|
28191
|
+
|
|
27467
28192
|
### ActionVariable <a name="ActionVariable" id="@cdklabs/cdk-ssm-documents.ActionVariable"></a>
|
|
27468
28193
|
|
|
27469
28194
|
- *Implements:* <a href="#@cdklabs/cdk-ssm-documents.IActionVariable">IActionVariable</a>
|
|
@@ -29242,6 +29967,118 @@ public readonly step: CommandStep;
|
|
|
29242
29967
|
---
|
|
29243
29968
|
|
|
29244
29969
|
|
|
29970
|
+
### Continue <a name="Continue" id="@cdklabs/cdk-ssm-documents.Continue"></a>
|
|
29971
|
+
|
|
29972
|
+
#### Initializers <a name="Initializers" id="@cdklabs/cdk-ssm-documents.Continue.Initializer"></a>
|
|
29973
|
+
|
|
29974
|
+
```typescript
|
|
29975
|
+
import { Continue } from '@cdklabs/cdk-ssm-documents'
|
|
29976
|
+
|
|
29977
|
+
new Continue()
|
|
29978
|
+
```
|
|
29979
|
+
|
|
29980
|
+
| **Name** | **Type** | **Description** |
|
|
29981
|
+
| --- | --- | --- |
|
|
29982
|
+
|
|
29983
|
+
---
|
|
29984
|
+
|
|
29985
|
+
#### Methods <a name="Methods" id="Methods"></a>
|
|
29986
|
+
|
|
29987
|
+
| **Name** | **Description** |
|
|
29988
|
+
| --- | --- |
|
|
29989
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.Continue.stepToInvoke">stepToInvoke</a></code> | *No description.* |
|
|
29990
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.Continue.toSsmValue">toSsmValue</a></code> | *No description.* |
|
|
29991
|
+
|
|
29992
|
+
---
|
|
29993
|
+
|
|
29994
|
+
##### `stepToInvoke` <a name="stepToInvoke" id="@cdklabs/cdk-ssm-documents.Continue.stepToInvoke"></a>
|
|
29995
|
+
|
|
29996
|
+
```typescript
|
|
29997
|
+
public stepToInvoke(currentStep: AutomationStep): string
|
|
29998
|
+
```
|
|
29999
|
+
|
|
30000
|
+
###### `currentStep`<sup>Required</sup> <a name="currentStep" id="@cdklabs/cdk-ssm-documents.Continue.stepToInvoke.parameter.currentStep"></a>
|
|
30001
|
+
|
|
30002
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
|
|
30003
|
+
|
|
30004
|
+
---
|
|
30005
|
+
|
|
30006
|
+
##### `toSsmValue` <a name="toSsmValue" id="@cdklabs/cdk-ssm-documents.Continue.toSsmValue"></a>
|
|
30007
|
+
|
|
30008
|
+
```typescript
|
|
30009
|
+
public toSsmValue(): string
|
|
30010
|
+
```
|
|
30011
|
+
|
|
30012
|
+
#### Static Functions <a name="Static Functions" id="Static Functions"></a>
|
|
30013
|
+
|
|
30014
|
+
| **Name** | **Description** |
|
|
30015
|
+
| --- | --- |
|
|
30016
|
+
| <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. |
|
|
30017
|
+
| <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. |
|
|
30018
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.Continue.invokeStep">invokeStep</a></code> | Invoke a specific step. |
|
|
30019
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.Continue.invokeStepByName">invokeStepByName</a></code> | Invoke a specific step by the step name for the OnFailure action. |
|
|
30020
|
+
|
|
30021
|
+
---
|
|
30022
|
+
|
|
30023
|
+
##### `abort` <a name="abort" id="@cdklabs/cdk-ssm-documents.Continue.abort"></a>
|
|
30024
|
+
|
|
30025
|
+
```typescript
|
|
30026
|
+
import { Continue } from '@cdklabs/cdk-ssm-documents'
|
|
30027
|
+
|
|
30028
|
+
Continue.abort()
|
|
30029
|
+
```
|
|
30030
|
+
|
|
30031
|
+
To abort execution if a failure occurs during execution of the current step.
|
|
30032
|
+
|
|
30033
|
+
(This is the default behavior.)
|
|
30034
|
+
|
|
30035
|
+
##### `continue` <a name="continue" id="@cdklabs/cdk-ssm-documents.Continue.continue"></a>
|
|
30036
|
+
|
|
30037
|
+
```typescript
|
|
30038
|
+
import { Continue } from '@cdklabs/cdk-ssm-documents'
|
|
30039
|
+
|
|
30040
|
+
Continue.continue()
|
|
30041
|
+
```
|
|
30042
|
+
|
|
30043
|
+
To continue execution of the subsequent step if a failure occurs during execution of the current step.
|
|
30044
|
+
|
|
30045
|
+
##### `invokeStep` <a name="invokeStep" id="@cdklabs/cdk-ssm-documents.Continue.invokeStep"></a>
|
|
30046
|
+
|
|
30047
|
+
```typescript
|
|
30048
|
+
import { Continue } from '@cdklabs/cdk-ssm-documents'
|
|
30049
|
+
|
|
30050
|
+
Continue.invokeStep(step: AutomationStep)
|
|
30051
|
+
```
|
|
30052
|
+
|
|
30053
|
+
Invoke a specific step.
|
|
30054
|
+
|
|
30055
|
+
Provide the step object to execute for the onFailure action.
|
|
30056
|
+
If you don't have a handle to the step object, use the invokeStepByName function.
|
|
30057
|
+
|
|
30058
|
+
###### `step`<sup>Required</sup> <a name="step" id="@cdklabs/cdk-ssm-documents.Continue.invokeStep.parameter.step"></a>
|
|
30059
|
+
|
|
30060
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
|
|
30061
|
+
|
|
30062
|
+
---
|
|
30063
|
+
|
|
30064
|
+
##### `invokeStepByName` <a name="invokeStepByName" id="@cdklabs/cdk-ssm-documents.Continue.invokeStepByName"></a>
|
|
30065
|
+
|
|
30066
|
+
```typescript
|
|
30067
|
+
import { Continue } from '@cdklabs/cdk-ssm-documents'
|
|
30068
|
+
|
|
30069
|
+
Continue.invokeStepByName(stepName: string)
|
|
30070
|
+
```
|
|
30071
|
+
|
|
30072
|
+
Invoke a specific step by the step name for the OnFailure action.
|
|
30073
|
+
|
|
30074
|
+
###### `stepName`<sup>Required</sup> <a name="stepName" id="@cdklabs/cdk-ssm-documents.Continue.invokeStepByName.parameter.stepName"></a>
|
|
30075
|
+
|
|
30076
|
+
- *Type:* string
|
|
30077
|
+
|
|
30078
|
+
---
|
|
30079
|
+
|
|
30080
|
+
|
|
30081
|
+
|
|
29245
30082
|
### CopyImageSimulation <a name="CopyImageSimulation" id="@cdklabs/cdk-ssm-documents.CopyImageSimulation"></a>
|
|
29246
30083
|
|
|
29247
30084
|
AutomationStep implemenation for aws:copyImage https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-action-copyimage.html.
|
|
@@ -35532,6 +36369,245 @@ public readonly reference: string;
|
|
|
35532
36369
|
---
|
|
35533
36370
|
|
|
35534
36371
|
|
|
36372
|
+
### OnCancel <a name="OnCancel" id="@cdklabs/cdk-ssm-documents.OnCancel"></a>
|
|
36373
|
+
|
|
36374
|
+
Steps can specify an action to take onCancel.
|
|
36375
|
+
|
|
36376
|
+
See docs here: https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-actions.html#canProp
|
|
36377
|
+
The supported actions are abort (default) or invoking a specific step.
|
|
36378
|
+
This behavior can be adopted by using the static methods available on OnCancel.
|
|
36379
|
+
|
|
36380
|
+
#### Initializers <a name="Initializers" id="@cdklabs/cdk-ssm-documents.OnCancel.Initializer"></a>
|
|
36381
|
+
|
|
36382
|
+
```typescript
|
|
36383
|
+
import { OnCancel } from '@cdklabs/cdk-ssm-documents'
|
|
36384
|
+
|
|
36385
|
+
new OnCancel()
|
|
36386
|
+
```
|
|
36387
|
+
|
|
36388
|
+
| **Name** | **Type** | **Description** |
|
|
36389
|
+
| --- | --- | --- |
|
|
36390
|
+
|
|
36391
|
+
---
|
|
36392
|
+
|
|
36393
|
+
#### Methods <a name="Methods" id="Methods"></a>
|
|
36394
|
+
|
|
36395
|
+
| **Name** | **Description** |
|
|
36396
|
+
| --- | --- |
|
|
36397
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.OnCancel.stepToInvoke">stepToInvoke</a></code> | *No description.* |
|
|
36398
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.OnCancel.toSsmValue">toSsmValue</a></code> | *No description.* |
|
|
36399
|
+
|
|
36400
|
+
---
|
|
36401
|
+
|
|
36402
|
+
##### `stepToInvoke` <a name="stepToInvoke" id="@cdklabs/cdk-ssm-documents.OnCancel.stepToInvoke"></a>
|
|
36403
|
+
|
|
36404
|
+
```typescript
|
|
36405
|
+
public stepToInvoke(currentStep: AutomationStep): string
|
|
36406
|
+
```
|
|
36407
|
+
|
|
36408
|
+
###### `currentStep`<sup>Required</sup> <a name="currentStep" id="@cdklabs/cdk-ssm-documents.OnCancel.stepToInvoke.parameter.currentStep"></a>
|
|
36409
|
+
|
|
36410
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
|
|
36411
|
+
|
|
36412
|
+
---
|
|
36413
|
+
|
|
36414
|
+
##### `toSsmValue` <a name="toSsmValue" id="@cdklabs/cdk-ssm-documents.OnCancel.toSsmValue"></a>
|
|
36415
|
+
|
|
36416
|
+
```typescript
|
|
36417
|
+
public toSsmValue(): string
|
|
36418
|
+
```
|
|
36419
|
+
|
|
36420
|
+
#### Static Functions <a name="Static Functions" id="Static Functions"></a>
|
|
36421
|
+
|
|
36422
|
+
| **Name** | **Description** |
|
|
36423
|
+
| --- | --- |
|
|
36424
|
+
| <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. |
|
|
36425
|
+
| <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. |
|
|
36426
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.OnCancel.invokeStep">invokeStep</a></code> | Invoke a specific step. |
|
|
36427
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.OnCancel.invokeStepByName">invokeStepByName</a></code> | Invoke a specific step by the step name for the OnCancel action. |
|
|
36428
|
+
|
|
36429
|
+
---
|
|
36430
|
+
|
|
36431
|
+
##### `abort` <a name="abort" id="@cdklabs/cdk-ssm-documents.OnCancel.abort"></a>
|
|
36432
|
+
|
|
36433
|
+
```typescript
|
|
36434
|
+
import { OnCancel } from '@cdklabs/cdk-ssm-documents'
|
|
36435
|
+
|
|
36436
|
+
OnCancel.abort()
|
|
36437
|
+
```
|
|
36438
|
+
|
|
36439
|
+
To abort execution if a cancellation occurs during execution of the current step.
|
|
36440
|
+
|
|
36441
|
+
(This is the default behavior.)
|
|
36442
|
+
|
|
36443
|
+
##### `continue` <a name="continue" id="@cdklabs/cdk-ssm-documents.OnCancel.continue"></a>
|
|
36444
|
+
|
|
36445
|
+
```typescript
|
|
36446
|
+
import { OnCancel } from '@cdklabs/cdk-ssm-documents'
|
|
36447
|
+
|
|
36448
|
+
OnCancel.continue()
|
|
36449
|
+
```
|
|
36450
|
+
|
|
36451
|
+
To continue execution of the subsequent step if a failure occurs during execution of the current step.
|
|
36452
|
+
|
|
36453
|
+
##### `invokeStep` <a name="invokeStep" id="@cdklabs/cdk-ssm-documents.OnCancel.invokeStep"></a>
|
|
36454
|
+
|
|
36455
|
+
```typescript
|
|
36456
|
+
import { OnCancel } from '@cdklabs/cdk-ssm-documents'
|
|
36457
|
+
|
|
36458
|
+
OnCancel.invokeStep(step: AutomationStep)
|
|
36459
|
+
```
|
|
36460
|
+
|
|
36461
|
+
Invoke a specific step.
|
|
36462
|
+
|
|
36463
|
+
Provide the step object to execute for the onCancel action.
|
|
36464
|
+
If you don't have a handle to the step object, use the invokeStepByName function.
|
|
36465
|
+
Not all action types may be invoked during cancellation. See documentation referenced on this class.
|
|
36466
|
+
|
|
36467
|
+
###### `step`<sup>Required</sup> <a name="step" id="@cdklabs/cdk-ssm-documents.OnCancel.invokeStep.parameter.step"></a>
|
|
36468
|
+
|
|
36469
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
|
|
36470
|
+
|
|
36471
|
+
---
|
|
36472
|
+
|
|
36473
|
+
##### `invokeStepByName` <a name="invokeStepByName" id="@cdklabs/cdk-ssm-documents.OnCancel.invokeStepByName"></a>
|
|
36474
|
+
|
|
36475
|
+
```typescript
|
|
36476
|
+
import { OnCancel } from '@cdklabs/cdk-ssm-documents'
|
|
36477
|
+
|
|
36478
|
+
OnCancel.invokeStepByName(stepName: string)
|
|
36479
|
+
```
|
|
36480
|
+
|
|
36481
|
+
Invoke a specific step by the step name for the OnCancel action.
|
|
36482
|
+
|
|
36483
|
+
Not all action types may be invoked during cancellation. See documentation referenced on this class.
|
|
36484
|
+
|
|
36485
|
+
###### `stepName`<sup>Required</sup> <a name="stepName" id="@cdklabs/cdk-ssm-documents.OnCancel.invokeStepByName.parameter.stepName"></a>
|
|
36486
|
+
|
|
36487
|
+
- *Type:* string
|
|
36488
|
+
|
|
36489
|
+
---
|
|
36490
|
+
|
|
36491
|
+
|
|
36492
|
+
|
|
36493
|
+
### OnFailure <a name="OnFailure" id="@cdklabs/cdk-ssm-documents.OnFailure"></a>
|
|
36494
|
+
|
|
36495
|
+
Steps can specify an action to take onFailure.
|
|
36496
|
+
|
|
36497
|
+
See docs here: https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-actions.html#failProp
|
|
36498
|
+
The supported actions are abort (default), continue, or invoking a specific step.
|
|
36499
|
+
This behavior can be adopted by using the static methods available on OnFailure.
|
|
36500
|
+
|
|
36501
|
+
#### Initializers <a name="Initializers" id="@cdklabs/cdk-ssm-documents.OnFailure.Initializer"></a>
|
|
36502
|
+
|
|
36503
|
+
```typescript
|
|
36504
|
+
import { OnFailure } from '@cdklabs/cdk-ssm-documents'
|
|
36505
|
+
|
|
36506
|
+
new OnFailure()
|
|
36507
|
+
```
|
|
36508
|
+
|
|
36509
|
+
| **Name** | **Type** | **Description** |
|
|
36510
|
+
| --- | --- | --- |
|
|
36511
|
+
|
|
36512
|
+
---
|
|
36513
|
+
|
|
36514
|
+
#### Methods <a name="Methods" id="Methods"></a>
|
|
36515
|
+
|
|
36516
|
+
| **Name** | **Description** |
|
|
36517
|
+
| --- | --- |
|
|
36518
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.OnFailure.stepToInvoke">stepToInvoke</a></code> | *No description.* |
|
|
36519
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.OnFailure.toSsmValue">toSsmValue</a></code> | *No description.* |
|
|
36520
|
+
|
|
36521
|
+
---
|
|
36522
|
+
|
|
36523
|
+
##### `stepToInvoke` <a name="stepToInvoke" id="@cdklabs/cdk-ssm-documents.OnFailure.stepToInvoke"></a>
|
|
36524
|
+
|
|
36525
|
+
```typescript
|
|
36526
|
+
public stepToInvoke(currentStep: AutomationStep): string
|
|
36527
|
+
```
|
|
36528
|
+
|
|
36529
|
+
###### `currentStep`<sup>Required</sup> <a name="currentStep" id="@cdklabs/cdk-ssm-documents.OnFailure.stepToInvoke.parameter.currentStep"></a>
|
|
36530
|
+
|
|
36531
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
|
|
36532
|
+
|
|
36533
|
+
---
|
|
36534
|
+
|
|
36535
|
+
##### `toSsmValue` <a name="toSsmValue" id="@cdklabs/cdk-ssm-documents.OnFailure.toSsmValue"></a>
|
|
36536
|
+
|
|
36537
|
+
```typescript
|
|
36538
|
+
public toSsmValue(): string
|
|
36539
|
+
```
|
|
36540
|
+
|
|
36541
|
+
#### Static Functions <a name="Static Functions" id="Static Functions"></a>
|
|
36542
|
+
|
|
36543
|
+
| **Name** | **Description** |
|
|
36544
|
+
| --- | --- |
|
|
36545
|
+
| <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. |
|
|
36546
|
+
| <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. |
|
|
36547
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.OnFailure.invokeStep">invokeStep</a></code> | Invoke a specific step. |
|
|
36548
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.OnFailure.invokeStepByName">invokeStepByName</a></code> | Invoke a specific step by the step name for the OnFailure action. |
|
|
36549
|
+
|
|
36550
|
+
---
|
|
36551
|
+
|
|
36552
|
+
##### `abort` <a name="abort" id="@cdklabs/cdk-ssm-documents.OnFailure.abort"></a>
|
|
36553
|
+
|
|
36554
|
+
```typescript
|
|
36555
|
+
import { OnFailure } from '@cdklabs/cdk-ssm-documents'
|
|
36556
|
+
|
|
36557
|
+
OnFailure.abort()
|
|
36558
|
+
```
|
|
36559
|
+
|
|
36560
|
+
To abort execution if a failure occurs during execution of the current step.
|
|
36561
|
+
|
|
36562
|
+
(This is the default behavior.)
|
|
36563
|
+
|
|
36564
|
+
##### `continue` <a name="continue" id="@cdklabs/cdk-ssm-documents.OnFailure.continue"></a>
|
|
36565
|
+
|
|
36566
|
+
```typescript
|
|
36567
|
+
import { OnFailure } from '@cdklabs/cdk-ssm-documents'
|
|
36568
|
+
|
|
36569
|
+
OnFailure.continue()
|
|
36570
|
+
```
|
|
36571
|
+
|
|
36572
|
+
To continue execution of the subsequent step if a failure occurs during execution of the current step.
|
|
36573
|
+
|
|
36574
|
+
##### `invokeStep` <a name="invokeStep" id="@cdklabs/cdk-ssm-documents.OnFailure.invokeStep"></a>
|
|
36575
|
+
|
|
36576
|
+
```typescript
|
|
36577
|
+
import { OnFailure } from '@cdklabs/cdk-ssm-documents'
|
|
36578
|
+
|
|
36579
|
+
OnFailure.invokeStep(step: AutomationStep)
|
|
36580
|
+
```
|
|
36581
|
+
|
|
36582
|
+
Invoke a specific step.
|
|
36583
|
+
|
|
36584
|
+
Provide the step object to execute for the onFailure action.
|
|
36585
|
+
If you don't have a handle to the step object, use the invokeStepByName function.
|
|
36586
|
+
|
|
36587
|
+
###### `step`<sup>Required</sup> <a name="step" id="@cdklabs/cdk-ssm-documents.OnFailure.invokeStep.parameter.step"></a>
|
|
36588
|
+
|
|
36589
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
|
|
36590
|
+
|
|
36591
|
+
---
|
|
36592
|
+
|
|
36593
|
+
##### `invokeStepByName` <a name="invokeStepByName" id="@cdklabs/cdk-ssm-documents.OnFailure.invokeStepByName"></a>
|
|
36594
|
+
|
|
36595
|
+
```typescript
|
|
36596
|
+
import { OnFailure } from '@cdklabs/cdk-ssm-documents'
|
|
36597
|
+
|
|
36598
|
+
OnFailure.invokeStepByName(stepName: string)
|
|
36599
|
+
```
|
|
36600
|
+
|
|
36601
|
+
Invoke a specific step by the step name for the OnFailure action.
|
|
36602
|
+
|
|
36603
|
+
###### `stepName`<sup>Required</sup> <a name="stepName" id="@cdklabs/cdk-ssm-documents.OnFailure.invokeStepByName.parameter.stepName"></a>
|
|
36604
|
+
|
|
36605
|
+
- *Type:* string
|
|
36606
|
+
|
|
36607
|
+
---
|
|
36608
|
+
|
|
36609
|
+
|
|
36610
|
+
|
|
35535
36611
|
### OnFailureVariable <a name="OnFailureVariable" id="@cdklabs/cdk-ssm-documents.OnFailureVariable"></a>
|
|
35536
36612
|
|
|
35537
36613
|
- *Implements:* <a href="#@cdklabs/cdk-ssm-documents.IOnFailureVariable">IOnFailureVariable</a>
|
|
@@ -37496,6 +38572,436 @@ public readonly secureToken: string;
|
|
|
37496
38572
|
---
|
|
37497
38573
|
|
|
37498
38574
|
|
|
38575
|
+
### StepFallback <a name="StepFallback" id="@cdklabs/cdk-ssm-documents.StepFallback"></a>
|
|
38576
|
+
|
|
38577
|
+
#### Initializers <a name="Initializers" id="@cdklabs/cdk-ssm-documents.StepFallback.Initializer"></a>
|
|
38578
|
+
|
|
38579
|
+
```typescript
|
|
38580
|
+
import { StepFallback } from '@cdklabs/cdk-ssm-documents'
|
|
38581
|
+
|
|
38582
|
+
new StepFallback(step: AutomationStep, validateStepAction: boolean)
|
|
38583
|
+
```
|
|
38584
|
+
|
|
38585
|
+
| **Name** | **Type** | **Description** |
|
|
38586
|
+
| --- | --- | --- |
|
|
38587
|
+
| <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.* |
|
|
38588
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.StepFallback.Initializer.parameter.validateStepAction">validateStepAction</a></code> | <code>boolean</code> | *No description.* |
|
|
38589
|
+
|
|
38590
|
+
---
|
|
38591
|
+
|
|
38592
|
+
##### `step`<sup>Required</sup> <a name="step" id="@cdklabs/cdk-ssm-documents.StepFallback.Initializer.parameter.step"></a>
|
|
38593
|
+
|
|
38594
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
|
|
38595
|
+
|
|
38596
|
+
---
|
|
38597
|
+
|
|
38598
|
+
##### `validateStepAction`<sup>Required</sup> <a name="validateStepAction" id="@cdklabs/cdk-ssm-documents.StepFallback.Initializer.parameter.validateStepAction"></a>
|
|
38599
|
+
|
|
38600
|
+
- *Type:* boolean
|
|
38601
|
+
|
|
38602
|
+
---
|
|
38603
|
+
|
|
38604
|
+
#### Methods <a name="Methods" id="Methods"></a>
|
|
38605
|
+
|
|
38606
|
+
| **Name** | **Description** |
|
|
38607
|
+
| --- | --- |
|
|
38608
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.StepFallback.stepToInvoke">stepToInvoke</a></code> | *No description.* |
|
|
38609
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.StepFallback.toSsmValue">toSsmValue</a></code> | *No description.* |
|
|
38610
|
+
|
|
38611
|
+
---
|
|
38612
|
+
|
|
38613
|
+
##### `stepToInvoke` <a name="stepToInvoke" id="@cdklabs/cdk-ssm-documents.StepFallback.stepToInvoke"></a>
|
|
38614
|
+
|
|
38615
|
+
```typescript
|
|
38616
|
+
public stepToInvoke(_currentStep: AutomationStep): string
|
|
38617
|
+
```
|
|
38618
|
+
|
|
38619
|
+
###### `_currentStep`<sup>Required</sup> <a name="_currentStep" id="@cdklabs/cdk-ssm-documents.StepFallback.stepToInvoke.parameter._currentStep"></a>
|
|
38620
|
+
|
|
38621
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
|
|
38622
|
+
|
|
38623
|
+
---
|
|
38624
|
+
|
|
38625
|
+
##### `toSsmValue` <a name="toSsmValue" id="@cdklabs/cdk-ssm-documents.StepFallback.toSsmValue"></a>
|
|
38626
|
+
|
|
38627
|
+
```typescript
|
|
38628
|
+
public toSsmValue(): string
|
|
38629
|
+
```
|
|
38630
|
+
|
|
38631
|
+
#### Static Functions <a name="Static Functions" id="Static Functions"></a>
|
|
38632
|
+
|
|
38633
|
+
| **Name** | **Description** |
|
|
38634
|
+
| --- | --- |
|
|
38635
|
+
| <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. |
|
|
38636
|
+
| <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. |
|
|
38637
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.StepFallback.invokeStep">invokeStep</a></code> | Invoke a specific step. |
|
|
38638
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.StepFallback.invokeStepByName">invokeStepByName</a></code> | Invoke a specific step by the step name for the OnCancel action. |
|
|
38639
|
+
|
|
38640
|
+
---
|
|
38641
|
+
|
|
38642
|
+
##### `abort` <a name="abort" id="@cdklabs/cdk-ssm-documents.StepFallback.abort"></a>
|
|
38643
|
+
|
|
38644
|
+
```typescript
|
|
38645
|
+
import { StepFallback } from '@cdklabs/cdk-ssm-documents'
|
|
38646
|
+
|
|
38647
|
+
StepFallback.abort()
|
|
38648
|
+
```
|
|
38649
|
+
|
|
38650
|
+
To abort execution if a cancellation occurs during execution of the current step.
|
|
38651
|
+
|
|
38652
|
+
(This is the default behavior.)
|
|
38653
|
+
|
|
38654
|
+
##### `continue` <a name="continue" id="@cdklabs/cdk-ssm-documents.StepFallback.continue"></a>
|
|
38655
|
+
|
|
38656
|
+
```typescript
|
|
38657
|
+
import { StepFallback } from '@cdklabs/cdk-ssm-documents'
|
|
38658
|
+
|
|
38659
|
+
StepFallback.continue()
|
|
38660
|
+
```
|
|
38661
|
+
|
|
38662
|
+
To continue execution of the subsequent step if a failure occurs during execution of the current step.
|
|
38663
|
+
|
|
38664
|
+
##### `invokeStep` <a name="invokeStep" id="@cdklabs/cdk-ssm-documents.StepFallback.invokeStep"></a>
|
|
38665
|
+
|
|
38666
|
+
```typescript
|
|
38667
|
+
import { StepFallback } from '@cdklabs/cdk-ssm-documents'
|
|
38668
|
+
|
|
38669
|
+
StepFallback.invokeStep(step: AutomationStep)
|
|
38670
|
+
```
|
|
38671
|
+
|
|
38672
|
+
Invoke a specific step.
|
|
38673
|
+
|
|
38674
|
+
Provide the step object to execute for the onCancel action.
|
|
38675
|
+
If you don't have a handle to the step object, use the invokeStepByName function.
|
|
38676
|
+
Not all action types may be invoked during cancellation. See documentation referenced on this class.
|
|
38677
|
+
|
|
38678
|
+
###### `step`<sup>Required</sup> <a name="step" id="@cdklabs/cdk-ssm-documents.StepFallback.invokeStep.parameter.step"></a>
|
|
38679
|
+
|
|
38680
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
|
|
38681
|
+
|
|
38682
|
+
---
|
|
38683
|
+
|
|
38684
|
+
##### `invokeStepByName` <a name="invokeStepByName" id="@cdklabs/cdk-ssm-documents.StepFallback.invokeStepByName"></a>
|
|
38685
|
+
|
|
38686
|
+
```typescript
|
|
38687
|
+
import { StepFallback } from '@cdklabs/cdk-ssm-documents'
|
|
38688
|
+
|
|
38689
|
+
StepFallback.invokeStepByName(stepName: string)
|
|
38690
|
+
```
|
|
38691
|
+
|
|
38692
|
+
Invoke a specific step by the step name for the OnCancel action.
|
|
38693
|
+
|
|
38694
|
+
Not all action types may be invoked during cancellation. See documentation referenced on this class.
|
|
38695
|
+
|
|
38696
|
+
###### `stepName`<sup>Required</sup> <a name="stepName" id="@cdklabs/cdk-ssm-documents.StepFallback.invokeStepByName.parameter.stepName"></a>
|
|
38697
|
+
|
|
38698
|
+
- *Type:* string
|
|
38699
|
+
|
|
38700
|
+
---
|
|
38701
|
+
|
|
38702
|
+
#### Properties <a name="Properties" id="Properties"></a>
|
|
38703
|
+
|
|
38704
|
+
| **Name** | **Type** | **Description** |
|
|
38705
|
+
| --- | --- | --- |
|
|
38706
|
+
| <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.* |
|
|
38707
|
+
|
|
38708
|
+
---
|
|
38709
|
+
|
|
38710
|
+
##### `step`<sup>Required</sup> <a name="step" id="@cdklabs/cdk-ssm-documents.StepFallback.property.step"></a>
|
|
38711
|
+
|
|
38712
|
+
```typescript
|
|
38713
|
+
public readonly step: AutomationStep;
|
|
38714
|
+
```
|
|
38715
|
+
|
|
38716
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
|
|
38717
|
+
|
|
38718
|
+
---
|
|
38719
|
+
|
|
38720
|
+
#### Constants <a name="Constants" id="Constants"></a>
|
|
38721
|
+
|
|
38722
|
+
| **Name** | **Type** | **Description** |
|
|
38723
|
+
| --- | --- | --- |
|
|
38724
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.StepFallback.property.ILLEGAL_FALLBACK_ACTIONS">ILLEGAL_FALLBACK_ACTIONS</a></code> | <code>string[]</code> | *No description.* |
|
|
38725
|
+
|
|
38726
|
+
---
|
|
38727
|
+
|
|
38728
|
+
##### `ILLEGAL_FALLBACK_ACTIONS`<sup>Required</sup> <a name="ILLEGAL_FALLBACK_ACTIONS" id="@cdklabs/cdk-ssm-documents.StepFallback.property.ILLEGAL_FALLBACK_ACTIONS"></a>
|
|
38729
|
+
|
|
38730
|
+
```typescript
|
|
38731
|
+
public readonly ILLEGAL_FALLBACK_ACTIONS: string[];
|
|
38732
|
+
```
|
|
38733
|
+
|
|
38734
|
+
- *Type:* string[]
|
|
38735
|
+
|
|
38736
|
+
---
|
|
38737
|
+
|
|
38738
|
+
### StepNameFallback <a name="StepNameFallback" id="@cdklabs/cdk-ssm-documents.StepNameFallback"></a>
|
|
38739
|
+
|
|
38740
|
+
#### Initializers <a name="Initializers" id="@cdklabs/cdk-ssm-documents.StepNameFallback.Initializer"></a>
|
|
38741
|
+
|
|
38742
|
+
```typescript
|
|
38743
|
+
import { StepNameFallback } from '@cdklabs/cdk-ssm-documents'
|
|
38744
|
+
|
|
38745
|
+
new StepNameFallback(step: string, validateStepAction: boolean)
|
|
38746
|
+
```
|
|
38747
|
+
|
|
38748
|
+
| **Name** | **Type** | **Description** |
|
|
38749
|
+
| --- | --- | --- |
|
|
38750
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.StepNameFallback.Initializer.parameter.step">step</a></code> | <code>string</code> | *No description.* |
|
|
38751
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.StepNameFallback.Initializer.parameter.validateStepAction">validateStepAction</a></code> | <code>boolean</code> | *No description.* |
|
|
38752
|
+
|
|
38753
|
+
---
|
|
38754
|
+
|
|
38755
|
+
##### `step`<sup>Required</sup> <a name="step" id="@cdklabs/cdk-ssm-documents.StepNameFallback.Initializer.parameter.step"></a>
|
|
38756
|
+
|
|
38757
|
+
- *Type:* string
|
|
38758
|
+
|
|
38759
|
+
---
|
|
38760
|
+
|
|
38761
|
+
##### `validateStepAction`<sup>Required</sup> <a name="validateStepAction" id="@cdklabs/cdk-ssm-documents.StepNameFallback.Initializer.parameter.validateStepAction"></a>
|
|
38762
|
+
|
|
38763
|
+
- *Type:* boolean
|
|
38764
|
+
|
|
38765
|
+
---
|
|
38766
|
+
|
|
38767
|
+
#### Methods <a name="Methods" id="Methods"></a>
|
|
38768
|
+
|
|
38769
|
+
| **Name** | **Description** |
|
|
38770
|
+
| --- | --- |
|
|
38771
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.StepNameFallback.stepToInvoke">stepToInvoke</a></code> | *No description.* |
|
|
38772
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.StepNameFallback.toSsmValue">toSsmValue</a></code> | *No description.* |
|
|
38773
|
+
|
|
38774
|
+
---
|
|
38775
|
+
|
|
38776
|
+
##### `stepToInvoke` <a name="stepToInvoke" id="@cdklabs/cdk-ssm-documents.StepNameFallback.stepToInvoke"></a>
|
|
38777
|
+
|
|
38778
|
+
```typescript
|
|
38779
|
+
public stepToInvoke(currentStep: AutomationStep): string
|
|
38780
|
+
```
|
|
38781
|
+
|
|
38782
|
+
###### `currentStep`<sup>Required</sup> <a name="currentStep" id="@cdklabs/cdk-ssm-documents.StepNameFallback.stepToInvoke.parameter.currentStep"></a>
|
|
38783
|
+
|
|
38784
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
|
|
38785
|
+
|
|
38786
|
+
---
|
|
38787
|
+
|
|
38788
|
+
##### `toSsmValue` <a name="toSsmValue" id="@cdklabs/cdk-ssm-documents.StepNameFallback.toSsmValue"></a>
|
|
38789
|
+
|
|
38790
|
+
```typescript
|
|
38791
|
+
public toSsmValue(): string
|
|
38792
|
+
```
|
|
38793
|
+
|
|
38794
|
+
#### Static Functions <a name="Static Functions" id="Static Functions"></a>
|
|
38795
|
+
|
|
38796
|
+
| **Name** | **Description** |
|
|
38797
|
+
| --- | --- |
|
|
38798
|
+
| <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. |
|
|
38799
|
+
| <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. |
|
|
38800
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.StepNameFallback.invokeStep">invokeStep</a></code> | Invoke a specific step. |
|
|
38801
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.StepNameFallback.invokeStepByName">invokeStepByName</a></code> | Invoke a specific step by the step name for the OnCancel action. |
|
|
38802
|
+
|
|
38803
|
+
---
|
|
38804
|
+
|
|
38805
|
+
##### `abort` <a name="abort" id="@cdklabs/cdk-ssm-documents.StepNameFallback.abort"></a>
|
|
38806
|
+
|
|
38807
|
+
```typescript
|
|
38808
|
+
import { StepNameFallback } from '@cdklabs/cdk-ssm-documents'
|
|
38809
|
+
|
|
38810
|
+
StepNameFallback.abort()
|
|
38811
|
+
```
|
|
38812
|
+
|
|
38813
|
+
To abort execution if a cancellation occurs during execution of the current step.
|
|
38814
|
+
|
|
38815
|
+
(This is the default behavior.)
|
|
38816
|
+
|
|
38817
|
+
##### `continue` <a name="continue" id="@cdklabs/cdk-ssm-documents.StepNameFallback.continue"></a>
|
|
38818
|
+
|
|
38819
|
+
```typescript
|
|
38820
|
+
import { StepNameFallback } from '@cdklabs/cdk-ssm-documents'
|
|
38821
|
+
|
|
38822
|
+
StepNameFallback.continue()
|
|
38823
|
+
```
|
|
38824
|
+
|
|
38825
|
+
To continue execution of the subsequent step if a failure occurs during execution of the current step.
|
|
38826
|
+
|
|
38827
|
+
##### `invokeStep` <a name="invokeStep" id="@cdklabs/cdk-ssm-documents.StepNameFallback.invokeStep"></a>
|
|
38828
|
+
|
|
38829
|
+
```typescript
|
|
38830
|
+
import { StepNameFallback } from '@cdklabs/cdk-ssm-documents'
|
|
38831
|
+
|
|
38832
|
+
StepNameFallback.invokeStep(step: AutomationStep)
|
|
38833
|
+
```
|
|
38834
|
+
|
|
38835
|
+
Invoke a specific step.
|
|
38836
|
+
|
|
38837
|
+
Provide the step object to execute for the onCancel action.
|
|
38838
|
+
If you don't have a handle to the step object, use the invokeStepByName function.
|
|
38839
|
+
Not all action types may be invoked during cancellation. See documentation referenced on this class.
|
|
38840
|
+
|
|
38841
|
+
###### `step`<sup>Required</sup> <a name="step" id="@cdklabs/cdk-ssm-documents.StepNameFallback.invokeStep.parameter.step"></a>
|
|
38842
|
+
|
|
38843
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
|
|
38844
|
+
|
|
38845
|
+
---
|
|
38846
|
+
|
|
38847
|
+
##### `invokeStepByName` <a name="invokeStepByName" id="@cdklabs/cdk-ssm-documents.StepNameFallback.invokeStepByName"></a>
|
|
38848
|
+
|
|
38849
|
+
```typescript
|
|
38850
|
+
import { StepNameFallback } from '@cdklabs/cdk-ssm-documents'
|
|
38851
|
+
|
|
38852
|
+
StepNameFallback.invokeStepByName(stepName: string)
|
|
38853
|
+
```
|
|
38854
|
+
|
|
38855
|
+
Invoke a specific step by the step name for the OnCancel action.
|
|
38856
|
+
|
|
38857
|
+
Not all action types may be invoked during cancellation. See documentation referenced on this class.
|
|
38858
|
+
|
|
38859
|
+
###### `stepName`<sup>Required</sup> <a name="stepName" id="@cdklabs/cdk-ssm-documents.StepNameFallback.invokeStepByName.parameter.stepName"></a>
|
|
38860
|
+
|
|
38861
|
+
- *Type:* string
|
|
38862
|
+
|
|
38863
|
+
---
|
|
38864
|
+
|
|
38865
|
+
#### Properties <a name="Properties" id="Properties"></a>
|
|
38866
|
+
|
|
38867
|
+
| **Name** | **Type** | **Description** |
|
|
38868
|
+
| --- | --- | --- |
|
|
38869
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.StepNameFallback.property.step">step</a></code> | <code>string</code> | *No description.* |
|
|
38870
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.StepNameFallback.property.validateStepAction">validateStepAction</a></code> | <code>boolean</code> | *No description.* |
|
|
38871
|
+
|
|
38872
|
+
---
|
|
38873
|
+
|
|
38874
|
+
##### `step`<sup>Required</sup> <a name="step" id="@cdklabs/cdk-ssm-documents.StepNameFallback.property.step"></a>
|
|
38875
|
+
|
|
38876
|
+
```typescript
|
|
38877
|
+
public readonly step: string;
|
|
38878
|
+
```
|
|
38879
|
+
|
|
38880
|
+
- *Type:* string
|
|
38881
|
+
|
|
38882
|
+
---
|
|
38883
|
+
|
|
38884
|
+
##### `validateStepAction`<sup>Required</sup> <a name="validateStepAction" id="@cdklabs/cdk-ssm-documents.StepNameFallback.property.validateStepAction"></a>
|
|
38885
|
+
|
|
38886
|
+
```typescript
|
|
38887
|
+
public readonly validateStepAction: boolean;
|
|
38888
|
+
```
|
|
38889
|
+
|
|
38890
|
+
- *Type:* boolean
|
|
38891
|
+
|
|
38892
|
+
---
|
|
38893
|
+
|
|
38894
|
+
|
|
38895
|
+
### StepRef <a name="StepRef" id="@cdklabs/cdk-ssm-documents.StepRef"></a>
|
|
38896
|
+
|
|
38897
|
+
Class to reference AutomationSteps.
|
|
38898
|
+
|
|
38899
|
+
The class allows steps to be referenced by the Step object or by the step name.
|
|
38900
|
+
|
|
38901
|
+
#### Initializers <a name="Initializers" id="@cdklabs/cdk-ssm-documents.StepRef.Initializer"></a>
|
|
38902
|
+
|
|
38903
|
+
```typescript
|
|
38904
|
+
import { StepRef } from '@cdklabs/cdk-ssm-documents'
|
|
38905
|
+
|
|
38906
|
+
new StepRef(stepName: string)
|
|
38907
|
+
```
|
|
38908
|
+
|
|
38909
|
+
| **Name** | **Type** | **Description** |
|
|
38910
|
+
| --- | --- | --- |
|
|
38911
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.StepRef.Initializer.parameter.stepName">stepName</a></code> | <code>string</code> | *No description.* |
|
|
38912
|
+
|
|
38913
|
+
---
|
|
38914
|
+
|
|
38915
|
+
##### `stepName`<sup>Required</sup> <a name="stepName" id="@cdklabs/cdk-ssm-documents.StepRef.Initializer.parameter.stepName"></a>
|
|
38916
|
+
|
|
38917
|
+
- *Type:* string
|
|
38918
|
+
|
|
38919
|
+
---
|
|
38920
|
+
|
|
38921
|
+
#### Methods <a name="Methods" id="Methods"></a>
|
|
38922
|
+
|
|
38923
|
+
| **Name** | **Description** |
|
|
38924
|
+
| --- | --- |
|
|
38925
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.StepRef.resolve">resolve</a></code> | Resolve to an AutomationStep object. |
|
|
38926
|
+
|
|
38927
|
+
---
|
|
38928
|
+
|
|
38929
|
+
##### `resolve` <a name="resolve" id="@cdklabs/cdk-ssm-documents.StepRef.resolve"></a>
|
|
38930
|
+
|
|
38931
|
+
```typescript
|
|
38932
|
+
public resolve(allStepsInExecution: AutomationStep[]): AutomationStep
|
|
38933
|
+
```
|
|
38934
|
+
|
|
38935
|
+
Resolve to an AutomationStep object.
|
|
38936
|
+
|
|
38937
|
+
Provide all the steps in the execution to find the associated step.
|
|
38938
|
+
|
|
38939
|
+
###### `allStepsInExecution`<sup>Required</sup> <a name="allStepsInExecution" id="@cdklabs/cdk-ssm-documents.StepRef.resolve.parameter.allStepsInExecution"></a>
|
|
38940
|
+
|
|
38941
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>[]
|
|
38942
|
+
|
|
38943
|
+
---
|
|
38944
|
+
|
|
38945
|
+
#### Static Functions <a name="Static Functions" id="Static Functions"></a>
|
|
38946
|
+
|
|
38947
|
+
| **Name** | **Description** |
|
|
38948
|
+
| --- | --- |
|
|
38949
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.StepRef.fromName">fromName</a></code> | Static constructor for creating a reference to a step from a step name. |
|
|
38950
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.StepRef.fromObject">fromObject</a></code> | Static constructor for creating a reference to a step from an AutomationStep object. |
|
|
38951
|
+
|
|
38952
|
+
---
|
|
38953
|
+
|
|
38954
|
+
##### `fromName` <a name="fromName" id="@cdklabs/cdk-ssm-documents.StepRef.fromName"></a>
|
|
38955
|
+
|
|
38956
|
+
```typescript
|
|
38957
|
+
import { StepRef } from '@cdklabs/cdk-ssm-documents'
|
|
38958
|
+
|
|
38959
|
+
StepRef.fromName(stepName: string)
|
|
38960
|
+
```
|
|
38961
|
+
|
|
38962
|
+
Static constructor for creating a reference to a step from a step name.
|
|
38963
|
+
|
|
38964
|
+
###### `stepName`<sup>Required</sup> <a name="stepName" id="@cdklabs/cdk-ssm-documents.StepRef.fromName.parameter.stepName"></a>
|
|
38965
|
+
|
|
38966
|
+
- *Type:* string
|
|
38967
|
+
|
|
38968
|
+
---
|
|
38969
|
+
|
|
38970
|
+
##### `fromObject` <a name="fromObject" id="@cdklabs/cdk-ssm-documents.StepRef.fromObject"></a>
|
|
38971
|
+
|
|
38972
|
+
```typescript
|
|
38973
|
+
import { StepRef } from '@cdklabs/cdk-ssm-documents'
|
|
38974
|
+
|
|
38975
|
+
StepRef.fromObject(step: AutomationStep)
|
|
38976
|
+
```
|
|
38977
|
+
|
|
38978
|
+
Static constructor for creating a reference to a step from an AutomationStep object.
|
|
38979
|
+
|
|
38980
|
+
###### `step`<sup>Required</sup> <a name="step" id="@cdklabs/cdk-ssm-documents.StepRef.fromObject.parameter.step"></a>
|
|
38981
|
+
|
|
38982
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
|
|
38983
|
+
|
|
38984
|
+
---
|
|
38985
|
+
|
|
38986
|
+
#### Properties <a name="Properties" id="Properties"></a>
|
|
38987
|
+
|
|
38988
|
+
| **Name** | **Type** | **Description** |
|
|
38989
|
+
| --- | --- | --- |
|
|
38990
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.StepRef.property.stepName">stepName</a></code> | <code>string</code> | *No description.* |
|
|
38991
|
+
|
|
38992
|
+
---
|
|
38993
|
+
|
|
38994
|
+
##### `stepName`<sup>Required</sup> <a name="stepName" id="@cdklabs/cdk-ssm-documents.StepRef.property.stepName"></a>
|
|
38995
|
+
|
|
38996
|
+
```typescript
|
|
38997
|
+
public readonly stepName: string;
|
|
38998
|
+
```
|
|
38999
|
+
|
|
39000
|
+
- *Type:* string
|
|
39001
|
+
|
|
39002
|
+
---
|
|
39003
|
+
|
|
39004
|
+
|
|
37499
39005
|
### StringDocument <a name="StringDocument" id="@cdklabs/cdk-ssm-documents.StringDocument"></a>
|
|
37500
39006
|
|
|
37501
39007
|
This AutomationDocument supports declaring your document from an existing document (JSON/YAML String/File).
|