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.

Sign up for GitHub

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(iam): clarify policy docs #29416

Merged
merged 4 commits into from
Mar 15, 2024
+5 −4
Merged

chore(iam): clarify policy docs #29416

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d8dbfab
chore(iam): clarify policy docs
msambol Mar 9, 2024
1faa205
Merge branch 'main' into 29398
paulhcsun Mar 14, 2024
089f901
Merge branch 'main' into 29398
paulhcsun Mar 14, 2024
4c06324
Merge branch 'main' into 29398
mergify[bot] Mar 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions packages/aws-cdk-lib/aws-iam/lib/policy.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,8 @@ export interface PolicyProps {
* creating invalid--and hence undeployable--CloudFormation templates.
*
* In cases where you know the policy must be created and it is actually
* an error if no statements have been added to it, you can set this to `true`.
* an error if no statements have been added to it or it remains unattached to
* an IAM identity, you can set this to `true`.
*
* @default false
*/
Expand All @@ -96,9 +97,9 @@ export interface PolicyProps {
}

/**
* The AWS::IAM::Policy resource associates an IAM policy with IAM users, roles,
* or groups. For more information about IAM policies, see [Overview of IAM
* Policies](http://docs.aws.amazon.com/IAM/latest/UserGuide/policies_overview.html)
* The AWS::IAM::Policy resource associates an [inline](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#inline)
* IAM policy with IAM users, roles, or groups. For more information about IAM policies, see
* [Overview of IAM Policies](http://docs.aws.amazon.com/IAM/latest/UserGuide/policies_overview.html)
* in the IAM User Guide guide.
*/
export class Policy extends Resource implements IPolicy, IGrantable {
Expand Down