AWS - A Node In Layers Package for AWS services

This package has a number of apps that assist with using AWS.

How to Install

npm install @node-in-layers/aws

Core

The core domain provides the ability to get a configured AWS 3 client based on your configs.

import { CoreNamespace } from '@node-in-layers/core/index.js'
import { AwsNamespace, AwsService } from '@node-in-layers/aws/types.js'

// Add the aws core app so context.services[AwsNamespace.root].aws3 is available
const core = {
  apps: [import('@node-in-layers/aws/index.js')],
  layerOrder: ['services', 'features'],
}

// Optional: limit services or pass AWS client options (Aws3PartialConfig)
const awsConfig = {
  [AwsNamespace.root]: {
    services: [AwsService.s3, AwsService.ssm, AwsService.secretsManager],
    awsClientProps: { region: 'us-east-1' },
  },
}

// In a layer, use the configured client from context
// const { s3, ssm, secretsManager } = context.services[AwsNamespace.root].aws3

Config

The config app provides the ability to have configurations inside a config file that use values from Parameter store and Secrets manager. In order to do this, the config app provides a globals file, that will take your configuration object, see if there are parameter store and secrets manager objects in it. If there are, it will reach out to each of those services to find and the replace them within the config.

How To Use

Within the apps of your system's configuration:

import { CoreNamespace } from '@node-in-layers/core/index.js'

const core = {
  apps: await Promise.all([
    // Adds support for aws config files.
    import('@node-in-layers/aws/config/index.js'),
  ]),
  layerOrder: ['services', 'features', 'express'],
  logLevel: 'debug',
  logFormat: 'full',
}

export default () => ({
  systemName: 'my-example-system',
  environment: 'dev',
  [CoreNamespace.root]: core,
})

Example Config

{
  "myApp": {
    "myClient": {
      "url": "https://some-url",
      "key": {
        "type": "secretsManager",
        "key": "/path/with-in/secrets-manager"
      }
    },
    "aDynamicAwsPath": {
      "type": "parameterStore",
      "key": "/path/with-in/parameter-store"
    }
  }
}

Gets turned into...

{
  "myApp": {
    "myClient": {
      "url": "https://some-url",
      "key": "the-value-from-secrets-manager"
    },
    "aDynamicAwsPath": "the-value-from-parameter-store"
  }
}

search parameter store and secrets