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

docs(lambda): Document recent changes to vpcSubnets property #21572

Merged
merged 2 commits into from
Aug 12, 2022

Conversation

laurelmay
Copy link
Contributor

Recently, the Function construct was changed to raise an error if
vpcSubnets was specified but vpc wasn't; however, this change was
not properly reflected in the documentation for the function. The change
itself was made in #21369.

Closes #21565


All Submissions:

Adding new Unconventional Dependencies:

  • This PR adds new unconventional dependencies following the process described here

New Features

  • Have you added the new feature to an integration test?
    • Did you use yarn integ to deploy the infrastructure and generate the snapshot (i.e. yarn integ without --dry-run)?

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

Recently, the Function construct was changed to raise an error if
`vpcSubnets` was specified but `vpc` wasn't; however, this change was
not properly reflected in the documentation for the function. The change
itself was made in aws#21369.

Closes aws#21565
@gitpod-io
Copy link

gitpod-io bot commented Aug 12, 2022

@github-actions github-actions bot added bug This issue is a bug. p2 labels Aug 12, 2022
@aws-cdk-automation aws-cdk-automation requested a review from a team August 12, 2022 05:05
@laurelmay
Copy link
Contributor Author

If documentation isn't sufficient and this is determined to be breaking change (it was discussed in #21369 and despite the new error being thrown, it was determined not be since it didn't result in changes to the created infrastructure) and the original PR needs to be reverted, that'd be unfortunate but understandable.

If that is the case, I'll instead open a separate issue to ask about using a warning Annotation by default in this case and using a feature flag to re-add the Error.

@mergify
Copy link
Contributor

mergify bot commented Aug 12, 2022

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
  • Commit ID: a412893
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@mergify mergify bot merged commit 6cb85a3 into aws:main Aug 12, 2022
@mergify
Copy link
Contributor

mergify bot commented Aug 12, 2022

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

josephedward pushed a commit to josephedward/aws-cdk that referenced this pull request Aug 30, 2022
…1572)

Recently, the Function construct was changed to raise an error if
`vpcSubnets` was specified but `vpc` wasn't; however, this change was
not properly reflected in the documentation for the function. The change
itself was made in aws#21369.

Closes aws#21565

----

### All Submissions:

* [X] Have you followed the guidelines in our [Contributing guide?](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md)

### Adding new Unconventional Dependencies:

* [ ] This PR adds new unconventional dependencies following the process described [here](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md/#adding-new-unconventional-dependencies)

### New Features

* [ ] Have you added the new feature to an [integration test](https://github.com/aws/aws-cdk/blob/main/INTEGRATION_TESTS.md)?
	* [ ] Did you use `yarn integ` to deploy the infrastructure and generate the snapshot (i.e. `yarn integ` without `--dry-run`)?

*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
bug This issue is a bug. p2
Projects
None yet
Development

Successfully merging this pull request may close these issues.

(lambda): vpcSubnets breaking change
3 participants