Skip to content

Commit

Permalink
docs(kinesis): correct grantRead and grantWrite comments (#14707)
Browse files Browse the repository at this point in the history
This commit swaps the comments for `grantRead` and `grantWrite` so that the comments match the permissions being granted. 

No extra verification was done for this change, as it only effects comments. 

----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
  • Loading branch information
carterv committed May 17, 2021
1 parent f65d826 commit b70a5fa
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions packages/@aws-cdk/aws-kinesis/lib/stream.ts
Original file line number Diff line number Diff line change
Expand Up @@ -326,7 +326,7 @@ abstract class StreamBase extends Resource implements IStream {
public abstract readonly encryptionKey?: kms.IKey;

/**
* Grant write permissions for this stream and its contents to an IAM
* Grant read permissions for this stream and its contents to an IAM
* principal (Role/Group/User).
*
* If an encryption key is used, permission to ues the key to decrypt the
Expand All @@ -343,10 +343,10 @@ abstract class StreamBase extends Resource implements IStream {
}

/**
* Grant read permissions for this stream and its contents to an IAM
* Grant write permissions for this stream and its contents to an IAM
* principal (Role/Group/User).
*
* If an encryption key is used, permission to ues the key to decrypt the
* If an encryption key is used, permission to ues the key to encrypt the
* contents of the stream will also be granted.
*/
public grantWrite(grantee: iam.IGrantable) {
Expand Down

0 comments on commit b70a5fa

Please sign in to comment.