Este é o Guia do desenvolvedor do AWS CDK v2. O CDK v1 antigo entrou em manutenção em 1º de junho de 2022 e encerrou o suporte em 1º de junho de 2023.

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

Migre recursos e AWS CloudFormation modelos existentes para o CDK AWS

Use a interface de linha de comando (AWS CDK AWS CLI) do AWS Cloud Development Kit (CDK) para migrar AWS recursos implantados, AWS CloudFormation pilhas implantadas e modelos locais para o CDK. AWS CloudFormation AWS

Como funciona a migração

Use o comando AWS CDK cdk migrate CLI para migrar das seguintes fontes:

Benefícios do CDK Migrate

Historicamente, a migração de recursos para o AWS CDK tem sido um processo manual que requer tempo e experiência com AWS CloudFormation o AWS CDK para começar. Com o CDK Migrate, a CLI do AWS CDK facilita a maior parte do esforço de migração para você em uma fração do tempo. O CDK Migrate fará com que você comece rapidamente a usar o AWS CDK para desenvolver e gerenciar aplicativos novos e existentes no. AWS

Considerações

Considerações gerais

Considerações ao migrar de um modelo AWS CloudFormation

Considerações ao migrar dos recursos implantados

Pré-requisitos

Antes de usar o cdk migrate comando, conclua todas as etapas de configuração em Introdução ao AWS CDK.

Começar a usar o CDK Migrate

Para começar, execute o comando AWS CDK cdk migrate CLI em um diretório de sua escolha. Forneça as opções necessárias e opcionais, dependendo do tipo de migração que você está realizando.

Para obter uma lista completa e uma descrição das opções que você pode usarcdk migrate, consulte cdk migrate.

A seguir estão algumas opções importantes que você pode oferecer.

Migre de uma pilha AWS CloudFormation

Para migrar de uma AWS CloudFormation pilha implantada, forneça a opção. --from-stack Forneça o nome da sua AWS CloudFormation pilha implantada com. --stack-name Veja um exemplo a seguir:

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

A CLI do AWS CDK fará o seguinte:

Quando você migra de uma AWS CloudFormation pilha implantada, a AWS CLI do CDK tenta combinar a lógica do recurso implantado e o nome da pilha implantada com os recursos IDs e a AWS CloudFormation pilha migrados no novo aplicativo CDK.

Após a migração, você pode gerenciar e modificar sua aplicação do CDK normalmente. Ao implantar, AWS CloudFormation identificará a implantação como uma atualização da AWS CloudFormation pilha devido ao nome da AWS CloudFormation pilha correspondente. Os recursos com a lógica correspondente IDs serão atualizados. Para obter mais informações sobre implantação, consulte Gerenciar e implantar seu aplicativo CDK.

Migrar de um modelo AWS CloudFormation

O CDK Migrate suporta a migração de AWS CloudFormation modelos formatados em ou. JSON YAML

Para migrar de um AWS CloudFormation modelo local, use a --from-path opção e forneça um caminho para o modelo local. Também é necessário fornecer a opção --stack-name obrigatória. Veja um exemplo a seguir:

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

A CLI do AWS CDK fará o seguinte:

Após a migração, você pode gerenciar e modificar sua aplicação do CDK normalmente. Na implantação, você tem as seguintes opções:

Migrar de um modelo de AWS SAM

Para migrar de um modelo de modelo de aplicativo AWS sem servidor (AWS SAM), você deve primeiro convertê-lo em um AWS CloudFormation modelo ou implantá-lo para criar uma pilha. AWS CloudFormation

Para converter um modelo do AWS SAM em AWS CloudFormation, você pode usar o comando CLI sam validate --debug do AWS SAM. Talvez seja necessário definir lint como false em seu arquivo samconfig.toml antes de executar esse comando.

Para converter em uma AWS CloudFormation pilha, implante o modelo do AWS SAM usando a CLI do AWS SAM. Em seguida, migre da pilha implantada.

Migrar dos recursos implantados

Para migrar dos AWS recursos implantados, forneça a --from-scan opção. Também é necessário fornecer a opção --stack-name obrigatória. Veja um exemplo a seguir:

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

A CLI do AWS CDK fará o seguinte:

Usar filtros

Por padrão, a CLI do AWS CDK examinará AWS todo o ambiente e migrará recursos até o limite máximo de cota do gerador IaC. Você pode fornecer filtros com a CLI do AWS CDK para especificar um critério para os quais os recursos serão migrados da sua conta para o novo aplicativo CDK. Para saber mais, consulte --filter .

Verificar recursos com o gerador de IaC

Dependendo do número de recursos na sua conta, a verificação pode demorar alguns minutos. Uma barra de progresso será exibida durante o processo de verificação.

Resolver propriedades somente gravação

Alguns recursos compatíveis contêm propriedades somente gravação. Essas propriedades podem ser gravadas para configurar a propriedade, mas não podem ser lidas pelo gerador IaC ou AWS CloudFormation para obter o valor. Por exemplo, uma propriedade usada para especificar uma senha de banco de dados pode ser somente gravação por motivos de segurança.

Ao verificar recursos durante a migração, o gerador de IaC detectará recursos que possam conter propriedades somente gravação e os categorizará em qualquer um dos seguintes tipos:

Para obter mais informações sobre propriedades somente de gravação e como o gerador de IaC as gerencia ao verificar recursos implantados e criar AWS CloudFormation modelos, consulte Gerador de IaC e propriedades somente de gravação no Guia do usuário. AWS CloudFormation

Após a migração, você deve especificar valores de propriedade somente gravação na nova aplicação do CDK. A CLI do AWS CDK anexará uma seção Avisos ao arquivo do projeto CDK para documentar todas as propriedades somente ReadMe de gravação identificadas pelo gerador IaC. Veja um exemplo a seguir:

# 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

O arquivo migrate.json

A CLI do AWS CDK cria migrate.json um arquivo em AWS seu projeto CDK durante a migração. Esse arquivo contém informações de referência sobre seus recursos implantados. Quando você implanta seu aplicativo CDK pela primeira vez, a AWS CLI do CDK usa esse arquivo para referenciar seus recursos implantados, associar seus recursos à nova AWS CloudFormation pilha e excluir o arquivo.

Gerenciar e implantar sua aplicação do CDK

Ao migrar para o AWS CDK, o novo aplicativo CDK pode não estar pronto para implantação imediatamente. Este tópico descreve itens de ação a serem considerados ao gerenciar e implantar sua nova aplicação do CDK.

Preparar-se para implantação

Antes da implantação, você deve preparar sua aplicação do CDK.

Implantar sua aplicação do CDK

Quando você implanta um aplicativo CDK, a AWS CLI do CDK utiliza o AWS CloudFormation serviço para provisionar seus recursos. Os recursos são agrupados em uma única pilha no aplicativo CDK e implantados como uma única pilha. AWS CloudFormation

Dependendo de onde você migrou, você pode implantar para criar uma nova AWS CloudFormation pilha ou atualizar uma pilha existente AWS CloudFormation .