Yandex Cloud
Search
Contact UsTry it for free
  • Customer Stories
  • Documentation
  • Blog
  • All Services
  • System Status
    • Featured
    • Infrastructure & Network
    • Data Platform
    • AI for business
    • Security
    • DevOps tools
    • Serverless
    • Monitoring & Resources
  • All Solutions
    • By industry
    • By use case
    • Economics and Pricing
    • Security
    • Technical Support
    • Start testing with double trial credits
    • Cloud credits to scale your IT product
    • Gateway to Russia
    • Cloud for Startups
    • Center for Technologies and Society
    • Yandex Cloud Partner program
    • Price calculator
    • Pricing plans
  • Customer Stories
  • Documentation
  • Blog
© 2025 Direct Cursus Technology L.L.C.
Yandex Managed Service for Valkey™
  • Getting started
    • All guides
      • Information about existing clusters
      • Creating a cluster
      • Updating cluster settings
      • Valkey™ version upgrade
      • Stopping and starting a cluster
      • Managing cluster hosts
      • Migrating hosts to a different availability zone
      • Managing backups
      • Deleting a cluster
  • Access management
  • Pricing policy
  • Terraform reference
  • Monitoring metrics
  • Audit Trails events
  • Public materials
  • Release notes
  • FAQ

In this article:

  • Creating a cluster
  • Creating a cluster copy
  • Examples
  • Creating a single-host cluster
  • Creating a sharded cluster with a single shard
  • Creating a sharded cluster with three shards
  1. Step-by-step guides
  2. Clusters
  3. Creating a cluster

Creating a Valkey™ cluster

Written by
Yandex Cloud
Updated at December 17, 2025
  • Creating a cluster
  • Creating a cluster copy
  • Examples
    • Creating a single-host cluster
    • Creating a sharded cluster with a single shard
    • Creating a sharded cluster with three shards

A Valkey™ cluster consists of one or more database hosts, with the option to configure replication between them. Replication is enabled by default in any cluster with more than one host: the master host accepts write requests and propagates the changes to its replicas.

For more information on the Yandex Managed Service for Valkey™ cluster structure, see Resource relationships.

Note

  • The number of hosts you can create together with a Valkey™ cluster depends on the selected disk type and host class, as well as on whether sharding is used.
  • The available disk types depend on the selected host class.

Creating a clusterCreating a cluster

To create a Yandex Managed Service for Valkey™ cluster, you need the vpc.user role and the managed-redis.editor role or higher. For more information on assigning roles, see this Identity and Access Management guide.

Note

The following restrictions apply when creating sharded clusters:

  • You can create a single-shard cluster using the CLI, Terraform, or API.
  • You cannot create a cluster with two shards, but you can add a shard to an existing single-shard cluster.
  • You can create a cluster with three or more shards using the management console, CLI, Terraform, or API.

There are no restrictions for non-sharded clusters.

Management console
CLI
Terraform
REST API
gRPC API

