aws_s3.Bucket: add_event_notification example doesn't work

[bencaldwell]

Describe the issue

This is the example from the docs:

# my_lambda: lambda.Function
bucket = s3.Bucket(self, "MyBucket")
bucket.add_event_notification(s3.EventType.OBJECT_CREATED, s3n.LambdaDestination(my_lambda), prefix="home/myusername/*")

cdk synth throws an error from this: TypeError: BucketBase.add_event_notification() got an unexpected keyword argument 'prefix'

The below is what I ended up having to use. Perhaps the example should be changed to something like this:

# my_lambda: lambda.Function
bucket = s3.Bucket(self, "MyBucket")
bucket.add_event_notification(s3.EventType.OBJECT_CREATED, s3n.LambdaDestination(my_lambda), s3.NotificationKeyFilter(prefix="home/myusername/*"))

Links

https://docs.aws.amazon.com/cdk/api/v2/python/aws_cdk.aws_s3/Bucket.html

[msambol]

Weird, the comment is correct here. Maybe whatever is rending the Python docs has a bug?

[bencaldwell]

That link just has {prefix: 'home/myusername/*'} - perhaps that doesn't tell what is rendering the python docs that it needs to be a list of s3.NotificationKeyFilter() objects.

[msambol]

@bencaldwell Take a look here: #8100. They mention limitations in Python doc generation.

[khushail]

Hi @bencaldwell , python and other language docs are generated by jsii-codegen and our original documentation is written in typescript.

Thanks @msambol , you are correct. That's a limitation correctly mentioned.

Here is an actual example of adding event notification in typescript- https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_s3.Bucket.html#addwbreventwbrnotificationevent-dest-filters -

public addEventNotification(event: EventType, dest: IBucketNotificationDestination, ...filters: NotificationKeyFilter[]): void

Hope that helps!

[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.