{"id":28305779,"url":"https://github.com/essential2189/nestjs-parameter-store","last_synced_at":"2026-04-17T10:08:48.647Z","repository":{"id":159810729,"uuid":"634872346","full_name":"essential2189/nestjs-parameter-store","owner":"essential2189","description":"NestJS Parameter Store","archived":false,"fork":false,"pushed_at":"2023-05-02T01:12:44.000Z","size":129,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"v1.x","last_synced_at":"2025-06-23T02:40:17.009Z","etag":null,"topics":["aws","nestjs","param-store","parameter-store"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/nestjs-parameter-store","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/essential2189.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":"2023-05-01T12:33:36.000Z","updated_at":"2023-05-01T13:38:22.000Z","dependencies_parsed_at":null,"dependency_job_id":"25c50b83-deeb-45fb-b8ff-a93b1e2f5cb3","html_url":"https://github.com/essential2189/nestjs-parameter-store","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/essential2189/nestjs-parameter-store","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/essential2189%2Fnestjs-parameter-store","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/essential2189%2Fnestjs-parameter-store/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/essential2189%2Fnestjs-parameter-store/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/essential2189%2Fnestjs-parameter-store/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/essential2189","download_url":"https://codeload.github.com/essential2189/nestjs-parameter-store/tar.gz/refs/heads/v1.x","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/essential2189%2Fnestjs-parameter-store/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266983434,"owners_count":24016554,"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","status":"online","status_checked_at":"2025-07-25T02:00:09.625Z","response_time":70,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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","nestjs","param-store","parameter-store"],"created_at":"2025-05-24T02:14:23.077Z","updated_at":"2026-04-17T10:08:48.573Z","avatar_url":"https://github.com/essential2189.png","language":"TypeScript","readme":"\u003c!-- PROJECT LOGO --\u003e\n\u003cbr /\u003e\n\u003cdiv align=\"center\"\u003e\n\u003ch2\u003enestjs-parameter-store\u003c/h2\u003e\n\n  \u003cp align=\"center\"\u003e\n    NestJS AWS Parameter Store \u0026middot; \u003ca href=\"https://badge.fury.io/js/nestjs-parameter-store\"\u003e\u003cimg src=\"https://badge.fury.io/js/nestjs-parameter-store.svg\" alt=\"npm version\" height=\"18\"\u003e\u003c/a\u003e\n    \u003cbr\u003e\n    Use nestjs managed \u003ca href=\"https://docs.aws.amazon.com/ko_kr/systems-manager/latest/userguide/what-is-systems-manager.html\"\u003eAWS Systems Manager\u003c/a\u003e.\n  \u003c/p\u003e\n\u003c/div\u003e\n\n\u003cbr\u003e\n\n\u003c!-- TABLE OF CONTENTS --\u003e\n\n## Table of Contents\n\n\u003col\u003e\n  \u003cli\u003e\u003ca href=\"#installation\"\u003eInstallation\u003c/a\u003e\u003c/li\u003e\n  \u003cli\u003e\u003ca href=\"#configuration\"\u003eConfiguration\u003c/a\u003e\u003c/li\u003e\n  \u003cli\u003e\u003ca href=\"#service\"\u003eService\u003c/a\u003e\u003c/li\u003e\n  \u003cli\u003e\u003ca href=\"#license\"\u003eLicense\u003c/a\u003e\u003c/li\u003e\n\u003c/ol\u003e\n\n\u003c!-- INSTALLATION --\u003e\n\n## Installation\n\n```sh\nnpm install nestjs-parameter-store @aws-sdk/client-ssm\n\npnpm install nestjs-parameter-store @aws-sdk/client-ssm\n```\n\n## Configuration\n\nConfigure the module `forRoot()` or `forRootAsync()` to access all the\nAWS System Manager service in production.\n\nConfigure the module `registerParamStore()` or `registerParamStoreAsync()` to\nloaded all the parameters in AWS Parameter Store in production using `@Inject(GET_PARAMETERS)`\n\n### Static configuration\n\n```typescript\nimport {Module} from \"@nestjs/common\";\nimport {NestjsParameterStoreModule} from \"nestjs-parameter-store\";\n\n@Module({\n    imports: [\n        NestjsParameterStoreModule.forRoot({region: \"region\"}),\n        NestjsParameterStoreModule.registerParamStore({\n            Path: \"/test\",\n            Recursive: true,\n            WithDecryption: true,\n        }),\n    ],\n})\nexport class AppModule {\n}\n```\n\n### Async configuration\n\n```typescript\nimport {Module} from \"@nestjs/common\";\nimport {NestjsParameterStoreModule} from \"nestjs-parameter-store\";\n\n@Module({\n    imports: [\n        NestjsParameterStoreModule.forRootAsync({\n            imports: [ConfigModule],\n            inject: [ConfigService],\n            useFactory: async (config: ConfigService) =\u003e {\n                const {region, accessKeyId, secretAccessKey} = config.get(\"aws\");\n                return {region, accessKeyId, secretAccessKey};\n            },\n        }),\n        NestjsParameterStoreModule.registerParamStoreAsync({\n            imports: [ConfigModule],\n            inject: [ConfigService],\n            useFactory: async (config: ConfigService) =\u003e {\n                const {path} = config.get(\"aws-param-store\");\n                return {Path: path, Recursive: true, WithDecryption: true};\n            },\n        }),\n    ],\n})\nexport class AppModule {\n}\n```\n\n## Service\n\nThis module exposes the following services.\n\n### AwsParamStoreService\n\nThe `AwsParamStoreService` allows you to access the configuration loaded from AWS Parameter Store. Use its own class\nname as the injection token.\n\nThe `AwsParamStoreService` exposes the following methods:\n\n- getParameter({ Name: String, WithDecryption: Boolean })\n- getParameters({ Name: String[], WithDecryption: Boolean })\n- getParametersByPath({ Path: String, Recursive: boolean, WithDecryption: boolean, OnlyValue: boolean })\n\nYou can use `OnlyValue` option to get the object like `{ [parameter name]: [value], ... }`.\n```typescript\nimport {Injectable} from \"@nestjs/common\";\nimport {AwsParamStoreService} from \"nestjs-parameter-store\";\n\n@Injectable()\nexport class TestService {\n    constructor(private readonly awsParameterStore: AwsParameterStore) {\n        console.log(awsParamStoreService.getParameter({Name: \"/test/parameter\"}));\n        console.log(\n            awsParamStoreService.getParameters({\n                Names: [\"/test/parameter\", \"/test/secure\"],\n                WithDecryption: true,\n            }),\n        );\n        console.log(\n            awsParamStoreService.getParametersByPath({\n                Path: \"/test\",\n                Recursive: true,\n                WithDecryption: true,\n                OnlyValue: true,\n            }),\n        );\n    }\n}\n```\n\n### GET_PARAMETERS\n\nYou can access the parameters loaded from the Parameter Store by configuration `registerParamStore()`\nor `registerParamStoreAsync()`\n\n`@Inject(GET_PARAMETERS)` is functionally the same as `getParametersByPath()`.\n\n```typescript\nimport {Inject, Injectable} from \"@nestjs/common\";\nimport {GET_PARAMETERS} from \"nestjs-parameter-store\";\nimport {Parameter} from \"@aws-sdk/client-ssm\";\n\n@Injectable()\nexport class ParameterStoreService {\n    constructor(@Inject(GET_PARAMETERS) private readonly parameters: Parameter[]) {\n        console.log(parameters)\n    }\n}\n```\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fessential2189%2Fnestjs-parameter-store","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fessential2189%2Fnestjs-parameter-store","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fessential2189%2Fnestjs-parameter-store/lists"}