@cdklabs/cdk-ssm-documents 0.0.15 → 0.0.16
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 +2338 -1258
- package/API.md +898 -77
- package/README.md +2 -5
- package/changelog.md +6 -1
- package/lib/construct/synth-utils.js +1 -1
- package/lib/document/automation-document.js +3 -3
- package/lib/document/command-document.js +3 -3
- package/lib/document/document-builder.js +2 -2
- package/lib/document/ssm-document.js +5 -26
- 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.d.ts +179 -3
- package/lib/domain/input.js +139 -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/pause-hook.js +2 -2
- package/lib/interface/run-command-hook/api-run-command-hook.js +1 -1
- package/lib/interface/run-command-hook.d.ts +1 -1
- package/lib/interface/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/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 +7 -7
- 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.d.ts +3 -3
- package/lib/interface/variables/variable.js +5 -5
- 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.d.ts +2 -2
- package/lib/parent-steps/automation/aws-api-step.js +3 -3
- 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 +3 -3
- package/lib/parent-steps/automation/execute-automation-step.js +1 -1
- package/lib/parent-steps/automation/execute-script-step.js +1 -1
- package/lib/parent-steps/automation/execute-state-machine-step.js +1 -1
- package/lib/parent-steps/automation/invoke-lambda-function-step.js +1 -1
- package/lib/parent-steps/automation/invoke-webhook-step.js +1 -1
- package/lib/parent-steps/automation/pause-step.js +1 -1
- package/lib/parent-steps/automation/run-command-step.d.ts +1 -1
- package/lib/parent-steps/automation/run-command-step.js +4 -4
- 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.d.ts +1 -1
- package/lib/parent-steps/command/configure-package-step.js +2 -2
- 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 +12 -2
- package/lib/patterns/document/string-document.js +6 -4
- package/lib/patterns/document/timed-document.js +1 -1
- package/lib/samples/hello-world.js +7 -11
- 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.d.ts +1 -1
- package/lib/simulation/automation/aws-api-simulation.js +3 -3
- package/lib/simulation/automation/branch-simulation.js +1 -1
- package/lib/simulation/automation/change-instance-state-simulation.js +1 -1
- package/lib/simulation/automation/copy-image-simulation.js +1 -1
- package/lib/simulation/automation/create-image-simulation.js +1 -1
- package/lib/simulation/automation/create-stack-simulation.js +1 -1
- package/lib/simulation/automation/create-tags-simulation.js +1 -1
- package/lib/simulation/automation/delete-image-simulation.js +1 -1
- package/lib/simulation/automation/delete-stack-simulation.js +1 -1
- package/lib/simulation/automation/execute-script-simulation.js +1 -1
- package/lib/simulation/automation/execute-state-machine-simulation.js +1 -1
- package/lib/simulation/automation/invoke-lambda-function-simulation.js +1 -1
- package/lib/simulation/automation/invoke-webhook-simulation.js +1 -1
- package/lib/simulation/automation/pause-simulation.js +1 -1
- package/lib/simulation/automation/run-command-simulation.js +1 -1
- package/lib/simulation/automation/run-instance-simulation.js +1 -1
- package/lib/simulation/automation/sleep-simulation.js +1 -1
- package/lib/simulation/automation/wait-for-resource-simulation.js +1 -1
- package/lib/simulation/automation-step-simulation.js +1 -1
- package/lib/simulation/command/command-simulation-base.js +1 -1
- package/lib/simulation/command/ps-module-simulation.js +1 -1
- package/lib/simulation/command/run-powershell-script-simulation.js +1 -1
- package/lib/simulation/command/run-shell-script-simulation.js +1 -1
- package/lib/simulation/command-step-simulation.js +1 -1
- package/lib/simulation/document/automation-simulation.js +1 -1
- package/lib/simulation/document/command-simulation.js +1 -1
- package/lib/simulation/simulation.js +7 -15
- package/package.json +1 -1
- package/releasetag.txt +1 -1
- package/version.txt +1 -1
package/API.md
CHANGED
|
@@ -734,7 +734,7 @@ new AssertAwsResourceStep(scope: Construct, id: string, props: AssertAwsResource
|
|
|
734
734
|
| **Name** | **Description** |
|
|
735
735
|
| --- | --- |
|
|
736
736
|
| <code><a href="#@cdklabs/cdk-ssm-documents.AssertAwsResourceStep.toString">toString</a></code> | Returns a string representation of this construct. |
|
|
737
|
-
| <code><a href="#@cdklabs/cdk-ssm-documents.AssertAwsResourceStep.listInputs">listInputs</a></code> | Derives the inputs by parsing the apiParams to find matches for inputs in double circle braces ("{{INPUT}}"). |
|
|
737
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.AssertAwsResourceStep.listInputs">listInputs</a></code> | Derives the inputs by parsing the apiParams to find matches for inputs in double circle braces ("{{ INPUT }}"). |
|
|
738
738
|
| <code><a href="#@cdklabs/cdk-ssm-documents.AssertAwsResourceStep.listOutputs">listOutputs</a></code> | There are no outputs for this step. |
|
|
739
739
|
| <code><a href="#@cdklabs/cdk-ssm-documents.AssertAwsResourceStep.toSsmEntry">toSsmEntry</a></code> | Converts this step into an object to prepare for yaml/json representation of this step. |
|
|
740
740
|
| <code><a href="#@cdklabs/cdk-ssm-documents.AssertAwsResourceStep.addToDocument">addToDocument</a></code> | *No description.* |
|
|
@@ -756,7 +756,7 @@ Returns a string representation of this construct.
|
|
|
756
756
|
public listInputs(): string[]
|
|
757
757
|
```
|
|
758
758
|
|
|
759
|
-
Derives the inputs by parsing the apiParams to find matches for inputs in double circle braces ("{{INPUT}}").
|
|
759
|
+
Derives the inputs by parsing the apiParams to find matches for inputs in double circle braces ("{{ INPUT }}").
|
|
760
760
|
|
|
761
761
|
##### `listOutputs` <a name="listOutputs" id="@cdklabs/cdk-ssm-documents.AssertAwsResourceStep.listOutputs"></a>
|
|
762
762
|
|
|
@@ -1668,7 +1668,7 @@ new AwsApiStep(scope: Construct, id: string, props: AwsApiStepProps)
|
|
|
1668
1668
|
| **Name** | **Description** |
|
|
1669
1669
|
| --- | --- |
|
|
1670
1670
|
| <code><a href="#@cdklabs/cdk-ssm-documents.AwsApiStep.toString">toString</a></code> | Returns a string representation of this construct. |
|
|
1671
|
-
| <code><a href="#@cdklabs/cdk-ssm-documents.AwsApiStep.listInputs">listInputs</a></code> | Derives the inputs by parsing the apiParams to find matches for inputs in double circle braces ("{{INPUT}}"). |
|
|
1671
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.AwsApiStep.listInputs">listInputs</a></code> | Derives the inputs by parsing the apiParams to find matches for inputs in double circle braces ("{{ INPUT }}"). |
|
|
1672
1672
|
| <code><a href="#@cdklabs/cdk-ssm-documents.AwsApiStep.listOutputs">listOutputs</a></code> | Lists the outputs that will be returned from this step. |
|
|
1673
1673
|
| <code><a href="#@cdklabs/cdk-ssm-documents.AwsApiStep.toSsmEntry">toSsmEntry</a></code> | Converts this step into an object to prepare for yaml/json representation of this step. |
|
|
1674
1674
|
| <code><a href="#@cdklabs/cdk-ssm-documents.AwsApiStep.addToDocument">addToDocument</a></code> | *No description.* |
|
|
@@ -1690,7 +1690,7 @@ Returns a string representation of this construct.
|
|
|
1690
1690
|
public listInputs(): string[]
|
|
1691
1691
|
```
|
|
1692
1692
|
|
|
1693
|
-
Derives the inputs by parsing the apiParams to find matches for inputs in double circle braces ("{{INPUT}}").
|
|
1693
|
+
Derives the inputs by parsing the apiParams to find matches for inputs in double circle braces ("{{ INPUT }}").
|
|
1694
1694
|
|
|
1695
1695
|
##### `listOutputs` <a name="listOutputs" id="@cdklabs/cdk-ssm-documents.AwsApiStep.listOutputs"></a>
|
|
1696
1696
|
|
|
@@ -14891,7 +14891,7 @@ new WaitForResourceStep(scope: Construct, id: string, props: WaitForResourceStep
|
|
|
14891
14891
|
| **Name** | **Description** |
|
|
14892
14892
|
| --- | --- |
|
|
14893
14893
|
| <code><a href="#@cdklabs/cdk-ssm-documents.WaitForResourceStep.toString">toString</a></code> | Returns a string representation of this construct. |
|
|
14894
|
-
| <code><a href="#@cdklabs/cdk-ssm-documents.WaitForResourceStep.listInputs">listInputs</a></code> | Derives the inputs by parsing the apiParams to find matches for inputs in double circle braces ("{{INPUT}}"). |
|
|
14894
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.WaitForResourceStep.listInputs">listInputs</a></code> | Derives the inputs by parsing the apiParams to find matches for inputs in double circle braces ("{{ INPUT }}"). |
|
|
14895
14895
|
| <code><a href="#@cdklabs/cdk-ssm-documents.WaitForResourceStep.listOutputs">listOutputs</a></code> | There are no outputs for this step. |
|
|
14896
14896
|
| <code><a href="#@cdklabs/cdk-ssm-documents.WaitForResourceStep.toSsmEntry">toSsmEntry</a></code> | Converts this step into an object to prepare for yaml/json representation of this step. |
|
|
14897
14897
|
| <code><a href="#@cdklabs/cdk-ssm-documents.WaitForResourceStep.addToDocument">addToDocument</a></code> | *No description.* |
|
|
@@ -14913,7 +14913,7 @@ Returns a string representation of this construct.
|
|
|
14913
14913
|
public listInputs(): string[]
|
|
14914
14914
|
```
|
|
14915
14915
|
|
|
14916
|
-
Derives the inputs by parsing the apiParams to find matches for inputs in double circle braces ("{{INPUT}}").
|
|
14916
|
+
Derives the inputs by parsing the apiParams to find matches for inputs in double circle braces ("{{ INPUT }}").
|
|
14917
14917
|
|
|
14918
14918
|
##### `listOutputs` <a name="listOutputs" id="@cdklabs/cdk-ssm-documents.WaitForResourceStep.listOutputs"></a>
|
|
14919
14919
|
|
|
@@ -15945,7 +15945,7 @@ public readonly apiParams: {[ key: string ]: any};
|
|
|
15945
15945
|
|
|
15946
15946
|
(Required) API Params to submit with the request to the api.
|
|
15947
15947
|
|
|
15948
|
-
You may include variables which will be substitued for inputs during step execution as such {{INPUT}}
|
|
15948
|
+
You may include variables which will be substitued for inputs during step execution as such {{ INPUT }}
|
|
15949
15949
|
|
|
15950
15950
|
---
|
|
15951
15951
|
|
|
@@ -16702,7 +16702,7 @@ public readonly apiParams: {[ key: string ]: any};
|
|
|
16702
16702
|
|
|
16703
16703
|
(Required) API Params to submit with the request to the api.
|
|
16704
16704
|
|
|
16705
|
-
You may include variables which will be substitued for inputs during step execution as such {{INPUT}}
|
|
16705
|
+
You may include variables which will be substitued for inputs during step execution as such {{ INPUT }}
|
|
16706
16706
|
|
|
16707
16707
|
---
|
|
16708
16708
|
|
|
@@ -16951,7 +16951,7 @@ public readonly apiParams: {[ key: string ]: any};
|
|
|
16951
16951
|
|
|
16952
16952
|
(Required) API Params to submit with the request to the api.
|
|
16953
16953
|
|
|
16954
|
-
You may include variables which will be substitued for inputs during step execution as such {{INPUT}}
|
|
16954
|
+
You may include variables which will be substitued for inputs during step execution as such {{ INPUT }}
|
|
16955
16955
|
|
|
16956
16956
|
---
|
|
16957
16957
|
|
|
@@ -17102,6 +17102,51 @@ Body or URL string.
|
|
|
17102
17102
|
|
|
17103
17103
|
---
|
|
17104
17104
|
|
|
17105
|
+
### BooleanInputProps <a name="BooleanInputProps" id="@cdklabs/cdk-ssm-documents.BooleanInputProps"></a>
|
|
17106
|
+
|
|
17107
|
+
#### Initializer <a name="Initializer" id="@cdklabs/cdk-ssm-documents.BooleanInputProps.Initializer"></a>
|
|
17108
|
+
|
|
17109
|
+
```typescript
|
|
17110
|
+
import { BooleanInputProps } from '@cdklabs/cdk-ssm-documents'
|
|
17111
|
+
|
|
17112
|
+
const booleanInputProps: BooleanInputProps = { ... }
|
|
17113
|
+
```
|
|
17114
|
+
|
|
17115
|
+
#### Properties <a name="Properties" id="Properties"></a>
|
|
17116
|
+
|
|
17117
|
+
| **Name** | **Type** | **Description** |
|
|
17118
|
+
| --- | --- | --- |
|
|
17119
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.BooleanInputProps.property.defaultValue">defaultValue</a></code> | <code>boolean</code> | (Optional) Default value to use for this input if not specified when invoking the document. |
|
|
17120
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.BooleanInputProps.property.description">description</a></code> | <code>string</code> | (Optional) The description of the input. |
|
|
17121
|
+
|
|
17122
|
+
---
|
|
17123
|
+
|
|
17124
|
+
##### `defaultValue`<sup>Optional</sup> <a name="defaultValue" id="@cdklabs/cdk-ssm-documents.BooleanInputProps.property.defaultValue"></a>
|
|
17125
|
+
|
|
17126
|
+
```typescript
|
|
17127
|
+
public readonly defaultValue: boolean;
|
|
17128
|
+
```
|
|
17129
|
+
|
|
17130
|
+
- *Type:* boolean
|
|
17131
|
+
- *Default:* undefined
|
|
17132
|
+
|
|
17133
|
+
(Optional) Default value to use for this input if not specified when invoking the document.
|
|
17134
|
+
|
|
17135
|
+
---
|
|
17136
|
+
|
|
17137
|
+
##### `description`<sup>Optional</sup> <a name="description" id="@cdklabs/cdk-ssm-documents.BooleanInputProps.property.description"></a>
|
|
17138
|
+
|
|
17139
|
+
```typescript
|
|
17140
|
+
public readonly description: string;
|
|
17141
|
+
```
|
|
17142
|
+
|
|
17143
|
+
- *Type:* string
|
|
17144
|
+
- *Default:* name
|
|
17145
|
+
|
|
17146
|
+
(Optional) The description of the input.
|
|
17147
|
+
|
|
17148
|
+
---
|
|
17149
|
+
|
|
17105
17150
|
### BranchStepProps <a name="BranchStepProps" id="@cdklabs/cdk-ssm-documents.BranchStepProps"></a>
|
|
17106
17151
|
|
|
17107
17152
|
#### Initializer <a name="Initializer" id="@cdklabs/cdk-ssm-documents.BranchStepProps.Initializer"></a>
|
|
@@ -18508,7 +18553,7 @@ public readonly additionalArguments: IStringMapVariable;
|
|
|
18508
18553
|
The additional parameters to provide to your install, uninstall, or update scripts.
|
|
18509
18554
|
|
|
18510
18555
|
Each parameter must be prefixed with SSM_.
|
|
18511
|
-
You can reference a Parameter Store parameter in your additional arguments by using the convention {{ssm:parameter-name}}.
|
|
18556
|
+
You can reference a Parameter Store parameter in your additional arguments by using the convention {{ ssm:parameter-name }}.
|
|
18512
18557
|
To use the additional parameter in your install, uninstall, or update script,
|
|
18513
18558
|
you must reference the parameter as an environment variable using the syntax appropriate for the operating system.
|
|
18514
18559
|
For example, in PowerShell, you reference the SSM_arg argument as $Env:SSM_arg.
|
|
@@ -21837,37 +21882,39 @@ To use the Digest method, SSM Agent version 3.0.1181.0 or later must be installe
|
|
|
21837
21882
|
|
|
21838
21883
|
---
|
|
21839
21884
|
|
|
21840
|
-
###
|
|
21885
|
+
### InputProps <a name="InputProps" id="@cdklabs/cdk-ssm-documents.InputProps"></a>
|
|
21841
21886
|
|
|
21842
21887
|
Properties of inputs supported by SSM documents.
|
|
21843
21888
|
|
|
21844
21889
|
These are NOT used for declaring step inputs, rather only for document inputs.
|
|
21845
21890
|
See https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-doc-syntax.html
|
|
21846
21891
|
|
|
21847
|
-
#### Initializer <a name="Initializer" id="@cdklabs/cdk-ssm-documents.
|
|
21892
|
+
#### Initializer <a name="Initializer" id="@cdklabs/cdk-ssm-documents.InputProps.Initializer"></a>
|
|
21848
21893
|
|
|
21849
21894
|
```typescript
|
|
21850
|
-
import {
|
|
21895
|
+
import { InputProps } from '@cdklabs/cdk-ssm-documents'
|
|
21851
21896
|
|
|
21852
|
-
const
|
|
21897
|
+
const inputProps: InputProps = { ... }
|
|
21853
21898
|
```
|
|
21854
21899
|
|
|
21855
21900
|
#### Properties <a name="Properties" id="Properties"></a>
|
|
21856
21901
|
|
|
21857
21902
|
| **Name** | **Type** | **Description** |
|
|
21858
21903
|
| --- | --- | --- |
|
|
21859
|
-
| <code><a href="#@cdklabs/cdk-ssm-documents.
|
|
21860
|
-
| <code><a href="#@cdklabs/cdk-ssm-documents.
|
|
21861
|
-
| <code><a href="#@cdklabs/cdk-ssm-documents.
|
|
21862
|
-
| <code><a href="#@cdklabs/cdk-ssm-documents.
|
|
21863
|
-
| <code><a href="#@cdklabs/cdk-ssm-documents.
|
|
21864
|
-
| <code><a href="#@cdklabs/cdk-ssm-documents.
|
|
21865
|
-
| <code><a href="#@cdklabs/cdk-ssm-documents.
|
|
21866
|
-
| <code><a href="#@cdklabs/cdk-ssm-documents.
|
|
21904
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.InputProps.property.inputType">inputType</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.DataTypeEnum">DataTypeEnum</a></code> | (Required) The DataTypeEnum of the input. |
|
|
21905
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.InputProps.property.name">name</a></code> | <code>string</code> | (Required) The name of the input by which to be referenced by steps in the document. |
|
|
21906
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.InputProps.property.allowedPattern">allowedPattern</a></code> | <code>string</code> | (Optional) Pattern that this input value must match. |
|
|
21907
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.InputProps.property.allowedValues">allowedValues</a></code> | <code>any[]</code> | (Optional) List of allowed values that this input may be. |
|
|
21908
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.InputProps.property.defaultValue">defaultValue</a></code> | <code>any</code> | (Optional) Default value to use for this input if not specified when invoking the document. |
|
|
21909
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.InputProps.property.description">description</a></code> | <code>string</code> | (Optional) The description of the input. |
|
|
21910
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.InputProps.property.maxChars">maxChars</a></code> | <code>number</code> | (Optional) Maximum number of chars that this input value (string) must contain. |
|
|
21911
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.InputProps.property.maxItems">maxItems</a></code> | <code>number</code> | (Optional) Maximum number of items that this input value (list) must contain. |
|
|
21912
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.InputProps.property.minChars">minChars</a></code> | <code>number</code> | (Optional) Minimum number of chars that this input value (string) must contain. |
|
|
21913
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.InputProps.property.minItems">minItems</a></code> | <code>number</code> | (Optional) Minimum number of items that this input value (list) must contain. |
|
|
21867
21914
|
|
|
21868
21915
|
---
|
|
21869
21916
|
|
|
21870
|
-
##### `inputType`<sup>Required</sup> <a name="inputType" id="@cdklabs/cdk-ssm-documents.
|
|
21917
|
+
##### `inputType`<sup>Required</sup> <a name="inputType" id="@cdklabs/cdk-ssm-documents.InputProps.property.inputType"></a>
|
|
21871
21918
|
|
|
21872
21919
|
```typescript
|
|
21873
21920
|
public readonly inputType: DataTypeEnum;
|
|
@@ -21879,7 +21926,7 @@ public readonly inputType: DataTypeEnum;
|
|
|
21879
21926
|
|
|
21880
21927
|
---
|
|
21881
21928
|
|
|
21882
|
-
##### `name`<sup>Required</sup> <a name="name" id="@cdklabs/cdk-ssm-documents.
|
|
21929
|
+
##### `name`<sup>Required</sup> <a name="name" id="@cdklabs/cdk-ssm-documents.InputProps.property.name"></a>
|
|
21883
21930
|
|
|
21884
21931
|
```typescript
|
|
21885
21932
|
public readonly name: string;
|
|
@@ -21891,7 +21938,7 @@ public readonly name: string;
|
|
|
21891
21938
|
|
|
21892
21939
|
---
|
|
21893
21940
|
|
|
21894
|
-
##### `allowedPattern`<sup>Optional</sup> <a name="allowedPattern" id="@cdklabs/cdk-ssm-documents.
|
|
21941
|
+
##### `allowedPattern`<sup>Optional</sup> <a name="allowedPattern" id="@cdklabs/cdk-ssm-documents.InputProps.property.allowedPattern"></a>
|
|
21895
21942
|
|
|
21896
21943
|
```typescript
|
|
21897
21944
|
public readonly allowedPattern: string;
|
|
@@ -21904,33 +21951,33 @@ public readonly allowedPattern: string;
|
|
|
21904
21951
|
|
|
21905
21952
|
---
|
|
21906
21953
|
|
|
21907
|
-
##### `allowedValues`<sup>Optional</sup> <a name="allowedValues" id="@cdklabs/cdk-ssm-documents.
|
|
21954
|
+
##### `allowedValues`<sup>Optional</sup> <a name="allowedValues" id="@cdklabs/cdk-ssm-documents.InputProps.property.allowedValues"></a>
|
|
21908
21955
|
|
|
21909
21956
|
```typescript
|
|
21910
|
-
public readonly allowedValues:
|
|
21957
|
+
public readonly allowedValues: any[];
|
|
21911
21958
|
```
|
|
21912
21959
|
|
|
21913
|
-
- *Type:*
|
|
21960
|
+
- *Type:* any[]
|
|
21914
21961
|
- *Default:* undefined
|
|
21915
21962
|
|
|
21916
21963
|
(Optional) List of allowed values that this input may be.
|
|
21917
21964
|
|
|
21918
21965
|
---
|
|
21919
21966
|
|
|
21920
|
-
##### `defaultValue`<sup>Optional</sup> <a name="defaultValue" id="@cdklabs/cdk-ssm-documents.
|
|
21967
|
+
##### `defaultValue`<sup>Optional</sup> <a name="defaultValue" id="@cdklabs/cdk-ssm-documents.InputProps.property.defaultValue"></a>
|
|
21921
21968
|
|
|
21922
21969
|
```typescript
|
|
21923
|
-
public readonly defaultValue:
|
|
21970
|
+
public readonly defaultValue: any;
|
|
21924
21971
|
```
|
|
21925
21972
|
|
|
21926
|
-
- *Type:*
|
|
21973
|
+
- *Type:* any
|
|
21927
21974
|
- *Default:* undefined
|
|
21928
21975
|
|
|
21929
21976
|
(Optional) Default value to use for this input if not specified when invoking the document.
|
|
21930
21977
|
|
|
21931
21978
|
---
|
|
21932
21979
|
|
|
21933
|
-
##### `description`<sup>Optional</sup> <a name="description" id="@cdklabs/cdk-ssm-documents.
|
|
21980
|
+
##### `description`<sup>Optional</sup> <a name="description" id="@cdklabs/cdk-ssm-documents.InputProps.property.description"></a>
|
|
21934
21981
|
|
|
21935
21982
|
```typescript
|
|
21936
21983
|
public readonly description: string;
|
|
@@ -21943,7 +21990,20 @@ public readonly description: string;
|
|
|
21943
21990
|
|
|
21944
21991
|
---
|
|
21945
21992
|
|
|
21946
|
-
##### `
|
|
21993
|
+
##### `maxChars`<sup>Optional</sup> <a name="maxChars" id="@cdklabs/cdk-ssm-documents.InputProps.property.maxChars"></a>
|
|
21994
|
+
|
|
21995
|
+
```typescript
|
|
21996
|
+
public readonly maxChars: number;
|
|
21997
|
+
```
|
|
21998
|
+
|
|
21999
|
+
- *Type:* number
|
|
22000
|
+
- *Default:* undefined
|
|
22001
|
+
|
|
22002
|
+
(Optional) Maximum number of chars that this input value (string) must contain.
|
|
22003
|
+
|
|
22004
|
+
---
|
|
22005
|
+
|
|
22006
|
+
##### `maxItems`<sup>Optional</sup> <a name="maxItems" id="@cdklabs/cdk-ssm-documents.InputProps.property.maxItems"></a>
|
|
21947
22007
|
|
|
21948
22008
|
```typescript
|
|
21949
22009
|
public readonly maxItems: number;
|
|
@@ -21956,7 +22016,20 @@ public readonly maxItems: number;
|
|
|
21956
22016
|
|
|
21957
22017
|
---
|
|
21958
22018
|
|
|
21959
|
-
##### `
|
|
22019
|
+
##### `minChars`<sup>Optional</sup> <a name="minChars" id="@cdklabs/cdk-ssm-documents.InputProps.property.minChars"></a>
|
|
22020
|
+
|
|
22021
|
+
```typescript
|
|
22022
|
+
public readonly minChars: number;
|
|
22023
|
+
```
|
|
22024
|
+
|
|
22025
|
+
- *Type:* number
|
|
22026
|
+
- *Default:* undefined
|
|
22027
|
+
|
|
22028
|
+
(Optional) Minimum number of chars that this input value (string) must contain.
|
|
22029
|
+
|
|
22030
|
+
---
|
|
22031
|
+
|
|
22032
|
+
##### `minItems`<sup>Optional</sup> <a name="minItems" id="@cdklabs/cdk-ssm-documents.InputProps.property.minItems"></a>
|
|
21960
22033
|
|
|
21961
22034
|
```typescript
|
|
21962
22035
|
public readonly minItems: number;
|
|
@@ -21969,6 +22042,65 @@ public readonly minItems: number;
|
|
|
21969
22042
|
|
|
21970
22043
|
---
|
|
21971
22044
|
|
|
22045
|
+
### IntegerInputProps <a name="IntegerInputProps" id="@cdklabs/cdk-ssm-documents.IntegerInputProps"></a>
|
|
22046
|
+
|
|
22047
|
+
#### Initializer <a name="Initializer" id="@cdklabs/cdk-ssm-documents.IntegerInputProps.Initializer"></a>
|
|
22048
|
+
|
|
22049
|
+
```typescript
|
|
22050
|
+
import { IntegerInputProps } from '@cdklabs/cdk-ssm-documents'
|
|
22051
|
+
|
|
22052
|
+
const integerInputProps: IntegerInputProps = { ... }
|
|
22053
|
+
```
|
|
22054
|
+
|
|
22055
|
+
#### Properties <a name="Properties" id="Properties"></a>
|
|
22056
|
+
|
|
22057
|
+
| **Name** | **Type** | **Description** |
|
|
22058
|
+
| --- | --- | --- |
|
|
22059
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.IntegerInputProps.property.allowedValues">allowedValues</a></code> | <code>number[]</code> | (Optional) List of allowed values that this input may be. |
|
|
22060
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.IntegerInputProps.property.defaultValue">defaultValue</a></code> | <code>number</code> | (Optional) Default value to use for this input if not specified when invoking the document. |
|
|
22061
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.IntegerInputProps.property.description">description</a></code> | <code>string</code> | (Optional) The description of the input. |
|
|
22062
|
+
|
|
22063
|
+
---
|
|
22064
|
+
|
|
22065
|
+
##### `allowedValues`<sup>Optional</sup> <a name="allowedValues" id="@cdklabs/cdk-ssm-documents.IntegerInputProps.property.allowedValues"></a>
|
|
22066
|
+
|
|
22067
|
+
```typescript
|
|
22068
|
+
public readonly allowedValues: number[];
|
|
22069
|
+
```
|
|
22070
|
+
|
|
22071
|
+
- *Type:* number[]
|
|
22072
|
+
- *Default:* undefined
|
|
22073
|
+
|
|
22074
|
+
(Optional) List of allowed values that this input may be.
|
|
22075
|
+
|
|
22076
|
+
---
|
|
22077
|
+
|
|
22078
|
+
##### `defaultValue`<sup>Optional</sup> <a name="defaultValue" id="@cdklabs/cdk-ssm-documents.IntegerInputProps.property.defaultValue"></a>
|
|
22079
|
+
|
|
22080
|
+
```typescript
|
|
22081
|
+
public readonly defaultValue: number;
|
|
22082
|
+
```
|
|
22083
|
+
|
|
22084
|
+
- *Type:* number
|
|
22085
|
+
- *Default:* undefined
|
|
22086
|
+
|
|
22087
|
+
(Optional) Default value to use for this input if not specified when invoking the document.
|
|
22088
|
+
|
|
22089
|
+
---
|
|
22090
|
+
|
|
22091
|
+
##### `description`<sup>Optional</sup> <a name="description" id="@cdklabs/cdk-ssm-documents.IntegerInputProps.property.description"></a>
|
|
22092
|
+
|
|
22093
|
+
```typescript
|
|
22094
|
+
public readonly description: string;
|
|
22095
|
+
```
|
|
22096
|
+
|
|
22097
|
+
- *Type:* string
|
|
22098
|
+
- *Default:* name
|
|
22099
|
+
|
|
22100
|
+
(Optional) The description of the input.
|
|
22101
|
+
|
|
22102
|
+
---
|
|
22103
|
+
|
|
21972
22104
|
### Invocation <a name="Invocation" id="@cdklabs/cdk-ssm-documents.Invocation"></a>
|
|
21973
22105
|
|
|
21974
22106
|
#### Initializer <a name="Initializer" id="@cdklabs/cdk-ssm-documents.Invocation.Initializer"></a>
|
|
@@ -22585,6 +22717,93 @@ public readonly body: IStringVariable;
|
|
|
22585
22717
|
|
|
22586
22718
|
---
|
|
22587
22719
|
|
|
22720
|
+
### MapListInputProps <a name="MapListInputProps" id="@cdklabs/cdk-ssm-documents.MapListInputProps"></a>
|
|
22721
|
+
|
|
22722
|
+
#### Initializer <a name="Initializer" id="@cdklabs/cdk-ssm-documents.MapListInputProps.Initializer"></a>
|
|
22723
|
+
|
|
22724
|
+
```typescript
|
|
22725
|
+
import { MapListInputProps } from '@cdklabs/cdk-ssm-documents'
|
|
22726
|
+
|
|
22727
|
+
const mapListInputProps: MapListInputProps = { ... }
|
|
22728
|
+
```
|
|
22729
|
+
|
|
22730
|
+
#### Properties <a name="Properties" id="Properties"></a>
|
|
22731
|
+
|
|
22732
|
+
| **Name** | **Type** | **Description** |
|
|
22733
|
+
| --- | --- | --- |
|
|
22734
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.MapListInputProps.property.allowedValues">allowedValues</a></code> | <code>any[]</code> | (Optional) List of allowed values that this input may be. |
|
|
22735
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.MapListInputProps.property.defaultValue">defaultValue</a></code> | <code>any</code> | (Optional) Default value to use for this input if not specified when invoking the document. |
|
|
22736
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.MapListInputProps.property.description">description</a></code> | <code>string</code> | (Optional) The description of the input. |
|
|
22737
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.MapListInputProps.property.maxItems">maxItems</a></code> | <code>number</code> | (Optional) Maximum number of items that this input value (list) must contain. |
|
|
22738
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.MapListInputProps.property.minItems">minItems</a></code> | <code>number</code> | (Optional) Minimum number of items that this input value (list) must contain. |
|
|
22739
|
+
|
|
22740
|
+
---
|
|
22741
|
+
|
|
22742
|
+
##### `allowedValues`<sup>Optional</sup> <a name="allowedValues" id="@cdklabs/cdk-ssm-documents.MapListInputProps.property.allowedValues"></a>
|
|
22743
|
+
|
|
22744
|
+
```typescript
|
|
22745
|
+
public readonly allowedValues: any[];
|
|
22746
|
+
```
|
|
22747
|
+
|
|
22748
|
+
- *Type:* any[]
|
|
22749
|
+
- *Default:* undefined
|
|
22750
|
+
|
|
22751
|
+
(Optional) List of allowed values that this input may be.
|
|
22752
|
+
|
|
22753
|
+
---
|
|
22754
|
+
|
|
22755
|
+
##### `defaultValue`<sup>Optional</sup> <a name="defaultValue" id="@cdklabs/cdk-ssm-documents.MapListInputProps.property.defaultValue"></a>
|
|
22756
|
+
|
|
22757
|
+
```typescript
|
|
22758
|
+
public readonly defaultValue: any;
|
|
22759
|
+
```
|
|
22760
|
+
|
|
22761
|
+
- *Type:* any
|
|
22762
|
+
- *Default:* undefined
|
|
22763
|
+
|
|
22764
|
+
(Optional) Default value to use for this input if not specified when invoking the document.
|
|
22765
|
+
|
|
22766
|
+
---
|
|
22767
|
+
|
|
22768
|
+
##### `description`<sup>Optional</sup> <a name="description" id="@cdklabs/cdk-ssm-documents.MapListInputProps.property.description"></a>
|
|
22769
|
+
|
|
22770
|
+
```typescript
|
|
22771
|
+
public readonly description: string;
|
|
22772
|
+
```
|
|
22773
|
+
|
|
22774
|
+
- *Type:* string
|
|
22775
|
+
- *Default:* name
|
|
22776
|
+
|
|
22777
|
+
(Optional) The description of the input.
|
|
22778
|
+
|
|
22779
|
+
---
|
|
22780
|
+
|
|
22781
|
+
##### `maxItems`<sup>Optional</sup> <a name="maxItems" id="@cdklabs/cdk-ssm-documents.MapListInputProps.property.maxItems"></a>
|
|
22782
|
+
|
|
22783
|
+
```typescript
|
|
22784
|
+
public readonly maxItems: number;
|
|
22785
|
+
```
|
|
22786
|
+
|
|
22787
|
+
- *Type:* number
|
|
22788
|
+
- *Default:* undefined
|
|
22789
|
+
|
|
22790
|
+
(Optional) Maximum number of items that this input value (list) must contain.
|
|
22791
|
+
|
|
22792
|
+
---
|
|
22793
|
+
|
|
22794
|
+
##### `minItems`<sup>Optional</sup> <a name="minItems" id="@cdklabs/cdk-ssm-documents.MapListInputProps.property.minItems"></a>
|
|
22795
|
+
|
|
22796
|
+
```typescript
|
|
22797
|
+
public readonly minItems: number;
|
|
22798
|
+
```
|
|
22799
|
+
|
|
22800
|
+
- *Type:* number
|
|
22801
|
+
- *Default:* undefined
|
|
22802
|
+
|
|
22803
|
+
(Optional) Minimum number of items that this input value (list) must contain.
|
|
22804
|
+
|
|
22805
|
+
---
|
|
22806
|
+
|
|
22588
22807
|
### Output <a name="Output" id="@cdklabs/cdk-ssm-documents.Output"></a>
|
|
22589
22808
|
|
|
22590
22809
|
Object used to specify step output.
|
|
@@ -23269,7 +23488,7 @@ public readonly targets: string[];
|
|
|
23269
23488
|
|
|
23270
23489
|
The instance IDs where you want the command to run. You can specify a maximum of 50 IDs.
|
|
23271
23490
|
|
|
23272
|
-
You can also use the pseudo parameter {{RESOURCE_ID}} in place of instance IDs to run the command on all instances in the target group. For more information about pseudo parameters, see [About pseudo parameters](https://docs.aws.amazon.com/systems-manager/latest/userguide/mw-cli-register-tasks-parameters.html).
|
|
23491
|
+
You can also use the pseudo parameter {{ RESOURCE_ID }} in place of instance IDs to run the command on all instances in the target group. For more information about pseudo parameters, see [About pseudo parameters](https://docs.aws.amazon.com/systems-manager/latest/userguide/mw-cli-register-tasks-parameters.html).
|
|
23273
23492
|
|
|
23274
23493
|
Another alternative is to send commands to a fleet of instances by using the Targets parameter. The Targets parameter accepts Amazon Elastic Compute Cloud (Amazon EC2) tags. For more information about how to use the Targets parameter, see [Using targets and rate controls to send commands to a fleet](https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html).
|
|
23275
23494
|
|
|
@@ -23644,7 +23863,7 @@ public readonly targets: IStringListVariable | IMapListVariable;
|
|
|
23644
23863
|
|
|
23645
23864
|
The instance IDs where you want the command to run. You can specify a maximum of 50 IDs.
|
|
23646
23865
|
|
|
23647
|
-
You can also use the pseudo parameter {{RESOURCE_ID}} in place of instance IDs to run the command on all instances in the target group. For more information about pseudo parameters, see [About pseudo parameters](https://docs.aws.amazon.com/systems-manager/latest/userguide/mw-cli-register-tasks-parameters.html).
|
|
23866
|
+
You can also use the pseudo parameter {{ RESOURCE_ID }} in place of instance IDs to run the command on all instances in the target group. For more information about pseudo parameters, see [About pseudo parameters](https://docs.aws.amazon.com/systems-manager/latest/userguide/mw-cli-register-tasks-parameters.html).
|
|
23648
23867
|
|
|
23649
23868
|
Another alternative is to send commands to a fleet of instances by using the Targets parameter. The Targets parameter accepts Amazon Elastic Compute Cloud (Amazon EC2) tags. For more information about how to use the Targets parameter, see [Using targets and rate controls to send commands to a fleet](https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html).
|
|
23650
23869
|
|
|
@@ -26164,6 +26383,281 @@ public readonly outputObserver: IObserver;
|
|
|
26164
26383
|
|
|
26165
26384
|
---
|
|
26166
26385
|
|
|
26386
|
+
### StringInputProps <a name="StringInputProps" id="@cdklabs/cdk-ssm-documents.StringInputProps"></a>
|
|
26387
|
+
|
|
26388
|
+
#### Initializer <a name="Initializer" id="@cdklabs/cdk-ssm-documents.StringInputProps.Initializer"></a>
|
|
26389
|
+
|
|
26390
|
+
```typescript
|
|
26391
|
+
import { StringInputProps } from '@cdklabs/cdk-ssm-documents'
|
|
26392
|
+
|
|
26393
|
+
const stringInputProps: StringInputProps = { ... }
|
|
26394
|
+
```
|
|
26395
|
+
|
|
26396
|
+
#### Properties <a name="Properties" id="Properties"></a>
|
|
26397
|
+
|
|
26398
|
+
| **Name** | **Type** | **Description** |
|
|
26399
|
+
| --- | --- | --- |
|
|
26400
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.StringInputProps.property.allowedPattern">allowedPattern</a></code> | <code>string</code> | (Optional) Pattern that this input value must match. |
|
|
26401
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.StringInputProps.property.allowedValues">allowedValues</a></code> | <code>string[]</code> | (Optional) List of allowed values that this input may be. |
|
|
26402
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.StringInputProps.property.defaultValue">defaultValue</a></code> | <code>string</code> | (Optional) Default value to use for this input if not specified when invoking the document. |
|
|
26403
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.StringInputProps.property.description">description</a></code> | <code>string</code> | (Optional) The description of the input. |
|
|
26404
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.StringInputProps.property.maxChars">maxChars</a></code> | <code>number</code> | (Optional) Maximum number of chars that this input value (string) must contain. |
|
|
26405
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.StringInputProps.property.minChars">minChars</a></code> | <code>number</code> | (Optional) Minimum number of chars that this input value (string) must contain. |
|
|
26406
|
+
|
|
26407
|
+
---
|
|
26408
|
+
|
|
26409
|
+
##### `allowedPattern`<sup>Optional</sup> <a name="allowedPattern" id="@cdklabs/cdk-ssm-documents.StringInputProps.property.allowedPattern"></a>
|
|
26410
|
+
|
|
26411
|
+
```typescript
|
|
26412
|
+
public readonly allowedPattern: string;
|
|
26413
|
+
```
|
|
26414
|
+
|
|
26415
|
+
- *Type:* string
|
|
26416
|
+
- *Default:* undefined
|
|
26417
|
+
|
|
26418
|
+
(Optional) Pattern that this input value must match.
|
|
26419
|
+
|
|
26420
|
+
---
|
|
26421
|
+
|
|
26422
|
+
##### `allowedValues`<sup>Optional</sup> <a name="allowedValues" id="@cdklabs/cdk-ssm-documents.StringInputProps.property.allowedValues"></a>
|
|
26423
|
+
|
|
26424
|
+
```typescript
|
|
26425
|
+
public readonly allowedValues: string[];
|
|
26426
|
+
```
|
|
26427
|
+
|
|
26428
|
+
- *Type:* string[]
|
|
26429
|
+
- *Default:* undefined
|
|
26430
|
+
|
|
26431
|
+
(Optional) List of allowed values that this input may be.
|
|
26432
|
+
|
|
26433
|
+
---
|
|
26434
|
+
|
|
26435
|
+
##### `defaultValue`<sup>Optional</sup> <a name="defaultValue" id="@cdklabs/cdk-ssm-documents.StringInputProps.property.defaultValue"></a>
|
|
26436
|
+
|
|
26437
|
+
```typescript
|
|
26438
|
+
public readonly defaultValue: string;
|
|
26439
|
+
```
|
|
26440
|
+
|
|
26441
|
+
- *Type:* string
|
|
26442
|
+
- *Default:* undefined
|
|
26443
|
+
|
|
26444
|
+
(Optional) Default value to use for this input if not specified when invoking the document.
|
|
26445
|
+
|
|
26446
|
+
---
|
|
26447
|
+
|
|
26448
|
+
##### `description`<sup>Optional</sup> <a name="description" id="@cdklabs/cdk-ssm-documents.StringInputProps.property.description"></a>
|
|
26449
|
+
|
|
26450
|
+
```typescript
|
|
26451
|
+
public readonly description: string;
|
|
26452
|
+
```
|
|
26453
|
+
|
|
26454
|
+
- *Type:* string
|
|
26455
|
+
- *Default:* name
|
|
26456
|
+
|
|
26457
|
+
(Optional) The description of the input.
|
|
26458
|
+
|
|
26459
|
+
---
|
|
26460
|
+
|
|
26461
|
+
##### `maxChars`<sup>Optional</sup> <a name="maxChars" id="@cdklabs/cdk-ssm-documents.StringInputProps.property.maxChars"></a>
|
|
26462
|
+
|
|
26463
|
+
```typescript
|
|
26464
|
+
public readonly maxChars: number;
|
|
26465
|
+
```
|
|
26466
|
+
|
|
26467
|
+
- *Type:* number
|
|
26468
|
+
- *Default:* undefined
|
|
26469
|
+
|
|
26470
|
+
(Optional) Maximum number of chars that this input value (string) must contain.
|
|
26471
|
+
|
|
26472
|
+
---
|
|
26473
|
+
|
|
26474
|
+
##### `minChars`<sup>Optional</sup> <a name="minChars" id="@cdklabs/cdk-ssm-documents.StringInputProps.property.minChars"></a>
|
|
26475
|
+
|
|
26476
|
+
```typescript
|
|
26477
|
+
public readonly minChars: number;
|
|
26478
|
+
```
|
|
26479
|
+
|
|
26480
|
+
- *Type:* number
|
|
26481
|
+
- *Default:* undefined
|
|
26482
|
+
|
|
26483
|
+
(Optional) Minimum number of chars that this input value (string) must contain.
|
|
26484
|
+
|
|
26485
|
+
---
|
|
26486
|
+
|
|
26487
|
+
### StringListInputProps <a name="StringListInputProps" id="@cdklabs/cdk-ssm-documents.StringListInputProps"></a>
|
|
26488
|
+
|
|
26489
|
+
#### Initializer <a name="Initializer" id="@cdklabs/cdk-ssm-documents.StringListInputProps.Initializer"></a>
|
|
26490
|
+
|
|
26491
|
+
```typescript
|
|
26492
|
+
import { StringListInputProps } from '@cdklabs/cdk-ssm-documents'
|
|
26493
|
+
|
|
26494
|
+
const stringListInputProps: StringListInputProps = { ... }
|
|
26495
|
+
```
|
|
26496
|
+
|
|
26497
|
+
#### Properties <a name="Properties" id="Properties"></a>
|
|
26498
|
+
|
|
26499
|
+
| **Name** | **Type** | **Description** |
|
|
26500
|
+
| --- | --- | --- |
|
|
26501
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.StringListInputProps.property.allowedValues">allowedValues</a></code> | <code>any[]</code> | (Optional) List of allowed values that this input may be. |
|
|
26502
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.StringListInputProps.property.defaultValue">defaultValue</a></code> | <code>any</code> | (Optional) Default value to use for this input if not specified when invoking the document. |
|
|
26503
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.StringListInputProps.property.description">description</a></code> | <code>string</code> | (Optional) The description of the input. |
|
|
26504
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.StringListInputProps.property.maxItems">maxItems</a></code> | <code>number</code> | (Optional) Maximum number of items that this input value (list) must contain. |
|
|
26505
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.StringListInputProps.property.minItems">minItems</a></code> | <code>number</code> | (Optional) Minimum number of items that this input value (list) must contain. |
|
|
26506
|
+
|
|
26507
|
+
---
|
|
26508
|
+
|
|
26509
|
+
##### `allowedValues`<sup>Optional</sup> <a name="allowedValues" id="@cdklabs/cdk-ssm-documents.StringListInputProps.property.allowedValues"></a>
|
|
26510
|
+
|
|
26511
|
+
```typescript
|
|
26512
|
+
public readonly allowedValues: any[];
|
|
26513
|
+
```
|
|
26514
|
+
|
|
26515
|
+
- *Type:* any[]
|
|
26516
|
+
- *Default:* undefined
|
|
26517
|
+
|
|
26518
|
+
(Optional) List of allowed values that this input may be.
|
|
26519
|
+
|
|
26520
|
+
---
|
|
26521
|
+
|
|
26522
|
+
##### `defaultValue`<sup>Optional</sup> <a name="defaultValue" id="@cdklabs/cdk-ssm-documents.StringListInputProps.property.defaultValue"></a>
|
|
26523
|
+
|
|
26524
|
+
```typescript
|
|
26525
|
+
public readonly defaultValue: any;
|
|
26526
|
+
```
|
|
26527
|
+
|
|
26528
|
+
- *Type:* any
|
|
26529
|
+
- *Default:* undefined
|
|
26530
|
+
|
|
26531
|
+
(Optional) Default value to use for this input if not specified when invoking the document.
|
|
26532
|
+
|
|
26533
|
+
---
|
|
26534
|
+
|
|
26535
|
+
##### `description`<sup>Optional</sup> <a name="description" id="@cdklabs/cdk-ssm-documents.StringListInputProps.property.description"></a>
|
|
26536
|
+
|
|
26537
|
+
```typescript
|
|
26538
|
+
public readonly description: string;
|
|
26539
|
+
```
|
|
26540
|
+
|
|
26541
|
+
- *Type:* string
|
|
26542
|
+
- *Default:* name
|
|
26543
|
+
|
|
26544
|
+
(Optional) The description of the input.
|
|
26545
|
+
|
|
26546
|
+
---
|
|
26547
|
+
|
|
26548
|
+
##### `maxItems`<sup>Optional</sup> <a name="maxItems" id="@cdklabs/cdk-ssm-documents.StringListInputProps.property.maxItems"></a>
|
|
26549
|
+
|
|
26550
|
+
```typescript
|
|
26551
|
+
public readonly maxItems: number;
|
|
26552
|
+
```
|
|
26553
|
+
|
|
26554
|
+
- *Type:* number
|
|
26555
|
+
- *Default:* undefined
|
|
26556
|
+
|
|
26557
|
+
(Optional) Maximum number of items that this input value (list) must contain.
|
|
26558
|
+
|
|
26559
|
+
---
|
|
26560
|
+
|
|
26561
|
+
##### `minItems`<sup>Optional</sup> <a name="minItems" id="@cdklabs/cdk-ssm-documents.StringListInputProps.property.minItems"></a>
|
|
26562
|
+
|
|
26563
|
+
```typescript
|
|
26564
|
+
public readonly minItems: number;
|
|
26565
|
+
```
|
|
26566
|
+
|
|
26567
|
+
- *Type:* number
|
|
26568
|
+
- *Default:* undefined
|
|
26569
|
+
|
|
26570
|
+
(Optional) Minimum number of items that this input value (list) must contain.
|
|
26571
|
+
|
|
26572
|
+
---
|
|
26573
|
+
|
|
26574
|
+
### StringMapInputProps <a name="StringMapInputProps" id="@cdklabs/cdk-ssm-documents.StringMapInputProps"></a>
|
|
26575
|
+
|
|
26576
|
+
#### Initializer <a name="Initializer" id="@cdklabs/cdk-ssm-documents.StringMapInputProps.Initializer"></a>
|
|
26577
|
+
|
|
26578
|
+
```typescript
|
|
26579
|
+
import { StringMapInputProps } from '@cdklabs/cdk-ssm-documents'
|
|
26580
|
+
|
|
26581
|
+
const stringMapInputProps: StringMapInputProps = { ... }
|
|
26582
|
+
```
|
|
26583
|
+
|
|
26584
|
+
#### Properties <a name="Properties" id="Properties"></a>
|
|
26585
|
+
|
|
26586
|
+
| **Name** | **Type** | **Description** |
|
|
26587
|
+
| --- | --- | --- |
|
|
26588
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.StringMapInputProps.property.allowedValues">allowedValues</a></code> | <code>any[]</code> | (Optional) List of allowed values that this input may be. |
|
|
26589
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.StringMapInputProps.property.defaultValue">defaultValue</a></code> | <code>any</code> | (Optional) Default value to use for this input if not specified when invoking the document. |
|
|
26590
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.StringMapInputProps.property.description">description</a></code> | <code>string</code> | (Optional) The description of the input. |
|
|
26591
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.StringMapInputProps.property.maxItems">maxItems</a></code> | <code>number</code> | (Optional) Maximum number of items that this input value (list) must contain. |
|
|
26592
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.StringMapInputProps.property.minItems">minItems</a></code> | <code>number</code> | (Optional) Minimum number of items that this input value (list) must contain. |
|
|
26593
|
+
|
|
26594
|
+
---
|
|
26595
|
+
|
|
26596
|
+
##### `allowedValues`<sup>Optional</sup> <a name="allowedValues" id="@cdklabs/cdk-ssm-documents.StringMapInputProps.property.allowedValues"></a>
|
|
26597
|
+
|
|
26598
|
+
```typescript
|
|
26599
|
+
public readonly allowedValues: any[];
|
|
26600
|
+
```
|
|
26601
|
+
|
|
26602
|
+
- *Type:* any[]
|
|
26603
|
+
- *Default:* undefined
|
|
26604
|
+
|
|
26605
|
+
(Optional) List of allowed values that this input may be.
|
|
26606
|
+
|
|
26607
|
+
---
|
|
26608
|
+
|
|
26609
|
+
##### `defaultValue`<sup>Optional</sup> <a name="defaultValue" id="@cdklabs/cdk-ssm-documents.StringMapInputProps.property.defaultValue"></a>
|
|
26610
|
+
|
|
26611
|
+
```typescript
|
|
26612
|
+
public readonly defaultValue: any;
|
|
26613
|
+
```
|
|
26614
|
+
|
|
26615
|
+
- *Type:* any
|
|
26616
|
+
- *Default:* undefined
|
|
26617
|
+
|
|
26618
|
+
(Optional) Default value to use for this input if not specified when invoking the document.
|
|
26619
|
+
|
|
26620
|
+
---
|
|
26621
|
+
|
|
26622
|
+
##### `description`<sup>Optional</sup> <a name="description" id="@cdklabs/cdk-ssm-documents.StringMapInputProps.property.description"></a>
|
|
26623
|
+
|
|
26624
|
+
```typescript
|
|
26625
|
+
public readonly description: string;
|
|
26626
|
+
```
|
|
26627
|
+
|
|
26628
|
+
- *Type:* string
|
|
26629
|
+
- *Default:* name
|
|
26630
|
+
|
|
26631
|
+
(Optional) The description of the input.
|
|
26632
|
+
|
|
26633
|
+
---
|
|
26634
|
+
|
|
26635
|
+
##### `maxItems`<sup>Optional</sup> <a name="maxItems" id="@cdklabs/cdk-ssm-documents.StringMapInputProps.property.maxItems"></a>
|
|
26636
|
+
|
|
26637
|
+
```typescript
|
|
26638
|
+
public readonly maxItems: number;
|
|
26639
|
+
```
|
|
26640
|
+
|
|
26641
|
+
- *Type:* number
|
|
26642
|
+
- *Default:* undefined
|
|
26643
|
+
|
|
26644
|
+
(Optional) Maximum number of items that this input value (list) must contain.
|
|
26645
|
+
|
|
26646
|
+
---
|
|
26647
|
+
|
|
26648
|
+
##### `minItems`<sup>Optional</sup> <a name="minItems" id="@cdklabs/cdk-ssm-documents.StringMapInputProps.property.minItems"></a>
|
|
26649
|
+
|
|
26650
|
+
```typescript
|
|
26651
|
+
public readonly minItems: number;
|
|
26652
|
+
```
|
|
26653
|
+
|
|
26654
|
+
- *Type:* number
|
|
26655
|
+
- *Default:* undefined
|
|
26656
|
+
|
|
26657
|
+
(Optional) Minimum number of items that this input value (list) must contain.
|
|
26658
|
+
|
|
26659
|
+
---
|
|
26660
|
+
|
|
26167
26661
|
### UpdateAgentStepProps <a name="UpdateAgentStepProps" id="@cdklabs/cdk-ssm-documents.UpdateAgentStepProps"></a>
|
|
26168
26662
|
|
|
26169
26663
|
Properties UpdateAgent step.
|
|
@@ -26853,7 +27347,7 @@ public readonly apiParams: {[ key: string ]: any};
|
|
|
26853
27347
|
|
|
26854
27348
|
(Required) API Params to submit with the request to the api.
|
|
26855
27349
|
|
|
26856
|
-
You may include variables which will be substitued for inputs during step execution as such {{INPUT}}
|
|
27350
|
+
You may include variables which will be substitued for inputs during step execution as such {{ INPUT }}
|
|
26857
27351
|
|
|
26858
27352
|
---
|
|
26859
27353
|
|
|
@@ -27015,7 +27509,7 @@ public print(): any
|
|
|
27015
27509
|
|
|
27016
27510
|
Prints the variable in a way that SSM understands.
|
|
27017
27511
|
|
|
27018
|
-
This is typically in the form of {{Variable}} or the value.
|
|
27512
|
+
This is typically in the form of {{ Variable }} or the value.
|
|
27019
27513
|
|
|
27020
27514
|
##### `requiredInputs` <a name="requiredInputs" id="@cdklabs/cdk-ssm-documents.ActionVariable.requiredInputs"></a>
|
|
27021
27515
|
|
|
@@ -28034,7 +28528,7 @@ public executeStep(inputs: {[ key: string ]: any}): {[ key: string ]: any}
|
|
|
28034
28528
|
Invokes the specified service (param) with the specified api (param) with the specified apiParams (param).
|
|
28035
28529
|
|
|
28036
28530
|
This call will be invoked synchronously.
|
|
28037
|
-
The input variables in apiParams (param) specified using "{{INPUT}}" syntax will be replaced with the inputs.
|
|
28531
|
+
The input variables in apiParams (param) specified using "{{ INPUT }}" syntax will be replaced with the inputs.
|
|
28038
28532
|
|
|
28039
28533
|
###### `inputs`<sup>Required</sup> <a name="inputs" id="@cdklabs/cdk-ssm-documents.AwsApiSimulation.executeStep.parameter.inputs"></a>
|
|
28040
28534
|
|
|
@@ -28145,7 +28639,7 @@ public print(): any
|
|
|
28145
28639
|
|
|
28146
28640
|
Prints the variable in a way that SSM understands.
|
|
28147
28641
|
|
|
28148
|
-
This is typically in the form of {{Variable}} or the value.
|
|
28642
|
+
This is typically in the form of {{ Variable }} or the value.
|
|
28149
28643
|
|
|
28150
28644
|
##### `requiredInputs` <a name="requiredInputs" id="@cdklabs/cdk-ssm-documents.BooleanVariable.requiredInputs"></a>
|
|
28151
28645
|
|
|
@@ -29391,7 +29885,7 @@ public print(): any
|
|
|
29391
29885
|
|
|
29392
29886
|
Prints the variable in a way that SSM understands.
|
|
29393
29887
|
|
|
29394
|
-
This is typically in the form of {{Variable}} or the value.
|
|
29888
|
+
This is typically in the form of {{ Variable }} or the value.
|
|
29395
29889
|
|
|
29396
29890
|
##### `requiredInputs` <a name="requiredInputs" id="@cdklabs/cdk-ssm-documents.DesiredStateVariable.requiredInputs"></a>
|
|
29397
29891
|
|
|
@@ -29544,7 +30038,7 @@ public print(): any
|
|
|
29544
30038
|
|
|
29545
30039
|
Prints the variable in a way that SSM understands.
|
|
29546
30040
|
|
|
29547
|
-
This is typically in the form of {{Variable}} or the value.
|
|
30041
|
+
This is typically in the form of {{ Variable }} or the value.
|
|
29548
30042
|
|
|
29549
30043
|
##### `requiredInputs` <a name="requiredInputs" id="@cdklabs/cdk-ssm-documents.DictFormat.requiredInputs"></a>
|
|
29550
30044
|
|
|
@@ -29773,7 +30267,7 @@ public print(): any
|
|
|
29773
30267
|
|
|
29774
30268
|
Prints the variable in a way that SSM understands.
|
|
29775
30269
|
|
|
29776
|
-
This is typically in the form of {{Variable}} or the value.
|
|
30270
|
+
This is typically in the form of {{ Variable }} or the value.
|
|
29777
30271
|
|
|
29778
30272
|
##### `requiredInputs` <a name="requiredInputs" id="@cdklabs/cdk-ssm-documents.DocumentHashTypeVariable.requiredInputs"></a>
|
|
29779
30273
|
|
|
@@ -30167,7 +30661,7 @@ public readonly props: AwsInvocationSimulationProps;
|
|
|
30167
30661
|
|
|
30168
30662
|
Abstraction of SSM variables.
|
|
30169
30663
|
|
|
30170
|
-
Variables are printed as using this syntax: {{myVariable}}
|
|
30664
|
+
Variables are printed as using this syntax: {{ myVariable }}
|
|
30171
30665
|
To resolve a variable, you must supply the available inputs and the variable will resolve the value.
|
|
30172
30666
|
|
|
30173
30667
|
#### Initializers <a name="Initializers" id="@cdklabs/cdk-ssm-documents.GenericVariable.Initializer"></a>
|
|
@@ -30210,7 +30704,7 @@ public print(): any
|
|
|
30210
30704
|
|
|
30211
30705
|
Prints the variable in a way that SSM understands.
|
|
30212
30706
|
|
|
30213
|
-
This is typically in the form of {{Variable}} or the value.
|
|
30707
|
+
This is typically in the form of {{ Variable }} or the value.
|
|
30214
30708
|
|
|
30215
30709
|
##### `requiredInputs` <a name="requiredInputs" id="@cdklabs/cdk-ssm-documents.GenericVariable.requiredInputs"></a>
|
|
30216
30710
|
|
|
@@ -30570,7 +31064,7 @@ public print(): any
|
|
|
30570
31064
|
|
|
30571
31065
|
Prints the variable in a way that SSM understands.
|
|
30572
31066
|
|
|
30573
|
-
This is typically in the form of {{Variable}} or the value.
|
|
31067
|
+
This is typically in the form of {{ Variable }} or the value.
|
|
30574
31068
|
|
|
30575
31069
|
##### `requiredInputs` <a name="requiredInputs" id="@cdklabs/cdk-ssm-documents.HardCodedAction.requiredInputs"></a>
|
|
30576
31070
|
|
|
@@ -30744,7 +31238,7 @@ public print(): any
|
|
|
30744
31238
|
|
|
30745
31239
|
Prints the variable in a way that SSM understands.
|
|
30746
31240
|
|
|
30747
|
-
This is typically in the form of {{Variable}} or the value.
|
|
31241
|
+
This is typically in the form of {{ Variable }} or the value.
|
|
30748
31242
|
|
|
30749
31243
|
##### `requiredInputs` <a name="requiredInputs" id="@cdklabs/cdk-ssm-documents.HardCodedBoolean.requiredInputs"></a>
|
|
30750
31244
|
|
|
@@ -30873,7 +31367,7 @@ public print(): any
|
|
|
30873
31367
|
|
|
30874
31368
|
Prints the variable in a way that SSM understands.
|
|
30875
31369
|
|
|
30876
|
-
This is typically in the form of {{Variable}} or the value.
|
|
31370
|
+
This is typically in the form of {{ Variable }} or the value.
|
|
30877
31371
|
|
|
30878
31372
|
##### `requiredInputs` <a name="requiredInputs" id="@cdklabs/cdk-ssm-documents.HardCodedDesiredState.requiredInputs"></a>
|
|
30879
31373
|
|
|
@@ -31034,7 +31528,7 @@ public print(): any
|
|
|
31034
31528
|
|
|
31035
31529
|
Prints the variable in a way that SSM understands.
|
|
31036
31530
|
|
|
31037
|
-
This is typically in the form of {{Variable}} or the value.
|
|
31531
|
+
This is typically in the form of {{ Variable }} or the value.
|
|
31038
31532
|
|
|
31039
31533
|
##### `requiredInputs` <a name="requiredInputs" id="@cdklabs/cdk-ssm-documents.HardCodedDocumentHashType.requiredInputs"></a>
|
|
31040
31534
|
|
|
@@ -31184,7 +31678,7 @@ public print(): any
|
|
|
31184
31678
|
|
|
31185
31679
|
Prints the variable in a way that SSM understands.
|
|
31186
31680
|
|
|
31187
|
-
This is typically in the form of {{Variable}} or the value.
|
|
31681
|
+
This is typically in the form of {{ Variable }} or the value.
|
|
31188
31682
|
|
|
31189
31683
|
##### `requiredInputs` <a name="requiredInputs" id="@cdklabs/cdk-ssm-documents.HardCodedInstallationType.requiredInputs"></a>
|
|
31190
31684
|
|
|
@@ -31334,7 +31828,7 @@ public print(): any
|
|
|
31334
31828
|
|
|
31335
31829
|
Prints the variable in a way that SSM understands.
|
|
31336
31830
|
|
|
31337
|
-
This is typically in the form of {{Variable}} or the value.
|
|
31831
|
+
This is typically in the form of {{ Variable }} or the value.
|
|
31338
31832
|
|
|
31339
31833
|
##### `requiredInputs` <a name="requiredInputs" id="@cdklabs/cdk-ssm-documents.HardCodedInstallUninstallRepair.requiredInputs"></a>
|
|
31340
31834
|
|
|
@@ -31519,7 +32013,7 @@ public print(): any
|
|
|
31519
32013
|
|
|
31520
32014
|
Prints the variable in a way that SSM understands.
|
|
31521
32015
|
|
|
31522
|
-
This is typically in the form of {{Variable}} or the value.
|
|
32016
|
+
This is typically in the form of {{ Variable }} or the value.
|
|
31523
32017
|
|
|
31524
32018
|
##### `requiredInputs` <a name="requiredInputs" id="@cdklabs/cdk-ssm-documents.HardCodedMapList.requiredInputs"></a>
|
|
31525
32019
|
|
|
@@ -31665,7 +32159,7 @@ public print(): any
|
|
|
31665
32159
|
|
|
31666
32160
|
Prints the variable in a way that SSM understands.
|
|
31667
32161
|
|
|
31668
|
-
This is typically in the form of {{Variable}} or the value.
|
|
32162
|
+
This is typically in the form of {{ Variable }} or the value.
|
|
31669
32163
|
|
|
31670
32164
|
##### `requiredInputs` <a name="requiredInputs" id="@cdklabs/cdk-ssm-documents.HardCodedNumber.requiredInputs"></a>
|
|
31671
32165
|
|
|
@@ -31787,7 +32281,7 @@ public print(): any
|
|
|
31787
32281
|
|
|
31788
32282
|
Prints the variable in a way that SSM understands.
|
|
31789
32283
|
|
|
31790
|
-
This is typically in the form of {{Variable}} or the value.
|
|
32284
|
+
This is typically in the form of {{ Variable }} or the value.
|
|
31791
32285
|
|
|
31792
32286
|
##### `requiredInputs` <a name="requiredInputs" id="@cdklabs/cdk-ssm-documents.HardCodedOnFailure.requiredInputs"></a>
|
|
31793
32287
|
|
|
@@ -31948,7 +32442,7 @@ public print(): any
|
|
|
31948
32442
|
|
|
31949
32443
|
Prints the variable in a way that SSM understands.
|
|
31950
32444
|
|
|
31951
|
-
This is typically in the form of {{Variable}} or the value.
|
|
32445
|
+
This is typically in the form of {{ Variable }} or the value.
|
|
31952
32446
|
|
|
31953
32447
|
##### `requiredInputs` <a name="requiredInputs" id="@cdklabs/cdk-ssm-documents.HardCodedPackageName.requiredInputs"></a>
|
|
31954
32448
|
|
|
@@ -32153,7 +32647,7 @@ public print(): any
|
|
|
32153
32647
|
|
|
32154
32648
|
Prints the variable in a way that SSM understands.
|
|
32155
32649
|
|
|
32156
|
-
This is typically in the form of {{Variable}} or the value.
|
|
32650
|
+
This is typically in the form of {{ Variable }} or the value.
|
|
32157
32651
|
|
|
32158
32652
|
##### `requiredInputs` <a name="requiredInputs" id="@cdklabs/cdk-ssm-documents.HardCodedResourceType.requiredInputs"></a>
|
|
32159
32653
|
|
|
@@ -32345,7 +32839,7 @@ public print(): any
|
|
|
32345
32839
|
|
|
32346
32840
|
Prints the variable in a way that SSM understands.
|
|
32347
32841
|
|
|
32348
|
-
This is typically in the form of {{Variable}} or the value.
|
|
32842
|
+
This is typically in the form of {{ Variable }} or the value.
|
|
32349
32843
|
|
|
32350
32844
|
##### `requiredInputs` <a name="requiredInputs" id="@cdklabs/cdk-ssm-documents.HardCodedSecureVariable.requiredInputs"></a>
|
|
32351
32845
|
|
|
@@ -32499,7 +32993,7 @@ public print(): any
|
|
|
32499
32993
|
|
|
32500
32994
|
Prints the variable in a way that SSM understands.
|
|
32501
32995
|
|
|
32502
|
-
This is typically in the form of {{Variable}} or the value.
|
|
32996
|
+
This is typically in the form of {{ Variable }} or the value.
|
|
32503
32997
|
|
|
32504
32998
|
##### `requiredInputs` <a name="requiredInputs" id="@cdklabs/cdk-ssm-documents.HardCodedString.requiredInputs"></a>
|
|
32505
32999
|
|
|
@@ -32645,7 +33139,7 @@ public print(): any
|
|
|
32645
33139
|
|
|
32646
33140
|
Prints the variable in a way that SSM understands.
|
|
32647
33141
|
|
|
32648
|
-
This is typically in the form of {{Variable}} or the value.
|
|
33142
|
+
This is typically in the form of {{ Variable }} or the value.
|
|
32649
33143
|
|
|
32650
33144
|
##### `requiredInputs` <a name="requiredInputs" id="@cdklabs/cdk-ssm-documents.HardCodedStringList.requiredInputs"></a>
|
|
32651
33145
|
|
|
@@ -32791,7 +33285,7 @@ public print(): any
|
|
|
32791
33285
|
|
|
32792
33286
|
Prints the variable in a way that SSM understands.
|
|
32793
33287
|
|
|
32794
|
-
This is typically in the form of {{Variable}} or the value.
|
|
33288
|
+
This is typically in the form of {{ Variable }} or the value.
|
|
32795
33289
|
|
|
32796
33290
|
##### `requiredInputs` <a name="requiredInputs" id="@cdklabs/cdk-ssm-documents.HardCodedStringMap.requiredInputs"></a>
|
|
32797
33291
|
|
|
@@ -32932,7 +33426,7 @@ public print(): any
|
|
|
32932
33426
|
|
|
32933
33427
|
Prints the variable in a way that SSM understands.
|
|
32934
33428
|
|
|
32935
|
-
This is typically in the form of {{Variable}} or the value.
|
|
33429
|
+
This is typically in the form of {{ Variable }} or the value.
|
|
32936
33430
|
|
|
32937
33431
|
##### `requiredInputs` <a name="requiredInputs" id="@cdklabs/cdk-ssm-documents.HardCodedValueBase.requiredInputs"></a>
|
|
32938
33432
|
|
|
@@ -33092,6 +33586,333 @@ public readonly authMethod: AuthMethod;
|
|
|
33092
33586
|
---
|
|
33093
33587
|
|
|
33094
33588
|
|
|
33589
|
+
### Input <a name="Input" id="@cdklabs/cdk-ssm-documents.Input"></a>
|
|
33590
|
+
|
|
33591
|
+
#### Initializers <a name="Initializers" id="@cdklabs/cdk-ssm-documents.Input.Initializer"></a>
|
|
33592
|
+
|
|
33593
|
+
```typescript
|
|
33594
|
+
import { Input } from '@cdklabs/cdk-ssm-documents'
|
|
33595
|
+
|
|
33596
|
+
new Input(props: InputProps)
|
|
33597
|
+
```
|
|
33598
|
+
|
|
33599
|
+
| **Name** | **Type** | **Description** |
|
|
33600
|
+
| --- | --- | --- |
|
|
33601
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.Input.Initializer.parameter.props">props</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.InputProps">InputProps</a></code> | *No description.* |
|
|
33602
|
+
|
|
33603
|
+
---
|
|
33604
|
+
|
|
33605
|
+
##### `props`<sup>Required</sup> <a name="props" id="@cdklabs/cdk-ssm-documents.Input.Initializer.parameter.props"></a>
|
|
33606
|
+
|
|
33607
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.InputProps">InputProps</a>
|
|
33608
|
+
|
|
33609
|
+
---
|
|
33610
|
+
|
|
33611
|
+
#### Methods <a name="Methods" id="Methods"></a>
|
|
33612
|
+
|
|
33613
|
+
| **Name** | **Description** |
|
|
33614
|
+
| --- | --- |
|
|
33615
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.Input.toSsm">toSsm</a></code> | *No description.* |
|
|
33616
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.Input.validate">validate</a></code> | *No description.* |
|
|
33617
|
+
|
|
33618
|
+
---
|
|
33619
|
+
|
|
33620
|
+
##### `toSsm` <a name="toSsm" id="@cdklabs/cdk-ssm-documents.Input.toSsm"></a>
|
|
33621
|
+
|
|
33622
|
+
```typescript
|
|
33623
|
+
public toSsm(): {[ key: string ]: any}
|
|
33624
|
+
```
|
|
33625
|
+
|
|
33626
|
+
##### `validate` <a name="validate" id="@cdklabs/cdk-ssm-documents.Input.validate"></a>
|
|
33627
|
+
|
|
33628
|
+
```typescript
|
|
33629
|
+
public validate(value: any): void
|
|
33630
|
+
```
|
|
33631
|
+
|
|
33632
|
+
###### `value`<sup>Required</sup> <a name="value" id="@cdklabs/cdk-ssm-documents.Input.validate.parameter.value"></a>
|
|
33633
|
+
|
|
33634
|
+
- *Type:* any
|
|
33635
|
+
|
|
33636
|
+
---
|
|
33637
|
+
|
|
33638
|
+
#### Static Functions <a name="Static Functions" id="Static Functions"></a>
|
|
33639
|
+
|
|
33640
|
+
| **Name** | **Description** |
|
|
33641
|
+
| --- | --- |
|
|
33642
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.Input.ofSpecifiedType">ofSpecifiedType</a></code> | *No description.* |
|
|
33643
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.Input.ofTypeBoolean">ofTypeBoolean</a></code> | *No description.* |
|
|
33644
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.Input.ofTypeInteger">ofTypeInteger</a></code> | *No description.* |
|
|
33645
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.Input.ofTypeMapList">ofTypeMapList</a></code> | *No description.* |
|
|
33646
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.Input.ofTypeString">ofTypeString</a></code> | *No description.* |
|
|
33647
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.Input.ofTypeStringList">ofTypeStringList</a></code> | *No description.* |
|
|
33648
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.Input.ofTypeStringMap">ofTypeStringMap</a></code> | *No description.* |
|
|
33649
|
+
|
|
33650
|
+
---
|
|
33651
|
+
|
|
33652
|
+
##### `ofSpecifiedType` <a name="ofSpecifiedType" id="@cdklabs/cdk-ssm-documents.Input.ofSpecifiedType"></a>
|
|
33653
|
+
|
|
33654
|
+
```typescript
|
|
33655
|
+
import { Input } from '@cdklabs/cdk-ssm-documents'
|
|
33656
|
+
|
|
33657
|
+
Input.ofSpecifiedType(type: DataTypeEnum, inputName: string, props: InputProps)
|
|
33658
|
+
```
|
|
33659
|
+
|
|
33660
|
+
###### `type`<sup>Required</sup> <a name="type" id="@cdklabs/cdk-ssm-documents.Input.ofSpecifiedType.parameter.type"></a>
|
|
33661
|
+
|
|
33662
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.DataTypeEnum">DataTypeEnum</a>
|
|
33663
|
+
|
|
33664
|
+
---
|
|
33665
|
+
|
|
33666
|
+
###### `inputName`<sup>Required</sup> <a name="inputName" id="@cdklabs/cdk-ssm-documents.Input.ofSpecifiedType.parameter.inputName"></a>
|
|
33667
|
+
|
|
33668
|
+
- *Type:* string
|
|
33669
|
+
|
|
33670
|
+
---
|
|
33671
|
+
|
|
33672
|
+
###### `props`<sup>Required</sup> <a name="props" id="@cdklabs/cdk-ssm-documents.Input.ofSpecifiedType.parameter.props"></a>
|
|
33673
|
+
|
|
33674
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.InputProps">InputProps</a>
|
|
33675
|
+
|
|
33676
|
+
---
|
|
33677
|
+
|
|
33678
|
+
##### `ofTypeBoolean` <a name="ofTypeBoolean" id="@cdklabs/cdk-ssm-documents.Input.ofTypeBoolean"></a>
|
|
33679
|
+
|
|
33680
|
+
```typescript
|
|
33681
|
+
import { Input } from '@cdklabs/cdk-ssm-documents'
|
|
33682
|
+
|
|
33683
|
+
Input.ofTypeBoolean(name: string, props?: BooleanInputProps)
|
|
33684
|
+
```
|
|
33685
|
+
|
|
33686
|
+
###### `name`<sup>Required</sup> <a name="name" id="@cdklabs/cdk-ssm-documents.Input.ofTypeBoolean.parameter.name"></a>
|
|
33687
|
+
|
|
33688
|
+
- *Type:* string
|
|
33689
|
+
|
|
33690
|
+
---
|
|
33691
|
+
|
|
33692
|
+
###### `props`<sup>Optional</sup> <a name="props" id="@cdklabs/cdk-ssm-documents.Input.ofTypeBoolean.parameter.props"></a>
|
|
33693
|
+
|
|
33694
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.BooleanInputProps">BooleanInputProps</a>
|
|
33695
|
+
|
|
33696
|
+
---
|
|
33697
|
+
|
|
33698
|
+
##### `ofTypeInteger` <a name="ofTypeInteger" id="@cdklabs/cdk-ssm-documents.Input.ofTypeInteger"></a>
|
|
33699
|
+
|
|
33700
|
+
```typescript
|
|
33701
|
+
import { Input } from '@cdklabs/cdk-ssm-documents'
|
|
33702
|
+
|
|
33703
|
+
Input.ofTypeInteger(name: string, props?: IntegerInputProps)
|
|
33704
|
+
```
|
|
33705
|
+
|
|
33706
|
+
###### `name`<sup>Required</sup> <a name="name" id="@cdklabs/cdk-ssm-documents.Input.ofTypeInteger.parameter.name"></a>
|
|
33707
|
+
|
|
33708
|
+
- *Type:* string
|
|
33709
|
+
|
|
33710
|
+
---
|
|
33711
|
+
|
|
33712
|
+
###### `props`<sup>Optional</sup> <a name="props" id="@cdklabs/cdk-ssm-documents.Input.ofTypeInteger.parameter.props"></a>
|
|
33713
|
+
|
|
33714
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.IntegerInputProps">IntegerInputProps</a>
|
|
33715
|
+
|
|
33716
|
+
---
|
|
33717
|
+
|
|
33718
|
+
##### `ofTypeMapList` <a name="ofTypeMapList" id="@cdklabs/cdk-ssm-documents.Input.ofTypeMapList"></a>
|
|
33719
|
+
|
|
33720
|
+
```typescript
|
|
33721
|
+
import { Input } from '@cdklabs/cdk-ssm-documents'
|
|
33722
|
+
|
|
33723
|
+
Input.ofTypeMapList(name: string, props?: MapListInputProps)
|
|
33724
|
+
```
|
|
33725
|
+
|
|
33726
|
+
###### `name`<sup>Required</sup> <a name="name" id="@cdklabs/cdk-ssm-documents.Input.ofTypeMapList.parameter.name"></a>
|
|
33727
|
+
|
|
33728
|
+
- *Type:* string
|
|
33729
|
+
|
|
33730
|
+
---
|
|
33731
|
+
|
|
33732
|
+
###### `props`<sup>Optional</sup> <a name="props" id="@cdklabs/cdk-ssm-documents.Input.ofTypeMapList.parameter.props"></a>
|
|
33733
|
+
|
|
33734
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.MapListInputProps">MapListInputProps</a>
|
|
33735
|
+
|
|
33736
|
+
---
|
|
33737
|
+
|
|
33738
|
+
##### `ofTypeString` <a name="ofTypeString" id="@cdklabs/cdk-ssm-documents.Input.ofTypeString"></a>
|
|
33739
|
+
|
|
33740
|
+
```typescript
|
|
33741
|
+
import { Input } from '@cdklabs/cdk-ssm-documents'
|
|
33742
|
+
|
|
33743
|
+
Input.ofTypeString(name: string, props?: StringInputProps)
|
|
33744
|
+
```
|
|
33745
|
+
|
|
33746
|
+
###### `name`<sup>Required</sup> <a name="name" id="@cdklabs/cdk-ssm-documents.Input.ofTypeString.parameter.name"></a>
|
|
33747
|
+
|
|
33748
|
+
- *Type:* string
|
|
33749
|
+
|
|
33750
|
+
---
|
|
33751
|
+
|
|
33752
|
+
###### `props`<sup>Optional</sup> <a name="props" id="@cdklabs/cdk-ssm-documents.Input.ofTypeString.parameter.props"></a>
|
|
33753
|
+
|
|
33754
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.StringInputProps">StringInputProps</a>
|
|
33755
|
+
|
|
33756
|
+
---
|
|
33757
|
+
|
|
33758
|
+
##### `ofTypeStringList` <a name="ofTypeStringList" id="@cdklabs/cdk-ssm-documents.Input.ofTypeStringList"></a>
|
|
33759
|
+
|
|
33760
|
+
```typescript
|
|
33761
|
+
import { Input } from '@cdklabs/cdk-ssm-documents'
|
|
33762
|
+
|
|
33763
|
+
Input.ofTypeStringList(name: string, props?: StringListInputProps)
|
|
33764
|
+
```
|
|
33765
|
+
|
|
33766
|
+
###### `name`<sup>Required</sup> <a name="name" id="@cdklabs/cdk-ssm-documents.Input.ofTypeStringList.parameter.name"></a>
|
|
33767
|
+
|
|
33768
|
+
- *Type:* string
|
|
33769
|
+
|
|
33770
|
+
---
|
|
33771
|
+
|
|
33772
|
+
###### `props`<sup>Optional</sup> <a name="props" id="@cdklabs/cdk-ssm-documents.Input.ofTypeStringList.parameter.props"></a>
|
|
33773
|
+
|
|
33774
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.StringListInputProps">StringListInputProps</a>
|
|
33775
|
+
|
|
33776
|
+
---
|
|
33777
|
+
|
|
33778
|
+
##### `ofTypeStringMap` <a name="ofTypeStringMap" id="@cdklabs/cdk-ssm-documents.Input.ofTypeStringMap"></a>
|
|
33779
|
+
|
|
33780
|
+
```typescript
|
|
33781
|
+
import { Input } from '@cdklabs/cdk-ssm-documents'
|
|
33782
|
+
|
|
33783
|
+
Input.ofTypeStringMap(name: string, props?: StringMapInputProps)
|
|
33784
|
+
```
|
|
33785
|
+
|
|
33786
|
+
###### `name`<sup>Required</sup> <a name="name" id="@cdklabs/cdk-ssm-documents.Input.ofTypeStringMap.parameter.name"></a>
|
|
33787
|
+
|
|
33788
|
+
- *Type:* string
|
|
33789
|
+
|
|
33790
|
+
---
|
|
33791
|
+
|
|
33792
|
+
###### `props`<sup>Optional</sup> <a name="props" id="@cdklabs/cdk-ssm-documents.Input.ofTypeStringMap.parameter.props"></a>
|
|
33793
|
+
|
|
33794
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.StringMapInputProps">StringMapInputProps</a>
|
|
33795
|
+
|
|
33796
|
+
---
|
|
33797
|
+
|
|
33798
|
+
#### Properties <a name="Properties" id="Properties"></a>
|
|
33799
|
+
|
|
33800
|
+
| **Name** | **Type** | **Description** |
|
|
33801
|
+
| --- | --- | --- |
|
|
33802
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.Input.property.inputType">inputType</a></code> | <code><a href="#@cdklabs/cdk-ssm-documents.DataTypeEnum">DataTypeEnum</a></code> | *No description.* |
|
|
33803
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.Input.property.name">name</a></code> | <code>string</code> | *No description.* |
|
|
33804
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.Input.property.allowedPattern">allowedPattern</a></code> | <code>string</code> | *No description.* |
|
|
33805
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.Input.property.allowedValues">allowedValues</a></code> | <code>string[]</code> | *No description.* |
|
|
33806
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.Input.property.defaultValue">defaultValue</a></code> | <code>string</code> | *No description.* |
|
|
33807
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.Input.property.description">description</a></code> | <code>string</code> | *No description.* |
|
|
33808
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.Input.property.maxChars">maxChars</a></code> | <code>number</code> | *No description.* |
|
|
33809
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.Input.property.maxItems">maxItems</a></code> | <code>number</code> | *No description.* |
|
|
33810
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.Input.property.minChars">minChars</a></code> | <code>number</code> | *No description.* |
|
|
33811
|
+
| <code><a href="#@cdklabs/cdk-ssm-documents.Input.property.minItems">minItems</a></code> | <code>number</code> | *No description.* |
|
|
33812
|
+
|
|
33813
|
+
---
|
|
33814
|
+
|
|
33815
|
+
##### `inputType`<sup>Required</sup> <a name="inputType" id="@cdklabs/cdk-ssm-documents.Input.property.inputType"></a>
|
|
33816
|
+
|
|
33817
|
+
```typescript
|
|
33818
|
+
public readonly inputType: DataTypeEnum;
|
|
33819
|
+
```
|
|
33820
|
+
|
|
33821
|
+
- *Type:* <a href="#@cdklabs/cdk-ssm-documents.DataTypeEnum">DataTypeEnum</a>
|
|
33822
|
+
|
|
33823
|
+
---
|
|
33824
|
+
|
|
33825
|
+
##### `name`<sup>Required</sup> <a name="name" id="@cdklabs/cdk-ssm-documents.Input.property.name"></a>
|
|
33826
|
+
|
|
33827
|
+
```typescript
|
|
33828
|
+
public readonly name: string;
|
|
33829
|
+
```
|
|
33830
|
+
|
|
33831
|
+
- *Type:* string
|
|
33832
|
+
|
|
33833
|
+
---
|
|
33834
|
+
|
|
33835
|
+
##### `allowedPattern`<sup>Optional</sup> <a name="allowedPattern" id="@cdklabs/cdk-ssm-documents.Input.property.allowedPattern"></a>
|
|
33836
|
+
|
|
33837
|
+
```typescript
|
|
33838
|
+
public readonly allowedPattern: string;
|
|
33839
|
+
```
|
|
33840
|
+
|
|
33841
|
+
- *Type:* string
|
|
33842
|
+
|
|
33843
|
+
---
|
|
33844
|
+
|
|
33845
|
+
##### `allowedValues`<sup>Optional</sup> <a name="allowedValues" id="@cdklabs/cdk-ssm-documents.Input.property.allowedValues"></a>
|
|
33846
|
+
|
|
33847
|
+
```typescript
|
|
33848
|
+
public readonly allowedValues: string[];
|
|
33849
|
+
```
|
|
33850
|
+
|
|
33851
|
+
- *Type:* string[]
|
|
33852
|
+
|
|
33853
|
+
---
|
|
33854
|
+
|
|
33855
|
+
##### `defaultValue`<sup>Optional</sup> <a name="defaultValue" id="@cdklabs/cdk-ssm-documents.Input.property.defaultValue"></a>
|
|
33856
|
+
|
|
33857
|
+
```typescript
|
|
33858
|
+
public readonly defaultValue: string;
|
|
33859
|
+
```
|
|
33860
|
+
|
|
33861
|
+
- *Type:* string
|
|
33862
|
+
|
|
33863
|
+
---
|
|
33864
|
+
|
|
33865
|
+
##### `description`<sup>Optional</sup> <a name="description" id="@cdklabs/cdk-ssm-documents.Input.property.description"></a>
|
|
33866
|
+
|
|
33867
|
+
```typescript
|
|
33868
|
+
public readonly description: string;
|
|
33869
|
+
```
|
|
33870
|
+
|
|
33871
|
+
- *Type:* string
|
|
33872
|
+
|
|
33873
|
+
---
|
|
33874
|
+
|
|
33875
|
+
##### `maxChars`<sup>Optional</sup> <a name="maxChars" id="@cdklabs/cdk-ssm-documents.Input.property.maxChars"></a>
|
|
33876
|
+
|
|
33877
|
+
```typescript
|
|
33878
|
+
public readonly maxChars: number;
|
|
33879
|
+
```
|
|
33880
|
+
|
|
33881
|
+
- *Type:* number
|
|
33882
|
+
|
|
33883
|
+
---
|
|
33884
|
+
|
|
33885
|
+
##### `maxItems`<sup>Optional</sup> <a name="maxItems" id="@cdklabs/cdk-ssm-documents.Input.property.maxItems"></a>
|
|
33886
|
+
|
|
33887
|
+
```typescript
|
|
33888
|
+
public readonly maxItems: number;
|
|
33889
|
+
```
|
|
33890
|
+
|
|
33891
|
+
- *Type:* number
|
|
33892
|
+
|
|
33893
|
+
---
|
|
33894
|
+
|
|
33895
|
+
##### `minChars`<sup>Optional</sup> <a name="minChars" id="@cdklabs/cdk-ssm-documents.Input.property.minChars"></a>
|
|
33896
|
+
|
|
33897
|
+
```typescript
|
|
33898
|
+
public readonly minChars: number;
|
|
33899
|
+
```
|
|
33900
|
+
|
|
33901
|
+
- *Type:* number
|
|
33902
|
+
|
|
33903
|
+
---
|
|
33904
|
+
|
|
33905
|
+
##### `minItems`<sup>Optional</sup> <a name="minItems" id="@cdklabs/cdk-ssm-documents.Input.property.minItems"></a>
|
|
33906
|
+
|
|
33907
|
+
```typescript
|
|
33908
|
+
public readonly minItems: number;
|
|
33909
|
+
```
|
|
33910
|
+
|
|
33911
|
+
- *Type:* number
|
|
33912
|
+
|
|
33913
|
+
---
|
|
33914
|
+
|
|
33915
|
+
|
|
33095
33916
|
### InstallationTypeVariable <a name="InstallationTypeVariable" id="@cdklabs/cdk-ssm-documents.InstallationTypeVariable"></a>
|
|
33096
33917
|
|
|
33097
33918
|
- *Implements:* <a href="#@cdklabs/cdk-ssm-documents.IInstallationTypeVariable">IInstallationTypeVariable</a>
|
|
@@ -33137,7 +33958,7 @@ public print(): any
|
|
|
33137
33958
|
|
|
33138
33959
|
Prints the variable in a way that SSM understands.
|
|
33139
33960
|
|
|
33140
|
-
This is typically in the form of {{Variable}} or the value.
|
|
33961
|
+
This is typically in the form of {{ Variable }} or the value.
|
|
33141
33962
|
|
|
33142
33963
|
##### `requiredInputs` <a name="requiredInputs" id="@cdklabs/cdk-ssm-documents.InstallationTypeVariable.requiredInputs"></a>
|
|
33143
33964
|
|
|
@@ -33290,7 +34111,7 @@ public print(): any
|
|
|
33290
34111
|
|
|
33291
34112
|
Prints the variable in a way that SSM understands.
|
|
33292
34113
|
|
|
33293
|
-
This is typically in the form of {{Variable}} or the value.
|
|
34114
|
+
This is typically in the form of {{ Variable }} or the value.
|
|
33294
34115
|
|
|
33295
34116
|
##### `requiredInputs` <a name="requiredInputs" id="@cdklabs/cdk-ssm-documents.InstallUninstallRepairVariable.requiredInputs"></a>
|
|
33296
34117
|
|
|
@@ -33713,7 +34534,7 @@ public print(): any
|
|
|
33713
34534
|
|
|
33714
34535
|
Prints the variable in a way that SSM understands.
|
|
33715
34536
|
|
|
33716
|
-
This is typically in the form of {{Variable}} or the value.
|
|
34537
|
+
This is typically in the form of {{ Variable }} or the value.
|
|
33717
34538
|
|
|
33718
34539
|
##### `requiredInputs` <a name="requiredInputs" id="@cdklabs/cdk-ssm-documents.MapListVariable.requiredInputs"></a>
|
|
33719
34540
|
|
|
@@ -34420,7 +35241,7 @@ public print(): any
|
|
|
34420
35241
|
|
|
34421
35242
|
Prints the variable in a way that SSM understands.
|
|
34422
35243
|
|
|
34423
|
-
This is typically in the form of {{Variable}} or the value.
|
|
35244
|
+
This is typically in the form of {{ Variable }} or the value.
|
|
34424
35245
|
|
|
34425
35246
|
##### `requiredInputs` <a name="requiredInputs" id="@cdklabs/cdk-ssm-documents.NonSecureVariable.requiredInputs"></a>
|
|
34426
35247
|
|
|
@@ -34614,7 +35435,7 @@ public print(): any
|
|
|
34614
35435
|
|
|
34615
35436
|
Prints the variable in a way that SSM understands.
|
|
34616
35437
|
|
|
34617
|
-
This is typically in the form of {{Variable}} or the value.
|
|
35438
|
+
This is typically in the form of {{ Variable }} or the value.
|
|
34618
35439
|
|
|
34619
35440
|
##### `requiredInputs` <a name="requiredInputs" id="@cdklabs/cdk-ssm-documents.NumberVariable.requiredInputs"></a>
|
|
34620
35441
|
|
|
@@ -34756,7 +35577,7 @@ public print(): any
|
|
|
34756
35577
|
|
|
34757
35578
|
Prints the variable in a way that SSM understands.
|
|
34758
35579
|
|
|
34759
|
-
This is typically in the form of {{Variable}} or the value.
|
|
35580
|
+
This is typically in the form of {{ Variable }} or the value.
|
|
34760
35581
|
|
|
34761
35582
|
##### `requiredInputs` <a name="requiredInputs" id="@cdklabs/cdk-ssm-documents.OnFailureVariable.requiredInputs"></a>
|
|
34762
35583
|
|
|
@@ -35028,7 +35849,7 @@ public print(): any
|
|
|
35028
35849
|
|
|
35029
35850
|
Prints the variable in a way that SSM understands.
|
|
35030
35851
|
|
|
35031
|
-
This is typically in the form of {{Variable}} or the value.
|
|
35852
|
+
This is typically in the form of {{ Variable }} or the value.
|
|
35032
35853
|
|
|
35033
35854
|
##### `requiredInputs` <a name="requiredInputs" id="@cdklabs/cdk-ssm-documents.PackageNameVariable.requiredInputs"></a>
|
|
35034
35855
|
|
|
@@ -35569,7 +36390,7 @@ public print(): any
|
|
|
35569
36390
|
|
|
35570
36391
|
Prints the variable in a way that SSM understands.
|
|
35571
36392
|
|
|
35572
|
-
This is typically in the form of {{Variable}} or the value.
|
|
36393
|
+
This is typically in the form of {{ Variable }} or the value.
|
|
35573
36394
|
|
|
35574
36395
|
##### `requiredInputs` <a name="requiredInputs" id="@cdklabs/cdk-ssm-documents.ResourceTypeVariable.requiredInputs"></a>
|
|
35575
36396
|
|
|
@@ -36071,7 +36892,7 @@ public print(): any
|
|
|
36071
36892
|
|
|
36072
36893
|
Prints the variable in a way that SSM understands.
|
|
36073
36894
|
|
|
36074
|
-
This is typically in the form of {{Variable}} or the value.
|
|
36895
|
+
This is typically in the form of {{ Variable }} or the value.
|
|
36075
36896
|
|
|
36076
36897
|
##### `requiredInputs` <a name="requiredInputs" id="@cdklabs/cdk-ssm-documents.SecureVariable.requiredInputs"></a>
|
|
36077
36898
|
|
|
@@ -36570,7 +37391,7 @@ public print(): any
|
|
|
36570
37391
|
|
|
36571
37392
|
Prints the variable in a way that SSM understands.
|
|
36572
37393
|
|
|
36573
|
-
This is typically in the form of {{Variable}} or the value.
|
|
37394
|
+
This is typically in the form of {{ Variable }} or the value.
|
|
36574
37395
|
|
|
36575
37396
|
##### `requiredInputs` <a name="requiredInputs" id="@cdklabs/cdk-ssm-documents.SsmSecureVariable.requiredInputs"></a>
|
|
36576
37397
|
|
|
@@ -36859,7 +37680,7 @@ public print(): any
|
|
|
36859
37680
|
|
|
36860
37681
|
Prints the variable in a way that SSM understands.
|
|
36861
37682
|
|
|
36862
|
-
This is typically in the form of {{Variable}} or the value.
|
|
37683
|
+
This is typically in the form of {{ Variable }} or the value.
|
|
36863
37684
|
|
|
36864
37685
|
##### `requiredInputs` <a name="requiredInputs" id="@cdklabs/cdk-ssm-documents.StringFormat.requiredInputs"></a>
|
|
36865
37686
|
|
|
@@ -36987,7 +37808,7 @@ public print(): any
|
|
|
36987
37808
|
|
|
36988
37809
|
Prints the variable in a way that SSM understands.
|
|
36989
37810
|
|
|
36990
|
-
This is typically in the form of {{Variable}} or the value.
|
|
37811
|
+
This is typically in the form of {{ Variable }} or the value.
|
|
36991
37812
|
|
|
36992
37813
|
##### `requiredInputs` <a name="requiredInputs" id="@cdklabs/cdk-ssm-documents.StringListVariable.requiredInputs"></a>
|
|
36993
37814
|
|
|
@@ -37133,7 +37954,7 @@ public print(): any
|
|
|
37133
37954
|
|
|
37134
37955
|
Prints the variable in a way that SSM understands.
|
|
37135
37956
|
|
|
37136
|
-
This is typically in the form of {{Variable}} or the value.
|
|
37957
|
+
This is typically in the form of {{ Variable }} or the value.
|
|
37137
37958
|
|
|
37138
37959
|
##### `requiredInputs` <a name="requiredInputs" id="@cdklabs/cdk-ssm-documents.StringMapVariable.requiredInputs"></a>
|
|
37139
37960
|
|
|
@@ -37279,7 +38100,7 @@ public print(): any
|
|
|
37279
38100
|
|
|
37280
38101
|
Prints the variable in a way that SSM understands.
|
|
37281
38102
|
|
|
37282
|
-
This is typically in the form of {{Variable}} or the value.
|
|
38103
|
+
This is typically in the form of {{ Variable }} or the value.
|
|
37283
38104
|
|
|
37284
38105
|
##### `requiredInputs` <a name="requiredInputs" id="@cdklabs/cdk-ssm-documents.StringVariable.requiredInputs"></a>
|
|
37285
38106
|
|
|
@@ -38009,12 +38830,12 @@ public print(): any
|
|
|
38009
38830
|
|
|
38010
38831
|
Prints the variable in a way that SSM understands.
|
|
38011
38832
|
|
|
38012
|
-
This is typically in the form of {{Variable}} or the value.
|
|
38833
|
+
This is typically in the form of {{ Variable }} or the value.
|
|
38013
38834
|
|
|
38014
38835
|
*Example*
|
|
38015
38836
|
|
|
38016
38837
|
```typescript
|
|
38017
|
-
{{MyVariable}}
|
|
38838
|
+
{{ MyVariable }}
|
|
38018
38839
|
```
|
|
38019
38840
|
|
|
38020
38841
|
|