Selecione suas preferências de cookies

Usamos cookies essenciais e ferramentas semelhantes que são necessárias para fornecer nosso site e serviços. Usamos cookies de desempenho para coletar estatísticas anônimas, para que possamos entender como os clientes usam nosso site e fazer as devidas melhorias. Cookies essenciais não podem ser desativados, mas você pode clicar em “Personalizar” ou “Recusar” para recusar cookies de desempenho.

Se você concordar, a AWS e terceiros aprovados também usarão cookies para fornecer recursos úteis do site, lembrar suas preferências e exibir conteúdo relevante, incluindo publicidade relevante. Para aceitar ou recusar todos os cookies não essenciais, clique em “Aceitar” ou “Recusar”. Para fazer escolhas mais detalhadas, clique em “Personalizar”.

Use CloudFormation parâmetros para obter um CloudFormation valor

Modo de foco
Use CloudFormation parâmetros para obter um CloudFormation valor - AWS Cloud Development Kit (AWS CDK) v2

Este é o Guia do Desenvolvedor 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á.

Este é o Guia do Desenvolvedor 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á.

Use AWS CloudFormation parâmetros nos AWS Cloud Development Kit (AWS CDK) aplicativos para inserir valores personalizados em seus CloudFormation modelos sintetizados na implantação.

Para obter uma introdução, consulte Parâmetros e o AWS CDK.

Definir parâmetros em sua aplicação CDK

Use a classe CfnParameter para definir um parâmetro. Você deve especificar pelo menos um tipo e uma descrição para a maioria dos parâmetros, embora ambos sejam tecnicamente opcionais. A descrição aparece quando o usuário é solicitado a inserir o valor do parâmetro no AWS CloudFormation console. Para obter mais informações sobre os tipos disponíveis, consulte Tipos.

nota

Você pode definir parâmetros em qualquer escopo. No entanto, recomendamos definir parâmetros no nível da pilha para que seu ID lógico não mude quando você refatorar seu código.

TypeScript
const uploadBucketName = new CfnParameter(this, "uploadBucketName", { type: "String", description: "The name of the Amazon S3 bucket where uploaded files will be stored."});
JavaScript
const uploadBucketName = new CfnParameter(this, "uploadBucketName", { type: "String", description: "The name of the Amazon S3 bucket where uploaded files will be stored."});
Python
upload_bucket_name = CfnParameter(self, "uploadBucketName", type="String", description="The name of the Amazon S3 bucket where uploaded files will be stored.")
Java
CfnParameter uploadBucketName = CfnParameter.Builder.create(this, "uploadBucketName") .type("String") .description("The name of the Amazon S3 bucket where uploaded files will be stored") .build();
C#
var uploadBucketName = new CfnParameter(this, "uploadBucketName", new CfnParameterProps { Type = "String", Description = "The name of the Amazon S3 bucket where uploaded files will be stored" });
const uploadBucketName = new CfnParameter(this, "uploadBucketName", { type: "String", description: "The name of the Amazon S3 bucket where uploaded files will be stored."});

Usar parâmetros

Uma instância do CfnParameter expõe seu valor à sua aplicação CDK por meio de um token. Como todos os tokens, o token do parâmetro é resolvido no momento da síntese. Mas isso se resume a uma referência ao parâmetro definido no AWS CloudFormation modelo (que será resolvido no momento da implantação), em vez de um valor concreto.

Você pode recuperar o token como uma instância da classe Token ou em string, lista de strings ou codificação numérica. Sua escolha depende do tipo de valor exigido pela classe ou método com o qual você deseja usar o parâmetro.

TypeScript
Propriedade tipo de valor
value Tokeninstância de classe
valueAsList O token representado como uma lista de strings
valueAsNumber O token representado como um número
valueAsString O token representado como uma string
JavaScript
Propriedade tipo de valor
value Tokeninstância de classe
valueAsList O token representado como uma lista de strings
valueAsNumber O token representado como um número
valueAsString O token representado como uma string
Python
Propriedade tipo de valor
value Tokeninstância de classe
value_as_list O token representado como uma lista de strings
value_as_number O token representado como um número
value_as_string O token representado como uma string
Java
Propriedade tipo de valor
getValue() Tokeninstância de classe
getValueAsList() O token representado como uma lista de strings
getValueAsNumber() O token representado como um número
getValueAsString() O token representado como uma string
C#
Propriedade tipo de valor
Value Tokeninstância de classe
ValueAsList O token representado como uma lista de strings
ValueAsNumber O token representado como um número
ValueAsString O token representado como uma string
Propriedade tipo de valor
value Tokeninstância de classe
valueAsList O token representado como uma lista de strings
valueAsNumber O token representado como um número
valueAsString O token representado como uma string

Por exemplo, para usar um parâmetro em uma definição Bucket:

TypeScript
const bucket = new Bucket(this, "amzn-s3-demo-bucket", { bucketName: uploadBucketName.valueAsString});
JavaScript
const bucket = new Bucket(this, "amzn-s3-demo-bucket", { bucketName: uploadBucketName.valueAsString});
Python
bucket = Bucket(self, "amzn-s3-demo-bucket", bucket_name=upload_bucket_name.value_as_string)
Java
Bucket bucket = Bucket.Builder.create(this, "amzn-s3-demo-bucket") .bucketName(uploadBucketName.getValueAsString()) .build();
C#
var bucket = new Bucket(this, "amzn-s3-demo-bucket") { BucketName = uploadBucketName.ValueAsString };
const bucket = new Bucket(this, "amzn-s3-demo-bucket", { bucketName: uploadBucketName.valueAsString});

