AWS cdk documentation change
Summary
Updated documentation to replace 'AWS CloudFormation' with 'CloudFormation' throughout the file for consistency in terminology
Security assessment
The changes are purely branding/terminology updates (removing 'AWS' prefix from CloudFormation references). No security vulnerabilities, mitigations, or security features are mentioned or modified. The S3 bucket configuration discussion remains unchanged in security context.
Diff
diff --git a/cdk/v1/guide/hello-world.md b/cdk/v1/guide/hello-world.md index 734d65a65..466358b8d 100644 --- a//cdk/v1/guide/hello-world.md +++ b//cdk/v1/guide/hello-world.md @@ -3 +3 @@ -Create the appBuild the appList the stacks in the appAdd an Amazon S3 bucketSynthesize an AWS CloudFormation templateDeploying the stackModifying the appDestroying the app's resourcesNext steps +Create the appBuild the appList the stacks in the appAdd an Amazon S3 bucketSynthesize an CloudFormation templateDeploying the stackModifying the appDestroying the app's resourcesNext steps @@ -25 +25 @@ The standard AWS CDK development workflow is similar to the workflow you're alre - 4. Synthesize one or more stacks in the app to create an AWS CloudFormation template + 4. Synthesize one or more stacks in the app to create an CloudFormation template @@ -38 +38 @@ Don't forget to keep your AWS CDK code under version control! -This tutorial walks you through creating and deploying a simple AWS CDK app, from initializing the project to deploying the resulting AWS CloudFormation template. The app contains one stack, which contains one resource: an Amazon S3 bucket. +This tutorial walks you through creating and deploying a simple AWS CDK app, from initializing the project to deploying the resulting CloudFormation template. The app contains one stack, which contains one resource: an Amazon S3 bucket. @@ -354 +354 @@ Props are represented differently in the languages supported by the AWS CDK. -## Synthesize an AWS CloudFormation template +## Synthesize an CloudFormation template @@ -356 +356 @@ Props are represented differently in the languages supported by the AWS CDK. -Synthesize an AWS CloudFormation template for the app, as follows. +Synthesize an CloudFormation template for the app, as follows. @@ -367 +367 @@ If you received an error like `--app is required...`, it's probably because you -The `cdk synth` command executes your app, which causes the resources defined in it to be translated into an AWS CloudFormation template. The displayed output of `cdk synth` is a YAML-format template; the beginning of our app's output is shown below. The template is also saved in the `cdk.out` directory in JSON format. +The `cdk synth` command executes your app, which causes the resources defined in it to be translated into an CloudFormation template. The displayed output of `cdk synth` is a YAML-format template; the beginning of our app's output is shown below. The template is also saved in the `cdk.out` directory in JSON format. @@ -380 +380 @@ The `cdk synth` command executes your app, which causes the resources defined in -Even if you aren't very familiar with AWS CloudFormation, you should be able to find the definition for the bucket and see how the `versioned` property was translated. +Even if you aren't very familiar with CloudFormation, you should be able to find the definition for the bucket and see how the `versioned` property was translated. @@ -386 +386 @@ Every generated template contains a `AWS::CDK::Metadata` resource by default. (W -The `cdk synth` generates a perfectly valid AWS CloudFormation template. You could take it and deploy it using the AWS CloudFormation console or another tool. But the AWS CDK Toolkit can also do that. +The `cdk synth` generates a perfectly valid CloudFormation template. You could take it and deploy it using the CloudFormation console or another tool. But the AWS CDK Toolkit can also do that. @@ -390 +390 @@ The `cdk synth` generates a perfectly valid AWS CloudFormation template. You cou -To deploy the stack using AWS CloudFormation, issue: +To deploy the stack using CloudFormation, issue: @@ -401 +401 @@ If your code has security implications, you'll see a summary of these and need t -`cdk deploy` displays progress information as your stack is deployed. When it's done, the command prompt reappears. You can go to the [AWS CloudFormation console](https://console.aws.amazon.com/cloudformation/home) and see that it now lists `HelloCdkStack`. You'll also find `MyFirstBucket` in the Amazon S3 console. +`cdk deploy` displays progress information as your stack is deployed. When it's done, the command prompt reappears. You can go to the [CloudFormation console](https://console.aws.amazon.com/cloudformation/home) and see that it now lists `HelloCdkStack`. You'll also find `MyFirstBucket` in the Amazon S3 console. @@ -407 +407 @@ You've deployed your first stack using the AWS CDK—congratulations! But that's -The AWS CDK can update your deployed resources after you modify your app. Let's change our bucket so it can be automatically deleted when we delete the stack, which involves changing its `RemovalPolicy`. Also, because AWS CloudFormation won't delete Amazon S3 buckets that contain any objects, we'll ask the AWS CDK to delete the objects from our bucket before destroying the bucket, via the `autoDeleteObjects` property. +The AWS CDK can update your deployed resources after you modify your app. Let's change our bucket so it can be automatically deleted when we delete the stack, which involves changing its `RemovalPolicy`. Also, because CloudFormation won't delete Amazon S3 buckets that contain any objects, we'll ask the AWS CDK to delete the objects from our bucket before destroying the bucket, via the `autoDeleteObjects` property. @@ -473 +473 @@ Update `src/HelloCdk/HelloCdkStack.cs`. -Here, we haven't written any code that, in itself, changes our Amazon S3 bucket. Instead, our code defines the desired state of the bucket. The AWS CDK synthesizes that state to a new AWS CloudFormation template and deploys a change set that makes only the changes necessary to reach that state. +Here, we haven't written any code that, in itself, changes our Amazon S3 bucket. Instead, our code defines the desired state of the bucket. The AWS CDK synthesizes that state to a new CloudFormation template and deploys a change set that makes only the changes necessary to reach that state. @@ -480 +480 @@ To see these changes, we'll use the `cdk diff` command . -The AWS CDK Toolkit queries your AWS account for the last-deployed AWS CloudFormation template for the `HelloCdkStack` and compares it with the template it just synthesized from your app. The output should look like the following. +The AWS CDK Toolkit queries your AWS account for the last-deployed CloudFormation template for the `HelloCdkStack` and compares it with the template it just synthesized from your app. The output should look like the following. @@ -535 +535 @@ This diff has four sections. -You may be curious about why we specified `RemovalPolicy` in our AWS CDK app but got a `DeletionPolicy` property in the resulting AWS CloudFormation template. The AWS CDK uses a different name for the property because the AWS CDK default is to retain the bucket when the stack is deleted, while AWS CloudFormation's default is to delete it. See [Removal policies](./resources.html#resources-removal) for further details. +You may be curious about why we specified `RemovalPolicy` in our AWS CDK app but got a `DeletionPolicy` property in the resulting CloudFormation template. The AWS CDK uses a different name for the property because the AWS CDK default is to retain the bucket when the stack is deleted, while CloudFormation's default is to delete it. See [Removal policies](./resources.html#resources-removal) for further details. @@ -537 +537 @@ You may be curious about why we specified `RemovalPolicy` in our AWS CDK app but -It's informative to compare the output of **cdk synth** here with the previous output and see the many additional lines of AWS CloudFormation template that the AWS CDK generated for us based on these relatively small changes. +It's informative to compare the output of **cdk synth** here with the previous output and see the many additional lines of CloudFormation template that the AWS CDK generated for us based on these relatively small changes. @@ -541 +541 @@ It's informative to compare the output of **cdk synth** here with the previous o -Since the `autoDeleteObjects` property is implemented using a AWS CloudFormation custom resource, which is implemented using an AWS Lambda function, our stack contains an [asset](./assets.html). This fact requires that our AWS account and region be [bootstrapped](./bootstrapping.html) so that there's an Amazon S3 bucket to hold the asset during deployment. If you haven't already bootstrapped, issue: +Since the `autoDeleteObjects` property is implemented using a CloudFormation custom resource, which is implemented using an AWS Lambda function, our stack contains an [asset](./assets.html). This fact requires that our AWS account and region be [bootstrapped](./bootstrapping.html) so that there's an Amazon S3 bucket to hold the asset during deployment. If you haven't already bootstrapped, issue: