Méthodes d’aide pour les magasins de clés-valeurs

Cette section s'applique si vous utilisez le CloudFront Key Value Store pour inclure des valeurs clés dans la fonction que vous créez. CloudFront Functions possède un module qui fournit trois méthodes d'assistance pour lire les valeurs du magasin de valeurs clés.

Pour utiliser ce module dans le code de fonction, assurez-vous d'avoir associé un magasin de valeurs clés à la fonction.

Ajoutez ensuite les instructions suivantes dans les premières lignes du code de fonction :

import cf from 'cloudfront';
const kvsId = "key value store ID";
const kvsHandle = cf.kvs(kvsId);

L'identifiant de votre boutique de valeurs clés peut ressembler à ce qui suit : a1b2c3d4-5678-90ab-cdef-EXAMPLE1

Méthode get()

Utilisez cette méthode pour renvoyer la valeur de clé pour le nom de clé que vous spécifiez.

Demande

get("key", options);

• key : nom de la clé dont la valeur doit être extraite

• options: Il y a une option,format. Elle garantit que la fonction analyse correctement les données. Valeurs possibles :

  • string : (par défaut) encodé en UTF8

  • json

  • bytes : tampon de données binaires brutes

Exemple de demande

const value = await kvsHandle.get("myFunctionKey", { format: "string"});

Réponse

La réponse est une promise qui aboutit à une valeur au format demandé en utilisantoptions. Par défaut, la valeur est renvoyée sous forme de chaîne.

Méthode exists()

Utilisez cette méthode pour déterminer si la clé existe ou non dans le magasin de valeurs clés.

Demande

exists("key");

Exemple de demande

const exist = await kvsHandle.exists("myFunctionkey");

Réponse

La réponse est un promise qui renvoie une valeur booléenne (trueoufalse). Cette valeur indique si la clé existe ou non dans le magasin de valeurs clés.

Gestion des erreurs

La get() méthode renvoie une erreur lorsque la clé que vous avez demandée n'existe pas dans le magasin de valeurs clé associé. Pour gérer ce cas d'utilisation, vous pouvez ajouter un catch bloc try et à votre code.

Méthode meta()

Utilisez cette méthode pour renvoyer des métadonnées relatives au magasin de valeurs clés.

Demande

meta();

Exemple de demande

const meta = await kvsHandle.meta();

Réponse

La réponse est un élément promise qui se résout à un objet doté des propriétés suivantes :

• creationDateTime : date et heure de création du magasin de clés-valeurs, au format ISO 8601.

• lastUpdatedDateTime : date et heure de la dernière synchronisation du magasin de clés-valeurs depuis la source, au format ISO 8601. La valeur n’inclut pas la durée de propagation jusqu’à la périphérie.

• keyCount : nombre total de clés dans le magasin de clés-valeurs après la dernière synchronisation depuis la source.

Exemple de réponse

{keyCount:3,creationDateTime:2023-11-30T23:07:55.765Z,lastUpdatedDateTime:2023-12-15T03:57:52.411Z}