Struct RedisEnterpriseTemplate 

pub struct RedisEnterpriseTemplate { /* private fields */ }

Redis Enterprise template for production-grade deployments

Implementations

impl RedisEnterpriseTemplate

pub fn new(name: impl Into<String>) -> Self

Create a new Redis Enterprise template

pub fn cluster_name(self, name: impl Into<String>) -> Self

Set the cluster name

pub fn admin_username(self, username: impl Into<String>) -> Self

Set the admin username (email format required)

pub fn admin_password(self, password: impl Into<String>) -> Self

Set the admin password (must be strong)

pub fn accept_eula(self) -> Self

Accept the End User License Agreement

pub fn license_file(self, path: impl Into<String>) -> Self

Set a license file path

pub fn ui_port(self, port: u16) -> Self

Set the UI port (default: 8443)

pub fn api_port(self, port: u16) -> Self

Set the API port (default: 9443)

pub fn database_port_start(self, port: u16) -> Self

Set the starting port for database endpoints (default: 12000)

pub fn persistent_path(self, path: impl Into<String>) -> Self

Set custom persistent storage path

pub fn ephemeral_path(self, path: impl Into<String>) -> Self

Set custom ephemeral storage path

pub fn memory_limit(self, limit: impl Into<String>) -> Self

Set memory limit for the container

pub fn with_database(self, name: impl Into<String>) -> Self

Create an initial database after cluster setup

pub fn custom_image( self, image: impl Into<String>, tag: impl Into<String>, ) -> Self

Use a custom Redis Enterprise image and tag

Example

let template = RedisEnterpriseTemplate::new("my-redis")
    .custom_image("my-registry/redis-enterprise", "latest")
    .platform("linux/arm64")
    .accept_eula();

pub fn platform(self, platform: impl Into<String>) -> Self

Set the platform for the container (e.g., “linux/arm64”, “linux/amd64”)

This is especially useful for ARM-based Redis Enterprise images on Apple Silicon Macs or ARM servers.

pub fn bootstrap_timeout(self, timeout: Duration) -> Self

Set the bootstrap timeout (default: 60 seconds)

pub fn bootstrap_retries(self, retries: u32) -> Self

Set the number of bootstrap retries (default: 3)

pub fn api_ready_timeout(self, timeout: Duration) -> Self

Set the API ready timeout (default: 30 seconds)

pub async fn start(self) -> Result<RedisEnterpriseConnectionInfo, Error>

Start the Redis Enterprise container and initialize the cluster

Errors

Returns an error if:

• EULA is not accepted
• Container fails to start
• Cluster initialization fails
• API is not accessible