AWS cdk documentation change

Service: cdk · 2025-05-10 · Documentation low

File: cdk/v2/guide/ref-cli-cmd-deploy.md

Summary

Updated CLI command syntax formatting (backticks to angle brackets) and minor typo fixes in parameter documentation

Security assessment

Changes are purely syntactic (formatting CLI parameters) and typo corrections. No security-related content was added or modified.

Diff

diff --git a/cdk/v2/guide/ref-cli-cmd-deploy.md b/cdk/v2/guide/ref-cli-cmd-deploy.md
index 0cfa91558..c38872567 100644
--- a//cdk/v2/guide/ref-cli-cmd-deploy.md
+++ b//cdk/v2/guide/ref-cli-cmd-deploy.md
@@ -9 +9 @@ This is the AWS CDK v2 Developer Guide. The older CDK v1 entered maintenance on
-# cdk deploy
+# `cdk deploy`
@@ -37 +37 @@ For a list of global options that work with all CDK CLI commands, see [Global op
-`--all `BOOLEAN``
+`--all <BOOLEAN>`
@@ -44 +44 @@ _Default value_ : `false`
-`--asset-parallelism `BOOLEAN``
+`--asset-parallelism <BOOLEAN>`
@@ -49 +49 @@ Specify whether to build and publish assets in parallel.
-`--asset-prebuild `BOOLEAN``
+`--asset-prebuild <BOOLEAN>`
@@ -56 +56 @@ _Default value_ : `true`
-`--build-exclude, -E `ARRAY``
+`--build-exclude, -E <ARRAY>`
@@ -65 +65 @@ _Default value_ : `[]`
-`--change-set-name `STRING``
+`--change-set-name <STRING>`
@@ -72 +72 @@ This option is not compatible with `--method='direct'`.
-`--concurrency `NUMBER``
+`--concurrency <NUMBER>`
@@ -81 +81 @@ _Default value_ : `1`
-`--exclusively, -e `BOOLEAN``
+`--exclusively, -e <BOOLEAN>`
@@ -84 +84 @@ _Default value_ : `1`
-Only deploy requested stacks and don't include dependencies.
+Only deploy requested stacks and don’t include dependencies.
@@ -86 +86 @@ Only deploy requested stacks and don't include dependencies.
-`--force, -f `BOOLEAN``
+`--force, -f <BOOLEAN>`
@@ -95 +95 @@ _Default value_ : `false`
-`--help, -h `BOOLEAN``
+`--help, -h <BOOLEAN>`
@@ -100 +100 @@ Show command reference information for the `cdk deploy` command.
-`--hotswap `BOOLEAN``
+`--hotswap <BOOLEAN>`
@@ -164 +164 @@ _Default value_ : `false`
-`--hotswap-fallback `BOOLEAN``
+`--hotswap-fallback <BOOLEAN>`
@@ -173 +173 @@ _Default value_ : `false`
-`--ignore-no-stacks `BOOLEAN``
+`--ignore-no-stacks <BOOLEAN>`
@@ -182 +182 @@ _Default value_ : `false`
-`--import-existing-resources `BOOLEAN``
+`--import-existing-resources <BOOLEAN>`
@@ -199 +199 @@ For more information on using this option, see [Import existing resources](https
-`--logs `BOOLEAN``
+`--logs <BOOLEAN>`
@@ -208 +208 @@ _Default value_ : `true`
-`--method, -m `STRING``
+`--method, -m <STRING>`
@@ -226 +226 @@ _Default value_ : `change-set`
-`--notification-arns `ARRAY``
+`--notification-arns <ARRAY>`
@@ -231 +231 @@ The ARNs of Amazon SNS topics that CloudFormation will notify for stack related
-`--outputs-file, -O `STRING``
+`--outputs-file, -O <STRING>`
@@ -249 +249 @@ If multiple stacks are deployed, outputs are written to the same output file, or
-`--parameters `ARRAY``
+`--parameters <ARRAY>`
@@ -271 +271 @@ _Default value_ : `{}`
-`--previous-parameters `BOOLEAN``
+`--previous-parameters <BOOLEAN>`
@@ -280 +280 @@ _Default value_ : `true`
-`--progress `STRING``
+`--progress <STRING>`
@@ -303 +303 @@ _Default value_ : `bar`
-`--require-approval `STRING``
+`--require-approval <STRING>`
@@ -336 +336 @@ _Default value_ : `--rollback`
-`--toolkit-stack-name `STRING``
+`--toolkit-stack-name <STRING>`
@@ -345 +345 @@ The CDK CLI uses this value to verify your bootstrap stack version.
-`--watch `BOOLEAN``
+`--watch <BOOLEAN>`