RedisConnectionPoolService

The maximum number of redirects that can be performed when clustered.

Display Name: Cluster Max Redirects
Description: The maximum number of redirects that can be performed when clustered.
API Name: Cluster Max Redirects
Default Value: 5
Expression Language Scope: Not Supported
Sensitive: false
Required: true

The timeout to use when attempting to communicate with Redis.

Display Name: Communication Timeout
Description: The timeout to use when attempting to communicate with Redis.
API Name: Communication Timeout
Default Value: 10 seconds
Expression Language Scope: Not Supported
Sensitive: false
Required: true

The connection string for Redis. In a standalone instance this value will be of the form hostname:port. In a sentinel instance this value will be the comma-separated list of sentinels, such as host1:port1,host2:port2,host3:port3. In a clustered instance this value will be the comma-separated list of cluster masters, such as host1:port,host2:port,host3:port.

Display Name: Connection String
Description: The connection string for Redis. In a standalone instance this value will be of the form hostname:port. In a sentinel instance this value will be the comma-separated list of sentinels, such as host1:port1,host2:port2,host3:port3. In a clustered instance this value will be the comma-separated list of cluster masters, such as host1:port,host2:port,host3:port.
API Name: Connection String
Expression Language Scope: Environment variables defined at JVM level and system properties
Sensitive: false
Required: true

Database Index

The database index to be used by connections created from this connection pool. See the databases property in redis.conf, by default databases 0-15 will be available.

Display Name: Database Index
Description: The database index to be used by connections created from this connection pool. See the databases property in redis.conf, by default databases 0-15 will be available.
API Name: Database Index
Default Value: 0
Expression Language Scope: Environment variables defined at JVM level and system properties
Sensitive: false
Required: true

Password

The password used to authenticate to the Redis server. See the 'requirepass' property in redis.conf.

Display Name: Password
Description: The password used to authenticate to the Redis server. See the 'requirepass' property in redis.conf.
API Name: Password
Expression Language Scope: Environment variables defined at JVM level and system properties
Sensitive: true
Required: false

Pool - Block When Exhausted

Whether or not clients should block and wait when trying to obtain a connection from the pool when the pool has no available connections. Setting this to false means an error will occur immediately when a client requests a connection and none are available.

Display Name

Pool - Block When Exhausted

Description

Whether or not clients should block and wait when trying to obtain a connection from the pool when the pool has no available connections. Setting this to false means an error will occur immediately when a client requests a connection and none are available.

API Name

Pool - Block When Exhausted

Default Value

true

Allowable Values

true
false

Expression Language Scope

Not Supported

Sensitive

false

Required

true

Pool - Max Idle

The maximum number of idle connections that can be held in the pool, or a negative value if there is no limit.

Display Name: Pool - Max Idle
Description: The maximum number of idle connections that can be held in the pool, or a negative value if there is no limit.
API Name: Pool - Max Idle
Default Value: 8
Expression Language Scope: Not Supported
Sensitive: false
Required: true

Pool - Max Total

The maximum number of connections that can be allocated by the pool (checked out to clients, or idle awaiting checkout). A negative value indicates that there is no limit.

Display Name: Pool - Max Total
Description: The maximum number of connections that can be allocated by the pool (checked out to clients, or idle awaiting checkout). A negative value indicates that there is no limit.
API Name: Pool - Max Total
Default Value: 8
Expression Language Scope: Not Supported
Sensitive: false
Required: true

Pool - Max Wait Time

The amount of time to wait for an available connection when Block When Exhausted is set to true.

Display Name: Pool - Max Wait Time
Description: The amount of time to wait for an available connection when Block When Exhausted is set to true.
API Name: Pool - Max Wait Time
Default Value: 10 seconds
Expression Language Scope: Not Supported
Sensitive: false
Required: true

Pool - Min Evictable Idle Time

The minimum amount of time an object may sit idle in the pool before it is eligible for eviction.

Display Name: Pool - Min Evictable Idle Time
Description: The minimum amount of time an object may sit idle in the pool before it is eligible for eviction.
API Name: Pool - Min Evictable Idle Time
Default Value: 60 seconds
Expression Language Scope: Not Supported
Sensitive: false
Required: true

Pool - Min Idle

The target for the minimum number of idle connections to maintain in the pool. If the configured value of Min Idle is greater than the configured value for Max Idle, then the value of Max Idle will be used instead.

