cdk import - Kit de desenvolvimento em nuvem da AWS (CDK da AWS) 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.

cdk import

Use as importações de recursos do AWS CloudFormation para importar recursos da AWS existentes em uma pilha do CDK.

Com esse comando, é possível pegar os recursos existentes que foram criados usando outros métodos e começar a gerenciá-los usando o AWS CDK.

Ao considerar a transferência de recursos para o gerenciamento do CDK, às vezes é aceitável criar novos recursos, como com perfis do IAM, funções do Lambda e regras de eventos. Para outros recursos, como recursos com estado, como buckets do Amazon S3 e tabelas do DynamoDB, a criação de novos recursos pode causar impactos em seu serviço. É possível usar cdk import para importar recursos existentes com o mínimo de interrupção em seus serviços. Para ver a lista de recursos da AWS com suporte, consulte Suporte a tipos de recursos no Guia do usuário do AWS CloudFormation.

Para importar um recurso existente para uma pilha do CDK

  1. Execute um cdk diff para garantir que sua pilha do CDK não tenha alterações pendentes. Ao realizar um cdk import, as únicas alterações permitidas em uma operação de importação são a adição de novos recursos sendo importados.

  2. Adicione constructos para os recursos que você deseja importar para a pilha. Por exemplo, adicione o seguinte para um bucket do Amazon S3:

    new s3.Bucket(this, 'ImportedS3Bucket', {});

    Não adicione nenhuma outra alteração. Você também deve se certificar de modelar exatamente o estado que o recurso tem atualmente. Para o exemplo do bucket, não se esqueça de incluir chaves do AWS KMS, políticas de ciclo de vida e qualquer outra coisa que seja relevante sobre o bucket. Caso contrário, as operações de atualização subsequentes podem não fazer o que você espera.

  3. Executar cdk import. Se houver várias pilhas na aplicação CDK, passe um nome de pilha específico como argumento.

  4. A CLI do CDK solicitará que você informe os nomes reais dos recursos que você está importando. Depois de fornecer essas informações, a importação será iniciada.

  5. Quando o relatório cdk import for bem-sucedido, o recurso será gerenciado pelo CDK. Quaisquer alterações subsequentes na configuração da constructo serão refletidas no recurso.

No momento, esse recurso tem as seguintes limitações:

  • Não é possível importar recursos para pilhas aninhadas.

  • Não há verificação se as propriedades especificadas estão corretas e completas para o recurso importado. Tente iniciar uma operação de detecção de desvio após a importação.

  • Os recursos que dependem de outros recursos devem ser importados juntos ou individualmente, na ordem correta. Caso contrário, a implantação do CloudFormation falhará com referências não resolvidas.

  • Esse comando usa as credenciais do perfil de implantação, necessárias para ler o bucket de teste criptografado. Isso requer a versão 12 do modelo de bootstrapping, que inclui as permissões necessárias do IAM para o perfil de implantação.

Uso

$ cdk import <arguments> <options>

Argumentos

ID da pilha CDK

O ID de constructo da pilha CDK da sua aplicação para o qual importar recursos. Este argumento pode ser fornecido várias vezes em um único comando.

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.

--change-set-name <STRING>

O nome do conjunto de alterações do CloudFormation a ser criado.

--execute <BOOLEAN>

Especifique se deseja executar o conjunto de alterações.

Valor padrão: true

--force, -f <BOOLEAN>

Por padrão, a CLI do CDK sai do processo se a diferença do modelo incluir atualizações ou exclusões. Especifique true para substituir esse comportamento e sempre continuar com a importação.

--help, -h <BOOLEAN>

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

--record-resource-mapping, -r <STRING>

Use essa opção para gerar um mapeamento dos recursos físicos existentes para os recursos do CDK que serão importados. O mapeamento será gravado no caminho do arquivo que você fornecer. Nenhuma operação de importação real será realizada.

--resource-mapping, -m <STRING>

Use essa opção para especificar um arquivo que define seu mapeamento de recursos. A CLI do CDK usará esse arquivo para mapear recursos físicos em recursos para importação, em vez de perguntar interativamente a você.

Essa opção pode ser executada a partir de scripts.

--rollback <BOOLEAN>

Reverta a pilha para o estado estável em caso de falha.

Para especificar false, você pode usar --no-rollback ou -R.

Especifique false para iterar mais rapidamente. Implantações contendo substituições de recursos sempre falharão.

Valor padrão: true

--toolkit-stack-name <STRING>

O nome da pilha do Kit de Ferramentas CDK a ser criada.

Por padrão, o cdk bootstrap implanta uma pilha chamada CDKToolkit no ambiente AWS especificado. Use essa opção para fornecer um nome diferente para sua pilha de bootstrapping.

A CLI do CDK usa esse valor para verificar a versão da pilha de bootstrapping.