@xmotion/aws-ssm-param-nestjs
v1.0.2
Published
AWS SSM Parameter Store Helper on NestJS application
Downloads
203
Maintainers
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.
Installation
You can install the module using npm or yarn:
npm install @xmotion/aws-ssm-param-nestjs
or
yarn add @xmotion/aws-ssm-param-nestjs
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 } }
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.