AWS cdk documentation change
Summary
Updated CLI parameter syntax formatting, example placeholder standardization, and minor grammatical corrections
Security assessment
Formatting changes and example updates do not introduce security content. The '--security-only' flag formatting change does not indicate new security documentation or address vulnerabilities.
Diff
diff --git a/cdk/v2/guide/ref-cli-cmd-diff.md b/cdk/v2/guide/ref-cli-cmd-diff.md index 4480e3e90..33209dbad 100644 --- a//cdk/v2/guide/ref-cli-cmd-diff.md +++ b//cdk/v2/guide/ref-cli-cmd-diff.md @@ -9 +9 @@ This is the AWS CDK v2 Developer Guide. The older CDK v1 entered maintenance on -# cdk diff +# `cdk diff` @@ -35 +35 @@ For a list of global options that work with all CDK CLI commands, see [Global op -`--change-set `BOOLEAN`` +`--change-set <BOOLEAN>` @@ -46 +46 @@ _Default value_ : `true` -`--context-lines `NUMBER`` +`--context-lines <NUMBER>` @@ -53 +53 @@ _Default value_ : `3` -`--exclusively, -e `BOOLEAN`` +`--exclusively, -e <BOOLEAN>` @@ -58 +58 @@ Only diff requested stacks and don’t include dependencies. -`--fail `BOOLEAN`` +`--fail <BOOLEAN>` @@ -63 +63 @@ Fail and exit with a code of `1` if differences are detected. -`--help, -h `BOOLEAN`` +`--help, -h <BOOLEAN>` @@ -68 +68 @@ Show command reference information for the `cdk diff` command. -`--processed `BOOLEAN`` +`--processed <BOOLEAN>` @@ -75 +75 @@ _Default value_ : `false` -`--quiet, -q `BOOLEAN`` +`--quiet, -q <BOOLEAN>` @@ -82 +82 @@ _Default value_ : `false` -`--security-only `BOOLEAN`` +`--security-only <BOOLEAN>` @@ -89 +89 @@ _Default value_ : `false` -`--strict `BOOLEAN`` +`--strict <BOOLEAN>` @@ -96 +96 @@ _Default value_ : `false` -`--template `STRING`` +`--template <STRING>` @@ -120,4 +120,4 @@ The following is an example that shows a diff of local changes to a Lambda funct - start: Building asset-hash:account-Region - success: Built asset-hash:account-Region - start: Publishing asset-hash:account-Region - success: Published asset-hash:account-Region + start: Building <asset-hash>:<account:Region> + success: Built <asset-hash>:<account:Region> + start: Publishing <asset-hash>:<account:Region> + success: Published <asset-hash>:<account:Region> @@ -127 +127 @@ The following is an example that shows a diff of local changes to a Lambda funct - [~] AWS::Lambda::Function HelloWorldFunction resource-logical-ID + [~] AWS::Lambda::Function HelloWorldFunction <resource-logical-ID> @@ -164 +164 @@ A `[~]` indicator for resources that will be modified does not always mean a ful -### Diff a local stack with its deployed stack. Don’t print to stdout if no changes are detected +### Diff a local stack with its deployed stack. don’t print to stdout if no changes are detected