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

aws-cdk-lib: Contradiction between CDK 2 migration guide and API reference #23880

Open
robertluttrell opened this issue Jan 27, 2023 · 2 comments
Open

aws-cdk-lib: Contradiction between CDK 2 migration guide and API reference #23880

robertluttrell opened this issue Jan 27, 2023 · 2 comments
Labels
aws-cdk-lib Related to the aws-cdk-lib package bug This issue is a bug. docs/guide Related to the developer guide documentation This is a problem with documentation. effort/small Small work item – less than a day of effort p1

Comments

@robertluttrell
Copy link

robertluttrell commented Jan 27, 2023 •
edited
Loading

Describe the issue

The Migrating to AWS CDK v2 guide says, "CDK v2 does not support the legacy stack synthesizer."

The API reference for CDK v2 has documentation for the legacy synthesizer with no mention of being unsupported.

I am able to deploy stacks with CDK v2 using the legacy stack synthesizer. What does "not supported" in the migration guide mean here?

Related to #23879 - redeploying after upgrading synthesizers fails on deployment when cross-stack asset dependencies exist, but a clean deploy with the legacy synthesizer works fine in this case.

Links

https://docs.aws.amazon.com/cdk/v2/guide/migrating-v2.html

https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.LegacyStackSynthesizer.html
@robertluttrell robertluttrell added documentation This is a problem with documentation. needs-triage This issue or PR still needs to be triaged. labels Jan 27, 2023
@github-actions github-actions bot added the aws-cdk-lib Related to the aws-cdk-lib package label Jan 27, 2023
@robertluttrell robertluttrell changed the title (aws-cdk-lib): Contradiction between CDK 2 migration guide and API reference aws-cdk-lib: Contradiction between CDK 2 migration guide and API reference Jan 27, 2023
@peterwoodworth
Copy link
Contributor

Yes, the section in the devguide that says this is inaccurate:

(CDK v2 does not support the legacy stack synthesizer.)

You can use the legacy stack synthesizer in v2. However, you cannot create a legacy bootstrap stack with v2. Thanks for pointing this out!

@peterwoodworth peterwoodworth added p1 effort/small Small work item – less than a day of effort docs/guide Related to the developer guide and removed needs-triage This issue or PR still needs to be triaged. labels Feb 2, 2023
@robertluttrell
Copy link
Author

Opened a PR to remove the statement: awsdocs/aws-cdk-guide#446

@peterwoodworth peterwoodworth added the bug This issue is a bug. label May 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
aws-cdk-lib Related to the aws-cdk-lib package bug This issue is a bug. docs/guide Related to the developer guide documentation This is a problem with documentation. effort/small Small work item – less than a day of effort p1
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@peterwoodworth @robertluttrell