Module subscriptions

Expand description

Subscription management for Pro (Flexible) plans

This module provides comprehensive management of Redis Cloud Pro subscriptions, which offer flexible, scalable Redis deployments with advanced features like auto-scaling, multi-region support, and Active-Active configurations.

§Overview

Pro subscriptions are Redis Cloud’s most flexible offering, supporting everything from small development instances to large-scale production deployments with automatic scaling, clustering, and global distribution.

§Key Features

Flexible Scaling: Auto-scaling based on usage patterns
Multi-Region: Deploy across multiple regions and cloud providers
Active-Active: Global database replication with local reads/writes
Advanced Networking: VPC peering, Transit Gateway, Private endpoints
Maintenance Windows: Configurable maintenance scheduling
CIDR Management: IP allowlist and security group configuration
Custom Pricing: Usage-based pricing with detailed cost tracking

§Subscription Types

Single-Region: Standard deployment in one region
Multi-Region: Replicated across multiple regions
Active-Active: CRDB with conflict-free replicated data types

§Example Usage

use redis_cloud::{CloudClient, SubscriptionHandler};

let client = CloudClient::builder()
    .api_key("your-api-key")
    .api_secret("your-api-secret")
    .build()?;

let handler = SubscriptionHandler::new(client);

// List all Pro subscriptions
let subscriptions = handler.get_all_subscriptions().await?;

// Get subscription details (subscription ID 123)
let subscription = handler.get_subscription_by_id(123).await?;

// Manage maintenance windows
let windows = handler.get_subscription_maintenance_windows(123).await?;

Structs§

AccountSubscriptions: RedisLabs list of subscriptions in current account
ActiveActiveRegionCreateRequest: Active active region creation request message
ActiveActiveRegionDeleteRequest: Active active region deletion request message
ActiveActiveRegionToDelete: The names of the regions to delete.
ActiveActiveSubscriptionRegions: List of active-active subscription regions
BaseSubscriptionUpdateRequest: Subscription update request message
CidrAllowlistUpdateRequest: Update Pro subscription
CloudDetail: Cloud provider details for a subscription
CrdbRegionSpec: List of databases in the subscription with local throughput details. Default: 1000 read and write ops/sec for each database
CustomerManagedKey: Object representing a customer managed key (CMK), along with the region it is associated to.
CustomerManagedKeyAccessDetails: Configuration regarding customer managed persistent storage encryption
DatabaseModuleSpec: Optional. Redis advanced capabilities (also known as modules) to be provisioned in the database. Use GET /database-modules to get a list of available advanced capabilities.
DatabaseThroughputSpec: Optional. Throughput measurement method.
LocalThroughput: Optional. Expected read and write throughput for this region.
MaintenanceWindow: MaintenanceWindow
MaintenanceWindowSkipStatus: MaintenanceWindowSkipStatus
MaintenanceWindowSpec: Maintenance window timeframes if mode is set to ‘manual’. Up to 7 maintenance windows can be provided.
RedisVersion: RedisVersion
RedisVersions: RedisVersions
Subscription: RedisLabs Subscription information Subscription
SubscriptionCreateRequest: Request structure for creating a new Pro subscription
SubscriptionDatabaseSpec: One or more database specification(s) to create in this subscription.
SubscriptionHandler: Handler for Pro subscription operations
SubscriptionMaintenanceWindows: SubscriptionMaintenanceWindows
SubscriptionMaintenanceWindowsSpec: SubscriptionMaintenanceWindowsSpec
SubscriptionNetworking: Networking configuration in a subscription region
SubscriptionPricing: SubscriptionPricing
SubscriptionPricings: SubscriptionPricings
SubscriptionRegion: Region details in a subscription response
SubscriptionRegionNetworkingSpec: Optional. Cloud networking details, per region. Required if creating an Active-Active subscription.
SubscriptionRegionSpec: The cloud provider region or list of regions (Active-Active only) and networking details.
SubscriptionSpec: Cloud provider, region, and networking details.
SubscriptionUpdateCMKRequest: Subscription update request message
SubscriptionUpdateRequest: Subscription update request message
TaskStateUpdate: TaskStateUpdate