docs(ssm): doc for grantRead in IParameter is missing GetParameters (#27867)

go-to-k · web-flow · commit c02471ddd719 · 2023-11-08T17:01:32.000Z
The doc for `grantRead` in `IParameter` is missing `GetParameters`. The `grantRead` actually grants 'ssm:GetParameters'. ```ts return iam.Grant.addToPrincipal({ grantee, actions: [ 'ssm:DescribeParameters', 'ssm:GetParameters', 'ssm:GetParameter', 'ssm:GetParameterHistory', ], ``` https://github.com/aws/aws-cdk/blob/main/packages/aws-cdk-lib/aws-ssm/lib/parameter.ts#L181-L186 ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
diff --git a/packages/aws-cdk-lib/aws-ssm/lib/parameter.ts b/packages/aws-cdk-lib/aws-ssm/lib/parameter.ts
@@ -33,7 +33,7 @@ export interface IParameter extends IResource {
   readonly parameterType: string;
 
   /**
-   * Grants read (DescribeParameter, GetParameter, GetParameterHistory) permissions on the SSM Parameter.
+   * Grants read (DescribeParameter, GetParameters, GetParameter, GetParameterHistory) permissions on the SSM Parameter.
    *
    * @param grantee the role to be granted read-only access to the parameter.
    */

Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,7 @@ export interface IParameter extends IResource {`
`33`	`33`	`readonly parameterType: string;`
`34`	`34`
`35`	`35`	`/**`
`36`		`- * Grants read (DescribeParameter, GetParameter, GetParameterHistory) permissions on the SSM Parameter.`
	`36`	`+ * Grants read (DescribeParameter, GetParameters, GetParameter, GetParameterHistory) permissions on the SSM Parameter.`
`37`	`37`	`*`
`38`	`38`	`* @param grantee the role to be granted read-only access to the parameter.`
`39`	`39`	`*/`