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 AWS recursos, AWS CloudFormation pilhas e CloudFormation modelos implantados para um novo AWS projeto de 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. Você pode configurar a fonte de migração usando o --from-scan, --from-stack ou --from-path.

Para obter mais informações sobre o usocdk migrate, consulte Migrar recursos e AWS CloudFormation modelos existentes 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 de 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 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 uma nova verificação deve ser iniciada ou se a CLI do AWS CDK deve usar a última verificação bem-sucedida.

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. Necessá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: 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 CDK gerado em um arquivo ZIP.

Obrigatório: não

--filter <ARRAY>

Use ao migrar recursos implantados de uma AWS conta e AWS região. 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 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 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, a CLI do AWS CDK usará seu diretório de trabalho atual.

--region <STRING>

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

Obrigatório: não

Padrão: a CLI do AWS CDK AWS obtém informações de região 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 Forneça um nome --stack-name para sua nova pilha de CDK. Veja a seguir um exemplo que migra o myCloudFormationStack para um nova aplicação CDK que está usando o 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 Forneça um nome --stack-name 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 A CLI do CDK utiliza o IaC generator serviço para verificar recursos e gerar um modelo. Em seguida, a CLI do CDK 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"