question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

aws-cdk-lib: CfnInclude "parameters" description misleading

See original GitHub issue

Describe 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

https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.cloudformation_include.CfnInclude.html#parameters

Issue Analytics

  • State:closed
  • Created a year ago
  • Comments:8 (3 by maintainers)

github_iconTop GitHub Comments

2reactions
jarettgrosscommented, Jul 5, 2022

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.

2reactions
peterwoodworthcommented, Jul 5, 2022

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

Read more comments on GitHub >

github_iconTop 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 >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found