Métodos auxiliares para armazenamentos de chave-valor
nota
As chamadas do método auxiliar de armazenamento de chave-valor do CloudFront Functions não acionam um evento de dados do AWS CloudTrail. Esses eventos não são registrados em log no histórico de eventos do CloudTrail. Para obter mais informações, consulte Registrar em log chamadas de API do Amazon CloudFront usando o AWS CloudTrail.
Esta seção se aplicará se você usar o Armazenamento de chave-valor do CloudFront para incluir chave-valor na função criada. O CloudFront Functions tem um módulo que oferece três métodos auxiliares para ler valores do armazenamento de chave-valor.
Para usar esse módulo no código da função, verifique se você associou um armazenamento de chave-valor à função.
Em seguida, inclua as seguintes declarações nas primeiras linhas do código da função:
import cf from 'cloudfront'; const kvsHandle = cf.kvs();
Método get()
Use esse método para retornar o valor do nome da chave especificado.
Solicitação
get("
key
",options
);
-
key
: o nome da chave cujo valor precisa ser buscado. -
options
: existe uma opção,format
. Isso garante que a função analise os dados corretamente. Possíveis valores:-
string
: (padrão) codificado em UTF8. -
json
-
bytes
: buffer de dados binários brutos.
-
Exemplo de solicitação
const value = await kvsHandle.get("myFunctionKey", { format: "string"});
Resposta
A resposta é uma promise
que se resolve para um valor no formato solicitado usando options
. Por padrão, o valor é retornado como uma string.
Gerenciamento de erros
O método get()
retornará um erro quando a chave solicitada não existir no armazenamento de chave-valor associado. Para gerenciar esse caso de uso, é possível adicionar um bloco try
e catch
ao seu código.
Método exists()
Use esse método para identificar se a chave existe ou não no armazenamento de chave-valor.
Solicitação
exists("
key
");
Exemplo de solicitação
const exist = await kvsHandle.exists("myFunctionkey");
Resposta
A resposta é uma promise
que retorna um booleano (true
ou false
). Esse valor especifica se a chave existe ou não no armazenamento de chave-valor.
Método meta()
Use esse método para retornar metadados sobre o armazenamento de chave-valor.
Solicitação
meta();
Exemplo de solicitação
const meta = await kvsHandle.meta();
Resposta
A resposta é uma promise
que é resolvida em um objeto com as seguintes propriedades:
-
creationDateTime
: a data e a hora no formato ISO 8601 em que o armazenamento de chave-valor foi criado. -
lastUpdatedDateTime
: a data e a hora em que o valor da chave armazenado foi sincronizado pela última vez a partir da origem, no formato ISO 8601. O valor não inclui o tempo de propagação até a borda. -
keyCount
: o número total de chaves no KVS após a última sincronização da origem.
Exemplo de resposta
{keyCount:3,creationDateTime:2023-11-30T23:07:55.765Z,lastUpdatedDateTime:2023-12-15T03:57:52.411Z}