aws-s3: Bad type definition for objectsKeyPattern parameter

[azatoth]

Describe the issue

The parameter objectsKeyPattern for grantRead(identity, objectsKeyPattern?) has the type any; But it seems it needs to be a string and nothing else.
I initially thought the parameter had to be a object due to the name.

Same wrong type is found for

• grantDelete(identity, objectsKeyPattern?)
• grantPut(identity, objectsKeyPattern?)
• grantReadWrite(identity, objectsKeyPattern?)
• grantWrite(identity, objectsKeyPattern?, allowedActionPatterns?)

Incidentally grantPutAcl(identity, objectsKeyPattern?) has correct type.

Links

• https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_s3.Bucket.html#grantwbrdeleteidentity-objectskeypattern
• https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_s3.Bucket.html#grantwbrputidentity-objectskeypattern
• https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_s3.Bucket.html#grantwbrputwbraclidentity-objectskeypattern
• https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_s3.Bucket.html#grantwbrreadidentity-objectskeypattern
• https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_s3.Bucket.html#grantwbrreadwbrwriteidentity-objectskeypattern
• https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_s3.Bucket.html#grantwbrwriteidentity-objectskeypattern-allowedactionpatterns

[peterwoodworth]

on a quick look, it looks like this value is only used to pass into arnForObjects which requires a string

aws-cdk/packages/aws-cdk-lib/aws-s3/lib/bucket.ts

Line 756 in b2a895e

public arnForObjects(keyPattern: string): string {

Thanks for reporting 🙂

[github-actions]

⚠️COMMENT VISIBILITY WARNING⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.