npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@xmotion/aws-ssm-param-nestjs

v1.0.2

Published

AWS SSM Parameter Store Helper on NestJS application

Downloads

203

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:

  1. 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 {}
  1. 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.