Utiliser CloudFormation des paramètres pour obtenir une CloudFormation valeur - AWS Cloud Development Kit (AWS CDK) v2
Définissez les paramètres de votre CDK applicationParamètres d'utilisationDéployer CDK des applications contenant des paramètres

Ceci est le guide du AWS CDK développeur de la version 2. L'ancienne CDK version 1 est entrée en maintenance le 1er juin 2022 et a pris fin le 1er juin 2023.

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Utiliser CloudFormation des paramètres pour obtenir une CloudFormation valeur

Utilisez AWS CloudFormation des paramètres au sein AWS Cloud Development Kit (AWS CDK) des applications pour saisir des valeurs personnalisées dans vos CloudFormation modèles synthétisés lors du déploiement.

Pour obtenir une présentation, consultez Les paramètres et le AWS CDK.

Définissez les paramètres de votre CDK application

Utilisez la CfnParameterclasse pour définir un paramètre. Vous devez spécifier au moins un type et une description pour la plupart des paramètres, bien que les deux soient techniquement facultatifs. La description apparaît lorsque l'utilisateur est invité à saisir la valeur du paramètre dans la AWS CloudFormation console. Pour plus d'informations sur les types disponibles, consultez la section Types.

Note

Vous pouvez définir des paramètres dans n'importe quelle étendue. Cependant, nous vous recommandons de définir les paramètres au niveau de la pile afin que leur identifiant logique ne change pas lorsque vous refactorisez votre code.

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"
});

Paramètres d'utilisation

Une CfnParameter instance expose sa valeur à votre CDK application via un jeton. Comme tous les jetons, le jeton du paramètre est résolu au moment de la synthèse. Mais il s'agit d'une référence au paramètre défini dans le AWS CloudFormation modèle (qui sera résolu au moment du déploiement), plutôt que d'une valeur concrète.

Vous pouvez récupérer le jeton sous forme d'instance de la Token classe, ou sous forme de chaîne, de liste de chaînes ou de codage numérique. Votre choix dépend du type de valeur requis par la classe ou la méthode avec laquelle vous souhaitez utiliser le paramètre.

TypeScript
Propriété type de valeur
value Tokeninstance de classe
valueAsList Le jeton représenté sous forme de liste de chaînes
valueAsNumber Le jeton représenté par un chiffre
valueAsString Le jeton représenté sous forme de chaîne
JavaScript
Propriété type de valeur
value Tokeninstance de classe
valueAsList Le jeton représenté sous forme de liste de chaînes
valueAsNumber Le jeton représenté par un chiffre
valueAsString Le jeton représenté sous forme de chaîne
Python
Propriété type de valeur
value Tokeninstance de classe
value_as_list Le jeton représenté sous forme de liste de chaînes
value_as_number Le jeton représenté par un chiffre
value_as_string Le jeton représenté sous forme de chaîne
Java
Propriété type de valeur
getValue() Tokeninstance de classe
getValueAsList() Le jeton représenté sous forme de liste de chaînes
getValueAsNumber() Le jeton représenté par un chiffre
getValueAsString() Le jeton représenté sous forme de chaîne
C#
Propriété type de valeur
Value Tokeninstance de classe
ValueAsList Le jeton représenté sous forme de liste de chaînes
ValueAsNumber Le jeton représenté par un chiffre
ValueAsString Le jeton représenté sous forme de chaîne

Par exemple, pour utiliser un paramètre dans une Bucket définition :

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
};

Déployer CDK des applications contenant des paramètres

Lorsque vous déployez un AWS CloudFormation modèle généré via la AWS CloudFormation console, vous êtes invité à fournir les valeurs de chaque paramètre.

Vous pouvez également fournir des valeurs de paramètres à l'aide du CDK CLI cdk deploycommande, ou en spécifiant les valeurs des paramètres dans le fichier de pile de votre CDK projet.

Fournissez des valeurs de paramètres avec cdk deploy

Lorsque vous déployez à l'aide du CDK CLI cdk deploycommande, vous pouvez fournir des valeurs de paramètres lors du déploiement avec l'--parametersoption.

Voici un exemple de structure de cdk deploy commande :

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

Si votre CDK application contient une seule pile, il n'est pas nécessaire de fournir l'argument d'ID logique de la pile ni la stack-name valeur de l'--parametersoption. Le CDK CLI trouvera et fournira automatiquement ces valeurs. Voici un exemple qui spécifie une uploadbucket valeur pour le uploadBucketName paramètre de la pile unique dans notre CDK application :

$ cdk deploy --parameters uploadBucketName=uploadbucket

Fournir des valeurs de paramètres avec cdk deploy pour les applications multi-stack

Voici un exemple d'CDKapplication dans TypeScript qui contient deux CDK piles. Chaque pile contient une instance de compartiment Amazon S3 et un paramètre permettant de définir le nom du compartiment 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',
});

Pour les CDK applications contenant plusieurs piles, vous pouvez effectuer les opérations suivantes :

  • Déployer une pile avec des paramètres : pour déployer une pile unique à partir d'une application à plusieurs piles, fournissez l'ID logique de la pile comme argument.

    Voici un exemple de déploiement MySecondStack avec mynewbucketname comme valeur de paramètre pour bucketNameParam :

    $ cdk deploy MySecondStack --parameters bucketNameParam='mynewbucketname'

  • Déployez toutes les piles et spécifiez les valeurs des paramètres pour chaque pile : fournissez le '*' caractère générique ou l'--alloption permettant de déployer toutes les piles. Fournissez l'--parametersoption plusieurs fois en une seule commande pour spécifier les valeurs des paramètres pour chaque pile. Voici un exemple :

    $ cdk deploy '*' --parameters MyFirstDeployedStack:bucketNameParam='mynewfirststackbucketname' --parameters MySecondDeployedStack:bucketNameParam='mynewsecondstackbucketname'

  • Déployez toutes les piles et spécifiez les valeurs des paramètres pour une seule pile : fournissez le '*' caractère générique ou l'--alloption permettant de déployer toutes les piles. Spécifiez ensuite la pile pour laquelle définir le paramètre dans l'--parametersoption. Voici des exemples qui déploient toutes les piles dans une CDK application et spécifient une valeur de paramètre pour la MySecondDeployedStack AWS CloudFormation pile. Toutes les autres piles seront déployées et utiliseront la valeur de paramètre par défaut :

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

Fournissez des valeurs de paramètres avec cdk deploy pour les applications avec des piles imbriquées

Le CDK CLI le comportement lorsque vous travaillez avec des applications contenant des piles imbriquées est similaire à celui des applications à piles multiples. La principale différence est que si vous souhaitez déployer toutes les piles imbriquées, utilisez le '**' joker. Le '*' joker déploie toutes les piles mais ne déploie pas les piles imbriquées. Le '**' joker déploie toutes les piles, y compris les piles imbriquées.

Voici un exemple qui déploie des piles imbriquées tout en spécifiant la valeur du paramètre pour une pile imbriquée :

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

Pour plus d'informations sur les options de cdk deploy commande, consultezcdk deploy.