Parâmetros e o AWS CDK - AWS Cloud Development Kit (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.

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 atributo do AWS CloudFormation. Como o AWS Cloud Development Kit (AWS CDK) sintetiza modelos de AWS CloudFormation, ele também oferece suporte para parâmetros de tempo de implantação.

Sobre parâmetros

Usando o AWS CDK, você pode 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 AWS CloudFormation usando o AWS CDK CLI, você fornece os valores dos parâmetros na linha de comando. Se você implantar o modelo por meio do console AWS CloudFormation, você será solicitado a fornecer os valores dos parâmetros.

Em geral, não recomendamos o uso de parâmetros AWS CloudFormation com o AWS CDK. As formas usuais de passar valores para aplicativos 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 seu aplicativo 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 seu aplicativo AWS CDK, em muitos casos com poucos benefícios.

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

No entanto, existem casos de uso para os quais os parâmetros 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 compatível com parâmetros AWS CloudFormation, você pode usar o AWS CDK com serviços da AWS que usam modelos de AWS CloudFormation (como o Catálogo de Serviços). Esses serviços AWS usam parâmetros para configurar o modelo que está sendo implantado.

Saiba mais

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