Skip to content

docs: use registerConfig in existing resource guide - #226

Open
ikenyal wants to merge 2 commits into
aws-devtools-labs:mainfrom
ikenyal:docs/register-config-guide
Open

docs: use registerConfig in existing resource guide#226
ikenyal wants to merge 2 commits into
aws-devtools-labs:mainfrom
ikenyal:docs/register-config-guide

Conversation

@ikenyal

@ikenyal ikenyal commented Jul 17, 2026

Copy link
Copy Markdown
Contributor

Problem

The existing-resource guide teaches handler.addEnvironment() for resource identifiers. This conflicts with the current API design guidance, which requires registerConfig() for resource mappings to avoid Lambda environment-variable capacity limits.

Issue #, if available: N/A

Changes

  • Replace runtime resource-configuration examples with registerConfig().
  • Explain that registered values remain available through process.env before the backend module loads.
  • Keep direct handler use for IAM grants unchanged.

Validation

  • Ran npx --yes markdown-link-check docs/guides/extending-with-existing-aws-resources.md.
  • Ran git diff --check.
  • Confirmed the examples against the current registerConfig() implementation and Lambda initialization order.

No automated tests were added because this is a documentation-only change.

Checklist

  • PR description included
  • Tests are changed or added
  • Relevant documentation is changed or added (and PR referenced)

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

@ikenyal
ikenyal requested a review from a team as a code owner July 17, 2026 19:44
@changeset-bot

changeset-bot Bot commented Jul 17, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 827b6f1

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant