{"id":20750393,"url":"https://github.com/nak2k/node-ssm-params","last_synced_at":"2025-04-28T12:52:59.976Z","repository":{"id":40793376,"uuid":"85147422","full_name":"nak2k/node-ssm-params","owner":"nak2k","description":"Obtain parameters from AWS SSM Parameter Store.","archived":false,"fork":false,"pushed_at":"2023-04-18T07:38:54.000Z","size":271,"stargazers_count":7,"open_issues_count":2,"forks_count":4,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-21T10:54:26.221Z","etag":null,"topics":["aws","nodejs"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nak2k.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-03-16T03:17:50.000Z","updated_at":"2022-01-18T18:32:21.000Z","dependencies_parsed_at":"2024-06-19T13:33:47.653Z","dependency_job_id":"4931b563-3807-4f64-9923-ec309a48f682","html_url":"https://github.com/nak2k/node-ssm-params","commit_stats":{"total_commits":46,"total_committers":3,"mean_commits":"15.333333333333334","dds":"0.15217391304347827","last_synced_commit":"4390b53263b4618d4b10b3c151346f9f786eda2d"},"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nak2k%2Fnode-ssm-params","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nak2k%2Fnode-ssm-params/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nak2k%2Fnode-ssm-params/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nak2k%2Fnode-ssm-params/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nak2k","download_url":"https://codeload.github.com/nak2k/node-ssm-params/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251318742,"owners_count":21570418,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["aws","nodejs"],"created_at":"2024-11-17T08:27:09.309Z","updated_at":"2025-04-28T12:52:59.900Z","avatar_url":"https://github.com/nak2k.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ssm-params\n\nObtain parameters from AWS SSM Parameter Store.\n\n## Installation\n\n```\nnpm i ssm-params aws-sdk -S\n```\n\n## API\n\n### ssmToObj(options, callback)\n\n- `options`\n    - If this is a string, it is equivalent to specify `options.prefix` only.\n- `options.prefix`\n    - A prefix of parameter names to obtain parameters.\n- `options.target`\n    - A target object that is set values of obtained parameters.\n    - Default: `{}`\n- `options.withDecryption`\n    - If this is true, values of secure strings are decrypted.\n- `callback(err, target)`\n    - A callback which is called, when obtaining parameters have finished or an error occurs.\n    - If no error occurs, `options.target` passes into `target`.\n\n### ssmToObjByPath(options, callback)\n\n- `options`\n    - If this is a string, it is equivalent to specify `options.Path` only.\n- `options.target`\n    - A target object that is set values of obtained parameters.\n    - Default: `{}`\n- `options.nestObject`\n    - A boolean value that determines whether to make a nested object from obtained parameters.\n    - If this option is `true`, `options.Recursive` is also treated as `true`.\n    - Default: `false`\n- `options.trimPath`\n    - A boolean value that determines whether to trim the hierarchy path from the name of obtained parameters.\n    - Default: `true`\n- `options.Path`\n    - A hierarchy path to obtain parameters.\n- `options.Recursive`\n    - A boolean value that determines whether to obtain parameters recursively.\n    - Default: `false`\n- `options.WithDecryption`\n    - If this is true, values of secure strings are decrypted.\n    - Default: `false`\n- `options.ParameterFilters`\n    - An array of objects describing the conditions of the parameters to be retrieved.\n- `callback(err, target)`\n    - A callback which is called, when obtaining parameters have finished or an error occurs.\n    - If no error occurs, `options.target` passes into `target`.\n\n### ssmToEnv(prefix, [recursive,] callback)\n\nThis is equivalent to call `ssmToObj` or `ssmToObjByPath` with specifying `process.env` to a target.\n\n- `prefix`\n    - This is equivalent to `options.prefix` of `ssmToObj`.\n    - If this argument starts with '/', this function calls `ssmToObjByPath` instead of `ssmToObj`.\n- `recursive`\n    - This is equivalent to `options.Recursive` of `ssmToObjByPath`.\n- `callback(err, target)`\n    - This is equivalent to `callback` of `ssmToObj`.\n\n## Required IAM Permissions\n\n- `ssm:DescribeParameters`\n- `ssm:GetParameters`\n\n## License\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnak2k%2Fnode-ssm-params","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnak2k%2Fnode-ssm-params","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnak2k%2Fnode-ssm-params/lists"}