Skip to content

Commit

Permalink
docs: clarify cfnInclude parameters (#21001)
Browse files Browse the repository at this point in the history
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*
  • Loading branch information
peterwoodworth authored Jul 6, 2022
1 parent 47bc9ee commit 9c93ba7
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion packages/@aws-cdk/cloudformation-include/lib/cfn-include.ts
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

0 comments on commit 9c93ba7

Please sign in to comment.