Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[aws-iam] readme typos #11624

Closed
joewired opened this issue Nov 23, 2020 · 1 comment · Fixed by #11273
Closed

[aws-iam] readme typos #11624

joewired opened this issue Nov 23, 2020 · 1 comment · Fixed by #11273
Assignees
Labels
@aws-cdk/aws-iam Related to AWS Identity and Access Management documentation This is a problem with documentation. effort/small Small work item – less than a day of effort feature-request A feature should be added or improved. in-progress This issue is being actively worked on. p2

Comments

@joewired
Copy link

joewired commented Nov 23, 2020

link to reference doc page: https://docs.aws.amazon.com/cdk/api/latest/docs/aws-iam-readme.html

describe your issue: Wrong parameters for Roles > Opting out of automatic permissions management example

...
// You now have to manage the Role policies yourself
role.addToPolicy(new iam.PolicyStatement({
action: [/* whatever actions you want /],
resource: [/
whatever resources you intend to touch */],
});

should be:

// You now have to manage the Role policies yourself
role.addToPolicy(new iam.PolicyStatement({
actions: [/* whatever actions you want /],
resources: [/
whatever resources you intend to touch */],
});

It is actions and resources, not action and resource according to your interface PolicyStatementProps


This is a 📕 documentation issue

@joewired joewired added documentation This is a problem with documentation. feature-request A feature should be added or improved. needs-triage This issue or PR still needs to be triaged. labels Nov 23, 2020
@github-actions github-actions bot added the @aws-cdk/aws-iam Related to AWS Identity and Access Management label Nov 23, 2020
@rix0rrr rix0rrr added effort/small Small work item – less than a day of effort p2 labels Nov 23, 2020
@SomayaB SomayaB removed the needs-triage This issue or PR still needs to be triaged. label Nov 23, 2020
@SomayaB SomayaB changed the title [aws-iam] [aws-iam] readme typos Nov 26, 2020
@SomayaB SomayaB added the in-progress This issue is being actively worked on. label Nov 26, 2020
@mergify mergify bot closed this as completed in #11273 Nov 30, 2020
mergify bot pushed a commit that referenced this issue Nov 30, 2020
Add support in `cdk-build` to actually run `jsii-rosetta --compile --fail`
in packages that declare supporting "strict" mode for `jsii-rosetta`.
This enables a "quick" feedback loop for detecting "now-invalid" code
examples.

Turned on this feature on `@aws-cdk/core` and made the necessary
adjustments to fixtures and examples so that they now compile. In
particular:
- Made all `import` statements implicit from the examples, as they are
  all moved to the fixture. Imports from the library itself are *always
  unqualified*, and external ones are *always qualified*.
- Used `declare` statements in the fixtures to avoid having to come
  up with "real" values that compile. This is way less brittle than actually
  coming up with an initializer, especially for external types.

Also turned on this feature on `@aws-cdk/aws-iam` and made the
ajustement to fixtures and examples so that they now compile. In
particular:
- All imports to `@aws-cdk/core` are nominal and un-qualified.
- All imports to other libraries are always qualified.

Fixes #11624.

----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
@github-actions
Copy link

⚠️COMMENT VISIBILITY WARNING⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
@aws-cdk/aws-iam Related to AWS Identity and Access Management documentation This is a problem with documentation. effort/small Small work item – less than a day of effort feature-request A feature should be added or improved. in-progress This issue is being actively worked on. p2
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants