pub struct DatabaseCreateRequest {Show 34 fields
pub subscription_id: Option<i32>,
pub dry_run: Option<bool>,
pub name: String,
pub protocol: Option<String>,
pub port: Option<i32>,
pub memory_limit_in_gb: Option<f64>,
pub dataset_size_in_gb: Option<f64>,
pub redis_version: Option<String>,
pub resp_version: Option<String>,
pub support_oss_cluster_api: Option<bool>,
pub use_external_endpoint_for_oss_cluster_api: Option<bool>,
pub data_persistence: Option<String>,
pub data_eviction_policy: Option<String>,
pub replication: Option<bool>,
pub replica_of: Option<Vec<String>>,
pub replica: Option<ReplicaOfSpec>,
pub throughput_measurement: Option<DatabaseThroughputSpec>,
pub local_throughput_measurement: Option<Vec<LocalThroughput>>,
pub average_item_size_in_bytes: Option<i64>,
pub periodic_backup_path: Option<String>,
pub remote_backup: Option<DatabaseBackupConfig>,
pub source_ip: Option<Vec<String>>,
pub client_ssl_certificate: Option<String>,
pub client_tls_certificates: Option<Vec<DatabaseCertificateSpec>>,
pub enable_tls: Option<bool>,
pub password: Option<String>,
pub sasl_username: Option<String>,
pub sasl_password: Option<String>,
pub alerts: Option<Vec<DatabaseAlertSpec>>,
pub modules: Option<Vec<DatabaseModuleSpec>>,
pub sharding_type: Option<String>,
pub command_type: Option<String>,
pub query_performance_factor: Option<String>,
pub extra: Value,
}
Expand description
Request structure for creating a new Pro database
Contains all configuration options for creating a database in a Pro subscription, including memory settings, replication, persistence, modules, and networking.
Fields§
§subscription_id: Option<i32>
§dry_run: Option<bool>
Optional. When ‘false’: Creates a deployment plan and deploys it, creating any resources required by the plan. When ‘true’: creates a read-only deployment plan and does not create any resources. Default: ‘false’
name: String
Name of the database. Database name is limited to 40 characters or less and must include only letters, digits, and hyphens (‘-’). It must start with a letter and end with a letter or digit.
protocol: Option<String>
Optional. Database protocol. Only set to ‘memcached’ if you have a legacy application. Default: ‘redis’
port: Option<i32>
Optional. TCP port on which the database is available (10000-19999). Generated automatically if not set.
memory_limit_in_gb: Option<f64>
Optional. Total memory in GB, including replication and other overhead. You cannot set both datasetSizeInGb and totalMemoryInGb.
dataset_size_in_gb: Option<f64>
Optional. The maximum amount of data in the dataset for this database in GB. You cannot set both datasetSizeInGb and totalMemoryInGb. If ‘replication’ is ‘true’, the database’s total memory will be twice as large as the datasetSizeInGb. If ‘replication’ is false, the database’s total memory will be the datasetSizeInGb value.
redis_version: Option<String>
Optional. If specified, redisVersion defines the Redis database version. If omitted, the Redis version will be set to the default version (available in ‘GET /subscriptions/redis-versions’)
resp_version: Option<String>
Optional. Redis Serialization Protocol version. Must be compatible with Redis version.
support_oss_cluster_api: Option<bool>
Optional. Support OSS Cluster API. Default: ‘false’
use_external_endpoint_for_oss_cluster_api: Option<bool>
Optional. If set to ‘true’, the database will use the external endpoint for OSS Cluster API. This setting blocks the database’s private endpoint. Can only be set if ‘supportOSSClusterAPI’ is ‘true’. Default: ‘false’
data_persistence: Option<String>
Optional. Type and rate of data persistence in persistent storage. Default: ‘none’
data_eviction_policy: Option<String>
Optional. Data eviction policy. Default: ‘volatile-lru’
replication: Option<bool>
Optional. Sets database replication. Default: ‘true’
replica_of: Option<Vec<String>>
Optional. This database will be a replica of the specified Redis databases provided as one or more URI(s). Example: ‘redis://user:password@host:port’. If the URI provided is a Redis Cloud database, only host and port should be provided. Example: [‘redis://endpoint1:6379’, ‘redis://endpoint2:6380’].
replica: Option<ReplicaOfSpec>
§throughput_measurement: Option<DatabaseThroughputSpec>
§local_throughput_measurement: Option<Vec<LocalThroughput>>
Optional. Expected throughput per region for an Active-Active database. Default: 1000 read and write ops/sec for each region
average_item_size_in_bytes: Option<i64>
Optional. Relevant only to ram-and-flash (also known as Auto Tiering) subscriptions. Estimated average size in bytes of the items stored in the database. Default: 1000
periodic_backup_path: Option<String>
Optional. The path to a backup storage location. If specified, the database will back up every 24 hours to this location, and you can manually back up the database to this location at any time.
remote_backup: Option<DatabaseBackupConfig>
§source_ip: Option<Vec<String>>
Optional. List of source IP addresses or subnet masks to allow. If specified, Redis clients will be able to connect to this database only from within the specified source IP addresses ranges. Example: ’[‘192.168.10.0/32’, ‘192.168.12.0/24’]’
client_ssl_certificate: Option<String>
Optional. A public key client TLS/SSL certificate with new line characters replaced with ‘\n’. If specified, mTLS authentication will be required to authenticate user connections. Default: ‘null’
client_tls_certificates: Option<Vec<DatabaseCertificateSpec>>
Optional. A list of client TLS/SSL certificates. If specified, mTLS authentication will be required to authenticate user connections.
enable_tls: Option<bool>
Optional. When ‘true’, requires TLS authentication for all connections - mTLS with valid clientTlsCertificates, regular TLS when clientTlsCertificates is not provided. Default: ‘false’
password: Option<String>
Optional. Password to access the database. If not set, a random 32-character alphanumeric password will be automatically generated. Can only be set if ‘protocol’ is ‘redis’.
sasl_username: Option<String>
Optional. Memcached (SASL) Username to access the database. If not set, the username will be set to a ‘mc-’ prefix followed by a random 5 character long alphanumeric. Can only be set if ‘protocol’ is ‘memcached’.
sasl_password: Option<String>
Optional. Memcached (SASL) Password to access the database. If not set, a random 32 character long alphanumeric password will be automatically generated. Can only be set if ‘protocol’ is ‘memcached’.
alerts: Option<Vec<DatabaseAlertSpec>>
Optional. Redis database alert details.
modules: Option<Vec<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.
sharding_type: Option<String>
Optional. Database Hashing policy.
command_type: Option<String>
§query_performance_factor: Option<String>
Optional. The query performance factor adds extra compute power specifically for search and query databases. You can increase your queries per second by the selected factor.
extra: Value
Additional fields from the API
Trait Implementations§
Source§impl Clone for DatabaseCreateRequest
impl Clone for DatabaseCreateRequest
Source§fn clone(&self) -> DatabaseCreateRequest
fn clone(&self) -> DatabaseCreateRequest
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more