AWS cdk documentation change

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

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

Summary

Formatting updates: Standardized option syntax with angle brackets for parameters, fixed spacing in command links, and converted a section header to bold text

Security assessment

Changes involve documentation formatting consistency and markup improvements. No security-related parameters, warnings, or features were introduced or modified. Updates are focused on presentation rather than security content.

Diff

diff --git a/cdk/v2/guide/ref-cli-cmd.md b/cdk/v2/guide/ref-cli-cmd.md
index 0addf19e6..b7d3a9d03 100644
--- a//cdk/v2/guide/ref-cli-cmd.md
+++ b//cdk/v2/guide/ref-cli-cmd.md
@@ -20 +20 @@ This section contains command reference information for the AWS Cloud Developmen
-`[acknowledge, ack](./ref-cli-cmd-ack.html)`
+` [acknowledge ack](./ref-cli-cmd-ack.html) `
@@ -50 +50 @@ Perform a diff to see infrastructure changes between CDK stacks.
-`[docs, doc](./ref-cli-cmd-docs.html)`
+` [docs doc](./ref-cli-cmd-docs.html) `
@@ -104 +104 @@ The following options are compatible with all CDK CLI commands.
-`--app, -a `STRING``
+`--app, -a <STRING>`
@@ -111 +111 @@ _Required_ : Yes
-`--asset-metadata `BOOLEAN``
+`--asset-metadata <BOOLEAN>`
@@ -120 +120 @@ _Default value_ : `true`
-`--build `STRING``
+`--build <STRING>`
@@ -127 +127 @@ _Required_ : No
-`--ca-bundle-path `STRING``
+`--ca-bundle-path <STRING>`
@@ -136 +136 @@ _Required_ : Yes
-`--ci `BOOLEAN``
+`--ci <BOOLEAN>`
@@ -149 +149 @@ _Default value_ : `false`
-`--context, -c `ARRAY``
+`--context, -c <ARRAY>`
@@ -154 +154 @@ Add contextual string parameters as key-value pairs.
-`--debug `BOOLEAN``
+`--debug <BOOLEAN>`
@@ -163 +163 @@ _Default value_ : `false`
-`--ec2creds, -i `BOOLEAN``
+`--ec2creds, -i <BOOLEAN>`
@@ -174 +174 @@ _Default value_ : `false`
-`--help, -h `BOOLEAN``
+`--help, -h <BOOLEAN>`
@@ -183 +183 @@ _Default value_ : `false`
-`--ignore-errors `BOOLEAN``
+`--ignore-errors <BOOLEAN>`
@@ -192 +192 @@ _Default value_ : `false`
-`--json, -j `BOOLEAN``
+`--json, -j <BOOLEAN>`
@@ -201 +201 @@ _Default value_ : `false`
-`--lookups `BOOLEAN``
+`--lookups <BOOLEAN>`
@@ -212 +212 @@ _Default value_ : `true`
-`--no-color `BOOLEAN``
+`--no-color <BOOLEAN>`
@@ -221 +221 @@ _Default value_ : `false`
-`--notices `BOOLEAN``
+`--notices <BOOLEAN>`
@@ -230 +230 @@ _Default value_ : `false`
-`--output, -o `STRING``
+`--output, -o <STRING>`
@@ -239 +239 @@ _Default value_ : `cdk.out`
-`--path-metadata `BOOLEAN``
+`--path-metadata <BOOLEAN>`
@@ -248 +248 @@ _Default value_ : `true`
-`--plugin, -p `ARRAY``
+`--plugin, -p <ARRAY>`
@@ -267 +267 @@ _Required_ : No
-`--profile `STRING``
+`--profile <STRING>`
@@ -274 +274 @@ _Required_ : Yes
-`--proxy `STRING``
+`--proxy <STRING>`
@@ -285 +285 @@ _Default value_ : Read from `HTTPS_PROXY` environment variable.
-`--role-arn, -r `STRING``
+`--role-arn, -r <STRING>`
@@ -292 +292 @@ _Required_ : No
-`--staging `BOOLEAN``
+`--staging <BOOLEAN>`
@@ -303 +303 @@ _Default value_ : `true`
-`--strict `BOOLEAN``
+`--strict <BOOLEAN>`
@@ -312 +312 @@ _Default value_ : `false`
-`--trace `BOOLEAN``
+`--trace <BOOLEAN>`
@@ -321 +321 @@ _Default value_ : `false`
-`--verbose, -v `COUNT``
+`--verbose, -v <COUNT>`
@@ -328 +328 @@ _Required_ : No
-`--version `BOOLEAN``
+`--version <BOOLEAN>`
@@ -337 +337 @@ _Default value_ : `false`
-`--version-reporting `BOOLEAN``
+`--version-reporting <BOOLEAN>`
@@ -361 +361,2 @@ You can pass options through command-line arguments. For most options, you can c
-### Passing boolean values
+**Passing boolean values**
+