Skip to content

Commit

Permalink
docs(ssm): doc for grantRead in IParameter is missing GetParameters (#…
Browse files Browse the repository at this point in the history
…27867)

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*
  • Loading branch information
go-to-k authored Nov 8, 2023
1 parent 610d9ac commit c02471d
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion packages/aws-cdk-lib/aws-ssm/lib/parameter.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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.
*/
Expand Down

0 comments on commit c02471d

Please sign in to comment.