Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: clarify cfnInclude parameters #21001

Merged
merged 3 commits into from
Jul 6, 2022
Merged

docs: clarify cfnInclude parameters #21001

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b33f7d1
docs: clarify cfnInclude parameters
peterwoodworth Jul 5, 2022
f086c07
docs: clarify cfnInclude parameters
peterwoodworth Jul 5, 2022
b9132c3
Merge branch 'main' into peterwoodworth/cfnParamDocsFix
mergify[bot] Jul 6, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion packages/@aws-cdk/cloudformation-include/lib/cfn-include.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 };
}
Expand Down