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

Use CloudFormation parâmetros para obter um CloudFormation valor

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

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

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.

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

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 comando CDK cdk deploy CLI ou especificando valores de parâmetros no arquivo de pilha do seu projeto CDK.

Forneça valores de parâmetros com cdk deploy

Ao implantar usando o comando CDK cdk deploy CLI, você pode fornecer valores de parâmetros na implantação com --parameters a 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. A CLI do CDK localizará 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

Veja a seguir um exemplo de aplicativo CDK 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:

Fornecer valores de parâmetros cdk deploy para aplicações com pilhas aninhadas

O comportamento da CLI do CDK 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 cdk deploy comando, consulte cdk deploy.