Trabalhar com dados de chave-valor

Este tópico descreve como adicionar pares de chave-valor a um armazenamento de chave-valor existente. Para incluir pares de chave-valor ao criar inicialmente armazenamentos de chave-valor, consulte Criar um armazenamento de chave-valor.

Trabalhar com pares de chave-valor (console)

É possível usar o console do CloudFront para trabalhar com os seus pares de chave-valor.

Sobre o KeyValueStore do CloudFront

Se você estiver usando a AWS Command Line Interface (AWS CLI) ou seu próprio código para chamar a API KeyValueStore do CloudFront, consulte as seções a seguir.

Quando você trabalha com um armazenamento de chave-valor e seus pares de chave-valor, o serviço que você chama depende do seu caso de uso:

Tanto a API do CloudFront quanto a API KeyValueStore do CloudFront têm uma operação DescribeKeyValueStore. Você pode chamá-los por diferentes motivos. Para entender as diferenças, consulte a tabela a seguir.

Trabalhar com pares de chave-valor (AWS CLI)

É possível executar os comandos da AWS Command Line Interface a seguir no KeyValueStore do CloudFront.

Listar pares de chave-valor

Para listar pares de chave-valor no armazenamento de chave-valor, execute o comando a seguir.

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

Resposta

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

Obter pares de chave-valor

Para obter um par de chave-valor no armazenamento de chave-valor, execute o comando a seguir.

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

Resposta

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

Descrever um armazenamento de chave-valor

Para descrever um armazenamento de chave-valor, execute o comando a seguir.

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

Resposta

{
    "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"
}

Criar um par de chave-valor

Para criar um par de chave-valor no armazenamento de chave-valor, execute o comando a seguir.

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

Resposta

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

Excluir um par de chave-valor

Para excluir um par de chave-valor, execute o comando a seguir.

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

Saída

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

Atualizar pares de chave-valor

É possível usar o comando update-keys para atualizar mais de um par de chave-valor. Por exemplo, para excluir um par de chave-valor e criar outro, execute o comando a seguir.

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"}]'

Resposta

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

Trabalhar com pares de chave-valor (API)

Siga esta seção para trabalhar com os pares de chave-valor de forma programática.

Obter uma referência a um armazenamento de chave-valor

Ao usar a API KeyValueStore do CloudFront para chamar uma operação de gravação, é necessário especificar o ARN e a ETag do armazenamento de chave-valor. Para obter esses dados, faça o seguinte:

Alterar pares de chave-valor em um armazenamento de chave-valor

É possível especificar o armazenamento de chave-valor que contém o par de chave-valor que você deseja atualizar.

Veja as seguintes operações da API KeyValueStore do CloudFront:

Exemplo de código de KeyValueStore do CloudFront

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