redis-cloud 0.7.0

Redis Cloud REST API client library
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95

# 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
- 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

```toml
[dependencies]
redis-cloud = "0.1.0"
```

## Quick Start

```rust
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`](examples/basic_cloud.rs) - Getting started with the API client
- [`database_management.rs`](examples/database_management.rs) - Managing databases

Run examples with:
```bash
# 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
```

## 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](https://api.redislabs.com/v1/swagger-ui/index.html).

## License

Licensed under either of

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

at your option.