Add Serverless Framework Plugin support for AWS SSM API Key#653
Merged
Conversation
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 82f88e14e6
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
estherk15
approved these changes
Jan 21, 2026
ava-silver
reviewed
Jan 23, 2026
| | `apiKey` | [Datadog API key][7]. This parameter is required when collecting telemetry using the Datadog Lambda Extension. Alternatively, you can also set the `DATADOG_API_KEY` environment variable in your deployment environment. | | ||
| | `appKey` | Datadog app key. Only needed when the `monitors` field is defined. Alternatively, you can also set the `DATADOG_APP_KEY` environment variable in your deployment environment. | | ||
| | `apiKeySecretArn` | An alternative to using the `apiKey` field. The ARN of the secret that is storing the Datadog API key in AWS Secrets Manager. Remember to add the `secretsmanager:GetSecretValue` permission to the Lambda execution role. | | ||
| | `apiKeySecretArn` | An alternative to using the `apiKey` field. The ARN of the secret that is storing the Datadog API key in AWS Secrets Manager. Remember to add the `secretsmanager:GetSecretValue` permission to the Lambda execution role. Note: Not supported for Node.js runtimes when using synchronous metrics (when `addExtension` and `flushMetricsToLogs` are both `false`). | |
Contributor
There was a problem hiding this comment.
we clarified that the nodejs synchronous metrics should be supported now, right? it feels like we shouldn't add it to the readme since we'll be removing it from code soon anyways
| | `appKey` | Datadog app key. Only needed when the `monitors` field is defined. Alternatively, you can also set the `DATADOG_APP_KEY` environment variable in your deployment environment. | | ||
| | `apiKeySecretArn` | An alternative to using the `apiKey` field. The ARN of the secret that is storing the Datadog API key in AWS Secrets Manager. Remember to add the `secretsmanager:GetSecretValue` permission to the Lambda execution role. | | ||
| | `apiKeySecretArn` | An alternative to using the `apiKey` field. The ARN of the secret that is storing the Datadog API key in AWS Secrets Manager. Remember to add the `secretsmanager:GetSecretValue` permission to the Lambda execution role. Note: Not supported for Node.js runtimes when using synchronous metrics (when `addExtension` and `flushMetricsToLogs` are both `false`). | | ||
| | `apiKeySsmArn` | An alternative to using the `apiKey` field. The ARN of the parameter that is storing the Datadog API key in AWS Systems Manager Parameter Store. Remember to add the `ssm:GetParameter` permission to the Lambda execution role. | |
Contributor
There was a problem hiding this comment.
do we wanna add a disclaimer about the additional permission for securestring as well?
Co-authored-by: Ava Silver <ava.silver@datadoghq.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What and why?
Add DD_API_KEY_SSM_ARN env var to Serverless Framework Plugin to support AWS SSM Parameter ARN (e.g.,
arn:aws:ssm:region:account:parameter/path) to use a SecretString you must setssm:GetParameterandkms:Decrypt(for encrypted SecureString parameters) IAM PermissionsHow?
Link to example lambda deploy and example trace
Testing Guidelines
Additional Notes
SVLS-7706
Types of changes
Check all that apply