cdk migrate - AWS Cloud Development Kit (AWS CDK) v2

Este é o Guia do Desenvolvedor 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 AWS recursos, AWS CloudFormation pilhas e CloudFormation modelos implantados para um novo projeto. AWS CDK

Esse comando cria um novo aplicativo CDK que inclui uma única pilha nomeada com o valor que você fornece usando. --stack-name Você pode configurar a fonte de migração usando --from-scan--from-stack, ou--from-path.

Para obter mais informações sobre o usocdk migrate, consulteMigre recursos e AWS CloudFormation modelos existentes para o AWS CDK.

nota

O cdk migrate comando é 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 CLI comandos do CDK, consulteOpções globais.

Opções necessárias

--stack-name STRING

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

Obrigatório: Sim

Opções condicionais

--from-path PATH

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

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

--from-scan STRING

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

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

Valores aceitos:most-recent, new

--from-stack BOOLEAN

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

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

Opções opcionais

--account STRING

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

Obrigatório: não

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

--compress BOOLEAN

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

Obrigatório: não

--filter ARRAY

Use ao migrar recursos implantados de uma AWS conta 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 AWS CloudFormation recurso. 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 myTagKey com a chave da tag:. --filter resource-type-prefix="AWS::DynamoDB::", tag-key="myTagKey"

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

Obrigatório: não

--help, -h BOOLEAN

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

--language STRING

A linguagem de programação a ser usada no projeto 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 CDK migrado.

Obrigatório: não

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

--region STRING

O Região da AWS para recuperar o modelo de AWS CloudFormation pilha.

Obrigatório: não

Padrão: AWS CDK CLI Obtém Região da AWS informações de fontes padrão.

Exemplos

Exemplo simples de migração de uma pilha CloudFormation

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

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

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

Migre de um modelo JSON ou YAML CloudFormation local usando o. --from-path --stack-nameForneça um nome para sua nova pilha de CDK. Veja a seguir um exemplo que cria um novo aplicativo CDK TypeScript que inclui uma myCloudFormationStack pilha de um arquivo localtemplate.json:

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

Exemplo simples de migração de recursos implantados AWS

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

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