本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。 # 使用 Java 搭配用戶端快取取得 Secrets Manager 秘密值擷取秘密時，您可以使用 Secrets Manager Java 型快取元件進行快取以供將來使用。擷取快取的秘密比從 Secrets Manager 中擷取要快。由於呼叫 Secrets Manager API 需要花費成本，因此使用快取可以降低成本。如需您可以擷取機密的所有方法，請參閱 [取得秘密](retrieving-secrets.md)。快取政策是「最近最少使用的 (LRU)」，因此當快取必須丟棄秘密時，其會丟棄最近最少使用的秘密。預設情況下，快取每小時重新整理一次秘密。您可以設定在快取中[重新整理機密的頻率](retrieving-secrets_cache-java-ref_SecretCacheConfiguration.md#retrieving-secrets_cache-java-ref_SecretCacheConfiguration_methods-getCacheItemTTL)，並可以[掛接到機密擷取](retrieving-secrets_cache-java-ref_SecretCacheHook.md)以新增更多功能。一旦釋放快取參考，快取不會強制執行垃圾回收。快取實作不包括快取失效。快取實作著重於快取本身，而不是強化或著重於安全性。如果您需要額外的安全性，例如加密快取中的項目，請使用提供的介面和抽象方法。若要使用元件，您必須擁有下列項目： + Java 8 或更高版本的開發環境。請參閱 Oracle 網站上的 [Java SE 下載](https://www.oracle.com/technetwork/java/javase/downloads/index.html)。若要下載開放程式碼，請參閱 [Secrets Manager Java 型快取用戶端元件](https://github.com/aws/aws-secretsmanager-caching-java) (在 GitHub 上)。要將元件新增至您的專案中，請在 Maven pom.xml 檔案中包含以下相依性。如需 Maven 的詳細資訊，請參閱 Apache Maven 專案網站上的[入門指南](https://maven.apache.org/guides/getting-started/index.html)。 ``` com.amazonaws.secretsmanager aws-secretsmanager-caching-java 1.0.2 ``` **必要許可：** + `secretsmanager:DescribeSecret` + `secretsmanager:GetSecretValue` 如需詳細資訊，請參閱[許可參考](auth-and-access.md#reference_iam-permissions)。 **Topics** + [ # SecretCache ](retrieving-secrets_cache-java-ref_SecretCache.md) + [ # SecretCacheConfiguration ](retrieving-secrets_cache-java-ref_SecretCacheConfiguration.md) + [ # SecretCacheHook ](retrieving-secrets_cache-java-ref_SecretCacheHook.md) **Example 擷取秘密** 下列程式碼範例顯示擷取秘密字串的 Lambda 函數。它遵循將函數處理常式之外的快取執行個體化的[最佳實務](https://docs.aws.amazon.com/lambda/latest/dg/best-practices.html)，所以如果您再次呼叫 Lambda 函數，則不會繼續呼叫 API。 ``` package com.amazonaws.secretsmanager.caching.examples; import com.amazonaws.services.lambda.runtime.Context; import com.amazonaws.services.lambda.runtime.RequestHandler; import com.amazonaws.services.lambda.runtime.LambdaLogger; import com.amazonaws.secretsmanager.caching.SecretCache; public class SampleClass implements RequestHandler { private final SecretCache cache = new SecretCache(); @Override public String handleRequest(String secretId, Context context) { final String secret = cache.getSecretString(secretId); // Use the secret, return success; } } ``` # SecretCache 從 Secrets Manager 請求的秘密記憶體內快取。您使用 [getSecretString](#retrieving-secrets_cache-java-ref_SecretCache-methods-getSecretString) 或 [getSecretBinary](#retrieving-secrets_cache-java-ref_SecretCache-methods-getSecretBinary) 從快取中擷取秘密。您可以透過在建構函式的 [SecretCacheConfiguration](retrieving-secrets_cache-java-ref_SecretCacheConfiguration.md) 物件中傳遞，設定快取設定。如需包含範例的詳細資訊，請參閱 [使用 Java 搭配用戶端快取取得 Secrets Manager 秘密值](retrieving-secrets_cache-java.md)。 ## 建構函式 `public SecretCache()` `SecretCache` 物件的預設建構函式。 `public SecretCache(AWSSecretsManagerClientBuilder builder)` 使用以提供的 [https://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/com/amazonaws/services/secretsmanager/AWSSecretsManagerClientBuilder.html](https://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/com/amazonaws/services/secretsmanager/AWSSecretsManagerClientBuilder.html) 建立的 Secrets Manager 用戶端建構新快取。使用此建構函數自訂 Secrets Manager 用戶端，例如使用特定區域或端點。 `public SecretCache(AWSSecretsManager client)` 使用提供的 [https://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/com/amazonaws/services/secretsmanager/AWSSecretsManagerClient.html](https://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/com/amazonaws/services/secretsmanager/AWSSecretsManagerClient.html) 建構新的秘密快取。使用此建構函數自訂 Secrets Manager 用戶端，例如使用特定區域或端點。 `public SecretCache(SecretCacheConfiguration config)` 使用提供的 `SecretCacheConfiguration` 建構新的秘密快取。 ## 方法 ### getSecretString `public String getSecretString(final String secretId)` 從 Secrets Manager 中擷取字串秘密。傳回 [https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true](https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true)。 ### getSecretBinary `public ByteBuffer getSecretBinary(final String secretId)` 從 Secrets Manager 中擷取二進位秘密。傳回 [https://docs.oracle.com/javase/7/docs/api/java/nio/ByteBuffer.html](https://docs.oracle.com/javase/7/docs/api/java/nio/ByteBuffer.html)。 ### refreshNow `public boolean refreshNow(final String secretId) throws InterruptedException` 強制重新整理快取。如果重新整理完成且沒有錯誤，則會傳回 `true`，否則會傳回 `false`。 ### 關閉 `public void close()` 關閉快取。 # SecretCacheConfiguration [SecretCache](retrieving-secrets_cache-java-ref_SecretCache.md) 的快取組態選項，例如最大快取大小和快取秘密的存留時間 (TTL)。 ## 建構函數 `public SecretCacheConfiguration` `SecretCacheConfiguration` 物件的預設建構函式。 ## 方法 ### getClient `public AWSSecretsManager getClient()` 傳回 [https://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/com/amazonaws/services/secretsmanager/AWSSecretsManagerClient.html](https://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/com/amazonaws/services/secretsmanager/AWSSecretsManagerClient.html)，快取從中擷取秘密。 ### setClient `public void setClient(AWSSecretsManager client)` 傳回 [https://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/com/amazonaws/services/secretsmanager/AWSSecretsManagerClient.html](https://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/com/amazonaws/services/secretsmanager/AWSSecretsManagerClient.html) 用戶端，快取從中擷取秘密。 ### getCacheHook `public SecretCacheHook getCacheHook()` 傳回用於與快取更新掛鉤的 [SecretCacheHook](retrieving-secrets_cache-java-ref_SecretCacheHook.md) 介面。 ### setCacheHook `public void setCacheHook(SecretCacheHook cacheHook)` 設定用於與快取更新掛鉤的 [SecretCacheHook](retrieving-secrets_cache-java-ref_SecretCacheHook.md) 介面。 ### getMaxCacheSize `public int getMaxCacheSize()` 傳回最大快取大小。預設值為 1024 個秘密。 ### setMaxCacheSize `public void setMaxCacheSize(int maxCacheSize)` 設定最大快取大小。預設值為 1024 個秘密。 ### getCacheItemTTL `public long getCacheItemTTL()` 傳回快取項目的 TTL (以毫秒為單位)。當快取的秘密超過此 TTL 時，快取會從 [https://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/com/amazonaws/services/secretsmanager/AWSSecretsManagerClient.html](https://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/com/amazonaws/services/secretsmanager/AWSSecretsManagerClient.html) 擷取秘密的新複本。預設值為 1 小時 (以毫秒為單位)。當在 TTL 之後請求秘密時，快取會同步重新整理秘密。如果同步重新整理失敗，則快取會傳回過時的秘密。 ### setCacheItemTTL `public void setCacheItemTTL(long cacheItemTTL)` 設定快取項目的 TTL (以毫秒為單位)。當快取的秘密超過此 TTL 時，快取會從 [https://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/com/amazonaws/services/secretsmanager/AWSSecretsManagerClient.html](https://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/com/amazonaws/services/secretsmanager/AWSSecretsManagerClient.html) 擷取秘密的新複本。預設值為 1 小時 (以毫秒為單位)。 ### getVersionStage `public String getVersionStage()` 傳回要快取的秘密版本。如需詳細資訊，請參閱[秘密版本](whats-in-a-secret.md#term_version)。預設為 ` "AWSCURRENT"`。 ### setVersionStage `public void setVersionStage(String versionStage)` 設定要快取的秘密版本。如需詳細資訊，請參閱[秘密版本](whats-in-a-secret.md#term_version)。預設為 `"AWSCURRENT"`。 ### SecretCacheConfiguration withClient `public SecretCacheConfiguration withClient(AWSSecretsManager client)` 設定 [https://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/com/amazonaws/services/secretsmanager/AWSSecretsManagerClient.html](https://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/com/amazonaws/services/secretsmanager/AWSSecretsManagerClient.html)，以從中擷取秘密。使用新設定傳回已更新的 `SecretCacheConfiguration` 物件。 ### SecretCacheConfiguration withCacheHook `public SecretCacheConfiguration withCacheHook(SecretCacheHook cacheHook)` 設定用於與記憶體內快取掛鉤的介面。使用新設定傳回已更新的 `SecretCacheConfiguration` 物件。 ### SecretCacheConfiguration withMaxCacheSize `public SecretCacheConfiguration withMaxCacheSize(int maxCacheSize)` 設定最大快取大小。使用新設定傳回已更新的 `SecretCacheConfiguration` 物件。 ### SecretCacheConfiguration withCacheItemTTL `public SecretCacheConfiguration withCacheItemTTL(long cacheItemTTL)` 設定快取項目的 TTL (以毫秒為單位)。當快取的秘密超過此 TTL 時，快取會從 [https://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/com/amazonaws/services/secretsmanager/AWSSecretsManagerClient.html](https://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/com/amazonaws/services/secretsmanager/AWSSecretsManagerClient.html) 擷取秘密的新複本。預設值為 1 小時 (以毫秒為單位)。使用新設定傳回已更新的 `SecretCacheConfiguration` 物件。 ### SecretCacheConfiguration withVersionStage `public SecretCacheConfiguration withVersionStage(String versionStage)` 設定要快取的秘密版本。如需詳細資訊，請參閱[秘密版本](whats-in-a-secret.md#term_version)。使用新設定傳回已更新的 `SecretCacheConfiguration` 物件。 # SecretCacheHook 用於掛接到 [SecretCache](retrieving-secrets_cache-java-ref_SecretCache.md)，以對存放在快取中的秘密執行動作的介面。 ## put `Object put(final Object o)` 準備要存放在快取中的物件。傳回要存放在快取中的物件。 ## get `Object get(final Object cachedObject)` 從快取的物件中衍生物件。傳回要從快取傳回的物件