To create a Yandex Managed Service for Valkey™ cluster:

  1. In the management console, go to the folder where you want to create your database cluster.

  2. Go to Yandex Managed Service for Valkey™.

  3. Click Create cluster.

  4. Under Basic parameters:

    • Specify a cluster name in the Cluster name field. The cluster name must be unique within the folder.

    • Optionally, add a cluster description.

    • Select the environment where you want to create your cluster (you cannot change the environment once the cluster is created):

      • PRODUCTION: For stable versions of your applications.
      • PRESTABLE: For testing purposes. The prestable environment is similar to the production environment and likewise covered by an SLA, but it is the first to get new features, improvements, and bug fixes. In the prestable environment, you can test new versions for compatibility with your application.
    • Select the DBMS version.

    • Optionally, add labels.

    • Enable cluster sharding, if required.

      Warning

      You cannot disable sharding in a cluster where it is already enabled. You can create a non-sharded cluster and enable sharding later, if required.

    • Enable encrypted TLS connections to your cluster, if required.

      Warning

      You can enable encrypted connections only when creating a new cluster. You cannot disable encryption for an existing cluster.

    • Optionally, enable using FQDNs instead of IP addresses.

      Note

      Some clients do not support this setting and will fail to connect to the cluster hosts. Such clients expect an IP address and will produce errors if you provide an FQDN instead.

    • Select the data persistence mode.

  5. Under Resources:

    • Select a platform in the Platform field.

    • Specify the Type of virtual machine where you want to deploy the hosts.

    • Select Host class.

    • Select the disk type:

      • Either the more flexible network SSD (network-ssd) or non-replicated SSD (network-ssd-nonreplicated) storage
      • Or the faster local SSD (local-ssd) storage

      The selected type determines the increments in which you can change your disk size:

      • Network SSD storage: In increments of 1 GB.
      • Local SSD storage:
        • For Intel Broadwell and Intel Cascade Lake: In increments of 100 GB.
        • For Intel Ice Lake: In increments of 368 GB.
      • Non-replicated SSD storage: In increments of 93 GB.
    • Select the storage size. The available storage size is capped by quotas and limits.

    • In the Increase size field, specify the conditions for the actions below:

      • Storage size increase during the next maintenance window once the fill level exceeds the specified percentage. If you set this condition, configure the maintenance schedule.

      • Storage size increase immediately once the fill level exceeds the specified percentage.

        Warning

        If you set both conditions, make sure the immediate increase threshold is higher than the scheduled one.

    • In the Maximum storage size field, specify the maximum storage size that can be set during automatic scaling.

    Warning

    • You cannot decrease the storage size.
    • During storage resizing, cluster hosts will be stopped and updated one at a time.
    • Optionally, select Encrypted disk to encrypt the disk with a custom KMS key.

      • To create a new key, click Create.

      • To use the key you created earlier, select it in the KMS key field.

      To learn more about disk encryption, see Storage.

  6. Under Network settings, select:

    • Cloud network for cluster deployment.
    • Security groups for the cluster network traffic. You may need to set up security groups to be able to connect to the cluster.
  7. Under Hosts, configure the hosts:

    • To change the settings of a host, click next to the host name.

      • Availability zone: Select the availability zone.

      • Subnet: Specify the subnet in the selected availability zone.

      • Public access: Enables access to the host from the internet if you enabled TLS support for the cluster.

      • Master priority: Host priority for promotion to master if the primary master fails.

      • Shard name: Enables you to change the shard name for the host. This field is only available if you enabled Cluster sharding for the cluster.

    • To add hosts to your cluster, click Add host.

    If you enabled cluster sharding and selected the local-ssd disk type, add at least two hosts per shard.

  8. Under DBMS settings:

    • In the Password field, enter the user password.

      The password must be between 8 and 128 characters long. The password must meet the [a-zA-Z0-9@=+?*.,!&#$^<>_-]* regular expression.

    • Configure the DBMS settings, if required.

  9. Under Service settings, configure the additional cluster settings as follows:

    • Backup start time (UTC): UTC time when you want to start creating a cluster backup (in 24-hour format). If the time is not set, the backup will start at 22:00 UTC.

    • Maintenance window: Maintenance window settings:

      • To enable maintenance at any time, select arbitrary (default).
      • To specify the preferred maintenance start time, select by schedule and specify the desired day of the week and UTC hour. For example, you can choose a time when the cluster is least loaded.

      Maintenance operations are carried out both on enabled and disabled clusters. They may include updating the DBMS, applying patches, and so on.

    • Deletion protection: Manages cluster protection against accidental deletion.

      Even with deletion protection enabled, one can still connect to the cluster manually and delete the data.

    • WebSQL access: Enables you to run SQL queries against cluster databases from the Yandex Cloud management console using Yandex WebSQL.

  10. Click Create cluster.

If you do not have the Yandex Cloud CLI installed yet, install and initialize it.

By default, the CLI uses the folder specified when creating the profile. To change the default folder, use the yc config set folder-id <folder_ID> command. You can also set a different folder for any specific command using the --folder-name or --folder-id parameter.

To create a Yandex Managed Service for Valkey™ cluster:

  1. Check whether the folder has any subnets for the cluster hosts:

    yc vpc subnet list
    

    If your folder has no subnets, create them in VPC.

  2. See the description of the CLI command for creating a cluster:

    yc managed-redis cluster create --help
    
  3. When creating a cluster with the CLI, you cannot explicitly specify the host type and RAM size. Select the appropriate host class instead. To view the available host classes, run the following command:

    yc managed-redis resource-preset list
    
  4. Run this command, providing the cluster settings (our example lists only some flags):

    yc managed-redis cluster create \
      --name <cluster_name> \
      --environment <environment> \
      --redis-version <Valkey™_version> \
      --network-name <network_name> \
      --host zone-id=<availability_zone>,`
            `subnet-id=<subnet_ID>,`
            `assign-public-ip=<public_access>,`
            `replica-priority=<host_priority> \
      --security-group-ids <list_of_security_group_IDs> \
      --enable-tls \
      --persistence-mode <persistence_mode> \
      --resource-preset <host_class> \
      --disk-size <storage_size_in_GB> \
      --disk-size-autoscaling disk-size-limit=<maximum_storage_size_in_GB>,`
                              `planned-usage-threshold=<scheduled_increase_percentage>,`
                              `emergency-usage-threshold=<immediate_increase_percentage> \
      --disk-type-id <network-ssd|network-ssd-nonreplicated|local-ssd> \
      --password=<user_password> \
      --backup-window-start <time> \
      --disk-encryption-key-id <KMS_key_ID> \
      --deletion-protection \
      --announce-hostnames <using_FQDNs_instead_of_IP_addresses>
    

    Where:

    • --environment: Environment, prestable or production.

    • --redis-version: Valkey™ version, 7.2-valkey, 8.0-valkey, 8.1-valkey, or 9.0-valkey.

    • --host: Host settings:

      • zone-id: Availability zone.
      • subnet-id: Subnet ID. Specify it if the selected availability zone has two or more subnets.
      • assign-public-ip: Internet access to the host via a public IP address, true or false.
      • replica-priority: Host priority for promotion to master if the primary master fails.
    • --disk-type-id: Disk type.

    • --websql-access: Enables running SQL queries against cluster databases from the Yandex Cloud management console using Yandex WebSQL. The default value is false.

    • --disk-size-autoscaling: Storage autoscaling setting:

      • planned-usage-threshold: Storage utilization percentage to trigger a storage increase during the next maintenance window.

        Use a value between 0 and 100%. The default setting is 0 (automatic increase disabled).

        If you set this condition, configure the maintenance schedule.

      • emergency-usage-threshold: Storage utilization percentage to trigger an immediate storage increase.

        Use a value between 0 and 100%. The default setting is 0 (automatic increase disabled).

        Warning

        If you specify both thresholds, emergency-usage-threshold must not be less than planned-usage-threshold.

      • disk-size-limit: Maximum storage size after the increase, in GB.

      Warning

      • You cannot decrease the storage size.
      • During storage resizing, cluster hosts will be stopped and updated one at a time.
    • --persistence-mode: Data persistence mode.

      The possible values are:

      • ON: Enable persistence.
      • OFF: Disable persistence.
      • ON_REPLICAS: Enable persistence on replicas only.
    • --backup-window-start: Backup start time in HH:MM:SS format.

    • --deletion-protection: Cluster protection from accidental deletion, true or false.

      Even with deletion protection enabled, one can still connect to the cluster manually and delete the data.

    • --disk-encryption-key-id: Disk encryption with a custom KMS key.

      To learn more about disk encryption, see Storage.

    • --announce-hostnames: Enables or disables using FQDNs instead of IP addresses: true or false.

      Note

      Some clients do not support this setting and will fail to connect to the cluster hosts. Such clients expect an IP address and will produce errors if you provide an FQDN instead.

    You need to specify the subnet-id if the selected availability zone has two or more subnets.

    The password must be between 8 and 128 characters long. The password must meet the [a-zA-Z0-9@=+?*.,!&#$^<>_-]* regular expression.

    If you are creating a sharded cluster with the local-ssd disk type, specify at least two hosts per shard in the command.

    Note

    The default maintenance mode for new clusters is anytime. You can set a specific maintenance period when updating the cluster settings.

With Terraform, you can quickly create a cloud infrastructure in Yandex Cloud and manage it using configuration files. These files store the infrastructure description written in HashiCorp Configuration Language (HCL). If you change the configuration files, Terraform automatically detects which part of your configuration is already deployed, and what should be added or removed.

Terraform is distributed under the Business Source License. The Yandex Cloud provider for Terraform is distributed under the MPL-2.0 license.

For more information about the provider resources, see the relevant documentation on the Terraform website or its mirror.

If you do not have Terraform yet, install it and configure the Yandex Cloud provider.

To create a Yandex Managed Service for Valkey™ cluster:

  1. In the configuration file, describe the resources you want to create:

    • Database cluster: Description of the cluster and its hosts. You can also configure DBMS settings here, if required.

    • Network: Description of the cloud network to host the cluster. If you already have a network in place, you do not need to describe it again.

    • Subnets: Description of the subnets to connect the cluster hosts to. If you already have subnets in place, you do not need to describe them again.

    Here is an example structure of a configuration file for creating a non-sharded cluster with SSL support:

    resource "yandex_mdb_redis_cluster" "<cluster_name>" {
      name                = "<cluster_name>"
      environment         = "<environment>"
      network_id          = "<network_ID>"
      security_group_ids  = [ "<list_of_security_group_IDs>" ]
      tls_enabled         = true
      deletion_protection = <cluster_deletion_protection>
      announce_hostnames  = <using_FQDNs_instead_of_IP_addresses>
      persistence_mode    = "<persistence_mode>"
    
      disk_size_autoscaling {
        planned_usage_threshold   = "<scheduled_increase_percentage>"
        emergency_usage_threshold = "<immediate_increase_percentage>"
        disk_size_limit           = "<maximum_storage_size_in_GiB>"
      }
    
      config {
        password = "<password>"
        version  = "<Valkey™_version>"
      }
    
      resources {
        resource_preset_id = "<host_class>"
        disk_type_id       = "<disk_type>"
        disk_size          = <storage_size_in_GB>
      }
    
      host {
        zone             = "<availability_zone>"
        subnet_id        = "<subnet_ID>"
        assign_public_ip = <public_access>
        replica_priority = <host_priority>
      }
    }
    
    resource "yandex_vpc_network" "<network_name>" { name = "<network_name>" }
    
    resource "yandex_vpc_subnet" "<subnet_name>" {
      name           = "<subnet_name>"
      zone           = "<availability_zone>"
      network_id     = "<network_ID>"
      v4_cidr_blocks = ["<range>"]
    }
    

    Where:

    • environment: Environment, PRESTABLE or PRODUCTION.

    • deletion_protection: Cluster protection against accidental deletion, true or false.

      Even with deletion protection enabled, one can still connect to the cluster manually and delete the data.

    • disk_size_autoscaling: Storage autoscaling setting:

      • planned_usage_threshold: Storage utilization percentage to trigger a storage increase during the next maintenance window.

        Use a value between 0 and 100%. The default setting is 0 (automatic increase disabled).

        If you set this condition, configure the maintenance schedule under maintenance_window.

      • emergency_usage_threshold: Storage utilization percentage to trigger an immediate storage increase.

        Use a value between 0 and 100%. The default setting is 0 (automatic increase disabled).

        Warning

        If you specify both thresholds, emergency_usage_threshold must not be less than planned_usage_threshold.

      • disk_size_limit: Maximum storage size after the increase, in gibibytes.

      Warning

      • You cannot decrease the storage size.
      • During storage resizing, cluster hosts will be stopped and updated one at a time.
    • announce_hostnames: Enables or disables using FQDNs instead of IP addresses: true or false.

      Note

      Some clients do not support this setting and will fail to connect to the cluster hosts. Such clients expect an IP address and will produce errors if you provide an FQDN instead.

    • persistence_mode: Data persistence mode.

      The possible values are:

      • ON: Enable persistence.
      • OFF: Disable persistence.
      • ON_REPLICAS: Enable persistence on replicas only.
    • version: Valkey™ version, 7.2-valkey, 8.0-valkey, 8.1-valkey, or 9.0-valkey.

    • host: Host settings:

      • zone_id: Availability zone.
      • subnet_id: ID of the subnet in the selected availability zone.
      • assign_public_ip: Public access to the host, true or false.
      • replica_priority: Host priority for promotion to master if the primary master fails.

    The password must be between 8 and 128 characters long. The password must meet the [a-zA-Z0-9@=+?*.,!&#$^<>_-]* regular expression.

    If you are creating a sharded cluster with the local-ssd disk type, specify at least two hosts per shard in the configuration file.

    To set up the maintenance window (for example, for disabled clusters), add the maintenance_window section to the cluster description:

    resource "yandex_mdb_redis_cluster" "<cluster_name>" {
      ...
      maintenance_window {
        type = <maintenance_type>
        day  = <day_of_week>
        hour = <hour>
      }
      ...
    }
    

    Where:

    • type: Maintenance type. The possible values include:
      • ANYTIME: Anytime
      • WEEKLY: On a schedule
    • day: Day of week for the WEEKLY type, i.e., MON, TUE, WED, THU, FRI, SAT, or SUN.
    • hour: UTC hour for the WEEKLY type, from 1 to 24.

    To encrypt the disk with a custom KMS key, add the disk_encryption_key_id argument:

    resource "yandex_mdb_redis_cluster" "<cluster_name>" {
      ...
      disk_encryption_key_id = <KMS_key_ID>
      ...
    }
    

    To learn more about disk encryption, see Storage.

    For more information about the resources you can create with Terraform, see this provider guide.

  2. Make sure the settings are correct.

    1. In the command line, navigate to the directory that contains the current Terraform configuration files defining the infrastructure.

    2. Run this command:

      terraform validate
      

      Terraform will show any errors found in your configuration files.

  3. Create the cluster.

    1. Run this command to view the planned changes:

      terraform plan
      

      If you described the configuration correctly, the terminal will display a list of the resources to update and their parameters. This is a verification step that does not apply changes to your resources.

    2. If everything looks correct, apply the changes:

      1. Run this command:

        terraform apply
        
      2. Confirm updating the resources.

      3. Wait for the operation to complete.

    This will create all the resources you need in the specified folder, and the terminal will display the FQDNs of the cluster hosts. You can check the new resources and their configuration using the management console.

    Time limits

    A Terraform provider sets the timeout for Yandex Managed Service for Valkey™ cluster operations:

    • Creating a cluster, including by restoring one from a backup: 15 minutes.
    • Editing a cluster: 60 minutes.
    • Deleting a cluster: 15 minutes.

    Operations exceeding the set timeout are interrupted.

    How do I change these limits?

    Add the timeouts block to the cluster description, for example:

    resource "yandex_mdb_redis_cluster" "<cluster_name>" {
      ...
      timeouts {
        create = "1h30m" # 1 hour 30 minutes
        update = "2h"    # 2 hours
        delete = "30m"   # 30 minutes
      }
    }
    
  1. Get an IAM token for API authentication and put it into an environment variable:

    export IAM_TOKEN="<IAM_token>"
    
  2. Create a file named body.json and paste the following code into it:

    {
      "folderId": "<folder_ID>",
      "name": "<cluster_name>",
      "environment": "<environment>",
      "configSpec": {
        "version": "<Valkey™_version>",
        "resources": {
          "resourcePresetId": "<host_class>",
          "diskSize": "<storage_size_in_bytes>",
          "diskTypeId": "<disk_type>"
        },
        "diskSizeAutoscaling": {
          "plannedUsageThreshold": "<scheduled_increase_percentage>",
          "emergencyUsageThreshold": "<immediate_increase_percentage>",
          "diskSizeLimit": "<maximum_storage_size_in_bytes>"
        },
        "access": {
          "webSql": <access_from_WebSQL>
        },
        "redis": {
          "password": "<user_password>"
        }
      },
      "hostSpecs": [
        {
          "zoneId": "<availability_zone>",
          "subnetId": "<subnet_ID>",
          "shardName": "<shard_name>",
          "replicaPriority": "<host_priority>",
          "assignPublicIp": <public_access_to_cluster_host>
        },
        { <similar_settings_for_host_2> },
        { ... },
        { <similar_settings_for_host_N> }
      ],
      "networkId": "<network_ID>",
      "sharded": <cluster_sharding>,
      "securityGroupIds": [
        "<security_group_1_ID>",
        "<security_group_2_ID>",
        ...
        "<security_group_N_ID>"
      ],
      "tlsEnabled": <encrypted_TLS_connection_support>,
      "deletionProtection": <cluster_deletion_protection>,
      "announceHostnames": <using_FQDNs_instead_of_IP_addresses>,
      "persistenceMode": "<persistence_mode>"
    }
    

    Where:

    • folderId: Folder ID. You can get it with the list of folders in the cloud.

    • name: Cluster name.

    • environment: Environment, PRESTABLE or PRODUCTION.

    • configSpec: Cluster settings:

      • version: Valkey™ version, 7.2-valkey, 8.0-valkey, 8.1-valkey, or 9.0-valkey.

      • resources: Cluster resources:

        • resourcePresetId: Host class.
        • diskSize: Disk size, in bytes.
        • diskTypeId: Disk type.
      • diskSizeAutoscaling: Automatic storage size increase settings:

        • plannedUsageThreshold: Storage utilization percentage to trigger a storage increase during the next maintenance window.

          Use a value between 0 and 100%. The default setting is 0 (automatic increase disabled).

          If you set this condition, configure the maintenance schedule with the help of maintenanceWindow.

        • emergencyUsageThreshold: Storage utilization percentage to trigger an immediate storage increase.

          Use a value between 0 and 100%. The default setting is 0 (automatic increase disabled).

          Warning

          If you specify both thresholds, emergencyUsageThreshold must not be less than plannedUsageThreshold.

        • diskSizeLimit: Maximum storage size after the increase, in bytes.

        Warning

        • You cannot decrease the storage size.
        • During storage resizing, cluster hosts will be stopped and updated one at a time.
      • access.webSql: Access to cluster databases from the Yandex Cloud management console through Yandex WebSQL, true or false.

      • redis.password: User password.

    • hostSpecs: Host settings:

      • zoneId: Availability zone.
      • subnetId: Subnet ID. Specify it if the selected availability zone has two or more subnets.
      • shardName: Shard name for the host. This setting only applies when pathType is set to Exact.
      • replicaPriority: Host priority for promotion to master if the primary master fails.
      • assignPublicIp: Internet access to the host via a public IP address, true or false. You can enable public access only if tlsEnabled is set to true.
    • networkId: ID of the network where the cluster will be deployed.

    • sharded: Cluster sharding, true or false.

      Warning

      You cannot disable sharding in a cluster where it is already enabled. You can create a non-sharded cluster and enable sharding later, if required.

      If you are creating a sharded cluster with the local-ssd disk type, specify at least two hosts per shard, adding the appropriate number of hostSpecs sections.

    • securityGroupIds: Security group IDs.

    • tlsEnabled: Support for encrypted TLS connections to the cluster, true or false.

      Warning

      You can enable encrypted connections only when creating a new cluster. You cannot disable encryption for an existing cluster.

    • deletionProtection: Cluster protection against accidental deletion, true or false.

      Even with deletion protection enabled, one can still connect to the cluster manually and delete the data.

    • announceHostnames: Using FQDNs instead of IP addresses, true or false.

      Note

      Some clients do not support this setting and will fail to connect to the cluster hosts. Such clients expect an IP address and will produce errors if you provide an FQDN instead.

    • persistenceMode: Data persistence mode.

      The possible values are:

      • ON: Enable persistence.
      • OFF: Disable persistence.
      • ON_REPLICAS: Enable persistence on replicas only.
  3. Call the Cluster.Create method, e.g., via the following cURL request:

    curl \
        --request POST \
        --header "Authorization: Bearer $IAM_TOKEN" \
        --header "Content-Type: application/json" \
        --url 'https://mdb.api.cloud.yandex.net/managed-redis/v1/clusters' \
        --data "@body.json"
    
  4. View the server response to make sure your request was successful.

  1. Get an IAM token for API authentication and put it into an environment variable:

    export IAM_TOKEN="<IAM_token>"
    
  2. Clone the cloudapi repository:

    cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
    

    Below, we assume the repository contents are stored in the ~/cloudapi/ directory.

  3. Create a file named body.json and paste the following code into it:

    {
      "folder_id": "<folder_ID>",
      "name": "<cluster_name>",
      "environment": "<environment>",
      "config_spec": {
        "version": "<Valkey™_version>",
        "resources": {
          "resource_preset_id": "<host_class>",
          "disk_size": "<storage_size_in_bytes>",
          "disk_type_id": "<disk_type>"
        },
        "disk_size_autoscaling": {
          "planned_usage_threshold": "<scheduled_increase_percentage>",
          "emergency_usage_threshold": "<immediate_increase_percentage>",
          "disk_size_limit": "<maximum_storage_size_in_bytes>"
        },
        "access": {
          "web_sql": <access_from_WebSQL>
        },
        "redis": {
          "password": "<user_password>"
        }
      },
      "host_specs": [
        {
          "zone_id": "<availability_zone>",
          "subnet_id": "<subnet_ID>",
          "shard_name": "<shard_name>",
          "replica_priority": "<host_priority>",
          "assign_public_ip": <public_access_to_cluster_host>
        },
        { <similar_settings_for_host_2> },
        { ... },
        { <similar_settings_for_host_N> }
      ],
      "network_id": "<network_ID>",
      "sharded": <cluster_sharding>,
      "security_group_ids": [
        "<security_group_1_ID>",
        "<security_group_2_ID>",
        ...
        "<security_group_N_ID>"
      ],
      "tls_enabled": <encrypted_TLS_connection_support>,
      "deletion_protection": <cluster_deletion_protection>,
      "announce_hostnames": <using_FQDNs_instead_of_IP_addresses>,
      "persistence_mode": "<persistence_mode>"
    }
    

    Where:

    • folder_id: Folder ID. You can request it with the list of folders in the cloud.

    • name: Cluster name.

    • environment: Environment, PRESTABLE or PRODUCTION.

    • config_spec: Cluster settings:

      • version: Valkey™ version, 7.2-valkey, 8.0-valkey, 8.1-valkey, or 9.0-valkey.

      • resources: Cluster resources:

        • resource_preset_id: Host class.
        • disk_size: Disk size, in bytes.
        • disk_type_id: Disk type.
      • disk_size_autoscaling: Automatic storage size increase settings:

        • planned_usage_threshold: Storage utilization percentage to trigger a storage increase during the next maintenance window.

          Use a value between 0 and 100%. The default setting is 0 (automatic increase disabled).

          If you set this condition, configure the maintenance schedule with the help of maintenance_window.

        • emergency_usage_threshold: Storage utilization percentage to trigger an immediate storage increase.

          Use a value between 0 and 100%. The default setting is 0 (automatic increase disabled).

          Warning

          If you specify both thresholds, emergency_usage_threshold must not be less than planned_usage_threshold.

        • disk_size_limit: Maximum storage size after the increase, in bytes.

        Warning

        • You cannot decrease the storage size.
        • During storage resizing, cluster hosts will be stopped and updated one at a time.
      • access.web_sql: Access to cluster databases from the Yandex Cloud management console through Yandex WebSQL, true or false.

      • redis.password: User password.

    • host_specs: Host settings:

      • zone_id: Availability zone.
      • subnet_id: Subnet ID. Specify it if the selected availability zone has two or more subnets.
      • shard_name: Shard name for the host. Only used if the sharded parameter is set to true.
      • replica_priority: Host priority for promotion to master if the primary master fails.
      • assign_public_ip: Internet access to the host via a public IP address, true or false. You can enable public access only if tls_enabled is set to true.
    • network_id: ID of the network where the cluster will be deployed.

    • sharded: Cluster sharding, true or false.

      Warning

      You cannot disable sharding in a cluster where it is already enabled. You can create a non-sharded cluster and enable sharding later, if required.

      If you are creating a sharded cluster with the local-ssd disk type, specify at least two hosts per shard, adding the appropriate number of host_specs sections.

    • security_group_ids: Security group IDs.

    • tls_enabled: Support for encrypted TLS connections to the cluster, true or false.

      Warning

      You can enable encrypted connections only when creating a new cluster. You cannot disable encryption for an existing cluster.

    • deletion_protection: Cluster protection against accidental deletion, true or false.

      Even with deletion protection enabled, one can still connect to the cluster manually and delete the data.

    • announce_hostnames: Using FQDNs instead of IP addresses, true or false.

      Note

      Some clients do not support this setting and will fail to connect to the cluster hosts. Such clients expect an IP address and will produce errors if you provide an FQDN instead.

    • persistence_mode: Data persistence mode.

      The possible values are:

      • ON: Enable persistence.
      • OFF: Disable persistence.
      • ON_REPLICAS: Enable persistence on replicas only.
  4. Call the ClusterService.Create method, e.g., via the following gRPCurl request:

    grpcurl \
        -format json \
        -import-path ~/cloudapi/ \
        -import-path ~/cloudapi/third_party/googleapis/ \
        -proto ~/cloudapi/yandex/cloud/mdb/redis/v1/cluster_service.proto \
        -rpc-header "Authorization: Bearer $IAM_TOKEN" \
        -d @ \
        mdb.api.cloud.yandex.net:443 \
        yandex.cloud.mdb.redis.v1.ClusterService.Create \
        < body.json
    
  5. Check the server response to make sure your request was successful.

Warning

If you specified security group IDs when creating a cluster, you may need to additionally configure security groups to connect to the cluster.

Creating a cluster copyCreating a cluster copy

You can create a Valkey™ cluster with the settings of another one created earlier. Do it by importing the original Valkey™ cluster configuration to Terraform. This way, you can either create an identical copy or use the imported configuration as the baseline and modify it as needed. Importing a configuration is a good idea if the original Valkey™ cluster has lots of settings and you want to create a similar one.

To create a Valkey™ cluster copy:

Terraform
  1. If you do not have Terraform yet, install it.

  2. Get the authentication credentials. You can add them to environment variables or specify them later in the provider configuration file.

  3. Configure and initialize a provider. There is no need to create a provider configuration file manually, you can download it.

  4. Place the configuration file in a separate working directory and specify the parameter values. If you did not add the authentication credentials to environment variables, specify them in the configuration file.

  5. In the same working directory, place a .tf file with the following contents:

    resource "yandex_mdb_redis_cluster" "old" { }
    
  6. Save the ID of the original Valkey™ cluster to an environment variable:

    export REDIS_CLUSTER_ID=<cluster_ID>
    

    You can request the ID with the list of clusters in the folder.

  7. Import the original Valkey™ cluster settings to the Terraform configuration:

    terraform import yandex_mdb_redis_cluster.old ${REDIS_CLUSTER_ID}
    
  8. Get the imported configuration:

    terraform show
    
  9. Copy it from the terminal and paste it into the .tf file.

  10. Place the file in the new imported-cluster directory.

  11. Edit the copied configuration so that you can create a new cluster from it:

    • Specify the new cluster name in the resource name and the name parameter.
    • Delete created_at, health, id, and status.
    • Add the password parameter to the config section.
    • If you have notify_keyspace_events = "\"\"" in the config section, delete this parameter.
    • If sharded = false, delete the shard_name parameters from the host sections.
    • If you have type = "ANYTIME" in the maintenance_window section, delete the hour parameter.
    • Optionally, make further changes if you need a customized configuration.
  12. Get the authentication credentials in the imported-cluster directory.

  13. In the same directory, configure and initialize the provider. There is no need to create a provider configuration file manually, as you can download it.

  14. Place the configuration file in the imported-cluster directory and specify the parameter values. If you did not add the authentication credentials to environment variables, specify them in the configuration file.

  15. Make sure the Terraform configuration files are correct:

    terraform validate
    

    Terraform will show any errors found in your configuration files.

  16. Create the required infrastructure:

    1. Run this command to view the planned changes:

      terraform plan
      

      If you described the configuration correctly, the terminal will display a list of the resources to update and their parameters. This is a verification step that does not apply changes to your resources.

    2. If everything looks correct, apply the changes:

      1. Run this command:

        terraform apply
        
      2. Confirm updating the resources.

      3. Wait for the operation to complete.

    All the required resources will be created in the specified folder. You can check resource availability and their settings in the management console.

Time limits

A Terraform provider sets the timeout for Yandex Managed Service for Valkey™ cluster operations:

  • Creating a cluster, including by restoring one from a backup: 15 minutes.
  • Editing a cluster: 60 minutes.
  • Deleting a cluster: 15 minutes.

Operations exceeding the set timeout are interrupted.

How do I change these limits?

Add the timeouts block to the cluster description, for example:

resource "yandex_mdb_redis_cluster" "<cluster_name>" {
  ...
  timeouts {
    create = "1h30m" # 1 hour 30 minutes
    update = "2h"    # 2 hours
    delete = "30m"   # 30 minutes
  }
}

ExamplesExamples

Creating a single-host clusterCreating a single-host cluster

CLI
Terraform

To create a single-host cluster, provide one --host argument.

Create a Yandex Managed Service for Valkey™ cluster with the following test specifications:

  • Name: myredis.
  • Version: `9.0-valkey``.
  • Environment: production.
  • Network: default.
  • A single hm2.nano host in the b0rcctk2rvtr******** subnet, ru-central1-a availability zone and security group with the enp6saqnq4ie244g67sb ID, with public access and a host priority of 50.
  • SSL support: Enabled.
  • Network SSD storage (network-ssd): 16 GB.
  • Password: user1user1.
  • Deletion protection: Enabled.

Run this command:

yc managed-redis cluster create \
  --name myredis \
  --redis-version 9.0-valkey` \
  --environment production \
  --network-name default \
  --resource-preset hm2.nano \
  --host zone-id=ru-central1-a,subnet-id=b0rcctk2rvtr********,assign-public-ip=true,replica-priority=50 \
  --security-group-ids enp6saqnq4ie244g67sb \
  --enable-tls \
  --disk-type-id network-ssd \
  --disk-size 16 \
  --password=user1user1 \
  --deletion-protection

Create a Yandex Managed Service for Valkey™ cluster and its network with the following test specifications:

  • Name: myredis.
  • Version: `9.0-valkey``.
  • Environment: PRODUCTION.
  • Cloud ID: b1gq90dgh25bebiu75o.
  • Folder ID: b1gia87mbaomkfvsleds.
  • Network: mynet (new).
  • A single hm2.nano class host in the new subnet called mysubnet, ru-central1-a availability zone, with public access and a host priority of 50. mysubnet CIDR range: 10.5.0.0/24.
  • Security group: redis-sg (new), allowing connections on port 6380 from any addresses in mysubnet.
  • SSL support: Enabled.
  • Network SSD storage (network-ssd): 16 GB.
  • Password: user1user1.
  • Deletion protection: Enabled.

The configuration file for this cluster looks like this:

resource "yandex_mdb_redis_cluster" "myredis" {
  name                = "myredis"
  environment         = "PRODUCTION"
  network_id          = yandex_vpc_network.mynet.id
  security_group_ids  = [ yandex_vpc_security_group.redis-sg.id ]
  tls_enabled         = true
  deletion_protection = true

  config {
    password = "user1user1"
    version  = "9.0-valkey`"
  }

  resources {
    resource_preset_id = "hm2.nano"
    disk_type_id       = "network-ssd"
    disk_size          = 16
  }

  host {
    zone             = "ru-central1-a"
    subnet_id        = yandex_vpc_subnet.mysubnet.id
    assign_public_ip = true
    replica_priority = 50
  }
}

resource "yandex_vpc_network" "mynet" { name = "mynet" }

resource "yandex_vpc_security_group" "redis-sg" {
  name       = "redis-sg"
  network_id = yandex_vpc_network.mynet.id

  ingress {
    description    = "Valkey™"
    port           = 6380
    protocol       = "TCP"
    v4_cidr_blocks = ["10.5.0.0/24"]
  }
}

resource "yandex_vpc_subnet" "mysubnet" {
  name           = "mysubnet"
  zone           = "ru-central1-a"
  network_id     = yandex_vpc_network.mynet.id
  v4_cidr_blocks = ["10.5.0.0/24"]
}

Creating a sharded cluster with a single shardCreating a sharded cluster with a single shard

CLI
Terraform

Create a sharded Yandex Managed Service for Valkey™ cluster with the following test specifications:

  • Name: myredis.
  • Version: `9.0-valkey``.
  • Environment: production.
  • Sharding: Enabled.
  • SSL support: Enabled.
  • Deletion protection: Enabled.
  • Network: default.
  • Security group ID: enp6saqnq4ie244g67sb.
  • Host class: hm2.nano.
  • A single host in the shard called shard1, in the b0rcctk2rvtr******** subnet, ru-central1-a availability zone, with public access and a host priority of 50.
  • Network SSD storage (network-ssd): 16 GB.
  • Password: user1user1.

Run this command:

yc managed-redis cluster create \
  --name myredis \
  --redis-version 9.0-valkey` \
  --environment production \
  --sharded \
  --enable-tls \
  --deletion-protection \
  --network-name default \
  --security-group-ids enp6saqnq4ie244g67sb \
  --resource-preset hm2.nano \
  --host shard-name=shard1,subnet-id=b0rcctk2rvtr********,zone-id=ru-central1-a,assign-public-ip=true,replica-priority=50 \
  --disk-type-id network-ssd \
  --disk-size 16 \
  --password user1user1

Create a sharded Yandex Managed Service for Valkey™ cluster and a network for it with the following test specifications:

  • Name: myredis.
  • Version: `9.0-valkey``.
  • Environment: PRODUCTION.
  • Sharding: Enabled.
  • SSL support: Enabled.
  • Deletion protection: Enabled.
  • Network: mynet (new) with a single subnet: mysubnet. CIDR range for mysubnet: 10.5.0.0/24.
  • Security group: redis-sg (new), allowing connections on port 6380 from any addresses in mysubnet.
  • Host class: hm2.nano.
  • A single host in the shard called shard1, in the mysubnet subnet, ru-central1-a availability zone, with public access and a host priority of 50.
  • Network SSD storage (network-ssd): 16 GB.
  • Password: user1user1.

The configuration file for this cluster looks like this:

resource "yandex_mdb_redis_cluster" "myredis" {
  name                = "myredis"
  environment         = "PRODUCTION"
  sharded             = true
  tls_enabled         = true
  deletion_protection = true
  network_id          = yandex_vpc_network.mynet.id
  security_group_ids  = [yandex_vpc_security_group.redis-sg.id]

  config {
    version  = "9.0-valkey`"
    password = "user1user1"
  }

  resources {
    resource_preset_id = "hm2.nano"
    disk_type_id       = "network-ssd"
    disk_size          = 16
  }

  host {
    shard_name = "shard1"
    subnet_id  = yandex_vpc_subnet.mysubnet.id
    zone       = "ru-central1-a"
    assign_public_ip = true
    replica_priority = 50
  }
}

