Package Exports

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@xmotion/aws-ssm-param-nestjs) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

AWS System Manager - Parameter Store for NestJS

The AWS System Manager - Parameter Store for NestJS is a module that provides integration between the NestJS framework and the AWS Systems Manager Parameter Store. This module allows you to easily fetch and manage configuration parameters stored in the AWS Parameter Store within your NestJS application.

Features

Fetch configuration parameters from AWS Parameter Store.
Cache parameter values for improved performance.
Automatically reload parameter values when they are updated in the Parameter Store.
Supports both hierarchical and flat parameter structures.
Provides a simple and intuitive API for accessing parameters.
Compatible with NestJS 8, 9, 10, and 11.

Installation

You can install the module using npm or yarn:

npm install @xmotion/aws-ssm-param-nestjs

yarn add @xmotion/aws-ssm-param-nestjs

Requirements

Node.js 18 or newer
NestJS 8.x, 9.x, 10.x, or 11.x
AWS SDK v3

Usage

To use the module, follow these steps:

Import the AWSSSMParamsModule into your NestJS application module:

Static configuration

import { Module } from '@nestjs/common';
import { AWSSSMParamsModule } from '@xmotion/aws-ssm-param-nestjs';

@Module({
  imports: [
    AWSSSMParamsModule.register({
      ssmParamStorePath: '/prod/dbname',
      ssmDecryptParams: true,
      ssmClientOptions: {
        region: 'ap-southeast-1',
      },
    }),
  ],
})
export class AppModule {}

Async configuration

import { Module } from '@nestjs/common';
import { ConfigModule, ConfigService } from '@nestjs/config';
import { AWSSSMParamsModule } from '@xmotion/aws-ssm-param-nestjs';

@Module({
  imports: [
    AWSSSMParamsModule.registerAsync({
      imports: [ConfigModule],
      useFactory: async (config: ConfigService<any>) => ({
        ssmParamStorePath: config.get<string>('AWS_SSM_DBNAME'),
        ssmDecryptParams: true,
        ssmClientOptions: {
          region: config.get<string>('AWS_REGION'),
        },
      }),
      inject: [ConfigService],
    }),
  ],
})
export class AppModule {}

Import ConfigParametersService into your service and access configuration parameters in your service or provider:

import { Injectable } from '@nestjs/common';
import { ConfigParametersService } from '@xmotion/aws-ssm-param-nestjs';

@Injectable()
export class ConfigService {
  constructor(
    private readonly configParametersService: ConfigParametersService,
  ) {}

  someMethod() {
    const myParameter = this.configParametersService.get<string>('dbname');
    // Use the parameter value in your code
  }
}

Version Compatibility

NestJS Version	Support Status
NestJS 8.x	✅ Supported
NestJS 9.x	✅ Supported
NestJS 10.x	✅ Supported
NestJS 11.x	✅ Supported

Changelog

1.0.3 (Upcoming)

Added support for NestJS 11
Updated AWS SDK dependencies
Updated TypeScript to version 5.3+
Improved ESLint and Prettier configurations

1.0.2

Initial public release

Contributing

Contributions are welcome! If you find any issues or have suggestions for improvement, please create an issue or submit a pull request on the GitHub repository.

License

This module is licensed under the MIT License.