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 cdk refactor comando está na versão prévia e está sujeito a alterações.

Você deve fornecer a --unstable=refactor opção ao usar esse comando.

Preserve os recursos implantados ao refatorar o código em seu aplicativo AWS Cloud Development Kit (AWS CDK).

Quando você renomeia construções ou as move entre pilhas em seu código CDK, CloudFormation normalmente as trata como novos recursos, causando substituições que podem levar a interrupções de serviço ou perda de dados. O cdk refactor comando detecta essas alterações de forma inteligente e trabalha com CloudFormation a API de refatoração para preservar seus recursos e, ao mesmo tempo, atualizar sua lógica. IDs

Com o cdk refactor, você pode:

  • Renomeie as construções 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 construção (como agrupar recursos da AWS em uma nova construção L3) enquanto preserva os recursos de nuvem subjacentes.

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

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

Quando executado, o comando calcula automaticamente os mapeamentos comparando seu código atual com o estado implantado. Ele verifica se seu aplicativo CDK contém exatamente o mesmo conjunto de recursos do estado implantado, diferindo apenas em suas localizações na árvore de construção. 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 mostra as alterações propostas e, após a confirmação do usuário, aplica a refatoração. Se for detectada ambiguidade (onde vários mapeamentos válidos são possíveis), você pode fornecer um arquivo de substituição com mapeamentos explícitos para resolver esses casos.

Para uma introdução, consulte Preservar recursos implantados ao refatorar o código CDK.

Uso

$ cdk refactor <arguments> <options>

Argumentos

ID da pilha CDK

O ID de construção da pilha de CDK do seu aplicativo para refatorar.

Você pode especificar várias pilhas IDs 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 refactor incluirá automaticamente a pilha adicional na operação.

Se você não fornecer nenhuma pilha IDs, todas as pilhas no aplicativo serão consideradas para refatoração.

Tipo: string

Obrigatório: não

Opções

Para obter uma lista de 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 aplicativos complexos. 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 CI/CD pipelines, 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 conseguir 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. Você deve 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 seu aplicativo para um estado anterior e executar o processo de refatoração novamente.