Struct CacheConfig

pub struct CacheConfig {
    pub max_cache_size: usize,
    pub cache_item_ttl: u128,
    pub version_stage: String,
}

Configuration options for the SecretCache.

Defaults:

• max_cache_size: 1024
• cache_item_ttl: 3600000000000 (1hr)
• version_stage: “AWSCURRENT”

Fields

max_cache_size: usize

The maximum number of secrets to maintain in the cache.

The least frequently accessed items will be evicted from the cache once a max_cache_size number of items are stored.

Default: 1024

cache_item_ttl: u128

The TTL expiry of items in the cache.

Determines the number of nanoseconds a cached secret will be considered valid before the secret value is required to be refreshed. Refreshing happens synchronously.

Default: 3600000000000 (1 hour in nanoseconds)

version_stage: String

The version stage used when requesting secrets from AWS Secrets Manager.

Default: “AWSCURRENT”

Implementations

impl CacheConfig

pub fn new() -> Self

Returns a new Cache Configuration with default values set.

Defaults:

• max_cache_size: 1024
• cache_item_ttl: 3600000000000 (1hr)
• version_stage: “AWSCURRENT”

pub fn max_cache_size(self, max_cache_size: usize) -> Self

Sets the max_cache_size cache configuration option to a different value.

pub fn cache_item_ttl(self, cache_item_ttl: u128) -> Self

Sets the cache_item_ttl cache configuration option to a different value.

Trait Implementations

impl Default for CacheConfig

fn default() -> Self

Returns the “default value” for a type.