Skip to content

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

@jarettgross

Description

@jarettgross

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

Metadata

Metadata

Labels

aws-cdk-libRelated to the aws-cdk-lib packagedocumentationThis is a problem with documentation.

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions