-
Notifications
You must be signed in to change notification settings - Fork 2.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore(overrides): add README to "overrides" example
The README explains that the example does not end up in a deployable state. Also slighly edit example to use some of the nicer new features. Fixes #68.
- Loading branch information
Showing
2 changed files
with
24 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
Resource Override Example | ||
========================= | ||
|
||
This example shows the use of the resource overrides ("escape hatch") mechanism. | ||
We add an `AWS::S3::Bucket` resource, and then proceed to change the properties | ||
of the underlying CloudFormation resource. | ||
|
||
There are two steps: | ||
|
||
* Access the underlying CloudFormation resource by using | ||
`construct.node.defaultChild` or `construct.node.findChild()`. | ||
* Change the resource by the various `add[Property]Override()` methods, | ||
or assigning to properties or `cfnOptions`. | ||
|
||
**NOTE** The point is to show how to change various aspects of the generated | ||
CloudFormation template. The end result is a template that cannot be succesfully | ||
deployed! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters