From c03980ddd02cfb5b7cfd4748a7034091860932bb Mon Sep 17 00:00:00 2001 From: Peter Woodworth <44349620+peterwoodworth@users.noreply.github.com> Date: Wed, 6 Jul 2022 06:30:54 -0700 Subject: [PATCH] docs: clarify cfnInclude parameters (#21001) fixes #20905 ---- ### All Submissions: * [ ] 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* --- packages/@aws-cdk/cloudformation-include/lib/cfn-include.ts | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/packages/@aws-cdk/cloudformation-include/lib/cfn-include.ts b/packages/@aws-cdk/cloudformation-include/lib/cfn-include.ts index 2dcc4ee6b32e3..238118f20ab51 100644 --- a/packages/@aws-cdk/cloudformation-include/lib/cfn-include.ts +++ b/packages/@aws-cdk/cloudformation-include/lib/cfn-include.ts @@ -50,7 +50,11 @@ export interface CfnIncludeProps { * If you include a parameter here with an ID that isn't in the template, * template creation will fail and an error will be thrown. * - * @default - no parameters will be replaced + * If you are importing a parameter from a live stack, we cannot know the value of that + * parameter. You will need to supply a value for your parameters, else the default + * value will be used. + * + * @default - parameters will retain their original definitions */ readonly parameters?: { [parameterName: string]: any }; }