aws / aws/aws-cdk

cli: document the necessary permissions needed for a successful deployment with assets

Open
#9,863 3 comments 9 reactions 0 assignees View on GitHub
documentation effort/small feature-request p2 package/tools
Dominant language
TypeScript
Stars
12.9k
Forks
4.6k
Avg merge
2d 3h
Merged PRs (30d)
83

Description

When running `cdk deploy` with as assumed role, one must configure the exact permissions this role should have. We should document exactly which policies should these role have. For example:

- `s3:GetBucketLocation`
- `s3:PutObject*`
- ...

These are probably just the permissions described here:

https://github.com/aws/aws-cdk/blob/ddd29b485d5e07c0661ce135460b34d9f2b712e9/packages/aws-cdk/lib/api/bootstrap/bootstrap-template.yaml#L289-L313

But we should bubble these up to some documentation source.

---

This is a 📕 documentation issue

Contributor guide

Open the contributing guide

Research direction

Start with the referenced packages/aws-cdk/lib/api/bootstrap/bootstrap-template.yaml lines 289-313 and the cdk deploy assumed-role scenario. Check the awsdocs/aws-cdk-guide documentation structure, then document the required deployment permissions and verify that the listed policies match the bootstrap template.

Written by the indexing model from the issue text.

Assessment

Tech stack
aws
Domain
cli, cloud, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.