Display Name: Pool - Min Idle
Description: The target for the minimum number of idle connections to maintain in the pool. If the configured value of Min Idle is greater than the configured value for Max Idle, then the value of Max Idle will be used instead.
API Name: Pool - Min Idle
Default Value: 0
Expression Language Scope: Not Supported
Sensitive: false
Required: true

Pool - Num Tests Per Eviction Run

The number of connections to tests per eviction attempt. A negative value indicates to test all connections.

Display Name: Pool - Num Tests Per Eviction Run
Description: The number of connections to tests per eviction attempt. A negative value indicates to test all connections.
API Name: Pool - Num Tests Per Eviction Run
Default Value: -1
Expression Language Scope: Not Supported
Sensitive: false
Required: true

Pool - Test On Borrow

Whether or not connections should be tested upon borrowing from the pool.

Display Name

Pool - Test On Borrow

Description

Whether or not connections should be tested upon borrowing from the pool.

API Name

Pool - Test On Borrow

Default Value

false

Allowable Values

true
false

Expression Language Scope

Not Supported

Sensitive

false

Required

true

Pool - Test On Create

Whether or not connections should be tested upon creation.

Display Name

Pool - Test On Create

Description

Whether or not connections should be tested upon creation.

API Name

Pool - Test On Create

Default Value

false

Allowable Values

true
false

Expression Language Scope

Not Supported

Sensitive

false

Required

true

Pool - Test On Return

Whether or not connections should be tested upon returning to the pool.

Display Name

Pool - Test On Return

Description

Whether or not connections should be tested upon returning to the pool.

API Name

Pool - Test On Return

Default Value

false

Allowable Values

true
false

Expression Language Scope

Not Supported

Sensitive

false

Required

true

Pool - Test While Idle

Whether or not connections should be tested while idle.

Display Name

Pool - Test While Idle

Description

Whether or not connections should be tested while idle.

API Name

Pool - Test While Idle

Default Value

true

Allowable Values

true
false

Expression Language Scope

Not Supported

Sensitive

false

Required

true

Pool - Time Between Eviction Runs

The amount of time between attempting to evict idle connections from the pool.

Display Name: Pool - Time Between Eviction Runs
Description: The amount of time between attempting to evict idle connections from the pool.
API Name: Pool - Time Between Eviction Runs
Default Value: 30 seconds
Expression Language Scope: Not Supported
Sensitive: false
Required: true

Redis Mode

The type of Redis being communicated with - standalone, sentinel, or clustered.

Display Name

Redis Mode

Description

The type of Redis being communicated with - standalone, sentinel, or clustered.

API Name

Redis Mode

Default Value

Standalone

Allowable Values

Standalone
Sentinel
Cluster

Expression Language Scope

Not Supported

Sensitive

false

Required

true

Sentinel Master

The name of the sentinel master, require when Mode is set to Sentinel

Display Name: Sentinel Master
Description: The name of the sentinel master, require when Mode is set to Sentinel
API Name: Sentinel Master
Expression Language Scope: Environment variables defined at JVM level and system properties
Sensitive: false
Required: false

Sentinel Password

The password used to authenticate to the Redis Sentinel server. See the 'requirepass' and 'sentinel sentinel-pass' properties in sentinel.conf.

Display Name: Sentinel Password
Description: The password used to authenticate to the Redis Sentinel server. See the 'requirepass' and 'sentinel sentinel-pass' properties in sentinel.conf.
API Name: Sentinel Password
Expression Language Scope: Environment variables defined at JVM level and system properties
Sensitive: true
Required: false

Sentinel Username

The username used to authenticate to the Redis sentinel server.

Display Name: Sentinel Username
Description: The username used to authenticate to the Redis sentinel server.
API Name: Sentinel Username
Expression Language Scope: Environment variables defined at JVM level and system properties
Sensitive: false
Required: false

SSL Context Service

If specified, this service will be used to create an SSL Context that will be used to secure communications; if not specified, communications will not be secure

Display Name: SSL Context Service
Description: If specified, this service will be used to create an SSL Context that will be used to secure communications; if not specified, communications will not be secure
API Name: SSL Context Service
Service Interface: org.apache.nifi.ssl.RestrictedSSLContextService
Service Implementations: org.apache.nifi.ssl.StandardRestrictedSSLContextService
Expression Language Scope: Not Supported
Sensitive: false
Required: false

Username

The username used to authenticate to the Redis server.

Display Name: Username
Description: The username used to authenticate to the Redis server.
API Name: Username
Expression Language Scope: Environment variables defined at JVM level and system properties
Sensitive: false
Required: false

RedisConnectionPoolService 2.0.0