Redis parameters

Parameters for creating a service

These parameters are provided as parameters in the method CreateService.

When creating a new service, the parameters marked as Required should be provided.

If the selected version Redis supports other parameters, they can be set in the options parameter.

version

DBMS version.

Required	Datatype	Valid values
Yes	String	3.6 4.0 4.2 4.4 5.0

password

User password.

Required	Datatype	Valid values
No	String	The string should be 8 to 128 characters and should not contain ', ", ` and \

cluster_type

Clustering option. Available only when High-availability service is selected.

Required	Datatype	Valid values
Yes, if the High-availability service option is selected.	String	native sentinel

persistence_rdb

RDB storage mode.

Required	Datatype	Valid values
No	Boolean	true false

persistence_aof

AOF storage mode.

Required	Datatype	Valid values
No	Boolean	true false

databases

Number of databases (not relevant for high availability services).

Required	Datatype	Valid values	Default	Auto
No	Integer	1–2147483647	16	N/A

maxmemory

Maximum RAM size that will be allocated for user data on cluster nodes.

Note

RAM_LIMIT value is specified in MiB and equals to RAM size minus 3072 MiB (3 GiB).

Required	Datatype	Valid values, MiB	Default	Auto, MiB
No	String	0–RAM_LIMIT	N/A	RAM_LIMIT*80% – for single-node configurations, Sentinel, and a traditional 6-node Kubernetes cluster RAM_LIMIT*40% – for a traditional 3-node Kubernetes cluster

maxmemory-policy

Memory management mode when there is not enough memory.

Required	Datatype	Valid values	Default	Auto
No	String	noeviction allkeys-lru allkeys-lfu volatile-lru allkeys-random volatile-ttl volatile-lfu volatile-random	noeviction	N/A

The mode parameters are described here.

timeout

Time in seconds, for which connection to an inactive client is maintained.

Required	Datatype	Valid values	Default	Auto
No	Integer	0–2147483647	0	N/A

tcp-backlog

The size of a connection queue.

Required	Datatype	Valid values	Default	Auto
No	Integer	1–4096	511	N/A

tcp-keepalive

This option is used in order to detect dead peers (clients that cannot be reached even if they are identified as connected).

Required	Datatype	Valid values	Default	Auto
No	Integer	Non-negative	300	N/A

This parameter is described in the Redis documentation.

monitoring - The monitoring information for the instance

Connection to a monitoring service.

Required	Editable	Datatype	Valid values	Default
For all services, except for Prometheus	Yes	Boolean	true false	false

monitor_by

Monitoring service ID. The specified service must be deployed in the same project as the current service.

Required	Editable	Datatype	Valid values
Yes, if the monitoring = true parameter is passed. If monitoring = false, the parameter cannot be passed	Yes	String	The ID of a monitoring service running within the same VPC as the current service

monitoring_labels

Labels to be assigned to the metrics of the monitored service in the monitoring service.

Required	Editable	Datatype	Valid values
No. If monitoring = false, the parameter cannot be passed	Yes	Dict	The label name may contain digits, Latin letters, and an underscore character. The label value may contain any ASCII characters.

logging

Connection to a logging service.

Required	Editable	Datatype	Valid values	Default
For all services, except for ELK and Prometheus	Yes	Boolean	true false	false

log_to

Logging service ID. The logged service must be deployed in the same project as the current service.

Required	Editable	Datatype	Valid values	Default
Yes, if the logging = true parameter is passed. If logging = false, the parameter cannot be passed	Yes	String	The ID of a monitoring service running within the same VPC as the current service

logging_tags

Tags to be assigned in the logging service to the log records of the current service.

Required	Editable	Datatype	Valid values	Default
No. If logging = false, the parameter cannot be passed	Yes	List of strings	String of 256 characters max

options

Container for other parameters Redis.

Note

If the parameter name includes a dot, then it cannot be passed in the container for additional parameters. If you need to use such parameter, contact technical support.

Required	Datatype	Valid values
No	Dict	N/A