本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。
AWS WAF 移動SDK規格
此段落列示最新可用版本的SDK物件、作業和組態設定值 AWS WAF 移動SDK。如需有關權杖提供者和作業如何在各種組態設定組合中運作的詳細資訊，請參閱如何 AWS WAF 移動SDK作品。
WAFToken-
持有一個 AWS WAF 令牌。
getValue()-
擷取的
String表示WAFToken。
WAFTokenProvider-
在您的行動應用程式中管理權杖。使用
WAFConfiguration對象實現此操作。getToken()-
如果啟用後台刷新，這將返回緩存令牌。如果禁用後台刷新，則會進行同步，阻止調用 AWS WAF 檢索一個新的令牌。
onTokenReady(WAFTokenResultCallback)-
指示令牌提供者刷新令牌，並在活動令牌準備就緒時調用提供的回調。令牌提供者將在令牌緩存並準備就緒時在後台線程中調用您的回調。當您的應用程序首次加載以及返回活動狀態時調用此選項。若要取得有關返回使用中狀態的更多資訊，請參閱在應用程序不活動後檢索令牌。
對於 Android 或 iOS 應用程序，您可以設置
WAFTokenResultCallback為在請求的令牌準備就緒時希望令牌提供者調用的操作。您的實現WAFTokenResultCallback必須採用參數WAFToken，SdkError. 對於 iOS 應用程序，您可以交替創建一個內聯函數。 storeTokenInCookieStorage(WAFToken)-
指示儲存
WAFTokenProvider指定的 AWS WAF 令牌進入SDK的 cookie 管理器。默認情況下，令牌僅在首次獲取和刷新時才添加到 cookie 存儲中。如果應用程序出於任何原因清除共享 cookie 存儲，則SDK不會自動添加 AWS WAF 令牌返回，直到下一次刷新。
WAFConfiguration-
保留實作的組態
WAFTokenProvider。實現此操作時，您需要提供 Web ACL 的集成URL，要在令牌中使用的域名以及希望令牌提供程序使用的任何非默認設置。下列清單指定您可以在
WAFConfiguration物件中管理的組態設定。applicationIntegrationUrl-
應用程序集成URL。得到這個從 AWS WAF 控制台或通過
getWebACLAPI呼叫。必要：是
backgroundRefreshEnabled指出您是否希望權杖提供者在背景中重新整理權杖。如果您設定此項，權杖提供者會根據管理自動權杖重新整理活動的組態設定，在背景重新整理您的權杖。
必要：否
類型：
Boolean預設值：
TRUEdomainName-
要在權杖中使用的網域，用於權杖擷取和 Cookie 儲存。例如
example.com或aws.amazon.com。這通常是與 Web 相關聯的資源的主機域ACL，您將在其中發送 Web 請求。對於受ACFP管規則群組AWSManagedRulesACFPRuleSet，這通常是與您在規則群組組態中提供之帳戶建立路徑中的網域相符的單一網域。對於受ATP管規則群組AWSManagedRulesATPRuleSet，這通常是與您在規則群組配置中提供之登入路徑中的網域相符的單一網域。不允許使用公共後綴。例如，您無法使用
gov.au或co.uk做為權杖網域。該域必須是一個 AWS WAF 將根據受保護的主機域和 Web ACL 的令牌域列表接受。如需詳細資訊，請參閱AWS WAF Web ACL 令牌域列表配置。
必要：是
類型：
String maxErrorTokenRefreshDelayMsec-
嘗試失敗後重複權杖重新整理之前等待的最長時間 (以毫秒為單位)。這個值會在權杖擷取失敗並重試
maxRetryCount次數之後使用。必要：否
類型：
Integer預設值：
5000(5 秒)允許的最小值：
1（1 毫秒）允許的最大值：
30000（30 秒） maxRetryCount-
要求權杖時，使用指數輪詢執行的重試次數上限。
必要：否
類型：
Integer預設值：如果啟用了背景重新整理，
5. 否則為3。允許的最小值：
0允許的最大值：
10 setTokenCookie指出您是否希望SDK的 Cookie 管理器在您的請求中添加令牌 cookie。默認情況下，這會向所有請求添加一個令牌 cookie。Cookie 管理器將一個令牌 cookie 添加到其路徑位於中指定的路徑下的任何請求
tokenCookiePath。必要：否
類型：
Boolean預設值：
TRUEtokenCookiePath-
當
setTokenCookie是時使用TRUE。指出您希望 Cookie 管理員新增權杖 Cookie SDK 的最上層路徑。管理器將令牌 cookie 添加到您發送到此路徑和所有子路徑的所有請求。例如，如果您將其設置為
/web/login，則管理器包含發送到的所有內容/web/login及其任何子路徑的令牌 cookie，例如/web/login/help。它不包括發送到其他路徑的請求的令牌/，例如/web，或/web/order。必要：否
類型：
String預設值：
/ tokenRefreshDelaySec-
用於後台刷新。背景權杖重新整理之間的時間上限 (以秒為單位)。
必要：否
類型：
Integer預設值：
88允許的最小值：
88允許的最大值：
300（5 分鐘）
