fix(opensearchservice): use KMS Key ARN for cross-account encryption #36020
+142
−3
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
…in encryption - Add `selectKmsKeyIdentifier` method to dynamically select KMS key identifier - Support cross-account and cross-region KMS keys by using full key ARN - Maintain backward compatibility for same-account, same-region keys - Add comprehensive test cases for different KMS key scenarios - Enhance encryption at rest configuration with more robust key selection logic This change improves the flexibility of KMS key configuration for OpenSearch domains by intelligently selecting the appropriate key identifier based on the key's origin and context.
- Add example for supplying custom KMS key for encryption at rest - Include example of using cross-account KMS key for domain encryption - Improve documentation clarity for encryption configuration - Provide code snippets demonstrating key usage scenarios
github-actions
bot
added
bug
aws-cdk-automation
requested changes
Nov 12, 2025
Collaborator
There was a problem hiding this comment.
The pull request linter fails with the following errors:
❌ Fixes must contain a change to an integration test file and the resulting snapshot.
If you believe this pull request should receive an exemption, please comment and provide a justification. A comment requesting an exemption should contain the text Exemption Request. Additionally, if clarification is needed, add Clarification Request to a comment.
✅ A exemption request has been requested. Please wait for a maintainer's review.
pahud
changed the title
Contributor
Author
|
Exemption Request - we have unit tests covered. |
aws-cdk-automation
added
pr-linter/exemption-requested
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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 #36017.
Reason for this change
OpenSearch Domain construct fails when using cross-account KMS keys for encryption at rest. The construct currently uses KMS Key ID (
keyRef.keyId) which doesn't work for cross-account scenarios - OpenSearch requires the full ARN to properly identify and access keys from different accounts.This blocks users from implementing cross-account encryption patterns, which are common in enterprise multi-account architectures.
Description of changes
Added intelligent KMS key identifier selection logic that chooses between Key ID and Key ARN based on the key's account and region:
Implementation details:
selectKmsKeyIdentifier()private method to Domain classStack.of()andToken.isUnresolved()for account/region comparisondomain.tsto use the new selection logicThis follows the same pattern used in the DynamoDB construct for encryption key handling.
Describe any new or updated permissions being added
N/A - No new IAM permissions required. This change only affects how the KMS key identifier is passed to CloudFormation.
Description of how you validated changes
Unit tests: Added 3 comprehensive test cases:
Integration tests: All 18 OpenSearch integration tests passed with UNCHANGED snapshots, confirming no breaking changes to existing scenarios
Test results: 1,709/1,709 unit tests passed (100% pass rate)
Backward compatibility: Verified via UNCHANGED integration test snapshots - existing same-account scenarios continue to use Key ID format
Checklist
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license