From bbc624cdaed8d4931a7d355c37d4986db0b0d08b Mon Sep 17 00:00:00 2001 From: Michael Sambol Date: Thu, 14 Mar 2024 18:37:43 -0600 Subject: [PATCH] chore(iam): clarify policy docs (#29416) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Closes #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* --- packages/aws-cdk-lib/aws-iam/lib/policy.ts | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/packages/aws-cdk-lib/aws-iam/lib/policy.ts b/packages/aws-cdk-lib/aws-iam/lib/policy.ts index 43c3addd72b0f..a8dd67f5fecbf 100644 --- a/packages/aws-cdk-lib/aws-iam/lib/policy.ts +++ b/packages/aws-cdk-lib/aws-iam/lib/policy.ts @@ -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 */ @@ -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 {