S3: Incorrect @see references in bucket.ts

[joostvanderborg]

Describe the issue

The docstring for 'addEventNotification' in

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

Line 347 in 7f378b6

* @see https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html#notification-how-to-filtering

and

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

Line 898 in 7f378b6

* @see https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html#notification-how-to-filtering

references https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html#notification-how-to-filtering

This url redirects to a different page now. https://docs.aws.amazon.com/AmazonS3/latest/userguide/notification-how-to-filtering.html seems to have the documentation that should be referenced.

Links

https://docs.aws.amazon.com/AmazonS3/latest/userguide/notification-how-to-filtering.html

[pahud]

Hi @joostvanderborg,

Thanks for reporting this issue!

You are correct, the @see links in the JSDoc for the addEventNotification method in packages/aws-cdk-lib/aws-s3/lib/bucket.ts point to outdated AWS documentation URLs that now redirect.

The correct URL for the S3 notification filtering documentation is indeed:
https://docs.aws.amazon.com/AmazonS3/latest/userguide/notification-how-to-filtering.html

This is a documentation issue requiring updates to the source code comments in the bucket.ts file at both locations where addEventNotification is documented (the interface and the class implementation).

We encourage contributions! If you'd like to help fix this, please feel free to open a Pull Request to update these URLs.

Thanks again for helping improve the AWS CDK!

[github-actions]

Comments on closed issues and PRs are hard for our team to see.
If you need help, please open a new issue that references this one.

[github-actions]

Comments on closed issues and PRs are hard for our team to see.
If you need help, please open a new issue that references this one.