Enregistrer et récupérer les valeurs des variables de contexte - AWS Kit de développement Cloud (AWS CDK) v2
Spécifier les variables de contexteRécupérer les valeurs des variables de contexte

Ceci est le guide du développeur du AWS CDK v2. L'ancien CDK v1 est entré 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.

Enregistrer et récupérer les valeurs des variables de contexte

Vous pouvez spécifier des variables de contexte à l'aide de la CLI du AWS Cloud Development Kit (AWS CDK) ou dans le cdk.json fichier. Utilisez ensuite la TryGetContext méthode pour récupérer les valeurs.

Spécifier les variables de contexte

Vous pouvez spécifier une variable de contexte soit dans le cadre d'une commande AWS CDK CLI, soit danscdk.json.

Pour créer une variable de contexte en ligne de commande, utilisez l'option --context (-c), comme indiqué dans l'exemple suivant.

cdk synth -c bucket_name=mygroovybucket

Pour spécifier la même variable de contexte et la même valeur dans le cdk.json fichier, utilisez le code suivant.

{
  "context": {
    "bucket_name": "myotherbucket"
  }
}

Si vous spécifiez une variable de contexte à l'aide de la CLI AWS CDK et cdk.json du fichier, la valeur de la AWS CLI CDK est prioritaire.

Récupérer les valeurs des variables de contexte

Pour obtenir la valeur d'une variable de contexte dans votre application, utilisez la TryGetContext méthode dans le contexte d'une construction. (C'est-à-dire quandthis, ou self en Python, est une instance d'une construction.)

Dans cet exemple, nous récupérons la valeur de la variable de bucket_name contexte. Si la valeur demandée n'est pas définie, TryGetContext renvoie undefined (Noneen Python ; null en Java et C# ; nil en Go) plutôt que de déclencher une exception.

Exemple
TypeScript
const bucket_name = this.node.tryGetContext('bucket_name');
JavaScript
const bucket_name = this.node.tryGetContext('bucket_name');
Python
bucket_name = self.node.try_get_context("bucket_name")
Java
String bucketName = (String)this.getNode().tryGetContext("bucket_name");
C#
var bucketName = this.Node.TryGetContext("bucket_name");

En dehors du contexte d'une construction, vous pouvez accéder à la variable de contexte depuis l'objet de l'application, comme ceci.

Exemple
TypeScript
const app = new cdk.App();
const bucket_name = app.node.tryGetContext('bucket_name')
JavaScript
const app = new cdk.App();
const bucket_name = app.node.tryGetContext('bucket_name');
Python
app = cdk.App()
bucket_name = app.node.try_get_context("bucket_name")
Java
App app = App();
String bucketName = (String)app.getNode().tryGetContext("bucket_name");
C#
app = App();
var bucketName = app.Node.TryGetContext("bucket_name");

Pour plus de détails sur l'utilisation des variables de contexte, voir Valeurs de contexte et AWS CDK.