@cdklabs/cdk-ssm-documents 0.0.21 → 0.0.22
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 +616 -174
- package/API.md +538 -94
- package/README.md +4 -5
- package/changelog.md +2 -2
- package/lib/construct/synth-utils.js +1 -1
- package/lib/document/automation-document.js +1 -1
- package/lib/document/command-document.js +1 -1
- package/lib/document/document-builder.js +2 -2
- package/lib/document/ssm-document.js +1 -1
- package/lib/domain/choice.js +1 -1
- package/lib/domain/data-type.js +1 -1
- package/lib/domain/enum/install-action.js +2 -2
- package/lib/domain/enum/install-uninstall-repair.js +2 -2
- package/lib/domain/enum/installation-type.js +2 -2
- package/lib/domain/enum/package-name.js +2 -2
- package/lib/domain/input.js +1 -1
- package/lib/domain/operation.js +1 -1
- package/lib/domain/platform.js +1 -1
- package/lib/domain/precondition.js +1 -1
- package/lib/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.js +1 -1
- package/lib/interface/variables/boolean-variable.js +2 -2
- package/lib/interface/variables/map-list-variable.js +2 -2
- package/lib/interface/variables/number-variable.js +2 -2
- package/lib/interface/variables/secure-string-variable.js +4 -4
- package/lib/interface/variables/string-list-variable.js +2 -2
- package/lib/interface/variables/string-map-variable.js +2 -2
- package/lib/interface/variables/string-variable.js +4 -4
- package/lib/interface/variables/variable.js +2 -2
- package/lib/interface/webhook.js +1 -1
- package/lib/parent-steps/automation/approve-step.js +1 -1
- package/lib/parent-steps/automation/assert-aws-resource-step.js +1 -1
- package/lib/parent-steps/automation/aws-api-step.js +1 -1
- package/lib/parent-steps/automation/branch-step.js +1 -1
- package/lib/parent-steps/automation/change-instance-state-step.js +3 -3
- package/lib/parent-steps/automation/copy-image-step.js +1 -1
- package/lib/parent-steps/automation/create-image-step.js +1 -1
- package/lib/parent-steps/automation/create-stack-step.js +3 -3
- package/lib/parent-steps/automation/create-tags-step.js +3 -3
- package/lib/parent-steps/automation/delete-image-step.js +1 -1
- package/lib/parent-steps/automation/delete-stack-step.js +1 -1
- package/lib/parent-steps/automation/execute-automation-step.js +1 -1
- package/lib/parent-steps/automation/execute-script-step.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.js +1 -1
- 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 +8 -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 +1 -1
- 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
|
@@ -7578,7 +7578,6 @@ public variables(): {[ key: string ]: any}
|
|
|
7578
7578
|
| **Name** | **Description** |
|
|
7579
7579
|
| --- | --- |
|
|
7580
7580
|
| <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteScriptStep.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. |
|
|
7581
|
-
| <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteScriptStep.getLanguage">getLanguage</a></code> | *No description.* |
|
|
7582
7581
|
|
|
7583
7582
|
---
|
|
7584
7583
|
|
|
@@ -7600,20 +7599,6 @@ Any object.
|
|
|
7600
7599
|
|
|
7601
7600
|
---
|
|
7602
7601
|
|
|
7603
|
-
##### `getLanguage` <a name="getLanguage" id="@cdklabs/cdk-ssm-documents.ExecuteScriptStep.getLanguage"></a>
|
|
7604
|
-
|
|
7605
|
-
```typescript
|
|
7606
|
-
import { ExecuteScriptStep } from '@cdklabs/cdk-ssm-documents'
|
|
7607
|
-
|
|
7608
|
-
ExecuteScriptStep.getLanguage(runtime: string)
|
|
7609
|
-
```
|
|
7610
|
-
|
|
7611
|
-
###### `runtime`<sup>Required</sup> <a name="runtime" id="@cdklabs/cdk-ssm-documents.ExecuteScriptStep.getLanguage.parameter.runtime"></a>
|
|
7612
|
-
|
|
7613
|
-
- *Type:* string
|
|
7614
|
-
|
|
7615
|
-
---
|
|
7616
|
-
|
|
7617
7602
|
#### Properties <a name="Properties" id="Properties"></a>
|
|
7618
7603
|
|
|
7619
7604
|
| **Name** | **Type** | **Description** |
|
|
@@ -7632,9 +7617,8 @@ ExecuteScriptStep.getLanguage(runtime: string)
|
|
|
7632
7617
|
| <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.* |
|
|
7633
7618
|
| <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.* |
|
|
7634
7619
|
| <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.* |
|
|
7635
|
-
| <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteScriptStep.property.
|
|
7636
|
-
| <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteScriptStep.property.
|
|
7637
|
-
| <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteScriptStep.property.inputs">inputs</a></code> | <code>string[]</code> | *No description.* |
|
|
7620
|
+
| <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.* |
|
|
7621
|
+
| <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.* |
|
|
7638
7622
|
| <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.* |
|
|
7639
7623
|
| <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.* |
|
|
7640
7624
|
|
|
@@ -7782,33 +7766,23 @@ public readonly nextStep: AutomationStep;
|
|
|
7782
7766
|
|
|
7783
7767
|
---
|
|
7784
7768
|
|
|
7785
|
-
##### `
|
|
7786
|
-
|
|
7787
|
-
```typescript
|
|
7788
|
-
public readonly fullPathToCode: string;
|
|
7789
|
-
```
|
|
7790
|
-
|
|
7791
|
-
- *Type:* string
|
|
7792
|
-
|
|
7793
|
-
---
|
|
7794
|
-
|
|
7795
|
-
##### `handlerName`<sup>Required</sup> <a name="handlerName" id="@cdklabs/cdk-ssm-documents.ExecuteScriptStep.property.handlerName"></a>
|
|
7769
|
+
##### `code`<sup>Required</sup> <a name="code" id="@cdklabs/cdk-ssm-documents.ExecuteScriptStep.property.code"></a>
|
|
7796
7770
|
|
|
7797
7771
|
```typescript
|
|
7798
|
-
public readonly
|
|
7772
|
+
public readonly code: ScriptCode;
|
|
7799
7773
|
```
|
|
7800
7774
|
|
|
7801
|
-
- *Type:*
|
|
7775
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.ScriptCode">ScriptCode</a>
|
|
7802
7776
|
|
|
7803
7777
|
---
|
|
7804
7778
|
|
|
7805
7779
|
##### `inputs`<sup>Required</sup> <a name="inputs" id="@cdklabs/cdk-ssm-documents.ExecuteScriptStep.property.inputs"></a>
|
|
7806
7780
|
|
|
7807
7781
|
```typescript
|
|
7808
|
-
public readonly inputs: string
|
|
7782
|
+
public readonly inputs: {[ key: string ]: IGenericVariable};
|
|
7809
7783
|
```
|
|
7810
7784
|
|
|
7811
|
-
- *Type:* string
|
|
7785
|
+
- *Type:* {[ key: string ]: <a href="#@cdklabs/cdk-ssm-documents.IGenericVariable">IGenericVariable</a>}
|
|
7812
7786
|
|
|
7813
7787
|
---
|
|
7814
7788
|
|
|
@@ -21659,11 +21633,9 @@ const executeScriptStepProps: ExecuteScriptStepProps = { ... }
|
|
|
21659
21633
|
| <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteScriptStepProps.property.onCancel">onCancel</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.OnCancel">OnCancel</a></code> | (Optional) Fallback action to take in the event that this step is cancelled. |
|
|
21660
21634
|
| <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. |
|
|
21661
21635
|
| <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteScriptStepProps.property.timeoutSeconds">timeoutSeconds</a></code> | <code>number</code> | (Optional) timeout seconds to run this step. |
|
|
21662
|
-
| <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteScriptStepProps.property.
|
|
21636
|
+
| <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. |
|
|
21637
|
+
| <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. |
|
|
21663
21638
|
| <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. |
|
|
21664
|
-
| <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteScriptStepProps.property.fullPathToCode">fullPathToCode</a></code> | <code>string</code> | Full path to the code to execute. |
|
|
21665
|
-
| <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. |
|
|
21666
|
-
| <code><a href="#@cdklabs/cdk-ssm-documents.ExecuteScriptStepProps.property.inlineCode">inlineCode</a></code> | <code>string</code> | Inline code to be executed. |
|
|
21667
21639
|
| <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. |
|
|
21668
21640
|
|
|
21669
21641
|
---
|
|
@@ -21805,73 +21777,46 @@ In a simulation run, this will only be encorced after-the-fact but execution wil
|
|
|
21805
21777
|
|
|
21806
21778
|
---
|
|
21807
21779
|
|
|
21808
|
-
##### `
|
|
21780
|
+
##### `code`<sup>Required</sup> <a name="code" id="@cdklabs/cdk-ssm-documents.ExecuteScriptStepProps.property.code"></a>
|
|
21809
21781
|
|
|
21810
21782
|
```typescript
|
|
21811
|
-
public readonly
|
|
21783
|
+
public readonly code: ScriptCode;
|
|
21812
21784
|
```
|
|
21813
21785
|
|
|
21814
|
-
- *Type:*
|
|
21815
|
-
- *Default:* []
|
|
21816
|
-
|
|
21817
|
-
(Optional) Inputs that the function needs in order to execute.
|
|
21818
|
-
|
|
21819
|
-
---
|
|
21820
|
-
|
|
21821
|
-
##### `language`<sup>Required</sup> <a name="language" id="@cdklabs/cdk-ssm-documents.ExecuteScriptStepProps.property.language"></a>
|
|
21822
|
-
|
|
21823
|
-
```typescript
|
|
21824
|
-
public readonly language: ScriptLanguage;
|
|
21825
|
-
```
|
|
21786
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.ScriptCode">ScriptCode</a>
|
|
21826
21787
|
|
|
21827
|
-
|
|
21788
|
+
Inline code to be executed.
|
|
21828
21789
|
|
|
21829
|
-
|
|
21790
|
+
String will be used to produce function in yaml/json.
|
|
21791
|
+
Simulation will execute the function in this code using the language specified.
|
|
21830
21792
|
|
|
21831
21793
|
---
|
|
21832
21794
|
|
|
21833
|
-
##### `
|
|
21795
|
+
##### `inputPayload`<sup>Required</sup> <a name="inputPayload" id="@cdklabs/cdk-ssm-documents.ExecuteScriptStepProps.property.inputPayload"></a>
|
|
21834
21796
|
|
|
21835
21797
|
```typescript
|
|
21836
|
-
public readonly
|
|
21798
|
+
public readonly inputPayload: {[ key: string ]: IGenericVariable};
|
|
21837
21799
|
```
|
|
21838
21800
|
|
|
21839
|
-
- *Type:* string
|
|
21840
|
-
|
|
21841
|
-
Full path to the code to execute.
|
|
21842
|
-
|
|
21843
|
-
File is parsed to produce yaml/json.
|
|
21844
|
-
Simulation will execute this file using the language specified.
|
|
21845
|
-
Either this OR inclineCode must be provided.
|
|
21846
|
-
|
|
21847
|
-
---
|
|
21848
|
-
|
|
21849
|
-
##### `handlerName`<sup>Optional</sup> <a name="handlerName" id="@cdklabs/cdk-ssm-documents.ExecuteScriptStepProps.property.handlerName"></a>
|
|
21801
|
+
- *Type:* {[ key: string ]: <a href="#@cdklabs/cdk-ssm-documents.IGenericVariable">IGenericVariable</a>}
|
|
21850
21802
|
|
|
21851
|
-
|
|
21852
|
-
public readonly handlerName: string;
|
|
21853
|
-
```
|
|
21854
|
-
|
|
21855
|
-
- *Type:* string
|
|
21856
|
-
- *Default:* script_handler
|
|
21803
|
+
InputPayload that will be passed to the first parameter of the handler.
|
|
21857
21804
|
|
|
21858
|
-
|
|
21805
|
+
This can be used to pass input data to the script.
|
|
21806
|
+
The key of this dict is the variable name that will be available to the code.
|
|
21807
|
+
The value is the Variable object.
|
|
21859
21808
|
|
|
21860
21809
|
---
|
|
21861
21810
|
|
|
21862
|
-
##### `
|
|
21811
|
+
##### `language`<sup>Required</sup> <a name="language" id="@cdklabs/cdk-ssm-documents.ExecuteScriptStepProps.property.language"></a>
|
|
21863
21812
|
|
|
21864
21813
|
```typescript
|
|
21865
|
-
public readonly
|
|
21814
|
+
public readonly language: ScriptLanguage;
|
|
21866
21815
|
```
|
|
21867
21816
|
|
|
21868
|
-
- *Type:*
|
|
21869
|
-
|
|
21870
|
-
Inline code to be executed.
|
|
21817
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.ScriptLanguage">ScriptLanguage</a>
|
|
21871
21818
|
|
|
21872
|
-
|
|
21873
|
-
Simulation will execute the function in this string using the language specified.
|
|
21874
|
-
Either this OR fullPathToCode must be provided.
|
|
21819
|
+
(Required) Language used to execute the script.
|
|
21875
21820
|
|
|
21876
21821
|
---
|
|
21877
21822
|
|
|
@@ -31492,6 +31437,126 @@ public readonly props: AwsInvocationSimulationProps;
|
|
|
31492
31437
|
---
|
|
31493
31438
|
|
|
31494
31439
|
|
|
31440
|
+
### FileScriptCode <a name="FileScriptCode" id="@cdklabs/cdk-ssm-documents.FileScriptCode"></a>
|
|
31441
|
+
|
|
31442
|
+
#### Initializers <a name="Initializers" id="@cdklabs/cdk-ssm-documents.FileScriptCode.Initializer"></a>
|
|
31443
|
+
|
|
31444
|
+
```typescript
|
|
31445
|
+
import { FileScriptCode } from '@cdklabs/cdk-ssm-documents'
|
|
31446
|
+
|
|
31447
|
+
new FileScriptCode(fullPath: string)
|
|
31448
|
+
```
|
|
31449
|
+
|
|
31450
|
+
| **Name** | **Type** | **Description** |
|
|
31451
|
+
| --- | --- | --- |
|
|
31452
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.FileScriptCode.Initializer.parameter.fullPath">fullPath</a></code> | <code>string</code> | *No description.* |
|
|
31453
|
+
|
|
31454
|
+
---
|
|
31455
|
+
|
|
31456
|
+
##### `fullPath`<sup>Required</sup> <a name="fullPath" id="@cdklabs/cdk-ssm-documents.FileScriptCode.Initializer.parameter.fullPath"></a>
|
|
31457
|
+
|
|
31458
|
+
- *Type:* string
|
|
31459
|
+
|
|
31460
|
+
---
|
|
31461
|
+
|
|
31462
|
+
#### Methods <a name="Methods" id="Methods"></a>
|
|
31463
|
+
|
|
31464
|
+
| **Name** | **Description** |
|
|
31465
|
+
| --- | --- |
|
|
31466
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.FileScriptCode.codeAsString">codeAsString</a></code> | *No description.* |
|
|
31467
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.FileScriptCode.createOrGetFile">createOrGetFile</a></code> | If there is a file for this code, return it. |
|
|
31468
|
+
|
|
31469
|
+
---
|
|
31470
|
+
|
|
31471
|
+
##### `codeAsString` <a name="codeAsString" id="@cdklabs/cdk-ssm-documents.FileScriptCode.codeAsString"></a>
|
|
31472
|
+
|
|
31473
|
+
```typescript
|
|
31474
|
+
public codeAsString(): string
|
|
31475
|
+
```
|
|
31476
|
+
|
|
31477
|
+
##### `createOrGetFile` <a name="createOrGetFile" id="@cdklabs/cdk-ssm-documents.FileScriptCode.createOrGetFile"></a>
|
|
31478
|
+
|
|
31479
|
+
```typescript
|
|
31480
|
+
public createOrGetFile(_suffix: string): string
|
|
31481
|
+
```
|
|
31482
|
+
|
|
31483
|
+
If there is a file for this code, return it.
|
|
31484
|
+
|
|
31485
|
+
Otherwise, create a file with the specified suffix.
|
|
31486
|
+
|
|
31487
|
+
###### `_suffix`<sup>Required</sup> <a name="_suffix" id="@cdklabs/cdk-ssm-documents.FileScriptCode.createOrGetFile.parameter._suffix"></a>
|
|
31488
|
+
|
|
31489
|
+
- *Type:* string
|
|
31490
|
+
|
|
31491
|
+
---
|
|
31492
|
+
|
|
31493
|
+
#### Static Functions <a name="Static Functions" id="Static Functions"></a>
|
|
31494
|
+
|
|
31495
|
+
| **Name** | **Description** |
|
|
31496
|
+
| --- | --- |
|
|
31497
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.FileScriptCode.fromFile">fromFile</a></code> | Full path to the code to execute. |
|
|
31498
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.FileScriptCode.inline">inline</a></code> | Inline code to be executed. |
|
|
31499
|
+
|
|
31500
|
+
---
|
|
31501
|
+
|
|
31502
|
+
##### `fromFile` <a name="fromFile" id="@cdklabs/cdk-ssm-documents.FileScriptCode.fromFile"></a>
|
|
31503
|
+
|
|
31504
|
+
```typescript
|
|
31505
|
+
import { FileScriptCode } from '@cdklabs/cdk-ssm-documents'
|
|
31506
|
+
|
|
31507
|
+
FileScriptCode.fromFile(fullPath: string)
|
|
31508
|
+
```
|
|
31509
|
+
|
|
31510
|
+
Full path to the code to execute.
|
|
31511
|
+
|
|
31512
|
+
File is parsed to produce yaml/json.
|
|
31513
|
+
Simulation will execute this file using the language specified.
|
|
31514
|
+
(Attachments not yet supported)
|
|
31515
|
+
|
|
31516
|
+
###### `fullPath`<sup>Required</sup> <a name="fullPath" id="@cdklabs/cdk-ssm-documents.FileScriptCode.fromFile.parameter.fullPath"></a>
|
|
31517
|
+
|
|
31518
|
+
- *Type:* string
|
|
31519
|
+
|
|
31520
|
+
---
|
|
31521
|
+
|
|
31522
|
+
##### `inline` <a name="inline" id="@cdklabs/cdk-ssm-documents.FileScriptCode.inline"></a>
|
|
31523
|
+
|
|
31524
|
+
```typescript
|
|
31525
|
+
import { FileScriptCode } from '@cdklabs/cdk-ssm-documents'
|
|
31526
|
+
|
|
31527
|
+
FileScriptCode.inline(code: string)
|
|
31528
|
+
```
|
|
31529
|
+
|
|
31530
|
+
Inline code to be executed.
|
|
31531
|
+
|
|
31532
|
+
String will be used to produce function in yaml/json.
|
|
31533
|
+
Simulation will execute the function in this string using the language specified.
|
|
31534
|
+
|
|
31535
|
+
###### `code`<sup>Required</sup> <a name="code" id="@cdklabs/cdk-ssm-documents.FileScriptCode.inline.parameter.code"></a>
|
|
31536
|
+
|
|
31537
|
+
- *Type:* string
|
|
31538
|
+
|
|
31539
|
+
---
|
|
31540
|
+
|
|
31541
|
+
#### Properties <a name="Properties" id="Properties"></a>
|
|
31542
|
+
|
|
31543
|
+
| **Name** | **Type** | **Description** |
|
|
31544
|
+
| --- | --- | --- |
|
|
31545
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.FileScriptCode.property.fullPath">fullPath</a></code> | <code>string</code> | *No description.* |
|
|
31546
|
+
|
|
31547
|
+
---
|
|
31548
|
+
|
|
31549
|
+
##### `fullPath`<sup>Required</sup> <a name="fullPath" id="@cdklabs/cdk-ssm-documents.FileScriptCode.property.fullPath"></a>
|
|
31550
|
+
|
|
31551
|
+
```typescript
|
|
31552
|
+
public readonly fullPath: string;
|
|
31553
|
+
```
|
|
31554
|
+
|
|
31555
|
+
- *Type:* string
|
|
31556
|
+
|
|
31557
|
+
---
|
|
31558
|
+
|
|
31559
|
+
|
|
31495
31560
|
### GenericVariable <a name="GenericVariable" id="@cdklabs/cdk-ssm-documents.GenericVariable"></a>
|
|
31496
31561
|
|
|
31497
31562
|
- *Implements:* <a href="#@cdklabs/cdk-ssm-documents.IGenericVariable">IGenericVariable</a>
|
|
@@ -34423,6 +34488,126 @@ public readonly authMethod: AuthMethod;
|
|
|
34423
34488
|
---
|
|
34424
34489
|
|
|
34425
34490
|
|
|
34491
|
+
### InlineScriptCode <a name="InlineScriptCode" id="@cdklabs/cdk-ssm-documents.InlineScriptCode"></a>
|
|
34492
|
+
|
|
34493
|
+
#### Initializers <a name="Initializers" id="@cdklabs/cdk-ssm-documents.InlineScriptCode.Initializer"></a>
|
|
34494
|
+
|
|
34495
|
+
```typescript
|
|
34496
|
+
import { InlineScriptCode } from '@cdklabs/cdk-ssm-documents'
|
|
34497
|
+
|
|
34498
|
+
new InlineScriptCode(inlineCode: string)
|
|
34499
|
+
```
|
|
34500
|
+
|
|
34501
|
+
| **Name** | **Type** | **Description** |
|
|
34502
|
+
| --- | --- | --- |
|
|
34503
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.InlineScriptCode.Initializer.parameter.inlineCode">inlineCode</a></code> | <code>string</code> | *No description.* |
|
|
34504
|
+
|
|
34505
|
+
---
|
|
34506
|
+
|
|
34507
|
+
##### `inlineCode`<sup>Required</sup> <a name="inlineCode" id="@cdklabs/cdk-ssm-documents.InlineScriptCode.Initializer.parameter.inlineCode"></a>
|
|
34508
|
+
|
|
34509
|
+
- *Type:* string
|
|
34510
|
+
|
|
34511
|
+
---
|
|
34512
|
+
|
|
34513
|
+
#### Methods <a name="Methods" id="Methods"></a>
|
|
34514
|
+
|
|
34515
|
+
| **Name** | **Description** |
|
|
34516
|
+
| --- | --- |
|
|
34517
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.InlineScriptCode.codeAsString">codeAsString</a></code> | *No description.* |
|
|
34518
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.InlineScriptCode.createOrGetFile">createOrGetFile</a></code> | If there is a file for this code, return it. |
|
|
34519
|
+
|
|
34520
|
+
---
|
|
34521
|
+
|
|
34522
|
+
##### `codeAsString` <a name="codeAsString" id="@cdklabs/cdk-ssm-documents.InlineScriptCode.codeAsString"></a>
|
|
34523
|
+
|
|
34524
|
+
```typescript
|
|
34525
|
+
public codeAsString(): string
|
|
34526
|
+
```
|
|
34527
|
+
|
|
34528
|
+
##### `createOrGetFile` <a name="createOrGetFile" id="@cdklabs/cdk-ssm-documents.InlineScriptCode.createOrGetFile"></a>
|
|
34529
|
+
|
|
34530
|
+
```typescript
|
|
34531
|
+
public createOrGetFile(suffix: string): string
|
|
34532
|
+
```
|
|
34533
|
+
|
|
34534
|
+
If there is a file for this code, return it.
|
|
34535
|
+
|
|
34536
|
+
Otherwise, create a file with the specified suffix.
|
|
34537
|
+
|
|
34538
|
+
###### `suffix`<sup>Required</sup> <a name="suffix" id="@cdklabs/cdk-ssm-documents.InlineScriptCode.createOrGetFile.parameter.suffix"></a>
|
|
34539
|
+
|
|
34540
|
+
- *Type:* string
|
|
34541
|
+
|
|
34542
|
+
---
|
|
34543
|
+
|
|
34544
|
+
#### Static Functions <a name="Static Functions" id="Static Functions"></a>
|
|
34545
|
+
|
|
34546
|
+
| **Name** | **Description** |
|
|
34547
|
+
| --- | --- |
|
|
34548
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.InlineScriptCode.fromFile">fromFile</a></code> | Full path to the code to execute. |
|
|
34549
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.InlineScriptCode.inline">inline</a></code> | Inline code to be executed. |
|
|
34550
|
+
|
|
34551
|
+
---
|
|
34552
|
+
|
|
34553
|
+
##### `fromFile` <a name="fromFile" id="@cdklabs/cdk-ssm-documents.InlineScriptCode.fromFile"></a>
|
|
34554
|
+
|
|
34555
|
+
```typescript
|
|
34556
|
+
import { InlineScriptCode } from '@cdklabs/cdk-ssm-documents'
|
|
34557
|
+
|
|
34558
|
+
InlineScriptCode.fromFile(fullPath: string)
|
|
34559
|
+
```
|
|
34560
|
+
|
|
34561
|
+
Full path to the code to execute.
|
|
34562
|
+
|
|
34563
|
+
File is parsed to produce yaml/json.
|
|
34564
|
+
Simulation will execute this file using the language specified.
|
|
34565
|
+
(Attachments not yet supported)
|
|
34566
|
+
|
|
34567
|
+
###### `fullPath`<sup>Required</sup> <a name="fullPath" id="@cdklabs/cdk-ssm-documents.InlineScriptCode.fromFile.parameter.fullPath"></a>
|
|
34568
|
+
|
|
34569
|
+
- *Type:* string
|
|
34570
|
+
|
|
34571
|
+
---
|
|
34572
|
+
|
|
34573
|
+
##### `inline` <a name="inline" id="@cdklabs/cdk-ssm-documents.InlineScriptCode.inline"></a>
|
|
34574
|
+
|
|
34575
|
+
```typescript
|
|
34576
|
+
import { InlineScriptCode } from '@cdklabs/cdk-ssm-documents'
|
|
34577
|
+
|
|
34578
|
+
InlineScriptCode.inline(code: string)
|
|
34579
|
+
```
|
|
34580
|
+
|
|
34581
|
+
Inline code to be executed.
|
|
34582
|
+
|
|
34583
|
+
String will be used to produce function in yaml/json.
|
|
34584
|
+
Simulation will execute the function in this string using the language specified.
|
|
34585
|
+
|
|
34586
|
+
###### `code`<sup>Required</sup> <a name="code" id="@cdklabs/cdk-ssm-documents.InlineScriptCode.inline.parameter.code"></a>
|
|
34587
|
+
|
|
34588
|
+
- *Type:* string
|
|
34589
|
+
|
|
34590
|
+
---
|
|
34591
|
+
|
|
34592
|
+
#### Properties <a name="Properties" id="Properties"></a>
|
|
34593
|
+
|
|
34594
|
+
| **Name** | **Type** | **Description** |
|
|
34595
|
+
| --- | --- | --- |
|
|
34596
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.InlineScriptCode.property.inlineCode">inlineCode</a></code> | <code>string</code> | *No description.* |
|
|
34597
|
+
|
|
34598
|
+
---
|
|
34599
|
+
|
|
34600
|
+
##### `inlineCode`<sup>Required</sup> <a name="inlineCode" id="@cdklabs/cdk-ssm-documents.InlineScriptCode.property.inlineCode"></a>
|
|
34601
|
+
|
|
34602
|
+
```typescript
|
|
34603
|
+
public readonly inlineCode: string;
|
|
34604
|
+
```
|
|
34605
|
+
|
|
34606
|
+
- *Type:* string
|
|
34607
|
+
|
|
34608
|
+
---
|
|
34609
|
+
|
|
34610
|
+
|
|
34426
34611
|
### Input <a name="Input" id="@cdklabs/cdk-ssm-documents.Input"></a>
|
|
34427
34612
|
|
|
34428
34613
|
#### Initializers <a name="Initializers" id="@cdklabs/cdk-ssm-documents.Input.Initializer"></a>
|
|
@@ -37928,6 +38113,249 @@ public readonly sourceType: string;
|
|
|
37928
38113
|
---
|
|
37929
38114
|
|
|
37930
38115
|
|
|
38116
|
+
### ScriptCode <a name="ScriptCode" id="@cdklabs/cdk-ssm-documents.ScriptCode"></a>
|
|
38117
|
+
|
|
38118
|
+
The code to run for the execution.
|
|
38119
|
+
|
|
38120
|
+
See "script" parameter here:
|
|
38121
|
+
https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-action-executeScript.html
|
|
38122
|
+
Attachments are not yet supported.
|
|
38123
|
+
|
|
38124
|
+
#### Initializers <a name="Initializers" id="@cdklabs/cdk-ssm-documents.ScriptCode.Initializer"></a>
|
|
38125
|
+
|
|
38126
|
+
```typescript
|
|
38127
|
+
import { ScriptCode } from '@cdklabs/cdk-ssm-documents'
|
|
38128
|
+
|
|
38129
|
+
new ScriptCode()
|
|
38130
|
+
```
|
|
38131
|
+
|
|
38132
|
+
| **Name** | **Type** | **Description** |
|
|
38133
|
+
| --- | --- | --- |
|
|
38134
|
+
|
|
38135
|
+
---
|
|
38136
|
+
|
|
38137
|
+
#### Methods <a name="Methods" id="Methods"></a>
|
|
38138
|
+
|
|
38139
|
+
| **Name** | **Description** |
|
|
38140
|
+
| --- | --- |
|
|
38141
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.ScriptCode.codeAsString">codeAsString</a></code> | *No description.* |
|
|
38142
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.ScriptCode.createOrGetFile">createOrGetFile</a></code> | If there is a file for this code, return it. |
|
|
38143
|
+
|
|
38144
|
+
---
|
|
38145
|
+
|
|
38146
|
+
##### `codeAsString` <a name="codeAsString" id="@cdklabs/cdk-ssm-documents.ScriptCode.codeAsString"></a>
|
|
38147
|
+
|
|
38148
|
+
```typescript
|
|
38149
|
+
public codeAsString(): string
|
|
38150
|
+
```
|
|
38151
|
+
|
|
38152
|
+
##### `createOrGetFile` <a name="createOrGetFile" id="@cdklabs/cdk-ssm-documents.ScriptCode.createOrGetFile"></a>
|
|
38153
|
+
|
|
38154
|
+
```typescript
|
|
38155
|
+
public createOrGetFile(suffix: string): string
|
|
38156
|
+
```
|
|
38157
|
+
|
|
38158
|
+
If there is a file for this code, return it.
|
|
38159
|
+
|
|
38160
|
+
Otherwise, create a file with the specified suffix.
|
|
38161
|
+
|
|
38162
|
+
###### `suffix`<sup>Required</sup> <a name="suffix" id="@cdklabs/cdk-ssm-documents.ScriptCode.createOrGetFile.parameter.suffix"></a>
|
|
38163
|
+
|
|
38164
|
+
- *Type:* string
|
|
38165
|
+
|
|
38166
|
+
of the file to create (such as ".py").
|
|
38167
|
+
|
|
38168
|
+
---
|
|
38169
|
+
|
|
38170
|
+
#### Static Functions <a name="Static Functions" id="Static Functions"></a>
|
|
38171
|
+
|
|
38172
|
+
| **Name** | **Description** |
|
|
38173
|
+
| --- | --- |
|
|
38174
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.ScriptCode.fromFile">fromFile</a></code> | Full path to the code to execute. |
|
|
38175
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.ScriptCode.inline">inline</a></code> | Inline code to be executed. |
|
|
38176
|
+
|
|
38177
|
+
---
|
|
38178
|
+
|
|
38179
|
+
##### `fromFile` <a name="fromFile" id="@cdklabs/cdk-ssm-documents.ScriptCode.fromFile"></a>
|
|
38180
|
+
|
|
38181
|
+
```typescript
|
|
38182
|
+
import { ScriptCode } from '@cdklabs/cdk-ssm-documents'
|
|
38183
|
+
|
|
38184
|
+
ScriptCode.fromFile(fullPath: string)
|
|
38185
|
+
```
|
|
38186
|
+
|
|
38187
|
+
Full path to the code to execute.
|
|
38188
|
+
|
|
38189
|
+
File is parsed to produce yaml/json.
|
|
38190
|
+
Simulation will execute this file using the language specified.
|
|
38191
|
+
(Attachments not yet supported)
|
|
38192
|
+
|
|
38193
|
+
###### `fullPath`<sup>Required</sup> <a name="fullPath" id="@cdklabs/cdk-ssm-documents.ScriptCode.fromFile.parameter.fullPath"></a>
|
|
38194
|
+
|
|
38195
|
+
- *Type:* string
|
|
38196
|
+
|
|
38197
|
+
---
|
|
38198
|
+
|
|
38199
|
+
##### `inline` <a name="inline" id="@cdklabs/cdk-ssm-documents.ScriptCode.inline"></a>
|
|
38200
|
+
|
|
38201
|
+
```typescript
|
|
38202
|
+
import { ScriptCode } from '@cdklabs/cdk-ssm-documents'
|
|
38203
|
+
|
|
38204
|
+
ScriptCode.inline(code: string)
|
|
38205
|
+
```
|
|
38206
|
+
|
|
38207
|
+
Inline code to be executed.
|
|
38208
|
+
|
|
38209
|
+
String will be used to produce function in yaml/json.
|
|
38210
|
+
Simulation will execute the function in this string using the language specified.
|
|
38211
|
+
|
|
38212
|
+
###### `code`<sup>Required</sup> <a name="code" id="@cdklabs/cdk-ssm-documents.ScriptCode.inline.parameter.code"></a>
|
|
38213
|
+
|
|
38214
|
+
- *Type:* string
|
|
38215
|
+
|
|
38216
|
+
---
|
|
38217
|
+
|
|
38218
|
+
|
|
38219
|
+
|
|
38220
|
+
### ScriptLanguage <a name="ScriptLanguage" id="@cdklabs/cdk-ssm-documents.ScriptLanguage"></a>
|
|
38221
|
+
|
|
38222
|
+
Specifies the script language as described in the "Runtime" argument here: https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-action-executeScript.html.
|
|
38223
|
+
|
|
38224
|
+
#### Initializers <a name="Initializers" id="@cdklabs/cdk-ssm-documents.ScriptLanguage.Initializer"></a>
|
|
38225
|
+
|
|
38226
|
+
```typescript
|
|
38227
|
+
import { ScriptLanguage } from '@cdklabs/cdk-ssm-documents'
|
|
38228
|
+
|
|
38229
|
+
new ScriptLanguage()
|
|
38230
|
+
```
|
|
38231
|
+
|
|
38232
|
+
| **Name** | **Type** | **Description** |
|
|
38233
|
+
| --- | --- | --- |
|
|
38234
|
+
|
|
38235
|
+
---
|
|
38236
|
+
|
|
38237
|
+
#### Methods <a name="Methods" id="Methods"></a>
|
|
38238
|
+
|
|
38239
|
+
| **Name** | **Description** |
|
|
38240
|
+
| --- | --- |
|
|
38241
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.ScriptLanguage.fileSuffix">fileSuffix</a></code> | The suffix to apply to file names of this type of execution. |
|
|
38242
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.ScriptLanguage.runtime">runtime</a></code> | The associated runtime of this ScriptLanguage. |
|
|
38243
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.ScriptLanguage.simulate">simulate</a></code> | Simulate an execution of this ScriptLanguage. |
|
|
38244
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.ScriptLanguage.ssmInputs">ssmInputs</a></code> | Builds the ssm inputs. |
|
|
38245
|
+
|
|
38246
|
+
---
|
|
38247
|
+
|
|
38248
|
+
##### `fileSuffix` <a name="fileSuffix" id="@cdklabs/cdk-ssm-documents.ScriptLanguage.fileSuffix"></a>
|
|
38249
|
+
|
|
38250
|
+
```typescript
|
|
38251
|
+
public fileSuffix(): string
|
|
38252
|
+
```
|
|
38253
|
+
|
|
38254
|
+
The suffix to apply to file names of this type of execution.
|
|
38255
|
+
|
|
38256
|
+
##### `runtime` <a name="runtime" id="@cdklabs/cdk-ssm-documents.ScriptLanguage.runtime"></a>
|
|
38257
|
+
|
|
38258
|
+
```typescript
|
|
38259
|
+
public runtime(): string
|
|
38260
|
+
```
|
|
38261
|
+
|
|
38262
|
+
The associated runtime of this ScriptLanguage.
|
|
38263
|
+
|
|
38264
|
+
##### `simulate` <a name="simulate" id="@cdklabs/cdk-ssm-documents.ScriptLanguage.simulate"></a>
|
|
38265
|
+
|
|
38266
|
+
```typescript
|
|
38267
|
+
public simulate(code: ScriptCode, inputs: {[ key: string ]: string}): {[ key: string ]: string}
|
|
38268
|
+
```
|
|
38269
|
+
|
|
38270
|
+
Simulate an execution of this ScriptLanguage.
|
|
38271
|
+
|
|
38272
|
+
Provide the inputs after replaced with the actual values (not variables).
|
|
38273
|
+
|
|
38274
|
+
###### `code`<sup>Required</sup> <a name="code" id="@cdklabs/cdk-ssm-documents.ScriptLanguage.simulate.parameter.code"></a>
|
|
38275
|
+
|
|
38276
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.ScriptCode">ScriptCode</a>
|
|
38277
|
+
|
|
38278
|
+
---
|
|
38279
|
+
|
|
38280
|
+
###### `inputs`<sup>Required</sup> <a name="inputs" id="@cdklabs/cdk-ssm-documents.ScriptLanguage.simulate.parameter.inputs"></a>
|
|
38281
|
+
|
|
38282
|
+
- *Type:* {[ key: string ]: string}
|
|
38283
|
+
|
|
38284
|
+
---
|
|
38285
|
+
|
|
38286
|
+
##### `ssmInputs` <a name="ssmInputs" id="@cdklabs/cdk-ssm-documents.ScriptLanguage.ssmInputs"></a>
|
|
38287
|
+
|
|
38288
|
+
```typescript
|
|
38289
|
+
public ssmInputs(): {[ key: string ]: string}
|
|
38290
|
+
```
|
|
38291
|
+
|
|
38292
|
+
Builds the ssm inputs.
|
|
38293
|
+
|
|
38294
|
+
#### Static Functions <a name="Static Functions" id="Static Functions"></a>
|
|
38295
|
+
|
|
38296
|
+
| **Name** | **Description** |
|
|
38297
|
+
| --- | --- |
|
|
38298
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.ScriptLanguage.fromRuntime">fromRuntime</a></code> | Creates a ScriptLanguage based on the provided runtime. |
|
|
38299
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.ScriptLanguage.python">python</a></code> | Create a new ScriptLanguage for python execution. |
|
|
38300
|
+
|
|
38301
|
+
---
|
|
38302
|
+
|
|
38303
|
+
##### `fromRuntime` <a name="fromRuntime" id="@cdklabs/cdk-ssm-documents.ScriptLanguage.fromRuntime"></a>
|
|
38304
|
+
|
|
38305
|
+
```typescript
|
|
38306
|
+
import { ScriptLanguage } from '@cdklabs/cdk-ssm-documents'
|
|
38307
|
+
|
|
38308
|
+
ScriptLanguage.fromRuntime(runtime: string, handlerName?: string)
|
|
38309
|
+
```
|
|
38310
|
+
|
|
38311
|
+
Creates a ScriptLanguage based on the provided runtime.
|
|
38312
|
+
|
|
38313
|
+
Prefer one of the other static constructors if possible.
|
|
38314
|
+
|
|
38315
|
+
###### `runtime`<sup>Required</sup> <a name="runtime" id="@cdklabs/cdk-ssm-documents.ScriptLanguage.fromRuntime.parameter.runtime"></a>
|
|
38316
|
+
|
|
38317
|
+
- *Type:* string
|
|
38318
|
+
|
|
38319
|
+
is the runtime name (such as "python3.6").
|
|
38320
|
+
|
|
38321
|
+
---
|
|
38322
|
+
|
|
38323
|
+
###### `handlerName`<sup>Optional</sup> <a name="handlerName" id="@cdklabs/cdk-ssm-documents.ScriptLanguage.fromRuntime.parameter.handlerName"></a>
|
|
38324
|
+
|
|
38325
|
+
- *Type:* string
|
|
38326
|
+
|
|
38327
|
+
to be provided for python executions.
|
|
38328
|
+
|
|
38329
|
+
---
|
|
38330
|
+
|
|
38331
|
+
##### `python` <a name="python" id="@cdklabs/cdk-ssm-documents.ScriptLanguage.python"></a>
|
|
38332
|
+
|
|
38333
|
+
```typescript
|
|
38334
|
+
import { ScriptLanguage } from '@cdklabs/cdk-ssm-documents'
|
|
38335
|
+
|
|
38336
|
+
ScriptLanguage.python(version: PythonVersion, handlerName: string)
|
|
38337
|
+
```
|
|
38338
|
+
|
|
38339
|
+
Create a new ScriptLanguage for python execution.
|
|
38340
|
+
|
|
38341
|
+
###### `version`<sup>Required</sup> <a name="version" id="@cdklabs/cdk-ssm-documents.ScriptLanguage.python.parameter.version"></a>
|
|
38342
|
+
|
|
38343
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.PythonVersion">PythonVersion</a>
|
|
38344
|
+
|
|
38345
|
+
is the pythonVersion to use when writing the document (for simulation will not matter).
|
|
38346
|
+
|
|
38347
|
+
---
|
|
38348
|
+
|
|
38349
|
+
###### `handlerName`<sup>Required</sup> <a name="handlerName" id="@cdklabs/cdk-ssm-documents.ScriptLanguage.python.parameter.handlerName"></a>
|
|
38350
|
+
|
|
38351
|
+
- *Type:* string
|
|
38352
|
+
|
|
38353
|
+
is the function name in code as entry point for script handler.
|
|
38354
|
+
|
|
38355
|
+
---
|
|
38356
|
+
|
|
38357
|
+
|
|
38358
|
+
|
|
37931
38359
|
### SecureVariable <a name="SecureVariable" id="@cdklabs/cdk-ssm-documents.SecureVariable"></a>
|
|
37932
38360
|
|
|
37933
38361
|
- *Implements:* <a href="#@cdklabs/cdk-ssm-documents.IGenericVariable">IGenericVariable</a>
|
|
@@ -40982,49 +41410,65 @@ That allows customers to validate their CommandDocument against a given platform
|
|
|
40982
41410
|
---
|
|
40983
41411
|
|
|
40984
41412
|
|
|
40985
|
-
###
|
|
41413
|
+
### PythonVersion <a name="PythonVersion" id="@cdklabs/cdk-ssm-documents.PythonVersion"></a>
|
|
40986
41414
|
|
|
40987
|
-
|
|
41415
|
+
Python runtime to use when writing SSM Document.
|
|
40988
41416
|
|
|
40989
|
-
|
|
40990
|
-
A failed/canceled response will contain the stackTrace.
|
|
41417
|
+
Simulation will use local python version.
|
|
40991
41418
|
|
|
40992
41419
|
#### Members <a name="Members" id="Members"></a>
|
|
40993
41420
|
|
|
40994
41421
|
| **Name** | **Description** |
|
|
40995
41422
|
| --- | --- |
|
|
40996
|
-
| <code><a href="#@cdklabs/cdk-ssm-documents.
|
|
40997
|
-
| <code><a href="#@cdklabs/cdk-ssm-documents.
|
|
40998
|
-
| <code><a href="#@cdklabs/cdk-ssm-documents.
|
|
41423
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.PythonVersion.VERSION_3_6">VERSION_3_6</a></code> | *No description.* |
|
|
41424
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.PythonVersion.VERSION_3_7">VERSION_3_7</a></code> | *No description.* |
|
|
41425
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.PythonVersion.VERSION_3_8">VERSION_3_8</a></code> | *No description.* |
|
|
40999
41426
|
|
|
41000
41427
|
---
|
|
41001
41428
|
|
|
41002
|
-
##### `
|
|
41429
|
+
##### `VERSION_3_6` <a name="VERSION_3_6" id="@cdklabs/cdk-ssm-documents.PythonVersion.VERSION_3_6"></a>
|
|
41003
41430
|
|
|
41004
41431
|
---
|
|
41005
41432
|
|
|
41006
41433
|
|
|
41007
|
-
##### `
|
|
41434
|
+
##### `VERSION_3_7` <a name="VERSION_3_7" id="@cdklabs/cdk-ssm-documents.PythonVersion.VERSION_3_7"></a>
|
|
41008
41435
|
|
|
41009
41436
|
---
|
|
41010
41437
|
|
|
41011
41438
|
|
|
41012
|
-
##### `
|
|
41439
|
+
##### `VERSION_3_8` <a name="VERSION_3_8" id="@cdklabs/cdk-ssm-documents.PythonVersion.VERSION_3_8"></a>
|
|
41013
41440
|
|
|
41014
41441
|
---
|
|
41015
41442
|
|
|
41016
41443
|
|
|
41017
|
-
###
|
|
41444
|
+
### ResponseCode <a name="ResponseCode" id="@cdklabs/cdk-ssm-documents.ResponseCode"></a>
|
|
41445
|
+
|
|
41446
|
+
Steps report their ResponseCode using this enum.
|
|
41447
|
+
|
|
41448
|
+
A successful response will contain the outputs expected.
|
|
41449
|
+
A failed/canceled response will contain the stackTrace.
|
|
41018
41450
|
|
|
41019
41451
|
#### Members <a name="Members" id="Members"></a>
|
|
41020
41452
|
|
|
41021
41453
|
| **Name** | **Description** |
|
|
41022
41454
|
| --- | --- |
|
|
41023
|
-
| <code><a href="#@cdklabs/cdk-ssm-documents.
|
|
41455
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.ResponseCode.SUCCESS">SUCCESS</a></code> | *No description.* |
|
|
41456
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.ResponseCode.CANCELED">CANCELED</a></code> | *No description.* |
|
|
41457
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.ResponseCode.FAILED">FAILED</a></code> | *No description.* |
|
|
41024
41458
|
|
|
41025
41459
|
---
|
|
41026
41460
|
|
|
41027
|
-
##### `
|
|
41461
|
+
##### `SUCCESS` <a name="SUCCESS" id="@cdklabs/cdk-ssm-documents.ResponseCode.SUCCESS"></a>
|
|
41462
|
+
|
|
41463
|
+
---
|
|
41464
|
+
|
|
41465
|
+
|
|
41466
|
+
##### `CANCELED` <a name="CANCELED" id="@cdklabs/cdk-ssm-documents.ResponseCode.CANCELED"></a>
|
|
41467
|
+
|
|
41468
|
+
---
|
|
41469
|
+
|
|
41470
|
+
|
|
41471
|
+
##### `FAILED` <a name="FAILED" id="@cdklabs/cdk-ssm-documents.ResponseCode.FAILED"></a>
|
|
41028
41472
|
|
|
41029
41473
|
---
|
|
41030
41474
|
|