Implementar aplicações CDK contendo parâmetros

Ao implantar um AWS CloudFormation modelo gerado por meio do AWS CloudFormation console, você será solicitado a fornecer os valores para cada parâmetro.

Você também pode fornecer valores de parâmetros usando o CDK CLI cdk deploycomando ou especificando valores de parâmetros no arquivo de pilha do seu projeto CDK.

Forneça valores de parâmetros com cdk deploy

Quando você implanta usando o CDK CLI cdk deploycomando, você pode fornecer valores de parâmetros na implantação com a --parameters opção.

Veja a seguir um exemplo da estrutura de comando cdk deploy:

$ cdk deploy stack-logical-id --parameters stack-name:parameter-name=parameter-value

Se sua aplicação CDK contiver uma única pilha, você não precisará fornecer o argumento do ID lógico da pilha ou o valor stack-name na opção --parameters. O CDK CLI encontrará e fornecerá automaticamente esses valores. Veja a seguir um exemplo que especifica um valor uploadbucket para o parâmetro uploadBucketName da pilha única em nossa aplicação CDK:

$ cdk deploy --parameters uploadBucketName=uploadbucket

Fornecer valores de parâmetros com a implantação cdk para aplicações de várias pilhas

A seguir está um exemplo de aplicativo CDK em TypeScript que contém duas pilhas de CDK. Cada pilha contém uma instância de bucket do Amazon S3 e um parâmetro para definir o nome do bucket do Amazon S3:

import * as cdk from 'aws-cdk-lib'; import { Construct } from 'constructs'; import * as s3 from 'aws-cdk-lib/aws-s3'; // Define the CDK app const app = new cdk.App(); // First stack export class MyFirstStack extends cdk.Stack { constructor(scope: Construct, id: string, props?: cdk.StackProps) { super(scope, id, props); // Set a default parameter name const bucketNameParam = new cdk.CfnParameter(this, 'bucketNameParam', { type: 'String', default: 'myfirststackdefaultbucketname' }); // Define an S3 bucket new s3.Bucket(this, 'MyFirstBucket', { bucketName: bucketNameParam.valueAsString }); } } // Second stack export class MySecondStack extends cdk.Stack { constructor(scope: Construct, id: string, props?: cdk.StackProps) { super(scope, id, props); // Set a default parameter name const bucketNameParam = new cdk.CfnParameter(this, 'bucketNameParam', { type: 'String', default: 'mysecondstackdefaultbucketname' }); // Define an S3 bucket new s3.Bucket(this, 'MySecondBucket', { bucketName: bucketNameParam.valueAsString }); } } // Instantiate the stacks new MyFirstStack(app, 'MyFirstStack', { stackName: 'MyFirstDeployedStack', }); new MySecondStack(app, 'MySecondStack', { stackName: 'MySecondDeployedStack', });

Para aplicações do CDK que contêm várias pilhas, você pode fazer o seguinte:

  • Implantar uma pilha com parâmetros — Para implantar uma única pilha de uma aplicação com várias pilhas, forneça o ID lógico da pilha como argumento.

    Veja a seguir um exemplo que implanta o MySecondStack com mynewbucketname como o valor do parâmetro para bucketNameParam:

    $ cdk deploy MySecondStack --parameters bucketNameParam='mynewbucketname'
  • Implantar todas as pilhas e especificar os valores dos parâmetros para cada pilha — Forneça o curinga '*' ou a opção --all para implantar todas as pilhas. Forneça a opção --parameters várias vezes em um único comando para especificar os valores dos parâmetros para cada pilha. Veja um exemplo a seguir:

    $ cdk deploy '*' --parameters MyFirstDeployedStack:bucketNameParam='mynewfirststackbucketname' --parameters MySecondDeployedStack:bucketNameParam='mynewsecondstackbucketname'
  • Implantar todas as pilhas e especificar os valores dos parâmetros para uma única pilha — Forneça o curinga '*' ou a opção --all para implantar todas as pilhas. Em seguida, especifique a pilha para definir o parâmetro na opção --parameters. Veja a seguir exemplos de como implanta todas as pilhas em um aplicativo CDK e especifica um valor de parâmetro para a pilha. MySecondDeployedStack AWS CloudFormation Todas as outras pilhas serão implantadas e usarão o valor do parâmetro padrão:

    $ cdk deploy '*' --parameters MySecondDeployedStack:bucketNameParam='mynewbucketname' $ cdk deploy --all --parameters MySecondDeployedStack:bucketNameParam='mynewbucketname'

Forneça valores de parâmetros com cdk deploy para aplicativos com pilhas aninhadas

O CDK CLI o comportamento ao trabalhar com aplicativos contendo pilhas aninhadas é semelhante ao de aplicativos com várias pilhas. A principal diferença é que, se você quiser implantar todas as pilhas aninhadas, use o curinga '**'. O curinga '*' implanta todas as pilhas, mas não implantará pilhas aninhadas. O curinga '**' implanta todas as pilhas, incluindo pilhas aninhadas.

Veja a seguir um exemplo que implanta pilhas aninhadas enquanto especifica o valor do parâmetro para uma pilha aninhada:

$ cdk deploy '**' --parameters MultiStackCdkApp/SecondStack:bucketNameParam='mysecondstackbucketname'

Para obter mais informações sobre as opções de comando cdk deploy, consulte cdk deploy.

PrivacidadeTermos do sitePreferências de cookies
© 2025, Amazon Web Services, Inc. ou suas afiliadas. Todos os direitos reservados.