Wondering what’s next for npm?Check out our public roadmap! »

    aws-parameters-store
    TypeScript icon, indicating that this package has built-in type declarations

    1.0.11 • Public • Published

    aws-parameters-store

    Package for loading parameter-store values by path from AWS SSM into a JSON object

    Features

    • Gets parameters by path
    • Collects all paged results automatically
    • Built in typescript! (Built-in types)
    • Uses Promises for async use
    • Lightweight

    Installation

    npm install --save aws-parameters-store

    Getting started

    javascript

    const  paramStore  =  require( 'aws-parameters-store' );
    
    paramStore.getParams('/hello-world/config1/', { region: 'us-east-1' })
        .then( (parameters) => {
    
            // do something here
        });

    typescript

    import  getParams  from  'aws-parameters-store';
    
    getParams('/hello-world/config1/', { region: 'us-east-1' })
        .then( (parameters) => {
    
            // do something here
        });

    API

    overview

    API calls return a promise By default, JSON parameters are being evaluated

    getParams( namespace, { options }, parseJsonValues = true )

    import  getParams  from  'aws-parameters-store';
    
    getParams('/hello-world/config1/', { region: 'us-east-1' })
        .then( (parameters) => {
        
    /* parameters = {
    					feature: { 
    						authorization: true,
    						authentication: false
    					}, 
    					deployment: { 
    						  color: "blue"
    					}
    					version: "beta-27ea91f",
    					tags: ["pre-production", "beta", "rc2"]
    				} 
    */
    	.catch( (error) => console.log(error));
    
        });

    Contributing

    You are welcome to contribute and join our family =)

    License

    See the LICENSE file for license rights and limitations (Apache License, Version 2.0)

    Install

    npm i aws-parameters-store

    DownloadsWeekly Downloads

    25

    Version

    1.0.11

    License

    Apache-2.0

    Unpacked Size

    12.2 kB

    Total Files

    7

    Last publish

    Collaborators

    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar