Enhance DD_API_KEY_SECRET_ARN description with JSON support#36515
Enhance DD_API_KEY_SECRET_ARN description with JSON support#36515litianningdatadog wants to merge 2 commits intomasterfrom
Conversation
Updated the description for the DD_API_KEY_SECRET_ARN environment variable to include JSON extraction details starting from version 96.
💡 Codex ReviewWhen this new v96 behavior is published here, users following the primary Lambda setup pages still get the opposite instruction: a repo-wide search shows ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
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". |
duncanista
left a comment
There was a problem hiding this comment.
approving from serverless, lets wait on docs to approve
| | `DD_API_KEY` | The environment variable with your Datadog API key, in plaintext. **One** key environment variable is required. See [serverless CLI environment variables][7]. | | ||
| | `DD_KMS_API_KEY` | The environment variable with your Datadog API key, using KMS. **One** key environment variable is required. See [serverless CLI environment variables][7]. | | ||
| | `DD_API_KEY_SECRET_ARN` | The environment variable with your Datadog API key, using an AWS Secrets Manager secret. **One** key environment variable is required. See [serverless CLI environment variables][7]. | | ||
| | `DD_API_KEY_SECRET_ARN` | The environment variable with your Datadog API key, using an AWS Secrets Manager secret. **One** key environment variable is required. Starting v96, we can now extract the API key from a JSON-formatted Secrets Manager secret. If the secret value is a JSON object containing the field `dd_api_key` (hardcoded, not configurable), its value is used as the API key; otherwise the raw secret string is used as before. See [serverless CLI environment variables][7]. | |
There was a problem hiding this comment.
| | `DD_API_KEY_SECRET_ARN` | The environment variable with your Datadog API key, using an AWS Secrets Manager secret. **One** key environment variable is required. Starting v96, we can now extract the API key from a JSON-formatted Secrets Manager secret. If the secret value is a JSON object containing the field `dd_api_key` (hardcoded, not configurable), its value is used as the API key; otherwise the raw secret string is used as before. See [serverless CLI environment variables][7]. | | |
| | `DD_API_KEY_SECRET_ARN` | The environment variable with your Datadog API key, using an AWS Secrets Manager secret. **One** key environment variable is required. Starting with version 96, you can extract the API key from a JSON-formatted Secrets Manager secret. If the secret value is a JSON object containing the field `dd_api_key` (hardcoded, not configurable), its value is used as the API key; otherwise the raw secret string is used as the API key. See [Serverless CLI environment variables][7]. | |
What does this PR do? What is the motivation?
Merge instructions
Merge readiness:
For Datadog employees:
Your branch name MUST follow the
<name>/<description>convention and include the forward slash (/). Without this format, your pull request will not pass CI, the GitLab pipeline will not run, and you won't get a branch preview. Getting a branch preview makes it easier for us to check any issues with your PR, such as broken links.If your branch doesn't follow this format, rename it or create a new branch and PR.
[6/5/2025] Merge queue has been disabled on the documentation repo. If you have write access to the repo, the PR has been reviewed by a Documentation team member, and all of the required checks have passed, you can use the Squash and Merge button to merge the PR. If you don't have write access, or you need help, reach out in the #documentation channel in Slack.
AI assistance
Additional notes