feat(core): Add a description of this feature to README.md in aws-cdk…

…-lib.
aws · Jul 7, 2022 · 2b6703b · 2b6703b
1 parent 13920a2
commit 2b6703b
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/packages/aws-cdk-lib/README.md b/packages/aws-cdk-lib/README.md
@@ -1019,6 +1019,16 @@ const stack = new Stack(app, 'StackName', {
 
 By default, termination protection is disabled.
 
+### Description
+
+You can add a description of the stack in the same way as `StackProps`.
+
+```ts
+const stack = new Stack(app, 'StackName', {
+  description: 'This is a description.',
+});
+```
+
 ### CfnJson
 
 `CfnJson` allows you to postpone the resolution of a JSON blob from