Skip to content

Commit

Permalink
docs(core): clarify that addOverride does not change property casing (
Browse files Browse the repository at this point in the history
#18687)

We had a customer passing structs into `add_property_override` (in
Python) and being confused why all the keys came out with the wrong
casing.


----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
  • Loading branch information
rix0rrr authored Feb 3, 2022
1 parent d40e332 commit be0be01
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions packages/@aws-cdk/core/lib/cfn-resource.ts
Original file line number Diff line number Diff line change
Expand Up @@ -185,6 +185,12 @@ export class CfnResource extends CfnRefElement {
* }
* ```
*
* The `value` argument to `addOverride` will not be processed or translated
* in any way. Pass raw JSON values in here with the correct capitalization
* for CloudFormation. If you pass CDK classes or structs, they will be
* rendered with lowercased key names, and CloudFormation will reject the
* template.
*
* @param path - The path of the property, you can use dot notation to
* override values in complex types. Any intermdediate keys
* will be created as needed.
Expand Down

0 comments on commit be0be01

Please sign in to comment.