doc(iam): update references to addManagedPolicy (#3511)

aws · Aug 6, 2019 · fd02fc0 · fd02fc0
1 parent 75d06fd
commit fd02fc0
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 6 deletions.
diff --git a/packages/@aws-cdk/aws-iam/README.md b/packages/@aws-cdk/aws-iam/README.md
@@ -19,7 +19,7 @@ the policy either by calling `xxx.attachInlinePolicy(policy)` or `policy.attachT
 
 [attaching policies to user and group](test/example.attaching.lit.ts)
 
-Managed policies can be attached using `xxx.attachManagedPolicy(arn)`:
+Managed policies can be attached using `xxx.addManagedPolicy(ManagedPolicy.fromAwsManagedPolicyName(policyName))`:
 
 [attaching managed policies](test/example.managedpolicy.lit.ts)
 

diff --git a/packages/@aws-cdk/aws-iam/lib/group.ts b/packages/@aws-cdk/aws-iam/lib/group.ts
@@ -40,9 +40,10 @@ export interface GroupProps {
   readonly groupName?: string;
 
   /**
-   * A list managed policies associated with this role.
+   * A list of managed policies associated with this role.
    *
-   * You can add managed policies later using `attachManagedPolicy(policy)`.
+   * You can add managed policies later using
+   * `addManagedPolicy(ManagedPolicy.fromAwsManagedPolicyName(policyName))`.
    *
    * @default - No managed policies.
    */

diff --git a/packages/@aws-cdk/aws-iam/lib/role.ts b/packages/@aws-cdk/aws-iam/lib/role.ts
@@ -32,7 +32,8 @@ export interface RoleProps {
   /**
    * A list of managed policies associated with this role.
    *
-   * You can add managed policies later using `attachManagedPolicy(arn)`.
+   * You can add managed policies later using
+   * `addManagedPolicy(ManagedPolicy.fromAwsManagedPolicyName(policyName))`.
    *
    * @default - No managed policies.
    */

diff --git a/packages/@aws-cdk/aws-iam/lib/user.ts b/packages/@aws-cdk/aws-iam/lib/user.ts
@@ -24,9 +24,10 @@ export interface UserProps {
   readonly groups?: IGroup[];
 
   /**
-   * A list managed policies associated with this role.
+   * A list of managed policies associated with this role.
    *
-   * You can add managed policies later using `attachManagedPolicy(policy)`.
+   * You can add managed policies later using
+   * `addManagedPolicy(ManagedPolicy.fromAwsManagedPolicyName(policyName))`.
    *
    * @default - No managed policies.
    */