@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/.jsii
CHANGED
|
@@ -2798,7 +2798,7 @@
|
|
|
2798
2798
|
},
|
|
2799
2799
|
"name": "@cdklabs/cdk-ssm-documents",
|
|
2800
2800
|
"readme": {
|
|
2801
|
-
"markdown": "# SSM Document CDK\nThis library provides a code-based utility for implementing SSM Documents. The SSM Document objects can be used to print YAML/JSON documents and to mimic document processing locally.\n\nThis library abstracts SSM Documents at a high level, with each step as well as the document itself being objects. The properties needed to build these objects correlate to the settings that apply to them, making them simple to make.\nThis library can be used to test your document locally before deploying it to SSM.\n\nSince the library is written in JSII, it can be exported to other languages that support JSII (Java, Python).\n\nThis is what you'd use if you wanted to:\n1. The ability to test without deploying resources or executing an actual SSM on AWS.\n2. Reusability of steps between documents by reusing existing items\n3. Create logical higher-level groupings of reusable groups of steps (\"Patterns\")\n4. Simple to use interface for writing documents\n5. Import existing documents from a file (or string) and mimic them locally to test them.\n\n## Usage\n\n### Document Creation\n\nTypescript usage (Execute AWS API Step)...\nThe below creates the AutomationDocument in an AWS CDK stack.\n```ts\nimport { AutomationDocument } from './automation-document';\n\nexport class HelloWorld extends Stack {\n constructor(app: Construct, id: string) {\n super(app, id);\n\n // Create AutomationDocument\n const myDoc = new AutomationDocument(this, \"MyDoc\", {\n documentFormat: DocumentFormat.JSON,\n documentName: \"MyDoc\",\n docInputs: [
|
|
2801
|
+
"markdown": "# SSM Document CDK\nThis library provides a code-based utility for implementing SSM Documents. The SSM Document objects can be used to print YAML/JSON documents and to mimic document processing locally.\n\nThis library abstracts SSM Documents at a high level, with each step as well as the document itself being objects. The properties needed to build these objects correlate to the settings that apply to them, making them simple to make.\nThis library can be used to test your document locally before deploying it to SSM.\n\nSince the library is written in JSII, it can be exported to other languages that support JSII (Java, Python).\n\nThis is what you'd use if you wanted to:\n1. The ability to test without deploying resources or executing an actual SSM on AWS.\n2. Reusability of steps between documents by reusing existing items\n3. Create logical higher-level groupings of reusable groups of steps (\"Patterns\")\n4. Simple to use interface for writing documents\n5. Import existing documents from a file (or string) and mimic them locally to test them.\n\n## Usage\n\n### Document Creation\n\nTypescript usage (Execute AWS API Step)...\nThe below creates the AutomationDocument in an AWS CDK stack.\n```ts\nimport { AutomationDocument } from './automation-document';\n\nexport class HelloWorld extends Stack {\n constructor(app: Construct, id: string) {\n super(app, id);\n\n // Create AutomationDocument\n const myDoc = new AutomationDocument(this, \"MyDoc\", {\n documentFormat: DocumentFormat.JSON,\n documentName: \"MyDoc\",\n docInputs: [Input.ofTypeString('MyInput', { defaultValue: 'a' })],\n });\n\n // Define your steps...\n myDoc.addStep(new PauseStep(this, \"MyPauseStep\", { name: \"MyPauseStep\" }));\n\n myDoc.addStep(new ExecuteScriptStep(this, \"MyExecuteStep\", {\n name: \"step1\",\n handlerName: \"my_func\",\n language: ScriptLanguage.PYTHON,\n fullPathToCode: resolve(\"test/test_file.py\"),\n // OR .inlineCode(\"def my_func(args, context):\\n return {'MyReturn': args['MyInput'] + '-suffix'}\\n\")\n outputs: [{\n outputType: DataTypeEnum.STRING,\n name: \"MyFuncOut\",\n selector: \"$.Payload.MyReturn\"\n }],\n inputs: [\"MyInput\"]\n }));\n }\n}\n```\n\n### Document JSON/YAML Export as YAML/JSON\n\nYou can deploy the above document using CDK.\nTo print the above document object as a JSON (or YAML), do the following:\n\n```ts\nconst myDocJson = myDoc.print(); // Print YAML by setting the documentFormat to YAML\n```\n\n\n### Document Simulation\n\nTo run the document object in simulation mode, use the below. Simulation mode does NOT hit the SSM API, rather it mimics the execution that will happen in an SSM execution. The run happens locally and allows you to mock the calls to external services (AWS APIs for example) or to invoke those services using your local credentials.\n\n```ts\nimport { Simulation } from './simulation';\n\nconst myDocJson = Simulation.ofAutomation(myDoc, {}).simulate({ MyInput: \"FooBar\" });\n```\n\n### Command Documents\n\nBelow is an example of how to use the library to create Command documents.\nSimulation for command documents is not yet supported for all command plugins.\nYou can use a Docker image/container as a playground for testing the Command document execution for the supported plugins.\n\nIn this example there is a complete CDK stack. Notice that the `CommandDocument` is saved as a field so that it can be tested from the test code.\n```typescript\nexport class HelloCdkStack extends Stack {\n readonly myCommandDoc: CommandDocument;\n constructor(scope: Construct, id: string, props?: StackProps) {\n super(scope, id, props);\n this.myCommandDoc = new CommandDocument(this, \"MyCommandDoc\", {\n docInputs: [Input.ofTypeString('FirstCommand', { defaultValue: 'a' })],\n })\n const runScriptStep = new RunShellScriptStep(this, \"MyShellScript\", {\n runCommand: [\n StringVariable.of(\"FirstCommand\"),\n HardCodedString.of(\"mkdir asdf\"),\n ],\n });\n this.myCommandDoc.addStep(runScriptStep);\n }\n}\n```\n\nBelow is an example of how you would run a simulation against the above `CommandDocument`.\n\nCurrently, `bash` must be available in the container or the executions against the docker will not succeed.\n\n```typescript\ntest('Test command doc', () => {\n const app = new cdk.App();\n const stack = new HelloCdk.HelloCdkStack(app, 'MyTestStack');\n // 1. $ docker pull amazonlinux\n // 2. $ docker run -di amazonlinux\n const simulation = Simulation.ofCommand(stack.myCommandDoc, {\n simulationPlatform: Platform.LINUX,\n environment: DockerEnvironment.fromContainer('MY_CONTAINER_ID')\n });\n simulation.simulate({FirstCommand: 'mkdir foobar'})\n // 3. The document should run the first command (create 'foobar') and create file 'asdf'\n // 4. $ docker exec -it <container name> bash\n // 5. Ensure that 'asdf' and 'foobar' were written to /tmp\n});\n```\n\n## Patterns (High-Level Constructs)\n\nIn typical CDK style, you can assemble often used groups of steps into higher level Constructs.\n\nConsider if you typically create AutomationDocuments that start with logging the time and end with logging the total time taken. You can create a high-level Automation Document and extend that when you implement an Automation.\n\nSee the `TimedDocument` class to see such implementation.\n\nOr consider the case of multiple steps that are always run together such as rebooting and instance and waiting for it to be active.\n\nThe below example is copied from the `RebootInstanceAndWait` class:\n\n```ts\nexport class RebootInstanceAndWait extends CompositeAutomationStep {\n\n readonly reboot: AwsApiStep;\n readonly describe: WaitForResourceStep;\n\n constructor(scope: Construct, id: string, instanceId: IStringVariable) {\n super(scope, id);\n this.reboot = new AwsApiStep(this, 'RebootInstances', {\n service: 'ec2',\n pascalCaseApi: 'RebootInstances',\n apiParams: { InstanceIds: [instanceId] },\n outputs: [],\n });\n this.describe = new WaitForResourceStep(this, 'DescribeInstances', {\n service: 'ec2',\n pascalCaseApi: 'DescribeInstances',\n apiParams: { InstanceIds: [instanceId] },\n selector: '$.Reservations[0].Instances[0].State.Name',\n desiredValues: ['running'],\n });\n }\n\n addToDocument(doc: AutomationDocumentBuilder): void {\n doc.addStep(this.reboot);\n doc.addStep(this.describe);\n }\n}\n\n```\n\nNow, you can use `RebootInstanceAndWait` as a step in a document and the child steps will be included.\n\n## Existing Documents\n\nDo you have an existing document that you want to convert to code and/or test locally using the simulation?\n\n### Import Existing Document\n\nHere is an example of how you can import an existing document and then simulate it locally with mocked AWS resources:\n\n```ts\n// Initialize Mocks\nconst sleeper = new MockSleep();\nconst awsInvoker = new MockAwsInvoker();\nawsInvoker.whenThen(\n // when invoked with...\n {awsApi: 'listBuckets', awsParams: {}, service: 'S3'},\n // then response with...\n {Owner: {ID: \"BUCKET_ID\"}})\n\n// ======> Create document from file <=======\nconst stack: Stack = new Stack();\nconst myAutomationDoc = StringDocument.fromFile(stack, \"MyAutomationDoc\", 'test/myAutomation.json', {\n // ======================\n});\n\n// Execute simulation\nconst simOutput = Simulation.ofAutomation(myAutomationDoc, {\n sleepHook: sleeper,\n awsInvoker: awsInvoker\n}).simulate({});\n\n// Assert simulation result\nassert.deepEqual(awsInvoker.previousInvocations, [\n { awsApi: 'listBuckets', awsParams: {}, service: 'S3' }]);\nassert.deepEqual(sleeper.sleepMilliInvocations, [3000]);\nassert.deepEqual(simOutput.outputs['simulationSteps'], ['MySleep', 'GetBucketId']);\n```\n\n### Import Existing Steps\n\nYou can also grab a string step (or steps) and import them as CDK step constructs.\nThis can be used to convert existing documents into CDK with each step defined separately.\nDoing so will allow you do modify steps and reuse them in other documents.\n\nHere's a simple example of a sleep step copy and pasted from its original yaml:\n\n```ts\nStringStep.fromYaml(this, `\n name: sleep\n action: aws:sleep\n inputs:\n Duration: PT0M\n`, {});\n```\n\nThe above will return the CDK construct SleepStep.\n\n## What is Planned?\n\nThis library currently contains AutomationDocument steps.\n\nAlso planned is the ability to run Command documents.\n\nStay tuned!\n\n## Related Projects\n\n- https://github.com/udondan/cdk-ssm-document\n\n## Security\nSee [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more information.\n\n## License\nThis project is licensed under the Apache-2.0 License.\n\n"
|
|
2802
2802
|
},
|
|
2803
2803
|
"repository": {
|
|
2804
2804
|
"type": "git",
|
|
@@ -5641,7 +5641,7 @@
|
|
|
5641
5641
|
"methods": [
|
|
5642
5642
|
{
|
|
5643
5643
|
"docs": {
|
|
5644
|
-
"remarks": "This call will be invoked synchronously.\nThe input variables in apiParams (param) specified using \"{{INPUT}}\" syntax will be replaced with the inputs.",
|
|
5644
|
+
"remarks": "This call will be invoked synchronously.\nThe input variables in apiParams (param) specified using \"{{ INPUT }}\" syntax will be replaced with the inputs.",
|
|
5645
5645
|
"returns": "the AWS api response. The Output selection will take place outside of this function.",
|
|
5646
5646
|
"stability": "stable",
|
|
5647
5647
|
"summary": "Invokes the specified service (param) with the specified api (param) with the specified apiParams (param)."
|
|
@@ -5771,7 +5771,7 @@
|
|
|
5771
5771
|
"docs": {
|
|
5772
5772
|
"returns": "list of required inputs.",
|
|
5773
5773
|
"stability": "stable",
|
|
5774
|
-
"summary": "Derives the inputs by parsing the apiParams to find matches for inputs in double circle braces (\"{{INPUT}}\")."
|
|
5774
|
+
"summary": "Derives the inputs by parsing the apiParams to find matches for inputs in double circle braces (\"{{ INPUT }}\")."
|
|
5775
5775
|
},
|
|
5776
5776
|
"locationInModule": {
|
|
5777
5777
|
"filename": "src/parent-steps/automation/aws-api-step.ts",
|
|
@@ -5994,7 +5994,7 @@
|
|
|
5994
5994
|
"abstract": true,
|
|
5995
5995
|
"docs": {
|
|
5996
5996
|
"example": "{ 'VolumeIds': ['{{ EbsDescribeInstance.VolumeId }}'] }",
|
|
5997
|
-
"remarks": "You may include variables which will be substitued for inputs during step execution as such {{INPUT}}",
|
|
5997
|
+
"remarks": "You may include variables which will be substitued for inputs during step execution as such {{ INPUT }}",
|
|
5998
5998
|
"stability": "stable",
|
|
5999
5999
|
"summary": "(Required) API Params to submit with the request to the api."
|
|
6000
6000
|
},
|
|
@@ -6183,6 +6183,59 @@
|
|
|
6183
6183
|
"name": "BodyOrUrlType",
|
|
6184
6184
|
"symbolId": "src/parent-steps/automation/create-stack-step:BodyOrUrlType"
|
|
6185
6185
|
},
|
|
6186
|
+
"@cdklabs/cdk-ssm-documents.BooleanInputProps": {
|
|
6187
|
+
"assembly": "@cdklabs/cdk-ssm-documents",
|
|
6188
|
+
"datatype": true,
|
|
6189
|
+
"docs": {
|
|
6190
|
+
"stability": "stable"
|
|
6191
|
+
},
|
|
6192
|
+
"fqn": "@cdklabs/cdk-ssm-documents.BooleanInputProps",
|
|
6193
|
+
"kind": "interface",
|
|
6194
|
+
"locationInModule": {
|
|
6195
|
+
"filename": "src/domain/input.ts",
|
|
6196
|
+
"line": 265
|
|
6197
|
+
},
|
|
6198
|
+
"name": "BooleanInputProps",
|
|
6199
|
+
"properties": [
|
|
6200
|
+
{
|
|
6201
|
+
"abstract": true,
|
|
6202
|
+
"docs": {
|
|
6203
|
+
"default": "undefined",
|
|
6204
|
+
"stability": "stable",
|
|
6205
|
+
"summary": "(Optional) Default value to use for this input if not specified when invoking the document."
|
|
6206
|
+
},
|
|
6207
|
+
"immutable": true,
|
|
6208
|
+
"locationInModule": {
|
|
6209
|
+
"filename": "src/domain/input.ts",
|
|
6210
|
+
"line": 277
|
|
6211
|
+
},
|
|
6212
|
+
"name": "defaultValue",
|
|
6213
|
+
"optional": true,
|
|
6214
|
+
"type": {
|
|
6215
|
+
"primitive": "boolean"
|
|
6216
|
+
}
|
|
6217
|
+
},
|
|
6218
|
+
{
|
|
6219
|
+
"abstract": true,
|
|
6220
|
+
"docs": {
|
|
6221
|
+
"default": "name",
|
|
6222
|
+
"stability": "stable",
|
|
6223
|
+
"summary": "(Optional) The description of the input."
|
|
6224
|
+
},
|
|
6225
|
+
"immutable": true,
|
|
6226
|
+
"locationInModule": {
|
|
6227
|
+
"filename": "src/domain/input.ts",
|
|
6228
|
+
"line": 271
|
|
6229
|
+
},
|
|
6230
|
+
"name": "description",
|
|
6231
|
+
"optional": true,
|
|
6232
|
+
"type": {
|
|
6233
|
+
"primitive": "string"
|
|
6234
|
+
}
|
|
6235
|
+
}
|
|
6236
|
+
],
|
|
6237
|
+
"symbolId": "src/domain/input:BooleanInputProps"
|
|
6238
|
+
},
|
|
6186
6239
|
"@cdklabs/cdk-ssm-documents.BooleanVariable": {
|
|
6187
6240
|
"assembly": "@cdklabs/cdk-ssm-documents",
|
|
6188
6241
|
"base": "@cdklabs/cdk-ssm-documents.GenericVariable",
|
|
@@ -8815,7 +8868,7 @@
|
|
|
8815
8868
|
{
|
|
8816
8869
|
"abstract": true,
|
|
8817
8870
|
"docs": {
|
|
8818
|
-
"remarks": "Each parameter must be prefixed with SSM_.\nYou can reference a Parameter Store parameter in your additional arguments by using the convention {{ssm:parameter-name}}.\nTo use the additional parameter in your install, uninstall, or update script,\nyou must reference the parameter as an environment variable using the syntax appropriate for the operating system.\nFor example, in PowerShell, you reference the SSM_arg argument as $Env:SSM_arg.\nThere is no limit to the number of arguments you define, but the additional argument input has a 4096 character limit.\nThis limit includes all of the keys and values you define.",
|
|
8871
|
+
"remarks": "Each parameter must be prefixed with SSM_.\nYou can reference a Parameter Store parameter in your additional arguments by using the convention {{ ssm:parameter-name }}.\nTo use the additional parameter in your install, uninstall, or update script,\nyou must reference the parameter as an environment variable using the syntax appropriate for the operating system.\nFor example, in PowerShell, you reference the SSM_arg argument as $Env:SSM_arg.\nThere is no limit to the number of arguments you define, but the additional argument input has a 4096 character limit.\nThis limit includes all of the keys and values you define.",
|
|
8819
8872
|
"stability": "stable",
|
|
8820
8873
|
"summary": "The additional parameters to provide to your install, uninstall, or update scripts."
|
|
8821
8874
|
},
|
|
@@ -11773,7 +11826,7 @@
|
|
|
11773
11826
|
"methods": [
|
|
11774
11827
|
{
|
|
11775
11828
|
"docs": {
|
|
11776
|
-
"remarks": "This is typically in the form of {{Variable}} or the value.",
|
|
11829
|
+
"remarks": "This is typically in the form of {{ Variable }} or the value.",
|
|
11777
11830
|
"stability": "stable",
|
|
11778
11831
|
"summary": "Prints the variable in a way that SSM understands."
|
|
11779
11832
|
},
|
|
@@ -14508,7 +14561,7 @@
|
|
|
14508
14561
|
"abstract": true,
|
|
14509
14562
|
"assembly": "@cdklabs/cdk-ssm-documents",
|
|
14510
14563
|
"docs": {
|
|
14511
|
-
"remarks": "Variables are printed as using this syntax: {{myVariable}}\nTo resolve a variable, you must supply the available inputs and the variable will resolve the value.",
|
|
14564
|
+
"remarks": "Variables are printed as using this syntax: {{ myVariable }}\nTo resolve a variable, you must supply the available inputs and the variable will resolve the value.",
|
|
14512
14565
|
"stability": "stable",
|
|
14513
14566
|
"summary": "Abstraction of SSM variables."
|
|
14514
14567
|
},
|
|
@@ -14561,7 +14614,7 @@
|
|
|
14561
14614
|
},
|
|
14562
14615
|
{
|
|
14563
14616
|
"docs": {
|
|
14564
|
-
"remarks": "This is typically in the form of {{Variable}} or the value.",
|
|
14617
|
+
"remarks": "This is typically in the form of {{ Variable }} or the value.",
|
|
14565
14618
|
"stability": "stable",
|
|
14566
14619
|
"summary": "Prints the variable in a way that SSM understands."
|
|
14567
14620
|
},
|
|
@@ -16301,7 +16354,7 @@
|
|
|
16301
16354
|
"methods": [
|
|
16302
16355
|
{
|
|
16303
16356
|
"docs": {
|
|
16304
|
-
"remarks": "This is typically in the form of {{Variable}} or the value.",
|
|
16357
|
+
"remarks": "This is typically in the form of {{ Variable }} or the value.",
|
|
16305
16358
|
"stability": "stable",
|
|
16306
16359
|
"summary": "Prints the variable in a way that SSM understands."
|
|
16307
16360
|
},
|
|
@@ -16804,7 +16857,7 @@
|
|
|
16804
16857
|
},
|
|
16805
16858
|
{
|
|
16806
16859
|
"docs": {
|
|
16807
|
-
"remarks": "This is typically in the form of {{Variable}} or the value.",
|
|
16860
|
+
"remarks": "This is typically in the form of {{ Variable }} or the value.",
|
|
16808
16861
|
"stability": "stable",
|
|
16809
16862
|
"summary": "Prints the variable in a way that SSM understands."
|
|
16810
16863
|
},
|
|
@@ -16939,7 +16992,7 @@
|
|
|
16939
16992
|
},
|
|
16940
16993
|
"locationInModule": {
|
|
16941
16994
|
"filename": "src/samples/hello-world.ts",
|
|
16942
|
-
"line":
|
|
16995
|
+
"line": 11
|
|
16943
16996
|
},
|
|
16944
16997
|
"parameters": [
|
|
16945
16998
|
{
|
|
@@ -16959,7 +17012,7 @@
|
|
|
16959
17012
|
"kind": "class",
|
|
16960
17013
|
"locationInModule": {
|
|
16961
17014
|
"filename": "src/samples/hello-world.ts",
|
|
16962
|
-
"line":
|
|
17015
|
+
"line": 10
|
|
16963
17016
|
},
|
|
16964
17017
|
"name": "HelloWorld",
|
|
16965
17018
|
"symbolId": "src/samples/hello-world:HelloWorld"
|
|
@@ -17610,8 +17663,8 @@
|
|
|
17610
17663
|
{
|
|
17611
17664
|
"abstract": true,
|
|
17612
17665
|
"docs": {
|
|
17613
|
-
"example": "{{MyVariable}}",
|
|
17614
|
-
"remarks": "This is typically in the form of {{Variable}} or the value.",
|
|
17666
|
+
"example": "{{ MyVariable }}",
|
|
17667
|
+
"remarks": "This is typically in the form of {{ Variable }} or the value.",
|
|
17615
17668
|
"stability": "stable",
|
|
17616
17669
|
"summary": "Prints the variable in a way that SSM understands."
|
|
17617
17670
|
},
|
|
@@ -18350,212 +18403,286 @@
|
|
|
18350
18403
|
"symbolId": "src/interface/webhook:IWebhook"
|
|
18351
18404
|
},
|
|
18352
18405
|
"@cdklabs/cdk-ssm-documents.Input": {
|
|
18406
|
+
"abstract": true,
|
|
18353
18407
|
"assembly": "@cdklabs/cdk-ssm-documents",
|
|
18354
|
-
"datatype": true,
|
|
18355
18408
|
"docs": {
|
|
18356
|
-
"
|
|
18357
|
-
"stability": "stable",
|
|
18358
|
-
"summary": "Properties of inputs supported by SSM documents."
|
|
18409
|
+
"stability": "stable"
|
|
18359
18410
|
},
|
|
18360
18411
|
"fqn": "@cdklabs/cdk-ssm-documents.Input",
|
|
18361
|
-
"
|
|
18412
|
+
"initializer": {
|
|
18413
|
+
"docs": {
|
|
18414
|
+
"stability": "stable"
|
|
18415
|
+
},
|
|
18416
|
+
"locationInModule": {
|
|
18417
|
+
"filename": "src/domain/input.ts",
|
|
18418
|
+
"line": 125
|
|
18419
|
+
},
|
|
18420
|
+
"parameters": [
|
|
18421
|
+
{
|
|
18422
|
+
"name": "props",
|
|
18423
|
+
"type": {
|
|
18424
|
+
"fqn": "@cdklabs/cdk-ssm-documents.InputProps"
|
|
18425
|
+
}
|
|
18426
|
+
}
|
|
18427
|
+
]
|
|
18428
|
+
},
|
|
18429
|
+
"kind": "class",
|
|
18362
18430
|
"locationInModule": {
|
|
18363
18431
|
"filename": "src/domain/input.ts",
|
|
18364
|
-
"line":
|
|
18432
|
+
"line": 69
|
|
18365
18433
|
},
|
|
18366
|
-
"
|
|
18367
|
-
"properties": [
|
|
18434
|
+
"methods": [
|
|
18368
18435
|
{
|
|
18369
|
-
"abstract": true,
|
|
18370
18436
|
"docs": {
|
|
18371
|
-
"stability": "stable"
|
|
18372
|
-
"summary": "(Required) The DataTypeEnum of the input."
|
|
18437
|
+
"stability": "stable"
|
|
18373
18438
|
},
|
|
18374
|
-
"immutable": true,
|
|
18375
18439
|
"locationInModule": {
|
|
18376
18440
|
"filename": "src/domain/input.ts",
|
|
18377
|
-
"line":
|
|
18441
|
+
"line": 95
|
|
18378
18442
|
},
|
|
18379
|
-
"name": "
|
|
18380
|
-
"
|
|
18381
|
-
|
|
18382
|
-
|
|
18443
|
+
"name": "ofSpecifiedType",
|
|
18444
|
+
"parameters": [
|
|
18445
|
+
{
|
|
18446
|
+
"name": "type",
|
|
18447
|
+
"type": {
|
|
18448
|
+
"fqn": "@cdklabs/cdk-ssm-documents.DataTypeEnum"
|
|
18449
|
+
}
|
|
18450
|
+
},
|
|
18451
|
+
{
|
|
18452
|
+
"name": "inputName",
|
|
18453
|
+
"type": {
|
|
18454
|
+
"primitive": "string"
|
|
18455
|
+
}
|
|
18456
|
+
},
|
|
18457
|
+
{
|
|
18458
|
+
"name": "props",
|
|
18459
|
+
"type": {
|
|
18460
|
+
"fqn": "@cdklabs/cdk-ssm-documents.InputProps"
|
|
18461
|
+
}
|
|
18462
|
+
}
|
|
18463
|
+
],
|
|
18464
|
+
"returns": {
|
|
18465
|
+
"type": {
|
|
18466
|
+
"fqn": "@cdklabs/cdk-ssm-documents.Input"
|
|
18467
|
+
}
|
|
18468
|
+
},
|
|
18469
|
+
"static": true
|
|
18383
18470
|
},
|
|
18384
18471
|
{
|
|
18385
|
-
"abstract": true,
|
|
18386
18472
|
"docs": {
|
|
18387
|
-
"stability": "stable"
|
|
18388
|
-
"summary": "(Required) The name of the input by which to be referenced by steps in the document."
|
|
18473
|
+
"stability": "stable"
|
|
18389
18474
|
},
|
|
18390
|
-
"immutable": true,
|
|
18391
18475
|
"locationInModule": {
|
|
18392
18476
|
"filename": "src/domain/input.ts",
|
|
18393
|
-
"line":
|
|
18477
|
+
"line": 79
|
|
18394
18478
|
},
|
|
18395
|
-
"name": "
|
|
18396
|
-
"
|
|
18397
|
-
|
|
18398
|
-
|
|
18479
|
+
"name": "ofTypeBoolean",
|
|
18480
|
+
"parameters": [
|
|
18481
|
+
{
|
|
18482
|
+
"name": "name",
|
|
18483
|
+
"type": {
|
|
18484
|
+
"primitive": "string"
|
|
18485
|
+
}
|
|
18486
|
+
},
|
|
18487
|
+
{
|
|
18488
|
+
"name": "props",
|
|
18489
|
+
"optional": true,
|
|
18490
|
+
"type": {
|
|
18491
|
+
"fqn": "@cdklabs/cdk-ssm-documents.BooleanInputProps"
|
|
18492
|
+
}
|
|
18493
|
+
}
|
|
18494
|
+
],
|
|
18495
|
+
"returns": {
|
|
18496
|
+
"type": {
|
|
18497
|
+
"fqn": "@cdklabs/cdk-ssm-documents.Input"
|
|
18498
|
+
}
|
|
18499
|
+
},
|
|
18500
|
+
"static": true
|
|
18399
18501
|
},
|
|
18400
18502
|
{
|
|
18401
|
-
"abstract": true,
|
|
18402
18503
|
"docs": {
|
|
18403
|
-
"
|
|
18404
|
-
"stability": "stable",
|
|
18405
|
-
"summary": "(Optional) Pattern that this input value must match."
|
|
18504
|
+
"stability": "stable"
|
|
18406
18505
|
},
|
|
18407
|
-
"immutable": true,
|
|
18408
18506
|
"locationInModule": {
|
|
18409
18507
|
"filename": "src/domain/input.ts",
|
|
18410
|
-
"line":
|
|
18508
|
+
"line": 75
|
|
18411
18509
|
},
|
|
18412
|
-
"name": "
|
|
18413
|
-
"
|
|
18414
|
-
|
|
18415
|
-
|
|
18416
|
-
|
|
18510
|
+
"name": "ofTypeInteger",
|
|
18511
|
+
"parameters": [
|
|
18512
|
+
{
|
|
18513
|
+
"name": "name",
|
|
18514
|
+
"type": {
|
|
18515
|
+
"primitive": "string"
|
|
18516
|
+
}
|
|
18517
|
+
},
|
|
18518
|
+
{
|
|
18519
|
+
"name": "props",
|
|
18520
|
+
"optional": true,
|
|
18521
|
+
"type": {
|
|
18522
|
+
"fqn": "@cdklabs/cdk-ssm-documents.IntegerInputProps"
|
|
18523
|
+
}
|
|
18524
|
+
}
|
|
18525
|
+
],
|
|
18526
|
+
"returns": {
|
|
18527
|
+
"type": {
|
|
18528
|
+
"fqn": "@cdklabs/cdk-ssm-documents.Input"
|
|
18529
|
+
}
|
|
18530
|
+
},
|
|
18531
|
+
"static": true
|
|
18417
18532
|
},
|
|
18418
18533
|
{
|
|
18419
|
-
"abstract": true,
|
|
18420
18534
|
"docs": {
|
|
18421
|
-
"
|
|
18422
|
-
"stability": "stable",
|
|
18423
|
-
"summary": "(Optional) List of allowed values that this input may be."
|
|
18535
|
+
"stability": "stable"
|
|
18424
18536
|
},
|
|
18425
|
-
"immutable": true,
|
|
18426
18537
|
"locationInModule": {
|
|
18427
18538
|
"filename": "src/domain/input.ts",
|
|
18428
|
-
"line":
|
|
18539
|
+
"line": 87
|
|
18429
18540
|
},
|
|
18430
|
-
"name": "
|
|
18431
|
-
"
|
|
18432
|
-
|
|
18433
|
-
|
|
18434
|
-
"
|
|
18541
|
+
"name": "ofTypeMapList",
|
|
18542
|
+
"parameters": [
|
|
18543
|
+
{
|
|
18544
|
+
"name": "name",
|
|
18545
|
+
"type": {
|
|
18435
18546
|
"primitive": "string"
|
|
18436
|
-
}
|
|
18437
|
-
|
|
18547
|
+
}
|
|
18548
|
+
},
|
|
18549
|
+
{
|
|
18550
|
+
"name": "props",
|
|
18551
|
+
"optional": true,
|
|
18552
|
+
"type": {
|
|
18553
|
+
"fqn": "@cdklabs/cdk-ssm-documents.MapListInputProps"
|
|
18554
|
+
}
|
|
18438
18555
|
}
|
|
18439
|
-
|
|
18556
|
+
],
|
|
18557
|
+
"returns": {
|
|
18558
|
+
"type": {
|
|
18559
|
+
"fqn": "@cdklabs/cdk-ssm-documents.Input"
|
|
18560
|
+
}
|
|
18561
|
+
},
|
|
18562
|
+
"static": true
|
|
18440
18563
|
},
|
|
18441
18564
|
{
|
|
18442
|
-
"abstract": true,
|
|
18443
18565
|
"docs": {
|
|
18444
|
-
"
|
|
18445
|
-
"stability": "stable",
|
|
18446
|
-
"summary": "(Optional) Default value to use for this input if not specified when invoking the document."
|
|
18566
|
+
"stability": "stable"
|
|
18447
18567
|
},
|
|
18448
|
-
"immutable": true,
|
|
18449
18568
|
"locationInModule": {
|
|
18450
18569
|
"filename": "src/domain/input.ts",
|
|
18451
|
-
"line":
|
|
18570
|
+
"line": 71
|
|
18452
18571
|
},
|
|
18453
|
-
"name": "
|
|
18454
|
-
"
|
|
18455
|
-
|
|
18456
|
-
|
|
18457
|
-
|
|
18572
|
+
"name": "ofTypeString",
|
|
18573
|
+
"parameters": [
|
|
18574
|
+
{
|
|
18575
|
+
"name": "name",
|
|
18576
|
+
"type": {
|
|
18577
|
+
"primitive": "string"
|
|
18578
|
+
}
|
|
18579
|
+
},
|
|
18580
|
+
{
|
|
18581
|
+
"name": "props",
|
|
18582
|
+
"optional": true,
|
|
18583
|
+
"type": {
|
|
18584
|
+
"fqn": "@cdklabs/cdk-ssm-documents.StringInputProps"
|
|
18585
|
+
}
|
|
18586
|
+
}
|
|
18587
|
+
],
|
|
18588
|
+
"returns": {
|
|
18589
|
+
"type": {
|
|
18590
|
+
"fqn": "@cdklabs/cdk-ssm-documents.Input"
|
|
18591
|
+
}
|
|
18592
|
+
},
|
|
18593
|
+
"static": true
|
|
18458
18594
|
},
|
|
18459
18595
|
{
|
|
18460
|
-
"abstract": true,
|
|
18461
18596
|
"docs": {
|
|
18462
|
-
"
|
|
18463
|
-
"stability": "stable",
|
|
18464
|
-
"summary": "(Optional) The description of the input."
|
|
18597
|
+
"stability": "stable"
|
|
18465
18598
|
},
|
|
18466
|
-
"immutable": true,
|
|
18467
18599
|
"locationInModule": {
|
|
18468
18600
|
"filename": "src/domain/input.ts",
|
|
18469
|
-
"line":
|
|
18470
|
-
},
|
|
18471
|
-
"name": "
|
|
18472
|
-
"
|
|
18473
|
-
|
|
18474
|
-
|
|
18475
|
-
|
|
18476
|
-
|
|
18477
|
-
|
|
18478
|
-
|
|
18479
|
-
|
|
18480
|
-
|
|
18481
|
-
|
|
18482
|
-
|
|
18601
|
+
"line": 83
|
|
18602
|
+
},
|
|
18603
|
+
"name": "ofTypeStringList",
|
|
18604
|
+
"parameters": [
|
|
18605
|
+
{
|
|
18606
|
+
"name": "name",
|
|
18607
|
+
"type": {
|
|
18608
|
+
"primitive": "string"
|
|
18609
|
+
}
|
|
18610
|
+
},
|
|
18611
|
+
{
|
|
18612
|
+
"name": "props",
|
|
18613
|
+
"optional": true,
|
|
18614
|
+
"type": {
|
|
18615
|
+
"fqn": "@cdklabs/cdk-ssm-documents.StringListInputProps"
|
|
18616
|
+
}
|
|
18617
|
+
}
|
|
18618
|
+
],
|
|
18619
|
+
"returns": {
|
|
18620
|
+
"type": {
|
|
18621
|
+
"fqn": "@cdklabs/cdk-ssm-documents.Input"
|
|
18622
|
+
}
|
|
18623
|
+
},
|
|
18624
|
+
"static": true
|
|
18625
|
+
},
|
|
18626
|
+
{
|
|
18627
|
+
"docs": {
|
|
18628
|
+
"stability": "stable"
|
|
18483
18629
|
},
|
|
18484
|
-
"immutable": true,
|
|
18485
18630
|
"locationInModule": {
|
|
18486
18631
|
"filename": "src/domain/input.ts",
|
|
18487
|
-
"line":
|
|
18632
|
+
"line": 91
|
|
18488
18633
|
},
|
|
18489
|
-
"name": "
|
|
18490
|
-
"
|
|
18491
|
-
|
|
18492
|
-
|
|
18493
|
-
|
|
18634
|
+
"name": "ofTypeStringMap",
|
|
18635
|
+
"parameters": [
|
|
18636
|
+
{
|
|
18637
|
+
"name": "name",
|
|
18638
|
+
"type": {
|
|
18639
|
+
"primitive": "string"
|
|
18640
|
+
}
|
|
18641
|
+
},
|
|
18642
|
+
{
|
|
18643
|
+
"name": "props",
|
|
18644
|
+
"optional": true,
|
|
18645
|
+
"type": {
|
|
18646
|
+
"fqn": "@cdklabs/cdk-ssm-documents.StringMapInputProps"
|
|
18647
|
+
}
|
|
18648
|
+
}
|
|
18649
|
+
],
|
|
18650
|
+
"returns": {
|
|
18651
|
+
"type": {
|
|
18652
|
+
"fqn": "@cdklabs/cdk-ssm-documents.Input"
|
|
18653
|
+
}
|
|
18654
|
+
},
|
|
18655
|
+
"static": true
|
|
18494
18656
|
},
|
|
18495
18657
|
{
|
|
18496
|
-
"abstract": true,
|
|
18497
18658
|
"docs": {
|
|
18498
|
-
"
|
|
18499
|
-
"stability": "stable",
|
|
18500
|
-
"summary": "(Optional) Minimum number of items that this input value (list) must contain."
|
|
18659
|
+
"stability": "stable"
|
|
18501
18660
|
},
|
|
18502
|
-
"immutable": true,
|
|
18503
18661
|
"locationInModule": {
|
|
18504
18662
|
"filename": "src/domain/input.ts",
|
|
18505
|
-
"line":
|
|
18663
|
+
"line": 138
|
|
18506
18664
|
},
|
|
18507
|
-
"name": "
|
|
18508
|
-
"
|
|
18509
|
-
"type": {
|
|
18510
|
-
"primitive": "number"
|
|
18511
|
-
}
|
|
18512
|
-
}
|
|
18513
|
-
],
|
|
18514
|
-
"symbolId": "src/domain/input:Input"
|
|
18515
|
-
},
|
|
18516
|
-
"@cdklabs/cdk-ssm-documents.InstallUninstallRepairVariable": {
|
|
18517
|
-
"assembly": "@cdklabs/cdk-ssm-documents",
|
|
18518
|
-
"base": "@cdklabs/cdk-ssm-documents.StringVariable",
|
|
18519
|
-
"docs": {
|
|
18520
|
-
"stability": "stable"
|
|
18521
|
-
},
|
|
18522
|
-
"fqn": "@cdklabs/cdk-ssm-documents.InstallUninstallRepairVariable",
|
|
18523
|
-
"initializer": {
|
|
18524
|
-
"docs": {
|
|
18525
|
-
"stability": "stable"
|
|
18526
|
-
},
|
|
18527
|
-
"locationInModule": {
|
|
18528
|
-
"filename": "src/interface/variables/variable.ts",
|
|
18529
|
-
"line": 72
|
|
18530
|
-
},
|
|
18531
|
-
"parameters": [
|
|
18532
|
-
{
|
|
18533
|
-
"name": "reference",
|
|
18665
|
+
"name": "toSsm",
|
|
18666
|
+
"returns": {
|
|
18534
18667
|
"type": {
|
|
18535
|
-
"
|
|
18668
|
+
"collection": {
|
|
18669
|
+
"elementtype": {
|
|
18670
|
+
"primitive": "any"
|
|
18671
|
+
},
|
|
18672
|
+
"kind": "map"
|
|
18673
|
+
}
|
|
18536
18674
|
}
|
|
18537
18675
|
}
|
|
18538
|
-
|
|
18539
|
-
},
|
|
18540
|
-
"interfaces": [
|
|
18541
|
-
"@cdklabs/cdk-ssm-documents.IInstallUninstallRepairVariable"
|
|
18542
|
-
],
|
|
18543
|
-
"kind": "class",
|
|
18544
|
-
"locationInModule": {
|
|
18545
|
-
"filename": "src/domain/enum/install-uninstall-repair.ts",
|
|
18546
|
-
"line": 15
|
|
18547
|
-
},
|
|
18548
|
-
"methods": [
|
|
18676
|
+
},
|
|
18549
18677
|
{
|
|
18550
18678
|
"docs": {
|
|
18551
18679
|
"stability": "stable"
|
|
18552
18680
|
},
|
|
18553
18681
|
"locationInModule": {
|
|
18554
|
-
"filename": "src/domain/
|
|
18555
|
-
"line":
|
|
18682
|
+
"filename": "src/domain/input.ts",
|
|
18683
|
+
"line": 163
|
|
18556
18684
|
},
|
|
18557
|
-
"name": "
|
|
18558
|
-
"overrides": "@cdklabs/cdk-ssm-documents.StringVariable",
|
|
18685
|
+
"name": "validate",
|
|
18559
18686
|
"parameters": [
|
|
18560
18687
|
{
|
|
18561
18688
|
"name": "value",
|
|
@@ -18563,11 +18690,10 @@
|
|
|
18563
18690
|
"primitive": "any"
|
|
18564
18691
|
}
|
|
18565
18692
|
}
|
|
18566
|
-
]
|
|
18567
|
-
"protected": true
|
|
18693
|
+
]
|
|
18568
18694
|
}
|
|
18569
18695
|
],
|
|
18570
|
-
"name": "
|
|
18696
|
+
"name": "Input",
|
|
18571
18697
|
"properties": [
|
|
18572
18698
|
{
|
|
18573
18699
|
"docs": {
|
|
@@ -18575,88 +18701,54 @@
|
|
|
18575
18701
|
},
|
|
18576
18702
|
"immutable": true,
|
|
18577
18703
|
"locationInModule": {
|
|
18578
|
-
"filename": "src/domain/
|
|
18579
|
-
"line":
|
|
18704
|
+
"filename": "src/domain/input.ts",
|
|
18705
|
+
"line": 115
|
|
18580
18706
|
},
|
|
18581
|
-
"name": "
|
|
18707
|
+
"name": "inputType",
|
|
18582
18708
|
"type": {
|
|
18583
|
-
"
|
|
18584
|
-
"elementtype": {
|
|
18585
|
-
"primitive": "string"
|
|
18586
|
-
},
|
|
18587
|
-
"kind": "array"
|
|
18588
|
-
}
|
|
18709
|
+
"fqn": "@cdklabs/cdk-ssm-documents.DataTypeEnum"
|
|
18589
18710
|
}
|
|
18590
|
-
}
|
|
18591
|
-
],
|
|
18592
|
-
"symbolId": "src/domain/enum/install-uninstall-repair:InstallUninstallRepairVariable"
|
|
18593
|
-
},
|
|
18594
|
-
"@cdklabs/cdk-ssm-documents.InstallationTypeVariable": {
|
|
18595
|
-
"assembly": "@cdklabs/cdk-ssm-documents",
|
|
18596
|
-
"base": "@cdklabs/cdk-ssm-documents.StringVariable",
|
|
18597
|
-
"docs": {
|
|
18598
|
-
"stability": "stable"
|
|
18599
|
-
},
|
|
18600
|
-
"fqn": "@cdklabs/cdk-ssm-documents.InstallationTypeVariable",
|
|
18601
|
-
"initializer": {
|
|
18602
|
-
"docs": {
|
|
18603
|
-
"stability": "stable"
|
|
18604
|
-
},
|
|
18605
|
-
"locationInModule": {
|
|
18606
|
-
"filename": "src/interface/variables/variable.ts",
|
|
18607
|
-
"line": 72
|
|
18608
18711
|
},
|
|
18609
|
-
|
|
18610
|
-
{
|
|
18611
|
-
"
|
|
18612
|
-
|
|
18613
|
-
|
|
18614
|
-
|
|
18712
|
+
{
|
|
18713
|
+
"docs": {
|
|
18714
|
+
"stability": "stable"
|
|
18715
|
+
},
|
|
18716
|
+
"immutable": true,
|
|
18717
|
+
"locationInModule": {
|
|
18718
|
+
"filename": "src/domain/input.ts",
|
|
18719
|
+
"line": 114
|
|
18720
|
+
},
|
|
18721
|
+
"name": "name",
|
|
18722
|
+
"type": {
|
|
18723
|
+
"primitive": "string"
|
|
18615
18724
|
}
|
|
18616
|
-
|
|
18617
|
-
},
|
|
18618
|
-
"interfaces": [
|
|
18619
|
-
"@cdklabs/cdk-ssm-documents.IInstallationTypeVariable"
|
|
18620
|
-
],
|
|
18621
|
-
"kind": "class",
|
|
18622
|
-
"locationInModule": {
|
|
18623
|
-
"filename": "src/domain/enum/installation-type.ts",
|
|
18624
|
-
"line": 14
|
|
18625
|
-
},
|
|
18626
|
-
"methods": [
|
|
18725
|
+
},
|
|
18627
18726
|
{
|
|
18628
18727
|
"docs": {
|
|
18629
18728
|
"stability": "stable"
|
|
18630
18729
|
},
|
|
18730
|
+
"immutable": true,
|
|
18631
18731
|
"locationInModule": {
|
|
18632
|
-
"filename": "src/domain/
|
|
18633
|
-
"line":
|
|
18732
|
+
"filename": "src/domain/input.ts",
|
|
18733
|
+
"line": 119
|
|
18634
18734
|
},
|
|
18635
|
-
"name": "
|
|
18636
|
-
"
|
|
18637
|
-
"
|
|
18638
|
-
|
|
18639
|
-
|
|
18640
|
-
|
|
18641
|
-
"primitive": "any"
|
|
18642
|
-
}
|
|
18643
|
-
}
|
|
18644
|
-
],
|
|
18645
|
-
"protected": true
|
|
18646
|
-
}
|
|
18647
|
-
],
|
|
18648
|
-
"name": "InstallationTypeVariable",
|
|
18649
|
-
"properties": [
|
|
18735
|
+
"name": "allowedPattern",
|
|
18736
|
+
"optional": true,
|
|
18737
|
+
"type": {
|
|
18738
|
+
"primitive": "string"
|
|
18739
|
+
}
|
|
18740
|
+
},
|
|
18650
18741
|
{
|
|
18651
18742
|
"docs": {
|
|
18652
18743
|
"stability": "stable"
|
|
18653
18744
|
},
|
|
18654
18745
|
"immutable": true,
|
|
18655
18746
|
"locationInModule": {
|
|
18656
|
-
"filename": "src/domain/
|
|
18657
|
-
"line":
|
|
18747
|
+
"filename": "src/domain/input.ts",
|
|
18748
|
+
"line": 118
|
|
18658
18749
|
},
|
|
18659
|
-
"name": "
|
|
18750
|
+
"name": "allowedValues",
|
|
18751
|
+
"optional": true,
|
|
18660
18752
|
"type": {
|
|
18661
18753
|
"collection": {
|
|
18662
18754
|
"elementtype": {
|
|
@@ -18665,58 +18757,580 @@
|
|
|
18665
18757
|
"kind": "array"
|
|
18666
18758
|
}
|
|
18667
18759
|
}
|
|
18668
|
-
}
|
|
18669
|
-
],
|
|
18670
|
-
"symbolId": "src/domain/enum/installation-type:InstallationTypeVariable"
|
|
18671
|
-
},
|
|
18672
|
-
"@cdklabs/cdk-ssm-documents.Invocation": {
|
|
18673
|
-
"assembly": "@cdklabs/cdk-ssm-documents",
|
|
18674
|
-
"datatype": true,
|
|
18675
|
-
"docs": {
|
|
18676
|
-
"stability": "stable"
|
|
18677
|
-
},
|
|
18678
|
-
"fqn": "@cdklabs/cdk-ssm-documents.Invocation",
|
|
18679
|
-
"kind": "interface",
|
|
18680
|
-
"locationInModule": {
|
|
18681
|
-
"filename": "src/interface/aws-invoker.ts",
|
|
18682
|
-
"line": 4
|
|
18683
|
-
},
|
|
18684
|
-
"name": "Invocation",
|
|
18685
|
-
"properties": [
|
|
18760
|
+
},
|
|
18686
18761
|
{
|
|
18687
|
-
"abstract": true,
|
|
18688
18762
|
"docs": {
|
|
18689
|
-
"
|
|
18690
|
-
"remarks": "should be referenced using lowerCamelCase.",
|
|
18691
|
-
"stability": "stable",
|
|
18692
|
-
"summary": "(Required) AWS api to invoke;"
|
|
18763
|
+
"stability": "stable"
|
|
18693
18764
|
},
|
|
18694
18765
|
"immutable": true,
|
|
18695
18766
|
"locationInModule": {
|
|
18696
|
-
"filename": "src/
|
|
18697
|
-
"line":
|
|
18767
|
+
"filename": "src/domain/input.ts",
|
|
18768
|
+
"line": 117
|
|
18698
18769
|
},
|
|
18699
|
-
"name": "
|
|
18770
|
+
"name": "defaultValue",
|
|
18771
|
+
"optional": true,
|
|
18700
18772
|
"type": {
|
|
18701
18773
|
"primitive": "string"
|
|
18702
18774
|
}
|
|
18703
18775
|
},
|
|
18704
18776
|
{
|
|
18705
|
-
"abstract": true,
|
|
18706
18777
|
"docs": {
|
|
18707
|
-
"
|
|
18708
|
-
"stability": "stable",
|
|
18709
|
-
"summary": "(Required )AWS params."
|
|
18778
|
+
"stability": "stable"
|
|
18710
18779
|
},
|
|
18711
18780
|
"immutable": true,
|
|
18712
18781
|
"locationInModule": {
|
|
18713
|
-
"filename": "src/
|
|
18714
|
-
"line":
|
|
18782
|
+
"filename": "src/domain/input.ts",
|
|
18783
|
+
"line": 116
|
|
18715
18784
|
},
|
|
18716
|
-
"name": "
|
|
18785
|
+
"name": "description",
|
|
18786
|
+
"optional": true,
|
|
18717
18787
|
"type": {
|
|
18718
|
-
"
|
|
18719
|
-
|
|
18788
|
+
"primitive": "string"
|
|
18789
|
+
}
|
|
18790
|
+
},
|
|
18791
|
+
{
|
|
18792
|
+
"docs": {
|
|
18793
|
+
"stability": "stable"
|
|
18794
|
+
},
|
|
18795
|
+
"immutable": true,
|
|
18796
|
+
"locationInModule": {
|
|
18797
|
+
"filename": "src/domain/input.ts",
|
|
18798
|
+
"line": 123
|
|
18799
|
+
},
|
|
18800
|
+
"name": "maxChars",
|
|
18801
|
+
"optional": true,
|
|
18802
|
+
"type": {
|
|
18803
|
+
"primitive": "number"
|
|
18804
|
+
}
|
|
18805
|
+
},
|
|
18806
|
+
{
|
|
18807
|
+
"docs": {
|
|
18808
|
+
"stability": "stable"
|
|
18809
|
+
},
|
|
18810
|
+
"immutable": true,
|
|
18811
|
+
"locationInModule": {
|
|
18812
|
+
"filename": "src/domain/input.ts",
|
|
18813
|
+
"line": 121
|
|
18814
|
+
},
|
|
18815
|
+
"name": "maxItems",
|
|
18816
|
+
"optional": true,
|
|
18817
|
+
"type": {
|
|
18818
|
+
"primitive": "number"
|
|
18819
|
+
}
|
|
18820
|
+
},
|
|
18821
|
+
{
|
|
18822
|
+
"docs": {
|
|
18823
|
+
"stability": "stable"
|
|
18824
|
+
},
|
|
18825
|
+
"immutable": true,
|
|
18826
|
+
"locationInModule": {
|
|
18827
|
+
"filename": "src/domain/input.ts",
|
|
18828
|
+
"line": 122
|
|
18829
|
+
},
|
|
18830
|
+
"name": "minChars",
|
|
18831
|
+
"optional": true,
|
|
18832
|
+
"type": {
|
|
18833
|
+
"primitive": "number"
|
|
18834
|
+
}
|
|
18835
|
+
},
|
|
18836
|
+
{
|
|
18837
|
+
"docs": {
|
|
18838
|
+
"stability": "stable"
|
|
18839
|
+
},
|
|
18840
|
+
"immutable": true,
|
|
18841
|
+
"locationInModule": {
|
|
18842
|
+
"filename": "src/domain/input.ts",
|
|
18843
|
+
"line": 120
|
|
18844
|
+
},
|
|
18845
|
+
"name": "minItems",
|
|
18846
|
+
"optional": true,
|
|
18847
|
+
"type": {
|
|
18848
|
+
"primitive": "number"
|
|
18849
|
+
}
|
|
18850
|
+
}
|
|
18851
|
+
],
|
|
18852
|
+
"symbolId": "src/domain/input:Input"
|
|
18853
|
+
},
|
|
18854
|
+
"@cdklabs/cdk-ssm-documents.InputProps": {
|
|
18855
|
+
"assembly": "@cdklabs/cdk-ssm-documents",
|
|
18856
|
+
"datatype": true,
|
|
18857
|
+
"docs": {
|
|
18858
|
+
"remarks": "These are NOT used for declaring step inputs, rather only for document inputs.\nSee https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-doc-syntax.html",
|
|
18859
|
+
"stability": "stable",
|
|
18860
|
+
"summary": "Properties of inputs supported by SSM documents."
|
|
18861
|
+
},
|
|
18862
|
+
"fqn": "@cdklabs/cdk-ssm-documents.InputProps",
|
|
18863
|
+
"kind": "interface",
|
|
18864
|
+
"locationInModule": {
|
|
18865
|
+
"filename": "src/domain/input.ts",
|
|
18866
|
+
"line": 8
|
|
18867
|
+
},
|
|
18868
|
+
"name": "InputProps",
|
|
18869
|
+
"properties": [
|
|
18870
|
+
{
|
|
18871
|
+
"abstract": true,
|
|
18872
|
+
"docs": {
|
|
18873
|
+
"stability": "stable",
|
|
18874
|
+
"summary": "(Required) The DataTypeEnum of the input."
|
|
18875
|
+
},
|
|
18876
|
+
"immutable": true,
|
|
18877
|
+
"locationInModule": {
|
|
18878
|
+
"filename": "src/domain/input.ts",
|
|
18879
|
+
"line": 18
|
|
18880
|
+
},
|
|
18881
|
+
"name": "inputType",
|
|
18882
|
+
"type": {
|
|
18883
|
+
"fqn": "@cdklabs/cdk-ssm-documents.DataTypeEnum"
|
|
18884
|
+
}
|
|
18885
|
+
},
|
|
18886
|
+
{
|
|
18887
|
+
"abstract": true,
|
|
18888
|
+
"docs": {
|
|
18889
|
+
"stability": "stable",
|
|
18890
|
+
"summary": "(Required) The name of the input by which to be referenced by steps in the document."
|
|
18891
|
+
},
|
|
18892
|
+
"immutable": true,
|
|
18893
|
+
"locationInModule": {
|
|
18894
|
+
"filename": "src/domain/input.ts",
|
|
18895
|
+
"line": 13
|
|
18896
|
+
},
|
|
18897
|
+
"name": "name",
|
|
18898
|
+
"type": {
|
|
18899
|
+
"primitive": "string"
|
|
18900
|
+
}
|
|
18901
|
+
},
|
|
18902
|
+
{
|
|
18903
|
+
"abstract": true,
|
|
18904
|
+
"docs": {
|
|
18905
|
+
"default": "undefined",
|
|
18906
|
+
"stability": "stable",
|
|
18907
|
+
"summary": "(Optional) Pattern that this input value must match."
|
|
18908
|
+
},
|
|
18909
|
+
"immutable": true,
|
|
18910
|
+
"locationInModule": {
|
|
18911
|
+
"filename": "src/domain/input.ts",
|
|
18912
|
+
"line": 42
|
|
18913
|
+
},
|
|
18914
|
+
"name": "allowedPattern",
|
|
18915
|
+
"optional": true,
|
|
18916
|
+
"type": {
|
|
18917
|
+
"primitive": "string"
|
|
18918
|
+
}
|
|
18919
|
+
},
|
|
18920
|
+
{
|
|
18921
|
+
"abstract": true,
|
|
18922
|
+
"docs": {
|
|
18923
|
+
"default": "undefined",
|
|
18924
|
+
"stability": "stable",
|
|
18925
|
+
"summary": "(Optional) List of allowed values that this input may be."
|
|
18926
|
+
},
|
|
18927
|
+
"immutable": true,
|
|
18928
|
+
"locationInModule": {
|
|
18929
|
+
"filename": "src/domain/input.ts",
|
|
18930
|
+
"line": 36
|
|
18931
|
+
},
|
|
18932
|
+
"name": "allowedValues",
|
|
18933
|
+
"optional": true,
|
|
18934
|
+
"type": {
|
|
18935
|
+
"collection": {
|
|
18936
|
+
"elementtype": {
|
|
18937
|
+
"primitive": "any"
|
|
18938
|
+
},
|
|
18939
|
+
"kind": "array"
|
|
18940
|
+
}
|
|
18941
|
+
}
|
|
18942
|
+
},
|
|
18943
|
+
{
|
|
18944
|
+
"abstract": true,
|
|
18945
|
+
"docs": {
|
|
18946
|
+
"default": "undefined",
|
|
18947
|
+
"stability": "stable",
|
|
18948
|
+
"summary": "(Optional) Default value to use for this input if not specified when invoking the document."
|
|
18949
|
+
},
|
|
18950
|
+
"immutable": true,
|
|
18951
|
+
"locationInModule": {
|
|
18952
|
+
"filename": "src/domain/input.ts",
|
|
18953
|
+
"line": 30
|
|
18954
|
+
},
|
|
18955
|
+
"name": "defaultValue",
|
|
18956
|
+
"optional": true,
|
|
18957
|
+
"type": {
|
|
18958
|
+
"primitive": "any"
|
|
18959
|
+
}
|
|
18960
|
+
},
|
|
18961
|
+
{
|
|
18962
|
+
"abstract": true,
|
|
18963
|
+
"docs": {
|
|
18964
|
+
"default": "name",
|
|
18965
|
+
"stability": "stable",
|
|
18966
|
+
"summary": "(Optional) The description of the input."
|
|
18967
|
+
},
|
|
18968
|
+
"immutable": true,
|
|
18969
|
+
"locationInModule": {
|
|
18970
|
+
"filename": "src/domain/input.ts",
|
|
18971
|
+
"line": 24
|
|
18972
|
+
},
|
|
18973
|
+
"name": "description",
|
|
18974
|
+
"optional": true,
|
|
18975
|
+
"type": {
|
|
18976
|
+
"primitive": "string"
|
|
18977
|
+
}
|
|
18978
|
+
},
|
|
18979
|
+
{
|
|
18980
|
+
"abstract": true,
|
|
18981
|
+
"docs": {
|
|
18982
|
+
"default": "undefined",
|
|
18983
|
+
"stability": "stable",
|
|
18984
|
+
"summary": "(Optional) Maximum number of chars that this input value (string) must contain."
|
|
18985
|
+
},
|
|
18986
|
+
"immutable": true,
|
|
18987
|
+
"locationInModule": {
|
|
18988
|
+
"filename": "src/domain/input.ts",
|
|
18989
|
+
"line": 66
|
|
18990
|
+
},
|
|
18991
|
+
"name": "maxChars",
|
|
18992
|
+
"optional": true,
|
|
18993
|
+
"type": {
|
|
18994
|
+
"primitive": "number"
|
|
18995
|
+
}
|
|
18996
|
+
},
|
|
18997
|
+
{
|
|
18998
|
+
"abstract": true,
|
|
18999
|
+
"docs": {
|
|
19000
|
+
"default": "undefined",
|
|
19001
|
+
"stability": "stable",
|
|
19002
|
+
"summary": "(Optional) Maximum number of items that this input value (list) must contain."
|
|
19003
|
+
},
|
|
19004
|
+
"immutable": true,
|
|
19005
|
+
"locationInModule": {
|
|
19006
|
+
"filename": "src/domain/input.ts",
|
|
19007
|
+
"line": 54
|
|
19008
|
+
},
|
|
19009
|
+
"name": "maxItems",
|
|
19010
|
+
"optional": true,
|
|
19011
|
+
"type": {
|
|
19012
|
+
"primitive": "number"
|
|
19013
|
+
}
|
|
19014
|
+
},
|
|
19015
|
+
{
|
|
19016
|
+
"abstract": true,
|
|
19017
|
+
"docs": {
|
|
19018
|
+
"default": "undefined",
|
|
19019
|
+
"stability": "stable",
|
|
19020
|
+
"summary": "(Optional) Minimum number of chars that this input value (string) must contain."
|
|
19021
|
+
},
|
|
19022
|
+
"immutable": true,
|
|
19023
|
+
"locationInModule": {
|
|
19024
|
+
"filename": "src/domain/input.ts",
|
|
19025
|
+
"line": 60
|
|
19026
|
+
},
|
|
19027
|
+
"name": "minChars",
|
|
19028
|
+
"optional": true,
|
|
19029
|
+
"type": {
|
|
19030
|
+
"primitive": "number"
|
|
19031
|
+
}
|
|
19032
|
+
},
|
|
19033
|
+
{
|
|
19034
|
+
"abstract": true,
|
|
19035
|
+
"docs": {
|
|
19036
|
+
"default": "undefined",
|
|
19037
|
+
"stability": "stable",
|
|
19038
|
+
"summary": "(Optional) Minimum number of items that this input value (list) must contain."
|
|
19039
|
+
},
|
|
19040
|
+
"immutable": true,
|
|
19041
|
+
"locationInModule": {
|
|
19042
|
+
"filename": "src/domain/input.ts",
|
|
19043
|
+
"line": 48
|
|
19044
|
+
},
|
|
19045
|
+
"name": "minItems",
|
|
19046
|
+
"optional": true,
|
|
19047
|
+
"type": {
|
|
19048
|
+
"primitive": "number"
|
|
19049
|
+
}
|
|
19050
|
+
}
|
|
19051
|
+
],
|
|
19052
|
+
"symbolId": "src/domain/input:InputProps"
|
|
19053
|
+
},
|
|
19054
|
+
"@cdklabs/cdk-ssm-documents.InstallUninstallRepairVariable": {
|
|
19055
|
+
"assembly": "@cdklabs/cdk-ssm-documents",
|
|
19056
|
+
"base": "@cdklabs/cdk-ssm-documents.StringVariable",
|
|
19057
|
+
"docs": {
|
|
19058
|
+
"stability": "stable"
|
|
19059
|
+
},
|
|
19060
|
+
"fqn": "@cdklabs/cdk-ssm-documents.InstallUninstallRepairVariable",
|
|
19061
|
+
"initializer": {
|
|
19062
|
+
"docs": {
|
|
19063
|
+
"stability": "stable"
|
|
19064
|
+
},
|
|
19065
|
+
"locationInModule": {
|
|
19066
|
+
"filename": "src/interface/variables/variable.ts",
|
|
19067
|
+
"line": 72
|
|
19068
|
+
},
|
|
19069
|
+
"parameters": [
|
|
19070
|
+
{
|
|
19071
|
+
"name": "reference",
|
|
19072
|
+
"type": {
|
|
19073
|
+
"primitive": "string"
|
|
19074
|
+
}
|
|
19075
|
+
}
|
|
19076
|
+
]
|
|
19077
|
+
},
|
|
19078
|
+
"interfaces": [
|
|
19079
|
+
"@cdklabs/cdk-ssm-documents.IInstallUninstallRepairVariable"
|
|
19080
|
+
],
|
|
19081
|
+
"kind": "class",
|
|
19082
|
+
"locationInModule": {
|
|
19083
|
+
"filename": "src/domain/enum/install-uninstall-repair.ts",
|
|
19084
|
+
"line": 15
|
|
19085
|
+
},
|
|
19086
|
+
"methods": [
|
|
19087
|
+
{
|
|
19088
|
+
"docs": {
|
|
19089
|
+
"stability": "stable"
|
|
19090
|
+
},
|
|
19091
|
+
"locationInModule": {
|
|
19092
|
+
"filename": "src/domain/enum/install-uninstall-repair.ts",
|
|
19093
|
+
"line": 18
|
|
19094
|
+
},
|
|
19095
|
+
"name": "assertType",
|
|
19096
|
+
"overrides": "@cdklabs/cdk-ssm-documents.StringVariable",
|
|
19097
|
+
"parameters": [
|
|
19098
|
+
{
|
|
19099
|
+
"name": "value",
|
|
19100
|
+
"type": {
|
|
19101
|
+
"primitive": "any"
|
|
19102
|
+
}
|
|
19103
|
+
}
|
|
19104
|
+
],
|
|
19105
|
+
"protected": true
|
|
19106
|
+
}
|
|
19107
|
+
],
|
|
19108
|
+
"name": "InstallUninstallRepairVariable",
|
|
19109
|
+
"properties": [
|
|
19110
|
+
{
|
|
19111
|
+
"docs": {
|
|
19112
|
+
"stability": "stable"
|
|
19113
|
+
},
|
|
19114
|
+
"immutable": true,
|
|
19115
|
+
"locationInModule": {
|
|
19116
|
+
"filename": "src/domain/enum/install-uninstall-repair.ts",
|
|
19117
|
+
"line": 16
|
|
19118
|
+
},
|
|
19119
|
+
"name": "validValues",
|
|
19120
|
+
"type": {
|
|
19121
|
+
"collection": {
|
|
19122
|
+
"elementtype": {
|
|
19123
|
+
"primitive": "string"
|
|
19124
|
+
},
|
|
19125
|
+
"kind": "array"
|
|
19126
|
+
}
|
|
19127
|
+
}
|
|
19128
|
+
}
|
|
19129
|
+
],
|
|
19130
|
+
"symbolId": "src/domain/enum/install-uninstall-repair:InstallUninstallRepairVariable"
|
|
19131
|
+
},
|
|
19132
|
+
"@cdklabs/cdk-ssm-documents.InstallationTypeVariable": {
|
|
19133
|
+
"assembly": "@cdklabs/cdk-ssm-documents",
|
|
19134
|
+
"base": "@cdklabs/cdk-ssm-documents.StringVariable",
|
|
19135
|
+
"docs": {
|
|
19136
|
+
"stability": "stable"
|
|
19137
|
+
},
|
|
19138
|
+
"fqn": "@cdklabs/cdk-ssm-documents.InstallationTypeVariable",
|
|
19139
|
+
"initializer": {
|
|
19140
|
+
"docs": {
|
|
19141
|
+
"stability": "stable"
|
|
19142
|
+
},
|
|
19143
|
+
"locationInModule": {
|
|
19144
|
+
"filename": "src/interface/variables/variable.ts",
|
|
19145
|
+
"line": 72
|
|
19146
|
+
},
|
|
19147
|
+
"parameters": [
|
|
19148
|
+
{
|
|
19149
|
+
"name": "reference",
|
|
19150
|
+
"type": {
|
|
19151
|
+
"primitive": "string"
|
|
19152
|
+
}
|
|
19153
|
+
}
|
|
19154
|
+
]
|
|
19155
|
+
},
|
|
19156
|
+
"interfaces": [
|
|
19157
|
+
"@cdklabs/cdk-ssm-documents.IInstallationTypeVariable"
|
|
19158
|
+
],
|
|
19159
|
+
"kind": "class",
|
|
19160
|
+
"locationInModule": {
|
|
19161
|
+
"filename": "src/domain/enum/installation-type.ts",
|
|
19162
|
+
"line": 14
|
|
19163
|
+
},
|
|
19164
|
+
"methods": [
|
|
19165
|
+
{
|
|
19166
|
+
"docs": {
|
|
19167
|
+
"stability": "stable"
|
|
19168
|
+
},
|
|
19169
|
+
"locationInModule": {
|
|
19170
|
+
"filename": "src/domain/enum/installation-type.ts",
|
|
19171
|
+
"line": 17
|
|
19172
|
+
},
|
|
19173
|
+
"name": "assertType",
|
|
19174
|
+
"overrides": "@cdklabs/cdk-ssm-documents.StringVariable",
|
|
19175
|
+
"parameters": [
|
|
19176
|
+
{
|
|
19177
|
+
"name": "value",
|
|
19178
|
+
"type": {
|
|
19179
|
+
"primitive": "any"
|
|
19180
|
+
}
|
|
19181
|
+
}
|
|
19182
|
+
],
|
|
19183
|
+
"protected": true
|
|
19184
|
+
}
|
|
19185
|
+
],
|
|
19186
|
+
"name": "InstallationTypeVariable",
|
|
19187
|
+
"properties": [
|
|
19188
|
+
{
|
|
19189
|
+
"docs": {
|
|
19190
|
+
"stability": "stable"
|
|
19191
|
+
},
|
|
19192
|
+
"immutable": true,
|
|
19193
|
+
"locationInModule": {
|
|
19194
|
+
"filename": "src/domain/enum/installation-type.ts",
|
|
19195
|
+
"line": 15
|
|
19196
|
+
},
|
|
19197
|
+
"name": "validValues",
|
|
19198
|
+
"type": {
|
|
19199
|
+
"collection": {
|
|
19200
|
+
"elementtype": {
|
|
19201
|
+
"primitive": "string"
|
|
19202
|
+
},
|
|
19203
|
+
"kind": "array"
|
|
19204
|
+
}
|
|
19205
|
+
}
|
|
19206
|
+
}
|
|
19207
|
+
],
|
|
19208
|
+
"symbolId": "src/domain/enum/installation-type:InstallationTypeVariable"
|
|
19209
|
+
},
|
|
19210
|
+
"@cdklabs/cdk-ssm-documents.IntegerInputProps": {
|
|
19211
|
+
"assembly": "@cdklabs/cdk-ssm-documents",
|
|
19212
|
+
"datatype": true,
|
|
19213
|
+
"docs": {
|
|
19214
|
+
"stability": "stable"
|
|
19215
|
+
},
|
|
19216
|
+
"fqn": "@cdklabs/cdk-ssm-documents.IntegerInputProps",
|
|
19217
|
+
"kind": "interface",
|
|
19218
|
+
"locationInModule": {
|
|
19219
|
+
"filename": "src/domain/input.ts",
|
|
19220
|
+
"line": 238
|
|
19221
|
+
},
|
|
19222
|
+
"name": "IntegerInputProps",
|
|
19223
|
+
"properties": [
|
|
19224
|
+
{
|
|
19225
|
+
"abstract": true,
|
|
19226
|
+
"docs": {
|
|
19227
|
+
"default": "undefined",
|
|
19228
|
+
"stability": "stable",
|
|
19229
|
+
"summary": "(Optional) List of allowed values that this input may be."
|
|
19230
|
+
},
|
|
19231
|
+
"immutable": true,
|
|
19232
|
+
"locationInModule": {
|
|
19233
|
+
"filename": "src/domain/input.ts",
|
|
19234
|
+
"line": 256
|
|
19235
|
+
},
|
|
19236
|
+
"name": "allowedValues",
|
|
19237
|
+
"optional": true,
|
|
19238
|
+
"type": {
|
|
19239
|
+
"collection": {
|
|
19240
|
+
"elementtype": {
|
|
19241
|
+
"primitive": "number"
|
|
19242
|
+
},
|
|
19243
|
+
"kind": "array"
|
|
19244
|
+
}
|
|
19245
|
+
}
|
|
19246
|
+
},
|
|
19247
|
+
{
|
|
19248
|
+
"abstract": true,
|
|
19249
|
+
"docs": {
|
|
19250
|
+
"default": "undefined",
|
|
19251
|
+
"stability": "stable",
|
|
19252
|
+
"summary": "(Optional) Default value to use for this input if not specified when invoking the document."
|
|
19253
|
+
},
|
|
19254
|
+
"immutable": true,
|
|
19255
|
+
"locationInModule": {
|
|
19256
|
+
"filename": "src/domain/input.ts",
|
|
19257
|
+
"line": 250
|
|
19258
|
+
},
|
|
19259
|
+
"name": "defaultValue",
|
|
19260
|
+
"optional": true,
|
|
19261
|
+
"type": {
|
|
19262
|
+
"primitive": "number"
|
|
19263
|
+
}
|
|
19264
|
+
},
|
|
19265
|
+
{
|
|
19266
|
+
"abstract": true,
|
|
19267
|
+
"docs": {
|
|
19268
|
+
"default": "name",
|
|
19269
|
+
"stability": "stable",
|
|
19270
|
+
"summary": "(Optional) The description of the input."
|
|
19271
|
+
},
|
|
19272
|
+
"immutable": true,
|
|
19273
|
+
"locationInModule": {
|
|
19274
|
+
"filename": "src/domain/input.ts",
|
|
19275
|
+
"line": 244
|
|
19276
|
+
},
|
|
19277
|
+
"name": "description",
|
|
19278
|
+
"optional": true,
|
|
19279
|
+
"type": {
|
|
19280
|
+
"primitive": "string"
|
|
19281
|
+
}
|
|
19282
|
+
}
|
|
19283
|
+
],
|
|
19284
|
+
"symbolId": "src/domain/input:IntegerInputProps"
|
|
19285
|
+
},
|
|
19286
|
+
"@cdklabs/cdk-ssm-documents.Invocation": {
|
|
19287
|
+
"assembly": "@cdklabs/cdk-ssm-documents",
|
|
19288
|
+
"datatype": true,
|
|
19289
|
+
"docs": {
|
|
19290
|
+
"stability": "stable"
|
|
19291
|
+
},
|
|
19292
|
+
"fqn": "@cdklabs/cdk-ssm-documents.Invocation",
|
|
19293
|
+
"kind": "interface",
|
|
19294
|
+
"locationInModule": {
|
|
19295
|
+
"filename": "src/interface/aws-invoker.ts",
|
|
19296
|
+
"line": 4
|
|
19297
|
+
},
|
|
19298
|
+
"name": "Invocation",
|
|
19299
|
+
"properties": [
|
|
19300
|
+
{
|
|
19301
|
+
"abstract": true,
|
|
19302
|
+
"docs": {
|
|
19303
|
+
"example": "describeInstance",
|
|
19304
|
+
"remarks": "should be referenced using lowerCamelCase.",
|
|
19305
|
+
"stability": "stable",
|
|
19306
|
+
"summary": "(Required) AWS api to invoke;"
|
|
19307
|
+
},
|
|
19308
|
+
"immutable": true,
|
|
19309
|
+
"locationInModule": {
|
|
19310
|
+
"filename": "src/interface/aws-invoker.ts",
|
|
19311
|
+
"line": 15
|
|
19312
|
+
},
|
|
19313
|
+
"name": "awsApi",
|
|
19314
|
+
"type": {
|
|
19315
|
+
"primitive": "string"
|
|
19316
|
+
}
|
|
19317
|
+
},
|
|
19318
|
+
{
|
|
19319
|
+
"abstract": true,
|
|
19320
|
+
"docs": {
|
|
19321
|
+
"example": "{ 'Filters': [{'Name': 'instance-id', 'Values': ['{{ InstanceId }}'] }] }",
|
|
19322
|
+
"stability": "stable",
|
|
19323
|
+
"summary": "(Required )AWS params."
|
|
19324
|
+
},
|
|
19325
|
+
"immutable": true,
|
|
19326
|
+
"locationInModule": {
|
|
19327
|
+
"filename": "src/interface/aws-invoker.ts",
|
|
19328
|
+
"line": 21
|
|
19329
|
+
},
|
|
19330
|
+
"name": "awsParams",
|
|
19331
|
+
"type": {
|
|
19332
|
+
"collection": {
|
|
19333
|
+
"elementtype": {
|
|
18720
19334
|
"primitive": "any"
|
|
18721
19335
|
},
|
|
18722
19336
|
"kind": "map"
|
|
@@ -19691,85 +20305,197 @@
|
|
|
19691
20305
|
"properties": [
|
|
19692
20306
|
{
|
|
19693
20307
|
"docs": {
|
|
19694
|
-
"stability": "stable"
|
|
20308
|
+
"stability": "stable"
|
|
20309
|
+
},
|
|
20310
|
+
"immutable": true,
|
|
20311
|
+
"locationInModule": {
|
|
20312
|
+
"filename": "src/interface/run-document-location.ts",
|
|
20313
|
+
"line": 10
|
|
20314
|
+
},
|
|
20315
|
+
"name": "location",
|
|
20316
|
+
"overrides": "@cdklabs/cdk-ssm-documents.IRunDocumentLocation",
|
|
20317
|
+
"type": {
|
|
20318
|
+
"fqn": "@cdklabs/cdk-ssm-documents.IStringVariable"
|
|
20319
|
+
}
|
|
20320
|
+
},
|
|
20321
|
+
{
|
|
20322
|
+
"docs": {
|
|
20323
|
+
"stability": "stable"
|
|
20324
|
+
},
|
|
20325
|
+
"immutable": true,
|
|
20326
|
+
"locationInModule": {
|
|
20327
|
+
"filename": "src/interface/run-document-location.ts",
|
|
20328
|
+
"line": 9
|
|
20329
|
+
},
|
|
20330
|
+
"name": "type",
|
|
20331
|
+
"overrides": "@cdklabs/cdk-ssm-documents.IRunDocumentLocation",
|
|
20332
|
+
"type": {
|
|
20333
|
+
"primitive": "string"
|
|
20334
|
+
}
|
|
20335
|
+
}
|
|
20336
|
+
],
|
|
20337
|
+
"symbolId": "src/interface/run-document-location:LocalRunDocument"
|
|
20338
|
+
},
|
|
20339
|
+
"@cdklabs/cdk-ssm-documents.LoggingEnvironment": {
|
|
20340
|
+
"assembly": "@cdklabs/cdk-ssm-documents",
|
|
20341
|
+
"docs": {
|
|
20342
|
+
"stability": "stable",
|
|
20343
|
+
"summary": "Environment that simply logs the commands that it receives and displays them on the console."
|
|
20344
|
+
},
|
|
20345
|
+
"fqn": "@cdklabs/cdk-ssm-documents.LoggingEnvironment",
|
|
20346
|
+
"initializer": {
|
|
20347
|
+
"docs": {
|
|
20348
|
+
"stability": "stable"
|
|
20349
|
+
}
|
|
20350
|
+
},
|
|
20351
|
+
"interfaces": [
|
|
20352
|
+
"@cdklabs/cdk-ssm-documents.IEnvironment"
|
|
20353
|
+
],
|
|
20354
|
+
"kind": "class",
|
|
20355
|
+
"locationInModule": {
|
|
20356
|
+
"filename": "src/interface/environment.ts",
|
|
20357
|
+
"line": 85
|
|
20358
|
+
},
|
|
20359
|
+
"methods": [
|
|
20360
|
+
{
|
|
20361
|
+
"docs": {
|
|
20362
|
+
"stability": "stable"
|
|
20363
|
+
},
|
|
20364
|
+
"locationInModule": {
|
|
20365
|
+
"filename": "src/interface/environment.ts",
|
|
20366
|
+
"line": 86
|
|
20367
|
+
},
|
|
20368
|
+
"name": "run",
|
|
20369
|
+
"overrides": "@cdklabs/cdk-ssm-documents.IEnvironment",
|
|
20370
|
+
"parameters": [
|
|
20371
|
+
{
|
|
20372
|
+
"name": "command",
|
|
20373
|
+
"type": {
|
|
20374
|
+
"primitive": "string"
|
|
20375
|
+
}
|
|
20376
|
+
}
|
|
20377
|
+
],
|
|
20378
|
+
"returns": {
|
|
20379
|
+
"type": {
|
|
20380
|
+
"primitive": "string"
|
|
20381
|
+
}
|
|
20382
|
+
}
|
|
20383
|
+
}
|
|
20384
|
+
],
|
|
20385
|
+
"name": "LoggingEnvironment",
|
|
20386
|
+
"symbolId": "src/interface/environment:LoggingEnvironment"
|
|
20387
|
+
},
|
|
20388
|
+
"@cdklabs/cdk-ssm-documents.MapListInputProps": {
|
|
20389
|
+
"assembly": "@cdklabs/cdk-ssm-documents",
|
|
20390
|
+
"datatype": true,
|
|
20391
|
+
"docs": {
|
|
20392
|
+
"stability": "stable"
|
|
20393
|
+
},
|
|
20394
|
+
"fqn": "@cdklabs/cdk-ssm-documents.MapListInputProps",
|
|
20395
|
+
"kind": "interface",
|
|
20396
|
+
"locationInModule": {
|
|
20397
|
+
"filename": "src/domain/input.ts",
|
|
20398
|
+
"line": 326
|
|
20399
|
+
},
|
|
20400
|
+
"name": "MapListInputProps",
|
|
20401
|
+
"properties": [
|
|
20402
|
+
{
|
|
20403
|
+
"abstract": true,
|
|
20404
|
+
"docs": {
|
|
20405
|
+
"default": "undefined",
|
|
20406
|
+
"stability": "stable",
|
|
20407
|
+
"summary": "(Optional) List of allowed values that this input may be."
|
|
20408
|
+
},
|
|
20409
|
+
"immutable": true,
|
|
20410
|
+
"locationInModule": {
|
|
20411
|
+
"filename": "src/domain/input.ts",
|
|
20412
|
+
"line": 344
|
|
20413
|
+
},
|
|
20414
|
+
"name": "allowedValues",
|
|
20415
|
+
"optional": true,
|
|
20416
|
+
"type": {
|
|
20417
|
+
"collection": {
|
|
20418
|
+
"elementtype": {
|
|
20419
|
+
"primitive": "any"
|
|
20420
|
+
},
|
|
20421
|
+
"kind": "array"
|
|
20422
|
+
}
|
|
20423
|
+
}
|
|
20424
|
+
},
|
|
20425
|
+
{
|
|
20426
|
+
"abstract": true,
|
|
20427
|
+
"docs": {
|
|
20428
|
+
"default": "undefined",
|
|
20429
|
+
"stability": "stable",
|
|
20430
|
+
"summary": "(Optional) Default value to use for this input if not specified when invoking the document."
|
|
19695
20431
|
},
|
|
19696
20432
|
"immutable": true,
|
|
19697
20433
|
"locationInModule": {
|
|
19698
|
-
"filename": "src/
|
|
19699
|
-
"line":
|
|
20434
|
+
"filename": "src/domain/input.ts",
|
|
20435
|
+
"line": 338
|
|
19700
20436
|
},
|
|
19701
|
-
"name": "
|
|
19702
|
-
"
|
|
20437
|
+
"name": "defaultValue",
|
|
20438
|
+
"optional": true,
|
|
19703
20439
|
"type": {
|
|
19704
|
-
"
|
|
20440
|
+
"primitive": "any"
|
|
19705
20441
|
}
|
|
19706
20442
|
},
|
|
19707
20443
|
{
|
|
20444
|
+
"abstract": true,
|
|
19708
20445
|
"docs": {
|
|
19709
|
-
"
|
|
20446
|
+
"default": "name",
|
|
20447
|
+
"stability": "stable",
|
|
20448
|
+
"summary": "(Optional) The description of the input."
|
|
19710
20449
|
},
|
|
19711
20450
|
"immutable": true,
|
|
19712
20451
|
"locationInModule": {
|
|
19713
|
-
"filename": "src/
|
|
19714
|
-
"line":
|
|
20452
|
+
"filename": "src/domain/input.ts",
|
|
20453
|
+
"line": 332
|
|
19715
20454
|
},
|
|
19716
|
-
"name": "
|
|
19717
|
-
"
|
|
20455
|
+
"name": "description",
|
|
20456
|
+
"optional": true,
|
|
19718
20457
|
"type": {
|
|
19719
20458
|
"primitive": "string"
|
|
19720
20459
|
}
|
|
19721
|
-
}
|
|
19722
|
-
],
|
|
19723
|
-
"symbolId": "src/interface/run-document-location:LocalRunDocument"
|
|
19724
|
-
},
|
|
19725
|
-
"@cdklabs/cdk-ssm-documents.LoggingEnvironment": {
|
|
19726
|
-
"assembly": "@cdklabs/cdk-ssm-documents",
|
|
19727
|
-
"docs": {
|
|
19728
|
-
"stability": "stable",
|
|
19729
|
-
"summary": "Environment that simply logs the commands that it receives and displays them on the console."
|
|
19730
|
-
},
|
|
19731
|
-
"fqn": "@cdklabs/cdk-ssm-documents.LoggingEnvironment",
|
|
19732
|
-
"initializer": {
|
|
19733
|
-
"docs": {
|
|
19734
|
-
"stability": "stable"
|
|
19735
|
-
}
|
|
19736
|
-
},
|
|
19737
|
-
"interfaces": [
|
|
19738
|
-
"@cdklabs/cdk-ssm-documents.IEnvironment"
|
|
19739
|
-
],
|
|
19740
|
-
"kind": "class",
|
|
19741
|
-
"locationInModule": {
|
|
19742
|
-
"filename": "src/interface/environment.ts",
|
|
19743
|
-
"line": 85
|
|
19744
|
-
},
|
|
19745
|
-
"methods": [
|
|
20460
|
+
},
|
|
19746
20461
|
{
|
|
20462
|
+
"abstract": true,
|
|
19747
20463
|
"docs": {
|
|
19748
|
-
"
|
|
20464
|
+
"default": "undefined",
|
|
20465
|
+
"stability": "stable",
|
|
20466
|
+
"summary": "(Optional) Maximum number of items that this input value (list) must contain."
|
|
19749
20467
|
},
|
|
20468
|
+
"immutable": true,
|
|
19750
20469
|
"locationInModule": {
|
|
19751
|
-
"filename": "src/
|
|
19752
|
-
"line":
|
|
20470
|
+
"filename": "src/domain/input.ts",
|
|
20471
|
+
"line": 356
|
|
19753
20472
|
},
|
|
19754
|
-
"name": "
|
|
19755
|
-
"
|
|
19756
|
-
"
|
|
19757
|
-
|
|
19758
|
-
|
|
19759
|
-
|
|
19760
|
-
|
|
19761
|
-
|
|
19762
|
-
|
|
19763
|
-
|
|
19764
|
-
|
|
19765
|
-
"
|
|
19766
|
-
|
|
19767
|
-
|
|
20473
|
+
"name": "maxItems",
|
|
20474
|
+
"optional": true,
|
|
20475
|
+
"type": {
|
|
20476
|
+
"primitive": "number"
|
|
20477
|
+
}
|
|
20478
|
+
},
|
|
20479
|
+
{
|
|
20480
|
+
"abstract": true,
|
|
20481
|
+
"docs": {
|
|
20482
|
+
"default": "undefined",
|
|
20483
|
+
"stability": "stable",
|
|
20484
|
+
"summary": "(Optional) Minimum number of items that this input value (list) must contain."
|
|
20485
|
+
},
|
|
20486
|
+
"immutable": true,
|
|
20487
|
+
"locationInModule": {
|
|
20488
|
+
"filename": "src/domain/input.ts",
|
|
20489
|
+
"line": 350
|
|
20490
|
+
},
|
|
20491
|
+
"name": "minItems",
|
|
20492
|
+
"optional": true,
|
|
20493
|
+
"type": {
|
|
20494
|
+
"primitive": "number"
|
|
19768
20495
|
}
|
|
19769
20496
|
}
|
|
19770
20497
|
],
|
|
19771
|
-
"
|
|
19772
|
-
"symbolId": "src/interface/environment:LoggingEnvironment"
|
|
20498
|
+
"symbolId": "src/domain/input:MapListInputProps"
|
|
19773
20499
|
},
|
|
19774
20500
|
"@cdklabs/cdk-ssm-documents.MapListVariable": {
|
|
19775
20501
|
"assembly": "@cdklabs/cdk-ssm-documents",
|
|
@@ -20493,7 +21219,7 @@
|
|
|
20493
21219
|
"methods": [
|
|
20494
21220
|
{
|
|
20495
21221
|
"docs": {
|
|
20496
|
-
"remarks": "This is typically in the form of {{Variable}} or the value.",
|
|
21222
|
+
"remarks": "This is typically in the form of {{ Variable }} or the value.",
|
|
20497
21223
|
"stability": "stable",
|
|
20498
21224
|
"summary": "Prints the variable in a way that SSM understands."
|
|
20499
21225
|
},
|
|
@@ -22805,7 +23531,7 @@
|
|
|
22805
23531
|
{
|
|
22806
23532
|
"abstract": true,
|
|
22807
23533
|
"docs": {
|
|
22808
|
-
"remarks": "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).\n\nAnother 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).",
|
|
23534
|
+
"remarks": "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).\n\nAnother 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).",
|
|
22809
23535
|
"stability": "stable",
|
|
22810
23536
|
"summary": "The instance IDs where you want the command to run. You can specify a maximum of 50 IDs."
|
|
22811
23537
|
},
|
|
@@ -23560,7 +24286,7 @@
|
|
|
23560
24286
|
{
|
|
23561
24287
|
"abstract": true,
|
|
23562
24288
|
"docs": {
|
|
23563
|
-
"remarks": "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).\n\nAnother 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).",
|
|
24289
|
+
"remarks": "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).\n\nAnother 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).",
|
|
23564
24290
|
"stability": "stable",
|
|
23565
24291
|
"summary": "The instance IDs where you want the command to run. You can specify a maximum of 50 IDs."
|
|
23566
24292
|
},
|
|
@@ -26482,7 +27208,7 @@
|
|
|
26482
27208
|
{
|
|
26483
27209
|
"abstract": true,
|
|
26484
27210
|
"docs": {
|
|
26485
|
-
"remarks": "This is typically in the form of {{Variable}} or the value.",
|
|
27211
|
+
"remarks": "This is typically in the form of {{ Variable }} or the value.",
|
|
26486
27212
|
"stability": "stable",
|
|
26487
27213
|
"summary": "Prints the variable in a way that SSM understands."
|
|
26488
27214
|
},
|
|
@@ -26688,7 +27414,7 @@
|
|
|
26688
27414
|
},
|
|
26689
27415
|
"locationInModule": {
|
|
26690
27416
|
"filename": "src/simulation/simulation.ts",
|
|
26691
|
-
"line":
|
|
27417
|
+
"line": 194
|
|
26692
27418
|
},
|
|
26693
27419
|
"name": "start",
|
|
26694
27420
|
"parameters": [
|
|
@@ -27505,27 +28231,200 @@
|
|
|
27505
28231
|
"immutable": true,
|
|
27506
28232
|
"locationInModule": {
|
|
27507
28233
|
"filename": "src/parent-steps/command/software-inventory-step.ts",
|
|
27508
|
-
"line": 87
|
|
28234
|
+
"line": 87
|
|
28235
|
+
},
|
|
28236
|
+
"name": "platforms",
|
|
28237
|
+
"overrides": "@cdklabs/cdk-ssm-documents.CommandStep",
|
|
28238
|
+
"type": {
|
|
28239
|
+
"collection": {
|
|
28240
|
+
"elementtype": {
|
|
28241
|
+
"fqn": "@cdklabs/cdk-ssm-documents.Platform"
|
|
28242
|
+
},
|
|
28243
|
+
"kind": "array"
|
|
28244
|
+
}
|
|
28245
|
+
}
|
|
28246
|
+
},
|
|
28247
|
+
{
|
|
28248
|
+
"docs": {
|
|
28249
|
+
"stability": "stable"
|
|
28250
|
+
},
|
|
28251
|
+
"immutable": true,
|
|
28252
|
+
"locationInModule": {
|
|
28253
|
+
"filename": "src/parent-steps/command/software-inventory-step.ts",
|
|
28254
|
+
"line": 76
|
|
28255
|
+
},
|
|
28256
|
+
"name": "applications",
|
|
28257
|
+
"optional": true,
|
|
28258
|
+
"type": {
|
|
28259
|
+
"fqn": "@cdklabs/cdk-ssm-documents.IStringVariable"
|
|
28260
|
+
}
|
|
28261
|
+
},
|
|
28262
|
+
{
|
|
28263
|
+
"docs": {
|
|
28264
|
+
"stability": "stable"
|
|
28265
|
+
},
|
|
28266
|
+
"immutable": true,
|
|
28267
|
+
"locationInModule": {
|
|
28268
|
+
"filename": "src/parent-steps/command/software-inventory-step.ts",
|
|
28269
|
+
"line": 77
|
|
28270
|
+
},
|
|
28271
|
+
"name": "awsComponents",
|
|
28272
|
+
"optional": true,
|
|
28273
|
+
"type": {
|
|
28274
|
+
"fqn": "@cdklabs/cdk-ssm-documents.IStringVariable"
|
|
28275
|
+
}
|
|
28276
|
+
},
|
|
28277
|
+
{
|
|
28278
|
+
"docs": {
|
|
28279
|
+
"stability": "stable"
|
|
28280
|
+
},
|
|
28281
|
+
"immutable": true,
|
|
28282
|
+
"locationInModule": {
|
|
28283
|
+
"filename": "src/parent-steps/command/software-inventory-step.ts",
|
|
28284
|
+
"line": 85
|
|
28285
|
+
},
|
|
28286
|
+
"name": "customInventory",
|
|
28287
|
+
"optional": true,
|
|
28288
|
+
"type": {
|
|
28289
|
+
"fqn": "@cdklabs/cdk-ssm-documents.IStringVariable"
|
|
28290
|
+
}
|
|
28291
|
+
},
|
|
28292
|
+
{
|
|
28293
|
+
"docs": {
|
|
28294
|
+
"stability": "stable"
|
|
28295
|
+
},
|
|
28296
|
+
"immutable": true,
|
|
28297
|
+
"locationInModule": {
|
|
28298
|
+
"filename": "src/parent-steps/command/software-inventory-step.ts",
|
|
28299
|
+
"line": 78
|
|
28300
|
+
},
|
|
28301
|
+
"name": "files",
|
|
28302
|
+
"optional": true,
|
|
28303
|
+
"type": {
|
|
28304
|
+
"fqn": "@cdklabs/cdk-ssm-documents.IStringVariable"
|
|
28305
|
+
}
|
|
28306
|
+
},
|
|
28307
|
+
{
|
|
28308
|
+
"docs": {
|
|
28309
|
+
"stability": "stable"
|
|
28310
|
+
},
|
|
28311
|
+
"immutable": true,
|
|
28312
|
+
"locationInModule": {
|
|
28313
|
+
"filename": "src/parent-steps/command/software-inventory-step.ts",
|
|
28314
|
+
"line": 81
|
|
28315
|
+
},
|
|
28316
|
+
"name": "instanceDetailedInformation",
|
|
28317
|
+
"optional": true,
|
|
28318
|
+
"type": {
|
|
28319
|
+
"fqn": "@cdklabs/cdk-ssm-documents.IStringVariable"
|
|
28320
|
+
}
|
|
28321
|
+
},
|
|
28322
|
+
{
|
|
28323
|
+
"docs": {
|
|
28324
|
+
"stability": "stable"
|
|
28325
|
+
},
|
|
28326
|
+
"immutable": true,
|
|
28327
|
+
"locationInModule": {
|
|
28328
|
+
"filename": "src/parent-steps/command/software-inventory-step.ts",
|
|
28329
|
+
"line": 79
|
|
28330
|
+
},
|
|
28331
|
+
"name": "networkConfig",
|
|
28332
|
+
"optional": true,
|
|
28333
|
+
"type": {
|
|
28334
|
+
"fqn": "@cdklabs/cdk-ssm-documents.IStringVariable"
|
|
28335
|
+
}
|
|
28336
|
+
},
|
|
28337
|
+
{
|
|
28338
|
+
"docs": {
|
|
28339
|
+
"stability": "stable"
|
|
28340
|
+
},
|
|
28341
|
+
"immutable": true,
|
|
28342
|
+
"locationInModule": {
|
|
28343
|
+
"filename": "src/parent-steps/command/software-inventory-step.ts",
|
|
28344
|
+
"line": 82
|
|
28345
|
+
},
|
|
28346
|
+
"name": "services",
|
|
28347
|
+
"optional": true,
|
|
28348
|
+
"type": {
|
|
28349
|
+
"fqn": "@cdklabs/cdk-ssm-documents.IStringVariable"
|
|
28350
|
+
}
|
|
28351
|
+
},
|
|
28352
|
+
{
|
|
28353
|
+
"docs": {
|
|
28354
|
+
"stability": "stable"
|
|
28355
|
+
},
|
|
28356
|
+
"immutable": true,
|
|
28357
|
+
"locationInModule": {
|
|
28358
|
+
"filename": "src/parent-steps/command/software-inventory-step.ts",
|
|
28359
|
+
"line": 83
|
|
28360
|
+
},
|
|
28361
|
+
"name": "windowsRegistry",
|
|
28362
|
+
"optional": true,
|
|
28363
|
+
"type": {
|
|
28364
|
+
"fqn": "@cdklabs/cdk-ssm-documents.IStringVariable"
|
|
28365
|
+
}
|
|
28366
|
+
},
|
|
28367
|
+
{
|
|
28368
|
+
"docs": {
|
|
28369
|
+
"stability": "stable"
|
|
28370
|
+
},
|
|
28371
|
+
"immutable": true,
|
|
28372
|
+
"locationInModule": {
|
|
28373
|
+
"filename": "src/parent-steps/command/software-inventory-step.ts",
|
|
28374
|
+
"line": 84
|
|
28375
|
+
},
|
|
28376
|
+
"name": "windowsRoles",
|
|
28377
|
+
"optional": true,
|
|
28378
|
+
"type": {
|
|
28379
|
+
"fqn": "@cdklabs/cdk-ssm-documents.IStringVariable"
|
|
28380
|
+
}
|
|
28381
|
+
},
|
|
28382
|
+
{
|
|
28383
|
+
"docs": {
|
|
28384
|
+
"stability": "stable"
|
|
28385
|
+
},
|
|
28386
|
+
"immutable": true,
|
|
28387
|
+
"locationInModule": {
|
|
28388
|
+
"filename": "src/parent-steps/command/software-inventory-step.ts",
|
|
28389
|
+
"line": 80
|
|
27509
28390
|
},
|
|
27510
|
-
"name": "
|
|
27511
|
-
"
|
|
28391
|
+
"name": "windowsUpdates",
|
|
28392
|
+
"optional": true,
|
|
27512
28393
|
"type": {
|
|
27513
|
-
"
|
|
27514
|
-
"elementtype": {
|
|
27515
|
-
"fqn": "@cdklabs/cdk-ssm-documents.Platform"
|
|
27516
|
-
},
|
|
27517
|
-
"kind": "array"
|
|
27518
|
-
}
|
|
28394
|
+
"fqn": "@cdklabs/cdk-ssm-documents.IStringVariable"
|
|
27519
28395
|
}
|
|
27520
|
-
}
|
|
28396
|
+
}
|
|
28397
|
+
],
|
|
28398
|
+
"symbolId": "src/parent-steps/command/software-inventory-step:SoftwareInventoryStep"
|
|
28399
|
+
},
|
|
28400
|
+
"@cdklabs/cdk-ssm-documents.SoftwareInventoryStepProps": {
|
|
28401
|
+
"assembly": "@cdklabs/cdk-ssm-documents",
|
|
28402
|
+
"datatype": true,
|
|
28403
|
+
"docs": {
|
|
28404
|
+
"stability": "stable",
|
|
28405
|
+
"summary": "Properties of SoftwareInventory step."
|
|
28406
|
+
},
|
|
28407
|
+
"fqn": "@cdklabs/cdk-ssm-documents.SoftwareInventoryStepProps",
|
|
28408
|
+
"interfaces": [
|
|
28409
|
+
"@cdklabs/cdk-ssm-documents.CommandStepProps"
|
|
28410
|
+
],
|
|
28411
|
+
"kind": "interface",
|
|
28412
|
+
"locationInModule": {
|
|
28413
|
+
"filename": "src/parent-steps/command/software-inventory-step.ts",
|
|
28414
|
+
"line": 9
|
|
28415
|
+
},
|
|
28416
|
+
"name": "SoftwareInventoryStepProps",
|
|
28417
|
+
"properties": [
|
|
27521
28418
|
{
|
|
28419
|
+
"abstract": true,
|
|
27522
28420
|
"docs": {
|
|
27523
|
-
"stability": "stable"
|
|
28421
|
+
"stability": "stable",
|
|
28422
|
+
"summary": "(Optional) Collect metadata for installed applications."
|
|
27524
28423
|
},
|
|
27525
28424
|
"immutable": true,
|
|
27526
28425
|
"locationInModule": {
|
|
27527
28426
|
"filename": "src/parent-steps/command/software-inventory-step.ts",
|
|
27528
|
-
"line":
|
|
28427
|
+
"line": 14
|
|
27529
28428
|
},
|
|
27530
28429
|
"name": "applications",
|
|
27531
28430
|
"optional": true,
|
|
@@ -27534,13 +28433,15 @@
|
|
|
27534
28433
|
}
|
|
27535
28434
|
},
|
|
27536
28435
|
{
|
|
28436
|
+
"abstract": true,
|
|
27537
28437
|
"docs": {
|
|
27538
|
-
"stability": "stable"
|
|
28438
|
+
"stability": "stable",
|
|
28439
|
+
"summary": "(Optional) Collect metadata for AWS components like amazon-ssm-agent."
|
|
27539
28440
|
},
|
|
27540
28441
|
"immutable": true,
|
|
27541
28442
|
"locationInModule": {
|
|
27542
28443
|
"filename": "src/parent-steps/command/software-inventory-step.ts",
|
|
27543
|
-
"line":
|
|
28444
|
+
"line": 19
|
|
27544
28445
|
},
|
|
27545
28446
|
"name": "awsComponents",
|
|
27546
28447
|
"optional": true,
|
|
@@ -27549,13 +28450,16 @@
|
|
|
27549
28450
|
}
|
|
27550
28451
|
},
|
|
27551
28452
|
{
|
|
28453
|
+
"abstract": true,
|
|
27552
28454
|
"docs": {
|
|
27553
|
-
"
|
|
28455
|
+
"remarks": "For more information about custom inventory, see Working with custom inventory",
|
|
28456
|
+
"stability": "stable",
|
|
28457
|
+
"summary": "(Optional) Collect custom inventory data."
|
|
27554
28458
|
},
|
|
27555
28459
|
"immutable": true,
|
|
27556
28460
|
"locationInModule": {
|
|
27557
28461
|
"filename": "src/parent-steps/command/software-inventory-step.ts",
|
|
27558
|
-
"line":
|
|
28462
|
+
"line": 66
|
|
27559
28463
|
},
|
|
27560
28464
|
"name": "customInventory",
|
|
27561
28465
|
"optional": true,
|
|
@@ -27564,13 +28468,15 @@
|
|
|
27564
28468
|
}
|
|
27565
28469
|
},
|
|
27566
28470
|
{
|
|
28471
|
+
"abstract": true,
|
|
27567
28472
|
"docs": {
|
|
27568
|
-
"stability": "stable"
|
|
28473
|
+
"stability": "stable",
|
|
28474
|
+
"summary": "(Optional, requires SSM Agent version 2.2.64.0 or later) Collect metadata for files, including file names, the time files were created, the time files were last modified and accessed, and file sizes, to name a few. For more information about collecting file inventory, see Working with file and Windows registry."
|
|
27569
28475
|
},
|
|
27570
28476
|
"immutable": true,
|
|
27571
28477
|
"locationInModule": {
|
|
27572
28478
|
"filename": "src/parent-steps/command/software-inventory-step.ts",
|
|
27573
|
-
"line":
|
|
28479
|
+
"line": 26
|
|
27574
28480
|
},
|
|
27575
28481
|
"name": "files",
|
|
27576
28482
|
"optional": true,
|
|
@@ -27579,13 +28485,15 @@
|
|
|
27579
28485
|
}
|
|
27580
28486
|
},
|
|
27581
28487
|
{
|
|
28488
|
+
"abstract": true,
|
|
27582
28489
|
"docs": {
|
|
27583
|
-
"stability": "stable"
|
|
28490
|
+
"stability": "stable",
|
|
28491
|
+
"summary": "(Optional) Collect more instance information than is provided by the default inventory plugin (aws:instanceInformation), including CPU model, speed, and the number of cores, to name a few."
|
|
27584
28492
|
},
|
|
27585
28493
|
"immutable": true,
|
|
27586
28494
|
"locationInModule": {
|
|
27587
28495
|
"filename": "src/parent-steps/command/software-inventory-step.ts",
|
|
27588
|
-
"line":
|
|
28496
|
+
"line": 42
|
|
27589
28497
|
},
|
|
27590
28498
|
"name": "instanceDetailedInformation",
|
|
27591
28499
|
"optional": true,
|
|
@@ -27594,13 +28502,15 @@
|
|
|
27594
28502
|
}
|
|
27595
28503
|
},
|
|
27596
28504
|
{
|
|
28505
|
+
"abstract": true,
|
|
27597
28506
|
"docs": {
|
|
27598
|
-
"stability": "stable"
|
|
28507
|
+
"stability": "stable",
|
|
28508
|
+
"summary": "(Optional) Collect metadata for network configurations."
|
|
27599
28509
|
},
|
|
27600
28510
|
"immutable": true,
|
|
27601
28511
|
"locationInModule": {
|
|
27602
28512
|
"filename": "src/parent-steps/command/software-inventory-step.ts",
|
|
27603
|
-
"line":
|
|
28513
|
+
"line": 31
|
|
27604
28514
|
},
|
|
27605
28515
|
"name": "networkConfig",
|
|
27606
28516
|
"optional": true,
|
|
@@ -27609,13 +28519,15 @@
|
|
|
27609
28519
|
}
|
|
27610
28520
|
},
|
|
27611
28521
|
{
|
|
28522
|
+
"abstract": true,
|
|
27612
28523
|
"docs": {
|
|
27613
|
-
"stability": "stable"
|
|
28524
|
+
"stability": "stable",
|
|
28525
|
+
"summary": "(Optional, Windows OS only, requires SSM Agent version 2.2.64.0 or later) Collect metadata for service configurations."
|
|
27614
28526
|
},
|
|
27615
28527
|
"immutable": true,
|
|
27616
28528
|
"locationInModule": {
|
|
27617
28529
|
"filename": "src/parent-steps/command/software-inventory-step.ts",
|
|
27618
|
-
"line":
|
|
28530
|
+
"line": 47
|
|
27619
28531
|
},
|
|
27620
28532
|
"name": "services",
|
|
27621
28533
|
"optional": true,
|
|
@@ -27624,13 +28536,15 @@
|
|
|
27624
28536
|
}
|
|
27625
28537
|
},
|
|
27626
28538
|
{
|
|
28539
|
+
"abstract": true,
|
|
27627
28540
|
"docs": {
|
|
27628
|
-
"stability": "stable"
|
|
28541
|
+
"stability": "stable",
|
|
28542
|
+
"summary": "(Optional, Windows OS only, requires SSM Agent version 2.2.64.0 or later) Collect Windows Registry keys and values. You can choose a key path and collect all keys and values recursively. You can also collect a specific registry key and its value for a specific path. Inventory collects the key path, name, type, and the value. For more information about collecting Windows Registry inventory, see Working with file and Windows registry inventory."
|
|
27629
28543
|
},
|
|
27630
28544
|
"immutable": true,
|
|
27631
28545
|
"locationInModule": {
|
|
27632
28546
|
"filename": "src/parent-steps/command/software-inventory-step.ts",
|
|
27633
|
-
"line":
|
|
28547
|
+
"line": 56
|
|
27634
28548
|
},
|
|
27635
28549
|
"name": "windowsRegistry",
|
|
27636
28550
|
"optional": true,
|
|
@@ -27639,13 +28553,15 @@
|
|
|
27639
28553
|
}
|
|
27640
28554
|
},
|
|
27641
28555
|
{
|
|
28556
|
+
"abstract": true,
|
|
27642
28557
|
"docs": {
|
|
27643
|
-
"stability": "stable"
|
|
28558
|
+
"stability": "stable",
|
|
28559
|
+
"summary": "(Optional, Windows OS only, requires SSM Agent version 2.2.64.0 or later) Collect metadata for Microsoft Windows role configurations."
|
|
27644
28560
|
},
|
|
27645
28561
|
"immutable": true,
|
|
27646
28562
|
"locationInModule": {
|
|
27647
28563
|
"filename": "src/parent-steps/command/software-inventory-step.ts",
|
|
27648
|
-
"line":
|
|
28564
|
+
"line": 61
|
|
27649
28565
|
},
|
|
27650
28566
|
"name": "windowsRoles",
|
|
27651
28567
|
"optional": true,
|
|
@@ -27654,13 +28570,15 @@
|
|
|
27654
28570
|
}
|
|
27655
28571
|
},
|
|
27656
28572
|
{
|
|
28573
|
+
"abstract": true,
|
|
27657
28574
|
"docs": {
|
|
27658
|
-
"stability": "stable"
|
|
28575
|
+
"stability": "stable",
|
|
28576
|
+
"summary": "(Optional) Collect metadata for all Windows updates."
|
|
27659
28577
|
},
|
|
27660
28578
|
"immutable": true,
|
|
27661
28579
|
"locationInModule": {
|
|
27662
28580
|
"filename": "src/parent-steps/command/software-inventory-step.ts",
|
|
27663
|
-
"line":
|
|
28581
|
+
"line": 36
|
|
27664
28582
|
},
|
|
27665
28583
|
"name": "windowsUpdates",
|
|
27666
28584
|
"optional": true,
|
|
@@ -27669,376 +28587,594 @@
|
|
|
27669
28587
|
}
|
|
27670
28588
|
}
|
|
27671
28589
|
],
|
|
27672
|
-
"symbolId": "src/parent-steps/command/software-inventory-step:
|
|
28590
|
+
"symbolId": "src/parent-steps/command/software-inventory-step:SoftwareInventoryStepProps"
|
|
27673
28591
|
},
|
|
27674
|
-
"@cdklabs/cdk-ssm-documents.
|
|
28592
|
+
"@cdklabs/cdk-ssm-documents.SsmDocument": {
|
|
28593
|
+
"abstract": true,
|
|
27675
28594
|
"assembly": "@cdklabs/cdk-ssm-documents",
|
|
27676
|
-
"
|
|
28595
|
+
"base": "constructs.Construct",
|
|
27677
28596
|
"docs": {
|
|
27678
|
-
"stability": "stable"
|
|
27679
|
-
"summary": "Properties of SoftwareInventory step."
|
|
28597
|
+
"stability": "stable"
|
|
27680
28598
|
},
|
|
27681
|
-
"fqn": "@cdklabs/cdk-ssm-documents.
|
|
27682
|
-
"
|
|
27683
|
-
"
|
|
27684
|
-
|
|
27685
|
-
|
|
28599
|
+
"fqn": "@cdklabs/cdk-ssm-documents.SsmDocument",
|
|
28600
|
+
"initializer": {
|
|
28601
|
+
"docs": {
|
|
28602
|
+
"stability": "stable"
|
|
28603
|
+
},
|
|
28604
|
+
"locationInModule": {
|
|
28605
|
+
"filename": "src/document/ssm-document.ts",
|
|
28606
|
+
"line": 91
|
|
28607
|
+
},
|
|
28608
|
+
"parameters": [
|
|
28609
|
+
{
|
|
28610
|
+
"name": "scope",
|
|
28611
|
+
"type": {
|
|
28612
|
+
"fqn": "constructs.Construct"
|
|
28613
|
+
}
|
|
28614
|
+
},
|
|
28615
|
+
{
|
|
28616
|
+
"name": "id",
|
|
28617
|
+
"type": {
|
|
28618
|
+
"primitive": "string"
|
|
28619
|
+
}
|
|
28620
|
+
},
|
|
28621
|
+
{
|
|
28622
|
+
"name": "props",
|
|
28623
|
+
"type": {
|
|
28624
|
+
"fqn": "@cdklabs/cdk-ssm-documents.SsmDocumentProps"
|
|
28625
|
+
}
|
|
28626
|
+
}
|
|
28627
|
+
]
|
|
28628
|
+
},
|
|
28629
|
+
"kind": "class",
|
|
27686
28630
|
"locationInModule": {
|
|
27687
|
-
"filename": "src/
|
|
27688
|
-
"line":
|
|
28631
|
+
"filename": "src/document/ssm-document.ts",
|
|
28632
|
+
"line": 81
|
|
27689
28633
|
},
|
|
27690
|
-
"
|
|
28634
|
+
"methods": [
|
|
28635
|
+
{
|
|
28636
|
+
"abstract": true,
|
|
28637
|
+
"docs": {
|
|
28638
|
+
"stability": "stable",
|
|
28639
|
+
"summary": "Delegates building the SSM Document to be converted to a yaml/json to the subclass (Automation etc)."
|
|
28640
|
+
},
|
|
28641
|
+
"locationInModule": {
|
|
28642
|
+
"filename": "src/document/ssm-document.ts",
|
|
28643
|
+
"line": 138
|
|
28644
|
+
},
|
|
28645
|
+
"name": "buildSsmDocument",
|
|
28646
|
+
"protected": true,
|
|
28647
|
+
"returns": {
|
|
28648
|
+
"type": {
|
|
28649
|
+
"collection": {
|
|
28650
|
+
"elementtype": {
|
|
28651
|
+
"primitive": "any"
|
|
28652
|
+
},
|
|
28653
|
+
"kind": "map"
|
|
28654
|
+
}
|
|
28655
|
+
}
|
|
28656
|
+
}
|
|
28657
|
+
},
|
|
28658
|
+
{
|
|
28659
|
+
"abstract": true,
|
|
28660
|
+
"docs": {
|
|
28661
|
+
"stability": "stable"
|
|
28662
|
+
},
|
|
28663
|
+
"locationInModule": {
|
|
28664
|
+
"filename": "src/document/ssm-document.ts",
|
|
28665
|
+
"line": 133
|
|
28666
|
+
},
|
|
28667
|
+
"name": "documentType",
|
|
28668
|
+
"returns": {
|
|
28669
|
+
"type": {
|
|
28670
|
+
"primitive": "string"
|
|
28671
|
+
}
|
|
28672
|
+
}
|
|
28673
|
+
},
|
|
28674
|
+
{
|
|
28675
|
+
"docs": {
|
|
28676
|
+
"remarks": "This function builds an object containing the relevant (declared) input parameters.\nThe return object will be used to build the yaml/json representation of the document.",
|
|
28677
|
+
"stability": "stable",
|
|
28678
|
+
"summary": "The SSM Document inputs optionally specify a number of parameters including allowedValues, minItems etc."
|
|
28679
|
+
},
|
|
28680
|
+
"locationInModule": {
|
|
28681
|
+
"filename": "src/document/ssm-document.ts",
|
|
28682
|
+
"line": 125
|
|
28683
|
+
},
|
|
28684
|
+
"name": "formatInputs",
|
|
28685
|
+
"protected": true,
|
|
28686
|
+
"returns": {
|
|
28687
|
+
"type": {
|
|
28688
|
+
"collection": {
|
|
28689
|
+
"elementtype": {
|
|
28690
|
+
"primitive": "any"
|
|
28691
|
+
},
|
|
28692
|
+
"kind": "map"
|
|
28693
|
+
}
|
|
28694
|
+
}
|
|
28695
|
+
}
|
|
28696
|
+
},
|
|
28697
|
+
{
|
|
28698
|
+
"docs": {
|
|
28699
|
+
"remarks": "Converts the objects define in the SSM Document (including all of the steps) to an SSM document string.\nThe format is dependency on the documentFormat property provided to the class.\nThe yaml can be used as is and will behave (or at least should behave) as was simulated in the runSimulation().",
|
|
28700
|
+
"returns": "a string representation of this document as an SSM formatted yaml/json.",
|
|
28701
|
+
"stability": "stable",
|
|
28702
|
+
"summary": "Synthesize before calling this function! You can use this to Synthesize: cdk.SynthUtils.synthesize(stack);"
|
|
28703
|
+
},
|
|
28704
|
+
"locationInModule": {
|
|
28705
|
+
"filename": "src/document/ssm-document.ts",
|
|
28706
|
+
"line": 149
|
|
28707
|
+
},
|
|
28708
|
+
"name": "print",
|
|
28709
|
+
"returns": {
|
|
28710
|
+
"type": {
|
|
28711
|
+
"primitive": "string"
|
|
28712
|
+
}
|
|
28713
|
+
}
|
|
28714
|
+
}
|
|
28715
|
+
],
|
|
28716
|
+
"name": "SsmDocument",
|
|
27691
28717
|
"properties": [
|
|
27692
28718
|
{
|
|
27693
|
-
"abstract": true,
|
|
27694
28719
|
"docs": {
|
|
27695
|
-
"stability": "stable"
|
|
27696
|
-
|
|
28720
|
+
"stability": "stable"
|
|
28721
|
+
},
|
|
28722
|
+
"immutable": true,
|
|
28723
|
+
"locationInModule": {
|
|
28724
|
+
"filename": "src/document/ssm-document.ts",
|
|
28725
|
+
"line": 84
|
|
28726
|
+
},
|
|
28727
|
+
"name": "description",
|
|
28728
|
+
"type": {
|
|
28729
|
+
"primitive": "string"
|
|
28730
|
+
}
|
|
28731
|
+
},
|
|
28732
|
+
{
|
|
28733
|
+
"docs": {
|
|
28734
|
+
"stability": "stable"
|
|
28735
|
+
},
|
|
28736
|
+
"immutable": true,
|
|
28737
|
+
"locationInModule": {
|
|
28738
|
+
"filename": "src/document/ssm-document.ts",
|
|
28739
|
+
"line": 88
|
|
28740
|
+
},
|
|
28741
|
+
"name": "docInputs",
|
|
28742
|
+
"type": {
|
|
28743
|
+
"collection": {
|
|
28744
|
+
"elementtype": {
|
|
28745
|
+
"fqn": "@cdklabs/cdk-ssm-documents.Input"
|
|
28746
|
+
},
|
|
28747
|
+
"kind": "array"
|
|
28748
|
+
}
|
|
28749
|
+
}
|
|
28750
|
+
},
|
|
28751
|
+
{
|
|
28752
|
+
"docs": {
|
|
28753
|
+
"stability": "stable"
|
|
27697
28754
|
},
|
|
27698
28755
|
"immutable": true,
|
|
27699
28756
|
"locationInModule": {
|
|
27700
|
-
"filename": "src/
|
|
27701
|
-
"line":
|
|
28757
|
+
"filename": "src/document/ssm-document.ts",
|
|
28758
|
+
"line": 87
|
|
27702
28759
|
},
|
|
27703
|
-
"name": "
|
|
27704
|
-
"optional": true,
|
|
28760
|
+
"name": "docOutputs",
|
|
27705
28761
|
"type": {
|
|
27706
|
-
"
|
|
28762
|
+
"collection": {
|
|
28763
|
+
"elementtype": {
|
|
28764
|
+
"fqn": "@cdklabs/cdk-ssm-documents.DocumentOutput"
|
|
28765
|
+
},
|
|
28766
|
+
"kind": "array"
|
|
28767
|
+
}
|
|
27707
28768
|
}
|
|
27708
28769
|
},
|
|
27709
28770
|
{
|
|
27710
|
-
"abstract": true,
|
|
27711
28771
|
"docs": {
|
|
27712
|
-
"stability": "stable"
|
|
27713
|
-
"summary": "(Optional) Collect metadata for AWS components like amazon-ssm-agent."
|
|
28772
|
+
"stability": "stable"
|
|
27714
28773
|
},
|
|
27715
28774
|
"immutable": true,
|
|
27716
28775
|
"locationInModule": {
|
|
27717
|
-
"filename": "src/
|
|
27718
|
-
"line":
|
|
28776
|
+
"filename": "src/document/ssm-document.ts",
|
|
28777
|
+
"line": 83
|
|
27719
28778
|
},
|
|
27720
|
-
"name": "
|
|
27721
|
-
"optional": true,
|
|
28779
|
+
"name": "documentName",
|
|
27722
28780
|
"type": {
|
|
27723
|
-
"
|
|
28781
|
+
"primitive": "string"
|
|
27724
28782
|
}
|
|
27725
28783
|
},
|
|
27726
28784
|
{
|
|
27727
|
-
"abstract": true,
|
|
27728
28785
|
"docs": {
|
|
27729
|
-
"
|
|
27730
|
-
"stability": "stable",
|
|
27731
|
-
"summary": "(Optional) Collect custom inventory data."
|
|
28786
|
+
"stability": "stable"
|
|
27732
28787
|
},
|
|
27733
28788
|
"immutable": true,
|
|
27734
28789
|
"locationInModule": {
|
|
27735
|
-
"filename": "src/
|
|
27736
|
-
"line":
|
|
28790
|
+
"filename": "src/document/ssm-document.ts",
|
|
28791
|
+
"line": 89
|
|
27737
28792
|
},
|
|
27738
|
-
"name": "
|
|
27739
|
-
"optional": true,
|
|
28793
|
+
"name": "props",
|
|
27740
28794
|
"type": {
|
|
27741
|
-
"fqn": "@cdklabs/cdk-ssm-documents.
|
|
28795
|
+
"fqn": "@cdklabs/cdk-ssm-documents.SsmDocumentProps"
|
|
27742
28796
|
}
|
|
27743
28797
|
},
|
|
27744
28798
|
{
|
|
27745
|
-
"abstract": true,
|
|
27746
28799
|
"docs": {
|
|
27747
|
-
"stability": "stable"
|
|
27748
|
-
"summary": "(Optional, requires SSM Agent version 2.2.64.0 or later) Collect metadata for files, including file names, the time files were created, the time files were last modified and accessed, and file sizes, to name a few. For more information about collecting file inventory, see Working with file and Windows registry."
|
|
28800
|
+
"stability": "stable"
|
|
27749
28801
|
},
|
|
27750
28802
|
"immutable": true,
|
|
27751
28803
|
"locationInModule": {
|
|
27752
|
-
"filename": "src/
|
|
27753
|
-
"line":
|
|
28804
|
+
"filename": "src/document/ssm-document.ts",
|
|
28805
|
+
"line": 86
|
|
27754
28806
|
},
|
|
27755
|
-
"name": "
|
|
28807
|
+
"name": "assumeRole",
|
|
27756
28808
|
"optional": true,
|
|
27757
28809
|
"type": {
|
|
27758
|
-
"
|
|
28810
|
+
"primitive": "string"
|
|
27759
28811
|
}
|
|
27760
28812
|
},
|
|
27761
28813
|
{
|
|
27762
|
-
"abstract": true,
|
|
27763
28814
|
"docs": {
|
|
27764
|
-
"stability": "stable"
|
|
27765
|
-
"summary": "(Optional) Collect more instance information than is provided by the default inventory plugin (aws:instanceInformation), including CPU model, speed, and the number of cores, to name a few."
|
|
28815
|
+
"stability": "stable"
|
|
27766
28816
|
},
|
|
27767
28817
|
"immutable": true,
|
|
27768
28818
|
"locationInModule": {
|
|
27769
|
-
"filename": "src/
|
|
27770
|
-
"line":
|
|
28819
|
+
"filename": "src/document/ssm-document.ts",
|
|
28820
|
+
"line": 85
|
|
27771
28821
|
},
|
|
27772
|
-
"name": "
|
|
28822
|
+
"name": "header",
|
|
27773
28823
|
"optional": true,
|
|
27774
28824
|
"type": {
|
|
27775
|
-
"
|
|
28825
|
+
"primitive": "string"
|
|
27776
28826
|
}
|
|
27777
|
-
}
|
|
28827
|
+
}
|
|
28828
|
+
],
|
|
28829
|
+
"symbolId": "src/document/ssm-document:SsmDocument"
|
|
28830
|
+
},
|
|
28831
|
+
"@cdklabs/cdk-ssm-documents.SsmDocumentContentProps": {
|
|
28832
|
+
"assembly": "@cdklabs/cdk-ssm-documents",
|
|
28833
|
+
"datatype": true,
|
|
28834
|
+
"docs": {
|
|
28835
|
+
"stability": "stable",
|
|
28836
|
+
"summary": "Properties.json for sourceType SsmDocument."
|
|
28837
|
+
},
|
|
28838
|
+
"fqn": "@cdklabs/cdk-ssm-documents.SsmDocumentContentProps",
|
|
28839
|
+
"kind": "interface",
|
|
28840
|
+
"locationInModule": {
|
|
28841
|
+
"filename": "src/interface/downloadable-content.ts",
|
|
28842
|
+
"line": 303
|
|
28843
|
+
},
|
|
28844
|
+
"name": "SsmDocumentContentProps",
|
|
28845
|
+
"properties": [
|
|
27778
28846
|
{
|
|
27779
28847
|
"abstract": true,
|
|
27780
28848
|
"docs": {
|
|
28849
|
+
"remarks": "Version is optional.\nor The ARN for the document in the following format: arn:aws:ssm:region:account_id:document/document_name",
|
|
27781
28850
|
"stability": "stable",
|
|
27782
|
-
"summary": "
|
|
28851
|
+
"summary": "specify one of the following The name and version of the document in the following format: name:version."
|
|
27783
28852
|
},
|
|
27784
28853
|
"immutable": true,
|
|
27785
28854
|
"locationInModule": {
|
|
27786
|
-
"filename": "src/
|
|
27787
|
-
"line":
|
|
28855
|
+
"filename": "src/interface/downloadable-content.ts",
|
|
28856
|
+
"line": 309
|
|
27788
28857
|
},
|
|
27789
|
-
"name": "
|
|
27790
|
-
"optional": true,
|
|
28858
|
+
"name": "documentSource",
|
|
27791
28859
|
"type": {
|
|
27792
|
-
"fqn": "@cdklabs/cdk-ssm-documents.
|
|
28860
|
+
"fqn": "@cdklabs/cdk-ssm-documents.DocumentSource"
|
|
27793
28861
|
}
|
|
27794
|
-
}
|
|
28862
|
+
}
|
|
28863
|
+
],
|
|
28864
|
+
"symbolId": "src/interface/downloadable-content:SsmDocumentContentProps"
|
|
28865
|
+
},
|
|
28866
|
+
"@cdklabs/cdk-ssm-documents.SsmDocumentProps": {
|
|
28867
|
+
"assembly": "@cdklabs/cdk-ssm-documents",
|
|
28868
|
+
"datatype": true,
|
|
28869
|
+
"docs": {
|
|
28870
|
+
"stability": "stable"
|
|
28871
|
+
},
|
|
28872
|
+
"fqn": "@cdklabs/cdk-ssm-documents.SsmDocumentProps",
|
|
28873
|
+
"kind": "interface",
|
|
28874
|
+
"locationInModule": {
|
|
28875
|
+
"filename": "src/document/ssm-document.ts",
|
|
28876
|
+
"line": 17
|
|
28877
|
+
},
|
|
28878
|
+
"name": "SsmDocumentProps",
|
|
28879
|
+
"properties": [
|
|
27795
28880
|
{
|
|
27796
28881
|
"abstract": true,
|
|
27797
28882
|
"docs": {
|
|
28883
|
+
"remarks": "If provided, this value MUST be included as one of the documentInput names.",
|
|
27798
28884
|
"stability": "stable",
|
|
27799
|
-
"summary": "(Optional
|
|
28885
|
+
"summary": "(Optional) Assume role to use for this document."
|
|
27800
28886
|
},
|
|
27801
28887
|
"immutable": true,
|
|
27802
28888
|
"locationInModule": {
|
|
27803
|
-
"filename": "src/
|
|
27804
|
-
"line":
|
|
28889
|
+
"filename": "src/document/ssm-document.ts",
|
|
28890
|
+
"line": 34
|
|
27805
28891
|
},
|
|
27806
|
-
"name": "
|
|
28892
|
+
"name": "assumeRole",
|
|
27807
28893
|
"optional": true,
|
|
27808
28894
|
"type": {
|
|
27809
|
-
"
|
|
28895
|
+
"primitive": "string"
|
|
27810
28896
|
}
|
|
27811
28897
|
},
|
|
27812
28898
|
{
|
|
27813
28899
|
"abstract": true,
|
|
27814
28900
|
"docs": {
|
|
28901
|
+
"remarks": "Defaults to the document name.",
|
|
27815
28902
|
"stability": "stable",
|
|
27816
|
-
"summary": "(Optional
|
|
28903
|
+
"summary": "(Optional) Description of the document."
|
|
27817
28904
|
},
|
|
27818
28905
|
"immutable": true,
|
|
27819
28906
|
"locationInModule": {
|
|
27820
|
-
"filename": "src/
|
|
27821
|
-
"line":
|
|
28907
|
+
"filename": "src/document/ssm-document.ts",
|
|
28908
|
+
"line": 25
|
|
27822
28909
|
},
|
|
27823
|
-
"name": "
|
|
28910
|
+
"name": "description",
|
|
27824
28911
|
"optional": true,
|
|
27825
28912
|
"type": {
|
|
27826
|
-
"
|
|
28913
|
+
"primitive": "string"
|
|
27827
28914
|
}
|
|
27828
28915
|
},
|
|
27829
28916
|
{
|
|
27830
28917
|
"abstract": true,
|
|
27831
28918
|
"docs": {
|
|
27832
28919
|
"stability": "stable",
|
|
27833
|
-
"summary": "(Optional
|
|
28920
|
+
"summary": "(Optional) Inputs required by the document."
|
|
27834
28921
|
},
|
|
27835
28922
|
"immutable": true,
|
|
27836
28923
|
"locationInModule": {
|
|
27837
|
-
"filename": "src/
|
|
27838
|
-
"line":
|
|
28924
|
+
"filename": "src/document/ssm-document.ts",
|
|
28925
|
+
"line": 44
|
|
27839
28926
|
},
|
|
27840
|
-
"name": "
|
|
28927
|
+
"name": "docInputs",
|
|
27841
28928
|
"optional": true,
|
|
27842
28929
|
"type": {
|
|
27843
|
-
"
|
|
28930
|
+
"collection": {
|
|
28931
|
+
"elementtype": {
|
|
28932
|
+
"fqn": "@cdklabs/cdk-ssm-documents.Input"
|
|
28933
|
+
},
|
|
28934
|
+
"kind": "array"
|
|
28935
|
+
}
|
|
27844
28936
|
}
|
|
27845
28937
|
},
|
|
27846
28938
|
{
|
|
27847
28939
|
"abstract": true,
|
|
27848
28940
|
"docs": {
|
|
28941
|
+
"default": "[]",
|
|
28942
|
+
"remarks": "The outputs are placed in a StringSet called outputs (as is done in SSM).",
|
|
27849
28943
|
"stability": "stable",
|
|
27850
|
-
"summary": "(Optional)
|
|
28944
|
+
"summary": "(Optional) Outputs to be emitted from the document."
|
|
27851
28945
|
},
|
|
27852
28946
|
"immutable": true,
|
|
27853
28947
|
"locationInModule": {
|
|
27854
|
-
"filename": "src/
|
|
27855
|
-
"line":
|
|
28948
|
+
"filename": "src/document/ssm-document.ts",
|
|
28949
|
+
"line": 40
|
|
27856
28950
|
},
|
|
27857
|
-
"name": "
|
|
28951
|
+
"name": "docOutputs",
|
|
27858
28952
|
"optional": true,
|
|
27859
28953
|
"type": {
|
|
27860
|
-
"
|
|
27861
|
-
|
|
27862
|
-
|
|
27863
|
-
|
|
27864
|
-
|
|
27865
|
-
},
|
|
27866
|
-
"@cdklabs/cdk-ssm-documents.SsmDocument": {
|
|
27867
|
-
"abstract": true,
|
|
27868
|
-
"assembly": "@cdklabs/cdk-ssm-documents",
|
|
27869
|
-
"base": "constructs.Construct",
|
|
27870
|
-
"docs": {
|
|
27871
|
-
"stability": "stable"
|
|
27872
|
-
},
|
|
27873
|
-
"fqn": "@cdklabs/cdk-ssm-documents.SsmDocument",
|
|
27874
|
-
"initializer": {
|
|
27875
|
-
"docs": {
|
|
27876
|
-
"stability": "stable"
|
|
27877
|
-
},
|
|
27878
|
-
"locationInModule": {
|
|
27879
|
-
"filename": "src/document/ssm-document.ts",
|
|
27880
|
-
"line": 91
|
|
27881
|
-
},
|
|
27882
|
-
"parameters": [
|
|
27883
|
-
{
|
|
27884
|
-
"name": "scope",
|
|
27885
|
-
"type": {
|
|
27886
|
-
"fqn": "constructs.Construct"
|
|
27887
|
-
}
|
|
27888
|
-
},
|
|
27889
|
-
{
|
|
27890
|
-
"name": "id",
|
|
27891
|
-
"type": {
|
|
27892
|
-
"primitive": "string"
|
|
27893
|
-
}
|
|
27894
|
-
},
|
|
27895
|
-
{
|
|
27896
|
-
"name": "props",
|
|
27897
|
-
"type": {
|
|
27898
|
-
"fqn": "@cdklabs/cdk-ssm-documents.SsmDocumentProps"
|
|
28954
|
+
"collection": {
|
|
28955
|
+
"elementtype": {
|
|
28956
|
+
"fqn": "@cdklabs/cdk-ssm-documents.DocumentOutput"
|
|
28957
|
+
},
|
|
28958
|
+
"kind": "array"
|
|
27899
28959
|
}
|
|
27900
28960
|
}
|
|
27901
|
-
|
|
27902
|
-
},
|
|
27903
|
-
"kind": "class",
|
|
27904
|
-
"locationInModule": {
|
|
27905
|
-
"filename": "src/document/ssm-document.ts",
|
|
27906
|
-
"line": 81
|
|
27907
|
-
},
|
|
27908
|
-
"methods": [
|
|
28961
|
+
},
|
|
27909
28962
|
{
|
|
27910
28963
|
"abstract": true,
|
|
27911
28964
|
"docs": {
|
|
28965
|
+
"default": "JSON",
|
|
27912
28966
|
"stability": "stable",
|
|
27913
|
-
"summary": "
|
|
28967
|
+
"summary": "(Optional) Specifies whether this document should be written as YAML or JSON."
|
|
27914
28968
|
},
|
|
28969
|
+
"immutable": true,
|
|
27915
28970
|
"locationInModule": {
|
|
27916
28971
|
"filename": "src/document/ssm-document.ts",
|
|
27917
|
-
"line":
|
|
28972
|
+
"line": 49
|
|
27918
28973
|
},
|
|
27919
|
-
"name": "
|
|
27920
|
-
"
|
|
27921
|
-
"
|
|
27922
|
-
"
|
|
27923
|
-
|
|
27924
|
-
|
|
27925
|
-
|
|
27926
|
-
|
|
27927
|
-
|
|
27928
|
-
|
|
27929
|
-
|
|
28974
|
+
"name": "documentFormat",
|
|
28975
|
+
"optional": true,
|
|
28976
|
+
"type": {
|
|
28977
|
+
"fqn": "@cdklabs/cdk-ssm-documents.DocumentFormat"
|
|
28978
|
+
}
|
|
28979
|
+
},
|
|
28980
|
+
{
|
|
28981
|
+
"abstract": true,
|
|
28982
|
+
"docs": {
|
|
28983
|
+
"remarks": "Will default to the id provided for the CDK node.",
|
|
28984
|
+
"stability": "stable",
|
|
28985
|
+
"summary": "(Optional) Name of the document."
|
|
28986
|
+
},
|
|
28987
|
+
"immutable": true,
|
|
28988
|
+
"locationInModule": {
|
|
28989
|
+
"filename": "src/document/ssm-document.ts",
|
|
28990
|
+
"line": 21
|
|
28991
|
+
},
|
|
28992
|
+
"name": "documentName",
|
|
28993
|
+
"optional": true,
|
|
28994
|
+
"type": {
|
|
28995
|
+
"primitive": "string"
|
|
27930
28996
|
}
|
|
27931
28997
|
},
|
|
27932
28998
|
{
|
|
27933
28999
|
"abstract": true,
|
|
27934
29000
|
"docs": {
|
|
27935
|
-
"
|
|
29001
|
+
"remarks": "JSON documents do not support headers.",
|
|
29002
|
+
"stability": "stable",
|
|
29003
|
+
"summary": "(Optional) A Header/comment to include at the start of a YAML document."
|
|
27936
29004
|
},
|
|
29005
|
+
"immutable": true,
|
|
27937
29006
|
"locationInModule": {
|
|
27938
29007
|
"filename": "src/document/ssm-document.ts",
|
|
27939
|
-
"line":
|
|
29008
|
+
"line": 29
|
|
27940
29009
|
},
|
|
27941
|
-
"name": "
|
|
27942
|
-
"
|
|
27943
|
-
|
|
27944
|
-
|
|
27945
|
-
}
|
|
29010
|
+
"name": "header",
|
|
29011
|
+
"optional": true,
|
|
29012
|
+
"type": {
|
|
29013
|
+
"primitive": "string"
|
|
27946
29014
|
}
|
|
27947
29015
|
},
|
|
27948
29016
|
{
|
|
29017
|
+
"abstract": true,
|
|
27949
29018
|
"docs": {
|
|
27950
|
-
"
|
|
29019
|
+
"custom": {
|
|
29020
|
+
"external": "true",
|
|
29021
|
+
"link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-requires"
|
|
29022
|
+
},
|
|
27951
29023
|
"stability": "stable",
|
|
27952
|
-
"summary": "
|
|
29024
|
+
"summary": "`AWS::SSM::Document.Requires`."
|
|
27953
29025
|
},
|
|
29026
|
+
"immutable": true,
|
|
27954
29027
|
"locationInModule": {
|
|
27955
29028
|
"filename": "src/document/ssm-document.ts",
|
|
27956
|
-
"line":
|
|
29029
|
+
"line": 57
|
|
27957
29030
|
},
|
|
27958
|
-
"name": "
|
|
27959
|
-
"
|
|
27960
|
-
"
|
|
27961
|
-
"
|
|
27962
|
-
"
|
|
27963
|
-
|
|
27964
|
-
"
|
|
29031
|
+
"name": "requires",
|
|
29032
|
+
"optional": true,
|
|
29033
|
+
"type": {
|
|
29034
|
+
"union": {
|
|
29035
|
+
"types": [
|
|
29036
|
+
{
|
|
29037
|
+
"fqn": "aws-cdk-lib.IResolvable"
|
|
27965
29038
|
},
|
|
27966
|
-
|
|
27967
|
-
|
|
29039
|
+
{
|
|
29040
|
+
"collection": {
|
|
29041
|
+
"elementtype": {
|
|
29042
|
+
"union": {
|
|
29043
|
+
"types": [
|
|
29044
|
+
{
|
|
29045
|
+
"fqn": "aws-cdk-lib.aws_ssm.CfnDocument.DocumentRequiresProperty"
|
|
29046
|
+
},
|
|
29047
|
+
{
|
|
29048
|
+
"fqn": "aws-cdk-lib.IResolvable"
|
|
29049
|
+
}
|
|
29050
|
+
]
|
|
29051
|
+
}
|
|
29052
|
+
},
|
|
29053
|
+
"kind": "array"
|
|
29054
|
+
}
|
|
29055
|
+
}
|
|
29056
|
+
]
|
|
27968
29057
|
}
|
|
27969
29058
|
}
|
|
27970
29059
|
},
|
|
27971
29060
|
{
|
|
29061
|
+
"abstract": true,
|
|
27972
29062
|
"docs": {
|
|
27973
|
-
"
|
|
27974
|
-
|
|
29063
|
+
"custom": {
|
|
29064
|
+
"external": "true",
|
|
29065
|
+
"link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-tags"
|
|
29066
|
+
},
|
|
27975
29067
|
"stability": "stable",
|
|
27976
|
-
"summary": "
|
|
29068
|
+
"summary": "`AWS::SSM::Document.Tags`."
|
|
27977
29069
|
},
|
|
29070
|
+
"immutable": true,
|
|
27978
29071
|
"locationInModule": {
|
|
27979
29072
|
"filename": "src/document/ssm-document.ts",
|
|
27980
|
-
"line":
|
|
29073
|
+
"line": 64
|
|
27981
29074
|
},
|
|
27982
|
-
"name": "
|
|
27983
|
-
"
|
|
27984
|
-
|
|
27985
|
-
|
|
29075
|
+
"name": "tags",
|
|
29076
|
+
"optional": true,
|
|
29077
|
+
"type": {
|
|
29078
|
+
"collection": {
|
|
29079
|
+
"elementtype": {
|
|
29080
|
+
"fqn": "aws-cdk-lib.CfnTag"
|
|
29081
|
+
},
|
|
29082
|
+
"kind": "array"
|
|
27986
29083
|
}
|
|
27987
29084
|
}
|
|
27988
|
-
}
|
|
27989
|
-
],
|
|
27990
|
-
"name": "SsmDocument",
|
|
27991
|
-
"properties": [
|
|
29085
|
+
},
|
|
27992
29086
|
{
|
|
29087
|
+
"abstract": true,
|
|
27993
29088
|
"docs": {
|
|
27994
|
-
"
|
|
29089
|
+
"custom": {
|
|
29090
|
+
"external": "true",
|
|
29091
|
+
"link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-targettype"
|
|
29092
|
+
},
|
|
29093
|
+
"stability": "stable",
|
|
29094
|
+
"summary": "`AWS::SSM::Document.TargetType`."
|
|
27995
29095
|
},
|
|
27996
29096
|
"immutable": true,
|
|
27997
29097
|
"locationInModule": {
|
|
27998
29098
|
"filename": "src/document/ssm-document.ts",
|
|
27999
|
-
"line":
|
|
29099
|
+
"line": 71
|
|
28000
29100
|
},
|
|
28001
|
-
"name": "
|
|
29101
|
+
"name": "targetType",
|
|
29102
|
+
"optional": true,
|
|
28002
29103
|
"type": {
|
|
28003
29104
|
"primitive": "string"
|
|
28004
29105
|
}
|
|
28005
29106
|
},
|
|
28006
29107
|
{
|
|
29108
|
+
"abstract": true,
|
|
28007
29109
|
"docs": {
|
|
28008
|
-
"
|
|
29110
|
+
"custom": {
|
|
29111
|
+
"external": "true",
|
|
29112
|
+
"link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-versionname"
|
|
29113
|
+
},
|
|
29114
|
+
"stability": "stable",
|
|
29115
|
+
"summary": "`AWS::SSM::Document.VersionName`."
|
|
28009
29116
|
},
|
|
28010
29117
|
"immutable": true,
|
|
28011
29118
|
"locationInModule": {
|
|
28012
29119
|
"filename": "src/document/ssm-document.ts",
|
|
28013
|
-
"line":
|
|
29120
|
+
"line": 78
|
|
28014
29121
|
},
|
|
28015
|
-
"name": "
|
|
29122
|
+
"name": "versionName",
|
|
29123
|
+
"optional": true,
|
|
28016
29124
|
"type": {
|
|
28017
|
-
"
|
|
28018
|
-
"elementtype": {
|
|
28019
|
-
"fqn": "@cdklabs/cdk-ssm-documents.Input"
|
|
28020
|
-
},
|
|
28021
|
-
"kind": "array"
|
|
28022
|
-
}
|
|
29125
|
+
"primitive": "string"
|
|
28023
29126
|
}
|
|
29127
|
+
}
|
|
29128
|
+
],
|
|
29129
|
+
"symbolId": "src/document/ssm-document:SsmDocumentProps"
|
|
29130
|
+
},
|
|
29131
|
+
"@cdklabs/cdk-ssm-documents.SsmRunDocument": {
|
|
29132
|
+
"assembly": "@cdklabs/cdk-ssm-documents",
|
|
29133
|
+
"docs": {
|
|
29134
|
+
"stability": "stable"
|
|
29135
|
+
},
|
|
29136
|
+
"fqn": "@cdklabs/cdk-ssm-documents.SsmRunDocument",
|
|
29137
|
+
"initializer": {
|
|
29138
|
+
"docs": {
|
|
29139
|
+
"stability": "stable",
|
|
29140
|
+
"summary": "specify the name of the document."
|
|
29141
|
+
},
|
|
29142
|
+
"locationInModule": {
|
|
29143
|
+
"filename": "src/interface/run-document-location.ts",
|
|
29144
|
+
"line": 27
|
|
28024
29145
|
},
|
|
29146
|
+
"parameters": [
|
|
29147
|
+
{
|
|
29148
|
+
"name": "documentName",
|
|
29149
|
+
"type": {
|
|
29150
|
+
"fqn": "@cdklabs/cdk-ssm-documents.IStringVariable"
|
|
29151
|
+
}
|
|
29152
|
+
}
|
|
29153
|
+
]
|
|
29154
|
+
},
|
|
29155
|
+
"interfaces": [
|
|
29156
|
+
"@cdklabs/cdk-ssm-documents.IRunDocumentLocation"
|
|
29157
|
+
],
|
|
29158
|
+
"kind": "class",
|
|
29159
|
+
"locationInModule": {
|
|
29160
|
+
"filename": "src/interface/run-document-location.ts",
|
|
29161
|
+
"line": 20
|
|
29162
|
+
},
|
|
29163
|
+
"name": "SsmRunDocument",
|
|
29164
|
+
"properties": [
|
|
28025
29165
|
{
|
|
28026
29166
|
"docs": {
|
|
28027
29167
|
"stability": "stable"
|
|
28028
29168
|
},
|
|
28029
29169
|
"immutable": true,
|
|
28030
29170
|
"locationInModule": {
|
|
28031
|
-
"filename": "src/
|
|
28032
|
-
"line":
|
|
29171
|
+
"filename": "src/interface/run-document-location.ts",
|
|
29172
|
+
"line": 22
|
|
28033
29173
|
},
|
|
28034
|
-
"name": "
|
|
29174
|
+
"name": "location",
|
|
29175
|
+
"overrides": "@cdklabs/cdk-ssm-documents.IRunDocumentLocation",
|
|
28035
29176
|
"type": {
|
|
28036
|
-
"
|
|
28037
|
-
"elementtype": {
|
|
28038
|
-
"fqn": "@cdklabs/cdk-ssm-documents.DocumentOutput"
|
|
28039
|
-
},
|
|
28040
|
-
"kind": "array"
|
|
28041
|
-
}
|
|
29177
|
+
"fqn": "@cdklabs/cdk-ssm-documents.IStringVariable"
|
|
28042
29178
|
}
|
|
28043
29179
|
},
|
|
28044
29180
|
{
|
|
@@ -28047,332 +29183,389 @@
|
|
|
28047
29183
|
},
|
|
28048
29184
|
"immutable": true,
|
|
28049
29185
|
"locationInModule": {
|
|
28050
|
-
"filename": "src/
|
|
28051
|
-
"line":
|
|
29186
|
+
"filename": "src/interface/run-document-location.ts",
|
|
29187
|
+
"line": 21
|
|
28052
29188
|
},
|
|
28053
|
-
"name": "
|
|
29189
|
+
"name": "type",
|
|
29190
|
+
"overrides": "@cdklabs/cdk-ssm-documents.IRunDocumentLocation",
|
|
28054
29191
|
"type": {
|
|
28055
29192
|
"primitive": "string"
|
|
28056
29193
|
}
|
|
29194
|
+
}
|
|
29195
|
+
],
|
|
29196
|
+
"symbolId": "src/interface/run-document-location:SsmRunDocument"
|
|
29197
|
+
},
|
|
29198
|
+
"@cdklabs/cdk-ssm-documents.SsmSecureVariable": {
|
|
29199
|
+
"assembly": "@cdklabs/cdk-ssm-documents",
|
|
29200
|
+
"base": "@cdklabs/cdk-ssm-documents.SecureVariable",
|
|
29201
|
+
"docs": {
|
|
29202
|
+
"stability": "stable"
|
|
29203
|
+
},
|
|
29204
|
+
"fqn": "@cdklabs/cdk-ssm-documents.SsmSecureVariable",
|
|
29205
|
+
"initializer": {
|
|
29206
|
+
"docs": {
|
|
29207
|
+
"stability": "stable"
|
|
29208
|
+
},
|
|
29209
|
+
"locationInModule": {
|
|
29210
|
+
"filename": "src/interface/variables/secure-string-variable.ts",
|
|
29211
|
+
"line": 80
|
|
28057
29212
|
},
|
|
29213
|
+
"parameters": [
|
|
29214
|
+
{
|
|
29215
|
+
"name": "secureToken",
|
|
29216
|
+
"type": {
|
|
29217
|
+
"primitive": "string"
|
|
29218
|
+
}
|
|
29219
|
+
}
|
|
29220
|
+
]
|
|
29221
|
+
},
|
|
29222
|
+
"kind": "class",
|
|
29223
|
+
"locationInModule": {
|
|
29224
|
+
"filename": "src/interface/variables/secure-string-variable.ts",
|
|
29225
|
+
"line": 78
|
|
29226
|
+
},
|
|
29227
|
+
"methods": [
|
|
28058
29228
|
{
|
|
28059
29229
|
"docs": {
|
|
28060
|
-
"
|
|
29230
|
+
"remarks": "This is typically in the form of {{ Variable }} or the value.",
|
|
29231
|
+
"stability": "stable",
|
|
29232
|
+
"summary": "Prints the variable in a way that SSM understands."
|
|
28061
29233
|
},
|
|
28062
|
-
"immutable": true,
|
|
28063
29234
|
"locationInModule": {
|
|
28064
|
-
"filename": "src/
|
|
29235
|
+
"filename": "src/interface/variables/secure-string-variable.ts",
|
|
28065
29236
|
"line": 89
|
|
28066
29237
|
},
|
|
28067
|
-
"name": "
|
|
28068
|
-
"
|
|
28069
|
-
|
|
29238
|
+
"name": "print",
|
|
29239
|
+
"overrides": "@cdklabs/cdk-ssm-documents.SecureVariable",
|
|
29240
|
+
"returns": {
|
|
29241
|
+
"type": {
|
|
29242
|
+
"primitive": "any"
|
|
29243
|
+
}
|
|
28070
29244
|
}
|
|
28071
29245
|
},
|
|
28072
29246
|
{
|
|
28073
29247
|
"docs": {
|
|
28074
|
-
"
|
|
29248
|
+
"remarks": "In the case of a single variable string, this will return a single value.",
|
|
29249
|
+
"stability": "stable",
|
|
29250
|
+
"summary": "The inputs that are required for determining the value of this variable."
|
|
28075
29251
|
},
|
|
28076
|
-
"immutable": true,
|
|
28077
29252
|
"locationInModule": {
|
|
28078
|
-
"filename": "src/
|
|
28079
|
-
"line":
|
|
29253
|
+
"filename": "src/interface/variables/secure-string-variable.ts",
|
|
29254
|
+
"line": 93
|
|
28080
29255
|
},
|
|
28081
|
-
"name": "
|
|
28082
|
-
"
|
|
28083
|
-
"
|
|
28084
|
-
"
|
|
29256
|
+
"name": "requiredInputs",
|
|
29257
|
+
"overrides": "@cdklabs/cdk-ssm-documents.SecureVariable",
|
|
29258
|
+
"returns": {
|
|
29259
|
+
"type": {
|
|
29260
|
+
"collection": {
|
|
29261
|
+
"elementtype": {
|
|
29262
|
+
"primitive": "string"
|
|
29263
|
+
},
|
|
29264
|
+
"kind": "array"
|
|
29265
|
+
}
|
|
29266
|
+
}
|
|
28085
29267
|
}
|
|
28086
29268
|
},
|
|
28087
29269
|
{
|
|
28088
29270
|
"docs": {
|
|
28089
|
-
"stability": "stable"
|
|
29271
|
+
"stability": "stable",
|
|
29272
|
+
"summary": "Given the execution inputs, return the resolved value of this variable."
|
|
28090
29273
|
},
|
|
28091
|
-
"immutable": true,
|
|
28092
29274
|
"locationInModule": {
|
|
28093
|
-
"filename": "src/
|
|
29275
|
+
"filename": "src/interface/variables/secure-string-variable.ts",
|
|
28094
29276
|
"line": 85
|
|
28095
29277
|
},
|
|
28096
|
-
"name": "
|
|
28097
|
-
"
|
|
28098
|
-
"
|
|
28099
|
-
|
|
29278
|
+
"name": "resolve",
|
|
29279
|
+
"overrides": "@cdklabs/cdk-ssm-documents.SecureVariable",
|
|
29280
|
+
"parameters": [
|
|
29281
|
+
{
|
|
29282
|
+
"name": "_inputs",
|
|
29283
|
+
"type": {
|
|
29284
|
+
"collection": {
|
|
29285
|
+
"elementtype": {
|
|
29286
|
+
"primitive": "any"
|
|
29287
|
+
},
|
|
29288
|
+
"kind": "map"
|
|
29289
|
+
}
|
|
29290
|
+
}
|
|
29291
|
+
}
|
|
29292
|
+
],
|
|
29293
|
+
"returns": {
|
|
29294
|
+
"type": {
|
|
29295
|
+
"primitive": "any"
|
|
29296
|
+
}
|
|
28100
29297
|
}
|
|
28101
29298
|
}
|
|
28102
29299
|
],
|
|
28103
|
-
"
|
|
28104
|
-
},
|
|
28105
|
-
"@cdklabs/cdk-ssm-documents.SsmDocumentContentProps": {
|
|
28106
|
-
"assembly": "@cdklabs/cdk-ssm-documents",
|
|
28107
|
-
"datatype": true,
|
|
28108
|
-
"docs": {
|
|
28109
|
-
"stability": "stable",
|
|
28110
|
-
"summary": "Properties.json for sourceType SsmDocument."
|
|
28111
|
-
},
|
|
28112
|
-
"fqn": "@cdklabs/cdk-ssm-documents.SsmDocumentContentProps",
|
|
28113
|
-
"kind": "interface",
|
|
28114
|
-
"locationInModule": {
|
|
28115
|
-
"filename": "src/interface/downloadable-content.ts",
|
|
28116
|
-
"line": 303
|
|
28117
|
-
},
|
|
28118
|
-
"name": "SsmDocumentContentProps",
|
|
29300
|
+
"name": "SsmSecureVariable",
|
|
28119
29301
|
"properties": [
|
|
28120
29302
|
{
|
|
28121
|
-
"abstract": true,
|
|
28122
29303
|
"docs": {
|
|
28123
|
-
"
|
|
28124
|
-
"stability": "stable",
|
|
28125
|
-
"summary": "specify one of the following The name and version of the document in the following format: name:version."
|
|
29304
|
+
"stability": "stable"
|
|
28126
29305
|
},
|
|
28127
29306
|
"immutable": true,
|
|
28128
29307
|
"locationInModule": {
|
|
28129
|
-
"filename": "src/interface/
|
|
28130
|
-
"line":
|
|
29308
|
+
"filename": "src/interface/variables/secure-string-variable.ts",
|
|
29309
|
+
"line": 79
|
|
28131
29310
|
},
|
|
28132
|
-
"name": "
|
|
29311
|
+
"name": "secureToken",
|
|
28133
29312
|
"type": {
|
|
28134
|
-
"
|
|
29313
|
+
"primitive": "string"
|
|
28135
29314
|
}
|
|
28136
29315
|
}
|
|
28137
29316
|
],
|
|
28138
|
-
"symbolId": "src/interface/
|
|
29317
|
+
"symbolId": "src/interface/variables/secure-string-variable:SsmSecureVariable"
|
|
28139
29318
|
},
|
|
28140
|
-
"@cdklabs/cdk-ssm-documents.
|
|
29319
|
+
"@cdklabs/cdk-ssm-documents.Step": {
|
|
29320
|
+
"abstract": true,
|
|
28141
29321
|
"assembly": "@cdklabs/cdk-ssm-documents",
|
|
28142
|
-
"
|
|
29322
|
+
"base": "constructs.Construct",
|
|
28143
29323
|
"docs": {
|
|
28144
29324
|
"stability": "stable"
|
|
28145
29325
|
},
|
|
28146
|
-
"fqn": "@cdklabs/cdk-ssm-documents.
|
|
28147
|
-
"
|
|
29326
|
+
"fqn": "@cdklabs/cdk-ssm-documents.Step",
|
|
29327
|
+
"initializer": {
|
|
29328
|
+
"docs": {
|
|
29329
|
+
"stability": "stable"
|
|
29330
|
+
},
|
|
29331
|
+
"locationInModule": {
|
|
29332
|
+
"filename": "src/parent-steps/step.ts",
|
|
29333
|
+
"line": 41
|
|
29334
|
+
},
|
|
29335
|
+
"parameters": [
|
|
29336
|
+
{
|
|
29337
|
+
"name": "scope",
|
|
29338
|
+
"type": {
|
|
29339
|
+
"fqn": "constructs.Construct"
|
|
29340
|
+
}
|
|
29341
|
+
},
|
|
29342
|
+
{
|
|
29343
|
+
"name": "id",
|
|
29344
|
+
"type": {
|
|
29345
|
+
"primitive": "string"
|
|
29346
|
+
}
|
|
29347
|
+
},
|
|
29348
|
+
{
|
|
29349
|
+
"name": "props",
|
|
29350
|
+
"type": {
|
|
29351
|
+
"fqn": "@cdklabs/cdk-ssm-documents.StepProps"
|
|
29352
|
+
}
|
|
29353
|
+
}
|
|
29354
|
+
]
|
|
29355
|
+
},
|
|
29356
|
+
"kind": "class",
|
|
28148
29357
|
"locationInModule": {
|
|
28149
|
-
"filename": "src/
|
|
28150
|
-
"line":
|
|
29358
|
+
"filename": "src/parent-steps/step.ts",
|
|
29359
|
+
"line": 33
|
|
28151
29360
|
},
|
|
28152
|
-
"
|
|
28153
|
-
"properties": [
|
|
29361
|
+
"methods": [
|
|
28154
29362
|
{
|
|
28155
29363
|
"abstract": true,
|
|
28156
29364
|
"docs": {
|
|
28157
|
-
"remarks": "If provided, this value MUST be included as one of the documentInput names.",
|
|
28158
29365
|
"stability": "stable",
|
|
28159
|
-
"summary": "
|
|
29366
|
+
"summary": "Lists the inputs that are required for this step."
|
|
28160
29367
|
},
|
|
28161
|
-
"immutable": true,
|
|
28162
29368
|
"locationInModule": {
|
|
28163
|
-
"filename": "src/
|
|
28164
|
-
"line":
|
|
29369
|
+
"filename": "src/parent-steps/step.ts",
|
|
29370
|
+
"line": 60
|
|
28165
29371
|
},
|
|
28166
|
-
"name": "
|
|
28167
|
-
"
|
|
28168
|
-
|
|
28169
|
-
|
|
29372
|
+
"name": "listInputs",
|
|
29373
|
+
"returns": {
|
|
29374
|
+
"type": {
|
|
29375
|
+
"collection": {
|
|
29376
|
+
"elementtype": {
|
|
29377
|
+
"primitive": "string"
|
|
29378
|
+
},
|
|
29379
|
+
"kind": "array"
|
|
29380
|
+
}
|
|
29381
|
+
}
|
|
28170
29382
|
}
|
|
28171
29383
|
},
|
|
28172
29384
|
{
|
|
28173
29385
|
"abstract": true,
|
|
28174
29386
|
"docs": {
|
|
28175
|
-
"remarks": "Defaults to the document name.",
|
|
28176
29387
|
"stability": "stable",
|
|
28177
|
-
"summary": "
|
|
29388
|
+
"summary": "Lists the outputs that will be returned from this step."
|
|
28178
29389
|
},
|
|
28179
|
-
"immutable": true,
|
|
28180
29390
|
"locationInModule": {
|
|
28181
|
-
"filename": "src/
|
|
28182
|
-
"line":
|
|
29391
|
+
"filename": "src/parent-steps/step.ts",
|
|
29392
|
+
"line": 55
|
|
28183
29393
|
},
|
|
28184
|
-
"name": "
|
|
28185
|
-
"
|
|
28186
|
-
|
|
28187
|
-
|
|
29394
|
+
"name": "listOutputs",
|
|
29395
|
+
"returns": {
|
|
29396
|
+
"type": {
|
|
29397
|
+
"collection": {
|
|
29398
|
+
"elementtype": {
|
|
29399
|
+
"fqn": "@cdklabs/cdk-ssm-documents.Output"
|
|
29400
|
+
},
|
|
29401
|
+
"kind": "array"
|
|
29402
|
+
}
|
|
29403
|
+
}
|
|
28188
29404
|
}
|
|
28189
29405
|
},
|
|
28190
29406
|
{
|
|
28191
29407
|
"abstract": true,
|
|
28192
29408
|
"docs": {
|
|
28193
29409
|
"stability": "stable",
|
|
28194
|
-
"summary": "
|
|
29410
|
+
"summary": "Converts this step into an object to prepare for yaml/json representation of this step."
|
|
28195
29411
|
},
|
|
28196
|
-
"immutable": true,
|
|
28197
29412
|
"locationInModule": {
|
|
28198
|
-
"filename": "src/
|
|
28199
|
-
"line":
|
|
29413
|
+
"filename": "src/parent-steps/step.ts",
|
|
29414
|
+
"line": 65
|
|
28200
29415
|
},
|
|
28201
|
-
"name": "
|
|
28202
|
-
"
|
|
28203
|
-
|
|
28204
|
-
|
|
28205
|
-
|
|
28206
|
-
|
|
28207
|
-
|
|
28208
|
-
|
|
29416
|
+
"name": "toSsmEntry",
|
|
29417
|
+
"returns": {
|
|
29418
|
+
"type": {
|
|
29419
|
+
"collection": {
|
|
29420
|
+
"elementtype": {
|
|
29421
|
+
"primitive": "any"
|
|
29422
|
+
},
|
|
29423
|
+
"kind": "map"
|
|
29424
|
+
}
|
|
28209
29425
|
}
|
|
28210
29426
|
}
|
|
28211
|
-
}
|
|
29427
|
+
}
|
|
29428
|
+
],
|
|
29429
|
+
"name": "Step",
|
|
29430
|
+
"properties": [
|
|
28212
29431
|
{
|
|
28213
29432
|
"abstract": true,
|
|
28214
29433
|
"docs": {
|
|
28215
|
-
"
|
|
28216
|
-
"remarks": "The outputs are placed in a StringSet called outputs (as is done in SSM).",
|
|
28217
|
-
"stability": "stable",
|
|
28218
|
-
"summary": "(Optional) Outputs to be emitted from the document."
|
|
29434
|
+
"stability": "stable"
|
|
28219
29435
|
},
|
|
28220
29436
|
"immutable": true,
|
|
28221
29437
|
"locationInModule": {
|
|
28222
|
-
"filename": "src/
|
|
28223
|
-
"line":
|
|
29438
|
+
"filename": "src/parent-steps/step.ts",
|
|
29439
|
+
"line": 39
|
|
28224
29440
|
},
|
|
28225
|
-
"name": "
|
|
28226
|
-
"optional": true,
|
|
29441
|
+
"name": "action",
|
|
28227
29442
|
"type": {
|
|
28228
|
-
"
|
|
28229
|
-
"elementtype": {
|
|
28230
|
-
"fqn": "@cdklabs/cdk-ssm-documents.DocumentOutput"
|
|
28231
|
-
},
|
|
28232
|
-
"kind": "array"
|
|
28233
|
-
}
|
|
29443
|
+
"primitive": "string"
|
|
28234
29444
|
}
|
|
28235
29445
|
},
|
|
28236
29446
|
{
|
|
28237
|
-
"abstract": true,
|
|
28238
29447
|
"docs": {
|
|
28239
|
-
"
|
|
28240
|
-
"stability": "stable",
|
|
28241
|
-
"summary": "(Optional) Specifies whether this document should be written as YAML or JSON."
|
|
29448
|
+
"stability": "stable"
|
|
28242
29449
|
},
|
|
28243
29450
|
"immutable": true,
|
|
28244
29451
|
"locationInModule": {
|
|
28245
|
-
"filename": "src/
|
|
28246
|
-
"line":
|
|
29452
|
+
"filename": "src/parent-steps/step.ts",
|
|
29453
|
+
"line": 37
|
|
28247
29454
|
},
|
|
28248
|
-
"name": "
|
|
28249
|
-
"optional": true,
|
|
29455
|
+
"name": "inputObserver",
|
|
28250
29456
|
"type": {
|
|
28251
|
-
"fqn": "@cdklabs/cdk-ssm-documents.
|
|
29457
|
+
"fqn": "@cdklabs/cdk-ssm-documents.IObserver"
|
|
28252
29458
|
}
|
|
28253
29459
|
},
|
|
28254
29460
|
{
|
|
28255
|
-
"abstract": true,
|
|
28256
29461
|
"docs": {
|
|
28257
|
-
"
|
|
28258
|
-
"stability": "stable",
|
|
28259
|
-
"summary": "(Optional) Name of the document."
|
|
29462
|
+
"stability": "stable"
|
|
28260
29463
|
},
|
|
28261
29464
|
"immutable": true,
|
|
28262
29465
|
"locationInModule": {
|
|
28263
|
-
"filename": "src/
|
|
28264
|
-
"line":
|
|
29466
|
+
"filename": "src/parent-steps/step.ts",
|
|
29467
|
+
"line": 35
|
|
28265
29468
|
},
|
|
28266
|
-
"name": "
|
|
28267
|
-
"optional": true,
|
|
29469
|
+
"name": "name",
|
|
28268
29470
|
"type": {
|
|
28269
29471
|
"primitive": "string"
|
|
28270
29472
|
}
|
|
28271
29473
|
},
|
|
28272
29474
|
{
|
|
28273
|
-
"abstract": true,
|
|
28274
29475
|
"docs": {
|
|
28275
|
-
"
|
|
28276
|
-
"stability": "stable",
|
|
28277
|
-
"summary": "(Optional) A Header/comment to include at the start of a YAML document."
|
|
29476
|
+
"stability": "stable"
|
|
28278
29477
|
},
|
|
28279
29478
|
"immutable": true,
|
|
28280
29479
|
"locationInModule": {
|
|
28281
|
-
"filename": "src/
|
|
28282
|
-
"line":
|
|
29480
|
+
"filename": "src/parent-steps/step.ts",
|
|
29481
|
+
"line": 38
|
|
28283
29482
|
},
|
|
28284
|
-
"name": "
|
|
29483
|
+
"name": "outputObserver",
|
|
29484
|
+
"type": {
|
|
29485
|
+
"fqn": "@cdklabs/cdk-ssm-documents.IObserver"
|
|
29486
|
+
}
|
|
29487
|
+
},
|
|
29488
|
+
{
|
|
29489
|
+
"docs": {
|
|
29490
|
+
"stability": "stable"
|
|
29491
|
+
},
|
|
29492
|
+
"immutable": true,
|
|
29493
|
+
"locationInModule": {
|
|
29494
|
+
"filename": "src/parent-steps/step.ts",
|
|
29495
|
+
"line": 36
|
|
29496
|
+
},
|
|
29497
|
+
"name": "description",
|
|
28285
29498
|
"optional": true,
|
|
28286
29499
|
"type": {
|
|
28287
29500
|
"primitive": "string"
|
|
28288
29501
|
}
|
|
28289
|
-
}
|
|
29502
|
+
}
|
|
29503
|
+
],
|
|
29504
|
+
"symbolId": "src/parent-steps/step:Step"
|
|
29505
|
+
},
|
|
29506
|
+
"@cdklabs/cdk-ssm-documents.StepProps": {
|
|
29507
|
+
"assembly": "@cdklabs/cdk-ssm-documents",
|
|
29508
|
+
"datatype": true,
|
|
29509
|
+
"docs": {
|
|
29510
|
+
"stability": "stable"
|
|
29511
|
+
},
|
|
29512
|
+
"fqn": "@cdklabs/cdk-ssm-documents.StepProps",
|
|
29513
|
+
"kind": "interface",
|
|
29514
|
+
"locationInModule": {
|
|
29515
|
+
"filename": "src/parent-steps/step.ts",
|
|
29516
|
+
"line": 5
|
|
29517
|
+
},
|
|
29518
|
+
"name": "StepProps",
|
|
29519
|
+
"properties": [
|
|
28290
29520
|
{
|
|
28291
29521
|
"abstract": true,
|
|
28292
29522
|
"docs": {
|
|
28293
|
-
"
|
|
28294
|
-
"external": "true",
|
|
28295
|
-
"link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-requires"
|
|
28296
|
-
},
|
|
29523
|
+
"default": "undefined",
|
|
28297
29524
|
"stability": "stable",
|
|
28298
|
-
"summary": "
|
|
29525
|
+
"summary": "(Optional) description of the current step."
|
|
28299
29526
|
},
|
|
28300
29527
|
"immutable": true,
|
|
28301
29528
|
"locationInModule": {
|
|
28302
|
-
"filename": "src/
|
|
28303
|
-
"line":
|
|
29529
|
+
"filename": "src/parent-steps/step.ts",
|
|
29530
|
+
"line": 18
|
|
28304
29531
|
},
|
|
28305
|
-
"name": "
|
|
29532
|
+
"name": "description",
|
|
28306
29533
|
"optional": true,
|
|
28307
29534
|
"type": {
|
|
28308
|
-
"
|
|
28309
|
-
"types": [
|
|
28310
|
-
{
|
|
28311
|
-
"fqn": "aws-cdk-lib.IResolvable"
|
|
28312
|
-
},
|
|
28313
|
-
{
|
|
28314
|
-
"collection": {
|
|
28315
|
-
"elementtype": {
|
|
28316
|
-
"union": {
|
|
28317
|
-
"types": [
|
|
28318
|
-
{
|
|
28319
|
-
"fqn": "aws-cdk-lib.aws_ssm.CfnDocument.DocumentRequiresProperty"
|
|
28320
|
-
},
|
|
28321
|
-
{
|
|
28322
|
-
"fqn": "aws-cdk-lib.IResolvable"
|
|
28323
|
-
}
|
|
28324
|
-
]
|
|
28325
|
-
}
|
|
28326
|
-
},
|
|
28327
|
-
"kind": "array"
|
|
28328
|
-
}
|
|
28329
|
-
}
|
|
28330
|
-
]
|
|
28331
|
-
}
|
|
29535
|
+
"primitive": "string"
|
|
28332
29536
|
}
|
|
28333
29537
|
},
|
|
28334
29538
|
{
|
|
28335
29539
|
"abstract": true,
|
|
28336
29540
|
"docs": {
|
|
28337
|
-
"
|
|
28338
|
-
"external": "true",
|
|
28339
|
-
"link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-tags"
|
|
28340
|
-
},
|
|
29541
|
+
"default": "NoopObserver",
|
|
28341
29542
|
"stability": "stable",
|
|
28342
|
-
"summary": "
|
|
29543
|
+
"summary": "(Optional) Allows for observing the input to steps as they run."
|
|
28343
29544
|
},
|
|
28344
29545
|
"immutable": true,
|
|
28345
29546
|
"locationInModule": {
|
|
28346
|
-
"filename": "src/
|
|
28347
|
-
"line":
|
|
29547
|
+
"filename": "src/parent-steps/step.ts",
|
|
29548
|
+
"line": 24
|
|
28348
29549
|
},
|
|
28349
|
-
"name": "
|
|
29550
|
+
"name": "inputObserver",
|
|
28350
29551
|
"optional": true,
|
|
28351
29552
|
"type": {
|
|
28352
|
-
"
|
|
28353
|
-
"elementtype": {
|
|
28354
|
-
"fqn": "aws-cdk-lib.CfnTag"
|
|
28355
|
-
},
|
|
28356
|
-
"kind": "array"
|
|
28357
|
-
}
|
|
29553
|
+
"fqn": "@cdklabs/cdk-ssm-documents.IObserver"
|
|
28358
29554
|
}
|
|
28359
29555
|
},
|
|
28360
29556
|
{
|
|
28361
29557
|
"abstract": true,
|
|
28362
29558
|
"docs": {
|
|
28363
|
-
"
|
|
28364
|
-
"external": "true",
|
|
28365
|
-
"link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-targettype"
|
|
28366
|
-
},
|
|
29559
|
+
"remarks": "The name will be prepended onto all of the outputs emitted from this step.\nThis name will also be used to reference this step in logs.\nDefaults to the id of the CDK node.",
|
|
28367
29560
|
"stability": "stable",
|
|
28368
|
-
"summary": "
|
|
29561
|
+
"summary": "(Optional) Name of the current step."
|
|
28369
29562
|
},
|
|
28370
29563
|
"immutable": true,
|
|
28371
29564
|
"locationInModule": {
|
|
28372
|
-
"filename": "src/
|
|
28373
|
-
"line":
|
|
29565
|
+
"filename": "src/parent-steps/step.ts",
|
|
29566
|
+
"line": 12
|
|
28374
29567
|
},
|
|
28375
|
-
"name": "
|
|
29568
|
+
"name": "name",
|
|
28376
29569
|
"optional": true,
|
|
28377
29570
|
"type": {
|
|
28378
29571
|
"primitive": "string"
|
|
@@ -28381,136 +29574,219 @@
|
|
|
28381
29574
|
{
|
|
28382
29575
|
"abstract": true,
|
|
28383
29576
|
"docs": {
|
|
28384
|
-
"
|
|
28385
|
-
"external": "true",
|
|
28386
|
-
"link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-versionname"
|
|
28387
|
-
},
|
|
29577
|
+
"default": "NoopObserver",
|
|
28388
29578
|
"stability": "stable",
|
|
28389
|
-
"summary": "
|
|
29579
|
+
"summary": "(Optional) Allows for observing the output of steps as they run."
|
|
28390
29580
|
},
|
|
28391
29581
|
"immutable": true,
|
|
28392
29582
|
"locationInModule": {
|
|
28393
|
-
"filename": "src/
|
|
28394
|
-
"line":
|
|
29583
|
+
"filename": "src/parent-steps/step.ts",
|
|
29584
|
+
"line": 30
|
|
28395
29585
|
},
|
|
28396
|
-
"name": "
|
|
29586
|
+
"name": "outputObserver",
|
|
28397
29587
|
"optional": true,
|
|
28398
29588
|
"type": {
|
|
28399
|
-
"
|
|
29589
|
+
"fqn": "@cdklabs/cdk-ssm-documents.IObserver"
|
|
28400
29590
|
}
|
|
28401
29591
|
}
|
|
28402
29592
|
],
|
|
28403
|
-
"symbolId": "src/
|
|
29593
|
+
"symbolId": "src/parent-steps/step:StepProps"
|
|
28404
29594
|
},
|
|
28405
|
-
"@cdklabs/cdk-ssm-documents.
|
|
29595
|
+
"@cdklabs/cdk-ssm-documents.StringDocument": {
|
|
28406
29596
|
"assembly": "@cdklabs/cdk-ssm-documents",
|
|
28407
29597
|
"docs": {
|
|
28408
|
-
"
|
|
29598
|
+
"remarks": "Importing an existing file allows for benefiting from the simulated execution.\nThe simulated execution will run locally in the same fashion that SSM Execution would run the document.\nYou can supply mocks to the simulator and validate the calls and the flow of the document without running via SSM execution.",
|
|
29599
|
+
"stability": "stable",
|
|
29600
|
+
"summary": "This AutomationDocument supports declaring your document from an existing document (JSON/YAML String/File)."
|
|
28409
29601
|
},
|
|
28410
|
-
"fqn": "@cdklabs/cdk-ssm-documents.
|
|
29602
|
+
"fqn": "@cdklabs/cdk-ssm-documents.StringDocument",
|
|
28411
29603
|
"initializer": {
|
|
28412
29604
|
"docs": {
|
|
28413
|
-
"stability": "stable"
|
|
28414
|
-
|
|
28415
|
-
},
|
|
28416
|
-
"locationInModule": {
|
|
28417
|
-
"filename": "src/interface/run-document-location.ts",
|
|
28418
|
-
"line": 27
|
|
28419
|
-
},
|
|
28420
|
-
"parameters": [
|
|
28421
|
-
{
|
|
28422
|
-
"name": "documentName",
|
|
28423
|
-
"type": {
|
|
28424
|
-
"fqn": "@cdklabs/cdk-ssm-documents.IStringVariable"
|
|
28425
|
-
}
|
|
28426
|
-
}
|
|
28427
|
-
]
|
|
29605
|
+
"stability": "stable"
|
|
29606
|
+
}
|
|
28428
29607
|
},
|
|
28429
|
-
"interfaces": [
|
|
28430
|
-
"@cdklabs/cdk-ssm-documents.IRunDocumentLocation"
|
|
28431
|
-
],
|
|
28432
29608
|
"kind": "class",
|
|
28433
29609
|
"locationInModule": {
|
|
28434
|
-
"filename": "src/
|
|
28435
|
-
"line":
|
|
29610
|
+
"filename": "src/patterns/document/string-document.ts",
|
|
29611
|
+
"line": 14
|
|
28436
29612
|
},
|
|
28437
|
-
"
|
|
28438
|
-
"properties": [
|
|
29613
|
+
"methods": [
|
|
28439
29614
|
{
|
|
28440
29615
|
"docs": {
|
|
28441
|
-
"
|
|
29616
|
+
"remarks": "Note: This function will deduce whether the file is written in yaml or json based on whether it has a .yaml or .yml extention.\nYou can use the returned AutomationDocument to run simulations as you would other documents created using this library.",
|
|
29617
|
+
"stability": "stable",
|
|
29618
|
+
"summary": "Create an AutomationDocument from an existing AutomationDocument yaml or json file."
|
|
28442
29619
|
},
|
|
28443
|
-
"immutable": true,
|
|
28444
29620
|
"locationInModule": {
|
|
28445
|
-
"filename": "src/
|
|
28446
|
-
"line":
|
|
29621
|
+
"filename": "src/patterns/document/string-document.ts",
|
|
29622
|
+
"line": 21
|
|
28447
29623
|
},
|
|
28448
|
-
"name": "
|
|
28449
|
-
"
|
|
28450
|
-
|
|
28451
|
-
|
|
28452
|
-
|
|
29624
|
+
"name": "fromFile",
|
|
29625
|
+
"parameters": [
|
|
29626
|
+
{
|
|
29627
|
+
"name": "stack",
|
|
29628
|
+
"type": {
|
|
29629
|
+
"fqn": "constructs.Construct"
|
|
29630
|
+
}
|
|
29631
|
+
},
|
|
29632
|
+
{
|
|
29633
|
+
"name": "id",
|
|
29634
|
+
"type": {
|
|
29635
|
+
"primitive": "string"
|
|
29636
|
+
}
|
|
29637
|
+
},
|
|
29638
|
+
{
|
|
29639
|
+
"name": "documentFilePath",
|
|
29640
|
+
"type": {
|
|
29641
|
+
"primitive": "string"
|
|
29642
|
+
}
|
|
29643
|
+
}
|
|
29644
|
+
],
|
|
29645
|
+
"returns": {
|
|
29646
|
+
"type": {
|
|
29647
|
+
"fqn": "@cdklabs/cdk-ssm-documents.AutomationDocument"
|
|
29648
|
+
}
|
|
29649
|
+
},
|
|
29650
|
+
"static": true
|
|
28453
29651
|
},
|
|
28454
29652
|
{
|
|
28455
29653
|
"docs": {
|
|
28456
|
-
"
|
|
29654
|
+
"remarks": "You can use the returned AutomationDocument to run simulations as you would other documents created using this library.",
|
|
29655
|
+
"stability": "stable",
|
|
29656
|
+
"summary": "Create an AutomationDocument from an existing json string."
|
|
28457
29657
|
},
|
|
28458
|
-
"immutable": true,
|
|
28459
29658
|
"locationInModule": {
|
|
28460
|
-
"filename": "src/
|
|
28461
|
-
"line":
|
|
29659
|
+
"filename": "src/patterns/document/string-document.ts",
|
|
29660
|
+
"line": 42
|
|
29661
|
+
},
|
|
29662
|
+
"name": "fromJson",
|
|
29663
|
+
"parameters": [
|
|
29664
|
+
{
|
|
29665
|
+
"name": "stack",
|
|
29666
|
+
"type": {
|
|
29667
|
+
"fqn": "constructs.Construct"
|
|
29668
|
+
}
|
|
29669
|
+
},
|
|
29670
|
+
{
|
|
29671
|
+
"name": "id",
|
|
29672
|
+
"type": {
|
|
29673
|
+
"primitive": "string"
|
|
29674
|
+
}
|
|
29675
|
+
},
|
|
29676
|
+
{
|
|
29677
|
+
"name": "documentJson",
|
|
29678
|
+
"type": {
|
|
29679
|
+
"primitive": "string"
|
|
29680
|
+
}
|
|
29681
|
+
}
|
|
29682
|
+
],
|
|
29683
|
+
"returns": {
|
|
29684
|
+
"type": {
|
|
29685
|
+
"fqn": "@cdklabs/cdk-ssm-documents.AutomationDocument"
|
|
29686
|
+
}
|
|
29687
|
+
},
|
|
29688
|
+
"static": true
|
|
29689
|
+
},
|
|
29690
|
+
{
|
|
29691
|
+
"docs": {
|
|
29692
|
+
"remarks": "You can use the returned AutomationDocument to run simulations as you would other documents created using this library.",
|
|
29693
|
+
"stability": "stable",
|
|
29694
|
+
"summary": "Create an AutomationDocument from an existing yaml string."
|
|
29695
|
+
},
|
|
29696
|
+
"locationInModule": {
|
|
29697
|
+
"filename": "src/patterns/document/string-document.ts",
|
|
29698
|
+
"line": 34
|
|
29699
|
+
},
|
|
29700
|
+
"name": "fromYaml",
|
|
29701
|
+
"parameters": [
|
|
29702
|
+
{
|
|
29703
|
+
"name": "stack",
|
|
29704
|
+
"type": {
|
|
29705
|
+
"fqn": "constructs.Construct"
|
|
29706
|
+
}
|
|
29707
|
+
},
|
|
29708
|
+
{
|
|
29709
|
+
"name": "id",
|
|
29710
|
+
"type": {
|
|
29711
|
+
"primitive": "string"
|
|
29712
|
+
}
|
|
29713
|
+
},
|
|
29714
|
+
{
|
|
29715
|
+
"name": "documentYaml",
|
|
29716
|
+
"type": {
|
|
29717
|
+
"primitive": "string"
|
|
29718
|
+
}
|
|
29719
|
+
}
|
|
29720
|
+
],
|
|
29721
|
+
"returns": {
|
|
29722
|
+
"type": {
|
|
29723
|
+
"fqn": "@cdklabs/cdk-ssm-documents.AutomationDocument"
|
|
29724
|
+
}
|
|
28462
29725
|
},
|
|
28463
|
-
"
|
|
28464
|
-
"overrides": "@cdklabs/cdk-ssm-documents.IRunDocumentLocation",
|
|
28465
|
-
"type": {
|
|
28466
|
-
"primitive": "string"
|
|
28467
|
-
}
|
|
29726
|
+
"static": true
|
|
28468
29727
|
}
|
|
28469
29728
|
],
|
|
28470
|
-
"
|
|
29729
|
+
"name": "StringDocument",
|
|
29730
|
+
"symbolId": "src/patterns/document/string-document:StringDocument"
|
|
28471
29731
|
},
|
|
28472
|
-
"@cdklabs/cdk-ssm-documents.
|
|
29732
|
+
"@cdklabs/cdk-ssm-documents.StringFormat": {
|
|
28473
29733
|
"assembly": "@cdklabs/cdk-ssm-documents",
|
|
28474
|
-
"base": "@cdklabs/cdk-ssm-documents.SecureVariable",
|
|
28475
29734
|
"docs": {
|
|
28476
|
-
"
|
|
29735
|
+
"remarks": "Example: new StringFormat(\"This %s a replacement: %s\", [new HardCodedValue(\"is\"), new ExportedVariable(\"myInput\")]);\nThe supported variable strings are either:\n1. Implicit indices: \"%s\" where the first occurrence will match the first variable, the next will match the second...\n2. Explicit indices: Example: \"%1$s\"; where \"%1$s\" matches the first variable and \"%1$s\" matches the second.\nDo not combine usage of implicit and explicit indices. Choose one per StringFormat instance.",
|
|
29736
|
+
"stability": "stable",
|
|
29737
|
+
"summary": "Replacement for strings using Java String format style \"%s\" replacements."
|
|
28477
29738
|
},
|
|
28478
|
-
"fqn": "@cdklabs/cdk-ssm-documents.
|
|
29739
|
+
"fqn": "@cdklabs/cdk-ssm-documents.StringFormat",
|
|
28479
29740
|
"initializer": {
|
|
28480
29741
|
"docs": {
|
|
28481
29742
|
"stability": "stable"
|
|
28482
29743
|
},
|
|
28483
29744
|
"locationInModule": {
|
|
28484
|
-
"filename": "src/interface/variables/
|
|
28485
|
-
"line":
|
|
29745
|
+
"filename": "src/interface/variables/string-variable.ts",
|
|
29746
|
+
"line": 67
|
|
28486
29747
|
},
|
|
28487
29748
|
"parameters": [
|
|
28488
29749
|
{
|
|
28489
|
-
"name": "
|
|
29750
|
+
"name": "format",
|
|
28490
29751
|
"type": {
|
|
28491
29752
|
"primitive": "string"
|
|
28492
29753
|
}
|
|
29754
|
+
},
|
|
29755
|
+
{
|
|
29756
|
+
"name": "variables",
|
|
29757
|
+
"optional": true,
|
|
29758
|
+
"type": {
|
|
29759
|
+
"collection": {
|
|
29760
|
+
"elementtype": {
|
|
29761
|
+
"fqn": "@cdklabs/cdk-ssm-documents.IGenericVariable"
|
|
29762
|
+
},
|
|
29763
|
+
"kind": "array"
|
|
29764
|
+
}
|
|
29765
|
+
}
|
|
28493
29766
|
}
|
|
28494
29767
|
]
|
|
28495
29768
|
},
|
|
29769
|
+
"interfaces": [
|
|
29770
|
+
"@cdklabs/cdk-ssm-documents.IStringVariable"
|
|
29771
|
+
],
|
|
28496
29772
|
"kind": "class",
|
|
28497
29773
|
"locationInModule": {
|
|
28498
|
-
"filename": "src/interface/variables/
|
|
28499
|
-
"line":
|
|
29774
|
+
"filename": "src/interface/variables/string-variable.ts",
|
|
29775
|
+
"line": 63
|
|
28500
29776
|
},
|
|
28501
29777
|
"methods": [
|
|
28502
29778
|
{
|
|
28503
29779
|
"docs": {
|
|
28504
|
-
"remarks": "This is typically in the form of {{Variable}} or the value.",
|
|
29780
|
+
"remarks": "This is typically in the form of {{ Variable }} or the value.",
|
|
28505
29781
|
"stability": "stable",
|
|
28506
29782
|
"summary": "Prints the variable in a way that SSM understands."
|
|
28507
29783
|
},
|
|
28508
29784
|
"locationInModule": {
|
|
28509
|
-
"filename": "src/interface/variables/
|
|
28510
|
-
"line":
|
|
29785
|
+
"filename": "src/interface/variables/string-variable.ts",
|
|
29786
|
+
"line": 93
|
|
28511
29787
|
},
|
|
28512
29788
|
"name": "print",
|
|
28513
|
-
"overrides": "@cdklabs/cdk-ssm-documents.
|
|
29789
|
+
"overrides": "@cdklabs/cdk-ssm-documents.IGenericVariable",
|
|
28514
29790
|
"returns": {
|
|
28515
29791
|
"type": {
|
|
28516
29792
|
"primitive": "any"
|
|
@@ -28524,11 +29800,11 @@
|
|
|
28524
29800
|
"summary": "The inputs that are required for determining the value of this variable."
|
|
28525
29801
|
},
|
|
28526
29802
|
"locationInModule": {
|
|
28527
|
-
"filename": "src/interface/variables/
|
|
28528
|
-
"line":
|
|
29803
|
+
"filename": "src/interface/variables/string-variable.ts",
|
|
29804
|
+
"line": 109
|
|
28529
29805
|
},
|
|
28530
29806
|
"name": "requiredInputs",
|
|
28531
|
-
"overrides": "@cdklabs/cdk-ssm-documents.
|
|
29807
|
+
"overrides": "@cdklabs/cdk-ssm-documents.IGenericVariable",
|
|
28532
29808
|
"returns": {
|
|
28533
29809
|
"type": {
|
|
28534
29810
|
"collection": {
|
|
@@ -28546,14 +29822,14 @@
|
|
|
28546
29822
|
"summary": "Given the execution inputs, return the resolved value of this variable."
|
|
28547
29823
|
},
|
|
28548
29824
|
"locationInModule": {
|
|
28549
|
-
"filename": "src/interface/variables/
|
|
28550
|
-
"line":
|
|
29825
|
+
"filename": "src/interface/variables/string-variable.ts",
|
|
29826
|
+
"line": 77
|
|
28551
29827
|
},
|
|
28552
29828
|
"name": "resolve",
|
|
28553
|
-
"overrides": "@cdklabs/cdk-ssm-documents.
|
|
29829
|
+
"overrides": "@cdklabs/cdk-ssm-documents.IGenericVariable",
|
|
28554
29830
|
"parameters": [
|
|
28555
29831
|
{
|
|
28556
|
-
"name": "
|
|
29832
|
+
"name": "inputs",
|
|
28557
29833
|
"type": {
|
|
28558
29834
|
"collection": {
|
|
28559
29835
|
"elementtype": {
|
|
@@ -28569,178 +29845,67 @@
|
|
|
28569
29845
|
"primitive": "any"
|
|
28570
29846
|
}
|
|
28571
29847
|
}
|
|
28572
|
-
}
|
|
28573
|
-
],
|
|
28574
|
-
"name": "SsmSecureVariable",
|
|
28575
|
-
"properties": [
|
|
28576
|
-
{
|
|
28577
|
-
"docs": {
|
|
28578
|
-
"stability": "stable"
|
|
28579
|
-
},
|
|
28580
|
-
"immutable": true,
|
|
28581
|
-
"locationInModule": {
|
|
28582
|
-
"filename": "src/interface/variables/secure-string-variable.ts",
|
|
28583
|
-
"line": 79
|
|
28584
|
-
},
|
|
28585
|
-
"name": "secureToken",
|
|
28586
|
-
"type": {
|
|
28587
|
-
"primitive": "string"
|
|
28588
|
-
}
|
|
28589
|
-
}
|
|
28590
|
-
],
|
|
28591
|
-
"symbolId": "src/interface/variables/secure-string-variable:SsmSecureVariable"
|
|
28592
|
-
},
|
|
28593
|
-
"@cdklabs/cdk-ssm-documents.Step": {
|
|
28594
|
-
"abstract": true,
|
|
28595
|
-
"assembly": "@cdklabs/cdk-ssm-documents",
|
|
28596
|
-
"base": "constructs.Construct",
|
|
28597
|
-
"docs": {
|
|
28598
|
-
"stability": "stable"
|
|
28599
|
-
},
|
|
28600
|
-
"fqn": "@cdklabs/cdk-ssm-documents.Step",
|
|
28601
|
-
"initializer": {
|
|
28602
|
-
"docs": {
|
|
28603
|
-
"stability": "stable"
|
|
28604
29848
|
},
|
|
28605
|
-
"locationInModule": {
|
|
28606
|
-
"filename": "src/parent-steps/step.ts",
|
|
28607
|
-
"line": 41
|
|
28608
|
-
},
|
|
28609
|
-
"parameters": [
|
|
28610
|
-
{
|
|
28611
|
-
"name": "scope",
|
|
28612
|
-
"type": {
|
|
28613
|
-
"fqn": "constructs.Construct"
|
|
28614
|
-
}
|
|
28615
|
-
},
|
|
28616
|
-
{
|
|
28617
|
-
"name": "id",
|
|
28618
|
-
"type": {
|
|
28619
|
-
"primitive": "string"
|
|
28620
|
-
}
|
|
28621
|
-
},
|
|
28622
|
-
{
|
|
28623
|
-
"name": "props",
|
|
28624
|
-
"type": {
|
|
28625
|
-
"fqn": "@cdklabs/cdk-ssm-documents.StepProps"
|
|
28626
|
-
}
|
|
28627
|
-
}
|
|
28628
|
-
]
|
|
28629
|
-
},
|
|
28630
|
-
"kind": "class",
|
|
28631
|
-
"locationInModule": {
|
|
28632
|
-
"filename": "src/parent-steps/step.ts",
|
|
28633
|
-
"line": 33
|
|
28634
|
-
},
|
|
28635
|
-
"methods": [
|
|
28636
29849
|
{
|
|
28637
|
-
"abstract": true,
|
|
28638
29850
|
"docs": {
|
|
28639
29851
|
"stability": "stable",
|
|
28640
|
-
"summary": "
|
|
29852
|
+
"summary": "Given the execution inputs, return the resolved value of this variable."
|
|
28641
29853
|
},
|
|
28642
29854
|
"locationInModule": {
|
|
28643
|
-
"filename": "src/
|
|
28644
|
-
"line":
|
|
29855
|
+
"filename": "src/interface/variables/string-variable.ts",
|
|
29856
|
+
"line": 117
|
|
28645
29857
|
},
|
|
28646
|
-
"name": "
|
|
28647
|
-
"
|
|
28648
|
-
|
|
28649
|
-
|
|
28650
|
-
|
|
28651
|
-
|
|
28652
|
-
|
|
28653
|
-
|
|
29858
|
+
"name": "resolveToString",
|
|
29859
|
+
"overrides": "@cdklabs/cdk-ssm-documents.IStringVariable",
|
|
29860
|
+
"parameters": [
|
|
29861
|
+
{
|
|
29862
|
+
"name": "inputs",
|
|
29863
|
+
"type": {
|
|
29864
|
+
"collection": {
|
|
29865
|
+
"elementtype": {
|
|
29866
|
+
"primitive": "any"
|
|
29867
|
+
},
|
|
29868
|
+
"kind": "map"
|
|
29869
|
+
}
|
|
28654
29870
|
}
|
|
28655
29871
|
}
|
|
28656
|
-
|
|
28657
|
-
},
|
|
28658
|
-
{
|
|
28659
|
-
"abstract": true,
|
|
28660
|
-
"docs": {
|
|
28661
|
-
"stability": "stable",
|
|
28662
|
-
"summary": "Lists the outputs that will be returned from this step."
|
|
28663
|
-
},
|
|
28664
|
-
"locationInModule": {
|
|
28665
|
-
"filename": "src/parent-steps/step.ts",
|
|
28666
|
-
"line": 55
|
|
28667
|
-
},
|
|
28668
|
-
"name": "listOutputs",
|
|
29872
|
+
],
|
|
28669
29873
|
"returns": {
|
|
28670
29874
|
"type": {
|
|
28671
|
-
"
|
|
28672
|
-
"elementtype": {
|
|
28673
|
-
"fqn": "@cdklabs/cdk-ssm-documents.Output"
|
|
28674
|
-
},
|
|
28675
|
-
"kind": "array"
|
|
28676
|
-
}
|
|
29875
|
+
"primitive": "string"
|
|
28677
29876
|
}
|
|
28678
29877
|
}
|
|
28679
29878
|
},
|
|
28680
29879
|
{
|
|
28681
|
-
"abstract": true,
|
|
28682
29880
|
"docs": {
|
|
28683
29881
|
"stability": "stable",
|
|
28684
|
-
"summary": "
|
|
29882
|
+
"summary": "JSON.stringify(variable) will implicitly invoke this variable."
|
|
28685
29883
|
},
|
|
28686
29884
|
"locationInModule": {
|
|
28687
|
-
"filename": "src/
|
|
28688
|
-
"line":
|
|
29885
|
+
"filename": "src/interface/variables/string-variable.ts",
|
|
29886
|
+
"line": 113
|
|
28689
29887
|
},
|
|
28690
|
-
"name": "
|
|
29888
|
+
"name": "toJSON",
|
|
29889
|
+
"overrides": "@cdklabs/cdk-ssm-documents.IGenericVariable",
|
|
28691
29890
|
"returns": {
|
|
28692
29891
|
"type": {
|
|
28693
|
-
"
|
|
28694
|
-
"elementtype": {
|
|
28695
|
-
"primitive": "any"
|
|
28696
|
-
},
|
|
28697
|
-
"kind": "map"
|
|
28698
|
-
}
|
|
29892
|
+
"primitive": "any"
|
|
28699
29893
|
}
|
|
28700
29894
|
}
|
|
28701
29895
|
}
|
|
28702
29896
|
],
|
|
28703
|
-
"name": "
|
|
29897
|
+
"name": "StringFormat",
|
|
28704
29898
|
"properties": [
|
|
28705
|
-
{
|
|
28706
|
-
"abstract": true,
|
|
28707
|
-
"docs": {
|
|
28708
|
-
"stability": "stable"
|
|
28709
|
-
},
|
|
28710
|
-
"immutable": true,
|
|
28711
|
-
"locationInModule": {
|
|
28712
|
-
"filename": "src/parent-steps/step.ts",
|
|
28713
|
-
"line": 39
|
|
28714
|
-
},
|
|
28715
|
-
"name": "action",
|
|
28716
|
-
"type": {
|
|
28717
|
-
"primitive": "string"
|
|
28718
|
-
}
|
|
28719
|
-
},
|
|
28720
|
-
{
|
|
28721
|
-
"docs": {
|
|
28722
|
-
"stability": "stable"
|
|
28723
|
-
},
|
|
28724
|
-
"immutable": true,
|
|
28725
|
-
"locationInModule": {
|
|
28726
|
-
"filename": "src/parent-steps/step.ts",
|
|
28727
|
-
"line": 37
|
|
28728
|
-
},
|
|
28729
|
-
"name": "inputObserver",
|
|
28730
|
-
"type": {
|
|
28731
|
-
"fqn": "@cdklabs/cdk-ssm-documents.IObserver"
|
|
28732
|
-
}
|
|
28733
|
-
},
|
|
28734
29899
|
{
|
|
28735
29900
|
"docs": {
|
|
28736
29901
|
"stability": "stable"
|
|
28737
29902
|
},
|
|
28738
29903
|
"immutable": true,
|
|
28739
29904
|
"locationInModule": {
|
|
28740
|
-
"filename": "src/
|
|
28741
|
-
"line":
|
|
29905
|
+
"filename": "src/interface/variables/string-variable.ts",
|
|
29906
|
+
"line": 64
|
|
28742
29907
|
},
|
|
28743
|
-
"name": "
|
|
29908
|
+
"name": "format",
|
|
28744
29909
|
"type": {
|
|
28745
29910
|
"primitive": "string"
|
|
28746
29911
|
}
|
|
@@ -28751,59 +29916,49 @@
|
|
|
28751
29916
|
},
|
|
28752
29917
|
"immutable": true,
|
|
28753
29918
|
"locationInModule": {
|
|
28754
|
-
"filename": "src/
|
|
28755
|
-
"line":
|
|
28756
|
-
},
|
|
28757
|
-
"name": "outputObserver",
|
|
28758
|
-
"type": {
|
|
28759
|
-
"fqn": "@cdklabs/cdk-ssm-documents.IObserver"
|
|
28760
|
-
}
|
|
28761
|
-
},
|
|
28762
|
-
{
|
|
28763
|
-
"docs": {
|
|
28764
|
-
"stability": "stable"
|
|
28765
|
-
},
|
|
28766
|
-
"immutable": true,
|
|
28767
|
-
"locationInModule": {
|
|
28768
|
-
"filename": "src/parent-steps/step.ts",
|
|
28769
|
-
"line": 36
|
|
29919
|
+
"filename": "src/interface/variables/string-variable.ts",
|
|
29920
|
+
"line": 65
|
|
28770
29921
|
},
|
|
28771
|
-
"name": "
|
|
28772
|
-
"optional": true,
|
|
29922
|
+
"name": "variables",
|
|
28773
29923
|
"type": {
|
|
28774
|
-
"
|
|
29924
|
+
"collection": {
|
|
29925
|
+
"elementtype": {
|
|
29926
|
+
"fqn": "@cdklabs/cdk-ssm-documents.IGenericVariable"
|
|
29927
|
+
},
|
|
29928
|
+
"kind": "array"
|
|
29929
|
+
}
|
|
28775
29930
|
}
|
|
28776
29931
|
}
|
|
28777
29932
|
],
|
|
28778
|
-
"symbolId": "src/
|
|
29933
|
+
"symbolId": "src/interface/variables/string-variable:StringFormat"
|
|
28779
29934
|
},
|
|
28780
|
-
"@cdklabs/cdk-ssm-documents.
|
|
29935
|
+
"@cdklabs/cdk-ssm-documents.StringInputProps": {
|
|
28781
29936
|
"assembly": "@cdklabs/cdk-ssm-documents",
|
|
28782
29937
|
"datatype": true,
|
|
28783
29938
|
"docs": {
|
|
28784
29939
|
"stability": "stable"
|
|
28785
29940
|
},
|
|
28786
|
-
"fqn": "@cdklabs/cdk-ssm-documents.
|
|
29941
|
+
"fqn": "@cdklabs/cdk-ssm-documents.StringInputProps",
|
|
28787
29942
|
"kind": "interface",
|
|
28788
29943
|
"locationInModule": {
|
|
28789
|
-
"filename": "src/
|
|
28790
|
-
"line":
|
|
29944
|
+
"filename": "src/domain/input.ts",
|
|
29945
|
+
"line": 182
|
|
28791
29946
|
},
|
|
28792
|
-
"name": "
|
|
29947
|
+
"name": "StringInputProps",
|
|
28793
29948
|
"properties": [
|
|
28794
29949
|
{
|
|
28795
29950
|
"abstract": true,
|
|
28796
29951
|
"docs": {
|
|
28797
29952
|
"default": "undefined",
|
|
28798
29953
|
"stability": "stable",
|
|
28799
|
-
"summary": "(Optional)
|
|
29954
|
+
"summary": "(Optional) Pattern that this input value must match."
|
|
28800
29955
|
},
|
|
28801
29956
|
"immutable": true,
|
|
28802
29957
|
"locationInModule": {
|
|
28803
|
-
"filename": "src/
|
|
28804
|
-
"line":
|
|
29958
|
+
"filename": "src/domain/input.ts",
|
|
29959
|
+
"line": 206
|
|
28805
29960
|
},
|
|
28806
|
-
"name": "
|
|
29961
|
+
"name": "allowedPattern",
|
|
28807
29962
|
"optional": true,
|
|
28808
29963
|
"type": {
|
|
28809
29964
|
"primitive": "string"
|
|
@@ -28812,34 +29967,39 @@
|
|
|
28812
29967
|
{
|
|
28813
29968
|
"abstract": true,
|
|
28814
29969
|
"docs": {
|
|
28815
|
-
"default": "
|
|
29970
|
+
"default": "undefined",
|
|
28816
29971
|
"stability": "stable",
|
|
28817
|
-
"summary": "(Optional)
|
|
29972
|
+
"summary": "(Optional) List of allowed values that this input may be."
|
|
28818
29973
|
},
|
|
28819
29974
|
"immutable": true,
|
|
28820
29975
|
"locationInModule": {
|
|
28821
|
-
"filename": "src/
|
|
28822
|
-
"line":
|
|
29976
|
+
"filename": "src/domain/input.ts",
|
|
29977
|
+
"line": 200
|
|
28823
29978
|
},
|
|
28824
|
-
"name": "
|
|
29979
|
+
"name": "allowedValues",
|
|
28825
29980
|
"optional": true,
|
|
28826
29981
|
"type": {
|
|
28827
|
-
"
|
|
29982
|
+
"collection": {
|
|
29983
|
+
"elementtype": {
|
|
29984
|
+
"primitive": "string"
|
|
29985
|
+
},
|
|
29986
|
+
"kind": "array"
|
|
29987
|
+
}
|
|
28828
29988
|
}
|
|
28829
29989
|
},
|
|
28830
29990
|
{
|
|
28831
29991
|
"abstract": true,
|
|
28832
29992
|
"docs": {
|
|
28833
|
-
"
|
|
29993
|
+
"default": "undefined",
|
|
28834
29994
|
"stability": "stable",
|
|
28835
|
-
"summary": "(Optional)
|
|
29995
|
+
"summary": "(Optional) Default value to use for this input if not specified when invoking the document."
|
|
28836
29996
|
},
|
|
28837
29997
|
"immutable": true,
|
|
28838
29998
|
"locationInModule": {
|
|
28839
|
-
"filename": "src/
|
|
28840
|
-
"line":
|
|
29999
|
+
"filename": "src/domain/input.ts",
|
|
30000
|
+
"line": 194
|
|
28841
30001
|
},
|
|
28842
|
-
"name": "
|
|
30002
|
+
"name": "defaultValue",
|
|
28843
30003
|
"optional": true,
|
|
28844
30004
|
"type": {
|
|
28845
30005
|
"primitive": "string"
|
|
@@ -28848,363 +30008,171 @@
|
|
|
28848
30008
|
{
|
|
28849
30009
|
"abstract": true,
|
|
28850
30010
|
"docs": {
|
|
28851
|
-
"default": "
|
|
30011
|
+
"default": "name",
|
|
28852
30012
|
"stability": "stable",
|
|
28853
|
-
"summary": "(Optional)
|
|
30013
|
+
"summary": "(Optional) The description of the input."
|
|
28854
30014
|
},
|
|
28855
30015
|
"immutable": true,
|
|
28856
30016
|
"locationInModule": {
|
|
28857
|
-
"filename": "src/
|
|
28858
|
-
"line":
|
|
30017
|
+
"filename": "src/domain/input.ts",
|
|
30018
|
+
"line": 188
|
|
28859
30019
|
},
|
|
28860
|
-
"name": "
|
|
30020
|
+
"name": "description",
|
|
28861
30021
|
"optional": true,
|
|
28862
30022
|
"type": {
|
|
28863
|
-
"
|
|
30023
|
+
"primitive": "string"
|
|
28864
30024
|
}
|
|
28865
|
-
}
|
|
28866
|
-
],
|
|
28867
|
-
"symbolId": "src/parent-steps/step:StepProps"
|
|
28868
|
-
},
|
|
28869
|
-
"@cdklabs/cdk-ssm-documents.StringDocument": {
|
|
28870
|
-
"assembly": "@cdklabs/cdk-ssm-documents",
|
|
28871
|
-
"docs": {
|
|
28872
|
-
"remarks": "Importing an existing file allows for benefiting from the simulated execution.\nThe simulated execution will run locally in the same fashion that SSM Execution would run the document.\nYou can supply mocks to the simulator and validate the calls and the flow of the document without running via SSM execution.",
|
|
28873
|
-
"stability": "stable",
|
|
28874
|
-
"summary": "This AutomationDocument supports declaring your document from an existing document (JSON/YAML String/File)."
|
|
28875
|
-
},
|
|
28876
|
-
"fqn": "@cdklabs/cdk-ssm-documents.StringDocument",
|
|
28877
|
-
"initializer": {
|
|
28878
|
-
"docs": {
|
|
28879
|
-
"stability": "stable"
|
|
28880
|
-
}
|
|
28881
|
-
},
|
|
28882
|
-
"kind": "class",
|
|
28883
|
-
"locationInModule": {
|
|
28884
|
-
"filename": "src/patterns/document/string-document.ts",
|
|
28885
|
-
"line": 14
|
|
28886
|
-
},
|
|
28887
|
-
"methods": [
|
|
28888
|
-
{
|
|
28889
|
-
"docs": {
|
|
28890
|
-
"remarks": "Note: This function will deduce whether the file is written in yaml or json based on whether it has a .yaml or .yml extention.\nYou can use the returned AutomationDocument to run simulations as you would other documents created using this library.",
|
|
28891
|
-
"stability": "stable",
|
|
28892
|
-
"summary": "Create an AutomationDocument from an existing AutomationDocument yaml or json file."
|
|
28893
|
-
},
|
|
28894
|
-
"locationInModule": {
|
|
28895
|
-
"filename": "src/patterns/document/string-document.ts",
|
|
28896
|
-
"line": 21
|
|
28897
|
-
},
|
|
28898
|
-
"name": "fromFile",
|
|
28899
|
-
"parameters": [
|
|
28900
|
-
{
|
|
28901
|
-
"name": "stack",
|
|
28902
|
-
"type": {
|
|
28903
|
-
"fqn": "constructs.Construct"
|
|
28904
|
-
}
|
|
28905
|
-
},
|
|
28906
|
-
{
|
|
28907
|
-
"name": "id",
|
|
28908
|
-
"type": {
|
|
28909
|
-
"primitive": "string"
|
|
28910
|
-
}
|
|
28911
|
-
},
|
|
28912
|
-
{
|
|
28913
|
-
"name": "documentFilePath",
|
|
28914
|
-
"type": {
|
|
28915
|
-
"primitive": "string"
|
|
28916
|
-
}
|
|
28917
|
-
}
|
|
28918
|
-
],
|
|
28919
|
-
"returns": {
|
|
28920
|
-
"type": {
|
|
28921
|
-
"fqn": "@cdklabs/cdk-ssm-documents.AutomationDocument"
|
|
28922
|
-
}
|
|
28923
|
-
},
|
|
28924
|
-
"static": true
|
|
28925
30025
|
},
|
|
28926
30026
|
{
|
|
30027
|
+
"abstract": true,
|
|
28927
30028
|
"docs": {
|
|
28928
|
-
"
|
|
30029
|
+
"default": "undefined",
|
|
28929
30030
|
"stability": "stable",
|
|
28930
|
-
"summary": "
|
|
30031
|
+
"summary": "(Optional) Maximum number of chars that this input value (string) must contain."
|
|
28931
30032
|
},
|
|
30033
|
+
"immutable": true,
|
|
28932
30034
|
"locationInModule": {
|
|
28933
|
-
"filename": "src/
|
|
28934
|
-
"line":
|
|
28935
|
-
},
|
|
28936
|
-
"name": "fromJson",
|
|
28937
|
-
"parameters": [
|
|
28938
|
-
{
|
|
28939
|
-
"name": "stack",
|
|
28940
|
-
"type": {
|
|
28941
|
-
"fqn": "constructs.Construct"
|
|
28942
|
-
}
|
|
28943
|
-
},
|
|
28944
|
-
{
|
|
28945
|
-
"name": "id",
|
|
28946
|
-
"type": {
|
|
28947
|
-
"primitive": "string"
|
|
28948
|
-
}
|
|
28949
|
-
},
|
|
28950
|
-
{
|
|
28951
|
-
"name": "documentJson",
|
|
28952
|
-
"type": {
|
|
28953
|
-
"primitive": "string"
|
|
28954
|
-
}
|
|
28955
|
-
}
|
|
28956
|
-
],
|
|
28957
|
-
"returns": {
|
|
28958
|
-
"type": {
|
|
28959
|
-
"fqn": "@cdklabs/cdk-ssm-documents.AutomationDocument"
|
|
28960
|
-
}
|
|
30035
|
+
"filename": "src/domain/input.ts",
|
|
30036
|
+
"line": 218
|
|
28961
30037
|
},
|
|
28962
|
-
"
|
|
30038
|
+
"name": "maxChars",
|
|
30039
|
+
"optional": true,
|
|
30040
|
+
"type": {
|
|
30041
|
+
"primitive": "number"
|
|
30042
|
+
}
|
|
28963
30043
|
},
|
|
28964
30044
|
{
|
|
30045
|
+
"abstract": true,
|
|
28965
30046
|
"docs": {
|
|
28966
|
-
"
|
|
30047
|
+
"default": "undefined",
|
|
28967
30048
|
"stability": "stable",
|
|
28968
|
-
"summary": "
|
|
30049
|
+
"summary": "(Optional) Minimum number of chars that this input value (string) must contain."
|
|
28969
30050
|
},
|
|
30051
|
+
"immutable": true,
|
|
28970
30052
|
"locationInModule": {
|
|
28971
|
-
"filename": "src/
|
|
28972
|
-
"line":
|
|
28973
|
-
},
|
|
28974
|
-
"name": "fromYaml",
|
|
28975
|
-
"parameters": [
|
|
28976
|
-
{
|
|
28977
|
-
"name": "stack",
|
|
28978
|
-
"type": {
|
|
28979
|
-
"fqn": "constructs.Construct"
|
|
28980
|
-
}
|
|
28981
|
-
},
|
|
28982
|
-
{
|
|
28983
|
-
"name": "id",
|
|
28984
|
-
"type": {
|
|
28985
|
-
"primitive": "string"
|
|
28986
|
-
}
|
|
28987
|
-
},
|
|
28988
|
-
{
|
|
28989
|
-
"name": "documentYaml",
|
|
28990
|
-
"type": {
|
|
28991
|
-
"primitive": "string"
|
|
28992
|
-
}
|
|
28993
|
-
}
|
|
28994
|
-
],
|
|
28995
|
-
"returns": {
|
|
28996
|
-
"type": {
|
|
28997
|
-
"fqn": "@cdklabs/cdk-ssm-documents.AutomationDocument"
|
|
28998
|
-
}
|
|
30053
|
+
"filename": "src/domain/input.ts",
|
|
30054
|
+
"line": 212
|
|
28999
30055
|
},
|
|
29000
|
-
"
|
|
30056
|
+
"name": "minChars",
|
|
30057
|
+
"optional": true,
|
|
30058
|
+
"type": {
|
|
30059
|
+
"primitive": "number"
|
|
30060
|
+
}
|
|
29001
30061
|
}
|
|
29002
30062
|
],
|
|
29003
|
-
"
|
|
29004
|
-
"symbolId": "src/patterns/document/string-document:StringDocument"
|
|
30063
|
+
"symbolId": "src/domain/input:StringInputProps"
|
|
29005
30064
|
},
|
|
29006
|
-
"@cdklabs/cdk-ssm-documents.
|
|
30065
|
+
"@cdklabs/cdk-ssm-documents.StringListInputProps": {
|
|
29007
30066
|
"assembly": "@cdklabs/cdk-ssm-documents",
|
|
30067
|
+
"datatype": true,
|
|
29008
30068
|
"docs": {
|
|
29009
|
-
"
|
|
29010
|
-
"stability": "stable",
|
|
29011
|
-
"summary": "Replacement for strings using Java String format style \"%s\" replacements."
|
|
29012
|
-
},
|
|
29013
|
-
"fqn": "@cdklabs/cdk-ssm-documents.StringFormat",
|
|
29014
|
-
"initializer": {
|
|
29015
|
-
"docs": {
|
|
29016
|
-
"stability": "stable"
|
|
29017
|
-
},
|
|
29018
|
-
"locationInModule": {
|
|
29019
|
-
"filename": "src/interface/variables/string-variable.ts",
|
|
29020
|
-
"line": 67
|
|
29021
|
-
},
|
|
29022
|
-
"parameters": [
|
|
29023
|
-
{
|
|
29024
|
-
"name": "format",
|
|
29025
|
-
"type": {
|
|
29026
|
-
"primitive": "string"
|
|
29027
|
-
}
|
|
29028
|
-
},
|
|
29029
|
-
{
|
|
29030
|
-
"name": "variables",
|
|
29031
|
-
"optional": true,
|
|
29032
|
-
"type": {
|
|
29033
|
-
"collection": {
|
|
29034
|
-
"elementtype": {
|
|
29035
|
-
"fqn": "@cdklabs/cdk-ssm-documents.IGenericVariable"
|
|
29036
|
-
},
|
|
29037
|
-
"kind": "array"
|
|
29038
|
-
}
|
|
29039
|
-
}
|
|
29040
|
-
}
|
|
29041
|
-
]
|
|
29042
|
-
},
|
|
29043
|
-
"interfaces": [
|
|
29044
|
-
"@cdklabs/cdk-ssm-documents.IStringVariable"
|
|
29045
|
-
],
|
|
29046
|
-
"kind": "class",
|
|
29047
|
-
"locationInModule": {
|
|
29048
|
-
"filename": "src/interface/variables/string-variable.ts",
|
|
29049
|
-
"line": 63
|
|
30069
|
+
"stability": "stable"
|
|
29050
30070
|
},
|
|
29051
|
-
"
|
|
29052
|
-
|
|
29053
|
-
|
|
29054
|
-
|
|
29055
|
-
|
|
29056
|
-
|
|
29057
|
-
|
|
29058
|
-
|
|
29059
|
-
"filename": "src/interface/variables/string-variable.ts",
|
|
29060
|
-
"line": 93
|
|
29061
|
-
},
|
|
29062
|
-
"name": "print",
|
|
29063
|
-
"overrides": "@cdklabs/cdk-ssm-documents.IGenericVariable",
|
|
29064
|
-
"returns": {
|
|
29065
|
-
"type": {
|
|
29066
|
-
"primitive": "any"
|
|
29067
|
-
}
|
|
29068
|
-
}
|
|
29069
|
-
},
|
|
30071
|
+
"fqn": "@cdklabs/cdk-ssm-documents.StringListInputProps",
|
|
30072
|
+
"kind": "interface",
|
|
30073
|
+
"locationInModule": {
|
|
30074
|
+
"filename": "src/domain/input.ts",
|
|
30075
|
+
"line": 287
|
|
30076
|
+
},
|
|
30077
|
+
"name": "StringListInputProps",
|
|
30078
|
+
"properties": [
|
|
29070
30079
|
{
|
|
30080
|
+
"abstract": true,
|
|
29071
30081
|
"docs": {
|
|
29072
|
-
"
|
|
30082
|
+
"default": "undefined",
|
|
29073
30083
|
"stability": "stable",
|
|
29074
|
-
"summary": "
|
|
30084
|
+
"summary": "(Optional) List of allowed values that this input may be."
|
|
29075
30085
|
},
|
|
30086
|
+
"immutable": true,
|
|
29076
30087
|
"locationInModule": {
|
|
29077
|
-
"filename": "src/
|
|
29078
|
-
"line":
|
|
30088
|
+
"filename": "src/domain/input.ts",
|
|
30089
|
+
"line": 305
|
|
29079
30090
|
},
|
|
29080
|
-
"name": "
|
|
29081
|
-
"
|
|
29082
|
-
"
|
|
29083
|
-
"
|
|
29084
|
-
"
|
|
29085
|
-
"
|
|
29086
|
-
|
|
29087
|
-
|
|
29088
|
-
"kind": "array"
|
|
29089
|
-
}
|
|
30091
|
+
"name": "allowedValues",
|
|
30092
|
+
"optional": true,
|
|
30093
|
+
"type": {
|
|
30094
|
+
"collection": {
|
|
30095
|
+
"elementtype": {
|
|
30096
|
+
"primitive": "any"
|
|
30097
|
+
},
|
|
30098
|
+
"kind": "array"
|
|
29090
30099
|
}
|
|
29091
30100
|
}
|
|
29092
30101
|
},
|
|
29093
30102
|
{
|
|
30103
|
+
"abstract": true,
|
|
29094
30104
|
"docs": {
|
|
30105
|
+
"default": "undefined",
|
|
29095
30106
|
"stability": "stable",
|
|
29096
|
-
"summary": "
|
|
30107
|
+
"summary": "(Optional) Default value to use for this input if not specified when invoking the document."
|
|
29097
30108
|
},
|
|
30109
|
+
"immutable": true,
|
|
29098
30110
|
"locationInModule": {
|
|
29099
|
-
"filename": "src/
|
|
29100
|
-
"line":
|
|
30111
|
+
"filename": "src/domain/input.ts",
|
|
30112
|
+
"line": 299
|
|
29101
30113
|
},
|
|
29102
|
-
"name": "
|
|
29103
|
-
"
|
|
29104
|
-
"
|
|
29105
|
-
|
|
29106
|
-
"name": "inputs",
|
|
29107
|
-
"type": {
|
|
29108
|
-
"collection": {
|
|
29109
|
-
"elementtype": {
|
|
29110
|
-
"primitive": "any"
|
|
29111
|
-
},
|
|
29112
|
-
"kind": "map"
|
|
29113
|
-
}
|
|
29114
|
-
}
|
|
29115
|
-
}
|
|
29116
|
-
],
|
|
29117
|
-
"returns": {
|
|
29118
|
-
"type": {
|
|
29119
|
-
"primitive": "any"
|
|
29120
|
-
}
|
|
30114
|
+
"name": "defaultValue",
|
|
30115
|
+
"optional": true,
|
|
30116
|
+
"type": {
|
|
30117
|
+
"primitive": "any"
|
|
29121
30118
|
}
|
|
29122
30119
|
},
|
|
29123
30120
|
{
|
|
30121
|
+
"abstract": true,
|
|
29124
30122
|
"docs": {
|
|
30123
|
+
"default": "name",
|
|
29125
30124
|
"stability": "stable",
|
|
29126
|
-
"summary": "
|
|
30125
|
+
"summary": "(Optional) The description of the input."
|
|
29127
30126
|
},
|
|
30127
|
+
"immutable": true,
|
|
29128
30128
|
"locationInModule": {
|
|
29129
|
-
"filename": "src/
|
|
29130
|
-
"line":
|
|
30129
|
+
"filename": "src/domain/input.ts",
|
|
30130
|
+
"line": 293
|
|
29131
30131
|
},
|
|
29132
|
-
"name": "
|
|
29133
|
-
"
|
|
29134
|
-
"
|
|
29135
|
-
|
|
29136
|
-
"name": "inputs",
|
|
29137
|
-
"type": {
|
|
29138
|
-
"collection": {
|
|
29139
|
-
"elementtype": {
|
|
29140
|
-
"primitive": "any"
|
|
29141
|
-
},
|
|
29142
|
-
"kind": "map"
|
|
29143
|
-
}
|
|
29144
|
-
}
|
|
29145
|
-
}
|
|
29146
|
-
],
|
|
29147
|
-
"returns": {
|
|
29148
|
-
"type": {
|
|
29149
|
-
"primitive": "string"
|
|
29150
|
-
}
|
|
30132
|
+
"name": "description",
|
|
30133
|
+
"optional": true,
|
|
30134
|
+
"type": {
|
|
30135
|
+
"primitive": "string"
|
|
29151
30136
|
}
|
|
29152
30137
|
},
|
|
29153
30138
|
{
|
|
30139
|
+
"abstract": true,
|
|
29154
30140
|
"docs": {
|
|
30141
|
+
"default": "undefined",
|
|
29155
30142
|
"stability": "stable",
|
|
29156
|
-
"summary": "
|
|
29157
|
-
},
|
|
29158
|
-
"locationInModule": {
|
|
29159
|
-
"filename": "src/interface/variables/string-variable.ts",
|
|
29160
|
-
"line": 113
|
|
29161
|
-
},
|
|
29162
|
-
"name": "toJSON",
|
|
29163
|
-
"overrides": "@cdklabs/cdk-ssm-documents.IGenericVariable",
|
|
29164
|
-
"returns": {
|
|
29165
|
-
"type": {
|
|
29166
|
-
"primitive": "any"
|
|
29167
|
-
}
|
|
29168
|
-
}
|
|
29169
|
-
}
|
|
29170
|
-
],
|
|
29171
|
-
"name": "StringFormat",
|
|
29172
|
-
"properties": [
|
|
29173
|
-
{
|
|
29174
|
-
"docs": {
|
|
29175
|
-
"stability": "stable"
|
|
30143
|
+
"summary": "(Optional) Maximum number of items that this input value (list) must contain."
|
|
29176
30144
|
},
|
|
29177
30145
|
"immutable": true,
|
|
29178
30146
|
"locationInModule": {
|
|
29179
|
-
"filename": "src/
|
|
29180
|
-
"line":
|
|
30147
|
+
"filename": "src/domain/input.ts",
|
|
30148
|
+
"line": 317
|
|
29181
30149
|
},
|
|
29182
|
-
"name": "
|
|
30150
|
+
"name": "maxItems",
|
|
30151
|
+
"optional": true,
|
|
29183
30152
|
"type": {
|
|
29184
|
-
"primitive": "
|
|
30153
|
+
"primitive": "number"
|
|
29185
30154
|
}
|
|
29186
30155
|
},
|
|
29187
30156
|
{
|
|
30157
|
+
"abstract": true,
|
|
29188
30158
|
"docs": {
|
|
29189
|
-
"
|
|
30159
|
+
"default": "undefined",
|
|
30160
|
+
"stability": "stable",
|
|
30161
|
+
"summary": "(Optional) Minimum number of items that this input value (list) must contain."
|
|
29190
30162
|
},
|
|
29191
30163
|
"immutable": true,
|
|
29192
30164
|
"locationInModule": {
|
|
29193
|
-
"filename": "src/
|
|
29194
|
-
"line":
|
|
30165
|
+
"filename": "src/domain/input.ts",
|
|
30166
|
+
"line": 311
|
|
29195
30167
|
},
|
|
29196
|
-
"name": "
|
|
30168
|
+
"name": "minItems",
|
|
30169
|
+
"optional": true,
|
|
29197
30170
|
"type": {
|
|
29198
|
-
"
|
|
29199
|
-
"elementtype": {
|
|
29200
|
-
"fqn": "@cdklabs/cdk-ssm-documents.IGenericVariable"
|
|
29201
|
-
},
|
|
29202
|
-
"kind": "array"
|
|
29203
|
-
}
|
|
30171
|
+
"primitive": "number"
|
|
29204
30172
|
}
|
|
29205
30173
|
}
|
|
29206
30174
|
],
|
|
29207
|
-
"symbolId": "src/
|
|
30175
|
+
"symbolId": "src/domain/input:StringListInputProps"
|
|
29208
30176
|
},
|
|
29209
30177
|
"@cdklabs/cdk-ssm-documents.StringListVariable": {
|
|
29210
30178
|
"assembly": "@cdklabs/cdk-ssm-documents",
|
|
@@ -29324,6 +30292,118 @@
|
|
|
29324
30292
|
"name": "StringListVariable",
|
|
29325
30293
|
"symbolId": "src/interface/variables/string-list-variable:StringListVariable"
|
|
29326
30294
|
},
|
|
30295
|
+
"@cdklabs/cdk-ssm-documents.StringMapInputProps": {
|
|
30296
|
+
"assembly": "@cdklabs/cdk-ssm-documents",
|
|
30297
|
+
"datatype": true,
|
|
30298
|
+
"docs": {
|
|
30299
|
+
"stability": "stable"
|
|
30300
|
+
},
|
|
30301
|
+
"fqn": "@cdklabs/cdk-ssm-documents.StringMapInputProps",
|
|
30302
|
+
"kind": "interface",
|
|
30303
|
+
"locationInModule": {
|
|
30304
|
+
"filename": "src/domain/input.ts",
|
|
30305
|
+
"line": 365
|
|
30306
|
+
},
|
|
30307
|
+
"name": "StringMapInputProps",
|
|
30308
|
+
"properties": [
|
|
30309
|
+
{
|
|
30310
|
+
"abstract": true,
|
|
30311
|
+
"docs": {
|
|
30312
|
+
"default": "undefined",
|
|
30313
|
+
"stability": "stable",
|
|
30314
|
+
"summary": "(Optional) List of allowed values that this input may be."
|
|
30315
|
+
},
|
|
30316
|
+
"immutable": true,
|
|
30317
|
+
"locationInModule": {
|
|
30318
|
+
"filename": "src/domain/input.ts",
|
|
30319
|
+
"line": 383
|
|
30320
|
+
},
|
|
30321
|
+
"name": "allowedValues",
|
|
30322
|
+
"optional": true,
|
|
30323
|
+
"type": {
|
|
30324
|
+
"collection": {
|
|
30325
|
+
"elementtype": {
|
|
30326
|
+
"primitive": "any"
|
|
30327
|
+
},
|
|
30328
|
+
"kind": "array"
|
|
30329
|
+
}
|
|
30330
|
+
}
|
|
30331
|
+
},
|
|
30332
|
+
{
|
|
30333
|
+
"abstract": true,
|
|
30334
|
+
"docs": {
|
|
30335
|
+
"default": "undefined",
|
|
30336
|
+
"stability": "stable",
|
|
30337
|
+
"summary": "(Optional) Default value to use for this input if not specified when invoking the document."
|
|
30338
|
+
},
|
|
30339
|
+
"immutable": true,
|
|
30340
|
+
"locationInModule": {
|
|
30341
|
+
"filename": "src/domain/input.ts",
|
|
30342
|
+
"line": 377
|
|
30343
|
+
},
|
|
30344
|
+
"name": "defaultValue",
|
|
30345
|
+
"optional": true,
|
|
30346
|
+
"type": {
|
|
30347
|
+
"primitive": "any"
|
|
30348
|
+
}
|
|
30349
|
+
},
|
|
30350
|
+
{
|
|
30351
|
+
"abstract": true,
|
|
30352
|
+
"docs": {
|
|
30353
|
+
"default": "name",
|
|
30354
|
+
"stability": "stable",
|
|
30355
|
+
"summary": "(Optional) The description of the input."
|
|
30356
|
+
},
|
|
30357
|
+
"immutable": true,
|
|
30358
|
+
"locationInModule": {
|
|
30359
|
+
"filename": "src/domain/input.ts",
|
|
30360
|
+
"line": 371
|
|
30361
|
+
},
|
|
30362
|
+
"name": "description",
|
|
30363
|
+
"optional": true,
|
|
30364
|
+
"type": {
|
|
30365
|
+
"primitive": "string"
|
|
30366
|
+
}
|
|
30367
|
+
},
|
|
30368
|
+
{
|
|
30369
|
+
"abstract": true,
|
|
30370
|
+
"docs": {
|
|
30371
|
+
"default": "undefined",
|
|
30372
|
+
"stability": "stable",
|
|
30373
|
+
"summary": "(Optional) Maximum number of items that this input value (list) must contain."
|
|
30374
|
+
},
|
|
30375
|
+
"immutable": true,
|
|
30376
|
+
"locationInModule": {
|
|
30377
|
+
"filename": "src/domain/input.ts",
|
|
30378
|
+
"line": 395
|
|
30379
|
+
},
|
|
30380
|
+
"name": "maxItems",
|
|
30381
|
+
"optional": true,
|
|
30382
|
+
"type": {
|
|
30383
|
+
"primitive": "number"
|
|
30384
|
+
}
|
|
30385
|
+
},
|
|
30386
|
+
{
|
|
30387
|
+
"abstract": true,
|
|
30388
|
+
"docs": {
|
|
30389
|
+
"default": "undefined",
|
|
30390
|
+
"stability": "stable",
|
|
30391
|
+
"summary": "(Optional) Minimum number of items that this input value (list) must contain."
|
|
30392
|
+
},
|
|
30393
|
+
"immutable": true,
|
|
30394
|
+
"locationInModule": {
|
|
30395
|
+
"filename": "src/domain/input.ts",
|
|
30396
|
+
"line": 389
|
|
30397
|
+
},
|
|
30398
|
+
"name": "minItems",
|
|
30399
|
+
"optional": true,
|
|
30400
|
+
"type": {
|
|
30401
|
+
"primitive": "number"
|
|
30402
|
+
}
|
|
30403
|
+
}
|
|
30404
|
+
],
|
|
30405
|
+
"symbolId": "src/domain/input:StringMapInputProps"
|
|
30406
|
+
},
|
|
29327
30407
|
"@cdklabs/cdk-ssm-documents.StringMapVariable": {
|
|
29328
30408
|
"assembly": "@cdklabs/cdk-ssm-documents",
|
|
29329
30409
|
"base": "@cdklabs/cdk-ssm-documents.GenericVariable",
|
|
@@ -29454,7 +30534,7 @@
|
|
|
29454
30534
|
"kind": "class",
|
|
29455
30535
|
"locationInModule": {
|
|
29456
30536
|
"filename": "src/patterns/automation/string-step.ts",
|
|
29457
|
-
"line":
|
|
30537
|
+
"line": 26
|
|
29458
30538
|
},
|
|
29459
30539
|
"methods": [
|
|
29460
30540
|
{
|
|
@@ -29466,7 +30546,7 @@
|
|
|
29466
30546
|
},
|
|
29467
30547
|
"locationInModule": {
|
|
29468
30548
|
"filename": "src/patterns/automation/string-step.ts",
|
|
29469
|
-
"line":
|
|
30549
|
+
"line": 44
|
|
29470
30550
|
},
|
|
29471
30551
|
"name": "fromJson",
|
|
29472
30552
|
"parameters": [
|
|
@@ -29499,7 +30579,7 @@
|
|
|
29499
30579
|
},
|
|
29500
30580
|
"locationInModule": {
|
|
29501
30581
|
"filename": "src/patterns/automation/string-step.ts",
|
|
29502
|
-
"line":
|
|
30582
|
+
"line": 54
|
|
29503
30583
|
},
|
|
29504
30584
|
"name": "fromObject",
|
|
29505
30585
|
"parameters": [
|
|
@@ -29537,7 +30617,7 @@
|
|
|
29537
30617
|
},
|
|
29538
30618
|
"locationInModule": {
|
|
29539
30619
|
"filename": "src/patterns/automation/string-step.ts",
|
|
29540
|
-
"line":
|
|
30620
|
+
"line": 34
|
|
29541
30621
|
},
|
|
29542
30622
|
"name": "fromYaml",
|
|
29543
30623
|
"parameters": [
|
|
@@ -29567,7 +30647,7 @@
|
|
|
29567
30647
|
},
|
|
29568
30648
|
"locationInModule": {
|
|
29569
30649
|
"filename": "src/patterns/automation/string-step.ts",
|
|
29570
|
-
"line":
|
|
30650
|
+
"line": 155
|
|
29571
30651
|
},
|
|
29572
30652
|
"name": "addToDocument",
|
|
29573
30653
|
"overrides": "@cdklabs/cdk-ssm-documents.CompositeAutomationStep",
|
|
@@ -30846,6 +31926,6 @@
|
|
|
30846
31926
|
"symbolId": "src/interface/webhook:WebhookImpl"
|
|
30847
31927
|
}
|
|
30848
31928
|
},
|
|
30849
|
-
"version": "0.0.
|
|
30850
|
-
"fingerprint": "
|
|
31929
|
+
"version": "0.0.16",
|
|
31930
|
+
"fingerprint": "49ELJqY7dH3eIdc/x8dq07u85lAoKmqcRrxCCUzij5M="
|
|
30851
31931
|
}
|