这是 AWS CDK v2 开发者指南。较旧的 CDK v1 于 2022 年 6 月 1 日进入维护阶段，并于 2023 年 6 月 1 日终止支持。

本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

将现有资源和 AWS CloudFormation 模板迁移到 AWS CDK

使用 AWS Cloud Development Kit (AWS CDK) 命令行界面 (AWS CDK CLI) 将已部署的 AWS 资源、已部署的 AWS CloudFormation 堆栈和本地 AWS CloudFormation 模板迁移到 AWS CDK。

迁移的工作原理

使用 AWS CDK CLIcdk migrate命令从以下来源迁移：

迁移后，您可以管理、修改和部署您的 CDK 应用程序， AWS CloudFormation 以配置或更新您的资源。

CDK 迁移的好处

从历史上看 AWS CDK ，将资源迁移到中一直是一个手动过程，需要时间 AWS CloudFormation 和专业知识 AWS CDK ，甚至需要开始。使用 CDK Migr AWS CDK CLI ate，可以在很短的时间内为您完成大部分迁移工作。CDK Migrate 可以让你快速开始使用开发和管理新的和现有的应用程序。 AWS CDK AWS

注意事项

一般注意事项

从 AWS CloudFormation 模板迁移时的注意事项

从已部署的资源迁移时的注意事项

先决条件

在使用该cdk migrate命令之前，请执行以下操作：

开始使用 CDK 迁移

首先，从您选择的目录中运行该 AWS CDK CLIcdk migrate命令。根据您正在执行的迁移类型，提供必填选项和可选选项。

有关可与之配合使用的选项的完整列表和说明cdk migrate，请参阅cdk migrate。

以下是您可能需要提供的一些重要选项。

从 AWS CloudFormation 堆栈迁移

要从已部署的 AWS CloudFormation 堆栈迁移，请提供--from-stack选项。使用提供已部署 AWS CloudFormation 堆栈的名称--stack-name。以下是 示例：

$ cdk migrate --from-stack --stack-name "myCloudFormationStack"

AWS CDK CLI将执行以下操作：

当您从已部署的 AWS CloudFormation 堆栈迁移时，会 AWS CDK CLI尝试将已部署的资源逻辑 ID 和已部署的 AWS CloudFormation 堆栈名称与新 CDK 应用程序中迁移的资源和堆栈进行匹配。

迁移后，您可以正常管理和修改您的 CDK 应用程序。部署时，由于 AWS CloudFormation 堆栈名称匹配， AWS CloudFormation 会将部署标识为 AWS CloudFormation 堆栈更新。将更新具有匹配逻辑 ID 的资源。有关部署的更多信息，请参阅管理和部署您的 CDK 应用程序。

从 AWS CloudFormation 模板迁移

CDK Migrate 支持从格式为JSON或YAML的 AWS CloudFormation 模板迁移。

要从本地 AWS CloudFormation 模板迁移，请使用--from-path选项并提供本地模板的路径。您还必须提供所需的--stack-name选项。以下是 示例：

$ cdk migrate --from-path "./template.json" --stack-name "myCloudFormationStack"

AWS CDK CLI将执行以下操作：

迁移后，您可以正常管理和修改您的 CDK 应用程序。部署时，您可以选择以下选项：

从 AWS SAM 模板迁移

要从 AWS Serverless Application Model (AWS SAM) 模板迁移，必须先将其转换为 AWS CloudFormation 模板或部署以创建 AWS CloudFormation 堆栈。

要将 AWS SAM 模板转换为 AWS CloudFormation，可以使用 AWS SAM CLIsam validate --debug命令。在运行此命令之前lint，您可能需要false在samconfig.toml文件中将其设置为。

要转换为 AWS CloudFormation 堆栈，请使用部署 AWS SAM 模板 AWS SAM CLI。然后从已部署的堆栈迁移。

从已部署的资源迁移

