Skip to content

Commit

Permalink
chore(iam): clarify policy docs (aws#29416)
Browse files Browse the repository at this point in the history
Closes aws#29398. 

@abdulkadirdere – Let me know if this clarifies things.

----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
  • Loading branch information
msambol authored Mar 15, 2024
1 parent 9ec41ad commit bbc624c
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions packages/aws-cdk-lib/aws-iam/lib/policy.ts
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

0 comments on commit bbc624c

Please sign in to comment.