鍵值存放區的協助程式方法

如果您使用「索引鍵值存放區」將CloudFront 索引鍵值包含在您建立的函數中，則適用本節。 CloudFront 函數有一個模塊，它提供了三個輔助方法來讀取鍵值存儲中的值。

若要在函數程式碼中使用此模組，請確定您已將索引鍵值存放區與函數相關聯。

接下來，在函數程式碼的第一行中包含下列陳述式：

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

您的金鑰值存放區 ID 可能如下所示：a1b2c3d4-5678-90ab-cdef-EXAMPLE1

get() 方法

使用此方法可傳回您指定之金鑰名稱的索引鍵值。

請求

get("key", options);

• key：需要擷取其值的鍵名稱

• options：有一個選擇，format。它可以確保函數正確解析資料。可能的值如下：

  • string：(預設值) 以 UTF8 編碼

  • json

  • bytes：原始二進位資料緩衝區

請求示例

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

回應

響應是一promise個解析為使用請求的格式的值options。默認情況下，該值作為字符串返回。

exists() 方法

使用此方法可識別索引鍵是否存在於索引鍵值存放區中。

請求

exists("key");

請求示例

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

回應

回應是傳回布林值 (true或false) 的回應。promise此值指定索引鍵是否存在於索引鍵值存放區中。

錯誤處理

當您請求的密鑰不存在於關聯的鍵值存儲中時，該get()方法將返回錯誤。若要管理此使用案例，您可以在程式碼中新增try和catch區塊。

meta() 方法

使用此方法返回有關鍵值存儲的元數據。

請求

meta();

請求示例

const meta = await kvsHandle.meta();

回應

回應是一個 promise，可解析為具有以下屬性的物件：

• creationDateTime：鍵值存放區建立的日期和時間，以 ISO 8601 格式表示。

• lastUpdatedDateTime：上次從來源同步的鍵值存放區的日期和時間，以 ISO 8601 格式表示。該值不包括到邊緣的傳播時間。

• keyCount：上次從來源同步後 KVS 中的總鍵數。

回應範例

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