AWS cdk documentation change
Summary
Updated terminology from 'AWS CloudFormation' to 'CloudFormation' throughout the document for consistency
Security assessment
The changes are purely branding/terminology updates (removing redundant 'AWS' prefix from CloudFormation references). There is no evidence of security vulnerability fixes, security incident references, or new security controls being documented.
Diff
diff --git a/cdk/v1/guide/use-cfn-template.md b/cdk/v1/guide/use-cfn-template.md index a1bd3727e..19ebf1d46 100644 --- a//cdk/v1/guide/use-cfn-template.md +++ b//cdk/v1/guide/use-cfn-template.md @@ -7 +7 @@ This is the AWS CDK v1 Developer Guide. The older CDK v1 entered maintenance on -# Import or migrate an existing AWS CloudFormation template +# Import or migrate an existing CloudFormation template @@ -9 +9 @@ This is the AWS CDK v1 Developer Guide. The older CDK v1 entered maintenance on -The [`cloudformation-include.CfnInclude`](https://docs.aws.amazon.com/cdk/api/v1/docs/cloudformation-include-readme.html) construct converts the resources in an imported AWS CloudFormation template to AWS CDK L1 constructs. You can work with these in your app just as if they were defined in AWS CDK code, even using them within higher-level AWS CDK constructs, letting you use (for example) the L2 permission grant methods with the resources they define. +The [`cloudformation-include.CfnInclude`](https://docs.aws.amazon.com/cdk/api/v1/docs/cloudformation-include-readme.html) construct converts the resources in an imported CloudFormation template to AWS CDK L1 constructs. You can work with these in your app just as if they were defined in AWS CDK code, even using them within higher-level AWS CDK constructs, letting you use (for example) the L2 permission grant methods with the resources they define. @@ -11 +11 @@ The [`cloudformation-include.CfnInclude`](https://docs.aws.amazon.com/cdk/api/v1 -This construct essentially adds an AWS CDK API wrapper to any resource in the template. You can use this capability to migrate your existing AWS CloudFormation templates to the AWS CDK a piece at a time in order to take advantage of the AWS CDK's convenient higher-level abstractions, or just to vend your AWS CloudFormation templates to AWS CDK developers by providing an AWS CDK construct API. +This construct essentially adds an AWS CDK API wrapper to any resource in the template. You can use this capability to migrate your existing CloudFormation templates to the AWS CDK a piece at a time in order to take advantage of the AWS CDK's convenient higher-level abstractions, or just to vend your CloudFormation templates to AWS CDK developers by providing an AWS CDK construct API. @@ -59 +59 @@ Right-click the project in Visual Studio's Solution Explorer and choose **Manage -## Importing an AWS CloudFormation template +## Importing an CloudFormation template @@ -61 +61 @@ Right-click the project in Visual Studio's Solution Explorer and choose **Manage -Here is a simple AWS CloudFormation template we'll use for the examples in this topic. Save it as `my-template.json`. After you've tried these examples with the provided template, you might explore further using a template for an actual stack you've already deployed, which you can obtain from the AWS CloudFormation console. +Here is a simple CloudFormation template we'll use for the examples in this topic. Save it as `my-template.json`. After you've tried these examples with the provided template, you might explore further using a template for an actual stack you've already deployed, which you can obtain from the CloudFormation console. @@ -177 +177 @@ C# -By default, importing a resource preserves the resource's original logical ID from the template. This behavior is suitable for migrating an AWS CloudFormation template to the AWS CDK, where the logical IDs must be retained for AWS CloudFormation to recognize these as the same resources from the AWS CloudFormation template. +By default, importing a resource preserves the resource's original logical ID from the template. This behavior is suitable for migrating an CloudFormation template to the AWS CDK, where the logical IDs must be retained for CloudFormation to recognize these as the same resources from the CloudFormation template. @@ -297 +297 @@ To verify that there will be no unintended changes to the AWS resources in the s -When you `cdk deploy` the stack, your AWS CDK app becomes the source of truth for the stack. Going forward, make changes to the AWS CDK app, not to the AWS CloudFormation template. +When you `cdk deploy` the stack, your AWS CDK app becomes the source of truth for the stack. Going forward, make changes to the AWS CDK app, not to the CloudFormation template. @@ -301 +301 @@ When you `cdk deploy` the stack, your AWS CDK app becomes the source of truth fo -The name `template` in the example code represents the imported AWS CloudFormation template. To access a resource from it, use this object's [`getResource()`](https://docs.aws.amazon.com/cdk/api/v1/docs/@aws-cdk_cloudformation-include.CfnInclude.html#get-wbr-resourcelogicalid-span-class-api-icon-api-icon-experimental-title-this-api-element-is-experimental-it-may-change-without-notice-span) method. To access the returned resource as a specific kind of resource, cast the result to the desired type. (Casting is not necessary in Python and JavaScript.) +The name `template` in the example code represents the imported CloudFormation template. To access a resource from it, use this object's [`getResource()`](https://docs.aws.amazon.com/cdk/api/v1/docs/@aws-cdk_cloudformation-include.CfnInclude.html#get-wbr-resourcelogicalid-span-class-api-icon-api-icon-experimental-title-this-api-element-is-experimental-it-may-change-without-notice-span) method. To access the returned resource as a specific kind of resource, cast the result to the desired type. (Casting is not necessary in Python and JavaScript.) @@ -333 +333 @@ C# -In our example, `cfnBucket` is now an instance of the [`aws-s3.CfnBucket`](https://docs.aws.amazon.com/cdk/api/v1/docs/@aws-cdk_aws-s3.CfnBucket.html) class, a L1 construct that exactly represents the corresponding AWS CloudFormation resource. You can treat it like any other resource of its type, for example getting its ARN by way of the `bucket.attrArn` property. +In our example, `cfnBucket` is now an instance of the [`aws-s3.CfnBucket`](https://docs.aws.amazon.com/cdk/api/v1/docs/@aws-cdk_aws-s3.CfnBucket.html) class, a L1 construct that exactly represents the corresponding CloudFormation resource. You can treat it like any other resource of its type, for example getting its ARN by way of the `bucket.attrArn` property. @@ -405 +405 @@ C# -If your included AWS CloudFormation template has parameters, you can replace these with build-time values when you import the template, using the `parameters` property. In the example below, we replace the `UploadBucket` parameter with the ARN of a bucket defined elsewhere in our AWS CDK code. +If your included CloudFormation template has parameters, you can replace these with build-time values when you import the template, using the `parameters` property. In the example below, we replace the `UploadBucket` parameter with the ARN of a bucket defined elsewhere in our AWS CDK code. @@ -463 +463 @@ C# -You can import any AWS CloudFormation template element, not just resources. The imported elements become part of the AWS CDK stack. To import these elements, use the following methods of the `CfnInclude` object. +You can import any CloudFormation template element, not just resources. The imported elements become part of the AWS CDK stack. To import these elements, use the following methods of the `CfnInclude` object. @@ -465 +465 @@ You can import any AWS CloudFormation template element, not just resources. The - * [`getCondition()`](https://docs.aws.amazon.com/cdk/api/v1/docs/@aws-cdk_cloudformation-include.CfnInclude.html#get-wbr-conditionconditionname-span-class-api-icon-api-icon-experimental-title-this-api-element-is-experimental-it-may-change-without-notice-span) \- AWS CloudFormation [conditions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/conditions-section-structure.html) + * [`getCondition()`](https://docs.aws.amazon.com/cdk/api/v1/docs/@aws-cdk_cloudformation-include.CfnInclude.html#get-wbr-conditionconditionname-span-class-api-icon-api-icon-experimental-title-this-api-element-is-experimental-it-may-change-without-notice-span) \- CloudFormation [conditions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/conditions-section-structure.html) @@ -467 +467 @@ You can import any AWS CloudFormation template element, not just resources. The - * [`getHook()`](https://docs.aws.amazon.com/cdk/api/v1/docs/@aws-cdk_cloudformation-include.CfnInclude.html#get-wbr-hookhooklogicalid-span-class-api-icon-api-icon-experimental-title-this-api-element-is-experimental-it-may-change-without-notice-span) \- AWS CloudFormation [hooks](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/blue-green.html) for blue-green deployments + * [`getHook()`](https://docs.aws.amazon.com/cdk/api/v1/docs/@aws-cdk_cloudformation-include.CfnInclude.html#get-wbr-hookhooklogicalid-span-class-api-icon-api-icon-experimental-title-this-api-element-is-experimental-it-may-change-without-notice-span) \- CloudFormation [hooks](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/blue-green.html) for blue-green deployments @@ -469 +469 @@ You can import any AWS CloudFormation template element, not just resources. The - * [`getMapping()`](https://docs.aws.amazon.com/cdk/api/v1/docs/@aws-cdk_cloudformation-include.CfnInclude.html#get-wbr-mappingmappingname-span-class-api-icon-api-icon-experimental-title-this-api-element-is-experimental-it-may-change-without-notice-span) \- AWS CloudFormation [mappings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/mappings-section-structure.html) + * [`getMapping()`](https://docs.aws.amazon.com/cdk/api/v1/docs/@aws-cdk_cloudformation-include.CfnInclude.html#get-wbr-mappingmappingname-span-class-api-icon-api-icon-experimental-title-this-api-element-is-experimental-it-may-change-without-notice-span) \- CloudFormation [mappings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/mappings-section-structure.html) @@ -471 +471 @@ You can import any AWS CloudFormation template element, not just resources. The - * [`getOutput()`](https://docs.aws.amazon.com/cdk/api/v1/docs/@aws-cdk_cloudformation-include.CfnInclude.html#get-wbr-outputlogicalid-span-class-api-icon-api-icon-experimental-title-this-api-element-is-experimental-it-may-change-without-notice-span) \- AWS CloudFormation [outputs](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/outputs-section-structure.html) + * [`getOutput()`](https://docs.aws.amazon.com/cdk/api/v1/docs/@aws-cdk_cloudformation-include.CfnInclude.html#get-wbr-outputlogicalid-span-class-api-icon-api-icon-experimental-title-this-api-element-is-experimental-it-may-change-without-notice-span) \- CloudFormation [outputs](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/outputs-section-structure.html) @@ -473 +473 @@ You can import any AWS CloudFormation template element, not just resources. The - * [`getParameter()`](https://docs.aws.amazon.com/cdk/api/v1/docs/@aws-cdk_cloudformation-include.CfnInclude.html#get-wbr-parameterparametername-span-class-api-icon-api-icon-experimental-title-this-api-element-is-experimental-it-may-change-without-notice-span) \- AWS CloudFormation [parameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html) + * [`getParameter()`](https://docs.aws.amazon.com/cdk/api/v1/docs/@aws-cdk_cloudformation-include.CfnInclude.html#get-wbr-parameterparametername-span-class-api-icon-api-icon-experimental-title-this-api-element-is-experimental-it-may-change-without-notice-span) \- CloudFormation [parameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html) @@ -475 +475 @@ You can import any AWS CloudFormation template element, not just resources. The - * [`getRule()`](https://docs.aws.amazon.com/cdk/api/v1/docs/@aws-cdk_cloudformation-include.CfnInclude.html#get-wbr-rulerulename-span-class-api-icon-api-icon-experimental-title-this-api-element-is-experimental-it-may-change-without-notice-span) \- AWS CloudFormation [rules](https://docs.aws.amazon.com/servicecatalog/latest/adminguide/reference-template_constraint_rules.html) for Service Catalog templates + * [`getRule()`](https://docs.aws.amazon.com/cdk/api/v1/docs/@aws-cdk_cloudformation-include.CfnInclude.html#get-wbr-rulerulename-span-class-api-icon-api-icon-experimental-title-this-api-element-is-experimental-it-may-change-without-notice-span) \- CloudFormation [rules](https://docs.aws.amazon.com/servicecatalog/latest/adminguide/reference-template_constraint_rules.html) for Service Catalog templates @@ -480 +480 @@ You can import any AWS CloudFormation template element, not just resources. The -Each of these methods returns an instance of a class representing the specific type of AWS CloudFormation element. These objects are mutable; changes you make to them will appear in the template generated from the AWS CDK stack. The code below, for example, imports a parameter from the template and modifies its default. +Each of these methods returns an instance of a class representing the specific type of CloudFormation element. These objects are mutable; changes you make to them will appear in the template generated from the AWS CDK stack. The code below, for example, imports a parameter from the template and modifies its default. @@ -652 +652 @@ C# -The `getNestedStack()` method returns an [`IncludedNestedStack`](https://docs.aws.amazon.com/cdk/api/v1/docs/@aws-cdk_cloudformation-include.IncludedNestedStack.html) instance, from which you can access the AWS CDK [`NestedStack`](https://docs.aws.amazon.com/cdk/api/v1/docs/@aws-cdk_core.NestedStack.html) instance via the `stack` property (as shown in the example) or the original AWS CloudFormation template object via `includedTemplate`, from which you can load resources and other AWS CloudFormation elements. +The `getNestedStack()` method returns an [`IncludedNestedStack`](https://docs.aws.amazon.com/cdk/api/v1/docs/@aws-cdk_cloudformation-include.IncludedNestedStack.html) instance, from which you can access the AWS CDK [`NestedStack`](https://docs.aws.amazon.com/cdk/api/v1/docs/@aws-cdk_core.NestedStack.html) instance via the `stack` property (as shown in the example) or the original CloudFormation template object via `includedTemplate`, from which you can load resources and other CloudFormation elements.