refactor(iam): cleanup of IAM library #2823
Merged
Conversation
This file contains 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
Various changes. BREAKING CHANGE: * **iam**: rename `ImportedResourcePrincipal` to `UnknownPrincipal`. * **iam**: `managedPolicyArns` renamed to `managedPolicies`, takes return value from `ManagedPolicy.fromAwsManagedPolicyName()`.
Remove `postProcess` from Token interface, move opting into it into `IResolvable.resolve()`, so it can be hidden from the `PolicyDocument` public interface. Make addStatements() variadic.
PolicyStatement is no longer IResolvable (doesn't need to be)
Remove AwsPrincipal, which was always an alias for ArnPrincipal
which is much clearer.
Introduce `PolicyStatement.fromAttributes({ ... })` as an
alternative to the fluent interface chaining of old `PolicyStatement`.
eladb
approved these changes
Jun 11, 2019
| /** | ||
| * Represents a statement in an IAM policy document. | ||
| */ | ||
| export class PolicyStatement implements IPolicyStatement { |
There was a problem hiding this comment.
Should we make a linter rule to enforce the usage of IPolicyStatement everywhere?
| } | ||
| } | ||
|
|
||
| /** | ||
| * Adds a statement to the policy document. | ||
| */ | ||
| public addStatement(statement: PolicyStatement) { | ||
| this.document.addStatement(statement); |
| @@ -36,12 +36,18 @@ export function resolve(obj: any, options: IResolveOptions): any { | |||
| /** | |||
| * Make a new resolution context | |||
| */ | |||
| function makeContext(appendPath?: string): IResolveContext { | |||
| function makeContext(appendPath?: string): [IResolveContext, IPostProcessor] { | |||
There was a problem hiding this comment.
Can we avoid returning a tuple, and instead return some interface? The proliferation of [0] pains me...
There was a problem hiding this comment.
It's private though.
There was a problem hiding this comment.
I still have to read all those [0] :)
rix0rrr
force-pushed
the
huijbers/iam-cleanups
branch
from
0036e3f
to
5d9ba0f
Compare
This was referenced Aug 22, 2019
This was referenced Dec 12, 2019
This was referenced Jan 20, 2020
This was referenced Sep 24, 2024
Open
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Various changes.
postProcessfrom Token interface, move opting into it intoIResolvable.resolve(), so it can be hidden from thePolicyDocumentpublic interface.PolicyStatement.fromAttributes({ ... })as an alternative to the fluent interface chaining of oldPolicyStatement.Plus all the breaking changes below:
BREAKING CHANGE:
PolicyStatementno longer has a fluid API, and accepts aprops object to be able to set the important fields.
ImportedResourcePrincipaltoUnknownPrincipal.managedPolicyArnsrenamed tomanagedPolicies, takesreturn value from
ManagedPolicy.fromAwsManagedPolicyName().PolicyDocument.postProcess()is now removed.PolicyDocument.addStatement()renamed toaddStatements.PolicyStatementis no longerIResolvableAwsPrincipalhas been removed, useArnPrincipalinstead.Pull Request Checklist
designfolderBy submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license.