docs(logs): fix incorrect CrossAccountDestination documentation #36593
Conversation
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
github-actions
bot
added
the
beginning-contributor
github-actions
bot
added
effort/small
aws-cdk-automation
added
the
pr/needs-community-review
gasolima
approved these changes
Jan 8, 2026
Contributor
|
Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork). |
Contributor
Merge Queue Status✅ The pull request has been merged at e29c216 This pull request spent 28 minutes 45 seconds in the queue, including 28 minutes 36 seconds running CI. Required conditions to merge
|
Contributor
|
Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork). |
Contributor
|
Comments on closed issues and PRs are hard for our team to see. |
aws-cdk-automation
removed
the
pr/needs-community-review
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Issue # (if applicable)
Closes #36585.
Reason for this change
The documentation for
CrossAccountDestinationcontained inaccurate claims about automatic creation when using theKinesisDestinationclass fromaws-cdk-lib/aws-logs-destinations. The documentation stated thatCrossAccountDestinationwould be automatically created for cross-account scenarios, but the actual implementation ofKinesisDestination.bind()only creates an IAM role and grants permissions - it does not create aCrossAccountDestinationfor cross-account usage. This was leftover documentation from when destinations were moved toaws-logs-destinationsin PR #2655.Description of changes
This PR fixes inaccurate documentation in two locations:
packages/aws-cdk-lib/aws-logs/README.md:CrossAccountDestination"must be explicitly created in the destination account".packages/aws-cdk-lib/aws-logs/lib/cross-account-destination.ts:CrossAccountDestinationclass to accurately reflect the actual behavior.These changes ensure the documentation accurately reflects the current implementation behavior. The related functionality issue (#6884) for actually implementing cross-account support remains open as a separate concern.
Describe any new or updated permissions being added
No new or updated permissions are required. This is a documentation-only change.
Description of how you validated changes
Checklist
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license