AWS cdk documentation change
Summary
Updated documentation to replace 'AWS CloudFormation' with 'CloudFormation' throughout the file for terminology consistency
Security assessment
The changes are purely terminological updates to align with branding conventions (removing redundant 'AWS' prefix from CloudFormation references). No security vulnerabilities, mitigations, or security features were added or modified. The existing security context in the AWS::CDK::Metadata section remains unchanged except for terminology.
Diff
diff --git a/cdk/v1/guide/cli.md b/cdk/v1/guide/cli.md index 3fd915794..169dfa608 100644 --- a//cdk/v1/guide/cli.md +++ b//cdk/v1/guide/cli.md @@ -9 +9 @@ This is the AWS CDK v1 Developer Guide. The older CDK v1 entered maintenance on -The AWS CDK Toolkit, the CLI command `cdk`, is the primary tool for interacting with your AWS CDK app. It executes your app, interrogates the application model you defined, and produces and deploys the AWS CloudFormation templates generated by the AWS CDK. It also provides other features useful for creating and working with AWS CDK projects. This topic contains information about common use cases of the CDK Toolkit. +The AWS CDK Toolkit, the CLI command `cdk`, is the primary tool for interacting with your AWS CDK app. It executes your app, interrogates the application model you defined, and produces and deploys the CloudFormation templates generated by the AWS CDK. It also provides other features useful for creating and working with AWS CDK projects. This topic contains information about common use cases of the CDK Toolkit. @@ -90 +90 @@ Issue `cdk version` to display the version of the AWS CDK Toolkit. Provide this -To gain insight into how the AWS CDK is used, the constructs used by AWS CDK applications are collected and reported by using a resource identified as `AWS::CDK::Metadata`. This resource is added to AWS CloudFormation templates, and can easily be reviewed. This information can also be used by AWS to identify stacks using a construct with known security or reliability issues, and to contact their users with important information. +To gain insight into how the AWS CDK is used, the constructs used by AWS CDK applications are collected and reported by using a resource identified as `AWS::CDK::Metadata`. This resource is added to CloudFormation templates, and can easily be reviewed. This information can also be used by AWS to identify stacks using a construct with known security or reliability issues, and to contact their users with important information. @@ -211 +211 @@ 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](./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 CloudFormation template, and during deployment, it overrides the account or Region specified by one of the preceding methods. For more information, see [Environments](./environments.html). @@ -221 +221 @@ You may optionally use the `--role-arn` (or `-r`) option to specify the ARN of a -Many features of the CDK Toolkit require one or more AWS CloudFormation templates be synthesized, which in turn requires running your application. Since the AWS CDK supports programs written in a variety of languages, it uses a configuration option to specify the exact command necessary to run your app. This option can be specified in two ways. +Many features of the CDK Toolkit require one or more CloudFormation templates be synthesized, which in turn requires running your application. Since the AWS CDK supports programs written in a variety of languages, it uses a configuration option to specify the exact command necessary to run your app. This option can be specified in two ways. @@ -415 +415 @@ The `cdk deploy` subcommand deploys the specified stack(s) to your AWS account. -The CDK Toolkit runs your app and synthesizes fresh AWS CloudFormation templates before deploying anything. Therefore, most command line options you can use with `cdk synth` (for example, `--context`) can also be used with `cdk deploy`. +The CDK Toolkit runs your app and synthesizes fresh CloudFormation templates before deploying anything. Therefore, most command line options you can use with `cdk synth` (for example, `--context`) can also be used with `cdk deploy`. @@ -428 +428 @@ The **cdk deploy** command normally synthesizes your app's stacks before deployi -One of AWS CloudFormation's marquee features is its ability to roll back changes so that deployments are atomic—they either succeed or fail as a whole. The AWS CDK inherits this capability because it synthesizes and deploys AWS CloudFormation templates. +One of CloudFormation's marquee features is its ability to roll back changes so that deployments are atomic—they either succeed or fail as a whole. The AWS CDK inherits this capability because it synthesizes and deploys CloudFormation templates. @@ -436 +436 @@ For this reason, the CDK Toolkit allows you to disable rollback by adding `--no- -Use the `--hotswap` flag with `cdk deploy` to attempt to update your AWS resources directly instead of generating a AWS CloudFormation change set and deploying it. Deployment falls back to AWS CloudFormation deployment if hot swapping is not possible. +Use the `--hotswap` flag with `cdk deploy` to attempt to update your AWS resources directly instead of generating a CloudFormation change set and deploying it. Deployment falls back to CloudFormation deployment if hot swapping is not possible. @@ -448 +448 @@ The CDK Toolkit's watch mode ( **cdk deploy --watch** , or **cdk watch** for sho -By default, these deployments use the `--hotswap` flag, which fast-tracks deployment of changes to Lambda functions, and falls back to deploying through AWS CloudFormation if you have changed infrastructure configuration. To have `cdk watch` always perform full AWS CloudFormation deployments, add the `--no-hotswap` flag to `cdk watch`. +By default, these deployments use the `--hotswap` flag, which fast-tracks deployment of changes to Lambda functions, and falls back to deploying through CloudFormation if you have changed infrastructure configuration. To have `cdk watch` always perform full CloudFormation deployments, add the `--no-hotswap` flag to `cdk watch`. @@ -471 +471 @@ Watch mode is not recommended for production deployments. -### Specifying AWS CloudFormation parameters +### Specifying CloudFormation parameters @@ -473 +473 @@ Watch mode is not recommended for production deployments. -The AWS CDK Toolkit supports specifying AWS CloudFormation [parameters](./parameters.html) at deployment. You may provide these on the command line following the `--parameters` flag. +The AWS CDK Toolkit supports specifying CloudFormation [parameters](./parameters.html) at deployment. You may provide these on the command line following the `--parameters` flag. @@ -492 +492 @@ By default, the AWS CDK retains values of parameters from previous deployments a -If your stack declares AWS CloudFormation outputs, these are normally displayed on the screen at the conclusion of deployment. To write them to a file in JSON format, use the `--outputs-file` flag. +If your stack declares CloudFormation outputs, these are normally displayed on the screen at the conclusion of deployment. To write them to a file in JSON format, use the `--outputs-file` flag. @@ -522 +522 @@ The setting can also be configured in the `cdk.json` file. -The `cdk diff` command compares the current version of a stack (and its dependencies) defined in your app with the already-deployed version(s), or with a saved AWS CloudFormation template, and displays a list of changes. +The `cdk diff` command compares the current version of a stack (and its dependencies) defined in your app with the already-deployed version(s), or with a saved CloudFormation template, and displays a list of changes. @@ -593 +593 @@ Key | Notes | CDK Toolkit option -`outputsFile` | The file to which AWS CloudFormation outputs from deployed stacks will be written (in JSON format). | **\--outputs-file** +`outputsFile` | The file to which CloudFormation outputs from deployed stacks will be written (in JSON format). | **\--outputs-file** @@ -597 +597 @@ Key | Notes | CDK Toolkit option -`progress` | If set to `"events"`, the CDK Toolkit displays all AWS CloudFormation events during deployment, rather than a progress bar. | **\--progress** +`progress` | If set to `"events"`, the CDK Toolkit displays all CloudFormation events during deployment, rather than a progress bar. | **\--progress**