Utilisation de données clé-valeur

Cette rubrique décrit comment ajouter des paires clé-valeur à un magasin de clés-valeurs existant. Pour inclure des paires clé-valeur lorsque vous créez initialement le magasin de clés-valeurs, consultez Création d’un magasin de clés-valeurs.

Utilisation de paires clé-valeur (console)

Vous pouvez utiliser la console CloudFront pour gérer vos paires clé-valeur.

À propos de CloudFront KeyValueStore

Si vous utilisez l’AWS Command Line Interface (AWS CLI) ou votre propre code pour appeler l’API CloudFront KeyValueStore, consultez les sections suivantes.

Lorsque vous utilisez un magasin de clés-valeurs et ses paires clé-valeur, le service que vous appelez dépend de votre cas d’utilisation :

L’API CloudFront et l’API CloudFront KeyValueStore disposent toutes deux d’une opération DescribeKeyValueStore. Vous les appelez pour différentes raisons. Pour comprendre les différences, consultez le tableau suivant.

Utilisation des paires clé-valeur (AWS CLI)

Vous pouvez exécuter les commandes de l’AWS Command Line Interface suivantes pour CloudFront KeyValueStore.

Liste des paires clé-valeur

Pour répertorier les paires clé-valeur dans votre magasin de clés-valeurs, exécutez la commande suivante.

aws cloudfront-keyvaluestore list-keys \
    --kvs-arn=arn:aws:cloudfront::123456789012:key-value-store/37435e19-c205-4271-9e5c-example

Réponse

{
    "Items": [
        {
            "Key": "key1",
            "Value": "value1"
        }
    ]
}

Obtention des paires clé-valeur

Pour obtenir les paires clé-valeur dans votre magasin de clés-valeurs, exécutez la commande suivante.

aws cloudfront-keyvaluestore get-key \
    --key=key1 \
    --kvs-arn=arn:aws:cloudfront::123456789012:key-value-store/37435e19-c205-4271-9e5c-example

Réponse

{
    "Key": "key1",
    "Value": "value1",
    "ItemCount": 1,
    "TotalSizeInBytes": 11
}

Description d’un magasin de clés-valeurs

Pour décrire un magasin de clés-valeurs, exécutez la commande suivante.

aws cloudfront-keyvaluestore describe-key-value-store \
    --kvs-arn=arn:aws:cloudfront::123456789012:key-value-store/37435e19-c205-4271-9e5c-example

Réponse

{
    "ETag": "KV1F83G8C2ARO7P",
    "ItemCount": 1,
    "TotalSizeInBytes": 11,
    "KvsARN": "arn:aws:cloudfront::123456789012:key-value-store/37435e19-c205-4271-9e5c-example",
    "Created": "2024-05-08T07:48:45.381000-07:00",
    "LastModified": "2024-08-05T13:50:58.843000-07:00",
    "Status": "READY"
}

Création d’une paire clé-valeur

Pour créer une paire clé-valeur dans votre magasin de clés-valeurs, exécutez la commande suivante.

aws cloudfront-keyvaluestore put-key \
    --if-match=KV1PA6795UKMFR9 \
    --key=key2 \
    --value=value2 \
    --kvs-arn=arn:aws:cloudfront::123456789012:key-value-store/37435e19-c205-4271-9e5c-example

Réponse

{
    "ETag": "KV13V1IB3VIYZZH",
    "ItemCount": 3,
    "TotalSizeInBytes": 31
}

Suppression d’une paire clé-valeur

Pour supprimer une paire clé-valeur, exécutez la commande suivante.

aws cloudfront-keyvaluestore delete-key \
    --if-match=KV13V1IB3VIYZZH \
    --key=key1 \
    --kvs-arn=arn:aws:cloudfront::123456789012:key-value-store/37435e19-c205-4271-9e5c-example

Sortie

{
    "ETag": "KV1VC38T7YXB528",
    "ItemCount": 2,
    "TotalSizeInBytes": 22
}

Mise à jour d’une paire clé-valeur

Vous pouvez utiliser la commande update-keys pour mettre à jour plusieurs paires clé-valeur. Par exemple, pour supprimer une paire clé-valeur existante et en créer une autre, exécutez la commande suivante.

aws cloudfront-keyvaluestore update-keys \
    --if-match=KV2EUQ1WTGCTBG2 \
    --kvs-arn=arn:aws:cloudfront::123456789012:key-value-store/37435e19-c205-4271-9e5c-example \
    --deletes '[{"Key":"key2"}]' \
    --puts '[{"Key":"key3","Value":"value3"}]'

Réponse

{
    "ETag": "KV3AEGXETSR30VB",
    "ItemCount": 3,
    "TotalSizeInBytes": 28
}

Utilisation des paires clé-valeur (API)

Suivez cette section pour utiliser vos paires clé-valeur par programmation.

Obtention d’une référence à un magasin de clés-valeurs

Lorsque vous utilisez l’API CloudFront KeyValueStore pour appeler une opération d’écriture, vous devez spécifier l’ARN et l’ETag du magasin de clés-valeurs. Pour obtenir ces données, procédez comme suit :

Modification de paires clé-valeur dans un magasin de clés-valeurs

Vous pouvez spécifier le magasin de clés-valeurs qui contient la paire clé-valeur que vous souhaitez mettre à jour.

Consultez les opérations d’API CloudFront KeyValueStore suivantes :

Exemple de code pour CloudFront KeyValueStore

const {
  CloudFrontKeyValueStoreClient,
  DescribeKeyValueStoreCommand,
} = require("@aws-sdk/client-cloudfront-keyvaluestore");

require("@aws-sdk/signature-v4-crt");

(async () => {
  try {
    const client = new CloudFrontKeyValueStoreClient({
      region: "us-east-1"
    });
    const input = {
      KvsARN: "arn:aws:cloudfront::123456789012:key-value-store/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
    };
    const command = new DescribeKeyValueStoreCommand(input);

    const response = await client.send(command);
  } catch (e) {
    console.log(e);
  }
})();