-
Notifications
You must be signed in to change notification settings - Fork 3.9k
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
chore(docs): document grant* methods in IAM documentation #2782
Merged
Merged
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -26,6 +26,28 @@ Managed policies can be attached using `xxx.attachManagedPolicy(arn)`: | |
|
||
[attaching managed policies](test/example.managedpolicy.lit.ts) | ||
|
||
### Extending permissions for existing resources | ||
|
||
Many of the AWS CDK resources have `grant*` methods that allow you to grant other resources access to that resource. As an example, the following code gives a Lambda function write permissions (Put, Update, Delete) to a DynamoDB table. | ||
|
||
```typescript | ||
const fn = new lambda.Function(...); | ||
const table = new dynamodb.Table(...); | ||
|
||
table.grantWriteData(fn); | ||
``` | ||
|
||
The more generic `grant` method allows you to give specific permissions to a resource: | ||
|
||
```typescript | ||
const fn = new lambda.Function(...); | ||
const table = new dynamodb.Table(...); | ||
|
||
table.grant(fn, 'dynamodb:PutItem'); | ||
``` | ||
|
||
You can find which `grant*` methods exist for a resource in the [AWS CDK API Reference](https://docs.aws.amazon.com/cdk/api/latest/docs/aws-construct-library.html). | ||
|
||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Mention that grants accept an IGrantee which can be an IAM principal resource (like user, group, role) or a resource that implements this interface (usually resources that can assume a role, like Lambda Function, codebuild project, etc). |
||
### Configuring an ExternalId | ||
|
||
If you need to create roles that will be assumed by 3rd parties, it is generally a good idea to [require an `ExternalId` | ||
|
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Change the title to "Granting permissions on resources"?