Parâmetros e o AWS CDK - AWS Kit de desenvolvimento em nuvem (AWS CDK) v2

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á.

Parâmetros e o AWS CDK

Os parâmetros são valores personalizados fornecidos no momento da implantação. Os parâmetros são um recurso do AWS CloudFormation. Como o kit de desenvolvimento em nuvem da AWS (CDK da AWS) sintetiza modelos do AWS CloudFormation, ele também oferece suporte para parâmetros de tempo de implantação.

Sobre parâmetros

Usando o AWS CDK, é possível definir parâmetros, que podem então ser usados nas propriedades dos constructos que você cria. Você também pode implantar pilhas que contenham parâmetros.

Ao implantar o modelo do AWS CloudFormation usando a CLI do AWS CDK, você fornece os valores dos parâmetros na linha de comando. Se você implantar o modelo por meio do console AWS do CloudFormation, você será solicitado a fornecer os valores dos parâmetros.

Em geral, não recomendamos o uso de parâmetros do AWS CloudFormation com o AWS CDK. As formas usuais de passar valores para aplicações do AWS CDK são valores de contexto e variáveis de ambiente. Como não estão disponíveis no momento da síntese, os valores dos parâmetros não podem ser facilmente usados para controle de fluxo e outras finalidades em sua aplicação CDK.

nota

Para controlar o fluxo com parâmetros, você pode usar constructos CfnCondition, embora isso seja estranho em comparação com declarações if nativas.

O uso de parâmetros exige que você esteja ciente de como o código que você está escrevendo se comporta no momento da implantação e também no momento da síntese. Isso torna mais difícil entender e raciocinar sobre sua aplicação do AWS CDK, em muitos casos com poucos benefícios.

Geralmente, é melhor que sua aplicação do CDK aceite as informações necessárias de uma forma bem definida e as use diretamente para declarar constructos em sua aplicação do CDK. Um modelo ideal do AWS CloudFormation gerado pelo AWS CDK é concreto, sem valores a serem especificados no momento da implantação.

Entretanto, existem casos de uso para os quais os parâmetros do AWS CloudFormation são exclusivamente adequados. Se você tiver equipes separadas definindo e implantando a infraestrutura, por exemplo, você pode usar parâmetros para tornar os modelos gerados mais amplamente úteis. Além disso, como o AWS CDK oferece suporte aos parâmetros do AWS CloudFormation, é possível usar o AWS CDK com serviços da AWS que usem modelos do AWS CloudFormation (como o Catálogo de Serviços). Esses serviços da AWS usam parâmetros para configurar o modelo que está sendo implantado.

Saiba mais

Para obter instruções sobre o desenvolvimento de aplicações do CDK com parâmetros, consulte Uso de parâmetros do CloudFormation para obter um valor do CloudFormation.