chore(aws-iam): update aws-iam readme to include optional role descri…

…ption example (#6300) Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
aws · Feb 17, 2020 · c358498 · c358498
1 parent ea272fa
commit c358498
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/packages/@aws-cdk/aws-iam/README.md b/packages/@aws-cdk/aws-iam/README.md
@@ -87,6 +87,8 @@ permissions to trigger the expected targets, do the following:
 ```ts
 const role = new iam.Role(this, 'Role', {
  assumedBy: new iam.ServicePrincipal('codepipeline.amazonaws.com'),
+ // custom description if desired
+ description: 'This is a custom role...',
 });
 
 new codepipeline.Pipeline(this, 'Pipeline', {