lumigo-serverless-crossaccount-ssm

lumigo-serverless-crossaccount-ssm

Serverless framework plugin to access the system and secrets managers at isolated account.

Currently only AWS provider is supported.

Install

Run npm install in your Serverless project.

$ npm install --save-dev lumigo-serverless-crossaccount-ssm

Add the plugin to the top of the list at your serverless.yml file

plugins:
  - lumigo-serverless-crossaccount-ssm
  # ...

Configuration

In order to configure the account, use the custom.crossaccount-ssm object:

custom:
  crossaccount-ssm:
    profile: PROFILE_NAME # for ssm references resolution
    regions:
      - us-east-1
      - us-east-2 # failover replica
      #...

The default config in a case if nothing provided:

custom:
  crossaccount-ssm:
    profile: default
    regions:
      - us-east-1

Usage

All variables are being resolved and set through the environment during Cloudformation template generation:

service:
  name: client-demo

custom:
  crossaccount-ssm:
    profile: PROFILE
    regions:
      - MASTER_REGION
      - FAILOVER_REGION_1
      # ...
      - FAILOVER_REGION_N

provider:
  name: aws
  region: us-east-1

functions:
  client:
    description: Isolated AWS SecretsManager' secrets client
    handler: ...
    environment:
      CLIENT_SECRET: ${ssm:/aws/reference/secretsmanager/secret~true}
    package:
      include:
        - ...

plugins:
  - serverless-crossaccount-ssm

How to test

• Run npm run test:all