redis-cloud

A comprehensive Rust client library for the Redis Cloud REST API.

Features

• Complete coverage of Redis Cloud REST API endpoints
• Async/await support with tokio
• Strong typing for API requests and responses
• Comprehensive error handling
• Optional Tower service integration for middleware composition
• Support for all Redis Cloud features including:
  • Subscriptions and databases
  • User and ACL management
  • Backup and restore operations
  • VPC peering and networking
  • Metrics and monitoring
  • Billing and payment management

Installation

[dependencies]
redis-cloud = "0.1.0"

# Optional: Enable Tower service integration
redis-cloud = { version = "0.1.0", features = ["tower-integration"] }

Quick Start

use redis_cloud::CloudClient;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    // Create client using builder pattern
    let client = CloudClient::builder()
        .api_key("your-api-key")
        .api_secret("your-api-secret")
        .build()?;
    
    // Get account information
    let account = client.account().get().await?;
    println!("Account: {:?}", account);
    
    // List all subscriptions
    let subscriptions = client.subscription().list().await?;
    println!("Subscriptions: {:?}", subscriptions);
    
    // List databases in a subscription
    let databases = client.database().list("subscription-id").await?;
    println!("Databases: {:?}", databases);
    
    Ok(())
}

Examples

The examples/ directory contains runnable examples demonstrating common use cases:

• basic_cloud.rs - Getting started with the API client
• database_management.rs - Managing databases

Run examples with:

# Set your API credentials
export REDIS_CLOUD_API_KEY="your-api-key"
export REDIS_CLOUD_API_SECRET="your-api-secret"

# Run an example
cargo run --example basic

Tower Integration

Enable the tower-integration feature to use the client with Tower middleware:

use redis_cloud::CloudClient;
use redis_cloud::tower_support::ApiRequest;
use tower::ServiceExt;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = CloudClient::builder()
        .api_key("your-api-key")
        .api_secret("your-api-secret")
        .build()?;
    
    // Convert to a Tower service
    let mut service = client.into_service();
    
    // Use the service
    let response = service
        .oneshot(ApiRequest::get("/subscriptions"))
        .await?;
    
    println!("Response: {:?}", response.body);
    Ok(())
}

This enables composition with Tower middleware like circuit breakers, retry, rate limiting, and more.

API Coverage

This library provides comprehensive coverage of the Redis Cloud REST API, including:

• Account Management - Account info, users, payment methods
• Subscriptions - CRUD operations, pricing, CIDR management
• Databases - Full database lifecycle, backups, imports, metrics
• ACL Management - Users, roles, Redis rules
• Networking - VPC peering, Transit Gateway, Private Service Connect
• Monitoring - Metrics, logs, alerts
• Billing - Invoices, payment methods, usage

Documentation

For detailed API documentation, see the Redis Cloud API Reference.

License

Licensed under either of

• Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
• MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.