cdk refactor - AWS Kit de desenvolvimento em nuvem (AWS CDK) v2
UsoArgumentosOpções

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 refactor

Importante

O comando cdk refactor é uma versão de teste e está sujeita a alterações.

É necessário fornecer a opção --unstable=refactor ao usar esse comando.

Preserve os recursos implantados ao refatorar o código em sua aplicação do kit de desenvolvimento em nuvem da AWS (CDK da AWS).

Quando você renomeia constructos ou os move entre pilhas em seu código do CDK, o CloudFormation normalmente os trata como novos recursos, causando substituições que podem levar a interrupções de serviços ou a perda de dados. O comando cdk refactor detecta essas alterações de forma inteligente e funciona com a API de refatoração do CloudFormation para preservar seus recursos enquanto atualiza seus IDs lógicos.

Com o cdk refactor, você pode:

  • Renomeie os constructos para obter maior clareza em sua base de código sem causar a substituição de recursos.

  • Mova recursos entre pilhas para melhorar a organização e a separação de interesses.

  • Reorganize sua hierarquia de constructos (como agrupar recursos da AWS em um novo constructo L3) enquanto preserva os recursos de nuvem subjacentes.

  • Atualize ou alterne com segurança entre bibliotecas de constructos, incluindo dependências de terceiros, sem acionar a substituição de recursos quando os IDs lógicos mudam entre as versões.

Esse comando analisa suas alterações, mostra uma lista de recursos que mudarão de local (pilha e ID lógico) e gerencia o complexo processo de atualização dos recursos do CloudFormation, mantendo sua identidade e estado.

Quando executado, o comando calcula automaticamente os mapeamentos comparando seu código atual com o estado implantado. Ela verifica se sua aplicação do CDK contém exatamente o mesmo conjunto de recursos do estado implantado, diferindo apenas em suas localizações na árvore de constructos. Se o comando detectar quaisquer adições, exclusões ou modificações de recursos, a operação de refatoração será rejeitada com uma mensagem de erro.

Após o mapeamento do cálculo, o comando mostrará as alterações propostas e, após a confirmação do usuário, aplicará a refatoração. Se for detectada ambiguidade (onde vários mapeamentos válidos são possíveis), é possível fornecer um arquivo de substituição com mapeamentos explícitos para resolver esses casos.

Para obter uma introdução, consulte Preservação de recursos implantados ao refatorar o código do CDK.

Uso

$ cdk refactor <arguments> <options>

Argumentos

ID da pilha CDK

O ID de constructo da pilha do CDK da sua aplicação a refatorar.

É possível especificar vários IDs de pilha para focar a operação de refatoração nessas pilhas. Se os recursos estiverem sendo movidos entre as pilhas e uma dessas pilhas não estiver explicitamente incluída, o comando de refatoração incluirá automaticamente a pilha adicional na operação.

Se você não fornecer nenhum ID de pilha, todas as pilhas na aplicação serão consideradas para refatoração.

Tipo: string

Obrigatório: não

Opções

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

--dry-run

Imprima o mapeamento no console sem aplicá-lo.

Essa opção é útil para validar suas alterações antes de realmente realizar a refatoração, especialmente ao trabalhar com aplicações complexas. Ele mostra exatamente quais alterações seriam feitas sem modificar nenhum recurso.

--force

Prossiga com a refatoração sem solicitar a confirmação do usuário.

Isso é útil em ambientes interativos quando você está confiante sobre as mudanças. Em ambientes não interativos, como pipelines de CI/CD, a CLI do CDK prossegue automaticamente sem aviso prévio, portanto, essa opção não é necessária.

--help, -h <BOOLEAN>

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

--override-file <FILE>

Forneça substituições quando a CLI do CDK não for capaz de determinar uma resolução de refatoração para os recursos. Esse arquivo contém mapeamentos de recursos no formato .json. Veja um exemplo a seguir:

{
    "environments": [
        {
            "account": "123456789012",
            "region": "us-east-2",
            "resources": {
                "StackA.OldName": "StackB.NewName",
                "StackC.Foo": "StackC.Bar"
            }
        }
    ]
}
--revert <FILE>

Reverta uma refatoração anterior. É necessário fornecer um arquivo de substituição com mapeamentos de recursos.

Isso não desfaz completamente uma operação de refatoração anterior. Para reverter totalmente uma refatoração, você precisa reverter sua aplicação para um estado anterior e executar o processo de refatoração novamente.