@cdklabs/cdk-ssm-documents 0.0.20 → 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 +188 -23
- package/API.md +720 -0
- package/README.md +4 -1
- package/changelog.md +2 -2
- 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 +1 -0
- package/lib/index.js +2 -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.js +6 -6
- 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 +27 -19
- package/lib/parent-steps/automation-step.js +9 -5
- 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 +1 -1
- 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
|
@@ -479,6 +479,7 @@ Any object.
|
|
|
479
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
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.* |
|
|
481
481
|
| <code><a href="#@cdklabs/cdk-ssm-documents.ApproveStep.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</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.* |
|
|
@@ -600,6 +601,16 @@ public readonly timeoutSeconds: number;
|
|
|
600
601
|
|
|
601
602
|
---
|
|
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>
|
|
611
|
+
|
|
612
|
+
---
|
|
613
|
+
|
|
603
614
|
##### `allStepsInExecution`<sup>Optional</sup> <a name="allStepsInExecution" id="@cdklabs/cdk-ssm-documents.ApproveStep.property.allStepsInExecution"></a>
|
|
604
615
|
|
|
605
616
|
```typescript
|
|
@@ -833,6 +844,7 @@ Any object.
|
|
|
833
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.* |
|
|
834
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.* |
|
|
835
846
|
| <code><a href="#@cdklabs/cdk-ssm-documents.AssertAwsResourceStep.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</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.* |
|
|
@@ -957,6 +969,16 @@ public readonly timeoutSeconds: number;
|
|
|
957
969
|
|
|
958
970
|
---
|
|
959
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>
|
|
979
|
+
|
|
980
|
+
---
|
|
981
|
+
|
|
960
982
|
##### `allStepsInExecution`<sup>Optional</sup> <a name="allStepsInExecution" id="@cdklabs/cdk-ssm-documents.AssertAwsResourceStep.property.allStepsInExecution"></a>
|
|
961
983
|
|
|
962
984
|
```typescript
|
|
@@ -1459,6 +1481,7 @@ Any object.
|
|
|
1459
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.* |
|
|
1460
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.* |
|
|
1461
1483
|
| <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</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
|
|
|
@@ -1576,6 +1599,16 @@ public readonly timeoutSeconds: number;
|
|
|
1576
1599
|
|
|
1577
1600
|
---
|
|
1578
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>
|
|
1609
|
+
|
|
1610
|
+
---
|
|
1611
|
+
|
|
1579
1612
|
##### `allStepsInExecution`<sup>Optional</sup> <a name="allStepsInExecution" id="@cdklabs/cdk-ssm-documents.AutomationStep.property.allStepsInExecution"></a>
|
|
1580
1613
|
|
|
1581
1614
|
```typescript
|
|
@@ -1767,6 +1800,7 @@ Any object.
|
|
|
1767
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.* |
|
|
1768
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.* |
|
|
1769
1802
|
| <code><a href="#@cdklabs/cdk-ssm-documents.AwsApiStep.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</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.* |
|
|
@@ -1889,6 +1923,16 @@ public readonly timeoutSeconds: number;
|
|
|
1889
1923
|
|
|
1890
1924
|
---
|
|
1891
1925
|
|
|
1926
|
+
##### `explicitNextStep`<sup>Optional</sup> <a name="explicitNextStep" id="@cdklabs/cdk-ssm-documents.AwsApiStep.property.explicitNextStep"></a>
|
|
1927
|
+
|
|
1928
|
+
```typescript
|
|
1929
|
+
public readonly explicitNextStep: StepRef;
|
|
1930
|
+
```
|
|
1931
|
+
|
|
1932
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a>
|
|
1933
|
+
|
|
1934
|
+
---
|
|
1935
|
+
|
|
1892
1936
|
##### `allStepsInExecution`<sup>Optional</sup> <a name="allStepsInExecution" id="@cdklabs/cdk-ssm-documents.AwsApiStep.property.allStepsInExecution"></a>
|
|
1893
1937
|
|
|
1894
1938
|
```typescript
|
|
@@ -2130,6 +2174,7 @@ Any object.
|
|
|
2130
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.* |
|
|
2131
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.* |
|
|
2132
2176
|
| <code><a href="#@cdklabs/cdk-ssm-documents.BranchStep.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</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.* |
|
|
@@ -2249,6 +2294,16 @@ public readonly timeoutSeconds: number;
|
|
|
2249
2294
|
|
|
2250
2295
|
---
|
|
2251
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>
|
|
2304
|
+
|
|
2305
|
+
---
|
|
2306
|
+
|
|
2252
2307
|
##### `allStepsInExecution`<sup>Optional</sup> <a name="allStepsInExecution" id="@cdklabs/cdk-ssm-documents.BranchStep.property.allStepsInExecution"></a>
|
|
2253
2308
|
|
|
2254
2309
|
```typescript
|
|
@@ -2460,6 +2515,7 @@ Any object.
|
|
|
2460
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.* |
|
|
2461
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.* |
|
|
2462
2517
|
| <code><a href="#@cdklabs/cdk-ssm-documents.ChangeInstanceStateStep.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</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.* |
|
|
@@ -2582,6 +2638,16 @@ public readonly timeoutSeconds: number;
|
|
|
2582
2638
|
|
|
2583
2639
|
---
|
|
2584
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>
|
|
2648
|
+
|
|
2649
|
+
---
|
|
2650
|
+
|
|
2585
2651
|
##### `allStepsInExecution`<sup>Optional</sup> <a name="allStepsInExecution" id="@cdklabs/cdk-ssm-documents.ChangeInstanceStateStep.property.allStepsInExecution"></a>
|
|
2586
2652
|
|
|
2587
2653
|
```typescript
|
|
@@ -4205,6 +4271,7 @@ Any object.
|
|
|
4205
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.* |
|
|
4206
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.* |
|
|
4207
4273
|
| <code><a href="#@cdklabs/cdk-ssm-documents.CopyImageStep.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</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.* |
|
|
@@ -4329,6 +4396,16 @@ public readonly timeoutSeconds: number;
|
|
|
4329
4396
|
|
|
4330
4397
|
---
|
|
4331
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>
|
|
4406
|
+
|
|
4407
|
+
---
|
|
4408
|
+
|
|
4332
4409
|
##### `allStepsInExecution`<sup>Optional</sup> <a name="allStepsInExecution" id="@cdklabs/cdk-ssm-documents.CopyImageStep.property.allStepsInExecution"></a>
|
|
4333
4410
|
|
|
4334
4411
|
```typescript
|
|
@@ -4590,6 +4667,7 @@ Any object.
|
|
|
4590
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.* |
|
|
4591
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.* |
|
|
4592
4669
|
| <code><a href="#@cdklabs/cdk-ssm-documents.CreateImageStep.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</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.* |
|
|
@@ -4712,6 +4790,16 @@ public readonly timeoutSeconds: number;
|
|
|
4712
4790
|
|
|
4713
4791
|
---
|
|
4714
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>
|
|
4800
|
+
|
|
4801
|
+
---
|
|
4802
|
+
|
|
4715
4803
|
##### `allStepsInExecution`<sup>Optional</sup> <a name="allStepsInExecution" id="@cdklabs/cdk-ssm-documents.CreateImageStep.property.allStepsInExecution"></a>
|
|
4716
4804
|
|
|
4717
4805
|
```typescript
|
|
@@ -4953,6 +5041,7 @@ Any object.
|
|
|
4953
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.* |
|
|
4954
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.* |
|
|
4955
5043
|
| <code><a href="#@cdklabs/cdk-ssm-documents.CreateStackStep.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</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.* |
|
|
@@ -5084,6 +5173,16 @@ public readonly timeoutSeconds: number;
|
|
|
5084
5173
|
|
|
5085
5174
|
---
|
|
5086
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>
|
|
5183
|
+
|
|
5184
|
+
---
|
|
5185
|
+
|
|
5087
5186
|
##### `allStepsInExecution`<sup>Optional</sup> <a name="allStepsInExecution" id="@cdklabs/cdk-ssm-documents.CreateStackStep.property.allStepsInExecution"></a>
|
|
5088
5187
|
|
|
5089
5188
|
```typescript
|
|
@@ -5415,6 +5514,7 @@ Any object.
|
|
|
5415
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.* |
|
|
5416
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.* |
|
|
5417
5516
|
| <code><a href="#@cdklabs/cdk-ssm-documents.CreateTagsStep.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</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.* |
|
|
@@ -5535,6 +5635,16 @@ public readonly timeoutSeconds: number;
|
|
|
5535
5635
|
|
|
5536
5636
|
---
|
|
5537
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>
|
|
5645
|
+
|
|
5646
|
+
---
|
|
5647
|
+
|
|
5538
5648
|
##### `allStepsInExecution`<sup>Optional</sup> <a name="allStepsInExecution" id="@cdklabs/cdk-ssm-documents.CreateTagsStep.property.allStepsInExecution"></a>
|
|
5539
5649
|
|
|
5540
5650
|
```typescript
|
|
@@ -5756,6 +5866,7 @@ Any object.
|
|
|
5756
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.* |
|
|
5757
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.* |
|
|
5758
5868
|
| <code><a href="#@cdklabs/cdk-ssm-documents.DeleteImageStep.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</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.* |
|
|
@@ -5874,6 +5985,16 @@ public readonly timeoutSeconds: number;
|
|
|
5874
5985
|
|
|
5875
5986
|
---
|
|
5876
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>
|
|
5995
|
+
|
|
5996
|
+
---
|
|
5997
|
+
|
|
5877
5998
|
##### `allStepsInExecution`<sup>Optional</sup> <a name="allStepsInExecution" id="@cdklabs/cdk-ssm-documents.DeleteImageStep.property.allStepsInExecution"></a>
|
|
5878
5999
|
|
|
5879
6000
|
```typescript
|
|
@@ -6075,6 +6196,7 @@ Any object.
|
|
|
6075
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.* |
|
|
6076
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.* |
|
|
6077
6198
|
| <code><a href="#@cdklabs/cdk-ssm-documents.DeleteStackStep.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</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.* |
|
|
@@ -6194,6 +6316,16 @@ public readonly timeoutSeconds: number;
|
|
|
6194
6316
|
|
|
6195
6317
|
---
|
|
6196
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>
|
|
6326
|
+
|
|
6327
|
+
---
|
|
6328
|
+
|
|
6197
6329
|
##### `allStepsInExecution`<sup>Optional</sup> <a name="allStepsInExecution" id="@cdklabs/cdk-ssm-documents.DeleteStackStep.property.allStepsInExecution"></a>
|
|
6198
6330
|
|
|
6199
6331
|
```typescript
|
|
@@ -7053,6 +7185,7 @@ Any object.
|
|
|
7053
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.* |
|
|
7054
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.* |
|
|
7055
7187
|
| <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteAutomationStep.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</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.* |
|
|
@@ -7180,6 +7313,16 @@ public readonly timeoutSeconds: number;
|
|
|
7180
7313
|
|
|
7181
7314
|
---
|
|
7182
7315
|
|
|
7316
|
+
##### `explicitNextStep`<sup>Optional</sup> <a name="explicitNextStep" id="@cdklabs/cdk-ssm-documents.ExecuteAutomationStep.property.explicitNextStep"></a>
|
|
7317
|
+
|
|
7318
|
+
```typescript
|
|
7319
|
+
public readonly explicitNextStep: StepRef;
|
|
7320
|
+
```
|
|
7321
|
+
|
|
7322
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a>
|
|
7323
|
+
|
|
7324
|
+
---
|
|
7325
|
+
|
|
7183
7326
|
##### `allStepsInExecution`<sup>Optional</sup> <a name="allStepsInExecution" id="@cdklabs/cdk-ssm-documents.ExecuteAutomationStep.property.allStepsInExecution"></a>
|
|
7184
7327
|
|
|
7185
7328
|
```typescript
|
|
@@ -7486,6 +7629,7 @@ ExecuteScriptStep.getLanguage(runtime: string)
|
|
|
7486
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.* |
|
|
7487
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.* |
|
|
7488
7631
|
| <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteScriptStep.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</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.* |
|
|
@@ -7608,6 +7752,16 @@ public readonly timeoutSeconds: number;
|
|
|
7608
7752
|
|
|
7609
7753
|
---
|
|
7610
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>
|
|
7762
|
+
|
|
7763
|
+
---
|
|
7764
|
+
|
|
7611
7765
|
##### `allStepsInExecution`<sup>Optional</sup> <a name="allStepsInExecution" id="@cdklabs/cdk-ssm-documents.ExecuteScriptStep.property.allStepsInExecution"></a>
|
|
7612
7766
|
|
|
7613
7767
|
```typescript
|
|
@@ -7849,6 +8003,7 @@ Any object.
|
|
|
7849
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.* |
|
|
7850
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.* |
|
|
7851
8005
|
| <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteStateMachineStep.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</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.* |
|
|
@@ -7969,6 +8124,16 @@ public readonly timeoutSeconds: number;
|
|
|
7969
8124
|
|
|
7970
8125
|
---
|
|
7971
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>
|
|
8134
|
+
|
|
8135
|
+
---
|
|
8136
|
+
|
|
7972
8137
|
##### `allStepsInExecution`<sup>Optional</sup> <a name="allStepsInExecution" id="@cdklabs/cdk-ssm-documents.ExecuteStateMachineStep.property.allStepsInExecution"></a>
|
|
7973
8138
|
|
|
7974
8139
|
```typescript
|
|
@@ -8936,6 +9101,7 @@ Any object.
|
|
|
8936
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.* |
|
|
8937
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.* |
|
|
8938
9103
|
| <code><a href="#@cdklabs/cdk-ssm-documents.InvokeLambdaFunctionStep.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</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.* |
|
|
@@ -9060,6 +9226,16 @@ public readonly timeoutSeconds: number;
|
|
|
9060
9226
|
|
|
9061
9227
|
---
|
|
9062
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>
|
|
9236
|
+
|
|
9237
|
+
---
|
|
9238
|
+
|
|
9063
9239
|
##### `allStepsInExecution`<sup>Optional</sup> <a name="allStepsInExecution" id="@cdklabs/cdk-ssm-documents.InvokeLambdaFunctionStep.property.allStepsInExecution"></a>
|
|
9064
9240
|
|
|
9065
9241
|
```typescript
|
|
@@ -9321,6 +9497,7 @@ Any object.
|
|
|
9321
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.* |
|
|
9322
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.* |
|
|
9323
9499
|
| <code><a href="#@cdklabs/cdk-ssm-documents.InvokeWebhookStep.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</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.* |
|
|
@@ -9440,6 +9617,16 @@ public readonly timeoutSeconds: number;
|
|
|
9440
9617
|
|
|
9441
9618
|
---
|
|
9442
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>
|
|
9627
|
+
|
|
9628
|
+
---
|
|
9629
|
+
|
|
9443
9630
|
##### `allStepsInExecution`<sup>Optional</sup> <a name="allStepsInExecution" id="@cdklabs/cdk-ssm-documents.InvokeWebhookStep.property.allStepsInExecution"></a>
|
|
9444
9631
|
|
|
9445
9632
|
```typescript
|
|
@@ -9651,6 +9838,7 @@ Any object.
|
|
|
9651
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.* |
|
|
9652
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.* |
|
|
9653
9840
|
| <code><a href="#@cdklabs/cdk-ssm-documents.PauseStep.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</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
|
|
|
@@ -9768,6 +9956,16 @@ public readonly timeoutSeconds: number;
|
|
|
9768
9956
|
|
|
9769
9957
|
---
|
|
9770
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>
|
|
9966
|
+
|
|
9967
|
+
---
|
|
9968
|
+
|
|
9771
9969
|
##### `allStepsInExecution`<sup>Optional</sup> <a name="allStepsInExecution" id="@cdklabs/cdk-ssm-documents.PauseStep.property.allStepsInExecution"></a>
|
|
9772
9970
|
|
|
9773
9971
|
```typescript
|
|
@@ -10439,6 +10637,7 @@ Any object.
|
|
|
10439
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.* |
|
|
10440
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.* |
|
|
10441
10639
|
| <code><a href="#@cdklabs/cdk-ssm-documents.RunCommandStep.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</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.* |
|
|
@@ -10570,6 +10769,16 @@ public readonly timeoutSeconds: number;
|
|
|
10570
10769
|
|
|
10571
10770
|
---
|
|
10572
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>
|
|
10779
|
+
|
|
10780
|
+
---
|
|
10781
|
+
|
|
10573
10782
|
##### `allStepsInExecution`<sup>Optional</sup> <a name="allStepsInExecution" id="@cdklabs/cdk-ssm-documents.RunCommandStep.property.allStepsInExecution"></a>
|
|
10574
10783
|
|
|
10575
10784
|
```typescript
|
|
@@ -11615,6 +11824,7 @@ Any object.
|
|
|
11615
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.* |
|
|
11616
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.* |
|
|
11617
11826
|
| <code><a href="#@cdklabs/cdk-ssm-documents.RunInstanceStep.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</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.* |
|
|
@@ -11756,6 +11966,16 @@ public readonly timeoutSeconds: number;
|
|
|
11756
11966
|
|
|
11757
11967
|
---
|
|
11758
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>
|
|
11976
|
+
|
|
11977
|
+
---
|
|
11978
|
+
|
|
11759
11979
|
##### `allStepsInExecution`<sup>Optional</sup> <a name="allStepsInExecution" id="@cdklabs/cdk-ssm-documents.RunInstanceStep.property.allStepsInExecution"></a>
|
|
11760
11980
|
|
|
11761
11981
|
```typescript
|
|
@@ -12835,6 +13055,7 @@ Any object.
|
|
|
12835
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.* |
|
|
12836
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.* |
|
|
12837
13057
|
| <code><a href="#@cdklabs/cdk-ssm-documents.SleepStep.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</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.* |
|
|
@@ -12953,6 +13174,16 @@ public readonly timeoutSeconds: number;
|
|
|
12953
13174
|
|
|
12954
13175
|
---
|
|
12955
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>
|
|
13184
|
+
|
|
13185
|
+
---
|
|
13186
|
+
|
|
12956
13187
|
##### `allStepsInExecution`<sup>Optional</sup> <a name="allStepsInExecution" id="@cdklabs/cdk-ssm-documents.SleepStep.property.allStepsInExecution"></a>
|
|
12957
13188
|
|
|
12958
13189
|
```typescript
|
|
@@ -14990,6 +15221,7 @@ Any object.
|
|
|
14990
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.* |
|
|
14991
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.* |
|
|
14992
15223
|
| <code><a href="#@cdklabs/cdk-ssm-documents.WaitForResourceStep.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</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.* |
|
|
@@ -15115,6 +15347,16 @@ public readonly timeoutSeconds: number;
|
|
|
15115
15347
|
|
|
15116
15348
|
---
|
|
15117
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>
|
|
15357
|
+
|
|
15358
|
+
---
|
|
15359
|
+
|
|
15118
15360
|
##### `allStepsInExecution`<sup>Optional</sup> <a name="allStepsInExecution" id="@cdklabs/cdk-ssm-documents.WaitForResourceStep.property.allStepsInExecution"></a>
|
|
15119
15361
|
|
|
15120
15362
|
```typescript
|
|
@@ -15583,6 +15825,7 @@ 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
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. |
|
|
@@ -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
|
|
@@ -15799,6 +16057,7 @@ 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
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. |
|
|
@@ -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
|
|
@@ -16407,6 +16681,7 @@ 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
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. |
|
|
@@ -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
|
|
@@ -16557,6 +16847,7 @@ 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
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. |
|
|
@@ -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
|
|
@@ -16807,6 +17113,7 @@ 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
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. |
|
|
@@ -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
|
|
@@ -17165,6 +17487,7 @@ 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
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. |
|
|
@@ -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
|
|
@@ -17344,6 +17682,7 @@ 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
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. |
|
|
@@ -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
|
|
@@ -17508,6 +17862,7 @@ 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
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. |
|
|
@@ -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
|
|
@@ -18616,6 +18986,7 @@ 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
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. |
|
|
@@ -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
|
|
@@ -18857,6 +19243,7 @@ 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
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. |
|
|
@@ -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
|
|
@@ -19140,6 +19542,7 @@ 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
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. |
|
|
@@ -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
|
|
@@ -19527,6 +19945,7 @@ 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
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. |
|
|
@@ -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
|
|
@@ -19770,6 +20204,7 @@ 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
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. |
|
|
@@ -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
|
|
@@ -19933,6 +20383,7 @@ 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
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. |
|
|
@@ -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
|
|
@@ -20911,6 +21377,7 @@ 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
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. |
|
|
@@ -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
|
|
@@ -21171,6 +21653,7 @@ 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
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. |
|
|
@@ -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
|
|
@@ -21412,6 +21910,7 @@ 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
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. |
|
|
@@ -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
|
|
@@ -22200,6 +22714,7 @@ 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
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. |
|
|
@@ -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
|
|
@@ -22559,6 +23089,7 @@ 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
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. |
|
|
@@ -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
|
|
@@ -23695,6 +24241,7 @@ 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
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. |
|
|
@@ -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
|
|
@@ -24497,6 +25059,7 @@ 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
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. |
|
|
@@ -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
|
|
@@ -25652,6 +26230,7 @@ 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
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. |
|
|
@@ -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
|
|
@@ -27200,6 +27794,7 @@ 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
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. |
|
|
@@ -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
|
|
@@ -38282,6 +38892,116 @@ public readonly validateStepAction: boolean;
|
|
|
38282
38892
|
---
|
|
38283
38893
|
|
|
38284
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
|
+
|
|
38285
39005
|
### StringDocument <a name="StringDocument" id="@cdklabs/cdk-ssm-documents.StringDocument"></a>
|
|
38286
39006
|
|
|
38287
39007
|
This AutomationDocument supports declaring your document from an existing document (JSON/YAML String/File).
|