resource "yandex_vpc_network" "mynet" { name = "mynet" }

resource "yandex_vpc_subnet" "mysubnet" {
  name           = "mysubnet"
  zone           = "ru-central1-a"
  network_id     = yandex_vpc_network.mynet.id
  v4_cidr_blocks = ["10.5.0.0/24"]
}

resource "yandex_vpc_security_group" "redis-sg" {
  name       = "redis-sg"
  network_id = yandex_vpc_network.mynet.id

  ingress {
    description    = "Valkey™"
    port           = 6380
    protocol       = "TCP"
    v4_cidr_blocks = ["10.5.0.0/24"]
  }
}

Creating a sharded cluster with three shardsCreating a sharded cluster with three shards

Terraform

Create a sharded Yandex Managed Service for Valkey™ cluster with the following test specifications:

  • Name: myredis.
  • Version: `9.0-valkey``.
  • Environment: PRODUCTION.
  • Cloud ID: b1gq90dgh25bebiu75o.
  • Folder ID: b1gia87mbaomkfvsleds.
  • Network: mynet (new).
  • Three subnets in the mynet network, one in each availability zone:
    • subnet-a with the 10.1.0.0/24 range
    • subnet-b with the 10.2.0.0/24 range
    • subnet-d with the 10.3.0.0/24 range
  • Three hm2.nano class hosts, one in each subnet.
  • New redis-sg security group allowing connections via ports 6379 and 26379 (Valkey™ Sentinel) from any subnet addresses.
  • Network SSD storage (network-ssd): 16 GB.
  • Password: user1user1.
  • Deletion protection: Enabled.

The configuration file for this cluster looks like this:

resource "yandex_mdb_redis_cluster" "myredis" {
  name                = "myredis"
  environment         = "PRODUCTION"
  network_id          = yandex_vpc_network.mynet.id
  security_group_ids  = [yandex_vpc_security_group.redis-sg.id]
  sharded             = true
  deletion_protection = true

  config {
    password = "user1user1"
    version  = "9.0-valkey`"
  }

  resources {
    resource_preset_id = "hm2.nano"
    disk_type_id       = "network-ssd"
    disk_size          = 16
  }

  host {
    zone       = "ru-central1-a"
    subnet_id  = yandex_vpc_subnet.subnet-a.id
    shard_name = "shard1"
  }

  host {
    zone       = "ru-central1-b"
    subnet_id  = yandex_vpc_subnet.subnet-b.id
    shard_name = "shard2"
  }

  host {
    zone       = "ru-central1-d"
    subnet_id  = yandex_vpc_subnet.subnet-d.id
    shard_name = "shard3"
  }
}

