org.springframework.cloud.aws.cache.config.annotation

Annotation Type CacheClusterConfig

public @interface CacheClusterConfig

Configuration annotation used by the EnableElastiCache annotation to configure cache specific attributes. This annotation allows to explicitly to define the cache names and also to configure further cache specific attributes like the expiration.

Author:

Agim Emruli

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	name Defines the name for the cache cluster.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
int	expiration Configures the expiration time of the particular cache cluster in seconds.

Element Detail

name

public abstract String name

Defines the name for the cache cluster. The name might be the physical name of the cache cluster itself or a logical name of a cache cluster inside a stack. The caching infrastructure will automatically retrieve the cache engine (redis or memcached) and configured the appropriate cache driver with the cache implementation. Caches can be used inside the application code with the Cacheable annotation or others referring to this name attribute inside the Cacheable.value() attribute.

Returns:

- the name of the cache cluster

expiration

public abstract int expiration

Configures the expiration time of the particular cache cluster in seconds. The expiration time is based on the cache level and is implementation specific. Typically this expiration time will configure the expiration of one item at the time the item is inserted into the cache regardless of the last access.

Returns:

the expiration with a default of 0. If this value is not explicitly configured then the value of EnableElastiCache.defaultExpiration() will be used.

Default:

0