Configuration Reference

Version:5.3.2

Redis Lettuce Config Properties

🔗
Table 1. Configuration Properties for DefaultRedisConnectionPoolConfiguration
Property Type Description

redis.pool.min-idle

java.lang.Integer

redis.pool.max-idle

java.lang.Integer

redis.pool.max-total

java.lang.Integer

redis.pool.enabled

java.lang.Boolean

🔗
Table 2. Configuration Properties for DefaultRedisConfiguration
Property Type Description

redis.host

java.lang.String

redis.sentinel-master-id

java.lang.String

redis.port

int

redis.socket

java.lang.String

redis.username

java.lang.String

redis.password

java.lang.String

redis.credentials-provider

io.lettuce.core.RedisCredentialsProvider

redis.timeout

java.time.Duration

redis.database

int

redis.client-name

java.lang.String

redis.ssl

boolean

redis.verify-peer

boolean

redis.start-tls

boolean

redis.uri

java.net.URI

Sets the Redis URI for configuration by string.

redis.uris

java.net.URI

Sets the Redis URIs for cluster configuration.

redis.io-thread-pool-size

java.lang.Integer

Sets the thread pool size (number of threads to use) for I/O operations (default value is the number of CPUs). The thread pool size is only effective if no {@link io.lettuce.core.resource.ClientResources.Builder#eventLoopGroupProvider} is provided.

{@link io.lettuce.core.resource.ClientResources.Builder#ioThreadPoolSize(int)}

redis.computation-thread-pool-size

java.lang.Integer

Sets the thread pool size (number of threads to use) for computation operations (default value is the number of CPUs). The thread pool size is only effective if no {@link io.lettuce.core.resource.ClientResources.Builder#eventExecutorGroup} is provided.

{@link io.lettuce.core.resource.ClientResources.Builder#computationThreadPoolSize(int)}

redis.name

java.lang.String

Sets the name of the bean.

🔗
Table 3. Configuration Properties for DefaultRedisCacheConfiguration
Property Type Description

redis.cache.server

java.lang.String

redis.cache.key-serializer

java.lang.Class

redis.cache.value-serializer

java.lang.Class

redis.cache.charset

java.nio.charset.Charset

The charset used to serialize and deserialize values

redis.cache.expire-after-write

java.time.Duration

The cache expiration duration after writing into it.

redis.cache.expire-after-access

java.time.Duration

The cache expiration duration after accessing it

redis.cache.expiration-after-write-policy

java.lang.String

The class path for an implementation of ExpirationAfterWritePolicy

🔗
Table 4. Configuration Properties for Configuration
Property Type Description

redis.embedded.redis-exec-provider

redis.embedded.RedisExecProvider

redis.embedded.port

java.lang.Integer

redis.embedded.slave-of

java.net.InetSocketAddress

redis.embedded.config-file

java.lang.String

redis.embedded.setting

java.lang.String

🔗
Table 5. Configuration Properties for NamedRedisServersConfiguration
Property Type Description

redis.servers.*.host

java.lang.String

redis.servers.*.sentinel-master-id

java.lang.String

redis.servers.*.port

int

redis.servers.*.socket

java.lang.String

redis.servers.*.username

java.lang.String

redis.servers.*.password

java.lang.String

redis.servers.*.credentials-provider

io.lettuce.core.RedisCredentialsProvider

redis.servers.*.timeout

java.time.Duration

redis.servers.*.database

int

redis.servers.*.client-name

java.lang.String

redis.servers.*.ssl

boolean

redis.servers.*.verify-peer

boolean

redis.servers.*.start-tls

boolean

redis.servers.*.uri

java.net.URI

Sets the Redis URI for configuration by string.

redis.servers.*.uris

java.net.URI

Sets the Redis URIs for cluster configuration.

redis.servers.*.io-thread-pool-size

java.lang.Integer

Sets the thread pool size (number of threads to use) for I/O operations (default value is the number of CPUs). The thread pool size is only effective if no {@link io.lettuce.core.resource.ClientResources.Builder#eventLoopGroupProvider} is provided.

{@link io.lettuce.core.resource.ClientResources.Builder#ioThreadPoolSize(int)}

redis.servers.*.computation-thread-pool-size

java.lang.Integer

Sets the thread pool size (number of threads to use) for computation operations (default value is the number of CPUs). The thread pool size is only effective if no {@link io.lettuce.core.resource.ClientResources.Builder#eventExecutorGroup} is provided.

{@link io.lettuce.core.resource.ClientResources.Builder#computationThreadPoolSize(int)}

redis.servers.*.name

java.lang.String

Sets the name of the bean.

🔗
Table 6. Configuration Properties for RedisCacheConfiguration
Property Type Description

redis.caches.*.server

java.lang.String

redis.caches.*.key-serializer

java.lang.Class

redis.caches.*.value-serializer

java.lang.Class

redis.caches.*.charset

java.nio.charset.Charset

The charset used to serialize and deserialize values

redis.caches.*.expire-after-write

java.time.Duration

The cache expiration duration after writing into it.

redis.caches.*.expire-after-access

java.time.Duration

The cache expiration duration after accessing it

redis.caches.*.expiration-after-write-policy

java.lang.String

The class path for an implementation of ExpirationAfterWritePolicy

🔗
Table 7. Configuration Properties for RedisHttpSessionConfiguration
Property Type Description

micronaut.session.http.redis.namespace

java.lang.String

Sets the namespace to use.

micronaut.session.http.redis.server-name

java.lang.String

Sets the server name.

micronaut.session.http.redis.session-created-topic

java.lang.String

Sets the topic to publish session created events to.

micronaut.session.http.redis.active-sessions-key

java.lang.String

Sets the key to store active sessions in.

micronaut.session.http.redis.value-serializer

java.lang.Class

Sets the default value serializer to use.

micronaut.session.http.redis.charset

java.nio.charset.Charset

Sets the charset to use to serialize values.

micronaut.session.http.redis.enable-keyspace-events

boolean

Sets whether keyspace events should be enabled at startup.

micronaut.session.http.redis.write-mode

RedisHttpSessionConfiguration$WriteMode

Sets the write mode to use.

micronaut.session.http.redis.expired-session-check

java.time.Duration

Sets the duration to check for expired sessions.