resource "yandex_vpc_network" "mynet" { name = "mynet" }

resource "yandex_vpc_subnet" "subnet-a" {
  name           = "subnet-a"
  zone           = "ru-central1-a"
  network_id     = yandex_vpc_network.mynet.id
  v4_cidr_blocks = ["10.1.0.0/24"]
}

resource "yandex_vpc_subnet" "subnet-b" {
  name           = "subnet-b"
  zone           = "ru-central1-b"
  network_id     = yandex_vpc_network.mynet.id
  v4_cidr_blocks = ["10.2.0.0/24"]
}

resource "yandex_vpc_subnet" "subnet-d" {
  name           = "subnet-d"
  zone           = "ru-central1-d"
  network_id     = yandex_vpc_network.mynet.id
  v4_cidr_blocks = ["10.3.0.0/24"]
}

resource "yandex_vpc_security_group" "redis-sg" {
  name       = "redis-sg"
  network_id = yandex_vpc_network.mynet.id

  ingress {
    description    = "Valkey™"
    port           = 6379
    protocol       = "TCP"
    v4_cidr_blocks = [
      "10.1.0.0/24",
      "10.2.0.0/24",
      "10.3.0.0/24"
    ]
  }

  ingress {
    description    = "Valkey™ Sentinel"
    port           = 26379
    protocol       = "TCP"
    v4_cidr_blocks = [
      "10.1.0.0/24",
      "10.2.0.0/24",
      "10.3.0.0/24"
    ]
  }
}

Was the article helpful?

Previous
Information about existing clusters
Next
Updating cluster settings
© 2025 Direct Cursus Technology L.L.C.