AWS cdk documentation change
Summary
Formatting and syntax improvements in documentation examples, including placeholder notation updates (e.g., <NAME>), typographical fixes, and markdown formatting consistency changes.
Security assessment
Changes involve documentation formatting, placeholder syntax standardization, and typographical corrections. No explicit security vulnerabilities, mitigations, or new security features are introduced. Example ARN format corrections are documentation accuracy improvements rather than security fixes.
Diff
diff --git a/cdk/v2/guide/cli.md b/cdk/v2/guide/cli.md index ce618d551..869e6fb5c 100644 --- a//cdk/v2/guide/cli.md +++ b//cdk/v2/guide/cli.md @@ -85 +85 @@ The recommended approach for new users developing locally, who are not given a m - * A [shared AWS`config` file](https://docs.aws.amazon.com/sdkref/latest/guide/file-format.html) having a `[default]` profile with a set of configuration values that can be referenced from the AWS CDK. To find the location of this file, see [Location of the shared files](https://docs.aws.amazon.com/sdkref/latest/guide/file-location.html) in the _AWS SDKs and Tools Reference Guide_. + * A [shared AWS config file](https://docs.aws.amazon.com/sdkref/latest/guide/file-format.html) having a `[default]` profile with a set of configuration values that can be referenced from the AWS CDK. To find the location of this file, see [Location of the shared files](https://docs.aws.amazon.com/sdkref/latest/guide/file-location.html) in the _AWS SDKs and Tools Reference Guide_. @@ -87 +87 @@ The recommended approach for new users developing locally, who are not given a m - * The shared `config` file sets the [`region`](https://docs.aws.amazon.com/sdkref/latest/guide/feature-region.html) setting. This sets the default AWS Region the AWS CDK and CDK CLI use for AWS requests. + * The shared `config` file sets the [region](https://docs.aws.amazon.com/sdkref/latest/guide/feature-region.html) setting. This sets the default AWS Region the AWS CDK and CDK CLI use for AWS requests. @@ -89 +89 @@ The recommended approach for new users developing locally, who are not given a m - * The CDK CLI uses the profile's [SSO token provider configuration](https://docs.aws.amazon.com/sdkref/latest/guide/feature-sso-credentials.html#feature-sso-credentials-profile) to acquire credentials before sending requests to AWS. The `sso_role_name` value, which is an IAM role connected to an IAM Identity Center permission set, should allow access to the AWS services used in your application. + * The CDK CLI uses the profile’s [SSO token provider configuration](https://docs.aws.amazon.com/sdkref/latest/guide/feature-sso-credentials.html#feature-sso-credentials-profile) to acquire credentials before sending requests to AWS. The `sso_role_name` value, which is an IAM role connected to an IAM Identity Center permission set, should allow access to the AWS services used in your application. @@ -91 +91 @@ The recommended approach for new users developing locally, who are not given a m -The following sample `config` file shows a default profile set up with SSO token provider configuration. The profile's `sso_session` setting refers to the named [`sso-session` section](https://docs.aws.amazon.com/sdkref/latest/guide/file-format.html#section-session). The `sso-session` section contains settings to initiate an AWS access portal session. +The following sample `config` file shows a default profile set up with SSO token provider configuration. The profile’s `sso_session` setting refers to the named [`sso-session` section](https://docs.aws.amazon.com/sdkref/latest/guide/file-format.html#section-session). The `sso-session` section contains settings to initiate an AWS access portal session. @@ -94,9 +94,9 @@ The following sample `config` file shows a default profile set up with SSO token - sso_session = my-sso - sso_account_id = 111122223333 - sso_role_name = SampleRole - region = us-east-1 - output = json - - [sso-session my-sso] - sso_region = us-east-1 - sso_start_url = https://provided-domain.awsapps.com/start + sso_session = <my-sso> + sso_account_id = <111122223333> + sso_role_name = <SampleRole> + region = <us-east-1> + output = <json> + + [sso-session <my-sso>] + sso_region = <us-east-1> + sso_start_url = <https://provided-domain.awsapps.com/start> @@ -115 +115 @@ Before accessing AWS services, you need an active AWS access portal session for -If your SSO token provider configuration is using a named profile instead of the default profile, the command is `aws sso login --profile `NAME``. Also specify this profile when issuing **cdk** commands using the **\--profile** option or the `AWS_PROFILE` environment variable. +If your SSO token provider configuration is using a named profile instead of the default profile, the command is `aws sso login --profile <NAME>`. Also specify this profile when issuing `cdk` commands using the `--profile` option or the `AWS_PROFILE` environment variable. @@ -132 +132 @@ The sign in process may prompt you to allow the AWS CLI access to your data. Sin -The CDK CLI needs to know the AWS Region that you're deploying into and how to authenticate with AWS. This is needed for deployment operations and to retrieve context values during synthesis. Together, your account and Region make up the _environment_. +The CDK CLI needs to know the AWS Region that you’re deploying into and how to authenticate with AWS. This is needed for deployment operations and to retrieve context values during synthesis. Together, your account and Region make up the _environment_. @@ -145 +145 @@ Region may be specified using environment variables or in configuration files. T -Besides specifying AWS authentication and a Region in the `[default]` section, you can also add one or more `[profile `NAME`]` sections, where `NAME` is the name of the profile. For more information about named profiles, see [Shared config and credentials files](https://docs.aws.amazon.com/sdkref/latest/guide/file-format.html) in the _AWS SDKs and Tools Reference Guide_. +Besides specifying AWS authentication and a Region in the `[default]` section, you can also add one or more `[profile <NAME>]` sections, where `<NAME>` is the name of the profile. For more information about named profiles, see [Shared config and credentials files](https://docs.aws.amazon.com/sdkref/latest/guide/file-format.html) in the _AWS SDKs and Tools Reference Guide_. @@ -149 +149 @@ The standard AWS `config` file is located at `~/.aws/config` (macOS/Linux) or `% -The environment that you specify in your AWS CDK app by using the stack's `env` property is used during synthesis. It's used to generate an environment-specific AWS CloudFormation template, and during deployment, it overrides the account or Region specified by one of the preceding methods. For more information, see [Environments for the AWS CDK](./environments.html). +The environment that you specify in your AWS CDK app by using the stack’s `env` property is used during synthesis. It’s used to generate an environment-specific AWS CloudFormation template, and during deployment, it overrides the account or Region specified by one of the preceding methods. For more information, see [Environments for the AWS CDK](./environments.html). @@ -168 +168 @@ First, and most commonly, it can be specified using the `app` key inside the fil -The CDK CLI looks for `cdk.json` in the current working directory when attempting to run your app. Because of this, you might keep a shell open in your project's main directory for issuing CDK CLI commands. +The CDK CLI looks for `cdk.json` in the current working directory when attempting to run your app. Because of this, you might keep a shell open in your project’s main directory for issuing CDK CLI commands. @@ -170 +170 @@ The CDK CLI looks for `cdk.json` in the current working directory when attemptin -The CDK CLI also looks for the app key in `~/.cdk.json` (that is, in your home directory) if it can't find it in `./cdk.json`. Adding the app command here can be useful if you usually work with CDK code in the same language. +The CDK CLI also looks for the app key in `~/.cdk.json` (that is, in your home directory) if it can’t find it in `./cdk.json`. Adding the app command here can be useful if you usually work with CDK code in the same language. @@ -177 +177 @@ If you are in some other directory, or to run your app using a command other tha -When deploying, you may also specify a directory containing synthesized cloud assemblies, such as `cdk.out`, as the value of **\--app**. The specified stacks are deployed from this directory; the app is not synthesized. +When deploying, you may also specify a directory containing synthesized cloud assemblies, such as `cdk.out`, as the value of `--app`. The specified stacks are deployed from this directory; the app is not synthesized. @@ -181 +181 @@ When deploying, you may also specify a directory containing synthesized cloud as -Many CDK CLI commands (for example, `cdk deploy`) work on stacks defined in your app. If your app contains only one stack, the CDK CLI assumes you mean that one if you don't specify a stack explicitly. +Many CDK CLI commands (for example, `cdk deploy`) work on stacks defined in your app. If your app contains only one stack, the CDK CLI assumes you mean that one if you don’t specify a stack explicitly. @@ -199 +199 @@ You may also use wildcards to specify IDs that match a pattern. -You may also use the **\--all** option to specify all stacks. +You may also use the `--all` option to specify all stacks. @@ -201 +201 @@ You may also use the **\--all** option to specify all stacks. -If your app uses [CDK Pipelines](./cdk-pipeline.html), the CDK CLI understands your stacks and stages as a hierarchy. Also, the **\--all** option and the `*` wildcard only match top-level stacks. To match all the stacks, use `**`. Also use `**` to indicate all the stacks under a particular hierarchy. +If your app uses [CDK Pipelines](./cdk-pipeline.html), the CDK CLI understands your stacks and stages as a hierarchy. Also, the `--all` option and the `*` wildcard only match top-level stacks. To match all the stacks, use `**`. Also use `**` to indicate all the stacks under a particular hierarchy. @@ -203 +203 @@ If your app uses [CDK Pipelines](./cdk-pipeline.html), the CDK CLI understands y -When using wildcards, enclose the pattern in quotes, or escape the wildcards with `\`. If you don't, your shell may try to expand the pattern to the names of files in the current directory. At best, this won't do what you expect; at worst, you could deploy stacks you didn't intend to. This isn't strictly necessary on Windows because `cmd.exe` does not expand wildcards, but is good practice nonetheless. +When using wildcards, enclose the pattern in quotes, or escape the wildcards with `\`. If you don’t, your shell may try to expand the pattern to the names of files in the current directory. At best, this won’t do what you expect; at worst, you could deploy stacks you didn’t intend to. This isn’t strictly necessary on Windows because `cmd.exe` does not expand wildcards, but is good practice nonetheless. @@ -214 +214 @@ When using wildcards, enclose the pattern in quotes, or escape the wildcards wit -The order in which you specify the stacks is not necessarily the order in which they will be processed. The CDK CLI accounts for dependencies between stacks when deciding the order in which to process them. For example, let's say that one stack uses a value produced by another (such as the ARN of a resource defined in the second stack). In this case, the second stack is synthesized before the first one because of this dependency. You can add dependencies between stacks manually using the stack's [`addDependency()`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.Stack.html#addwbrdependencytarget-reason) method. +The order in which you specify the stacks is not necessarily the order in which they will be processed. The CDK CLI accounts for dependencies between stacks when deciding the order in which to process them. For example, let’s say that one stack uses a value produced by another (such as the ARN of a resource defined in the second stack). In this case, the second stack is synthesized before the first one because of this dependency. You can add dependencies between stacks manually using the stack’s ` [addDependency()](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.Stack.html#addwbrdependencytarget-reason) ` method. @@ -223 +223 @@ Deploying stacks with the CDK requires special dedicated AWS CDK resources to be -If issued with no arguments, as shown here, the `cdk bootstrap` command synthesizes the current app and bootstraps the environments its stacks will be deployed to. If the app contains environment-agnostic stacks, which don't explicitly specify an environment, the default account and Region are bootstrapped, or the environment specified using `--profile`. +If issued with no arguments, as shown here, the `cdk bootstrap` command synthesizes the current app and bootstraps the environments its stacks will be deployed to. If the app contains environment-agnostic stacks, which don’t explicitly specify an environment, the default account and Region are bootstrapped, or the environment specified using `--profile`. @@ -225 +225 @@ If issued with no arguments, as shown here, the `cdk bootstrap` command synthesi -Outside of an app, you must explicitly specify the environment to be bootstrapped. You may also do so to bootstrap an environment that's not specified in your app or local AWS profile. Credentials must be configured (e.g. in `~/.aws/credentials`) for the specified account and Region. You may specify a profile that contains the required credentials. +Outside of an app, you must explicitly specify the environment to be bootstrapped. You may also do so to bootstrap an environment that’s not specified in your app or local AWS profile. Credentials must be configured (e.g. in `~/.aws/credentials`) for the specified account and Region. You may specify a profile that contains the required credentials. @@ -228 +228 @@ Outside of an app, you must explicitly specify the environment to be bootstrappe - cdk bootstrap ACCOUNT-NUMBER/REGION # e.g. + cdk bootstrap <ACCOUNT-NUMBER>/<REGION> # e.g. @@ -236 +236 @@ Each environment (account/region combination) to which you deploy such a stack m -You may incur AWS charges for what the AWS CDK stores in the bootstrapped resources. Additionally, if you use `-bootstrap-customer-key`, an AWS KMS key will be created, which also incurs charges per environment. +You may incur AWS charges for what the AWS CDK stores in the bootstrapped resources. Additionally, if you use `--bootstrap-customer-key`, an AWS KMS key will be created, which also incurs charges per environment. @@ -257 +257 @@ To create a new app, create a directory for it, then, inside the directory, issu - cdk init TEMPLATE --language LANGUAGE + cdk init <TEMPLATE> --language <LANGUAGE> @@ -259 +259 @@ To create a new app, create a directory for it, then, inside the directory, issu -The supported languages (`LANGUAGE`) are: +The supported languages (<LANGUAGE>) are: @@ -267,0 +268 @@ Code | Language +`Go` | Go @@ -269 +270 @@ Code | Language -`TEMPLATE` is an optional template. If the desired template is _app_ , the default, you may omit it. The available templates are: +<TEMPLATE> is an optional template. If the desired template is _app_ , the default, you may omit it. The available templates are: @@ -357 +358 @@ See `cdk deploy --help` for all available options. A few of the most useful opti -The **cdk deploy** command normally synthesizes your app's stacks before deploying to make sure that the deployment reflects the latest version of your app. If you know that you haven't changed your code since your last **cdk synth** , you can suppress the redundant synthesis step when deploying. To do so, specify your project's `cdk.out` directory in the **\--app** option. +The `cdk deploy` command normally synthesizes your app’s stacks before deploying to make sure that the deployment reflects the latest version of your app. If you know that you haven’t changed your code since your last `cdk synth`, you can suppress the redundant synthesis step when deploying. To do so, specify your project’s `cdk.out` directory in the `--app` option. @@ -366 +367 @@ AWS CloudFormation has the ability to roll back changes so that deployments are -Rollback makes sure that your resources are in a consistent state at all times, which is vital for production stacks. However, while you're still developing your infrastructure, some failures are inevitable, and rolling back failed deployments can slow you down. +Rollback makes sure that your resources are in a consistent state at all times, which is vital for production stacks. However, while you’re still developing your infrastructure, some failures are inevitable, and rolling back failed deployments can slow you down. @@ -368 +369 @@ Rollback makes sure that your resources are in a consistent state at all times, -For this reason, the CDK CLI lets you disable rollback by adding `--no-rollback` to your `cdk deploy` command. With this flag, failed deployments are not rolled back. Instead, resources deployed before the failed resource remain in place, and the next deployment starts with the failed resource. You'll spend a lot less time waiting for deployments and a lot more time developing your infrastructure. +For this reason, the CDK CLI lets you disable rollback by adding `--no-rollback` to your `cdk deploy` command. With this flag, failed deployments are not rolled back. Instead, resources deployed before the failed resource remain in place, and the next deployment starts with the failed resource. You’ll spend a lot less time waiting for deployments and a lot more time developing your infrastructure. @@ -382 +383 @@ Hot-swapping is not recommended for production deployments. -The CDK CLI's watch mode ( **cdk deploy --watch** , or **cdk watch** for short) continuously monitors your CDK app's source files and assets for changes. It immediately performs a deployment of the specified stacks when a change is detected. +The CDK CLI’s watch mode (`cdk deploy --watch`, or `cdk watch` for short) continuously monitors your CDK app’s source files and assets for changes. It immediately performs a deployment of the specified stacks when a change is detected. @@ -388 +389 @@ Any changes made while `cdk watch` is already performing a deployment are combin -Watch mode uses the `"watch"` key in the project's `cdk.json` to determine which files to monitor. By default, these files are your application files and assets, but this can be changed by modifying the `"include"` and `"exclude"` entries in the `"watch"` key. The following `cdk.json` file shows an example of these entries. +Watch mode uses the `"watch"` key in the project’s `cdk.json` to determine which files to monitor. By default, these files are your application files and assets, but this can be changed by modifying the `"include"` and `"exclude"` entries in the `"watch"` key. The following `cdk.json` file shows an example of these entries. @@ -399 +400 @@ Watch mode uses the `"watch"` key in the project's `cdk.json` to determine which -`cdk watch` executes the `"build"` command from `cdk.json` to build your app before synthesis. If your deployment requires any commands to build or package your Lambda code (or anything else that's not in your CDK app), add it here. +`cdk watch` executes the `"build"` command from `cdk.json` to build your app before synthesis. If your deployment requires any commands to build or package your Lambda code (or anything else that’s not in your CDK app), add it here. @@ -438 +439 @@ To protect you against unintended changes that affect your security posture, the - cdk deploy --require-approval LEVEL + cdk deploy --require-approval <LEVEL> @@ -440 +441 @@ To protect you against unintended changes that affect your security posture, the -`LEVEL` can be one of the following: +`<LEVEL>` can be one of the following: @@ -446 +447 @@ Term | Meaning -`broadening` (default) | Requires approval when IAM statements or traffic rules are added; removals don't require approval +`broadening` (default) | Requires approval when IAM statements or traffic rules are added; removals don’t require approval @@ -470 +471 @@ The `cdk diff` command compares the current version of a stack (and its dependen - │ + │ ${MyFirstBucket.Arn} │ Allow │ s3:DeleteObject* │ AWS:${Custom::S3AutoDeleteOb │ │ + │ + │ ${MyFirstBucket.Arn} │ Allow │ s3:DeleteObject* │ {aws}:${Custom::S3AutoDeleteOb │ │ @@ -479 +480 @@ The `cdk diff` command compares the current version of a stack (and its dependen - │ + │ ${Custom::S3AutoDeleteObjectsCustomResourceProvider/Ro │ {"Fn::Sub":"arn:${AWS::Partition}:iam::aws:policy/serv │ + │ + │ ${Custom::S3AutoDeleteObjectsCustomResourceProvider/Ro │ {"Fn::Sub":"arn:${{aws}::Partition}:iam::aws:policy/serv │ @@ -490 +491 @@ The `cdk diff` command compares the current version of a stack (and its dependen - [+] AWS::S3::BucketPolicy MyFirstBucket/Policy MyFirstBucketPolicy3243DEFD + [+] {aws}::S3::BucketPolicy MyFirstBucket/Policy MyFirstBucketPolicy3243DEFD @@ -492,3 +493,3 @@ The `cdk diff` command compares the current version of a stack (and its dependen - [+] AWS::IAM::Role Custom::S3AutoDeleteObjectsCustomResourceProvider/Role CustomS3AutoDeleteObjectsCustomResourceProviderRole3B1BD092 - [+] AWS::Lambda::Function Custom::S3AutoDeleteObjectsCustomResourceProvider/Handler CustomS3AutoDeleteObjectsCustomResourceProviderHandler9D90184F - [~] AWS::S3::Bucket MyFirstBucket MyFirstBucketB8884501 + [+] {aws}::IAM::Role Custom::S3AutoDeleteObjectsCustomResourceProvider/Role CustomS3AutoDeleteObjectsCustomResourceProviderRole3B1BD092 + [+] {aws}::Lambda::Function Custom::S3AutoDeleteObjectsCustomResourceProvider/Handler CustomS3AutoDeleteObjectsCustomResourceProviderHandler9D90184F + [~] {aws}::S3::Bucket MyFirstBucket MyFirstBucketB8884501 @@ -502 +503 @@ The `cdk diff` command compares the current version of a stack (and its dependen -To compare your app's stacks with the existing deployment: +To compare your app’s stacks with the existing deployment: @@ -507 +508 @@ To compare your app's stacks with the existing deployment: -To compare your app's stacks with a saved CloudFormation template: +To compare your app’s stacks with a saved CloudFormation template: @@ -524 +525 @@ To import an existing resource into a AWS CDK stack, follow the following steps: -You must also make sure to exactly model the state that the resource currently has into the definition. For the example of the bucket, be sure to include AWS KMS keys, life cycle policies, and anything else that's relevant about the bucket. If you do not, subsequent update operations may not do what you expect. +You must also make sure to exactly model the state that the resource currently has into the definition. For the example of the bucket, be sure to include AWS KMS keys, life cycle policies, and anything else that’s relevant about the bucket. If you do not, subsequent update operations may not do what you expect. @@ -528 +529 @@ You can choose whether or not to include the physical bucket name. We usually re - * Run `cdk import `STACKNAME``. + * Run `cdk import <STACKNAME>`. @@ -543 +544 @@ This feature currently does not support importing resources into nested stacks. -Default values for many CDK CLI command line flags can be stored in a project's `cdk.json` file or in the `.cdk.json` file in your user directory. Following is an alphabetical reference to the supported configuration settings. +Default values for many CDK CLI command line flags can be stored in a project’s `cdk.json` file or in the `.cdk.json` file in your user directory. Following is an alphabetical reference to the supported configuration settings. @@ -547,24 +548,24 @@ Key | Notes | CDK CLI option -`app` | The command that executes the CDK application. | **\--app** -`assetMetadata` | If `false`, CDK does not add metadata to resources that use assets. | **\--no-asset-metadata** -`bootstrapKmsKeyId` | Overrides the ID of the AWS KMS key used to encrypt the Amazon S3 deployment bucket. | **\--bootstrap-kms-key-id** -`build` | The command that compiles or builds the CDK application before synthesis. Not permitted in `~/.cdk.json`. | **\--build** -`browser` | The command for launching a Web browser for the `cdk docs` subcommand. | **\--browser** -`context` | See [Context values and the AWS CDK](./context.html). Context values in a configuration file will not be erased by **cdk context --clear**. (The CDK CLI places cached context values in `cdk.context.json`.) | **\--context** -`debug` | If `true`, CDK CLI emits more detailed information useful for debugging. | **\--debug** -`language` | The language to be used for initializing new projects. | **\--language** -`lookups` | If `false`, no context lookups are permitted. Synthesis will fail if any context lookups need to be performed. | **\--no-lookups** -`notices` | If `false`, suppresses the display of messages about security vulnerabilities, regressions, and unsupported versions. | **\--no-notices** -`output` | The name of the directory into which the synthesized cloud assembly will be emitted (default `"cdk.out"`). | **\--output** -`outputsFile` | The file to which AWS CloudFormation outputs from deployed stacks will be written (in JSON format). | **\--outputs-file** -`pathMetadata` | If `false`, CDK path metadata is not added to synthesized templates. | **\--no-path-metadata** -`plugin` | JSON array specifying the package names or local paths of packages that extend the CDK | **\--plugin** -`profile` | Name of the default AWS profile used for specifying Region and account credentials. | **\--profile** -`progress` | If set to `"events"`, the CDK CLI displays all AWS CloudFormation events during deployment, rather than a progress bar. | **\--progress** -`requireApproval` | Default approval level for security changes. See Approve security-related changes | **\--require-approval** -`rollback` | If `false`, failed deployments are not rolled back. | **\--no-rollback** -`staging` | If `false`, assets are not copied to the output directory (use for local debugging of the source files with AWS SAM). | **\--no-staging** -`tags` | JSON object containing tags (key-value pairs) for the stack. | **\--tags** -`toolkitBucketName` | The name of the Amazon S3 bucket used for deploying assets such as Lambda functions and container images (see Bootstrap your AWS environment. | **\--toolkit-bucket-name** -`toolkitStackName` | The name of the bootstrap stack (see Bootstrap your AWS environment. | **\--toolkit-stack-name** -`versionReporting` | If `false`, opts out of version reporting. | **\--no-version-reporting** -`watch` | JSON object containing `"include"` and `"exclude"` keys that indicate which files should (or should not) trigger a rebuild of the project when changed. See Watch mode. | **\--watch** +`app` | The command that executes the CDK application. | `--app` +`assetMetadata` | If `false`, CDK does not add metadata to resources that use assets. | `--no-asset-metadata` +`bootstrapKmsKeyId` | Overrides the ID of the AWS KMS key used to encrypt the Amazon S3 deployment bucket. | `--bootstrap-kms-key-id` +`build` | The command that compiles or builds the CDK application before synthesis. Not permitted in `~/.cdk.json`. | `--build` +`browser` | The command for launching a Web browser for the `cdk docs` subcommand. | `--browser` +`context` | See [Context values and the AWS CDK](./context.html). Context values in a configuration file will not be erased by `cdk context --clear`. (The CDK CLI places cached context values in `cdk.context.json`.) | `--context` +`debug` | If `true`, CDK CLI emits more detailed information useful for debugging. | `--debug` +`language` | The language to be used for initializing new projects. | `--language` +`lookups` | If `false`, no context lookups are permitted. Synthesis will fail if any context lookups need to be performed. | `--no-lookups` +`notices` | If `false`, suppresses the display of messages about security vulnerabilities, regressions, and unsupported versions. | `--no-notices` +`output` | The name of the directory into which the synthesized cloud assembly will be emitted (default `"cdk.out"`). | `--output` +`outputsFile` | The file to which AWS CloudFormation outputs from deployed stacks will be written (in `JSON` format). | `--outputs-file` +`pathMetadata` | If `false`, CDK path metadata is not added to synthesized templates. | `--no-path-metadata` +`plugin` | JSON array specifying the package names or local paths of packages that extend the CDK | `--plugin` +`profile` | Name of the default AWS profile used for specifying Region and account credentials. | `--profile` +`progress` | If set to `"events"`, the CDK CLI displays all AWS CloudFormation events during deployment, rather than a progress bar. | `--progress` +`requireApproval` | Default approval level for security changes. See Approve security-related changes | `--require-approval` +`rollback` | If `false`, failed deployments are not rolled back. | `--no-rollback` +`staging` | If `false`, assets are not copied to the output directory (use for local debugging of the source files with AWS SAM). | `--no-staging` +`tags` | `JSON` object containing tags (key-value pairs) for the stack. | `--tags` +`toolkitBucketName` | The name of the Amazon S3 bucket used for deploying assets such as Lambda functions and container images (see Bootstrap your AWS environment). | `--toolkit-bucket-name` +`toolkitStackName` | The name of the bootstrap stack (see Bootstrap your AWS environment). | `--toolkit-stack-name` +`versionReporting` | If `false`, opts out of version reporting. | `--no-version-reporting`