Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

(aws-codepipeline-actions): Type 'string' is not assignable to type 'S3EventSelector'. #13684

Closed
niklaswallerstedt opened this issue Mar 19, 2021 · 5 comments · Fixed by #13728
Assignees
Labels
@aws-cdk/aws-codepipeline-actions bug This issue is a bug. documentation This is a problem with documentation. effort/small Small work item – less than a day of effort good first issue Related to contributions. See CONTRIBUTING.md p2

Comments

@niklaswallerstedt
Copy link
Contributor

niklaswallerstedt commented Mar 19, 2021

Docs
(CDK v1.94.1)
https://docs.aws.amazon.com/cdk/api/latest/docs/aws-codepipeline-actions-readme.html#aws-s3-source

Using the example for setting up CloudTrail with CloudWatch Events to trigger a pipeline produces:

Type 'string' is not assignable to type 'S3EventSelector'.

trail.addS3EventSelector([sourceBucket.arnForObjects(key)], {
      ...
    });

Working with:

trail.addS3EventSelector([{
      bucket: sourceBucket,
      objectPrefix: key
    }], {
      ...
    });

This is a 📕 documentation issue

@niklaswallerstedt niklaswallerstedt added documentation This is a problem with documentation. feature-request A feature should be added or improved. needs-triage This issue or PR still needs to be triaged. labels Mar 19, 2021
@skinny85
Copy link
Contributor

Thanks for reporting @niklaswallerstedt ! Any chance of a PR fixing this? Our contribution guide: https://github.com/aws/aws-cdk/blob/master/CONTRIBUTING.md. The offending example is here: https://github.com/aws/aws-cdk/blob/master/packages/@aws-cdk/aws-codepipeline-actions/README.md#aws-s3-source

Thanks,
Adam

@skinny85 skinny85 added effort/small Small work item – less than a day of effort good first issue Related to contributions. See CONTRIBUTING.md p2 bug This issue is a bug. and removed needs-triage This issue or PR still needs to be triaged. feature-request A feature should be added or improved. labels Mar 19, 2021
@BLasan
Copy link
Contributor

BLasan commented Mar 22, 2021

@skinny85 Shall I work on this?

@niklaswallerstedt
Copy link
Contributor Author

@skinny85 made the change, noticed that the readme was missing fixtures though @BLasan

@BLasan
Copy link
Contributor

BLasan commented Mar 22, 2021

@skinny85 made the change, noticed that the readme was missing fixtures though @BLasan

Hope your PR completely will fix this issue. :)

@mergify mergify bot closed this as completed in #13728 Mar 22, 2021
mergify bot pushed a commit that referenced this issue Mar 22, 2021
…elector (#13728)

Fixes #13684


----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
@github-actions
Copy link

⚠️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.

eladb pushed a commit that referenced this issue Mar 24, 2021
…elector (#13728)

Fixes #13684


----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
hollanddd pushed a commit to hollanddd/aws-cdk that referenced this issue Aug 26, 2021
…elector (aws#13728)

Fixes aws#13684


----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
@aws-cdk/aws-codepipeline-actions bug This issue is a bug. documentation This is a problem with documentation. effort/small Small work item – less than a day of effort good first issue Related to contributions. See CONTRIBUTING.md p2
Projects
None yet
3 participants