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.

Sign up for GitHub

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

Jump to bottom

fix(cloudtrail): addS3EventSelector does not expose all options #1854

Merged
merged 3 commits into from
Feb 28, 2019
Merged

fix(cloudtrail): addS3EventSelector does not expose all options #1854

merged 3 commits into from
Feb 28, 2019

Conversation

RomainMuller
Copy link
Contributor

The documentation suggested one could pass an object as the second
argument to CloudTrail.addS3EventSelector, however the real argument
was ReadWriteType.

Additionally the documentation suggested incorrect uses of the API that
would lead to invalid templates being generated.

BREAKING CHANGE: The CloudTrail.addS3EventSelector accepts an options
object instead of only a ReadWriteType value.

Fixes #1841

Pull Request Checklist

  • Testing
    • Unit test added (prefer not to modify an existing test, otherwise, it's probably a breaking change)
    • CLI change?: coordinate update of integration tests with team
    • cdk-init template change?: coordinated update of integration tests with team
  • Docs
    • jsdocs: All public APIs documented
    • README: README and/or documentation topic updated
  • Title and Description
    • Change type: title prefixed with fix, feat will appear in changelog
    • Title: use lower-case and doesn't end with a period
    • Breaking?: last paragraph: "BREAKING CHANGE: <describe what changed + link for details>"
    • Issues: Indicate issues fixed via: "Fixes #xxx" or "Closes #xxx"
  • Sensitive Modules (requires 2 PR approvers)
    • IAM Policy Document (in @aws-cdk/aws-iam)
    • EC2 Security Groups and ACLs (in @aws-cdk/aws-ec2)
    • Grant APIs (only if not based on official documentation with a reference)

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license.

@RomainMuller
fix(cloudtrail): addS3EventSelector does not expose all options
0a73abd 
The documentation suggested one could pass an object as the second
argument to `CloudTrail.addS3EventSelector`, however the real argument
was `ReadWriteType`.

Additionally the documentation suggested incorrect uses of the API that
would lead to invalid templates being generated.

BREAKING CHANGE: The `CloudTrail.addS3EventSelector` accepts an options
object instead of only a `ReadWriteType` value.

Fixes #1841
@RomainMuller RomainMuller requested a review from a team as a code owner February 25, 2019 11:36
@RomainMuller RomainMuller added the pr/breaking-change This PR is a breaking change. It needs to be modified to be allowed in the current major version. label Feb 25, 2019
@RomainMuller RomainMuller merged commit 5c3431b into master Feb 28, 2019
@RomainMuller RomainMuller deleted the rmuller/issue-1841 branch February 28, 2019 09:01
@NGL321 NGL321 added the contribution/core This is a PR that came from AWS. label Sep 27, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@eladb eladb eladb approved these changes

@skinny85 skinny85 Awaiting requested review from skinny85

Assignees
No one assigned
Labels
contribution/core This is a PR that came from AWS. pr/breaking-change This PR is a breaking change. It needs to be modified to be allowed in the current major version.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

CloudTrail addS3EventSelector wrongly documented and not working
3 participants
@RomainMuller @eladb @NGL321