要从已部署的 AWS 资源迁移，请提供--from-scan选项。您还必须提供所需的--stack-name选项。以下是 示例：

$ cdk migrate --from-scan --stack-name "myCloudFormationStack"

AWS CDK CLI将执行以下操作：

使用过滤器

默认情况下， AWS CDK CLI将扫描整个 AWS 环境并迁移不超过 IaC 生成器的最大配额限制的资源。您可以为过滤器提供过滤器 AWS CDK CLI，以指定将资源从您的账户迁移到新 CDK 应用程序所依据的标准。要了解更多信息，请参阅--filter。

使用 iaC 生成器扫描资源

根据您账户中的资源数量，扫描可能需要几分钟。扫描过程中将显示一个进度条。

解析只写属性

一些支持的资源包含只写属性。可以写入这些属性来配置属性，但不能被 IaC 生成器读 AWS CloudFormation 取或获取值。例如，出于安全考虑，用于指定数据库密码的属性可能是只写的。

在迁移期间扫描资源时，IaC 生成器将检测可能包含只写属性的资源，并将其归类为以下任何类型：

有关只写属性以及 IaC 生成器在扫描已部署资源和创建 AWS CloudFormation 模板时如何管理这些属性的更多信息，请参阅《用户指南》中的 IaC 生成器和只写属性。AWS CloudFormation

迁移后，您必须在新 CDK 应用程序中指定只写属性值。 AWS CDK CLI将在 CDK 项目的ReadMe文件中追加警告部分，以记录 IaC 生成器识别的所有只写属性。以下是 示例：

# Welcome to your CDK TypeScript project
...
## Warnings
### Write-only properties
Write-only properties are resource property values that can be written to but can't be read by AWS CloudFormation or CDK Migrate. For more information, see [IaC generator and write-only properties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/generate-IaC-write-only-properties.html).

Write-only properties discovered during migration are organized here by resource ID and categorized by write-only property type. Resolve write-only properties by providing property values in your CDK app. For guidance, see [Resolve write-only properties](https://docs.aws.amazon.com/cdk/v2/guide/migrate.html#migrate-resources-writeonly).
### MyLambdaFunction
- **UNSUPPORTED_PROPERTIES**: 
  - SnapStart/ApplyOn: Applying SnapStart setting on function resource type.Possible values: [PublishedVersions, None]
This property can be replaced with other types
  - Code/S3ObjectVersion: For versioned objects, the version of the deployment package object to use.
This property can be replaced with other exclusive properties
- **MUTUALLY_EXCLUSIVE_PROPERTIES**: 
  - Code/S3Bucket: An Amazon S3 bucket in the same AWS Region as your function. The bucket can be in a different AWS account.
This property can be replaced with other exclusive properties
  - Code/S3Key: The Amazon S3 key of the deployment package.
This property can be replaced with other exclusive properties

解析完所有只写属性值后，就可以为部署做好准备了。

迁移.json 文件

迁移期间会在您的 AWS CDK 项目中 AWS CDK CLI创建一个migrate.json文件。此文件包含有关已部署资源的参考信息。首次部署 CDK 应用程序时，会 AWS CDK CLI使用此文件引用已部署的资源，将您的资源与新 AWS CloudFormation 堆栈关联起来，然后删除该文件。

管理和部署您的 CDK 应用程序

迁移到时 AWS CDK，新的 CDK 应用程序可能无法立即部署就绪。本主题介绍在管理和部署新 CDK 应用程序时需要考虑的操作项目。

准备部署

在部署之前，您必须准备好您的 CDK 应用程序。

部署你的 CDK 应用程序

当您部署 CDK 应用程序时， AWS CDK CLI会利用该 AWS CloudFormation 服务来配置您的资源。资源在 CDK 应用程序中捆绑到单个堆栈中，并作为单个 AWS CloudFormation 堆栈进行部署。

根据您从何处迁移，您可以进行部署以创建新 AWS CloudFormation 堆栈或更新现有 AWS CloudFormation 堆栈。