@cdklabs/cdk-ssm-documents 0.0.20 → 0.0.23
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 +861 -240
- package/API.md +1301 -93
- package/README.md +8 -6
- package/changelog.md +3 -3
- package/lib/construct/synth-utils.js +1 -1
- package/lib/document/automation-document.js +1 -1
- package/lib/document/command-document.js +1 -1
- package/lib/document/document-builder.js +2 -2
- package/lib/document/ssm-document.d.ts +1 -0
- package/lib/document/ssm-document.js +3 -3
- 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 +5 -3
- 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.d.ts +116 -39
- package/lib/parent-steps/automation/execute-script-step.js +157 -62
- 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 +9 -7
- package/lib/patterns/document/string-document.js +1 -1
- package/lib/patterns/document/timed-document.js +10 -10
- package/lib/samples/hello-world.js +7 -8
- 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 +5 -11
- 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
|
|
@@ -1204,6 +1226,7 @@ Any object.
|
|
|
1204
1226
|
| **Name** | **Type** | **Description** |
|
|
1205
1227
|
| --- | --- | --- |
|
|
1206
1228
|
| <code><a href="#@cdklabs/cdk-ssm-documents.AutomationDocument.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
|
|
1229
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.AutomationDocument.property.cfnDocument">cfnDocument</a></code> | <code>aws-cdk-lib.aws_ssm.CfnDocument</code> | *No description.* |
|
|
1207
1230
|
| <code><a href="#@cdklabs/cdk-ssm-documents.AutomationDocument.property.description">description</a></code> | <code>string</code> | *No description.* |
|
|
1208
1231
|
| <code><a href="#@cdklabs/cdk-ssm-documents.AutomationDocument.property.docInputs">docInputs</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.Input">Input</a>[]</code> | *No description.* |
|
|
1209
1232
|
| <code><a href="#@cdklabs/cdk-ssm-documents.AutomationDocument.property.docOutputs">docOutputs</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.DocumentOutput">DocumentOutput</a>[]</code> | *No description.* |
|
|
@@ -1227,6 +1250,16 @@ The tree node.
|
|
|
1227
1250
|
|
|
1228
1251
|
---
|
|
1229
1252
|
|
|
1253
|
+
##### `cfnDocument`<sup>Required</sup> <a name="cfnDocument" id="@cdklabs/cdk-ssm-documents.AutomationDocument.property.cfnDocument"></a>
|
|
1254
|
+
|
|
1255
|
+
```typescript
|
|
1256
|
+
public readonly cfnDocument: CfnDocument;
|
|
1257
|
+
```
|
|
1258
|
+
|
|
1259
|
+
- *Type:* aws-cdk-lib.aws_ssm.CfnDocument
|
|
1260
|
+
|
|
1261
|
+
---
|
|
1262
|
+
|
|
1230
1263
|
##### `description`<sup>Required</sup> <a name="description" id="@cdklabs/cdk-ssm-documents.AutomationDocument.property.description"></a>
|
|
1231
1264
|
|
|
1232
1265
|
```typescript
|
|
@@ -1459,6 +1492,7 @@ Any object.
|
|
|
1459
1492
|
| <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
1493
|
| <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
1494
|
| <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStep.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</code> | *No description.* |
|
|
1495
|
+
| <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
1496
|
| <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
1497
|
| <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
1498
|
|
|
@@ -1576,6 +1610,16 @@ public readonly timeoutSeconds: number;
|
|
|
1576
1610
|
|
|
1577
1611
|
---
|
|
1578
1612
|
|
|
1613
|
+
##### `explicitNextStep`<sup>Optional</sup> <a name="explicitNextStep" id="@cdklabs/cdk-ssm-documents.AutomationStep.property.explicitNextStep"></a>
|
|
1614
|
+
|
|
1615
|
+
```typescript
|
|
1616
|
+
public readonly explicitNextStep: StepRef;
|
|
1617
|
+
```
|
|
1618
|
+
|
|
1619
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a>
|
|
1620
|
+
|
|
1621
|
+
---
|
|
1622
|
+
|
|
1579
1623
|
##### `allStepsInExecution`<sup>Optional</sup> <a name="allStepsInExecution" id="@cdklabs/cdk-ssm-documents.AutomationStep.property.allStepsInExecution"></a>
|
|
1580
1624
|
|
|
1581
1625
|
```typescript
|
|
@@ -1767,6 +1811,7 @@ Any object.
|
|
|
1767
1811
|
| <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
1812
|
| <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
1813
|
| <code><a href="#@cdklabs/cdk-ssm-documents.AwsApiStep.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</code> | *No description.* |
|
|
1814
|
+
| <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
1815
|
| <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
1816
|
| <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
1817
|
| <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 +1934,16 @@ public readonly timeoutSeconds: number;
|
|
|
1889
1934
|
|
|
1890
1935
|
---
|
|
1891
1936
|
|
|
1937
|
+
##### `explicitNextStep`<sup>Optional</sup> <a name="explicitNextStep" id="@cdklabs/cdk-ssm-documents.AwsApiStep.property.explicitNextStep"></a>
|
|
1938
|
+
|
|
1939
|
+
```typescript
|
|
1940
|
+
public readonly explicitNextStep: StepRef;
|
|
1941
|
+
```
|
|
1942
|
+
|
|
1943
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a>
|
|
1944
|
+
|
|
1945
|
+
---
|
|
1946
|
+
|
|
1892
1947
|
##### `allStepsInExecution`<sup>Optional</sup> <a name="allStepsInExecution" id="@cdklabs/cdk-ssm-documents.AwsApiStep.property.allStepsInExecution"></a>
|
|
1893
1948
|
|
|
1894
1949
|
```typescript
|
|
@@ -2130,6 +2185,7 @@ Any object.
|
|
|
2130
2185
|
| <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
2186
|
| <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
2187
|
| <code><a href="#@cdklabs/cdk-ssm-documents.BranchStep.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</code> | *No description.* |
|
|
2188
|
+
| <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
2189
|
| <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
2190
|
| <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
2191
|
| <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 +2305,16 @@ public readonly timeoutSeconds: number;
|
|
|
2249
2305
|
|
|
2250
2306
|
---
|
|
2251
2307
|
|
|
2308
|
+
##### `explicitNextStep`<sup>Optional</sup> <a name="explicitNextStep" id="@cdklabs/cdk-ssm-documents.BranchStep.property.explicitNextStep"></a>
|
|
2309
|
+
|
|
2310
|
+
```typescript
|
|
2311
|
+
public readonly explicitNextStep: StepRef;
|
|
2312
|
+
```
|
|
2313
|
+
|
|
2314
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a>
|
|
2315
|
+
|
|
2316
|
+
---
|
|
2317
|
+
|
|
2252
2318
|
##### `allStepsInExecution`<sup>Optional</sup> <a name="allStepsInExecution" id="@cdklabs/cdk-ssm-documents.BranchStep.property.allStepsInExecution"></a>
|
|
2253
2319
|
|
|
2254
2320
|
```typescript
|
|
@@ -2460,6 +2526,7 @@ Any object.
|
|
|
2460
2526
|
| <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
2527
|
| <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
2528
|
| <code><a href="#@cdklabs/cdk-ssm-documents.ChangeInstanceStateStep.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</code> | *No description.* |
|
|
2529
|
+
| <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
2530
|
| <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
2531
|
| <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
2532
|
| <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 +2649,16 @@ public readonly timeoutSeconds: number;
|
|
|
2582
2649
|
|
|
2583
2650
|
---
|
|
2584
2651
|
|
|
2652
|
+
##### `explicitNextStep`<sup>Optional</sup> <a name="explicitNextStep" id="@cdklabs/cdk-ssm-documents.ChangeInstanceStateStep.property.explicitNextStep"></a>
|
|
2653
|
+
|
|
2654
|
+
```typescript
|
|
2655
|
+
public readonly explicitNextStep: StepRef;
|
|
2656
|
+
```
|
|
2657
|
+
|
|
2658
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a>
|
|
2659
|
+
|
|
2660
|
+
---
|
|
2661
|
+
|
|
2585
2662
|
##### `allStepsInExecution`<sup>Optional</sup> <a name="allStepsInExecution" id="@cdklabs/cdk-ssm-documents.ChangeInstanceStateStep.property.allStepsInExecution"></a>
|
|
2586
2663
|
|
|
2587
2664
|
```typescript
|
|
@@ -2806,6 +2883,7 @@ Any object.
|
|
|
2806
2883
|
| **Name** | **Type** | **Description** |
|
|
2807
2884
|
| --- | --- | --- |
|
|
2808
2885
|
| <code><a href="#@cdklabs/cdk-ssm-documents.CommandDocument.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
|
|
2886
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.CommandDocument.property.cfnDocument">cfnDocument</a></code> | <code>aws-cdk-lib.aws_ssm.CfnDocument</code> | *No description.* |
|
|
2809
2887
|
| <code><a href="#@cdklabs/cdk-ssm-documents.CommandDocument.property.description">description</a></code> | <code>string</code> | *No description.* |
|
|
2810
2888
|
| <code><a href="#@cdklabs/cdk-ssm-documents.CommandDocument.property.docInputs">docInputs</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.Input">Input</a>[]</code> | *No description.* |
|
|
2811
2889
|
| <code><a href="#@cdklabs/cdk-ssm-documents.CommandDocument.property.docOutputs">docOutputs</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.DocumentOutput">DocumentOutput</a>[]</code> | *No description.* |
|
|
@@ -2829,6 +2907,16 @@ The tree node.
|
|
|
2829
2907
|
|
|
2830
2908
|
---
|
|
2831
2909
|
|
|
2910
|
+
##### `cfnDocument`<sup>Required</sup> <a name="cfnDocument" id="@cdklabs/cdk-ssm-documents.CommandDocument.property.cfnDocument"></a>
|
|
2911
|
+
|
|
2912
|
+
```typescript
|
|
2913
|
+
public readonly cfnDocument: CfnDocument;
|
|
2914
|
+
```
|
|
2915
|
+
|
|
2916
|
+
- *Type:* aws-cdk-lib.aws_ssm.CfnDocument
|
|
2917
|
+
|
|
2918
|
+
---
|
|
2919
|
+
|
|
2832
2920
|
##### `description`<sup>Required</sup> <a name="description" id="@cdklabs/cdk-ssm-documents.CommandDocument.property.description"></a>
|
|
2833
2921
|
|
|
2834
2922
|
```typescript
|
|
@@ -4205,6 +4293,7 @@ Any object.
|
|
|
4205
4293
|
| <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
4294
|
| <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
4295
|
| <code><a href="#@cdklabs/cdk-ssm-documents.CopyImageStep.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</code> | *No description.* |
|
|
4296
|
+
| <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
4297
|
| <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
4298
|
| <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
4299
|
| <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 +4418,16 @@ public readonly timeoutSeconds: number;
|
|
|
4329
4418
|
|
|
4330
4419
|
---
|
|
4331
4420
|
|
|
4421
|
+
##### `explicitNextStep`<sup>Optional</sup> <a name="explicitNextStep" id="@cdklabs/cdk-ssm-documents.CopyImageStep.property.explicitNextStep"></a>
|
|
4422
|
+
|
|
4423
|
+
```typescript
|
|
4424
|
+
public readonly explicitNextStep: StepRef;
|
|
4425
|
+
```
|
|
4426
|
+
|
|
4427
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a>
|
|
4428
|
+
|
|
4429
|
+
---
|
|
4430
|
+
|
|
4332
4431
|
##### `allStepsInExecution`<sup>Optional</sup> <a name="allStepsInExecution" id="@cdklabs/cdk-ssm-documents.CopyImageStep.property.allStepsInExecution"></a>
|
|
4333
4432
|
|
|
4334
4433
|
```typescript
|
|
@@ -4590,6 +4689,7 @@ Any object.
|
|
|
4590
4689
|
| <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
4690
|
| <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
4691
|
| <code><a href="#@cdklabs/cdk-ssm-documents.CreateImageStep.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</code> | *No description.* |
|
|
4692
|
+
| <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
4693
|
| <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
4694
|
| <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
4695
|
| <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 +4812,16 @@ public readonly timeoutSeconds: number;
|
|
|
4712
4812
|
|
|
4713
4813
|
---
|
|
4714
4814
|
|
|
4815
|
+
##### `explicitNextStep`<sup>Optional</sup> <a name="explicitNextStep" id="@cdklabs/cdk-ssm-documents.CreateImageStep.property.explicitNextStep"></a>
|
|
4816
|
+
|
|
4817
|
+
```typescript
|
|
4818
|
+
public readonly explicitNextStep: StepRef;
|
|
4819
|
+
```
|
|
4820
|
+
|
|
4821
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a>
|
|
4822
|
+
|
|
4823
|
+
---
|
|
4824
|
+
|
|
4715
4825
|
##### `allStepsInExecution`<sup>Optional</sup> <a name="allStepsInExecution" id="@cdklabs/cdk-ssm-documents.CreateImageStep.property.allStepsInExecution"></a>
|
|
4716
4826
|
|
|
4717
4827
|
```typescript
|
|
@@ -4953,6 +5063,7 @@ Any object.
|
|
|
4953
5063
|
| <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
5064
|
| <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
5065
|
| <code><a href="#@cdklabs/cdk-ssm-documents.CreateStackStep.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</code> | *No description.* |
|
|
5066
|
+
| <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
5067
|
| <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
5068
|
| <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
5069
|
| <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 +5195,16 @@ public readonly timeoutSeconds: number;
|
|
|
5084
5195
|
|
|
5085
5196
|
---
|
|
5086
5197
|
|
|
5198
|
+
##### `explicitNextStep`<sup>Optional</sup> <a name="explicitNextStep" id="@cdklabs/cdk-ssm-documents.CreateStackStep.property.explicitNextStep"></a>
|
|
5199
|
+
|
|
5200
|
+
```typescript
|
|
5201
|
+
public readonly explicitNextStep: StepRef;
|
|
5202
|
+
```
|
|
5203
|
+
|
|
5204
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a>
|
|
5205
|
+
|
|
5206
|
+
---
|
|
5207
|
+
|
|
5087
5208
|
##### `allStepsInExecution`<sup>Optional</sup> <a name="allStepsInExecution" id="@cdklabs/cdk-ssm-documents.CreateStackStep.property.allStepsInExecution"></a>
|
|
5088
5209
|
|
|
5089
5210
|
```typescript
|
|
@@ -5415,6 +5536,7 @@ Any object.
|
|
|
5415
5536
|
| <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
5537
|
| <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
5538
|
| <code><a href="#@cdklabs/cdk-ssm-documents.CreateTagsStep.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</code> | *No description.* |
|
|
5539
|
+
| <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
5540
|
| <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
5541
|
| <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
5542
|
| <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 +5657,16 @@ public readonly timeoutSeconds: number;
|
|
|
5535
5657
|
|
|
5536
5658
|
---
|
|
5537
5659
|
|
|
5660
|
+
##### `explicitNextStep`<sup>Optional</sup> <a name="explicitNextStep" id="@cdklabs/cdk-ssm-documents.CreateTagsStep.property.explicitNextStep"></a>
|
|
5661
|
+
|
|
5662
|
+
```typescript
|
|
5663
|
+
public readonly explicitNextStep: StepRef;
|
|
5664
|
+
```
|
|
5665
|
+
|
|
5666
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a>
|
|
5667
|
+
|
|
5668
|
+
---
|
|
5669
|
+
|
|
5538
5670
|
##### `allStepsInExecution`<sup>Optional</sup> <a name="allStepsInExecution" id="@cdklabs/cdk-ssm-documents.CreateTagsStep.property.allStepsInExecution"></a>
|
|
5539
5671
|
|
|
5540
5672
|
```typescript
|
|
@@ -5756,6 +5888,7 @@ Any object.
|
|
|
5756
5888
|
| <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
5889
|
| <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
5890
|
| <code><a href="#@cdklabs/cdk-ssm-documents.DeleteImageStep.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</code> | *No description.* |
|
|
5891
|
+
| <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
5892
|
| <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
5893
|
| <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
5894
|
| <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 +6007,16 @@ public readonly timeoutSeconds: number;
|
|
|
5874
6007
|
|
|
5875
6008
|
---
|
|
5876
6009
|
|
|
6010
|
+
##### `explicitNextStep`<sup>Optional</sup> <a name="explicitNextStep" id="@cdklabs/cdk-ssm-documents.DeleteImageStep.property.explicitNextStep"></a>
|
|
6011
|
+
|
|
6012
|
+
```typescript
|
|
6013
|
+
public readonly explicitNextStep: StepRef;
|
|
6014
|
+
```
|
|
6015
|
+
|
|
6016
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a>
|
|
6017
|
+
|
|
6018
|
+
---
|
|
6019
|
+
|
|
5877
6020
|
##### `allStepsInExecution`<sup>Optional</sup> <a name="allStepsInExecution" id="@cdklabs/cdk-ssm-documents.DeleteImageStep.property.allStepsInExecution"></a>
|
|
5878
6021
|
|
|
5879
6022
|
```typescript
|
|
@@ -6075,6 +6218,7 @@ Any object.
|
|
|
6075
6218
|
| <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
6219
|
| <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
6220
|
| <code><a href="#@cdklabs/cdk-ssm-documents.DeleteStackStep.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</code> | *No description.* |
|
|
6221
|
+
| <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
6222
|
| <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
6223
|
| <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
6224
|
| <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 +6338,16 @@ public readonly timeoutSeconds: number;
|
|
|
6194
6338
|
|
|
6195
6339
|
---
|
|
6196
6340
|
|
|
6341
|
+
##### `explicitNextStep`<sup>Optional</sup> <a name="explicitNextStep" id="@cdklabs/cdk-ssm-documents.DeleteStackStep.property.explicitNextStep"></a>
|
|
6342
|
+
|
|
6343
|
+
```typescript
|
|
6344
|
+
public readonly explicitNextStep: StepRef;
|
|
6345
|
+
```
|
|
6346
|
+
|
|
6347
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a>
|
|
6348
|
+
|
|
6349
|
+
---
|
|
6350
|
+
|
|
6197
6351
|
##### `allStepsInExecution`<sup>Optional</sup> <a name="allStepsInExecution" id="@cdklabs/cdk-ssm-documents.DeleteStackStep.property.allStepsInExecution"></a>
|
|
6198
6352
|
|
|
6199
6353
|
```typescript
|
|
@@ -7053,6 +7207,7 @@ Any object.
|
|
|
7053
7207
|
| <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
7208
|
| <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
7209
|
| <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteAutomationStep.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</code> | *No description.* |
|
|
7210
|
+
| <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
7211
|
| <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
7212
|
| <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
7213
|
| <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 +7335,16 @@ public readonly timeoutSeconds: number;
|
|
|
7180
7335
|
|
|
7181
7336
|
---
|
|
7182
7337
|
|
|
7338
|
+
##### `explicitNextStep`<sup>Optional</sup> <a name="explicitNextStep" id="@cdklabs/cdk-ssm-documents.ExecuteAutomationStep.property.explicitNextStep"></a>
|
|
7339
|
+
|
|
7340
|
+
```typescript
|
|
7341
|
+
public readonly explicitNextStep: StepRef;
|
|
7342
|
+
```
|
|
7343
|
+
|
|
7344
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a>
|
|
7345
|
+
|
|
7346
|
+
---
|
|
7347
|
+
|
|
7183
7348
|
##### `allStepsInExecution`<sup>Optional</sup> <a name="allStepsInExecution" id="@cdklabs/cdk-ssm-documents.ExecuteAutomationStep.property.allStepsInExecution"></a>
|
|
7184
7349
|
|
|
7185
7350
|
```typescript
|
|
@@ -7435,7 +7600,6 @@ public variables(): {[ key: string ]: any}
|
|
|
7435
7600
|
| **Name** | **Description** |
|
|
7436
7601
|
| --- | --- |
|
|
7437
7602
|
| <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteScriptStep.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. |
|
|
7438
|
-
| <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteScriptStep.getLanguage">getLanguage</a></code> | *No description.* |
|
|
7439
7603
|
|
|
7440
7604
|
---
|
|
7441
7605
|
|
|
@@ -7457,20 +7621,6 @@ Any object.
|
|
|
7457
7621
|
|
|
7458
7622
|
---
|
|
7459
7623
|
|
|
7460
|
-
##### `getLanguage` <a name="getLanguage" id="@cdklabs/cdk-ssm-documents.ExecuteScriptStep.getLanguage"></a>
|
|
7461
|
-
|
|
7462
|
-
```typescript
|
|
7463
|
-
import { ExecuteScriptStep } from '@cdklabs/cdk-ssm-documents'
|
|
7464
|
-
|
|
7465
|
-
ExecuteScriptStep.getLanguage(runtime: string)
|
|
7466
|
-
```
|
|
7467
|
-
|
|
7468
|
-
###### `runtime`<sup>Required</sup> <a name="runtime" id="@cdklabs/cdk-ssm-documents.ExecuteScriptStep.getLanguage.parameter.runtime"></a>
|
|
7469
|
-
|
|
7470
|
-
- *Type:* string
|
|
7471
|
-
|
|
7472
|
-
---
|
|
7473
|
-
|
|
7474
7624
|
#### Properties <a name="Properties" id="Properties"></a>
|
|
7475
7625
|
|
|
7476
7626
|
| **Name** | **Type** | **Description** |
|
|
@@ -7486,11 +7636,11 @@ ExecuteScriptStep.getLanguage(runtime: string)
|
|
|
7486
7636
|
| <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
7637
|
| <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
7638
|
| <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteScriptStep.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</code> | *No description.* |
|
|
7639
|
+
| <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
7640
|
| <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
7641
|
| <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
|
-
| <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteScriptStep.property.
|
|
7492
|
-
| <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteScriptStep.property.
|
|
7493
|
-
| <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteScriptStep.property.inputs">inputs</a></code> | <code>string[]</code> | *No description.* |
|
|
7642
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteScriptStep.property.code">code</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.ScriptCode">ScriptCode</a></code> | *No description.* |
|
|
7643
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteScriptStep.property.inputs">inputs</a></code> | <code>{[ key: string ]: <a href="#@cdklabs/cdk-ssm-documents.IGenericVariable">IGenericVariable</a>}</code> | *No description.* |
|
|
7494
7644
|
| <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteScriptStep.property.language">language</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.ScriptLanguage">ScriptLanguage</a></code> | *No description.* |
|
|
7495
7645
|
| <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteScriptStep.property.outputs">outputs</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.Output">Output</a>[]</code> | *No description.* |
|
|
7496
7646
|
|
|
@@ -7608,53 +7758,53 @@ public readonly timeoutSeconds: number;
|
|
|
7608
7758
|
|
|
7609
7759
|
---
|
|
7610
7760
|
|
|
7611
|
-
##### `
|
|
7761
|
+
##### `explicitNextStep`<sup>Optional</sup> <a name="explicitNextStep" id="@cdklabs/cdk-ssm-documents.ExecuteScriptStep.property.explicitNextStep"></a>
|
|
7612
7762
|
|
|
7613
7763
|
```typescript
|
|
7614
|
-
public readonly
|
|
7764
|
+
public readonly explicitNextStep: StepRef;
|
|
7615
7765
|
```
|
|
7616
7766
|
|
|
7617
|
-
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.
|
|
7767
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a>
|
|
7618
7768
|
|
|
7619
7769
|
---
|
|
7620
7770
|
|
|
7621
|
-
##### `
|
|
7771
|
+
##### `allStepsInExecution`<sup>Optional</sup> <a name="allStepsInExecution" id="@cdklabs/cdk-ssm-documents.ExecuteScriptStep.property.allStepsInExecution"></a>
|
|
7622
7772
|
|
|
7623
7773
|
```typescript
|
|
7624
|
-
public readonly
|
|
7774
|
+
public readonly allStepsInExecution: AutomationStep[];
|
|
7625
7775
|
```
|
|
7626
7776
|
|
|
7627
|
-
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
|
|
7777
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>[]
|
|
7628
7778
|
|
|
7629
7779
|
---
|
|
7630
7780
|
|
|
7631
|
-
##### `
|
|
7781
|
+
##### `nextStep`<sup>Optional</sup> <a name="nextStep" id="@cdklabs/cdk-ssm-documents.ExecuteScriptStep.property.nextStep"></a>
|
|
7632
7782
|
|
|
7633
7783
|
```typescript
|
|
7634
|
-
public readonly
|
|
7784
|
+
public readonly nextStep: AutomationStep;
|
|
7635
7785
|
```
|
|
7636
7786
|
|
|
7637
|
-
- *Type:*
|
|
7787
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
|
|
7638
7788
|
|
|
7639
7789
|
---
|
|
7640
7790
|
|
|
7641
|
-
##### `
|
|
7791
|
+
##### `code`<sup>Required</sup> <a name="code" id="@cdklabs/cdk-ssm-documents.ExecuteScriptStep.property.code"></a>
|
|
7642
7792
|
|
|
7643
7793
|
```typescript
|
|
7644
|
-
public readonly
|
|
7794
|
+
public readonly code: ScriptCode;
|
|
7645
7795
|
```
|
|
7646
7796
|
|
|
7647
|
-
- *Type:*
|
|
7797
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.ScriptCode">ScriptCode</a>
|
|
7648
7798
|
|
|
7649
7799
|
---
|
|
7650
7800
|
|
|
7651
7801
|
##### `inputs`<sup>Required</sup> <a name="inputs" id="@cdklabs/cdk-ssm-documents.ExecuteScriptStep.property.inputs"></a>
|
|
7652
7802
|
|
|
7653
7803
|
```typescript
|
|
7654
|
-
public readonly inputs: string
|
|
7804
|
+
public readonly inputs: {[ key: string ]: IGenericVariable};
|
|
7655
7805
|
```
|
|
7656
7806
|
|
|
7657
|
-
- *Type:* string
|
|
7807
|
+
- *Type:* {[ key: string ]: <a href="#@cdklabs/cdk-ssm-documents.IGenericVariable">IGenericVariable</a>}
|
|
7658
7808
|
|
|
7659
7809
|
---
|
|
7660
7810
|
|
|
@@ -7849,6 +7999,7 @@ Any object.
|
|
|
7849
7999
|
| <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
8000
|
| <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
8001
|
| <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteStateMachineStep.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</code> | *No description.* |
|
|
8002
|
+
| <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
8003
|
| <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
8004
|
| <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
8005
|
| <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 +8120,16 @@ public readonly timeoutSeconds: number;
|
|
|
7969
8120
|
|
|
7970
8121
|
---
|
|
7971
8122
|
|
|
8123
|
+
##### `explicitNextStep`<sup>Optional</sup> <a name="explicitNextStep" id="@cdklabs/cdk-ssm-documents.ExecuteStateMachineStep.property.explicitNextStep"></a>
|
|
8124
|
+
|
|
8125
|
+
```typescript
|
|
8126
|
+
public readonly explicitNextStep: StepRef;
|
|
8127
|
+
```
|
|
8128
|
+
|
|
8129
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a>
|
|
8130
|
+
|
|
8131
|
+
---
|
|
8132
|
+
|
|
7972
8133
|
##### `allStepsInExecution`<sup>Optional</sup> <a name="allStepsInExecution" id="@cdklabs/cdk-ssm-documents.ExecuteStateMachineStep.property.allStepsInExecution"></a>
|
|
7973
8134
|
|
|
7974
8135
|
```typescript
|
|
@@ -8936,6 +9097,7 @@ Any object.
|
|
|
8936
9097
|
| <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
9098
|
| <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
9099
|
| <code><a href="#@cdklabs/cdk-ssm-documents.InvokeLambdaFunctionStep.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</code> | *No description.* |
|
|
9100
|
+
| <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
9101
|
| <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
9102
|
| <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
9103
|
| <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 +9222,16 @@ public readonly timeoutSeconds: number;
|
|
|
9060
9222
|
|
|
9061
9223
|
---
|
|
9062
9224
|
|
|
9225
|
+
##### `explicitNextStep`<sup>Optional</sup> <a name="explicitNextStep" id="@cdklabs/cdk-ssm-documents.InvokeLambdaFunctionStep.property.explicitNextStep"></a>
|
|
9226
|
+
|
|
9227
|
+
```typescript
|
|
9228
|
+
public readonly explicitNextStep: StepRef;
|
|
9229
|
+
```
|
|
9230
|
+
|
|
9231
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a>
|
|
9232
|
+
|
|
9233
|
+
---
|
|
9234
|
+
|
|
9063
9235
|
##### `allStepsInExecution`<sup>Optional</sup> <a name="allStepsInExecution" id="@cdklabs/cdk-ssm-documents.InvokeLambdaFunctionStep.property.allStepsInExecution"></a>
|
|
9064
9236
|
|
|
9065
9237
|
```typescript
|
|
@@ -9321,6 +9493,7 @@ Any object.
|
|
|
9321
9493
|
| <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
9494
|
| <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
9495
|
| <code><a href="#@cdklabs/cdk-ssm-documents.InvokeWebhookStep.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</code> | *No description.* |
|
|
9496
|
+
| <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
9497
|
| <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
9498
|
| <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
9499
|
| <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 +9613,16 @@ public readonly timeoutSeconds: number;
|
|
|
9440
9613
|
|
|
9441
9614
|
---
|
|
9442
9615
|
|
|
9616
|
+
##### `explicitNextStep`<sup>Optional</sup> <a name="explicitNextStep" id="@cdklabs/cdk-ssm-documents.InvokeWebhookStep.property.explicitNextStep"></a>
|
|
9617
|
+
|
|
9618
|
+
```typescript
|
|
9619
|
+
public readonly explicitNextStep: StepRef;
|
|
9620
|
+
```
|
|
9621
|
+
|
|
9622
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a>
|
|
9623
|
+
|
|
9624
|
+
---
|
|
9625
|
+
|
|
9443
9626
|
##### `allStepsInExecution`<sup>Optional</sup> <a name="allStepsInExecution" id="@cdklabs/cdk-ssm-documents.InvokeWebhookStep.property.allStepsInExecution"></a>
|
|
9444
9627
|
|
|
9445
9628
|
```typescript
|
|
@@ -9651,6 +9834,7 @@ Any object.
|
|
|
9651
9834
|
| <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
9835
|
| <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
9836
|
| <code><a href="#@cdklabs/cdk-ssm-documents.PauseStep.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</code> | *No description.* |
|
|
9837
|
+
| <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
9838
|
| <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
9839
|
| <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
9840
|
|
|
@@ -9768,6 +9952,16 @@ public readonly timeoutSeconds: number;
|
|
|
9768
9952
|
|
|
9769
9953
|
---
|
|
9770
9954
|
|
|
9955
|
+
##### `explicitNextStep`<sup>Optional</sup> <a name="explicitNextStep" id="@cdklabs/cdk-ssm-documents.PauseStep.property.explicitNextStep"></a>
|
|
9956
|
+
|
|
9957
|
+
```typescript
|
|
9958
|
+
public readonly explicitNextStep: StepRef;
|
|
9959
|
+
```
|
|
9960
|
+
|
|
9961
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a>
|
|
9962
|
+
|
|
9963
|
+
---
|
|
9964
|
+
|
|
9771
9965
|
##### `allStepsInExecution`<sup>Optional</sup> <a name="allStepsInExecution" id="@cdklabs/cdk-ssm-documents.PauseStep.property.allStepsInExecution"></a>
|
|
9772
9966
|
|
|
9773
9967
|
```typescript
|
|
@@ -10439,6 +10633,7 @@ Any object.
|
|
|
10439
10633
|
| <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
10634
|
| <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
10635
|
| <code><a href="#@cdklabs/cdk-ssm-documents.RunCommandStep.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</code> | *No description.* |
|
|
10636
|
+
| <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
10637
|
| <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
10638
|
| <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
10639
|
| <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 +10765,16 @@ public readonly timeoutSeconds: number;
|
|
|
10570
10765
|
|
|
10571
10766
|
---
|
|
10572
10767
|
|
|
10768
|
+
##### `explicitNextStep`<sup>Optional</sup> <a name="explicitNextStep" id="@cdklabs/cdk-ssm-documents.RunCommandStep.property.explicitNextStep"></a>
|
|
10769
|
+
|
|
10770
|
+
```typescript
|
|
10771
|
+
public readonly explicitNextStep: StepRef;
|
|
10772
|
+
```
|
|
10773
|
+
|
|
10774
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a>
|
|
10775
|
+
|
|
10776
|
+
---
|
|
10777
|
+
|
|
10573
10778
|
##### `allStepsInExecution`<sup>Optional</sup> <a name="allStepsInExecution" id="@cdklabs/cdk-ssm-documents.RunCommandStep.property.allStepsInExecution"></a>
|
|
10574
10779
|
|
|
10575
10780
|
```typescript
|
|
@@ -11615,6 +11820,7 @@ Any object.
|
|
|
11615
11820
|
| <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
11821
|
| <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
11822
|
| <code><a href="#@cdklabs/cdk-ssm-documents.RunInstanceStep.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</code> | *No description.* |
|
|
11823
|
+
| <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
11824
|
| <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
11825
|
| <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
11826
|
| <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 +11962,16 @@ public readonly timeoutSeconds: number;
|
|
|
11756
11962
|
|
|
11757
11963
|
---
|
|
11758
11964
|
|
|
11965
|
+
##### `explicitNextStep`<sup>Optional</sup> <a name="explicitNextStep" id="@cdklabs/cdk-ssm-documents.RunInstanceStep.property.explicitNextStep"></a>
|
|
11966
|
+
|
|
11967
|
+
```typescript
|
|
11968
|
+
public readonly explicitNextStep: StepRef;
|
|
11969
|
+
```
|
|
11970
|
+
|
|
11971
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a>
|
|
11972
|
+
|
|
11973
|
+
---
|
|
11974
|
+
|
|
11759
11975
|
##### `allStepsInExecution`<sup>Optional</sup> <a name="allStepsInExecution" id="@cdklabs/cdk-ssm-documents.RunInstanceStep.property.allStepsInExecution"></a>
|
|
11760
11976
|
|
|
11761
11977
|
```typescript
|
|
@@ -12835,6 +13051,7 @@ Any object.
|
|
|
12835
13051
|
| <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
13052
|
| <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
13053
|
| <code><a href="#@cdklabs/cdk-ssm-documents.SleepStep.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</code> | *No description.* |
|
|
13054
|
+
| <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
13055
|
| <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
13056
|
| <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
13057
|
| <code><a href="#@cdklabs/cdk-ssm-documents.SleepStep.property.sleepSeconds">sleepSeconds</a></code> | <code>number</code> | *No description.* |
|
|
@@ -12953,6 +13170,16 @@ public readonly timeoutSeconds: number;
|
|
|
12953
13170
|
|
|
12954
13171
|
---
|
|
12955
13172
|
|
|
13173
|
+
##### `explicitNextStep`<sup>Optional</sup> <a name="explicitNextStep" id="@cdklabs/cdk-ssm-documents.SleepStep.property.explicitNextStep"></a>
|
|
13174
|
+
|
|
13175
|
+
```typescript
|
|
13176
|
+
public readonly explicitNextStep: StepRef;
|
|
13177
|
+
```
|
|
13178
|
+
|
|
13179
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a>
|
|
13180
|
+
|
|
13181
|
+
---
|
|
13182
|
+
|
|
12956
13183
|
##### `allStepsInExecution`<sup>Optional</sup> <a name="allStepsInExecution" id="@cdklabs/cdk-ssm-documents.SleepStep.property.allStepsInExecution"></a>
|
|
12957
13184
|
|
|
12958
13185
|
```typescript
|
|
@@ -13516,6 +13743,7 @@ Any object.
|
|
|
13516
13743
|
| **Name** | **Type** | **Description** |
|
|
13517
13744
|
| --- | --- | --- |
|
|
13518
13745
|
| <code><a href="#@cdklabs/cdk-ssm-documents.SsmDocument.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
|
|
13746
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.SsmDocument.property.cfnDocument">cfnDocument</a></code> | <code>aws-cdk-lib.aws_ssm.CfnDocument</code> | *No description.* |
|
|
13519
13747
|
| <code><a href="#@cdklabs/cdk-ssm-documents.SsmDocument.property.description">description</a></code> | <code>string</code> | *No description.* |
|
|
13520
13748
|
| <code><a href="#@cdklabs/cdk-ssm-documents.SsmDocument.property.docInputs">docInputs</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.Input">Input</a>[]</code> | *No description.* |
|
|
13521
13749
|
| <code><a href="#@cdklabs/cdk-ssm-documents.SsmDocument.property.docOutputs">docOutputs</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.DocumentOutput">DocumentOutput</a>[]</code> | *No description.* |
|
|
@@ -13538,6 +13766,16 @@ The tree node.
|
|
|
13538
13766
|
|
|
13539
13767
|
---
|
|
13540
13768
|
|
|
13769
|
+
##### `cfnDocument`<sup>Required</sup> <a name="cfnDocument" id="@cdklabs/cdk-ssm-documents.SsmDocument.property.cfnDocument"></a>
|
|
13770
|
+
|
|
13771
|
+
```typescript
|
|
13772
|
+
public readonly cfnDocument: CfnDocument;
|
|
13773
|
+
```
|
|
13774
|
+
|
|
13775
|
+
- *Type:* aws-cdk-lib.aws_ssm.CfnDocument
|
|
13776
|
+
|
|
13777
|
+
---
|
|
13778
|
+
|
|
13541
13779
|
##### `description`<sup>Required</sup> <a name="description" id="@cdklabs/cdk-ssm-documents.SsmDocument.property.description"></a>
|
|
13542
13780
|
|
|
13543
13781
|
```typescript
|
|
@@ -14074,6 +14312,7 @@ Any object.
|
|
|
14074
14312
|
| **Name** | **Type** | **Description** |
|
|
14075
14313
|
| --- | --- | --- |
|
|
14076
14314
|
| <code><a href="#@cdklabs/cdk-ssm-documents.TimedDocument.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
|
|
14315
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.TimedDocument.property.cfnDocument">cfnDocument</a></code> | <code>aws-cdk-lib.aws_ssm.CfnDocument</code> | *No description.* |
|
|
14077
14316
|
| <code><a href="#@cdklabs/cdk-ssm-documents.TimedDocument.property.description">description</a></code> | <code>string</code> | *No description.* |
|
|
14078
14317
|
| <code><a href="#@cdklabs/cdk-ssm-documents.TimedDocument.property.docInputs">docInputs</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.Input">Input</a>[]</code> | *No description.* |
|
|
14079
14318
|
| <code><a href="#@cdklabs/cdk-ssm-documents.TimedDocument.property.docOutputs">docOutputs</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.DocumentOutput">DocumentOutput</a>[]</code> | *No description.* |
|
|
@@ -14097,6 +14336,16 @@ The tree node.
|
|
|
14097
14336
|
|
|
14098
14337
|
---
|
|
14099
14338
|
|
|
14339
|
+
##### `cfnDocument`<sup>Required</sup> <a name="cfnDocument" id="@cdklabs/cdk-ssm-documents.TimedDocument.property.cfnDocument"></a>
|
|
14340
|
+
|
|
14341
|
+
```typescript
|
|
14342
|
+
public readonly cfnDocument: CfnDocument;
|
|
14343
|
+
```
|
|
14344
|
+
|
|
14345
|
+
- *Type:* aws-cdk-lib.aws_ssm.CfnDocument
|
|
14346
|
+
|
|
14347
|
+
---
|
|
14348
|
+
|
|
14100
14349
|
##### `description`<sup>Required</sup> <a name="description" id="@cdklabs/cdk-ssm-documents.TimedDocument.property.description"></a>
|
|
14101
14350
|
|
|
14102
14351
|
```typescript
|
|
@@ -14990,6 +15239,7 @@ Any object.
|
|
|
14990
15239
|
| <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
15240
|
| <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
15241
|
| <code><a href="#@cdklabs/cdk-ssm-documents.WaitForResourceStep.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</code> | *No description.* |
|
|
15242
|
+
| <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
15243
|
| <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
15244
|
| <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
15245
|
| <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 +15365,16 @@ public readonly timeoutSeconds: number;
|
|
|
15115
15365
|
|
|
15116
15366
|
---
|
|
15117
15367
|
|
|
15368
|
+
##### `explicitNextStep`<sup>Optional</sup> <a name="explicitNextStep" id="@cdklabs/cdk-ssm-documents.WaitForResourceStep.property.explicitNextStep"></a>
|
|
15369
|
+
|
|
15370
|
+
```typescript
|
|
15371
|
+
public readonly explicitNextStep: StepRef;
|
|
15372
|
+
```
|
|
15373
|
+
|
|
15374
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a>
|
|
15375
|
+
|
|
15376
|
+
---
|
|
15377
|
+
|
|
15118
15378
|
##### `allStepsInExecution`<sup>Optional</sup> <a name="allStepsInExecution" id="@cdklabs/cdk-ssm-documents.WaitForResourceStep.property.allStepsInExecution"></a>
|
|
15119
15379
|
|
|
15120
15380
|
```typescript
|
|
@@ -15583,6 +15843,7 @@ const approveStepProps: ApproveStepProps = { ... }
|
|
|
15583
15843
|
| <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
15844
|
| <code><a href="#@cdklabs/cdk-ssm-documents.ApproveStepProps.property.name">name</a></code> | <code>string</code> | (Optional) Name of the current step. |
|
|
15585
15845
|
| <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. |
|
|
15846
|
+
| <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
15847
|
| <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
15848
|
| <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
15849
|
| <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 +15911,21 @@ public readonly outputObserver: IObserver;
|
|
|
15650
15911
|
|
|
15651
15912
|
---
|
|
15652
15913
|
|
|
15914
|
+
##### `explicitNextStep`<sup>Optional</sup> <a name="explicitNextStep" id="@cdklabs/cdk-ssm-documents.ApproveStepProps.property.explicitNextStep"></a>
|
|
15915
|
+
|
|
15916
|
+
```typescript
|
|
15917
|
+
public readonly explicitNextStep: StepRef;
|
|
15918
|
+
```
|
|
15919
|
+
|
|
15920
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a>
|
|
15921
|
+
- *Default:* will implicitly choose the next step in the sequence that the steps are added to the document.
|
|
15922
|
+
|
|
15923
|
+
(Optional) explicit step to go to after this step completes.
|
|
15924
|
+
|
|
15925
|
+
https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-actions.html#nextProp
|
|
15926
|
+
|
|
15927
|
+
---
|
|
15928
|
+
|
|
15653
15929
|
##### `isEnd`<sup>Optional</sup> <a name="isEnd" id="@cdklabs/cdk-ssm-documents.ApproveStepProps.property.isEnd"></a>
|
|
15654
15930
|
|
|
15655
15931
|
```typescript
|
|
@@ -15799,6 +16075,7 @@ const assertAwsResourceStepProps: AssertAwsResourceStepProps = { ... }
|
|
|
15799
16075
|
| <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
16076
|
| <code><a href="#@cdklabs/cdk-ssm-documents.AssertAwsResourceStepProps.property.name">name</a></code> | <code>string</code> | (Optional) Name of the current step. |
|
|
15801
16077
|
| <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. |
|
|
16078
|
+
| <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
16079
|
| <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
16080
|
| <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
16081
|
| <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 +16145,21 @@ public readonly outputObserver: IObserver;
|
|
|
15868
16145
|
|
|
15869
16146
|
---
|
|
15870
16147
|
|
|
16148
|
+
##### `explicitNextStep`<sup>Optional</sup> <a name="explicitNextStep" id="@cdklabs/cdk-ssm-documents.AssertAwsResourceStepProps.property.explicitNextStep"></a>
|
|
16149
|
+
|
|
16150
|
+
```typescript
|
|
16151
|
+
public readonly explicitNextStep: StepRef;
|
|
16152
|
+
```
|
|
16153
|
+
|
|
16154
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a>
|
|
16155
|
+
- *Default:* will implicitly choose the next step in the sequence that the steps are added to the document.
|
|
16156
|
+
|
|
16157
|
+
(Optional) explicit step to go to after this step completes.
|
|
16158
|
+
|
|
16159
|
+
https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-actions.html#nextProp
|
|
16160
|
+
|
|
16161
|
+
---
|
|
16162
|
+
|
|
15871
16163
|
##### `isEnd`<sup>Optional</sup> <a name="isEnd" id="@cdklabs/cdk-ssm-documents.AssertAwsResourceStepProps.property.isEnd"></a>
|
|
15872
16164
|
|
|
15873
16165
|
```typescript
|
|
@@ -16407,6 +16699,7 @@ const automationStepProps: AutomationStepProps = { ... }
|
|
|
16407
16699
|
| <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
16700
|
| <code><a href="#@cdklabs/cdk-ssm-documents.AutomationStepProps.property.name">name</a></code> | <code>string</code> | (Optional) Name of the current step. |
|
|
16409
16701
|
| <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. |
|
|
16702
|
+
| <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
16703
|
| <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
16704
|
| <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
16705
|
| <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 +16763,21 @@ public readonly outputObserver: IObserver;
|
|
|
16470
16763
|
|
|
16471
16764
|
---
|
|
16472
16765
|
|
|
16766
|
+
##### `explicitNextStep`<sup>Optional</sup> <a name="explicitNextStep" id="@cdklabs/cdk-ssm-documents.AutomationStepProps.property.explicitNextStep"></a>
|
|
16767
|
+
|
|
16768
|
+
```typescript
|
|
16769
|
+
public readonly explicitNextStep: StepRef;
|
|
16770
|
+
```
|
|
16771
|
+
|
|
16772
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a>
|
|
16773
|
+
- *Default:* will implicitly choose the next step in the sequence that the steps are added to the document.
|
|
16774
|
+
|
|
16775
|
+
(Optional) explicit step to go to after this step completes.
|
|
16776
|
+
|
|
16777
|
+
https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-actions.html#nextProp
|
|
16778
|
+
|
|
16779
|
+
---
|
|
16780
|
+
|
|
16473
16781
|
##### `isEnd`<sup>Optional</sup> <a name="isEnd" id="@cdklabs/cdk-ssm-documents.AutomationStepProps.property.isEnd"></a>
|
|
16474
16782
|
|
|
16475
16783
|
```typescript
|
|
@@ -16557,6 +16865,7 @@ const awsApiStepProps: AwsApiStepProps = { ... }
|
|
|
16557
16865
|
| <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
16866
|
| <code><a href="#@cdklabs/cdk-ssm-documents.AwsApiStepProps.property.name">name</a></code> | <code>string</code> | (Optional) Name of the current step. |
|
|
16559
16867
|
| <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. |
|
|
16868
|
+
| <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
16869
|
| <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
16870
|
| <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
16871
|
| <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 +16934,21 @@ public readonly outputObserver: IObserver;
|
|
|
16625
16934
|
|
|
16626
16935
|
---
|
|
16627
16936
|
|
|
16937
|
+
##### `explicitNextStep`<sup>Optional</sup> <a name="explicitNextStep" id="@cdklabs/cdk-ssm-documents.AwsApiStepProps.property.explicitNextStep"></a>
|
|
16938
|
+
|
|
16939
|
+
```typescript
|
|
16940
|
+
public readonly explicitNextStep: StepRef;
|
|
16941
|
+
```
|
|
16942
|
+
|
|
16943
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a>
|
|
16944
|
+
- *Default:* will implicitly choose the next step in the sequence that the steps are added to the document.
|
|
16945
|
+
|
|
16946
|
+
(Optional) explicit step to go to after this step completes.
|
|
16947
|
+
|
|
16948
|
+
https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-actions.html#nextProp
|
|
16949
|
+
|
|
16950
|
+
---
|
|
16951
|
+
|
|
16628
16952
|
##### `isEnd`<sup>Optional</sup> <a name="isEnd" id="@cdklabs/cdk-ssm-documents.AwsApiStepProps.property.isEnd"></a>
|
|
16629
16953
|
|
|
16630
16954
|
```typescript
|
|
@@ -16807,6 +17131,7 @@ const awsInvocationProps: AwsInvocationProps = { ... }
|
|
|
16807
17131
|
| <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
17132
|
| <code><a href="#@cdklabs/cdk-ssm-documents.AwsInvocationProps.property.name">name</a></code> | <code>string</code> | (Optional) Name of the current step. |
|
|
16809
17133
|
| <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. |
|
|
17134
|
+
| <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
17135
|
| <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
17136
|
| <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
17137
|
| <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 +17199,21 @@ public readonly outputObserver: IObserver;
|
|
|
16874
17199
|
|
|
16875
17200
|
---
|
|
16876
17201
|
|
|
17202
|
+
##### `explicitNextStep`<sup>Optional</sup> <a name="explicitNextStep" id="@cdklabs/cdk-ssm-documents.AwsInvocationProps.property.explicitNextStep"></a>
|
|
17203
|
+
|
|
17204
|
+
```typescript
|
|
17205
|
+
public readonly explicitNextStep: StepRef;
|
|
17206
|
+
```
|
|
17207
|
+
|
|
17208
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a>
|
|
17209
|
+
- *Default:* will implicitly choose the next step in the sequence that the steps are added to the document.
|
|
17210
|
+
|
|
17211
|
+
(Optional) explicit step to go to after this step completes.
|
|
17212
|
+
|
|
17213
|
+
https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-actions.html#nextProp
|
|
17214
|
+
|
|
17215
|
+
---
|
|
17216
|
+
|
|
16877
17217
|
##### `isEnd`<sup>Optional</sup> <a name="isEnd" id="@cdklabs/cdk-ssm-documents.AwsInvocationProps.property.isEnd"></a>
|
|
16878
17218
|
|
|
16879
17219
|
```typescript
|
|
@@ -17165,6 +17505,7 @@ const branchStepProps: BranchStepProps = { ... }
|
|
|
17165
17505
|
| <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
17506
|
| <code><a href="#@cdklabs/cdk-ssm-documents.BranchStepProps.property.name">name</a></code> | <code>string</code> | (Optional) Name of the current step. |
|
|
17167
17507
|
| <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. |
|
|
17508
|
+
| <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
17509
|
| <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
17510
|
| <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
17511
|
| <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 +17571,21 @@ public readonly outputObserver: IObserver;
|
|
|
17230
17571
|
|
|
17231
17572
|
---
|
|
17232
17573
|
|
|
17574
|
+
##### `explicitNextStep`<sup>Optional</sup> <a name="explicitNextStep" id="@cdklabs/cdk-ssm-documents.BranchStepProps.property.explicitNextStep"></a>
|
|
17575
|
+
|
|
17576
|
+
```typescript
|
|
17577
|
+
public readonly explicitNextStep: StepRef;
|
|
17578
|
+
```
|
|
17579
|
+
|
|
17580
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a>
|
|
17581
|
+
- *Default:* will implicitly choose the next step in the sequence that the steps are added to the document.
|
|
17582
|
+
|
|
17583
|
+
(Optional) explicit step to go to after this step completes.
|
|
17584
|
+
|
|
17585
|
+
https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-actions.html#nextProp
|
|
17586
|
+
|
|
17587
|
+
---
|
|
17588
|
+
|
|
17233
17589
|
##### `isEnd`<sup>Optional</sup> <a name="isEnd" id="@cdklabs/cdk-ssm-documents.BranchStepProps.property.isEnd"></a>
|
|
17234
17590
|
|
|
17235
17591
|
```typescript
|
|
@@ -17344,6 +17700,7 @@ const changeInstanceStateSimulationProps: ChangeInstanceStateSimulationProps = {
|
|
|
17344
17700
|
| <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
17701
|
| <code><a href="#@cdklabs/cdk-ssm-documents.ChangeInstanceStateSimulationProps.property.name">name</a></code> | <code>string</code> | (Optional) Name of the current step. |
|
|
17346
17702
|
| <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. |
|
|
17703
|
+
| <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
17704
|
| <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
17705
|
| <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
17706
|
| <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 +17765,21 @@ public readonly outputObserver: IObserver;
|
|
|
17408
17765
|
|
|
17409
17766
|
---
|
|
17410
17767
|
|
|
17768
|
+
##### `explicitNextStep`<sup>Optional</sup> <a name="explicitNextStep" id="@cdklabs/cdk-ssm-documents.ChangeInstanceStateSimulationProps.property.explicitNextStep"></a>
|
|
17769
|
+
|
|
17770
|
+
```typescript
|
|
17771
|
+
public readonly explicitNextStep: StepRef;
|
|
17772
|
+
```
|
|
17773
|
+
|
|
17774
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a>
|
|
17775
|
+
- *Default:* will implicitly choose the next step in the sequence that the steps are added to the document.
|
|
17776
|
+
|
|
17777
|
+
(Optional) explicit step to go to after this step completes.
|
|
17778
|
+
|
|
17779
|
+
https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-actions.html#nextProp
|
|
17780
|
+
|
|
17781
|
+
---
|
|
17782
|
+
|
|
17411
17783
|
##### `isEnd`<sup>Optional</sup> <a name="isEnd" id="@cdklabs/cdk-ssm-documents.ChangeInstanceStateSimulationProps.property.isEnd"></a>
|
|
17412
17784
|
|
|
17413
17785
|
```typescript
|
|
@@ -17508,6 +17880,7 @@ const changeInstanceStateStepProps: ChangeInstanceStateStepProps = { ... }
|
|
|
17508
17880
|
| <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
17881
|
| <code><a href="#@cdklabs/cdk-ssm-documents.ChangeInstanceStateStepProps.property.name">name</a></code> | <code>string</code> | (Optional) Name of the current step. |
|
|
17510
17882
|
| <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. |
|
|
17883
|
+
| <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
17884
|
| <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
17885
|
| <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
17886
|
| <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 +17949,21 @@ public readonly outputObserver: IObserver;
|
|
|
17576
17949
|
|
|
17577
17950
|
---
|
|
17578
17951
|
|
|
17952
|
+
##### `explicitNextStep`<sup>Optional</sup> <a name="explicitNextStep" id="@cdklabs/cdk-ssm-documents.ChangeInstanceStateStepProps.property.explicitNextStep"></a>
|
|
17953
|
+
|
|
17954
|
+
```typescript
|
|
17955
|
+
public readonly explicitNextStep: StepRef;
|
|
17956
|
+
```
|
|
17957
|
+
|
|
17958
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a>
|
|
17959
|
+
- *Default:* will implicitly choose the next step in the sequence that the steps are added to the document.
|
|
17960
|
+
|
|
17961
|
+
(Optional) explicit step to go to after this step completes.
|
|
17962
|
+
|
|
17963
|
+
https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-actions.html#nextProp
|
|
17964
|
+
|
|
17965
|
+
---
|
|
17966
|
+
|
|
17579
17967
|
##### `isEnd`<sup>Optional</sup> <a name="isEnd" id="@cdklabs/cdk-ssm-documents.ChangeInstanceStateStepProps.property.isEnd"></a>
|
|
17580
17968
|
|
|
17581
17969
|
```typescript
|
|
@@ -18616,6 +19004,7 @@ const copyImageStepProps: CopyImageStepProps = { ... }
|
|
|
18616
19004
|
| <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
19005
|
| <code><a href="#@cdklabs/cdk-ssm-documents.CopyImageStepProps.property.name">name</a></code> | <code>string</code> | (Optional) Name of the current step. |
|
|
18618
19006
|
| <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. |
|
|
19007
|
+
| <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
19008
|
| <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
19009
|
| <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
19010
|
| <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 +19075,21 @@ public readonly outputObserver: IObserver;
|
|
|
18686
19075
|
|
|
18687
19076
|
---
|
|
18688
19077
|
|
|
19078
|
+
##### `explicitNextStep`<sup>Optional</sup> <a name="explicitNextStep" id="@cdklabs/cdk-ssm-documents.CopyImageStepProps.property.explicitNextStep"></a>
|
|
19079
|
+
|
|
19080
|
+
```typescript
|
|
19081
|
+
public readonly explicitNextStep: StepRef;
|
|
19082
|
+
```
|
|
19083
|
+
|
|
19084
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a>
|
|
19085
|
+
- *Default:* will implicitly choose the next step in the sequence that the steps are added to the document.
|
|
19086
|
+
|
|
19087
|
+
(Optional) explicit step to go to after this step completes.
|
|
19088
|
+
|
|
19089
|
+
https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-actions.html#nextProp
|
|
19090
|
+
|
|
19091
|
+
---
|
|
19092
|
+
|
|
18689
19093
|
##### `isEnd`<sup>Optional</sup> <a name="isEnd" id="@cdklabs/cdk-ssm-documents.CopyImageStepProps.property.isEnd"></a>
|
|
18690
19094
|
|
|
18691
19095
|
```typescript
|
|
@@ -18857,6 +19261,7 @@ const createImageStepProps: CreateImageStepProps = { ... }
|
|
|
18857
19261
|
| <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
19262
|
| <code><a href="#@cdklabs/cdk-ssm-documents.CreateImageStepProps.property.name">name</a></code> | <code>string</code> | (Optional) Name of the current step. |
|
|
18859
19263
|
| <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. |
|
|
19264
|
+
| <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
19265
|
| <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
19266
|
| <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
19267
|
| <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 +19330,21 @@ public readonly outputObserver: IObserver;
|
|
|
18925
19330
|
|
|
18926
19331
|
---
|
|
18927
19332
|
|
|
19333
|
+
##### `explicitNextStep`<sup>Optional</sup> <a name="explicitNextStep" id="@cdklabs/cdk-ssm-documents.CreateImageStepProps.property.explicitNextStep"></a>
|
|
19334
|
+
|
|
19335
|
+
```typescript
|
|
19336
|
+
public readonly explicitNextStep: StepRef;
|
|
19337
|
+
```
|
|
19338
|
+
|
|
19339
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a>
|
|
19340
|
+
- *Default:* will implicitly choose the next step in the sequence that the steps are added to the document.
|
|
19341
|
+
|
|
19342
|
+
(Optional) explicit step to go to after this step completes.
|
|
19343
|
+
|
|
19344
|
+
https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-actions.html#nextProp
|
|
19345
|
+
|
|
19346
|
+
---
|
|
19347
|
+
|
|
18928
19348
|
##### `isEnd`<sup>Optional</sup> <a name="isEnd" id="@cdklabs/cdk-ssm-documents.CreateImageStepProps.property.isEnd"></a>
|
|
18929
19349
|
|
|
18930
19350
|
```typescript
|
|
@@ -19140,6 +19560,7 @@ const createStackStepProps: CreateStackStepProps = { ... }
|
|
|
19140
19560
|
| <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
19561
|
| <code><a href="#@cdklabs/cdk-ssm-documents.CreateStackStepProps.property.name">name</a></code> | <code>string</code> | (Optional) Name of the current step. |
|
|
19142
19562
|
| <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. |
|
|
19563
|
+
| <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
19564
|
| <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
19565
|
| <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
19566
|
| <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 +19636,21 @@ public readonly outputObserver: IObserver;
|
|
|
19215
19636
|
|
|
19216
19637
|
---
|
|
19217
19638
|
|
|
19639
|
+
##### `explicitNextStep`<sup>Optional</sup> <a name="explicitNextStep" id="@cdklabs/cdk-ssm-documents.CreateStackStepProps.property.explicitNextStep"></a>
|
|
19640
|
+
|
|
19641
|
+
```typescript
|
|
19642
|
+
public readonly explicitNextStep: StepRef;
|
|
19643
|
+
```
|
|
19644
|
+
|
|
19645
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a>
|
|
19646
|
+
- *Default:* will implicitly choose the next step in the sequence that the steps are added to the document.
|
|
19647
|
+
|
|
19648
|
+
(Optional) explicit step to go to after this step completes.
|
|
19649
|
+
|
|
19650
|
+
https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-actions.html#nextProp
|
|
19651
|
+
|
|
19652
|
+
---
|
|
19653
|
+
|
|
19218
19654
|
##### `isEnd`<sup>Optional</sup> <a name="isEnd" id="@cdklabs/cdk-ssm-documents.CreateStackStepProps.property.isEnd"></a>
|
|
19219
19655
|
|
|
19220
19656
|
```typescript
|
|
@@ -19527,6 +19963,7 @@ const createTagsStepProps: CreateTagsStepProps = { ... }
|
|
|
19527
19963
|
| <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
19964
|
| <code><a href="#@cdklabs/cdk-ssm-documents.CreateTagsStepProps.property.name">name</a></code> | <code>string</code> | (Optional) Name of the current step. |
|
|
19529
19965
|
| <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. |
|
|
19966
|
+
| <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
19967
|
| <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
19968
|
| <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
19969
|
| <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 +20030,21 @@ public readonly outputObserver: IObserver;
|
|
|
19593
20030
|
|
|
19594
20031
|
---
|
|
19595
20032
|
|
|
20033
|
+
##### `explicitNextStep`<sup>Optional</sup> <a name="explicitNextStep" id="@cdklabs/cdk-ssm-documents.CreateTagsStepProps.property.explicitNextStep"></a>
|
|
20034
|
+
|
|
20035
|
+
```typescript
|
|
20036
|
+
public readonly explicitNextStep: StepRef;
|
|
20037
|
+
```
|
|
20038
|
+
|
|
20039
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a>
|
|
20040
|
+
- *Default:* will implicitly choose the next step in the sequence that the steps are added to the document.
|
|
20041
|
+
|
|
20042
|
+
(Optional) explicit step to go to after this step completes.
|
|
20043
|
+
|
|
20044
|
+
https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-actions.html#nextProp
|
|
20045
|
+
|
|
20046
|
+
---
|
|
20047
|
+
|
|
19596
20048
|
##### `isEnd`<sup>Optional</sup> <a name="isEnd" id="@cdklabs/cdk-ssm-documents.CreateTagsStepProps.property.isEnd"></a>
|
|
19597
20049
|
|
|
19598
20050
|
```typescript
|
|
@@ -19770,6 +20222,7 @@ const deleteImageStepProps: DeleteImageStepProps = { ... }
|
|
|
19770
20222
|
| <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
20223
|
| <code><a href="#@cdklabs/cdk-ssm-documents.DeleteImageStepProps.property.name">name</a></code> | <code>string</code> | (Optional) Name of the current step. |
|
|
19772
20224
|
| <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. |
|
|
20225
|
+
| <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
20226
|
| <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
20227
|
| <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
20228
|
| <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 +20287,21 @@ public readonly outputObserver: IObserver;
|
|
|
19834
20287
|
|
|
19835
20288
|
---
|
|
19836
20289
|
|
|
20290
|
+
##### `explicitNextStep`<sup>Optional</sup> <a name="explicitNextStep" id="@cdklabs/cdk-ssm-documents.DeleteImageStepProps.property.explicitNextStep"></a>
|
|
20291
|
+
|
|
20292
|
+
```typescript
|
|
20293
|
+
public readonly explicitNextStep: StepRef;
|
|
20294
|
+
```
|
|
20295
|
+
|
|
20296
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a>
|
|
20297
|
+
- *Default:* will implicitly choose the next step in the sequence that the steps are added to the document.
|
|
20298
|
+
|
|
20299
|
+
(Optional) explicit step to go to after this step completes.
|
|
20300
|
+
|
|
20301
|
+
https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-actions.html#nextProp
|
|
20302
|
+
|
|
20303
|
+
---
|
|
20304
|
+
|
|
19837
20305
|
##### `isEnd`<sup>Optional</sup> <a name="isEnd" id="@cdklabs/cdk-ssm-documents.DeleteImageStepProps.property.isEnd"></a>
|
|
19838
20306
|
|
|
19839
20307
|
```typescript
|
|
@@ -19933,6 +20401,7 @@ const deleteStackStepProps: DeleteStackStepProps = { ... }
|
|
|
19933
20401
|
| <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
20402
|
| <code><a href="#@cdklabs/cdk-ssm-documents.DeleteStackStepProps.property.name">name</a></code> | <code>string</code> | (Optional) Name of the current step. |
|
|
19935
20403
|
| <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. |
|
|
20404
|
+
| <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
20405
|
| <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
20406
|
| <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
20407
|
| <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 +20467,21 @@ public readonly outputObserver: IObserver;
|
|
|
19998
20467
|
|
|
19999
20468
|
---
|
|
20000
20469
|
|
|
20470
|
+
##### `explicitNextStep`<sup>Optional</sup> <a name="explicitNextStep" id="@cdklabs/cdk-ssm-documents.DeleteStackStepProps.property.explicitNextStep"></a>
|
|
20471
|
+
|
|
20472
|
+
```typescript
|
|
20473
|
+
public readonly explicitNextStep: StepRef;
|
|
20474
|
+
```
|
|
20475
|
+
|
|
20476
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a>
|
|
20477
|
+
- *Default:* will implicitly choose the next step in the sequence that the steps are added to the document.
|
|
20478
|
+
|
|
20479
|
+
(Optional) explicit step to go to after this step completes.
|
|
20480
|
+
|
|
20481
|
+
https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-actions.html#nextProp
|
|
20482
|
+
|
|
20483
|
+
---
|
|
20484
|
+
|
|
20001
20485
|
##### `isEnd`<sup>Optional</sup> <a name="isEnd" id="@cdklabs/cdk-ssm-documents.DeleteStackStepProps.property.isEnd"></a>
|
|
20002
20486
|
|
|
20003
20487
|
```typescript
|
|
@@ -20911,6 +21395,7 @@ const executeAutomationStepProps: ExecuteAutomationStepProps = { ... }
|
|
|
20911
21395
|
| <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
21396
|
| <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteAutomationStepProps.property.name">name</a></code> | <code>string</code> | (Optional) Name of the current step. |
|
|
20913
21397
|
| <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. |
|
|
21398
|
+
| <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
21399
|
| <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
21400
|
| <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
21401
|
| <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 +21469,21 @@ public readonly outputObserver: IObserver;
|
|
|
20984
21469
|
|
|
20985
21470
|
---
|
|
20986
21471
|
|
|
21472
|
+
##### `explicitNextStep`<sup>Optional</sup> <a name="explicitNextStep" id="@cdklabs/cdk-ssm-documents.ExecuteAutomationStepProps.property.explicitNextStep"></a>
|
|
21473
|
+
|
|
21474
|
+
```typescript
|
|
21475
|
+
public readonly explicitNextStep: StepRef;
|
|
21476
|
+
```
|
|
21477
|
+
|
|
21478
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a>
|
|
21479
|
+
- *Default:* will implicitly choose the next step in the sequence that the steps are added to the document.
|
|
21480
|
+
|
|
21481
|
+
(Optional) explicit step to go to after this step completes.
|
|
21482
|
+
|
|
21483
|
+
https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-actions.html#nextProp
|
|
21484
|
+
|
|
21485
|
+
---
|
|
21486
|
+
|
|
20987
21487
|
##### `isEnd`<sup>Optional</sup> <a name="isEnd" id="@cdklabs/cdk-ssm-documents.ExecuteAutomationStepProps.property.isEnd"></a>
|
|
20988
21488
|
|
|
20989
21489
|
```typescript
|
|
@@ -21171,16 +21671,15 @@ const executeScriptStepProps: ExecuteScriptStepProps = { ... }
|
|
|
21171
21671
|
| <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
21672
|
| <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteScriptStepProps.property.name">name</a></code> | <code>string</code> | (Optional) Name of the current step. |
|
|
21173
21673
|
| <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. |
|
|
21674
|
+
| <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
21675
|
| <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
21676
|
| <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
21677
|
| <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteScriptStepProps.property.onCancel">onCancel</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a></code> | (Optional) Fallback action to take in the event that this step is cancelled. |
|
|
21177
21678
|
| <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteScriptStepProps.property.onFailure">onFailure</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.OnFailure">OnFailure</a></code> | (Optional) Fallback action to take in the event that this step fails. |
|
|
21178
21679
|
| <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteScriptStepProps.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</code> | (Optional) timeout seconds to run this step. |
|
|
21179
|
-
| <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteScriptStepProps.property.
|
|
21680
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteScriptStepProps.property.code">code</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.ScriptCode">ScriptCode</a></code> | Inline code to be executed. |
|
|
21681
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteScriptStepProps.property.inputPayload">inputPayload</a></code> | <code>{[ key: string ]: <a href="#@cdklabs/cdk-ssm-documents.IGenericVariable">IGenericVariable</a>}</code> | InputPayload that will be passed to the first parameter of the handler. |
|
|
21180
21682
|
| <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteScriptStepProps.property.language">language</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.ScriptLanguage">ScriptLanguage</a></code> | (Required) Language used to execute the script. |
|
|
21181
|
-
| <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteScriptStepProps.property.fullPathToCode">fullPathToCode</a></code> | <code>string</code> | Full path to the code to execute. |
|
|
21182
|
-
| <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteScriptStepProps.property.handlerName">handlerName</a></code> | <code>string</code> | (Optional) Function name in fullPathToCode file to use as entry point for script handler. |
|
|
21183
|
-
| <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteScriptStepProps.property.inlineCode">inlineCode</a></code> | <code>string</code> | Inline code to be executed. |
|
|
21184
21683
|
| <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteScriptStepProps.property.outputs">outputs</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.Output">Output</a>[]</code> | (Optional) Outputs that the function is expected to return. |
|
|
21185
21684
|
|
|
21186
21685
|
---
|
|
@@ -21240,6 +21739,21 @@ public readonly outputObserver: IObserver;
|
|
|
21240
21739
|
|
|
21241
21740
|
---
|
|
21242
21741
|
|
|
21742
|
+
##### `explicitNextStep`<sup>Optional</sup> <a name="explicitNextStep" id="@cdklabs/cdk-ssm-documents.ExecuteScriptStepProps.property.explicitNextStep"></a>
|
|
21743
|
+
|
|
21744
|
+
```typescript
|
|
21745
|
+
public readonly explicitNextStep: StepRef;
|
|
21746
|
+
```
|
|
21747
|
+
|
|
21748
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a>
|
|
21749
|
+
- *Default:* will implicitly choose the next step in the sequence that the steps are added to the document.
|
|
21750
|
+
|
|
21751
|
+
(Optional) explicit step to go to after this step completes.
|
|
21752
|
+
|
|
21753
|
+
https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-actions.html#nextProp
|
|
21754
|
+
|
|
21755
|
+
---
|
|
21756
|
+
|
|
21243
21757
|
##### `isEnd`<sup>Optional</sup> <a name="isEnd" id="@cdklabs/cdk-ssm-documents.ExecuteScriptStepProps.property.isEnd"></a>
|
|
21244
21758
|
|
|
21245
21759
|
```typescript
|
|
@@ -21307,73 +21821,46 @@ In a simulation run, this will only be encorced after-the-fact but execution wil
|
|
|
21307
21821
|
|
|
21308
21822
|
---
|
|
21309
21823
|
|
|
21310
|
-
##### `
|
|
21824
|
+
##### `code`<sup>Required</sup> <a name="code" id="@cdklabs/cdk-ssm-documents.ExecuteScriptStepProps.property.code"></a>
|
|
21311
21825
|
|
|
21312
21826
|
```typescript
|
|
21313
|
-
public readonly
|
|
21827
|
+
public readonly code: ScriptCode;
|
|
21314
21828
|
```
|
|
21315
21829
|
|
|
21316
|
-
- *Type:*
|
|
21317
|
-
- *Default:* []
|
|
21318
|
-
|
|
21319
|
-
(Optional) Inputs that the function needs in order to execute.
|
|
21320
|
-
|
|
21321
|
-
---
|
|
21322
|
-
|
|
21323
|
-
##### `language`<sup>Required</sup> <a name="language" id="@cdklabs/cdk-ssm-documents.ExecuteScriptStepProps.property.language"></a>
|
|
21830
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.ScriptCode">ScriptCode</a>
|
|
21324
21831
|
|
|
21325
|
-
|
|
21326
|
-
public readonly language: ScriptLanguage;
|
|
21327
|
-
```
|
|
21328
|
-
|
|
21329
|
-
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.ScriptLanguage">ScriptLanguage</a>
|
|
21832
|
+
Inline code to be executed.
|
|
21330
21833
|
|
|
21331
|
-
|
|
21834
|
+
String will be used to produce function in yaml/json.
|
|
21835
|
+
Simulation will execute the function in this code using the language specified.
|
|
21332
21836
|
|
|
21333
21837
|
---
|
|
21334
21838
|
|
|
21335
|
-
##### `
|
|
21839
|
+
##### `inputPayload`<sup>Required</sup> <a name="inputPayload" id="@cdklabs/cdk-ssm-documents.ExecuteScriptStepProps.property.inputPayload"></a>
|
|
21336
21840
|
|
|
21337
21841
|
```typescript
|
|
21338
|
-
public readonly
|
|
21842
|
+
public readonly inputPayload: {[ key: string ]: IGenericVariable};
|
|
21339
21843
|
```
|
|
21340
21844
|
|
|
21341
|
-
- *Type:* string
|
|
21342
|
-
|
|
21343
|
-
Full path to the code to execute.
|
|
21344
|
-
|
|
21345
|
-
File is parsed to produce yaml/json.
|
|
21346
|
-
Simulation will execute this file using the language specified.
|
|
21347
|
-
Either this OR inclineCode must be provided.
|
|
21348
|
-
|
|
21349
|
-
---
|
|
21845
|
+
- *Type:* {[ key: string ]: <a href="#@cdklabs/cdk-ssm-documents.IGenericVariable">IGenericVariable</a>}
|
|
21350
21846
|
|
|
21351
|
-
|
|
21847
|
+
InputPayload that will be passed to the first parameter of the handler.
|
|
21352
21848
|
|
|
21353
|
-
|
|
21354
|
-
|
|
21355
|
-
|
|
21356
|
-
|
|
21357
|
-
- *Type:* string
|
|
21358
|
-
- *Default:* script_handler
|
|
21359
|
-
|
|
21360
|
-
(Optional) Function name in fullPathToCode file to use as entry point for script handler.
|
|
21849
|
+
This can be used to pass input data to the script.
|
|
21850
|
+
The key of this dict is the variable name that will be available to the code.
|
|
21851
|
+
The value is the Variable object.
|
|
21361
21852
|
|
|
21362
21853
|
---
|
|
21363
21854
|
|
|
21364
|
-
##### `
|
|
21855
|
+
##### `language`<sup>Required</sup> <a name="language" id="@cdklabs/cdk-ssm-documents.ExecuteScriptStepProps.property.language"></a>
|
|
21365
21856
|
|
|
21366
21857
|
```typescript
|
|
21367
|
-
public readonly
|
|
21858
|
+
public readonly language: ScriptLanguage;
|
|
21368
21859
|
```
|
|
21369
21860
|
|
|
21370
|
-
- *Type:*
|
|
21371
|
-
|
|
21372
|
-
Inline code to be executed.
|
|
21861
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.ScriptLanguage">ScriptLanguage</a>
|
|
21373
21862
|
|
|
21374
|
-
|
|
21375
|
-
Simulation will execute the function in this string using the language specified.
|
|
21376
|
-
Either this OR fullPathToCode must be provided.
|
|
21863
|
+
(Required) Language used to execute the script.
|
|
21377
21864
|
|
|
21378
21865
|
---
|
|
21379
21866
|
|
|
@@ -21412,6 +21899,7 @@ const executeStateMachineStepProps: ExecuteStateMachineStepProps = { ... }
|
|
|
21412
21899
|
| <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
21900
|
| <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteStateMachineStepProps.property.name">name</a></code> | <code>string</code> | (Optional) Name of the current step. |
|
|
21414
21901
|
| <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. |
|
|
21902
|
+
| <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
21903
|
| <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
21904
|
| <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
21905
|
| <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 +21966,21 @@ public readonly outputObserver: IObserver;
|
|
|
21478
21966
|
|
|
21479
21967
|
---
|
|
21480
21968
|
|
|
21969
|
+
##### `explicitNextStep`<sup>Optional</sup> <a name="explicitNextStep" id="@cdklabs/cdk-ssm-documents.ExecuteStateMachineStepProps.property.explicitNextStep"></a>
|
|
21970
|
+
|
|
21971
|
+
```typescript
|
|
21972
|
+
public readonly explicitNextStep: StepRef;
|
|
21973
|
+
```
|
|
21974
|
+
|
|
21975
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a>
|
|
21976
|
+
- *Default:* will implicitly choose the next step in the sequence that the steps are added to the document.
|
|
21977
|
+
|
|
21978
|
+
(Optional) explicit step to go to after this step completes.
|
|
21979
|
+
|
|
21980
|
+
https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-actions.html#nextProp
|
|
21981
|
+
|
|
21982
|
+
---
|
|
21983
|
+
|
|
21481
21984
|
##### `isEnd`<sup>Optional</sup> <a name="isEnd" id="@cdklabs/cdk-ssm-documents.ExecuteStateMachineStepProps.property.isEnd"></a>
|
|
21482
21985
|
|
|
21483
21986
|
```typescript
|
|
@@ -22200,6 +22703,7 @@ const invokeLambdaFunctionStepProps: InvokeLambdaFunctionStepProps = { ... }
|
|
|
22200
22703
|
| <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
22704
|
| <code><a href="#@cdklabs/cdk-ssm-documents.InvokeLambdaFunctionStepProps.property.name">name</a></code> | <code>string</code> | (Optional) Name of the current step. |
|
|
22202
22705
|
| <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. |
|
|
22706
|
+
| <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
22707
|
| <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
22708
|
| <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
22709
|
| <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 +22773,21 @@ public readonly outputObserver: IObserver;
|
|
|
22269
22773
|
|
|
22270
22774
|
---
|
|
22271
22775
|
|
|
22776
|
+
##### `explicitNextStep`<sup>Optional</sup> <a name="explicitNextStep" id="@cdklabs/cdk-ssm-documents.InvokeLambdaFunctionStepProps.property.explicitNextStep"></a>
|
|
22777
|
+
|
|
22778
|
+
```typescript
|
|
22779
|
+
public readonly explicitNextStep: StepRef;
|
|
22780
|
+
```
|
|
22781
|
+
|
|
22782
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a>
|
|
22783
|
+
- *Default:* will implicitly choose the next step in the sequence that the steps are added to the document.
|
|
22784
|
+
|
|
22785
|
+
(Optional) explicit step to go to after this step completes.
|
|
22786
|
+
|
|
22787
|
+
https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-actions.html#nextProp
|
|
22788
|
+
|
|
22789
|
+
---
|
|
22790
|
+
|
|
22272
22791
|
##### `isEnd`<sup>Optional</sup> <a name="isEnd" id="@cdklabs/cdk-ssm-documents.InvokeLambdaFunctionStepProps.property.isEnd"></a>
|
|
22273
22792
|
|
|
22274
22793
|
```typescript
|
|
@@ -22559,6 +23078,7 @@ const invokeWebhookStepProps: InvokeWebhookStepProps = { ... }
|
|
|
22559
23078
|
| <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
23079
|
| <code><a href="#@cdklabs/cdk-ssm-documents.InvokeWebhookStepProps.property.name">name</a></code> | <code>string</code> | (Optional) Name of the current step. |
|
|
22561
23080
|
| <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. |
|
|
23081
|
+
| <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
23082
|
| <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
23083
|
| <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
23084
|
| <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 +23144,21 @@ public readonly outputObserver: IObserver;
|
|
|
22624
23144
|
|
|
22625
23145
|
---
|
|
22626
23146
|
|
|
23147
|
+
##### `explicitNextStep`<sup>Optional</sup> <a name="explicitNextStep" id="@cdklabs/cdk-ssm-documents.InvokeWebhookStepProps.property.explicitNextStep"></a>
|
|
23148
|
+
|
|
23149
|
+
```typescript
|
|
23150
|
+
public readonly explicitNextStep: StepRef;
|
|
23151
|
+
```
|
|
23152
|
+
|
|
23153
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a>
|
|
23154
|
+
- *Default:* will implicitly choose the next step in the sequence that the steps are added to the document.
|
|
23155
|
+
|
|
23156
|
+
(Optional) explicit step to go to after this step completes.
|
|
23157
|
+
|
|
23158
|
+
https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-actions.html#nextProp
|
|
23159
|
+
|
|
23160
|
+
---
|
|
23161
|
+
|
|
22627
23162
|
##### `isEnd`<sup>Optional</sup> <a name="isEnd" id="@cdklabs/cdk-ssm-documents.InvokeWebhookStepProps.property.isEnd"></a>
|
|
22628
23163
|
|
|
22629
23164
|
```typescript
|
|
@@ -23695,6 +24230,7 @@ const runCommandStepProps: RunCommandStepProps = { ... }
|
|
|
23695
24230
|
| <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
24231
|
| <code><a href="#@cdklabs/cdk-ssm-documents.RunCommandStepProps.property.name">name</a></code> | <code>string</code> | (Optional) Name of the current step. |
|
|
23697
24232
|
| <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. |
|
|
24233
|
+
| <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
24234
|
| <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
24235
|
| <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
24236
|
| <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 +24308,21 @@ public readonly outputObserver: IObserver;
|
|
|
23772
24308
|
|
|
23773
24309
|
---
|
|
23774
24310
|
|
|
24311
|
+
##### `explicitNextStep`<sup>Optional</sup> <a name="explicitNextStep" id="@cdklabs/cdk-ssm-documents.RunCommandStepProps.property.explicitNextStep"></a>
|
|
24312
|
+
|
|
24313
|
+
```typescript
|
|
24314
|
+
public readonly explicitNextStep: StepRef;
|
|
24315
|
+
```
|
|
24316
|
+
|
|
24317
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a>
|
|
24318
|
+
- *Default:* will implicitly choose the next step in the sequence that the steps are added to the document.
|
|
24319
|
+
|
|
24320
|
+
(Optional) explicit step to go to after this step completes.
|
|
24321
|
+
|
|
24322
|
+
https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-actions.html#nextProp
|
|
24323
|
+
|
|
24324
|
+
---
|
|
24325
|
+
|
|
23775
24326
|
##### `isEnd`<sup>Optional</sup> <a name="isEnd" id="@cdklabs/cdk-ssm-documents.RunCommandStepProps.property.isEnd"></a>
|
|
23776
24327
|
|
|
23777
24328
|
```typescript
|
|
@@ -24497,6 +25048,7 @@ const runInstanceStepProps: RunInstanceStepProps = { ... }
|
|
|
24497
25048
|
| <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
25049
|
| <code><a href="#@cdklabs/cdk-ssm-documents.RunInstanceStepProps.property.name">name</a></code> | <code>string</code> | (Optional) Name of the current step. |
|
|
24499
25050
|
| <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. |
|
|
25051
|
+
| <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
25052
|
| <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
25053
|
| <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
25054
|
| <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 +25136,21 @@ public readonly outputObserver: IObserver;
|
|
|
24584
25136
|
|
|
24585
25137
|
---
|
|
24586
25138
|
|
|
25139
|
+
##### `explicitNextStep`<sup>Optional</sup> <a name="explicitNextStep" id="@cdklabs/cdk-ssm-documents.RunInstanceStepProps.property.explicitNextStep"></a>
|
|
25140
|
+
|
|
25141
|
+
```typescript
|
|
25142
|
+
public readonly explicitNextStep: StepRef;
|
|
25143
|
+
```
|
|
25144
|
+
|
|
25145
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a>
|
|
25146
|
+
- *Default:* will implicitly choose the next step in the sequence that the steps are added to the document.
|
|
25147
|
+
|
|
25148
|
+
(Optional) explicit step to go to after this step completes.
|
|
25149
|
+
|
|
25150
|
+
https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-actions.html#nextProp
|
|
25151
|
+
|
|
25152
|
+
---
|
|
25153
|
+
|
|
24587
25154
|
##### `isEnd`<sup>Optional</sup> <a name="isEnd" id="@cdklabs/cdk-ssm-documents.RunInstanceStepProps.property.isEnd"></a>
|
|
24588
25155
|
|
|
24589
25156
|
```typescript
|
|
@@ -25652,6 +26219,7 @@ const sleepStepProps: SleepStepProps = { ... }
|
|
|
25652
26219
|
| <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
26220
|
| <code><a href="#@cdklabs/cdk-ssm-documents.SleepStepProps.property.name">name</a></code> | <code>string</code> | (Optional) Name of the current step. |
|
|
25654
26221
|
| <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. |
|
|
26222
|
+
| <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
26223
|
| <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
26224
|
| <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
26225
|
| <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 +26284,21 @@ public readonly outputObserver: IObserver;
|
|
|
25716
26284
|
|
|
25717
26285
|
---
|
|
25718
26286
|
|
|
26287
|
+
##### `explicitNextStep`<sup>Optional</sup> <a name="explicitNextStep" id="@cdklabs/cdk-ssm-documents.SleepStepProps.property.explicitNextStep"></a>
|
|
26288
|
+
|
|
26289
|
+
```typescript
|
|
26290
|
+
public readonly explicitNextStep: StepRef;
|
|
26291
|
+
```
|
|
26292
|
+
|
|
26293
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a>
|
|
26294
|
+
- *Default:* will implicitly choose the next step in the sequence that the steps are added to the document.
|
|
26295
|
+
|
|
26296
|
+
(Optional) explicit step to go to after this step completes.
|
|
26297
|
+
|
|
26298
|
+
https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-actions.html#nextProp
|
|
26299
|
+
|
|
26300
|
+
---
|
|
26301
|
+
|
|
25719
26302
|
##### `isEnd`<sup>Optional</sup> <a name="isEnd" id="@cdklabs/cdk-ssm-documents.SleepStepProps.property.isEnd"></a>
|
|
25720
26303
|
|
|
25721
26304
|
```typescript
|
|
@@ -27200,6 +27783,7 @@ const waitForResourceStepProps: WaitForResourceStepProps = { ... }
|
|
|
27200
27783
|
| <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
27784
|
| <code><a href="#@cdklabs/cdk-ssm-documents.WaitForResourceStepProps.property.name">name</a></code> | <code>string</code> | (Optional) Name of the current step. |
|
|
27202
27785
|
| <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. |
|
|
27786
|
+
| <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
27787
|
| <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
27788
|
| <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
27789
|
| <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 +27854,21 @@ public readonly outputObserver: IObserver;
|
|
|
27270
27854
|
|
|
27271
27855
|
---
|
|
27272
27856
|
|
|
27857
|
+
##### `explicitNextStep`<sup>Optional</sup> <a name="explicitNextStep" id="@cdklabs/cdk-ssm-documents.WaitForResourceStepProps.property.explicitNextStep"></a>
|
|
27858
|
+
|
|
27859
|
+
```typescript
|
|
27860
|
+
public readonly explicitNextStep: StepRef;
|
|
27861
|
+
```
|
|
27862
|
+
|
|
27863
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.StepRef">StepRef</a>
|
|
27864
|
+
- *Default:* will implicitly choose the next step in the sequence that the steps are added to the document.
|
|
27865
|
+
|
|
27866
|
+
(Optional) explicit step to go to after this step completes.
|
|
27867
|
+
|
|
27868
|
+
https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-actions.html#nextProp
|
|
27869
|
+
|
|
27870
|
+
---
|
|
27871
|
+
|
|
27273
27872
|
##### `isEnd`<sup>Optional</sup> <a name="isEnd" id="@cdklabs/cdk-ssm-documents.WaitForResourceStepProps.property.isEnd"></a>
|
|
27274
27873
|
|
|
27275
27874
|
```typescript
|
|
@@ -30882,6 +31481,126 @@ public readonly props: AwsInvocationSimulationProps;
|
|
|
30882
31481
|
---
|
|
30883
31482
|
|
|
30884
31483
|
|
|
31484
|
+
### FileScriptCode <a name="FileScriptCode" id="@cdklabs/cdk-ssm-documents.FileScriptCode"></a>
|
|
31485
|
+
|
|
31486
|
+
#### Initializers <a name="Initializers" id="@cdklabs/cdk-ssm-documents.FileScriptCode.Initializer"></a>
|
|
31487
|
+
|
|
31488
|
+
```typescript
|
|
31489
|
+
import { FileScriptCode } from '@cdklabs/cdk-ssm-documents'
|
|
31490
|
+
|
|
31491
|
+
new FileScriptCode(fullPath: string)
|
|
31492
|
+
```
|
|
31493
|
+
|
|
31494
|
+
| **Name** | **Type** | **Description** |
|
|
31495
|
+
| --- | --- | --- |
|
|
31496
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.FileScriptCode.Initializer.parameter.fullPath">fullPath</a></code> | <code>string</code> | *No description.* |
|
|
31497
|
+
|
|
31498
|
+
---
|
|
31499
|
+
|
|
31500
|
+
##### `fullPath`<sup>Required</sup> <a name="fullPath" id="@cdklabs/cdk-ssm-documents.FileScriptCode.Initializer.parameter.fullPath"></a>
|
|
31501
|
+
|
|
31502
|
+
- *Type:* string
|
|
31503
|
+
|
|
31504
|
+
---
|
|
31505
|
+
|
|
31506
|
+
#### Methods <a name="Methods" id="Methods"></a>
|
|
31507
|
+
|
|
31508
|
+
| **Name** | **Description** |
|
|
31509
|
+
| --- | --- |
|
|
31510
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.FileScriptCode.codeAsString">codeAsString</a></code> | *No description.* |
|
|
31511
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.FileScriptCode.createOrGetFile">createOrGetFile</a></code> | If there is a file for this code, return it. |
|
|
31512
|
+
|
|
31513
|
+
---
|
|
31514
|
+
|
|
31515
|
+
##### `codeAsString` <a name="codeAsString" id="@cdklabs/cdk-ssm-documents.FileScriptCode.codeAsString"></a>
|
|
31516
|
+
|
|
31517
|
+
```typescript
|
|
31518
|
+
public codeAsString(): string
|
|
31519
|
+
```
|
|
31520
|
+
|
|
31521
|
+
##### `createOrGetFile` <a name="createOrGetFile" id="@cdklabs/cdk-ssm-documents.FileScriptCode.createOrGetFile"></a>
|
|
31522
|
+
|
|
31523
|
+
```typescript
|
|
31524
|
+
public createOrGetFile(_suffix: string): string
|
|
31525
|
+
```
|
|
31526
|
+
|
|
31527
|
+
If there is a file for this code, return it.
|
|
31528
|
+
|
|
31529
|
+
Otherwise, create a file with the specified suffix.
|
|
31530
|
+
|
|
31531
|
+
###### `_suffix`<sup>Required</sup> <a name="_suffix" id="@cdklabs/cdk-ssm-documents.FileScriptCode.createOrGetFile.parameter._suffix"></a>
|
|
31532
|
+
|
|
31533
|
+
- *Type:* string
|
|
31534
|
+
|
|
31535
|
+
---
|
|
31536
|
+
|
|
31537
|
+
#### Static Functions <a name="Static Functions" id="Static Functions"></a>
|
|
31538
|
+
|
|
31539
|
+
| **Name** | **Description** |
|
|
31540
|
+
| --- | --- |
|
|
31541
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.FileScriptCode.fromFile">fromFile</a></code> | Full path to the code to execute. |
|
|
31542
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.FileScriptCode.inline">inline</a></code> | Inline code to be executed. |
|
|
31543
|
+
|
|
31544
|
+
---
|
|
31545
|
+
|
|
31546
|
+
##### `fromFile` <a name="fromFile" id="@cdklabs/cdk-ssm-documents.FileScriptCode.fromFile"></a>
|
|
31547
|
+
|
|
31548
|
+
```typescript
|
|
31549
|
+
import { FileScriptCode } from '@cdklabs/cdk-ssm-documents'
|
|
31550
|
+
|
|
31551
|
+
FileScriptCode.fromFile(fullPath: string)
|
|
31552
|
+
```
|
|
31553
|
+
|
|
31554
|
+
Full path to the code to execute.
|
|
31555
|
+
|
|
31556
|
+
File is parsed to produce yaml/json.
|
|
31557
|
+
Simulation will execute this file using the language specified.
|
|
31558
|
+
(Attachments not yet supported)
|
|
31559
|
+
|
|
31560
|
+
###### `fullPath`<sup>Required</sup> <a name="fullPath" id="@cdklabs/cdk-ssm-documents.FileScriptCode.fromFile.parameter.fullPath"></a>
|
|
31561
|
+
|
|
31562
|
+
- *Type:* string
|
|
31563
|
+
|
|
31564
|
+
---
|
|
31565
|
+
|
|
31566
|
+
##### `inline` <a name="inline" id="@cdklabs/cdk-ssm-documents.FileScriptCode.inline"></a>
|
|
31567
|
+
|
|
31568
|
+
```typescript
|
|
31569
|
+
import { FileScriptCode } from '@cdklabs/cdk-ssm-documents'
|
|
31570
|
+
|
|
31571
|
+
FileScriptCode.inline(code: string)
|
|
31572
|
+
```
|
|
31573
|
+
|
|
31574
|
+
Inline code to be executed.
|
|
31575
|
+
|
|
31576
|
+
String will be used to produce function in yaml/json.
|
|
31577
|
+
Simulation will execute the function in this string using the language specified.
|
|
31578
|
+
|
|
31579
|
+
###### `code`<sup>Required</sup> <a name="code" id="@cdklabs/cdk-ssm-documents.FileScriptCode.inline.parameter.code"></a>
|
|
31580
|
+
|
|
31581
|
+
- *Type:* string
|
|
31582
|
+
|
|
31583
|
+
---
|
|
31584
|
+
|
|
31585
|
+
#### Properties <a name="Properties" id="Properties"></a>
|
|
31586
|
+
|
|
31587
|
+
| **Name** | **Type** | **Description** |
|
|
31588
|
+
| --- | --- | --- |
|
|
31589
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.FileScriptCode.property.fullPath">fullPath</a></code> | <code>string</code> | *No description.* |
|
|
31590
|
+
|
|
31591
|
+
---
|
|
31592
|
+
|
|
31593
|
+
##### `fullPath`<sup>Required</sup> <a name="fullPath" id="@cdklabs/cdk-ssm-documents.FileScriptCode.property.fullPath"></a>
|
|
31594
|
+
|
|
31595
|
+
```typescript
|
|
31596
|
+
public readonly fullPath: string;
|
|
31597
|
+
```
|
|
31598
|
+
|
|
31599
|
+
- *Type:* string
|
|
31600
|
+
|
|
31601
|
+
---
|
|
31602
|
+
|
|
31603
|
+
|
|
30885
31604
|
### GenericVariable <a name="GenericVariable" id="@cdklabs/cdk-ssm-documents.GenericVariable"></a>
|
|
30886
31605
|
|
|
30887
31606
|
- *Implements:* <a href="#@cdklabs/cdk-ssm-documents.IGenericVariable">IGenericVariable</a>
|
|
@@ -33813,6 +34532,126 @@ public readonly authMethod: AuthMethod;
|
|
|
33813
34532
|
---
|
|
33814
34533
|
|
|
33815
34534
|
|
|
34535
|
+
### InlineScriptCode <a name="InlineScriptCode" id="@cdklabs/cdk-ssm-documents.InlineScriptCode"></a>
|
|
34536
|
+
|
|
34537
|
+
#### Initializers <a name="Initializers" id="@cdklabs/cdk-ssm-documents.InlineScriptCode.Initializer"></a>
|
|
34538
|
+
|
|
34539
|
+
```typescript
|
|
34540
|
+
import { InlineScriptCode } from '@cdklabs/cdk-ssm-documents'
|
|
34541
|
+
|
|
34542
|
+
new InlineScriptCode(inlineCode: string)
|
|
34543
|
+
```
|
|
34544
|
+
|
|
34545
|
+
| **Name** | **Type** | **Description** |
|
|
34546
|
+
| --- | --- | --- |
|
|
34547
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.InlineScriptCode.Initializer.parameter.inlineCode">inlineCode</a></code> | <code>string</code> | *No description.* |
|
|
34548
|
+
|
|
34549
|
+
---
|
|
34550
|
+
|
|
34551
|
+
##### `inlineCode`<sup>Required</sup> <a name="inlineCode" id="@cdklabs/cdk-ssm-documents.InlineScriptCode.Initializer.parameter.inlineCode"></a>
|
|
34552
|
+
|
|
34553
|
+
- *Type:* string
|
|
34554
|
+
|
|
34555
|
+
---
|
|
34556
|
+
|
|
34557
|
+
#### Methods <a name="Methods" id="Methods"></a>
|
|
34558
|
+
|
|
34559
|
+
| **Name** | **Description** |
|
|
34560
|
+
| --- | --- |
|
|
34561
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.InlineScriptCode.codeAsString">codeAsString</a></code> | *No description.* |
|
|
34562
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.InlineScriptCode.createOrGetFile">createOrGetFile</a></code> | If there is a file for this code, return it. |
|
|
34563
|
+
|
|
34564
|
+
---
|
|
34565
|
+
|
|
34566
|
+
##### `codeAsString` <a name="codeAsString" id="@cdklabs/cdk-ssm-documents.InlineScriptCode.codeAsString"></a>
|
|
34567
|
+
|
|
34568
|
+
```typescript
|
|
34569
|
+
public codeAsString(): string
|
|
34570
|
+
```
|
|
34571
|
+
|
|
34572
|
+
##### `createOrGetFile` <a name="createOrGetFile" id="@cdklabs/cdk-ssm-documents.InlineScriptCode.createOrGetFile"></a>
|
|
34573
|
+
|
|
34574
|
+
```typescript
|
|
34575
|
+
public createOrGetFile(suffix: string): string
|
|
34576
|
+
```
|
|
34577
|
+
|
|
34578
|
+
If there is a file for this code, return it.
|
|
34579
|
+
|
|
34580
|
+
Otherwise, create a file with the specified suffix.
|
|
34581
|
+
|
|
34582
|
+
###### `suffix`<sup>Required</sup> <a name="suffix" id="@cdklabs/cdk-ssm-documents.InlineScriptCode.createOrGetFile.parameter.suffix"></a>
|
|
34583
|
+
|
|
34584
|
+
- *Type:* string
|
|
34585
|
+
|
|
34586
|
+
---
|
|
34587
|
+
|
|
34588
|
+
#### Static Functions <a name="Static Functions" id="Static Functions"></a>
|
|
34589
|
+
|
|
34590
|
+
| **Name** | **Description** |
|
|
34591
|
+
| --- | --- |
|
|
34592
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.InlineScriptCode.fromFile">fromFile</a></code> | Full path to the code to execute. |
|
|
34593
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.InlineScriptCode.inline">inline</a></code> | Inline code to be executed. |
|
|
34594
|
+
|
|
34595
|
+
---
|
|
34596
|
+
|
|
34597
|
+
##### `fromFile` <a name="fromFile" id="@cdklabs/cdk-ssm-documents.InlineScriptCode.fromFile"></a>
|
|
34598
|
+
|
|
34599
|
+
```typescript
|
|
34600
|
+
import { InlineScriptCode } from '@cdklabs/cdk-ssm-documents'
|
|
34601
|
+
|
|
34602
|
+
InlineScriptCode.fromFile(fullPath: string)
|
|
34603
|
+
```
|
|
34604
|
+
|
|
34605
|
+
Full path to the code to execute.
|
|
34606
|
+
|
|
34607
|
+
File is parsed to produce yaml/json.
|
|
34608
|
+
Simulation will execute this file using the language specified.
|
|
34609
|
+
(Attachments not yet supported)
|
|
34610
|
+
|
|
34611
|
+
###### `fullPath`<sup>Required</sup> <a name="fullPath" id="@cdklabs/cdk-ssm-documents.InlineScriptCode.fromFile.parameter.fullPath"></a>
|
|
34612
|
+
|
|
34613
|
+
- *Type:* string
|
|
34614
|
+
|
|
34615
|
+
---
|
|
34616
|
+
|
|
34617
|
+
##### `inline` <a name="inline" id="@cdklabs/cdk-ssm-documents.InlineScriptCode.inline"></a>
|
|
34618
|
+
|
|
34619
|
+
```typescript
|
|
34620
|
+
import { InlineScriptCode } from '@cdklabs/cdk-ssm-documents'
|
|
34621
|
+
|
|
34622
|
+
InlineScriptCode.inline(code: string)
|
|
34623
|
+
```
|
|
34624
|
+
|
|
34625
|
+
Inline code to be executed.
|
|
34626
|
+
|
|
34627
|
+
String will be used to produce function in yaml/json.
|
|
34628
|
+
Simulation will execute the function in this string using the language specified.
|
|
34629
|
+
|
|
34630
|
+
###### `code`<sup>Required</sup> <a name="code" id="@cdklabs/cdk-ssm-documents.InlineScriptCode.inline.parameter.code"></a>
|
|
34631
|
+
|
|
34632
|
+
- *Type:* string
|
|
34633
|
+
|
|
34634
|
+
---
|
|
34635
|
+
|
|
34636
|
+
#### Properties <a name="Properties" id="Properties"></a>
|
|
34637
|
+
|
|
34638
|
+
| **Name** | **Type** | **Description** |
|
|
34639
|
+
| --- | --- | --- |
|
|
34640
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.InlineScriptCode.property.inlineCode">inlineCode</a></code> | <code>string</code> | *No description.* |
|
|
34641
|
+
|
|
34642
|
+
---
|
|
34643
|
+
|
|
34644
|
+
##### `inlineCode`<sup>Required</sup> <a name="inlineCode" id="@cdklabs/cdk-ssm-documents.InlineScriptCode.property.inlineCode"></a>
|
|
34645
|
+
|
|
34646
|
+
```typescript
|
|
34647
|
+
public readonly inlineCode: string;
|
|
34648
|
+
```
|
|
34649
|
+
|
|
34650
|
+
- *Type:* string
|
|
34651
|
+
|
|
34652
|
+
---
|
|
34653
|
+
|
|
34654
|
+
|
|
33816
34655
|
### Input <a name="Input" id="@cdklabs/cdk-ssm-documents.Input"></a>
|
|
33817
34656
|
|
|
33818
34657
|
#### Initializers <a name="Initializers" id="@cdklabs/cdk-ssm-documents.Input.Initializer"></a>
|
|
@@ -37318,6 +38157,249 @@ public readonly sourceType: string;
|
|
|
37318
38157
|
---
|
|
37319
38158
|
|
|
37320
38159
|
|
|
38160
|
+
### ScriptCode <a name="ScriptCode" id="@cdklabs/cdk-ssm-documents.ScriptCode"></a>
|
|
38161
|
+
|
|
38162
|
+
The code to run for the execution.
|
|
38163
|
+
|
|
38164
|
+
See "script" parameter here:
|
|
38165
|
+
https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-action-executeScript.html
|
|
38166
|
+
Attachments are not yet supported.
|
|
38167
|
+
|
|
38168
|
+
#### Initializers <a name="Initializers" id="@cdklabs/cdk-ssm-documents.ScriptCode.Initializer"></a>
|
|
38169
|
+
|
|
38170
|
+
```typescript
|
|
38171
|
+
import { ScriptCode } from '@cdklabs/cdk-ssm-documents'
|
|
38172
|
+
|
|
38173
|
+
new ScriptCode()
|
|
38174
|
+
```
|
|
38175
|
+
|
|
38176
|
+
| **Name** | **Type** | **Description** |
|
|
38177
|
+
| --- | --- | --- |
|
|
38178
|
+
|
|
38179
|
+
---
|
|
38180
|
+
|
|
38181
|
+
#### Methods <a name="Methods" id="Methods"></a>
|
|
38182
|
+
|
|
38183
|
+
| **Name** | **Description** |
|
|
38184
|
+
| --- | --- |
|
|
38185
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.ScriptCode.codeAsString">codeAsString</a></code> | *No description.* |
|
|
38186
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.ScriptCode.createOrGetFile">createOrGetFile</a></code> | If there is a file for this code, return it. |
|
|
38187
|
+
|
|
38188
|
+
---
|
|
38189
|
+
|
|
38190
|
+
##### `codeAsString` <a name="codeAsString" id="@cdklabs/cdk-ssm-documents.ScriptCode.codeAsString"></a>
|
|
38191
|
+
|
|
38192
|
+
```typescript
|
|
38193
|
+
public codeAsString(): string
|
|
38194
|
+
```
|
|
38195
|
+
|
|
38196
|
+
##### `createOrGetFile` <a name="createOrGetFile" id="@cdklabs/cdk-ssm-documents.ScriptCode.createOrGetFile"></a>
|
|
38197
|
+
|
|
38198
|
+
```typescript
|
|
38199
|
+
public createOrGetFile(suffix: string): string
|
|
38200
|
+
```
|
|
38201
|
+
|
|
38202
|
+
If there is a file for this code, return it.
|
|
38203
|
+
|
|
38204
|
+
Otherwise, create a file with the specified suffix.
|
|
38205
|
+
|
|
38206
|
+
###### `suffix`<sup>Required</sup> <a name="suffix" id="@cdklabs/cdk-ssm-documents.ScriptCode.createOrGetFile.parameter.suffix"></a>
|
|
38207
|
+
|
|
38208
|
+
- *Type:* string
|
|
38209
|
+
|
|
38210
|
+
of the file to create (such as ".py").
|
|
38211
|
+
|
|
38212
|
+
---
|
|
38213
|
+
|
|
38214
|
+
#### Static Functions <a name="Static Functions" id="Static Functions"></a>
|
|
38215
|
+
|
|
38216
|
+
| **Name** | **Description** |
|
|
38217
|
+
| --- | --- |
|
|
38218
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.ScriptCode.fromFile">fromFile</a></code> | Full path to the code to execute. |
|
|
38219
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.ScriptCode.inline">inline</a></code> | Inline code to be executed. |
|
|
38220
|
+
|
|
38221
|
+
---
|
|
38222
|
+
|
|
38223
|
+
##### `fromFile` <a name="fromFile" id="@cdklabs/cdk-ssm-documents.ScriptCode.fromFile"></a>
|
|
38224
|
+
|
|
38225
|
+
```typescript
|
|
38226
|
+
import { ScriptCode } from '@cdklabs/cdk-ssm-documents'
|
|
38227
|
+
|
|
38228
|
+
ScriptCode.fromFile(fullPath: string)
|
|
38229
|
+
```
|
|
38230
|
+
|
|
38231
|
+
Full path to the code to execute.
|
|
38232
|
+
|
|
38233
|
+
File is parsed to produce yaml/json.
|
|
38234
|
+
Simulation will execute this file using the language specified.
|
|
38235
|
+
(Attachments not yet supported)
|
|
38236
|
+
|
|
38237
|
+
###### `fullPath`<sup>Required</sup> <a name="fullPath" id="@cdklabs/cdk-ssm-documents.ScriptCode.fromFile.parameter.fullPath"></a>
|
|
38238
|
+
|
|
38239
|
+
- *Type:* string
|
|
38240
|
+
|
|
38241
|
+
---
|
|
38242
|
+
|
|
38243
|
+
##### `inline` <a name="inline" id="@cdklabs/cdk-ssm-documents.ScriptCode.inline"></a>
|
|
38244
|
+
|
|
38245
|
+
```typescript
|
|
38246
|
+
import { ScriptCode } from '@cdklabs/cdk-ssm-documents'
|
|
38247
|
+
|
|
38248
|
+
ScriptCode.inline(code: string)
|
|
38249
|
+
```
|
|
38250
|
+
|
|
38251
|
+
Inline code to be executed.
|
|
38252
|
+
|
|
38253
|
+
String will be used to produce function in yaml/json.
|
|
38254
|
+
Simulation will execute the function in this string using the language specified.
|
|
38255
|
+
|
|
38256
|
+
###### `code`<sup>Required</sup> <a name="code" id="@cdklabs/cdk-ssm-documents.ScriptCode.inline.parameter.code"></a>
|
|
38257
|
+
|
|
38258
|
+
- *Type:* string
|
|
38259
|
+
|
|
38260
|
+
---
|
|
38261
|
+
|
|
38262
|
+
|
|
38263
|
+
|
|
38264
|
+
### ScriptLanguage <a name="ScriptLanguage" id="@cdklabs/cdk-ssm-documents.ScriptLanguage"></a>
|
|
38265
|
+
|
|
38266
|
+
Specifies the script language as described in the "Runtime" argument here: https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-action-executeScript.html.
|
|
38267
|
+
|
|
38268
|
+
#### Initializers <a name="Initializers" id="@cdklabs/cdk-ssm-documents.ScriptLanguage.Initializer"></a>
|
|
38269
|
+
|
|
38270
|
+
```typescript
|
|
38271
|
+
import { ScriptLanguage } from '@cdklabs/cdk-ssm-documents'
|
|
38272
|
+
|
|
38273
|
+
new ScriptLanguage()
|
|
38274
|
+
```
|
|
38275
|
+
|
|
38276
|
+
| **Name** | **Type** | **Description** |
|
|
38277
|
+
| --- | --- | --- |
|
|
38278
|
+
|
|
38279
|
+
---
|
|
38280
|
+
|
|
38281
|
+
#### Methods <a name="Methods" id="Methods"></a>
|
|
38282
|
+
|
|
38283
|
+
| **Name** | **Description** |
|
|
38284
|
+
| --- | --- |
|
|
38285
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.ScriptLanguage.fileSuffix">fileSuffix</a></code> | The suffix to apply to file names of this type of execution. |
|
|
38286
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.ScriptLanguage.runtime">runtime</a></code> | The associated runtime of this ScriptLanguage. |
|
|
38287
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.ScriptLanguage.simulate">simulate</a></code> | Simulate an execution of this ScriptLanguage. |
|
|
38288
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.ScriptLanguage.ssmInputs">ssmInputs</a></code> | Builds the ssm inputs. |
|
|
38289
|
+
|
|
38290
|
+
---
|
|
38291
|
+
|
|
38292
|
+
##### `fileSuffix` <a name="fileSuffix" id="@cdklabs/cdk-ssm-documents.ScriptLanguage.fileSuffix"></a>
|
|
38293
|
+
|
|
38294
|
+
```typescript
|
|
38295
|
+
public fileSuffix(): string
|
|
38296
|
+
```
|
|
38297
|
+
|
|
38298
|
+
The suffix to apply to file names of this type of execution.
|
|
38299
|
+
|
|
38300
|
+
##### `runtime` <a name="runtime" id="@cdklabs/cdk-ssm-documents.ScriptLanguage.runtime"></a>
|
|
38301
|
+
|
|
38302
|
+
```typescript
|
|
38303
|
+
public runtime(): string
|
|
38304
|
+
```
|
|
38305
|
+
|
|
38306
|
+
The associated runtime of this ScriptLanguage.
|
|
38307
|
+
|
|
38308
|
+
##### `simulate` <a name="simulate" id="@cdklabs/cdk-ssm-documents.ScriptLanguage.simulate"></a>
|
|
38309
|
+
|
|
38310
|
+
```typescript
|
|
38311
|
+
public simulate(code: ScriptCode, inputs: {[ key: string ]: string}): {[ key: string ]: string}
|
|
38312
|
+
```
|
|
38313
|
+
|
|
38314
|
+
Simulate an execution of this ScriptLanguage.
|
|
38315
|
+
|
|
38316
|
+
Provide the inputs after replaced with the actual values (not variables).
|
|
38317
|
+
|
|
38318
|
+
###### `code`<sup>Required</sup> <a name="code" id="@cdklabs/cdk-ssm-documents.ScriptLanguage.simulate.parameter.code"></a>
|
|
38319
|
+
|
|
38320
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.ScriptCode">ScriptCode</a>
|
|
38321
|
+
|
|
38322
|
+
---
|
|
38323
|
+
|
|
38324
|
+
###### `inputs`<sup>Required</sup> <a name="inputs" id="@cdklabs/cdk-ssm-documents.ScriptLanguage.simulate.parameter.inputs"></a>
|
|
38325
|
+
|
|
38326
|
+
- *Type:* {[ key: string ]: string}
|
|
38327
|
+
|
|
38328
|
+
---
|
|
38329
|
+
|
|
38330
|
+
##### `ssmInputs` <a name="ssmInputs" id="@cdklabs/cdk-ssm-documents.ScriptLanguage.ssmInputs"></a>
|
|
38331
|
+
|
|
38332
|
+
```typescript
|
|
38333
|
+
public ssmInputs(): {[ key: string ]: string}
|
|
38334
|
+
```
|
|
38335
|
+
|
|
38336
|
+
Builds the ssm inputs.
|
|
38337
|
+
|
|
38338
|
+
#### Static Functions <a name="Static Functions" id="Static Functions"></a>
|
|
38339
|
+
|
|
38340
|
+
| **Name** | **Description** |
|
|
38341
|
+
| --- | --- |
|
|
38342
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.ScriptLanguage.fromRuntime">fromRuntime</a></code> | Creates a ScriptLanguage based on the provided runtime. |
|
|
38343
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.ScriptLanguage.python">python</a></code> | Create a new ScriptLanguage for python execution. |
|
|
38344
|
+
|
|
38345
|
+
---
|
|
38346
|
+
|
|
38347
|
+
##### `fromRuntime` <a name="fromRuntime" id="@cdklabs/cdk-ssm-documents.ScriptLanguage.fromRuntime"></a>
|
|
38348
|
+
|
|
38349
|
+
```typescript
|
|
38350
|
+
import { ScriptLanguage } from '@cdklabs/cdk-ssm-documents'
|
|
38351
|
+
|
|
38352
|
+
ScriptLanguage.fromRuntime(runtime: string, handlerName?: string)
|
|
38353
|
+
```
|
|
38354
|
+
|
|
38355
|
+
Creates a ScriptLanguage based on the provided runtime.
|
|
38356
|
+
|
|
38357
|
+
Prefer one of the other static constructors if possible.
|
|
38358
|
+
|
|
38359
|
+
###### `runtime`<sup>Required</sup> <a name="runtime" id="@cdklabs/cdk-ssm-documents.ScriptLanguage.fromRuntime.parameter.runtime"></a>
|
|
38360
|
+
|
|
38361
|
+
- *Type:* string
|
|
38362
|
+
|
|
38363
|
+
is the runtime name (such as "python3.6").
|
|
38364
|
+
|
|
38365
|
+
---
|
|
38366
|
+
|
|
38367
|
+
###### `handlerName`<sup>Optional</sup> <a name="handlerName" id="@cdklabs/cdk-ssm-documents.ScriptLanguage.fromRuntime.parameter.handlerName"></a>
|
|
38368
|
+
|
|
38369
|
+
- *Type:* string
|
|
38370
|
+
|
|
38371
|
+
to be provided for python executions.
|
|
38372
|
+
|
|
38373
|
+
---
|
|
38374
|
+
|
|
38375
|
+
##### `python` <a name="python" id="@cdklabs/cdk-ssm-documents.ScriptLanguage.python"></a>
|
|
38376
|
+
|
|
38377
|
+
```typescript
|
|
38378
|
+
import { ScriptLanguage } from '@cdklabs/cdk-ssm-documents'
|
|
38379
|
+
|
|
38380
|
+
ScriptLanguage.python(version: PythonVersion, handlerName: string)
|
|
38381
|
+
```
|
|
38382
|
+
|
|
38383
|
+
Create a new ScriptLanguage for python execution.
|
|
38384
|
+
|
|
38385
|
+
###### `version`<sup>Required</sup> <a name="version" id="@cdklabs/cdk-ssm-documents.ScriptLanguage.python.parameter.version"></a>
|
|
38386
|
+
|
|
38387
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.PythonVersion">PythonVersion</a>
|
|
38388
|
+
|
|
38389
|
+
is the pythonVersion to use when writing the document (for simulation will not matter).
|
|
38390
|
+
|
|
38391
|
+
---
|
|
38392
|
+
|
|
38393
|
+
###### `handlerName`<sup>Required</sup> <a name="handlerName" id="@cdklabs/cdk-ssm-documents.ScriptLanguage.python.parameter.handlerName"></a>
|
|
38394
|
+
|
|
38395
|
+
- *Type:* string
|
|
38396
|
+
|
|
38397
|
+
is the function name in code as entry point for script handler.
|
|
38398
|
+
|
|
38399
|
+
---
|
|
38400
|
+
|
|
38401
|
+
|
|
38402
|
+
|
|
37321
38403
|
### SecureVariable <a name="SecureVariable" id="@cdklabs/cdk-ssm-documents.SecureVariable"></a>
|
|
37322
38404
|
|
|
37323
38405
|
- *Implements:* <a href="#@cdklabs/cdk-ssm-documents.IGenericVariable">IGenericVariable</a>
|
|
@@ -38282,6 +39364,116 @@ public readonly validateStepAction: boolean;
|
|
|
38282
39364
|
---
|
|
38283
39365
|
|
|
38284
39366
|
|
|
39367
|
+
### StepRef <a name="StepRef" id="@cdklabs/cdk-ssm-documents.StepRef"></a>
|
|
39368
|
+
|
|
39369
|
+
Class to reference AutomationSteps.
|
|
39370
|
+
|
|
39371
|
+
The class allows steps to be referenced by the Step object or by the step name.
|
|
39372
|
+
|
|
39373
|
+
#### Initializers <a name="Initializers" id="@cdklabs/cdk-ssm-documents.StepRef.Initializer"></a>
|
|
39374
|
+
|
|
39375
|
+
```typescript
|
|
39376
|
+
import { StepRef } from '@cdklabs/cdk-ssm-documents'
|
|
39377
|
+
|
|
39378
|
+
new StepRef(stepName: string)
|
|
39379
|
+
```
|
|
39380
|
+
|
|
39381
|
+
| **Name** | **Type** | **Description** |
|
|
39382
|
+
| --- | --- | --- |
|
|
39383
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.StepRef.Initializer.parameter.stepName">stepName</a></code> | <code>string</code> | *No description.* |
|
|
39384
|
+
|
|
39385
|
+
---
|
|
39386
|
+
|
|
39387
|
+
##### `stepName`<sup>Required</sup> <a name="stepName" id="@cdklabs/cdk-ssm-documents.StepRef.Initializer.parameter.stepName"></a>
|
|
39388
|
+
|
|
39389
|
+
- *Type:* string
|
|
39390
|
+
|
|
39391
|
+
---
|
|
39392
|
+
|
|
39393
|
+
#### Methods <a name="Methods" id="Methods"></a>
|
|
39394
|
+
|
|
39395
|
+
| **Name** | **Description** |
|
|
39396
|
+
| --- | --- |
|
|
39397
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.StepRef.resolve">resolve</a></code> | Resolve to an AutomationStep object. |
|
|
39398
|
+
|
|
39399
|
+
---
|
|
39400
|
+
|
|
39401
|
+
##### `resolve` <a name="resolve" id="@cdklabs/cdk-ssm-documents.StepRef.resolve"></a>
|
|
39402
|
+
|
|
39403
|
+
```typescript
|
|
39404
|
+
public resolve(allStepsInExecution: AutomationStep[]): AutomationStep
|
|
39405
|
+
```
|
|
39406
|
+
|
|
39407
|
+
Resolve to an AutomationStep object.
|
|
39408
|
+
|
|
39409
|
+
Provide all the steps in the execution to find the associated step.
|
|
39410
|
+
|
|
39411
|
+
###### `allStepsInExecution`<sup>Required</sup> <a name="allStepsInExecution" id="@cdklabs/cdk-ssm-documents.StepRef.resolve.parameter.allStepsInExecution"></a>
|
|
39412
|
+
|
|
39413
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>[]
|
|
39414
|
+
|
|
39415
|
+
---
|
|
39416
|
+
|
|
39417
|
+
#### Static Functions <a name="Static Functions" id="Static Functions"></a>
|
|
39418
|
+
|
|
39419
|
+
| **Name** | **Description** |
|
|
39420
|
+
| --- | --- |
|
|
39421
|
+
| <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. |
|
|
39422
|
+
| <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. |
|
|
39423
|
+
|
|
39424
|
+
---
|
|
39425
|
+
|
|
39426
|
+
##### `fromName` <a name="fromName" id="@cdklabs/cdk-ssm-documents.StepRef.fromName"></a>
|
|
39427
|
+
|
|
39428
|
+
```typescript
|
|
39429
|
+
import { StepRef } from '@cdklabs/cdk-ssm-documents'
|
|
39430
|
+
|
|
39431
|
+
StepRef.fromName(stepName: string)
|
|
39432
|
+
```
|
|
39433
|
+
|
|
39434
|
+
Static constructor for creating a reference to a step from a step name.
|
|
39435
|
+
|
|
39436
|
+
###### `stepName`<sup>Required</sup> <a name="stepName" id="@cdklabs/cdk-ssm-documents.StepRef.fromName.parameter.stepName"></a>
|
|
39437
|
+
|
|
39438
|
+
- *Type:* string
|
|
39439
|
+
|
|
39440
|
+
---
|
|
39441
|
+
|
|
39442
|
+
##### `fromObject` <a name="fromObject" id="@cdklabs/cdk-ssm-documents.StepRef.fromObject"></a>
|
|
39443
|
+
|
|
39444
|
+
```typescript
|
|
39445
|
+
import { StepRef } from '@cdklabs/cdk-ssm-documents'
|
|
39446
|
+
|
|
39447
|
+
StepRef.fromObject(step: AutomationStep)
|
|
39448
|
+
```
|
|
39449
|
+
|
|
39450
|
+
Static constructor for creating a reference to a step from an AutomationStep object.
|
|
39451
|
+
|
|
39452
|
+
###### `step`<sup>Required</sup> <a name="step" id="@cdklabs/cdk-ssm-documents.StepRef.fromObject.parameter.step"></a>
|
|
39453
|
+
|
|
39454
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.AutomationStep">AutomationStep</a>
|
|
39455
|
+
|
|
39456
|
+
---
|
|
39457
|
+
|
|
39458
|
+
#### Properties <a name="Properties" id="Properties"></a>
|
|
39459
|
+
|
|
39460
|
+
| **Name** | **Type** | **Description** |
|
|
39461
|
+
| --- | --- | --- |
|
|
39462
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.StepRef.property.stepName">stepName</a></code> | <code>string</code> | *No description.* |
|
|
39463
|
+
|
|
39464
|
+
---
|
|
39465
|
+
|
|
39466
|
+
##### `stepName`<sup>Required</sup> <a name="stepName" id="@cdklabs/cdk-ssm-documents.StepRef.property.stepName"></a>
|
|
39467
|
+
|
|
39468
|
+
```typescript
|
|
39469
|
+
public readonly stepName: string;
|
|
39470
|
+
```
|
|
39471
|
+
|
|
39472
|
+
- *Type:* string
|
|
39473
|
+
|
|
39474
|
+
---
|
|
39475
|
+
|
|
39476
|
+
|
|
38285
39477
|
### StringDocument <a name="StringDocument" id="@cdklabs/cdk-ssm-documents.StringDocument"></a>
|
|
38286
39478
|
|
|
38287
39479
|
This AutomationDocument supports declaring your document from an existing document (JSON/YAML String/File).
|
|
@@ -40262,49 +41454,65 @@ That allows customers to validate their CommandDocument against a given platform
|
|
|
40262
41454
|
---
|
|
40263
41455
|
|
|
40264
41456
|
|
|
40265
|
-
###
|
|
41457
|
+
### PythonVersion <a name="PythonVersion" id="@cdklabs/cdk-ssm-documents.PythonVersion"></a>
|
|
40266
41458
|
|
|
40267
|
-
|
|
41459
|
+
Python runtime to use when writing SSM Document.
|
|
40268
41460
|
|
|
40269
|
-
|
|
40270
|
-
A failed/canceled response will contain the stackTrace.
|
|
41461
|
+
Simulation will use local python version.
|
|
40271
41462
|
|
|
40272
41463
|
#### Members <a name="Members" id="Members"></a>
|
|
40273
41464
|
|
|
40274
41465
|
| **Name** | **Description** |
|
|
40275
41466
|
| --- | --- |
|
|
40276
|
-
| <code><a href="#@cdklabs/cdk-ssm-documents.
|
|
40277
|
-
| <code><a href="#@cdklabs/cdk-ssm-documents.
|
|
40278
|
-
| <code><a href="#@cdklabs/cdk-ssm-documents.
|
|
41467
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.PythonVersion.VERSION_3_6">VERSION_3_6</a></code> | *No description.* |
|
|
41468
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.PythonVersion.VERSION_3_7">VERSION_3_7</a></code> | *No description.* |
|
|
41469
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.PythonVersion.VERSION_3_8">VERSION_3_8</a></code> | *No description.* |
|
|
40279
41470
|
|
|
40280
41471
|
---
|
|
40281
41472
|
|
|
40282
|
-
##### `
|
|
41473
|
+
##### `VERSION_3_6` <a name="VERSION_3_6" id="@cdklabs/cdk-ssm-documents.PythonVersion.VERSION_3_6"></a>
|
|
40283
41474
|
|
|
40284
41475
|
---
|
|
40285
41476
|
|
|
40286
41477
|
|
|
40287
|
-
##### `
|
|
41478
|
+
##### `VERSION_3_7` <a name="VERSION_3_7" id="@cdklabs/cdk-ssm-documents.PythonVersion.VERSION_3_7"></a>
|
|
40288
41479
|
|
|
40289
41480
|
---
|
|
40290
41481
|
|
|
40291
41482
|
|
|
40292
|
-
##### `
|
|
41483
|
+
##### `VERSION_3_8` <a name="VERSION_3_8" id="@cdklabs/cdk-ssm-documents.PythonVersion.VERSION_3_8"></a>
|
|
40293
41484
|
|
|
40294
41485
|
---
|
|
40295
41486
|
|
|
40296
41487
|
|
|
40297
|
-
###
|
|
41488
|
+
### ResponseCode <a name="ResponseCode" id="@cdklabs/cdk-ssm-documents.ResponseCode"></a>
|
|
41489
|
+
|
|
41490
|
+
Steps report their ResponseCode using this enum.
|
|
41491
|
+
|
|
41492
|
+
A successful response will contain the outputs expected.
|
|
41493
|
+
A failed/canceled response will contain the stackTrace.
|
|
40298
41494
|
|
|
40299
41495
|
#### Members <a name="Members" id="Members"></a>
|
|
40300
41496
|
|
|
40301
41497
|
| **Name** | **Description** |
|
|
40302
41498
|
| --- | --- |
|
|
40303
|
-
| <code><a href="#@cdklabs/cdk-ssm-documents.
|
|
41499
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.ResponseCode.SUCCESS">SUCCESS</a></code> | *No description.* |
|
|
41500
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.ResponseCode.CANCELED">CANCELED</a></code> | *No description.* |
|
|
41501
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.ResponseCode.FAILED">FAILED</a></code> | *No description.* |
|
|
40304
41502
|
|
|
40305
41503
|
---
|
|
40306
41504
|
|
|
40307
|
-
##### `
|
|
41505
|
+
##### `SUCCESS` <a name="SUCCESS" id="@cdklabs/cdk-ssm-documents.ResponseCode.SUCCESS"></a>
|
|
41506
|
+
|
|
41507
|
+
---
|
|
41508
|
+
|
|
41509
|
+
|
|
41510
|
+
##### `CANCELED` <a name="CANCELED" id="@cdklabs/cdk-ssm-documents.ResponseCode.CANCELED"></a>
|
|
41511
|
+
|
|
41512
|
+
---
|
|
41513
|
+
|
|
41514
|
+
|
|
41515
|
+
##### `FAILED` <a name="FAILED" id="@cdklabs/cdk-ssm-documents.ResponseCode.FAILED"></a>
|
|
40308
41516
|
|
|
40309
41517
|
---
|
|
40310
41518
|
|