Index
All Classes and Interfaces|All Packages|Constant Field Values
B
- BUGFIX_REVISION_NUM - Static variable in class com.amazonaws.secretsmanager.caching.cache.internal.VersionInfo
C
- clear() - Method in class com.amazonaws.secretsmanager.caching.cache.LRUCache
-
Clear the cache.
- client - Variable in class com.amazonaws.secretsmanager.caching.cache.SecretCacheObject
-
The AWS Secrets Manager client to use for requesting secrets.
- close() - Method in class com.amazonaws.secretsmanager.caching.SecretCache
-
Method to close the cache.
- com.amazonaws.secretsmanager.caching - package com.amazonaws.secretsmanager.caching
- com.amazonaws.secretsmanager.caching.cache - package com.amazonaws.secretsmanager.caching.cache
- com.amazonaws.secretsmanager.caching.cache.internal - package com.amazonaws.secretsmanager.caching.cache.internal
- config - Variable in class com.amazonaws.secretsmanager.caching.cache.SecretCacheObject
-
The Secret Cache Configuration.
- containsKey(K) - Method in class com.amazonaws.secretsmanager.caching.cache.LRUCache
-
Determine if the cache contains the given key.
D
- DEFAULT_CACHE_ITEM_TTL - Static variable in class com.amazonaws.secretsmanager.caching.SecretCacheConfiguration
-
The default TTL for an item stored in cache before access causing a refresh.
- DEFAULT_MAX_CACHE_SIZE - Static variable in class com.amazonaws.secretsmanager.caching.SecretCacheConfiguration
-
The default cache size.
- DEFAULT_VERSION_STAGE - Static variable in class com.amazonaws.secretsmanager.caching.SecretCacheConfiguration
-
The default version stage to use when retrieving secret values.
E
- equals(Object) - Method in class com.amazonaws.secretsmanager.caching.cache.SecretCacheItem
- equals(Object) - Method in class com.amazonaws.secretsmanager.caching.cache.SecretCacheObject
- equals(Object) - Method in class com.amazonaws.secretsmanager.caching.cache.SecretCacheVersion
- exception - Variable in class com.amazonaws.secretsmanager.caching.cache.SecretCacheObject
-
If the last request to AWS Secrets Manager resulted in an exception, that exception will be thrown back to the caller when requesting secret data.
- executeRefresh() - Method in class com.amazonaws.secretsmanager.caching.cache.SecretCacheItem
-
Execute the logic to perform the actual refresh of the item.
- executeRefresh() - Method in class com.amazonaws.secretsmanager.caching.cache.SecretCacheObject
-
Execute the actual refresh of the cached secret state.
- executeRefresh() - Method in class com.amazonaws.secretsmanager.caching.cache.SecretCacheVersion
-
Execute the logic to perform the actual refresh of the item.
G
- get(Object) - Method in interface com.amazonaws.secretsmanager.caching.SecretCacheHook
-
Derive the object from the cached object.
- get(K) - Method in class com.amazonaws.secretsmanager.caching.cache.LRUCache
-
Return the value mapped to the given key.
- getAndPut(K, V) - Method in class com.amazonaws.secretsmanager.caching.cache.LRUCache
-
Return the previously mapped value and map a new value.
- getAndRemove(K) - Method in class com.amazonaws.secretsmanager.caching.cache.LRUCache
-
Return the previously mapped value and remove the key.
- getCacheHook() - Method in class com.amazonaws.secretsmanager.caching.SecretCacheConfiguration
-
Returns the interface used to hook in-memory cache updates.
- getCacheItemTTL() - Method in class com.amazonaws.secretsmanager.caching.SecretCacheConfiguration
-
Returns the TTL for the cached items.
- getClient() - Method in class com.amazonaws.secretsmanager.caching.SecretCacheConfiguration
-
Returns the AWS Secrets Manager client that is used for requesting secret values.
- getMaxCacheSize() - Method in class com.amazonaws.secretsmanager.caching.SecretCacheConfiguration
-
Returns the max cache size that should be used for creating the cache.
- getSecretBinary(String) - Method in class com.amazonaws.secretsmanager.caching.SecretCache
-
Method to retrieve a binary secret from AWS Secrets Manager.
- getSecretString(String) - Method in class com.amazonaws.secretsmanager.caching.SecretCache
-
Method to retrieve a string secret from AWS Secrets Manager.
- getSecretValue() - Method in class com.amazonaws.secretsmanager.caching.cache.SecretCacheObject
-
Return the cached result from AWS Secrets Manager for GetSecretValue.
- getSecretValue(DescribeSecretResponse) - Method in class com.amazonaws.secretsmanager.caching.cache.SecretCacheItem
-
Return the cached result from AWS Secrets Manager for GetSecretValue.
- getSecretValue(GetSecretValueResponse) - Method in class com.amazonaws.secretsmanager.caching.cache.SecretCacheVersion
-
Return the cached result from AWS Secrets Manager for GetSecretValue.
- getSecretValue(T) - Method in class com.amazonaws.secretsmanager.caching.cache.SecretCacheObject
-
Execute the actual refresh of the cached secret state.
- getVersionStage() - Method in class com.amazonaws.secretsmanager.caching.SecretCacheConfiguration
-
Returns the version stage that is used for requesting secret values.
H
- hashCode() - Method in class com.amazonaws.secretsmanager.caching.cache.SecretCacheItem
- hashCode() - Method in class com.amazonaws.secretsmanager.caching.cache.SecretCacheObject
- hashCode() - Method in class com.amazonaws.secretsmanager.caching.cache.SecretCacheVersion
I
- isRefreshNeeded() - Method in class com.amazonaws.secretsmanager.caching.cache.SecretCacheItem
-
Determine if the secret object should be refreshed.
- isRefreshNeeded() - Method in class com.amazonaws.secretsmanager.caching.cache.SecretCacheObject
-
Determine if the secret object should be refreshed.
L
- lock - Variable in class com.amazonaws.secretsmanager.caching.cache.SecretCacheObject
-
A private object to synchronize access to certain methods.
- LRUCache<K,
V> - Class in com.amazonaws.secretsmanager.caching.cache -
An LRU cache based on the Java LinkedHashMap.
- LRUCache() - Constructor for class com.amazonaws.secretsmanager.caching.cache.LRUCache
-
Construct a new cache with default settings.
- LRUCache(int) - Constructor for class com.amazonaws.secretsmanager.caching.cache.LRUCache
-
Construct a new cache based on the given max size.
M
- MAJOR_REVISION_NUM - Static variable in class com.amazonaws.secretsmanager.caching.cache.internal.VersionInfo
- MINOR_REVISION_NUM - Static variable in class com.amazonaws.secretsmanager.caching.cache.internal.VersionInfo
P
- put(Object) - Method in interface com.amazonaws.secretsmanager.caching.SecretCacheHook
-
Prepare the object for storing in the cache
- put(K, V) - Method in class com.amazonaws.secretsmanager.caching.cache.LRUCache
-
Map a given key to the given value.
- putAll(Map<? extends K, ? extends V>) - Method in class com.amazonaws.secretsmanager.caching.cache.LRUCache
-
Copies all of the mappings from the provided map to this cache.
- putIfAbsent(K, V) - Method in class com.amazonaws.secretsmanager.caching.cache.LRUCache
-
Map a given key to the given value if not already mapped.
R
- refreshNow() - Method in class com.amazonaws.secretsmanager.caching.cache.SecretCacheObject
-
Method to force the refresh of a cached secret state.
- refreshNow(String) - Method in class com.amazonaws.secretsmanager.caching.SecretCache
-
Method to force the refresh of a cached secret state.
- RELEASE_VERSION - Static variable in class com.amazonaws.secretsmanager.caching.cache.internal.VersionInfo
- remove(K) - Method in class com.amazonaws.secretsmanager.caching.cache.LRUCache
-
Remove a given key from the cache.
- remove(K, V) - Method in class com.amazonaws.secretsmanager.caching.cache.LRUCache
-
Remove a given key and value from the cache.
- removeAll() - Method in class com.amazonaws.secretsmanager.caching.cache.LRUCache
-
Remove all of the cached items.
S
- SecretCache - Class in com.amazonaws.secretsmanager.caching
-
Provides the primary entry-point to the AWS Secrets Manager client cache SDK.
- SecretCache() - Constructor for class com.amazonaws.secretsmanager.caching.SecretCache
-
Constructs a new secret cache using the standard AWS Secrets Manager client with default options.
- SecretCache(SecretCacheConfiguration) - Constructor for class com.amazonaws.secretsmanager.caching.SecretCache
-
Constructs a new secret cache using the provided cache configuration.
- SecretCache(SecretsManagerClient) - Constructor for class com.amazonaws.secretsmanager.caching.SecretCache
-
Constructs a new secret cache using the provided AWS Secrets Manager client.
- SecretCache(SecretsManagerClientBuilder) - Constructor for class com.amazonaws.secretsmanager.caching.SecretCache
-
Constructs a new secret cache using an AWS Secrets Manager client created using the provided builder.
- SecretCacheConfiguration - Class in com.amazonaws.secretsmanager.caching
-
Cache configuration options such as max cache size, ttl for cached items, etc.
- SecretCacheConfiguration() - Constructor for class com.amazonaws.secretsmanager.caching.SecretCacheConfiguration
-
Default constructor for the SecretCacheConfiguration object.
- SecretCacheHook - Interface in com.amazonaws.secretsmanager.caching
-
Interface to hook the local in-memory cache.
- SecretCacheItem - Class in com.amazonaws.secretsmanager.caching.cache
-
The cached secret item which contains information from the DescribeSecret request to AWS Secrets Manager along with any associated GetSecretValue results.
- SecretCacheItem(String, SecretsManagerClient, SecretCacheConfiguration) - Constructor for class com.amazonaws.secretsmanager.caching.cache.SecretCacheItem
-
Construct a new cached item for the secret.
- SecretCacheObject<T> - Class in com.amazonaws.secretsmanager.caching.cache
-
Basic secret caching object.
- SecretCacheObject(String, SecretsManagerClient, SecretCacheConfiguration) - Constructor for class com.amazonaws.secretsmanager.caching.cache.SecretCacheObject
-
Construct a new cached item for the secret.
- SecretCacheVersion - Class in com.amazonaws.secretsmanager.caching.cache
-
The cached secret version item which contains information from the GetSecretValue AWS Secrets Manager request.
- SecretCacheVersion(String, String, SecretsManagerClient, SecretCacheConfiguration) - Constructor for class com.amazonaws.secretsmanager.caching.cache.SecretCacheVersion
-
Construct a new cached version for the secret.
- secretId - Variable in class com.amazonaws.secretsmanager.caching.cache.SecretCacheObject
-
The secret identifier for this cached object.
- setCacheHook(SecretCacheHook) - Method in class com.amazonaws.secretsmanager.caching.SecretCacheConfiguration
-
Sets the interface used to hook the in-memory cache.
- setCacheItemTTL(long) - Method in class com.amazonaws.secretsmanager.caching.SecretCacheConfiguration
-
Sets the TTL in milliseconds for the cached items.
- setClient(SecretsManagerClient) - Method in class com.amazonaws.secretsmanager.caching.SecretCacheConfiguration
-
Sets the AWS Secrets Manager client that should be used by the cache for requesting secrets.
- setMaxCacheSize(int) - Method in class com.amazonaws.secretsmanager.caching.SecretCacheConfiguration
-
Sets the max cache size.
- setVersionStage(String) - Method in class com.amazonaws.secretsmanager.caching.SecretCacheConfiguration
-
Sets the version stage that should be used for requesting secret values from AWS Secrets Manager
T
- toString() - Method in class com.amazonaws.secretsmanager.caching.cache.SecretCacheItem
- toString() - Method in class com.amazonaws.secretsmanager.caching.cache.SecretCacheObject
- toString() - Method in class com.amazonaws.secretsmanager.caching.cache.SecretCacheVersion
U
- USER_AGENT - Static variable in class com.amazonaws.secretsmanager.caching.cache.internal.VersionInfo
V
- VERSION_NUM - Static variable in class com.amazonaws.secretsmanager.caching.cache.internal.VersionInfo
- VersionInfo - Class in com.amazonaws.secretsmanager.caching.cache.internal
-
This class specifies the versioning system for the AWS SecretsManager caching client.
W
- withCacheHook(SecretCacheHook) - Method in class com.amazonaws.secretsmanager.caching.SecretCacheConfiguration
-
Sets the interface used to hook the in-memory cache.
- withCacheItemTTL(long) - Method in class com.amazonaws.secretsmanager.caching.SecretCacheConfiguration
-
Sets the TTL in milliseconds for the cached items.
- withClient(SecretsManagerClient) - Method in class com.amazonaws.secretsmanager.caching.SecretCacheConfiguration
-
Sets the AWS Secrets Manager client that should be used by the cache for requesting secrets.
- withMaxCacheSize(int) - Method in class com.amazonaws.secretsmanager.caching.SecretCacheConfiguration
-
Sets the max cache size.
- withVersionStage(String) - Method in class com.amazonaws.secretsmanager.caching.SecretCacheConfiguration
-
Sets the version stage that should be used for requesting secret values from AWS Secrets Manager
All Classes and Interfaces|All Packages|Constant Field Values