Skip to content

Commit 9c93ba7

Browse files
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*
1 parent 47bc9ee commit 9c93ba7

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

packages/@aws-cdk/cloudformation-include/lib/cfn-include.ts

+5-1
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,11 @@ export interface CfnIncludeProps {
5050
* If you include a parameter here with an ID that isn't in the template,
5151
* template creation will fail and an error will be thrown.
5252
*
53-
* @default - no parameters will be replaced
53+
* If you are importing a parameter from a live stack, we cannot know the value of that
54+
* parameter. You will need to supply a value for your parameters, else the default
55+
* value will be used.
56+
*
57+
* @default - parameters will retain their original definitions
5458
*/
5559
readonly parameters?: { [parameterName: string]: any };
5660
}

0 commit comments

Comments
 (0)