fix(iam): IEncryptedResource extends IEnvironmentAware instead of IResource
#36787
+12
−5
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
aws-cdk-automation
previously requested changes
Jan 23, 2026
mrgrain
changed the title
IEncryptedResource extends IEnvironmentAware instead of IResource
mrgrain
changed the title
IEncryptedResource extends IEnvironmentAware instead of IResourceIEncryptedResource extends IEnvironmentAware instead of IResource
mrgrain
added
pr-linter/exempt-readme
mrgrain
changed the title
IEncryptedResource extends IEnvironmentAware instead of IResourceIEncryptedResource extends IEnvironmentAware instead of IResource
rix0rrr
approved these changes
Jan 23, 2026
BREAKING CHANGE: `IEncryptedResource` now extends `IEnvironmentAware` instead of `cdk.IResource`. The `GrantableResources.isEncryptedResource()` method now requires an `IEnvironmentAware` parameter instead of `IConstruct`.
mrgrain
force-pushed
the
mrgrain/feat/aws-iam/encrypted-resource-extends-environment-aware
branch
from
1f0f1eb to
4ef156b
Compare
mrgrain
changed the title
IEncryptedResource extends IEnvironmentAware instead of IResourceIEncryptedResource extends IEnvironmentAware instead of IResource
mrgrain
changed the title
IEncryptedResource extends IEnvironmentAware instead of IResourceIEncryptedResource extends IEnvironmentAware instead of IResource
mrgrain
added
the
pr-linter/exempt-breaking-change
mrgrain
changed the title
IEncryptedResource extends IEnvironmentAware instead of IResourceIEncryptedResource extends IEnvironmentAware instead of IResource
mrgrain
changed the title
IEncryptedResource extends IEnvironmentAware instead of IResourceIEncryptedResource extends IEnvironmentAware instead of IResource
aws-cdk-automation
dismissed
their stale review
✅ Updated pull request passes all PRLinter validations. Dismissing previous PRLinter review.
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). |
mergify
bot
deleted the
mrgrain/feat/aws-iam/encrypted-resource-extends-environment-aware
branch
Contributor
Merge Queue Status✅ The pull request has been merged at 4ef156b This pull request spent 7 seconds in the queue, with no time running CI. Required conditions to merge
|
Contributor
|
Comments on closed issues and PRs are hard for our team to see. |
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.
Reason for this change
The
IEncryptedResourceinterface currently extendsIResource, which requires implementations to be full CDK resources. By changing it to extendIEnvironmentAwareinstead, we allow for more flexible implementations that only need environment information to function correctly with encryption grants.This change also aligns the
GrantableResources.isEncryptedResource()type guard to acceptIEnvironmentAwareinstead ofIConstruct, making the API more consistent with the interface it guards.Today, all AWS vended constructs that implement
IEncryptedResourcealready implementIResourcedirectly.Description of changes
IEncryptedResourceto extendIEnvironmentAwareinstead ofcdk.IResourceGrantableResources.isEncryptedResource()parameter type fromIConstructtoIEnvironmentAware[awslint:interface-extends-ref]directive as it's no longer applicableBREAKING CHANGE: Receivers of
IEncryptedResourceobjects now have fewer guarantees about the shape of the object. If you still require anIResource, change the type toIEncryptedResource & IResourceand/or add a type guard check usingResource.isResource(). Implementations ofIEncryptedResourceno longer need to implementIResourcebut must continue to implementIEnvironmentAware. SinceIResourceextendsIEnvironmentAware, there is no change for implementors. Calls toGrantableResources.isEncryptedResource()now require anIEnvironmentAwareargument instead ofIConstruct.Describe any new or updated permissions being added
N/A
Description of how you validated changes
N/A
Checklist
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license