aws-cdk-lib: CfnInclude "parameters" description misleading
See original GitHub issueDescribe the issue
The optional “parameters” prop states that if the prop is not provided, no parameters will be replaced. Additionally it states that if any parameter is not specified here, then it is left unmodified.
However, if the parameter has a “default” value in the template, then if that parameter is omitted from CfnInclude
, the parameter is reset to the default. It is modified from what it originally was.
The wording of the documentation sounds misleading in this case. The template is unmodified, but the parameter itself is changed.
Links
Issue Analytics
- State:
- Created a year ago
- Comments:8 (3 by maintainers)
Top Results From Across the Web
class CfnInclude (construct) · AWS CDK
Specifies parameters to be replaced by the values in this mapping. Any parameters in the template that aren't specified here will be left...
Read more >Existing Stack fails with CDK "Unexpected token _ in JSON at ...
In my case the existing template had duplicate keys in a resource property resulting in yaml error YAML parse error, this should never...
Read more >How to Provide Parameters to CfnInclude with CDK
When using CfnInclude, it's possible to provide parameters to a Cloudformation YAML file. This guide walks through how to do that.
Read more >awslabs/aws-cdk - Gitter
Hi. I'm trying to pass some parameters for CnfStack in Python but it will fail if I pass a key that is a...
Read more >Deploy AWS Amplify GraphQL Transformers with AWS CDK
I will not fully describe it here as it only consists of reading some ... 'aws-cdk-lib'; import * as cognito from 'aws-cdk-lib/aws-cognito'; ...
Read more >
Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free
Top Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
Thanks for putting up the PR! That reads great and definitely helps clarify this situation. I appreciate you taking the time to consider and review this.
I hear you guys that this is confusing to people who aren’t very familiar with our services yet. Thanks for letting me know what the exact confusion is
Check out my PR, hope this provides the necessary clarity https://github.com/aws/aws-cdk/pull/21001 @MCWoo @jarettgross