AWS cdk documentation change
Summary
Updated documentation to standardize terminology by replacing 'AWS CloudFormation' with 'CloudFormation' throughout the file. No technical changes to processes or requirements.
Security assessment
The changes are purely editorial, focusing on branding consistency rather than addressing security vulnerabilities or introducing security features. References to IAM permissions (s3:*) and resource limits remain unchanged in substance.
Diff
diff --git a/cdk/v1/guide/troubleshooting.md b/cdk/v1/guide/troubleshooting.md index d759a9a20..c9238abda 100644 --- a//cdk/v1/guide/troubleshooting.md +++ b//cdk/v1/guide/troubleshooting.md @@ -19 +19 @@ This topic describes how to troubleshoot the following issues with the AWS CDK. - * When synthesizing an AWS CDK stack, I receive an error because the AWS CloudFormation template contains too many resources + * When synthesizing an AWS CDK stack, I receive an error because the CloudFormation template contains too many resources @@ -167 +167 @@ To run a locally-installed AWS CDK Toolkit, use the command `npx aws-cdk` rather -Your AWS environment does not have a staging bucket, which the AWS CDK uses to hold resources during deployment. Stacks require this bucket if they contain [Assets](./assets.html) or synthesize to AWS CloudFormation templates larger than 50 kilobytes. You can create the staging bucket with the following command: +Your AWS environment does not have a staging bucket, which the AWS CDK uses to hold resources during deployment. Stacks require this bucket if they contain [Assets](./assets.html) or synthesize to CloudFormation templates larger than 50 kilobytes. You can create the staging bucket with the following command: @@ -187 +187 @@ For more information, see [Bootstrapping](./bootstrapping.html) -You are deploying a stack that requires the use of a staging bucket, but are using an IAM role or account that lacks permission to write to it. (The staging bucket is used when deploying stacks that contain assets or that synthesize an AWS CloudFormation template larger than 50K.) Use an account or role that has permission to perform the action `s3:*` against the resource `arn:aws:s3:::cdktoolkit-stagingbucket-*`. +You are deploying a stack that requires the use of a staging bucket, but are using an IAM role or account that lacks permission to write to it. (The staging bucket is used when deploying stacks that contain assets or that synthesize an CloudFormation template larger than 50K.) Use an account or role that has permission to perform the action `s3:*` against the resource `arn:aws:s3:::cdktoolkit-stagingbucket-*`. @@ -218 +218 @@ For example, you might synthesize a stack from a TypeScript app as follows. -###### When synthesizing an AWS CDK stack, I receive an error because the AWS CloudFormation template contains too many resources +###### When synthesizing an AWS CDK stack, I receive an error because the CloudFormation template contains too many resources @@ -220 +220 @@ For example, you might synthesize a stack from a TypeScript app as follows. -The AWS CDK generates and deploys AWS CloudFormation templates. AWS CloudFormation has a hard limit on the number of resources a stack can contain. With the AWS CDK, you can run up against this limit more quickly than you might expect. +The AWS CDK generates and deploys CloudFormation templates. CloudFormation has a hard limit on the number of resources a stack can contain. With the AWS CDK, you can run up against this limit more quickly than you might expect. @@ -224 +224 @@ The AWS CDK generates and deploys AWS CloudFormation templates. AWS CloudFormati -The AWS CloudFormation resource limit is 500 at this writing. See [AWS CloudFormation quotas](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cloudformation-limits.html) for the current resource limit. +The CloudFormation resource limit is 500 at this writing. See [CloudFormation quotas](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cloudformation-limits.html) for the current resource limit. @@ -228 +228 @@ The AWS Construct Library's higher-level, intent-based constructs automatically -In our experience, real-world use of intent-based constructs results in 1–5 AWS CloudFormation resources per construct, though this can vary. For serverless applications, 5–8 AWS resources per API endpoint is typical. +In our experience, real-world use of intent-based constructs results in 1–5 CloudFormation resources per construct, though this can vary. For serverless applications, 5–8 AWS resources per API endpoint is typical. @@ -230 +230 @@ In our experience, real-world use of intent-based constructs results in 1–5 AW -Patterns, which represent a higher level of abstraction, let you define even more AWS resources with even less code. The AWS CDK code in [Creating an AWS Fargate service using the AWS CDK](./ecs-example.html), for example, generates more than fifty AWS CloudFormation resources while defining only three constructs! +Patterns, which represent a higher level of abstraction, let you define even more AWS resources with even less code. The AWS CDK code in [Creating an AWS Fargate service using the AWS CDK](./ecs-example.html), for example, generates more than fifty CloudFormation resources while defining only three constructs! @@ -232 +232 @@ Patterns, which represent a higher level of abstraction, let you define even mor -Exceeding the AWS CloudFormation resource limit is an error during AWS CloudFormation synthesis. The AWS CDK issues a warning if your stack exceeds 80% of the limit. You can use a different limit by setting the `maxResources` property on your stack, or disable validation by setting `maxResources` to 0. +Exceeding the CloudFormation resource limit is an error during CloudFormation synthesis. The AWS CDK issues a warning if your stack exceeds 80% of the limit. You can use a different limit by setting the `maxResources` property on your stack, or disable validation by setting `maxResources` to 0. @@ -255 +255 @@ As your stack's resource count approaches the limit, consider re-architecting to -AWS CloudFormation experts often suggest the use of nested stacks as a solution to the resource limit. The AWS CDK supports this approach via the [NestedStack](./stacks.html#stack-nesting) construct. +CloudFormation experts often suggest the use of nested stacks as a solution to the resource limit. The AWS CDK supports this approach via the [NestedStack](./stacks.html#stack-nesting) construct. @@ -261 +261 @@ AWS CloudFormation experts often suggest the use of nested stacks as a solution -To get the number of Availability Zones you requested, specify the account and region in the stack's `env` property. If you do not specify both, the AWS CDK, by default, synthesizes the stack as environment-agnostic, such that it can be deployed to any region. You can then deploy the stack to a specific region using AWS CloudFormation. Because some regions have only two availability zones, an environment-agnostic template never uses more than two. +To get the number of Availability Zones you requested, specify the account and region in the stack's `env` property. If you do not specify both, the AWS CDK, by default, synthesizes the stack as environment-agnostic, such that it can be deployed to any region. You can then deploy the stack to a specific region using CloudFormation. Because some regions have only two availability zones, an environment-agnostic template never uses more than two. @@ -365 +365 @@ C# -AWS CloudFormation cannot delete a non-empty Amazon S3 bucket. If you set an Amazon S3 bucket's removal policy to `DESTROY`, and it contains data, attempting to destroy the stack will fail because the bucket cannot be deleted. You can have the AWS CDK delete the objects in the bucket before attempting to destroy it by setting the bucket's `autoDeleteObjects` prop to `true`. +CloudFormation cannot delete a non-empty Amazon S3 bucket. If you set an Amazon S3 bucket's removal policy to `DESTROY`, and it contains data, attempting to destroy the stack will fail because the bucket cannot be deleted. You can have the AWS CDK delete the objects in the bucket before attempting to destroy it by setting the bucket's `autoDeleteObjects` prop to `true`.