AWS cdk documentation change
Summary
Updated references from 'AWS CloudFormation' to 'CloudFormation' for terminology consistency
Security assessment
The changes are purely branding/naming updates (removing redundant 'AWS' prefix from CloudFormation references). No security vulnerabilities, mitigations, or security features are mentioned or modified in these changes. This appears to be a documentation style update rather than a security-related change.
Diff
diff --git a/cdk/v1/guide/bootstrapping.md b/cdk/v1/guide/bootstrapping.md index 37e9ea3e9..09f911f25 100644 --- a//cdk/v1/guide/bootstrapping.md +++ b//cdk/v1/guide/bootstrapping.md @@ -15 +15 @@ An environment needs to be bootstrapped if any of the following apply. - * An AWS CloudFormation template generated by the app exceeds 50 kilobytes. + * An CloudFormation template generated by the app exceeds 50 kilobytes. @@ -22 +22 @@ An environment needs to be bootstrapped if any of the following apply. -The required resources are defined in a AWS CloudFormation stack, called the _bootstrap stack_ , which is usually named `CDKToolkit`. Like any AWS CloudFormation stack, it appears in the AWS CloudFormation console once it has been deployed. +The required resources are defined in a CloudFormation stack, called the _bootstrap stack_ , which is usually named `CDKToolkit`. Like any CloudFormation stack, it appears in the CloudFormation console once it has been deployed. @@ -51 +51 @@ Do not delete and recreate an account's bootstrap stack if you are using CDK Pip -Bootstrapping is the deployment of a AWS CloudFormation template to a specific AWS environment (account and region). The bootstrapping template accepts parameters that customize some aspects of the bootstrapped resources (see Customizing bootstrapping). Thus, you can bootstrap in one of two ways. +Bootstrapping is the deployment of a CloudFormation template to a specific AWS environment (account and region). The bootstrapping template accepts parameters that customize some aspects of the bootstrapped resources (see Customizing bootstrapping). Thus, you can bootstrap in one of two ways. @@ -55 +55 @@ Bootstrapping is the deployment of a AWS CloudFormation template to a specific A - * Deploy the template provided by the AWS CDK Toolkit using another AWS CloudFormation deployment tool. This lets you use AWS CloudFormation Stack Sets or AWS Control Tower as well as the AWS CloudFormation console or the AWS CLI. You can even make small modifications to the template before deployment. This approach is more flexible and is suitable for large-scale deployments. + * Deploy the template provided by the AWS CDK Toolkit using another CloudFormation deployment tool. This lets you use CloudFormation Stack Sets or AWS Control Tower as well as the CloudFormation console or the AWS CLI. You can even make small modifications to the template before deployment. This approach is more flexible and is suitable for large-scale deployments. @@ -82 +82 @@ For example, the following command synthesizes the current AWS CDK app using the -### Bootstrapping from the AWS CloudFormation template +### Bootstrapping from the CloudFormation template @@ -84 +84 @@ For example, the following command synthesizes the current AWS CDK app using the -AWS CDK bootstrapping is performed by an AWS CloudFormation template. To get a copy of this template in the file `bootstrap-template.yaml`, run the following command. +AWS CDK bootstrapping is performed by an CloudFormation template. To get a copy of this template in the file `bootstrap-template.yaml`, run the following command. @@ -102 +102 @@ The template is also available in the [AWS CDK GitHub repository](https://github -Deploy this template using the CDK CLI or your preferred deployment mechanism for AWS CloudFormation templates. To deploy using the CDK CLI, run **cdk bootstrap --template`TEMPLATE_FILENAME`**. You can also deploy it using the AWS CLI by running the command below, or [deploy to one or more accounts at once using AWS CloudFormation Stack Sets](https://aws.amazon.com/blogs/mt/bootstrapping-multiple-aws-accounts-for-aws-cdk-using-cloudformation-stacksets/). +Deploy this template using the CDK CLI or your preferred deployment mechanism for CloudFormation templates. To deploy using the CDK CLI, run **cdk bootstrap --template`TEMPLATE_FILENAME`**. You can also deploy it using the AWS CLI by running the command below, or [deploy to one or more accounts at once using CloudFormation Stack Sets](https://aws.amazon.com/blogs/mt/bootstrapping-multiple-aws-accounts-for-aws-cdk-using-cloudformation-stacksets/). @@ -131 +131 @@ Feature | Legacy | Modern -**AWS CloudFormation Permissions** | Deploys using current user's permissions (determined by AWS profile, environment variables, etc.) | Deploys using the permissions specified when the bootstrap stack was provisioned (e.g. using `--trust`) +**CloudFormation Permissions** | Deploys using current user's permissions (determined by AWS profile, environment variables, etc.) | Deploys using the permissions specified when the bootstrap stack was provisioned (e.g. using `--trust`) @@ -194 +194 @@ The following command-line options, when used with CDK Toolkit's **cdk bootstrap - * **\--tags** adds one or more AWS CloudFormation tags to the bootstrap stack. + * **\--tags** adds one or more CloudFormation tags to the bootstrap stack. @@ -196 +196 @@ The following command-line options, when used with CDK Toolkit's **cdk bootstrap - * **\--termination-protection** prevents the bootstrap stack from being deleted (see [Protecting a stack from being deleted](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-protect-stacks.html) in the AWS CloudFormation User Guide) + * **\--termination-protection** prevents the bootstrap stack from being deleted (see [Protecting a stack from being deleted](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-protect-stacks.html) in the CloudFormation User Guide) @@ -203 +203 @@ The following additional switches are available only with the modern bootstrappi - * **\--cloudformation-execution-policies** specifies the ARNs of managed policies that should be attached to the deployment role assumed by AWS CloudFormation during deployment of your stacks. By default, stacks are deployed with full administrator privileges using the `AdministratorAccess` policy. + * **\--cloudformation-execution-policies** specifies the ARNs of managed policies that should be attached to the deployment role assumed by CloudFormation during deployment of your stacks. By default, stacks are deployed with full administrator privileges using the `AdministratorAccess` policy. @@ -246 +246 @@ Any modifications you make must adhere to the bootstrapping template contract. T -Deploy your modified template as described in Bootstrapping from the AWS CloudFormation template, or using **cdk bootstrap --template**. +Deploy your modified template as described in Bootstrapping from the CloudFormation template, or using **cdk bootstrap --template**. @@ -332 +332 @@ Feature | LegacyStackSynthesizer | DefaultStackSynthesizer -**Assets** | Uses AWS CloudFormation parameters to reference assets | Expects assets to be in a predictable location +**Assets** | Uses CloudFormation parameters to reference assets | Expects assets to be in a predictable location @@ -335 +335 @@ Feature | LegacyStackSynthesizer | DefaultStackSynthesizer -**Versioning** | Not supported | Confirms versions of bootstrapping resources via embedded AWS CloudFormation rule +**Versioning** | Not supported | Confirms versions of bootstrapping resources via embedded CloudFormation rule @@ -347 +347 @@ The `LegacyStackSynthesizer` does not offer any customization properties. -The _qualifier_ is added to the name of bootstrap resources to distinguish the resources in separate bootstrap stacks. To deploy two different versions of the bootstrap stack in the same environment (AWS account and region), then, the stacks must have different qualifiers. This feature is intended for name isolation between automated tests of the CDK itself. Unless you can very precisely scope down the IAM permissions given to the AWS CloudFormation execution role, there are no privilege isolation benefits to having two different bootstrap stacks in a single account, so there is usually no need to change this value. +The _qualifier_ is added to the name of bootstrap resources to distinguish the resources in separate bootstrap stacks. To deploy two different versions of the bootstrap stack in the same environment (AWS account and region), then, the stacks must have different qualifiers. This feature is intended for name isolation between automated tests of the CDK itself. Unless you can very precisely scope down the IAM permissions given to the CloudFormation execution role, there are no privilege isolation benefits to having two different bootstrap stacks in a single account, so there is usually no need to change this value. @@ -643 +643 @@ The `DefaultStackSynthesizer` requires five IAM roles for five different purpose - * _The AWS CloudFormation execution role_ is passed to AWS CloudFormation to perform the actual deployment. Its permissions are the permissions that the deployment will execute under. The permissions are passed to the stack as a parameter that lists managed policy ARNs. + * _The CloudFormation execution role_ is passed to CloudFormation to perform the actual deployment. Its permissions are the permissions that the deployment will execute under. The permissions are passed to the stack as a parameter that lists managed policy ARNs. @@ -674 +674 @@ Template version | AWS CDK version | Changes -**7** | 1.110.0 | Deployment role can no longer read Buckets in the target account directly (however, this role is effectively an administrator, and could always use its AWS CloudFormation permissions to make the bucket readable anyway). +**7** | 1.110.0 | Deployment role can no longer read Buckets in the target account directly (however, this role is effectively an administrator, and could always use its CloudFormation permissions to make the bucket readable anyway).