serverless-operations / serverless-operations/serverless-step-functions

API Gateway - SSM api keys

Open
#320 0 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

area: api-gateway enhancement need more info
Dominant language
JavaScript
Stars
1k
Forks
220
No merged PRs in 30d

Description

This is a Bug Report

Description

Currently it is not possible to use api keys from SSM. Normally this syntax works for lambdas

apiKeys:
  - name:  myApiKey
    value: ${ssm:/apiKey}

But when we use it for step functions the following error is thrown

API Keys must be strings

It would be nice to add support for ssm keys since they are preserved after stack removals so no need to update the keys in the client when the stack is fully restarted

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by tracing how the step-functions API key configuration handles the ${ssm:/apiKey} value, then reproduce the issue with the configuration shown in the report. Done means an SSM-backed API key is accepted without the “API Keys must be strings” error and remains usable after stack removal and restart.

Written by the indexing model from the issue text.

Assessment

Tech stack
aws, javascript
Domain
api, cloud
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.