cdk migrate - AWS Kit de desenvolvimento em nuvem (AWS CDK) v2
UsoOpçõesExemplos

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á.

cdk migrate

Migre os recursos da AWS implantados, pilhas do AWS CloudFormation e modelos do CloudFormation para um novo projeto do AWS CDK.

Esse comando cria um nova aplicação CDK que inclui uma única pilha nomeada com o valor que você fornece usando o --stack-name. É possível configurar a fonte de migração usando o --from-scan, --from-stack ou --from-path.

Para obter mais informações sobre o uso de cdk migrate, consulte Migração de recursos existentes e modelos do AWS CloudFormation para o AWS CDK.

nota

O comando cdk migrate é experimental e pode ter alterações significativas no futuro.

Uso

$ cdk migrate <options>

Opções

Para obter uma lista das opções globais que funcionam com todos os comandos da CLI do CDK, consulte Opções globais.

Opções obrigatórias

--stack-name <STRING>

O nome da pilha do AWS CloudFormation que será criada na aplicação do CDK após a migração.

Obrigatório: Sim

Opções condicionais

--from-path <PATH>

O caminho para o modelo do AWS CloudFormation a ser migrado. Forneça essa opção para especificar um modelo local.

Obrigatório: condicional. Obrigatório ao migrar de um modelo local do AWS CloudFormation.

--from-scan <STRING>

Ao migrar recursos implantados de um ambiente da AWS, use essa opção para especificar se um novo escaneamento deve ser iniciado ou se a CLI do AWS CDK deve usar o último escaneamento bem-sucedido.

Obrigatório: condicional. Obrigatório ao migrar dos recursos implantados do AWS.

Valores aceitos: most-recent, new

--from-stack <BOOLEAN>

Forneça essa opção para migrar a partir de uma pilha do AWS CloudFormation implantada. Use --stack-name para especificar o nome da pilha do AWS CloudFormation implantada.

Obrigatório: condicional. Obrigatório ao migrar de uma pilha do AWS CloudFormation implantada.

Opções opcionais

--account <STRING>

A conta da qual recuperar o modelo de pilha do AWS CloudFormation.

Obrigatório: não

Padrão: a CLI do AWS CDK obtém informações da conta de fontes padrão.

--compress <BOOLEAN>

Forneça essa opção para compactar o projeto do CDK gerado em um arquivo ZIP.

Obrigatório: não

--filter <ARRAY>

Use ao migrar recursos implantados a partir de uma conta da AWS e região da AWS. Essa opção especifica um filtro para determinar quais recursos implantados devem ser migrados.

Essa opção aceita uma matriz de pares de valores-chave, em que chave representa o tipo de filtro e valor representa o valor a ser filtrado.

As seguintes chaves são aceitas:

  • resource-identifier — Um identificador para o recurso. O valor pode ser o ID lógico ou físico do recurso. Por exemplo, resource-identifier="ClusterName".

  • resource-type-prefix: o prefixo do tipo de recurso do AWS CloudFormation. Por exemplo, especifique resource-type-prefix="AWS::DynamoDB::" para filtrar todos os recursos do Amazon DynamoDB.

  • tag-key – A chave de uma tag de recurso. Por exemplo, tag-key="myTagKey".

  • tag-value – O valor de uma tag de recurso. Por exemplo, tag-value="myTagValue".

Forneça vários pares de valores-chave para lógica AND condicional. O exemplo a seguir filtra qualquer recurso do DynamoDB marcado com myTagKey como a chave da tag: --filter resource-type-prefix="AWS::DynamoDB::", tag-key="myTagKey".

Forneça a opção --filter várias vezes em um único comando para a lógica condicional OR. O exemplo a seguir filtra qualquer recurso que seja um recurso do DynamoDB ou que esteja marcado com myTagKey como a chave da tag: --filter resource-type-prefix="AWS::DynamoDB::" --filter tag-key="myTagKey".

Obrigatório: não

--help, -h <BOOLEAN>

Mostrar as informações de referência do comando cdk migrate.

--language <STRING>

A linguagem de programação a ser usada no projeto do CDK criado durante a migração.

Obrigatório: não

Valores válidos: typescript, python, java, csharp, go.

Padrão: typescript

--output-path <PATH>

O caminho de saída para o projeto do CDK migrado.

Obrigatório: não

Padrão: por padrão, a CLI do AWS CDK usará seu diretório de trabalho atual.

--region <STRING>

A região da AWS da qual recuperar o modelo de pilha do AWS CloudFormation.

Obrigatório: não

Padrão: a CLI do AWS CDK obtém informações da região da AWS de fontes padrão.

Exemplos

Exemplo simples de migração de uma pilha do CloudFormation

Migre de uma pilha implantada do CloudFormation em um ambiente específico usando o AWS --from-stack. Forneça um nome --stack-name para sua nova pilha do CDK. Veja a seguir um exemplo que migra myCloudFormationStack para um nova aplicação do CDK que está usando o TypeScript:

$ cdk migrate --language typescript --from-stack --stack-name 'myCloudFormationStack'

Exemplo simples de migração de um modelo local do CloudFormation

Migre de um modelo JSON ou YAML local do CloudFormation usando o --from-path. Forneça um nome --stack-name para sua nova pilha do CDK. Veja a seguir um exemplo que cria um nova aplicação do CDK em Typecript que inclui uma pilha myCloudFormationStack de um arquivo local template.json:

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

Exemplo simples de migração de recursos AWS implantados

Migre os recursos AWS implantados de um ambiente AWS específico que não estão associados a uma pilha do CloudFormation usando o --from-scan. A CLI do CDK utiliza o serviço IaC generator para escanear recursos e gerar um modelo. Em seguida, a CLI do CDK faz referência ao modelo para criar a nova aplicação do CDK. Veja a seguir um exemplo que cria um nova aplicação do CDK em TypeScript com uma nova pilha myCloudFormationStack contendo recursos AWS migrados:

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