1. Packages
  2. Packages
  3. Volcenginecc Provider
  4. API Docs
  5. redis
  6. Instance
Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

volcenginecc.redis.Instance

volcenginecc logo
Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

    The basic unit of Redis cache database is the instance. An instance is an independent, virtualized database runtime environment, consisting of multiple data nodes and proxy nodes. The Redis engine runs on the data nodes.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as volcenginecc from "@volcengine/pulumi-volcenginecc";

const redisInstanceDemo = new volcenginecc.redis.Instance("RedisInstanceDemo", {
    instanceName: "RedisInstance",
    shardedCluster: 1,
    password: "********",
    nodeNumber: 2,
    shardCapacity: 512,
    shardNumber: 2,
    engineVersion: "5.0",
    vpcId: "vpc-13f8xxxx",
    subnetId: "vpc_subnet-xxxx",
    deletionProtection: "disabled",
    chargeType: "PostPaid",
    port: 6381,
    projectName: "default",
    tags: [{
        key: "env",
        value: "test",
    }],
    multiAz: "enabled",
    configureNodes: [
        {
            az: "cn-beijing-a",
        },
        {
            az: "cn-beijing-b",
        },
    ],
});

    import pulumi
import pulumi_volcenginecc as volcenginecc

redis_instance_demo = volcenginecc.redis.Instance("RedisInstanceDemo",
    instance_name="RedisInstance",
    sharded_cluster=1,
    password="********",
    node_number=2,
    shard_capacity=512,
    shard_number=2,
    engine_version="5.0",
    vpc_id="vpc-13f8xxxx",
    subnet_id="vpc_subnet-xxxx",
    deletion_protection="disabled",
    charge_type="PostPaid",
    port=6381,
    project_name="default",
    tags=[{
        "key": "env",
        "value": "test",
    }],
    multi_az="enabled",
    configure_nodes=[
        {
            "az": "cn-beijing-a",
        },
        {
            "az": "cn-beijing-b",
        },
    ])

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/redis"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := redis.NewInstance(ctx, "RedisInstanceDemo", &redis.InstanceArgs{
			InstanceName:       pulumi.String("RedisInstance"),
			ShardedCluster:     pulumi.Int(1),
			Password:           pulumi.String("********"),
			NodeNumber:         pulumi.Int(2),
			ShardCapacity:      pulumi.Int(512),
			ShardNumber:        pulumi.Int(2),
			EngineVersion:      pulumi.String("5.0"),
			VpcId:              pulumi.String("vpc-13f8xxxx"),
			SubnetId:           pulumi.String("vpc_subnet-xxxx"),
			DeletionProtection: pulumi.String("disabled"),
			ChargeType:         pulumi.String("PostPaid"),
			Port:               pulumi.Int(6381),
			ProjectName:        pulumi.String("default"),
			Tags: redis.InstanceTagArray{
				&redis.InstanceTagArgs{
					Key:   pulumi.String("env"),
					Value: pulumi.String("test"),
				},
			},
			MultiAz: pulumi.String("enabled"),
			ConfigureNodes: redis.InstanceConfigureNodeArray{
				&redis.InstanceConfigureNodeArgs{
					Az: pulumi.String("cn-beijing-a"),
				},
				&redis.InstanceConfigureNodeArgs{
					Az: pulumi.String("cn-beijing-b"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Volcenginecc = Volcengine.Pulumi.Volcenginecc;

return await Deployment.RunAsync(() => 
{
    var redisInstanceDemo = new Volcenginecc.Redis.Instance("RedisInstanceDemo", new()
    {
        InstanceName = "RedisInstance",
        ShardedCluster = 1,
        Password = "********",
        NodeNumber = 2,
        ShardCapacity = 512,
        ShardNumber = 2,
        EngineVersion = "5.0",
        VpcId = "vpc-13f8xxxx",
        SubnetId = "vpc_subnet-xxxx",
        DeletionProtection = "disabled",
        ChargeType = "PostPaid",
        Port = 6381,
        ProjectName = "default",
        Tags = new[]
        {
            new Volcenginecc.Redis.Inputs.InstanceTagArgs
            {
                Key = "env",
                Value = "test",
            },
        },
        MultiAz = "enabled",
        ConfigureNodes = new[]
        {
            new Volcenginecc.Redis.Inputs.InstanceConfigureNodeArgs
            {
                Az = "cn-beijing-a",
            },
            new Volcenginecc.Redis.Inputs.InstanceConfigureNodeArgs
            {
                Az = "cn-beijing-b",
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.volcengine.volcenginecc.redis.Instance;
import com.volcengine.volcenginecc.redis.InstanceArgs;
import com.pulumi.volcenginecc.redis.inputs.InstanceTagArgs;
import com.pulumi.volcenginecc.redis.inputs.InstanceConfigureNodeArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var redisInstanceDemo = new Instance("redisInstanceDemo", InstanceArgs.builder()
            .instanceName("RedisInstance")
            .shardedCluster(1)
            .password("********")
            .nodeNumber(2)
            .shardCapacity(512)
            .shardNumber(2)
            .engineVersion("5.0")
            .vpcId("vpc-13f8xxxx")
            .subnetId("vpc_subnet-xxxx")
            .deletionProtection("disabled")
            .chargeType("PostPaid")
            .port(6381)
            .projectName("default")
            .tags(InstanceTagArgs.builder()
                .key("env")
                .value("test")
                .build())
            .multiAz("enabled")
            .configureNodes(            
                InstanceConfigureNodeArgs.builder()
                    .az("cn-beijing-a")
                    .build(),
                InstanceConfigureNodeArgs.builder()
                    .az("cn-beijing-b")
                    .build())
            .build());

    }
}

    resources:
  redisInstanceDemo:
    type: volcenginecc:redis:Instance
    name: RedisInstanceDemo
    properties:
      instanceName: RedisInstance
      shardedCluster: 1
      password: '********'
      nodeNumber: 2
      shardCapacity: 512
      shardNumber: 2
      engineVersion: '5.0'
      vpcId: vpc-13f8xxxx
      subnetId: vpc_subnet-xxxx
      deletionProtection: disabled
      chargeType: PostPaid
      port: 6381
      projectName: default
      tags:
        - key: env
          value: test
      multiAz: enabled
      configureNodes:
        - az: cn-beijing-a
        - az: cn-beijing-b

    Create Instance Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Instance(name: string, args: InstanceArgs, opts?: CustomResourceOptions);
    @overload
def Instance(resource_name: str,
             args: InstanceArgs,
             opts: Optional[ResourceOptions] = None)

@overload
def Instance(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             multi_az: Optional[str] = None,
             vpc_id: Optional[str] = None,
             subnet_id: Optional[str] = None,
             sharded_cluster: Optional[int] = None,
             configure_nodes: Optional[Sequence[InstanceConfigureNodeArgs]] = None,
             shard_capacity: Optional[int] = None,
             node_number: Optional[int] = None,
             engine_version: Optional[str] = None,
             deletion_protection: Optional[str] = None,
             project_name: Optional[str] = None,
             no_auth_mode: Optional[str] = None,
             allow_list_ids: Optional[Sequence[str]] = None,
             parameter_group_id: Optional[str] = None,
             password: Optional[str] = None,
             port: Optional[int] = None,
             instance_name: Optional[str] = None,
             purchase_months: Optional[int] = None,
             reserve_additional_bandwidth: Optional[bool] = None,
             create_backup: Optional[bool] = None,
             shard_number: Optional[int] = None,
             charge_type: Optional[str] = None,
             backup_point_name: Optional[str] = None,
             tags: Optional[Sequence[InstanceTagArgs]] = None,
             auto_renew: Optional[bool] = None)
    func NewInstance(ctx *Context, name string, args InstanceArgs, opts ...ResourceOption) (*Instance, error)
    public Instance(string name, InstanceArgs args, CustomResourceOptions? opts = null)
    public Instance(String name, InstanceArgs args)
public Instance(String name, InstanceArgs args, CustomResourceOptions options)

    type: volcenginecc:redis:Instance
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args InstanceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args InstanceArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args InstanceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args InstanceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args InstanceArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Instance Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Instance resource accepts the following input properties:

    ConfigureNodes List<Volcengine.InstanceConfigureNode>
    EngineVersion string
    Database version number.
    MultiAz string
    Set the deployment scheme for the instance's availability zone.
    NodeNumber int
    Number of nodes in each shard. Value range: 1–6. By default, each account can create up to 4 nodes of 256 MiB specification per region. To increase the quota limit to 10, see Account Quotas. A value of 1 creates a single-node instance; a value greater than 1 creates a primary-secondary instance. For details on the differences between these two types of instances, see Feature Differences.
    ShardCapacity int
    Memory capacity of each shard in the instance. Unit: MiB.
    ShardedCluster int
    Whether to enable sharded cluster. Value options: 0: Disabled. 1: Enabled.
    SubnetId string
    Set the subnet ID for the instance. Subnets have availability zone attributes; you must select a subnet in the target private network that belongs to the same availability zone as the instance. A subnet is an IP address block within a private network. All cloud resources in the private network must be deployed in a subnet. The subnet assigns private IP addresses to cloud resources. You can call the CreateSubnet API to create a subnet. You can call the DescribeSubnets API to query the list of all subnets in a specified availability zone, including subnet IDs.
    VpcId string
    Set the private network ID for the instance. It is recommended that the Redis instance and the ECS instance you want to connect to are in the same private network; otherwise, they cannot communicate optimally via the internal network. You can call the CreateVpc API to create a private network. You can call the DescribeVpcs API to query private network information that meets specified conditions, including the private network ID.
    AllowListIds List<string>
    Allowlist ID list. If left empty, the new instance will not be added to any allowlist by default. You can call the DescribeAllowLists API to query all IP allowlist information, including allowlist IDs, for the specified region under your account. Each instance supports binding up to 100 allowlists, and you can batch bind up to 100 allowlists at a time. Each instance supports binding up to 1000 IP addresses or CIDR-format IP address ranges.
    AutoRenew bool
    Whether to enable auto-renewal. Value options: false (default): Disabled; true: Enabled.
    BackupPointName string
    Set a backup name for the full backup created before changes.
    ChargeType string
    Instance billing type. Value options: PrePaid: Subscription (also called prepaid). PostPaid: Pay-as-you-go (also called postpaid).
    CreateBackup bool
    Whether to create a backup before making changes.
    DeletionProtection string
    Enable or disable instance deletion protection.
    InstanceName string
    Instance name. Naming rules: Cannot start with a digit or hyphen (-); can only contain Chinese characters, letters, digits, underscores (_), and hyphens (-); length must be 1–128 characters.
    NoAuthMode string
    Enable or disable password-free access for new instances. Valid values: open: enable password-free access; close (default): disable password-free access.
    ParameterGroupId string
    The parameter template to be applied to the new instance. Redis for Cache Database creates a default system parameter template for each database version, which includes all parameters supported by that version and their default values. If this parameter is left blank, the system will select and apply the corresponding version's system parameter template for the new instance based on the database version you set (i.e., EngineVersion). You can call the DescribeParameterGroups API to query basic information about all parameter templates under your account and region, including the parameter template ID.
    Password string
    Set the password for the default account of the default database.
    Port int
    Custom port number for the private network connection address. Value range: 1024~65535. If this parameter is left blank, the private network connection address uses port 6379 by default. After the instance is created, you can also modify the port number of the private network address. For instructions, see Modify Port Number.
    ProjectName string
    Project to which the instance belongs.
    PurchaseMonths int
    Purchase duration, unit: month. Value options: Monthly purchase: 1, 2, 3, 4, 5, 6, 7, 8, 9. Annual purchase: 12, 24, 36. When ChargeType is PrePaid, this parameter is required.
    ReserveAdditionalBandwidth bool
    Set whether to reserve additional bandwidth
    ShardNumber int
    Number of shards in the instance. Value range: 2–256. Specify this parameter only when ShardedCluster is set to 1 (enabled).
    Tags List<Volcengine.InstanceTag>
    ConfigureNodes []InstanceConfigureNodeArgs
    EngineVersion string
    Database version number.
    MultiAz string
    Set the deployment scheme for the instance's availability zone.
    NodeNumber int
    Number of nodes in each shard. Value range: 1–6. By default, each account can create up to 4 nodes of 256 MiB specification per region. To increase the quota limit to 10, see Account Quotas. A value of 1 creates a single-node instance; a value greater than 1 creates a primary-secondary instance. For details on the differences between these two types of instances, see Feature Differences.
    ShardCapacity int
    Memory capacity of each shard in the instance. Unit: MiB.
    ShardedCluster int
    Whether to enable sharded cluster. Value options: 0: Disabled. 1: Enabled.
    SubnetId string
    Set the subnet ID for the instance. Subnets have availability zone attributes; you must select a subnet in the target private network that belongs to the same availability zone as the instance. A subnet is an IP address block within a private network. All cloud resources in the private network must be deployed in a subnet. The subnet assigns private IP addresses to cloud resources. You can call the CreateSubnet API to create a subnet. You can call the DescribeSubnets API to query the list of all subnets in a specified availability zone, including subnet IDs.
    VpcId string
    Set the private network ID for the instance. It is recommended that the Redis instance and the ECS instance you want to connect to are in the same private network; otherwise, they cannot communicate optimally via the internal network. You can call the CreateVpc API to create a private network. You can call the DescribeVpcs API to query private network information that meets specified conditions, including the private network ID.
    AllowListIds []string
    Allowlist ID list. If left empty, the new instance will not be added to any allowlist by default. You can call the DescribeAllowLists API to query all IP allowlist information, including allowlist IDs, for the specified region under your account. Each instance supports binding up to 100 allowlists, and you can batch bind up to 100 allowlists at a time. Each instance supports binding up to 1000 IP addresses or CIDR-format IP address ranges.
    AutoRenew bool
    Whether to enable auto-renewal. Value options: false (default): Disabled; true: Enabled.
    BackupPointName string
    Set a backup name for the full backup created before changes.
    ChargeType string
    Instance billing type. Value options: PrePaid: Subscription (also called prepaid). PostPaid: Pay-as-you-go (also called postpaid).
    CreateBackup bool
    Whether to create a backup before making changes.
    DeletionProtection string
    Enable or disable instance deletion protection.
    InstanceName string
    Instance name. Naming rules: Cannot start with a digit or hyphen (-); can only contain Chinese characters, letters, digits, underscores (_), and hyphens (-); length must be 1–128 characters.
    NoAuthMode string
    Enable or disable password-free access for new instances. Valid values: open: enable password-free access; close (default): disable password-free access.
    ParameterGroupId string
    The parameter template to be applied to the new instance. Redis for Cache Database creates a default system parameter template for each database version, which includes all parameters supported by that version and their default values. If this parameter is left blank, the system will select and apply the corresponding version's system parameter template for the new instance based on the database version you set (i.e., EngineVersion). You can call the DescribeParameterGroups API to query basic information about all parameter templates under your account and region, including the parameter template ID.
    Password string
    Set the password for the default account of the default database.
    Port int
    Custom port number for the private network connection address. Value range: 1024~65535. If this parameter is left blank, the private network connection address uses port 6379 by default. After the instance is created, you can also modify the port number of the private network address. For instructions, see Modify Port Number.
    ProjectName string
    Project to which the instance belongs.
    PurchaseMonths int
    Purchase duration, unit: month. Value options: Monthly purchase: 1, 2, 3, 4, 5, 6, 7, 8, 9. Annual purchase: 12, 24, 36. When ChargeType is PrePaid, this parameter is required.
    ReserveAdditionalBandwidth bool
    Set whether to reserve additional bandwidth
    ShardNumber int
    Number of shards in the instance. Value range: 2–256. Specify this parameter only when ShardedCluster is set to 1 (enabled).
    Tags []InstanceTagArgs
    configureNodes List<InstanceConfigureNode>
    engineVersion String
    Database version number.
    multiAz String
    Set the deployment scheme for the instance's availability zone.
    nodeNumber Integer
    Number of nodes in each shard. Value range: 1–6. By default, each account can create up to 4 nodes of 256 MiB specification per region. To increase the quota limit to 10, see Account Quotas. A value of 1 creates a single-node instance; a value greater than 1 creates a primary-secondary instance. For details on the differences between these two types of instances, see Feature Differences.
    shardCapacity Integer
    Memory capacity of each shard in the instance. Unit: MiB.
    shardedCluster Integer
    Whether to enable sharded cluster. Value options: 0: Disabled. 1: Enabled.
    subnetId String
    Set the subnet ID for the instance. Subnets have availability zone attributes; you must select a subnet in the target private network that belongs to the same availability zone as the instance. A subnet is an IP address block within a private network. All cloud resources in the private network must be deployed in a subnet. The subnet assigns private IP addresses to cloud resources. You can call the CreateSubnet API to create a subnet. You can call the DescribeSubnets API to query the list of all subnets in a specified availability zone, including subnet IDs.
    vpcId String
    Set the private network ID for the instance. It is recommended that the Redis instance and the ECS instance you want to connect to are in the same private network; otherwise, they cannot communicate optimally via the internal network. You can call the CreateVpc API to create a private network. You can call the DescribeVpcs API to query private network information that meets specified conditions, including the private network ID.
    allowListIds List<String>
    Allowlist ID list. If left empty, the new instance will not be added to any allowlist by default. You can call the DescribeAllowLists API to query all IP allowlist information, including allowlist IDs, for the specified region under your account. Each instance supports binding up to 100 allowlists, and you can batch bind up to 100 allowlists at a time. Each instance supports binding up to 1000 IP addresses or CIDR-format IP address ranges.
    autoRenew Boolean
    Whether to enable auto-renewal. Value options: false (default): Disabled; true: Enabled.
    backupPointName String
    Set a backup name for the full backup created before changes.
    chargeType String
    Instance billing type. Value options: PrePaid: Subscription (also called prepaid). PostPaid: Pay-as-you-go (also called postpaid).
    createBackup Boolean
    Whether to create a backup before making changes.
    deletionProtection String
    Enable or disable instance deletion protection.
    instanceName String
    Instance name. Naming rules: Cannot start with a digit or hyphen (-); can only contain Chinese characters, letters, digits, underscores (_), and hyphens (-); length must be 1–128 characters.
    noAuthMode String
    Enable or disable password-free access for new instances. Valid values: open: enable password-free access; close (default): disable password-free access.
    parameterGroupId String
    The parameter template to be applied to the new instance. Redis for Cache Database creates a default system parameter template for each database version, which includes all parameters supported by that version and their default values. If this parameter is left blank, the system will select and apply the corresponding version's system parameter template for the new instance based on the database version you set (i.e., EngineVersion). You can call the DescribeParameterGroups API to query basic information about all parameter templates under your account and region, including the parameter template ID.
    password String
    Set the password for the default account of the default database.
    port Integer
    Custom port number for the private network connection address. Value range: 1024~65535. If this parameter is left blank, the private network connection address uses port 6379 by default. After the instance is created, you can also modify the port number of the private network address. For instructions, see Modify Port Number.
    projectName String
    Project to which the instance belongs.
    purchaseMonths Integer
    Purchase duration, unit: month. Value options: Monthly purchase: 1, 2, 3, 4, 5, 6, 7, 8, 9. Annual purchase: 12, 24, 36. When ChargeType is PrePaid, this parameter is required.
    reserveAdditionalBandwidth Boolean
    Set whether to reserve additional bandwidth
    shardNumber Integer
    Number of shards in the instance. Value range: 2–256. Specify this parameter only when ShardedCluster is set to 1 (enabled).
    tags List<InstanceTag>
    configureNodes InstanceConfigureNode[]
    engineVersion string
    Database version number.
    multiAz string
    Set the deployment scheme for the instance's availability zone.
    nodeNumber number
    Number of nodes in each shard. Value range: 1–6. By default, each account can create up to 4 nodes of 256 MiB specification per region. To increase the quota limit to 10, see Account Quotas. A value of 1 creates a single-node instance; a value greater than 1 creates a primary-secondary instance. For details on the differences between these two types of instances, see Feature Differences.
    shardCapacity number
    Memory capacity of each shard in the instance. Unit: MiB.
    shardedCluster number
    Whether to enable sharded cluster. Value options: 0: Disabled. 1: Enabled.
    subnetId string
    Set the subnet ID for the instance. Subnets have availability zone attributes; you must select a subnet in the target private network that belongs to the same availability zone as the instance. A subnet is an IP address block within a private network. All cloud resources in the private network must be deployed in a subnet. The subnet assigns private IP addresses to cloud resources. You can call the CreateSubnet API to create a subnet. You can call the DescribeSubnets API to query the list of all subnets in a specified availability zone, including subnet IDs.
    vpcId string
    Set the private network ID for the instance. It is recommended that the Redis instance and the ECS instance you want to connect to are in the same private network; otherwise, they cannot communicate optimally via the internal network. You can call the CreateVpc API to create a private network. You can call the DescribeVpcs API to query private network information that meets specified conditions, including the private network ID.
    allowListIds string[]
    Allowlist ID list. If left empty, the new instance will not be added to any allowlist by default. You can call the DescribeAllowLists API to query all IP allowlist information, including allowlist IDs, for the specified region under your account. Each instance supports binding up to 100 allowlists, and you can batch bind up to 100 allowlists at a time. Each instance supports binding up to 1000 IP addresses or CIDR-format IP address ranges.
    autoRenew boolean
    Whether to enable auto-renewal. Value options: false (default): Disabled; true: Enabled.
    backupPointName string
    Set a backup name for the full backup created before changes.
    chargeType string
    Instance billing type. Value options: PrePaid: Subscription (also called prepaid). PostPaid: Pay-as-you-go (also called postpaid).
    createBackup boolean
    Whether to create a backup before making changes.
    deletionProtection string
    Enable or disable instance deletion protection.
    instanceName string
    Instance name. Naming rules: Cannot start with a digit or hyphen (-); can only contain Chinese characters, letters, digits, underscores (_), and hyphens (-); length must be 1–128 characters.
    noAuthMode string
    Enable or disable password-free access for new instances. Valid values: open: enable password-free access; close (default): disable password-free access.
    parameterGroupId string
    The parameter template to be applied to the new instance. Redis for Cache Database creates a default system parameter template for each database version, which includes all parameters supported by that version and their default values. If this parameter is left blank, the system will select and apply the corresponding version's system parameter template for the new instance based on the database version you set (i.e., EngineVersion). You can call the DescribeParameterGroups API to query basic information about all parameter templates under your account and region, including the parameter template ID.
    password string
    Set the password for the default account of the default database.
    port number
    Custom port number for the private network connection address. Value range: 1024~65535. If this parameter is left blank, the private network connection address uses port 6379 by default. After the instance is created, you can also modify the port number of the private network address. For instructions, see Modify Port Number.
    projectName string
    Project to which the instance belongs.
    purchaseMonths number
    Purchase duration, unit: month. Value options: Monthly purchase: 1, 2, 3, 4, 5, 6, 7, 8, 9. Annual purchase: 12, 24, 36. When ChargeType is PrePaid, this parameter is required.
    reserveAdditionalBandwidth boolean
    Set whether to reserve additional bandwidth
    shardNumber number
    Number of shards in the instance. Value range: 2–256. Specify this parameter only when ShardedCluster is set to 1 (enabled).
    tags InstanceTag[]
    configure_nodes Sequence[InstanceConfigureNodeArgs]
    engine_version str
    Database version number.
    multi_az str
    Set the deployment scheme for the instance's availability zone.
    node_number int
    Number of nodes in each shard. Value range: 1–6. By default, each account can create up to 4 nodes of 256 MiB specification per region. To increase the quota limit to 10, see Account Quotas. A value of 1 creates a single-node instance; a value greater than 1 creates a primary-secondary instance. For details on the differences between these two types of instances, see Feature Differences.
    shard_capacity int
    Memory capacity of each shard in the instance. Unit: MiB.
    sharded_cluster int
    Whether to enable sharded cluster. Value options: 0: Disabled. 1: Enabled.
    subnet_id str
    Set the subnet ID for the instance. Subnets have availability zone attributes; you must select a subnet in the target private network that belongs to the same availability zone as the instance. A subnet is an IP address block within a private network. All cloud resources in the private network must be deployed in a subnet. The subnet assigns private IP addresses to cloud resources. You can call the CreateSubnet API to create a subnet. You can call the DescribeSubnets API to query the list of all subnets in a specified availability zone, including subnet IDs.
    vpc_id str
    Set the private network ID for the instance. It is recommended that the Redis instance and the ECS instance you want to connect to are in the same private network; otherwise, they cannot communicate optimally via the internal network. You can call the CreateVpc API to create a private network. You can call the DescribeVpcs API to query private network information that meets specified conditions, including the private network ID.
    allow_list_ids Sequence[str]
    Allowlist ID list. If left empty, the new instance will not be added to any allowlist by default. You can call the DescribeAllowLists API to query all IP allowlist information, including allowlist IDs, for the specified region under your account. Each instance supports binding up to 100 allowlists, and you can batch bind up to 100 allowlists at a time. Each instance supports binding up to 1000 IP addresses or CIDR-format IP address ranges.
    auto_renew bool
    Whether to enable auto-renewal. Value options: false (default): Disabled; true: Enabled.
    backup_point_name str
    Set a backup name for the full backup created before changes.
    charge_type str
    Instance billing type. Value options: PrePaid: Subscription (also called prepaid). PostPaid: Pay-as-you-go (also called postpaid).
    create_backup bool
    Whether to create a backup before making changes.
    deletion_protection str
    Enable or disable instance deletion protection.
    instance_name str
    Instance name. Naming rules: Cannot start with a digit or hyphen (-); can only contain Chinese characters, letters, digits, underscores (_), and hyphens (-); length must be 1–128 characters.
    no_auth_mode str
    Enable or disable password-free access for new instances. Valid values: open: enable password-free access; close (default): disable password-free access.
    parameter_group_id str
    The parameter template to be applied to the new instance. Redis for Cache Database creates a default system parameter template for each database version, which includes all parameters supported by that version and their default values. If this parameter is left blank, the system will select and apply the corresponding version's system parameter template for the new instance based on the database version you set (i.e., EngineVersion). You can call the DescribeParameterGroups API to query basic information about all parameter templates under your account and region, including the parameter template ID.
    password str
    Set the password for the default account of the default database.
    port int
    Custom port number for the private network connection address. Value range: 1024~65535. If this parameter is left blank, the private network connection address uses port 6379 by default. After the instance is created, you can also modify the port number of the private network address. For instructions, see Modify Port Number.
    project_name str
    Project to which the instance belongs.
    purchase_months int
    Purchase duration, unit: month. Value options: Monthly purchase: 1, 2, 3, 4, 5, 6, 7, 8, 9. Annual purchase: 12, 24, 36. When ChargeType is PrePaid, this parameter is required.
    reserve_additional_bandwidth bool
    Set whether to reserve additional bandwidth
    shard_number int
    Number of shards in the instance. Value range: 2–256. Specify this parameter only when ShardedCluster is set to 1 (enabled).
    tags Sequence[InstanceTagArgs]
    configureNodes List<Property Map>
    engineVersion String
    Database version number.
    multiAz String
    Set the deployment scheme for the instance's availability zone.
    nodeNumber Number
    Number of nodes in each shard. Value range: 1–6. By default, each account can create up to 4 nodes of 256 MiB specification per region. To increase the quota limit to 10, see Account Quotas. A value of 1 creates a single-node instance; a value greater than 1 creates a primary-secondary instance. For details on the differences between these two types of instances, see Feature Differences.
    shardCapacity Number
    Memory capacity of each shard in the instance. Unit: MiB.
    shardedCluster Number
    Whether to enable sharded cluster. Value options: 0: Disabled. 1: Enabled.
    subnetId String
    Set the subnet ID for the instance. Subnets have availability zone attributes; you must select a subnet in the target private network that belongs to the same availability zone as the instance. A subnet is an IP address block within a private network. All cloud resources in the private network must be deployed in a subnet. The subnet assigns private IP addresses to cloud resources. You can call the CreateSubnet API to create a subnet. You can call the DescribeSubnets API to query the list of all subnets in a specified availability zone, including subnet IDs.
    vpcId String
    Set the private network ID for the instance. It is recommended that the Redis instance and the ECS instance you want to connect to are in the same private network; otherwise, they cannot communicate optimally via the internal network. You can call the CreateVpc API to create a private network. You can call the DescribeVpcs API to query private network information that meets specified conditions, including the private network ID.
    allowListIds List<String>
    Allowlist ID list. If left empty, the new instance will not be added to any allowlist by default. You can call the DescribeAllowLists API to query all IP allowlist information, including allowlist IDs, for the specified region under your account. Each instance supports binding up to 100 allowlists, and you can batch bind up to 100 allowlists at a time. Each instance supports binding up to 1000 IP addresses or CIDR-format IP address ranges.
    autoRenew Boolean
    Whether to enable auto-renewal. Value options: false (default): Disabled; true: Enabled.
    backupPointName String
    Set a backup name for the full backup created before changes.
    chargeType String
    Instance billing type. Value options: PrePaid: Subscription (also called prepaid). PostPaid: Pay-as-you-go (also called postpaid).
    createBackup Boolean
    Whether to create a backup before making changes.
    deletionProtection String
    Enable or disable instance deletion protection.
    instanceName String
    Instance name. Naming rules: Cannot start with a digit or hyphen (-); can only contain Chinese characters, letters, digits, underscores (_), and hyphens (-); length must be 1–128 characters.
    noAuthMode String
    Enable or disable password-free access for new instances. Valid values: open: enable password-free access; close (default): disable password-free access.
    parameterGroupId String
    The parameter template to be applied to the new instance. Redis for Cache Database creates a default system parameter template for each database version, which includes all parameters supported by that version and their default values. If this parameter is left blank, the system will select and apply the corresponding version's system parameter template for the new instance based on the database version you set (i.e., EngineVersion). You can call the DescribeParameterGroups API to query basic information about all parameter templates under your account and region, including the parameter template ID.
    password String
    Set the password for the default account of the default database.
    port Number
    Custom port number for the private network connection address. Value range: 1024~65535. If this parameter is left blank, the private network connection address uses port 6379 by default. After the instance is created, you can also modify the port number of the private network address. For instructions, see Modify Port Number.
    projectName String
    Project to which the instance belongs.
    purchaseMonths Number
    Purchase duration, unit: month. Value options: Monthly purchase: 1, 2, 3, 4, 5, 6, 7, 8, 9. Annual purchase: 12, 24, 36. When ChargeType is PrePaid, this parameter is required.
    reserveAdditionalBandwidth Boolean
    Set whether to reserve additional bandwidth
    shardNumber Number
    Number of shards in the instance. Value range: 2–256. Specify this parameter only when ShardedCluster is set to 1 (enabled).
    tags List<Property Map>

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Instance resource produces the following output properties:

    BlueGreenRole string
    Blue-green deployment role of the instance. Valid values: Blue: blue instance. Green: green instance. This parameter is returned only for Redis instances that have used the blue-green deployment feature.
    Capacity Volcengine.InstanceCapacity
    Capacity information of the instance.
    CreateTime string
    Creation time of the instance.
    DataLayout string
    Data storage type of the instance. This parameter is only relevant for Enterprise Edition instances (ServiceType=Enterprise). Community Edition instances (ServiceType=Basic) do not involve data storage type, and DataLayout is always set to RAM. If this parameter is left empty, data storage type is not used as a filter.
    ExpiredTime string
    Instance expiration time.
    Id string
    The provider-assigned unique ID for this managed resource.
    InstanceClass string
    Type of Redis instance. Valid values: PrimarySecondary: primary-secondary instance; Standalone: single-node instance. If this parameter is left empty, instance type is not used as a filter. For more information about instance types, see Product Architecture.
    InstanceId string
    Instance ID.
    InstanceShards List<Volcengine.InstanceInstanceShard>
    MaintenanceTime string
    Maintenance window for the instance, format: HH:mm-HH:mm (UTC+8).
    MaxConnections int
    Current maximum connections per shard for the instance. The default connection limit per shard is 10,000. You can also call the ModifyDBInstanceMaxConn API to adjust the maximum connections per shard based on your business needs.
    NodeIds List<string>
    List of Proxy and Server node IDs.
    PrivateAddress string
    The domain name for the instance's private network connection address.
    PrivatePort string
    Port number for the instance's private network connection address.
    ServiceType string
    Service type of the instance
    Status string
    Service type of the instance. Value options: Basic (default): Community Edition; Enterprise: Enterprise Edition.
    ViPv6 string
    The IPv6 address corresponding to the instance's private network connection address. This parameter is returned only if the instance uses an IPv6 address.
    Vip string
    IPv4 address corresponding to the instance's private network connection address.
    VisitAddrs List<Volcengine.InstanceVisitAddr>
    VpcAuthMode string
    Enable or disable password-free access. Valid values: open: enable password-free access; close: disable password-free access. Values are case-insensitive.
    ZoneIds List<string>
    List of available zones where the instance is located.
    BlueGreenRole string
    Blue-green deployment role of the instance. Valid values: Blue: blue instance. Green: green instance. This parameter is returned only for Redis instances that have used the blue-green deployment feature.
    Capacity InstanceCapacity
    Capacity information of the instance.
    CreateTime string
    Creation time of the instance.
    DataLayout string
    Data storage type of the instance. This parameter is only relevant for Enterprise Edition instances (ServiceType=Enterprise). Community Edition instances (ServiceType=Basic) do not involve data storage type, and DataLayout is always set to RAM. If this parameter is left empty, data storage type is not used as a filter.
    ExpiredTime string
    Instance expiration time.
    Id string
    The provider-assigned unique ID for this managed resource.
    InstanceClass string
    Type of Redis instance. Valid values: PrimarySecondary: primary-secondary instance; Standalone: single-node instance. If this parameter is left empty, instance type is not used as a filter. For more information about instance types, see Product Architecture.
    InstanceId string
    Instance ID.
    InstanceShards []InstanceInstanceShard
    MaintenanceTime string
    Maintenance window for the instance, format: HH:mm-HH:mm (UTC+8).
    MaxConnections int
    Current maximum connections per shard for the instance. The default connection limit per shard is 10,000. You can also call the ModifyDBInstanceMaxConn API to adjust the maximum connections per shard based on your business needs.
    NodeIds []string
    List of Proxy and Server node IDs.
    PrivateAddress string
    The domain name for the instance's private network connection address.
    PrivatePort string
    Port number for the instance's private network connection address.
    ServiceType string
    Service type of the instance
    Status string
    Service type of the instance. Value options: Basic (default): Community Edition; Enterprise: Enterprise Edition.
    ViPv6 string
    The IPv6 address corresponding to the instance's private network connection address. This parameter is returned only if the instance uses an IPv6 address.
    Vip string
    IPv4 address corresponding to the instance's private network connection address.
    VisitAddrs []InstanceVisitAddr
    VpcAuthMode string
    Enable or disable password-free access. Valid values: open: enable password-free access; close: disable password-free access. Values are case-insensitive.
    ZoneIds []string
    List of available zones where the instance is located.
    blueGreenRole String
    Blue-green deployment role of the instance. Valid values: Blue: blue instance. Green: green instance. This parameter is returned only for Redis instances that have used the blue-green deployment feature.
    capacity InstanceCapacity
    Capacity information of the instance.
    createTime String
    Creation time of the instance.
    dataLayout String
    Data storage type of the instance. This parameter is only relevant for Enterprise Edition instances (ServiceType=Enterprise). Community Edition instances (ServiceType=Basic) do not involve data storage type, and DataLayout is always set to RAM. If this parameter is left empty, data storage type is not used as a filter.
    expiredTime String
    Instance expiration time.
    id String
    The provider-assigned unique ID for this managed resource.
    instanceClass String
    Type of Redis instance. Valid values: PrimarySecondary: primary-secondary instance; Standalone: single-node instance. If this parameter is left empty, instance type is not used as a filter. For more information about instance types, see Product Architecture.
    instanceId String
    Instance ID.
    instanceShards List<InstanceInstanceShard>
    maintenanceTime String
    Maintenance window for the instance, format: HH:mm-HH:mm (UTC+8).
    maxConnections Integer
    Current maximum connections per shard for the instance. The default connection limit per shard is 10,000. You can also call the ModifyDBInstanceMaxConn API to adjust the maximum connections per shard based on your business needs.
    nodeIds List<String>
    List of Proxy and Server node IDs.
    privateAddress String
    The domain name for the instance's private network connection address.
    privatePort String
    Port number for the instance's private network connection address.
    serviceType String
    Service type of the instance
    status String
    Service type of the instance. Value options: Basic (default): Community Edition; Enterprise: Enterprise Edition.
    viPv6 String
    The IPv6 address corresponding to the instance's private network connection address. This parameter is returned only if the instance uses an IPv6 address.
    vip String
    IPv4 address corresponding to the instance's private network connection address.
    visitAddrs List<InstanceVisitAddr>
    vpcAuthMode String
    Enable or disable password-free access. Valid values: open: enable password-free access; close: disable password-free access. Values are case-insensitive.
    zoneIds List<String>
    List of available zones where the instance is located.
    blueGreenRole string
    Blue-green deployment role of the instance. Valid values: Blue: blue instance. Green: green instance. This parameter is returned only for Redis instances that have used the blue-green deployment feature.
    capacity InstanceCapacity
    Capacity information of the instance.
    createTime string
    Creation time of the instance.
    dataLayout string
    Data storage type of the instance. This parameter is only relevant for Enterprise Edition instances (ServiceType=Enterprise). Community Edition instances (ServiceType=Basic) do not involve data storage type, and DataLayout is always set to RAM. If this parameter is left empty, data storage type is not used as a filter.
    expiredTime string
    Instance expiration time.
    id string
    The provider-assigned unique ID for this managed resource.
    instanceClass string
    Type of Redis instance. Valid values: PrimarySecondary: primary-secondary instance; Standalone: single-node instance. If this parameter is left empty, instance type is not used as a filter. For more information about instance types, see Product Architecture.
    instanceId string
    Instance ID.
    instanceShards InstanceInstanceShard[]
    maintenanceTime string
    Maintenance window for the instance, format: HH:mm-HH:mm (UTC+8).
    maxConnections number
    Current maximum connections per shard for the instance. The default connection limit per shard is 10,000. You can also call the ModifyDBInstanceMaxConn API to adjust the maximum connections per shard based on your business needs.
    nodeIds string[]
    List of Proxy and Server node IDs.
    privateAddress string
    The domain name for the instance's private network connection address.
    privatePort string
    Port number for the instance's private network connection address.
    serviceType string
    Service type of the instance
    status string
    Service type of the instance. Value options: Basic (default): Community Edition; Enterprise: Enterprise Edition.
    viPv6 string
    The IPv6 address corresponding to the instance's private network connection address. This parameter is returned only if the instance uses an IPv6 address.
    vip string
    IPv4 address corresponding to the instance's private network connection address.
    visitAddrs InstanceVisitAddr[]
    vpcAuthMode string
    Enable or disable password-free access. Valid values: open: enable password-free access; close: disable password-free access. Values are case-insensitive.
    zoneIds string[]
    List of available zones where the instance is located.
    blue_green_role str
    Blue-green deployment role of the instance. Valid values: Blue: blue instance. Green: green instance. This parameter is returned only for Redis instances that have used the blue-green deployment feature.
    capacity InstanceCapacity
    Capacity information of the instance.
    create_time str
    Creation time of the instance.
    data_layout str
    Data storage type of the instance. This parameter is only relevant for Enterprise Edition instances (ServiceType=Enterprise). Community Edition instances (ServiceType=Basic) do not involve data storage type, and DataLayout is always set to RAM. If this parameter is left empty, data storage type is not used as a filter.
    expired_time str
    Instance expiration time.
    id str
    The provider-assigned unique ID for this managed resource.
    instance_class str
    Type of Redis instance. Valid values: PrimarySecondary: primary-secondary instance; Standalone: single-node instance. If this parameter is left empty, instance type is not used as a filter. For more information about instance types, see Product Architecture.
    instance_id str
    Instance ID.
    instance_shards Sequence[InstanceInstanceShard]
    maintenance_time str
    Maintenance window for the instance, format: HH:mm-HH:mm (UTC+8).
    max_connections int
    Current maximum connections per shard for the instance. The default connection limit per shard is 10,000. You can also call the ModifyDBInstanceMaxConn API to adjust the maximum connections per shard based on your business needs.
    node_ids Sequence[str]
    List of Proxy and Server node IDs.
    private_address str
    The domain name for the instance's private network connection address.
    private_port str
    Port number for the instance's private network connection address.
    service_type str
    Service type of the instance
    status str
    Service type of the instance. Value options: Basic (default): Community Edition; Enterprise: Enterprise Edition.
    vi_pv6 str
    The IPv6 address corresponding to the instance's private network connection address. This parameter is returned only if the instance uses an IPv6 address.
    vip str
    IPv4 address corresponding to the instance's private network connection address.
    visit_addrs Sequence[InstanceVisitAddr]
    vpc_auth_mode str
    Enable or disable password-free access. Valid values: open: enable password-free access; close: disable password-free access. Values are case-insensitive.
    zone_ids Sequence[str]
    List of available zones where the instance is located.
    blueGreenRole String
    Blue-green deployment role of the instance. Valid values: Blue: blue instance. Green: green instance. This parameter is returned only for Redis instances that have used the blue-green deployment feature.
    capacity Property Map
    Capacity information of the instance.
    createTime String
    Creation time of the instance.
    dataLayout String
    Data storage type of the instance. This parameter is only relevant for Enterprise Edition instances (ServiceType=Enterprise). Community Edition instances (ServiceType=Basic) do not involve data storage type, and DataLayout is always set to RAM. If this parameter is left empty, data storage type is not used as a filter.
    expiredTime String
    Instance expiration time.
    id String
    The provider-assigned unique ID for this managed resource.
    instanceClass String
    Type of Redis instance. Valid values: PrimarySecondary: primary-secondary instance; Standalone: single-node instance. If this parameter is left empty, instance type is not used as a filter. For more information about instance types, see Product Architecture.
    instanceId String
    Instance ID.
    instanceShards List<Property Map>
    maintenanceTime String
    Maintenance window for the instance, format: HH:mm-HH:mm (UTC+8).
    maxConnections Number
    Current maximum connections per shard for the instance. The default connection limit per shard is 10,000. You can also call the ModifyDBInstanceMaxConn API to adjust the maximum connections per shard based on your business needs.
    nodeIds List<String>
    List of Proxy and Server node IDs.
    privateAddress String
    The domain name for the instance's private network connection address.
    privatePort String
    Port number for the instance's private network connection address.
    serviceType String
    Service type of the instance
    status String
    Service type of the instance. Value options: Basic (default): Community Edition; Enterprise: Enterprise Edition.
    viPv6 String
    The IPv6 address corresponding to the instance's private network connection address. This parameter is returned only if the instance uses an IPv6 address.
    vip String
    IPv4 address corresponding to the instance's private network connection address.
    visitAddrs List<Property Map>
    vpcAuthMode String
    Enable or disable password-free access. Valid values: open: enable password-free access; close: disable password-free access. Values are case-insensitive.
    zoneIds List<String>
    List of available zones where the instance is located.

    Look up Existing Instance Resource

    Get an existing Instance resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: InstanceState, opts?: CustomResourceOptions): Instance
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        allow_list_ids: Optional[Sequence[str]] = None,
        auto_renew: Optional[bool] = None,
        backup_point_name: Optional[str] = None,
        blue_green_role: Optional[str] = None,
        capacity: Optional[InstanceCapacityArgs] = None,
        charge_type: Optional[str] = None,
        configure_nodes: Optional[Sequence[InstanceConfigureNodeArgs]] = None,
        create_backup: Optional[bool] = None,
        create_time: Optional[str] = None,
        data_layout: Optional[str] = None,
        deletion_protection: Optional[str] = None,
        engine_version: Optional[str] = None,
        expired_time: Optional[str] = None,
        instance_class: Optional[str] = None,
        instance_id: Optional[str] = None,
        instance_name: Optional[str] = None,
        instance_shards: Optional[Sequence[InstanceInstanceShardArgs]] = None,
        maintenance_time: Optional[str] = None,
        max_connections: Optional[int] = None,
        multi_az: Optional[str] = None,
        no_auth_mode: Optional[str] = None,
        node_ids: Optional[Sequence[str]] = None,
        node_number: Optional[int] = None,
        parameter_group_id: Optional[str] = None,
        password: Optional[str] = None,
        port: Optional[int] = None,
        private_address: Optional[str] = None,
        private_port: Optional[str] = None,
        project_name: Optional[str] = None,
        purchase_months: Optional[int] = None,
        reserve_additional_bandwidth: Optional[bool] = None,
        service_type: Optional[str] = None,
        shard_capacity: Optional[int] = None,
        shard_number: Optional[int] = None,
        sharded_cluster: Optional[int] = None,
        status: Optional[str] = None,
        subnet_id: Optional[str] = None,
        tags: Optional[Sequence[InstanceTagArgs]] = None,
        vi_pv6: Optional[str] = None,
        vip: Optional[str] = None,
        visit_addrs: Optional[Sequence[InstanceVisitAddrArgs]] = None,
        vpc_auth_mode: Optional[str] = None,
        vpc_id: Optional[str] = None,
        zone_ids: Optional[Sequence[str]] = None) -> Instance
    func GetInstance(ctx *Context, name string, id IDInput, state *InstanceState, opts ...ResourceOption) (*Instance, error)
    public static Instance Get(string name, Input<string> id, InstanceState? state, CustomResourceOptions? opts = null)
    public static Instance get(String name, Output<String> id, InstanceState state, CustomResourceOptions options)
    resources:  _:    type: volcenginecc:redis:Instance    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AllowListIds List<string>
    Allowlist ID list. If left empty, the new instance will not be added to any allowlist by default. You can call the DescribeAllowLists API to query all IP allowlist information, including allowlist IDs, for the specified region under your account. Each instance supports binding up to 100 allowlists, and you can batch bind up to 100 allowlists at a time. Each instance supports binding up to 1000 IP addresses or CIDR-format IP address ranges.
    AutoRenew bool
    Whether to enable auto-renewal. Value options: false (default): Disabled; true: Enabled.
    BackupPointName string
    Set a backup name for the full backup created before changes.
    BlueGreenRole string
    Blue-green deployment role of the instance. Valid values: Blue: blue instance. Green: green instance. This parameter is returned only for Redis instances that have used the blue-green deployment feature.
    Capacity Volcengine.InstanceCapacity
    Capacity information of the instance.
    ChargeType string
    Instance billing type. Value options: PrePaid: Subscription (also called prepaid). PostPaid: Pay-as-you-go (also called postpaid).
    ConfigureNodes List<Volcengine.InstanceConfigureNode>
    CreateBackup bool
    Whether to create a backup before making changes.
    CreateTime string
    Creation time of the instance.
    DataLayout string
    Data storage type of the instance. This parameter is only relevant for Enterprise Edition instances (ServiceType=Enterprise). Community Edition instances (ServiceType=Basic) do not involve data storage type, and DataLayout is always set to RAM. If this parameter is left empty, data storage type is not used as a filter.
    DeletionProtection string
    Enable or disable instance deletion protection.
    EngineVersion string
    Database version number.
    ExpiredTime string
    Instance expiration time.
    InstanceClass string
    Type of Redis instance. Valid values: PrimarySecondary: primary-secondary instance; Standalone: single-node instance. If this parameter is left empty, instance type is not used as a filter. For more information about instance types, see Product Architecture.
    InstanceId string
    Instance ID.
    InstanceName string
    Instance name. Naming rules: Cannot start with a digit or hyphen (-); can only contain Chinese characters, letters, digits, underscores (_), and hyphens (-); length must be 1–128 characters.
    InstanceShards List<Volcengine.InstanceInstanceShard>
    MaintenanceTime string
    Maintenance window for the instance, format: HH:mm-HH:mm (UTC+8).
    MaxConnections int
    Current maximum connections per shard for the instance. The default connection limit per shard is 10,000. You can also call the ModifyDBInstanceMaxConn API to adjust the maximum connections per shard based on your business needs.
    MultiAz string
    Set the deployment scheme for the instance's availability zone.
    NoAuthMode string
    Enable or disable password-free access for new instances. Valid values: open: enable password-free access; close (default): disable password-free access.
    NodeIds List<string>
    List of Proxy and Server node IDs.
    NodeNumber int
    Number of nodes in each shard. Value range: 1–6. By default, each account can create up to 4 nodes of 256 MiB specification per region. To increase the quota limit to 10, see Account Quotas. A value of 1 creates a single-node instance; a value greater than 1 creates a primary-secondary instance. For details on the differences between these two types of instances, see Feature Differences.
    ParameterGroupId string
    The parameter template to be applied to the new instance. Redis for Cache Database creates a default system parameter template for each database version, which includes all parameters supported by that version and their default values. If this parameter is left blank, the system will select and apply the corresponding version's system parameter template for the new instance based on the database version you set (i.e., EngineVersion). You can call the DescribeParameterGroups API to query basic information about all parameter templates under your account and region, including the parameter template ID.
    Password string
    Set the password for the default account of the default database.
    Port int
    Custom port number for the private network connection address. Value range: 1024~65535. If this parameter is left blank, the private network connection address uses port 6379 by default. After the instance is created, you can also modify the port number of the private network address. For instructions, see Modify Port Number.
    PrivateAddress string
    The domain name for the instance's private network connection address.
    PrivatePort string
    Port number for the instance's private network connection address.
    ProjectName string
    Project to which the instance belongs.
    PurchaseMonths int
    Purchase duration, unit: month. Value options: Monthly purchase: 1, 2, 3, 4, 5, 6, 7, 8, 9. Annual purchase: 12, 24, 36. When ChargeType is PrePaid, this parameter is required.
    ReserveAdditionalBandwidth bool
    Set whether to reserve additional bandwidth
    ServiceType string
    Service type of the instance
    ShardCapacity int
    Memory capacity of each shard in the instance. Unit: MiB.
    ShardNumber int
    Number of shards in the instance. Value range: 2–256. Specify this parameter only when ShardedCluster is set to 1 (enabled).
    ShardedCluster int
    Whether to enable sharded cluster. Value options: 0: Disabled. 1: Enabled.
    Status string
    Service type of the instance. Value options: Basic (default): Community Edition; Enterprise: Enterprise Edition.
    SubnetId string
    Set the subnet ID for the instance. Subnets have availability zone attributes; you must select a subnet in the target private network that belongs to the same availability zone as the instance. A subnet is an IP address block within a private network. All cloud resources in the private network must be deployed in a subnet. The subnet assigns private IP addresses to cloud resources. You can call the CreateSubnet API to create a subnet. You can call the DescribeSubnets API to query the list of all subnets in a specified availability zone, including subnet IDs.
    Tags List<Volcengine.InstanceTag>
    ViPv6 string
    The IPv6 address corresponding to the instance's private network connection address. This parameter is returned only if the instance uses an IPv6 address.
    Vip string
    IPv4 address corresponding to the instance's private network connection address.
    VisitAddrs List<Volcengine.InstanceVisitAddr>
    VpcAuthMode string
    Enable or disable password-free access. Valid values: open: enable password-free access; close: disable password-free access. Values are case-insensitive.
    VpcId string
    Set the private network ID for the instance. It is recommended that the Redis instance and the ECS instance you want to connect to are in the same private network; otherwise, they cannot communicate optimally via the internal network. You can call the CreateVpc API to create a private network. You can call the DescribeVpcs API to query private network information that meets specified conditions, including the private network ID.
    ZoneIds List<string>
    List of available zones where the instance is located.
    AllowListIds []string
    Allowlist ID list. If left empty, the new instance will not be added to any allowlist by default. You can call the DescribeAllowLists API to query all IP allowlist information, including allowlist IDs, for the specified region under your account. Each instance supports binding up to 100 allowlists, and you can batch bind up to 100 allowlists at a time. Each instance supports binding up to 1000 IP addresses or CIDR-format IP address ranges.
    AutoRenew bool
    Whether to enable auto-renewal. Value options: false (default): Disabled; true: Enabled.
    BackupPointName string
    Set a backup name for the full backup created before changes.
    BlueGreenRole string
    Blue-green deployment role of the instance. Valid values: Blue: blue instance. Green: green instance. This parameter is returned only for Redis instances that have used the blue-green deployment feature.
    Capacity InstanceCapacityArgs
    Capacity information of the instance.
    ChargeType string
    Instance billing type. Value options: PrePaid: Subscription (also called prepaid). PostPaid: Pay-as-you-go (also called postpaid).
    ConfigureNodes []InstanceConfigureNodeArgs
    CreateBackup bool
    Whether to create a backup before making changes.
    CreateTime string
    Creation time of the instance.
    DataLayout string
    Data storage type of the instance. This parameter is only relevant for Enterprise Edition instances (ServiceType=Enterprise). Community Edition instances (ServiceType=Basic) do not involve data storage type, and DataLayout is always set to RAM. If this parameter is left empty, data storage type is not used as a filter.
    DeletionProtection string
    Enable or disable instance deletion protection.
    EngineVersion string
    Database version number.
    ExpiredTime string
    Instance expiration time.
    InstanceClass string
    Type of Redis instance. Valid values: PrimarySecondary: primary-secondary instance; Standalone: single-node instance. If this parameter is left empty, instance type is not used as a filter. For more information about instance types, see Product Architecture.
    InstanceId string
    Instance ID.
    InstanceName string
    Instance name. Naming rules: Cannot start with a digit or hyphen (-); can only contain Chinese characters, letters, digits, underscores (_), and hyphens (-); length must be 1–128 characters.
    InstanceShards []InstanceInstanceShardArgs
    MaintenanceTime string
    Maintenance window for the instance, format: HH:mm-HH:mm (UTC+8).
    MaxConnections int
    Current maximum connections per shard for the instance. The default connection limit per shard is 10,000. You can also call the ModifyDBInstanceMaxConn API to adjust the maximum connections per shard based on your business needs.
    MultiAz string
    Set the deployment scheme for the instance's availability zone.
    NoAuthMode string
    Enable or disable password-free access for new instances. Valid values: open: enable password-free access; close (default): disable password-free access.
    NodeIds []string
    List of Proxy and Server node IDs.
    NodeNumber int
    Number of nodes in each shard. Value range: 1–6. By default, each account can create up to 4 nodes of 256 MiB specification per region. To increase the quota limit to 10, see Account Quotas. A value of 1 creates a single-node instance; a value greater than 1 creates a primary-secondary instance. For details on the differences between these two types of instances, see Feature Differences.
    ParameterGroupId string
    The parameter template to be applied to the new instance. Redis for Cache Database creates a default system parameter template for each database version, which includes all parameters supported by that version and their default values. If this parameter is left blank, the system will select and apply the corresponding version's system parameter template for the new instance based on the database version you set (i.e., EngineVersion). You can call the DescribeParameterGroups API to query basic information about all parameter templates under your account and region, including the parameter template ID.
    Password string
    Set the password for the default account of the default database.
    Port int
    Custom port number for the private network connection address. Value range: 1024~65535. If this parameter is left blank, the private network connection address uses port 6379 by default. After the instance is created, you can also modify the port number of the private network address. For instructions, see Modify Port Number.
    PrivateAddress string
    The domain name for the instance's private network connection address.
    PrivatePort string
    Port number for the instance's private network connection address.
    ProjectName string
    Project to which the instance belongs.
    PurchaseMonths int
    Purchase duration, unit: month. Value options: Monthly purchase: 1, 2, 3, 4, 5, 6, 7, 8, 9. Annual purchase: 12, 24, 36. When ChargeType is PrePaid, this parameter is required.
    ReserveAdditionalBandwidth bool
    Set whether to reserve additional bandwidth
    ServiceType string
    Service type of the instance
    ShardCapacity int
    Memory capacity of each shard in the instance. Unit: MiB.
    ShardNumber int
    Number of shards in the instance. Value range: 2–256. Specify this parameter only when ShardedCluster is set to 1 (enabled).
    ShardedCluster int
    Whether to enable sharded cluster. Value options: 0: Disabled. 1: Enabled.
    Status string
    Service type of the instance. Value options: Basic (default): Community Edition; Enterprise: Enterprise Edition.
    SubnetId string
    Set the subnet ID for the instance. Subnets have availability zone attributes; you must select a subnet in the target private network that belongs to the same availability zone as the instance. A subnet is an IP address block within a private network. All cloud resources in the private network must be deployed in a subnet. The subnet assigns private IP addresses to cloud resources. You can call the CreateSubnet API to create a subnet. You can call the DescribeSubnets API to query the list of all subnets in a specified availability zone, including subnet IDs.
    Tags []InstanceTagArgs
    ViPv6 string
    The IPv6 address corresponding to the instance's private network connection address. This parameter is returned only if the instance uses an IPv6 address.
    Vip string
    IPv4 address corresponding to the instance's private network connection address.
    VisitAddrs []InstanceVisitAddrArgs
    VpcAuthMode string
    Enable or disable password-free access. Valid values: open: enable password-free access; close: disable password-free access. Values are case-insensitive.
    VpcId string
    Set the private network ID for the instance. It is recommended that the Redis instance and the ECS instance you want to connect to are in the same private network; otherwise, they cannot communicate optimally via the internal network. You can call the CreateVpc API to create a private network. You can call the DescribeVpcs API to query private network information that meets specified conditions, including the private network ID.
    ZoneIds []string
    List of available zones where the instance is located.
    allowListIds List<String>
    Allowlist ID list. If left empty, the new instance will not be added to any allowlist by default. You can call the DescribeAllowLists API to query all IP allowlist information, including allowlist IDs, for the specified region under your account. Each instance supports binding up to 100 allowlists, and you can batch bind up to 100 allowlists at a time. Each instance supports binding up to 1000 IP addresses or CIDR-format IP address ranges.
    autoRenew Boolean
    Whether to enable auto-renewal. Value options: false (default): Disabled; true: Enabled.
    backupPointName String
    Set a backup name for the full backup created before changes.
    blueGreenRole String
    Blue-green deployment role of the instance. Valid values: Blue: blue instance. Green: green instance. This parameter is returned only for Redis instances that have used the blue-green deployment feature.
    capacity InstanceCapacity
    Capacity information of the instance.
    chargeType String
    Instance billing type. Value options: PrePaid: Subscription (also called prepaid). PostPaid: Pay-as-you-go (also called postpaid).
    configureNodes List<InstanceConfigureNode>
    createBackup Boolean
    Whether to create a backup before making changes.
    createTime String
    Creation time of the instance.
    dataLayout String
    Data storage type of the instance. This parameter is only relevant for Enterprise Edition instances (ServiceType=Enterprise). Community Edition instances (ServiceType=Basic) do not involve data storage type, and DataLayout is always set to RAM. If this parameter is left empty, data storage type is not used as a filter.
    deletionProtection String
    Enable or disable instance deletion protection.
    engineVersion String
    Database version number.
    expiredTime String
    Instance expiration time.
    instanceClass String
    Type of Redis instance. Valid values: PrimarySecondary: primary-secondary instance; Standalone: single-node instance. If this parameter is left empty, instance type is not used as a filter. For more information about instance types, see Product Architecture.
    instanceId String
    Instance ID.
    instanceName String
    Instance name. Naming rules: Cannot start with a digit or hyphen (-); can only contain Chinese characters, letters, digits, underscores (_), and hyphens (-); length must be 1–128 characters.
    instanceShards List<InstanceInstanceShard>
    maintenanceTime String
    Maintenance window for the instance, format: HH:mm-HH:mm (UTC+8).
    maxConnections Integer
    Current maximum connections per shard for the instance. The default connection limit per shard is 10,000. You can also call the ModifyDBInstanceMaxConn API to adjust the maximum connections per shard based on your business needs.
    multiAz String
    Set the deployment scheme for the instance's availability zone.
    noAuthMode String
    Enable or disable password-free access for new instances. Valid values: open: enable password-free access; close (default): disable password-free access.
    nodeIds List<String>
    List of Proxy and Server node IDs.
    nodeNumber Integer
    Number of nodes in each shard. Value range: 1–6. By default, each account can create up to 4 nodes of 256 MiB specification per region. To increase the quota limit to 10, see Account Quotas. A value of 1 creates a single-node instance; a value greater than 1 creates a primary-secondary instance. For details on the differences between these two types of instances, see Feature Differences.
    parameterGroupId String
    The parameter template to be applied to the new instance. Redis for Cache Database creates a default system parameter template for each database version, which includes all parameters supported by that version and their default values. If this parameter is left blank, the system will select and apply the corresponding version's system parameter template for the new instance based on the database version you set (i.e., EngineVersion). You can call the DescribeParameterGroups API to query basic information about all parameter templates under your account and region, including the parameter template ID.
    password String
    Set the password for the default account of the default database.
    port Integer
    Custom port number for the private network connection address. Value range: 1024~65535. If this parameter is left blank, the private network connection address uses port 6379 by default. After the instance is created, you can also modify the port number of the private network address. For instructions, see Modify Port Number.
    privateAddress String
    The domain name for the instance's private network connection address.
    privatePort String
    Port number for the instance's private network connection address.
    projectName String
    Project to which the instance belongs.
    purchaseMonths Integer
    Purchase duration, unit: month. Value options: Monthly purchase: 1, 2, 3, 4, 5, 6, 7, 8, 9. Annual purchase: 12, 24, 36. When ChargeType is PrePaid, this parameter is required.
    reserveAdditionalBandwidth Boolean
    Set whether to reserve additional bandwidth
    serviceType String
    Service type of the instance
    shardCapacity Integer
    Memory capacity of each shard in the instance. Unit: MiB.
    shardNumber Integer
    Number of shards in the instance. Value range: 2–256. Specify this parameter only when ShardedCluster is set to 1 (enabled).
    shardedCluster Integer
    Whether to enable sharded cluster. Value options: 0: Disabled. 1: Enabled.
    status String
    Service type of the instance. Value options: Basic (default): Community Edition; Enterprise: Enterprise Edition.
    subnetId String
    Set the subnet ID for the instance. Subnets have availability zone attributes; you must select a subnet in the target private network that belongs to the same availability zone as the instance. A subnet is an IP address block within a private network. All cloud resources in the private network must be deployed in a subnet. The subnet assigns private IP addresses to cloud resources. You can call the CreateSubnet API to create a subnet. You can call the DescribeSubnets API to query the list of all subnets in a specified availability zone, including subnet IDs.
    tags List<InstanceTag>
    viPv6 String
    The IPv6 address corresponding to the instance's private network connection address. This parameter is returned only if the instance uses an IPv6 address.
    vip String
    IPv4 address corresponding to the instance's private network connection address.
    visitAddrs List<InstanceVisitAddr>
    vpcAuthMode String
    Enable or disable password-free access. Valid values: open: enable password-free access; close: disable password-free access. Values are case-insensitive.
    vpcId String
    Set the private network ID for the instance. It is recommended that the Redis instance and the ECS instance you want to connect to are in the same private network; otherwise, they cannot communicate optimally via the internal network. You can call the CreateVpc API to create a private network. You can call the DescribeVpcs API to query private network information that meets specified conditions, including the private network ID.
    zoneIds List<String>
    List of available zones where the instance is located.
    allowListIds string[]
    Allowlist ID list. If left empty, the new instance will not be added to any allowlist by default. You can call the DescribeAllowLists API to query all IP allowlist information, including allowlist IDs, for the specified region under your account. Each instance supports binding up to 100 allowlists, and you can batch bind up to 100 allowlists at a time. Each instance supports binding up to 1000 IP addresses or CIDR-format IP address ranges.
    autoRenew boolean
    Whether to enable auto-renewal. Value options: false (default): Disabled; true: Enabled.
    backupPointName string
    Set a backup name for the full backup created before changes.
    blueGreenRole string
    Blue-green deployment role of the instance. Valid values: Blue: blue instance. Green: green instance. This parameter is returned only for Redis instances that have used the blue-green deployment feature.
    capacity InstanceCapacity
    Capacity information of the instance.
    chargeType string
    Instance billing type. Value options: PrePaid: Subscription (also called prepaid). PostPaid: Pay-as-you-go (also called postpaid).
    configureNodes InstanceConfigureNode[]
    createBackup boolean
    Whether to create a backup before making changes.
    createTime string
    Creation time of the instance.
    dataLayout string
    Data storage type of the instance. This parameter is only relevant for Enterprise Edition instances (ServiceType=Enterprise). Community Edition instances (ServiceType=Basic) do not involve data storage type, and DataLayout is always set to RAM. If this parameter is left empty, data storage type is not used as a filter.
    deletionProtection string
    Enable or disable instance deletion protection.
    engineVersion string
    Database version number.
    expiredTime string
    Instance expiration time.
    instanceClass string
    Type of Redis instance. Valid values: PrimarySecondary: primary-secondary instance; Standalone: single-node instance. If this parameter is left empty, instance type is not used as a filter. For more information about instance types, see Product Architecture.
    instanceId string
    Instance ID.
    instanceName string
    Instance name. Naming rules: Cannot start with a digit or hyphen (-); can only contain Chinese characters, letters, digits, underscores (_), and hyphens (-); length must be 1–128 characters.
    instanceShards InstanceInstanceShard[]
    maintenanceTime string
    Maintenance window for the instance, format: HH:mm-HH:mm (UTC+8).
    maxConnections number
    Current maximum connections per shard for the instance. The default connection limit per shard is 10,000. You can also call the ModifyDBInstanceMaxConn API to adjust the maximum connections per shard based on your business needs.
    multiAz string
    Set the deployment scheme for the instance's availability zone.
    noAuthMode string
    Enable or disable password-free access for new instances. Valid values: open: enable password-free access; close (default): disable password-free access.
    nodeIds string[]
    List of Proxy and Server node IDs.
    nodeNumber number
    Number of nodes in each shard. Value range: 1–6. By default, each account can create up to 4 nodes of 256 MiB specification per region. To increase the quota limit to 10, see Account Quotas. A value of 1 creates a single-node instance; a value greater than 1 creates a primary-secondary instance. For details on the differences between these two types of instances, see Feature Differences.
    parameterGroupId string
    The parameter template to be applied to the new instance. Redis for Cache Database creates a default system parameter template for each database version, which includes all parameters supported by that version and their default values. If this parameter is left blank, the system will select and apply the corresponding version's system parameter template for the new instance based on the database version you set (i.e., EngineVersion). You can call the DescribeParameterGroups API to query basic information about all parameter templates under your account and region, including the parameter template ID.
    password string
    Set the password for the default account of the default database.
    port number
    Custom port number for the private network connection address. Value range: 1024~65535. If this parameter is left blank, the private network connection address uses port 6379 by default. After the instance is created, you can also modify the port number of the private network address. For instructions, see Modify Port Number.
    privateAddress string
    The domain name for the instance's private network connection address.
    privatePort string
    Port number for the instance's private network connection address.
    projectName string
    Project to which the instance belongs.
    purchaseMonths number
    Purchase duration, unit: month. Value options: Monthly purchase: 1, 2, 3, 4, 5, 6, 7, 8, 9. Annual purchase: 12, 24, 36. When ChargeType is PrePaid, this parameter is required.
    reserveAdditionalBandwidth boolean
    Set whether to reserve additional bandwidth
    serviceType string
    Service type of the instance
    shardCapacity number
    Memory capacity of each shard in the instance. Unit: MiB.
    shardNumber number
    Number of shards in the instance. Value range: 2–256. Specify this parameter only when ShardedCluster is set to 1 (enabled).
    shardedCluster number
    Whether to enable sharded cluster. Value options: 0: Disabled. 1: Enabled.
    status string
    Service type of the instance. Value options: Basic (default): Community Edition; Enterprise: Enterprise Edition.
    subnetId string
    Set the subnet ID for the instance. Subnets have availability zone attributes; you must select a subnet in the target private network that belongs to the same availability zone as the instance. A subnet is an IP address block within a private network. All cloud resources in the private network must be deployed in a subnet. The subnet assigns private IP addresses to cloud resources. You can call the CreateSubnet API to create a subnet. You can call the DescribeSubnets API to query the list of all subnets in a specified availability zone, including subnet IDs.
    tags InstanceTag[]
    viPv6 string
    The IPv6 address corresponding to the instance's private network connection address. This parameter is returned only if the instance uses an IPv6 address.
    vip string
    IPv4 address corresponding to the instance's private network connection address.
    visitAddrs InstanceVisitAddr[]
    vpcAuthMode string
    Enable or disable password-free access. Valid values: open: enable password-free access; close: disable password-free access. Values are case-insensitive.
    vpcId string
    Set the private network ID for the instance. It is recommended that the Redis instance and the ECS instance you want to connect to are in the same private network; otherwise, they cannot communicate optimally via the internal network. You can call the CreateVpc API to create a private network. You can call the DescribeVpcs API to query private network information that meets specified conditions, including the private network ID.
    zoneIds string[]
    List of available zones where the instance is located.
    allow_list_ids Sequence[str]
    Allowlist ID list. If left empty, the new instance will not be added to any allowlist by default. You can call the DescribeAllowLists API to query all IP allowlist information, including allowlist IDs, for the specified region under your account. Each instance supports binding up to 100 allowlists, and you can batch bind up to 100 allowlists at a time. Each instance supports binding up to 1000 IP addresses or CIDR-format IP address ranges.
    auto_renew bool
    Whether to enable auto-renewal. Value options: false (default): Disabled; true: Enabled.
    backup_point_name str
    Set a backup name for the full backup created before changes.
    blue_green_role str
    Blue-green deployment role of the instance. Valid values: Blue: blue instance. Green: green instance. This parameter is returned only for Redis instances that have used the blue-green deployment feature.
    capacity InstanceCapacityArgs
    Capacity information of the instance.
    charge_type str
    Instance billing type. Value options: PrePaid: Subscription (also called prepaid). PostPaid: Pay-as-you-go (also called postpaid).
    configure_nodes Sequence[InstanceConfigureNodeArgs]
    create_backup bool
    Whether to create a backup before making changes.
    create_time str
    Creation time of the instance.
    data_layout str
    Data storage type of the instance. This parameter is only relevant for Enterprise Edition instances (ServiceType=Enterprise). Community Edition instances (ServiceType=Basic) do not involve data storage type, and DataLayout is always set to RAM. If this parameter is left empty, data storage type is not used as a filter.
    deletion_protection str
    Enable or disable instance deletion protection.
    engine_version str
    Database version number.
    expired_time str
    Instance expiration time.
    instance_class str
    Type of Redis instance. Valid values: PrimarySecondary: primary-secondary instance; Standalone: single-node instance. If this parameter is left empty, instance type is not used as a filter. For more information about instance types, see Product Architecture.
    instance_id str
    Instance ID.
    instance_name str
    Instance name. Naming rules: Cannot start with a digit or hyphen (-); can only contain Chinese characters, letters, digits, underscores (_), and hyphens (-); length must be 1–128 characters.
    instance_shards Sequence[InstanceInstanceShardArgs]
    maintenance_time str
    Maintenance window for the instance, format: HH:mm-HH:mm (UTC+8).
    max_connections int
    Current maximum connections per shard for the instance. The default connection limit per shard is 10,000. You can also call the ModifyDBInstanceMaxConn API to adjust the maximum connections per shard based on your business needs.
    multi_az str
    Set the deployment scheme for the instance's availability zone.
    no_auth_mode str
    Enable or disable password-free access for new instances. Valid values: open: enable password-free access; close (default): disable password-free access.
    node_ids Sequence[str]
    List of Proxy and Server node IDs.
    node_number int
    Number of nodes in each shard. Value range: 1–6. By default, each account can create up to 4 nodes of 256 MiB specification per region. To increase the quota limit to 10, see Account Quotas. A value of 1 creates a single-node instance; a value greater than 1 creates a primary-secondary instance. For details on the differences between these two types of instances, see Feature Differences.
    parameter_group_id str
    The parameter template to be applied to the new instance. Redis for Cache Database creates a default system parameter template for each database version, which includes all parameters supported by that version and their default values. If this parameter is left blank, the system will select and apply the corresponding version's system parameter template for the new instance based on the database version you set (i.e., EngineVersion). You can call the DescribeParameterGroups API to query basic information about all parameter templates under your account and region, including the parameter template ID.
    password str
    Set the password for the default account of the default database.
    port int
    Custom port number for the private network connection address. Value range: 1024~65535. If this parameter is left blank, the private network connection address uses port 6379 by default. After the instance is created, you can also modify the port number of the private network address. For instructions, see Modify Port Number.
    private_address str
    The domain name for the instance's private network connection address.
    private_port str
    Port number for the instance's private network connection address.
    project_name str
    Project to which the instance belongs.
    purchase_months int
    Purchase duration, unit: month. Value options: Monthly purchase: 1, 2, 3, 4, 5, 6, 7, 8, 9. Annual purchase: 12, 24, 36. When ChargeType is PrePaid, this parameter is required.
    reserve_additional_bandwidth bool
    Set whether to reserve additional bandwidth
    service_type str
    Service type of the instance
    shard_capacity int
    Memory capacity of each shard in the instance. Unit: MiB.
    shard_number int
    Number of shards in the instance. Value range: 2–256. Specify this parameter only when ShardedCluster is set to 1 (enabled).
    sharded_cluster int
    Whether to enable sharded cluster. Value options: 0: Disabled. 1: Enabled.
    status str
    Service type of the instance. Value options: Basic (default): Community Edition; Enterprise: Enterprise Edition.
    subnet_id str
    Set the subnet ID for the instance. Subnets have availability zone attributes; you must select a subnet in the target private network that belongs to the same availability zone as the instance. A subnet is an IP address block within a private network. All cloud resources in the private network must be deployed in a subnet. The subnet assigns private IP addresses to cloud resources. You can call the CreateSubnet API to create a subnet. You can call the DescribeSubnets API to query the list of all subnets in a specified availability zone, including subnet IDs.
    tags Sequence[InstanceTagArgs]
    vi_pv6 str
    The IPv6 address corresponding to the instance's private network connection address. This parameter is returned only if the instance uses an IPv6 address.
    vip str
    IPv4 address corresponding to the instance's private network connection address.
    visit_addrs Sequence[InstanceVisitAddrArgs]
    vpc_auth_mode str
    Enable or disable password-free access. Valid values: open: enable password-free access; close: disable password-free access. Values are case-insensitive.
    vpc_id str
    Set the private network ID for the instance. It is recommended that the Redis instance and the ECS instance you want to connect to are in the same private network; otherwise, they cannot communicate optimally via the internal network. You can call the CreateVpc API to create a private network. You can call the DescribeVpcs API to query private network information that meets specified conditions, including the private network ID.
    zone_ids Sequence[str]
    List of available zones where the instance is located.
    allowListIds List<String>
    Allowlist ID list. If left empty, the new instance will not be added to any allowlist by default. You can call the DescribeAllowLists API to query all IP allowlist information, including allowlist IDs, for the specified region under your account. Each instance supports binding up to 100 allowlists, and you can batch bind up to 100 allowlists at a time. Each instance supports binding up to 1000 IP addresses or CIDR-format IP address ranges.
    autoRenew Boolean
    Whether to enable auto-renewal. Value options: false (default): Disabled; true: Enabled.
    backupPointName String
    Set a backup name for the full backup created before changes.
    blueGreenRole String
    Blue-green deployment role of the instance. Valid values: Blue: blue instance. Green: green instance. This parameter is returned only for Redis instances that have used the blue-green deployment feature.
    capacity Property Map
    Capacity information of the instance.
    chargeType String
    Instance billing type. Value options: PrePaid: Subscription (also called prepaid). PostPaid: Pay-as-you-go (also called postpaid).
    configureNodes List<Property Map>
    createBackup Boolean
    Whether to create a backup before making changes.
    createTime String
    Creation time of the instance.
    dataLayout String
    Data storage type of the instance. This parameter is only relevant for Enterprise Edition instances (ServiceType=Enterprise). Community Edition instances (ServiceType=Basic) do not involve data storage type, and DataLayout is always set to RAM. If this parameter is left empty, data storage type is not used as a filter.
    deletionProtection String
    Enable or disable instance deletion protection.
    engineVersion String
    Database version number.
    expiredTime String
    Instance expiration time.
    instanceClass String
    Type of Redis instance. Valid values: PrimarySecondary: primary-secondary instance; Standalone: single-node instance. If this parameter is left empty, instance type is not used as a filter. For more information about instance types, see Product Architecture.
    instanceId String
    Instance ID.
    instanceName String
    Instance name. Naming rules: Cannot start with a digit or hyphen (-); can only contain Chinese characters, letters, digits, underscores (_), and hyphens (-); length must be 1–128 characters.
    instanceShards List<Property Map>
    maintenanceTime String
    Maintenance window for the instance, format: HH:mm-HH:mm (UTC+8).
    maxConnections Number
    Current maximum connections per shard for the instance. The default connection limit per shard is 10,000. You can also call the ModifyDBInstanceMaxConn API to adjust the maximum connections per shard based on your business needs.
    multiAz String
    Set the deployment scheme for the instance's availability zone.
    noAuthMode String
    Enable or disable password-free access for new instances. Valid values: open: enable password-free access; close (default): disable password-free access.
    nodeIds List<String>
    List of Proxy and Server node IDs.
    nodeNumber Number
    Number of nodes in each shard. Value range: 1–6. By default, each account can create up to 4 nodes of 256 MiB specification per region. To increase the quota limit to 10, see Account Quotas. A value of 1 creates a single-node instance; a value greater than 1 creates a primary-secondary instance. For details on the differences between these two types of instances, see Feature Differences.
    parameterGroupId String
    The parameter template to be applied to the new instance. Redis for Cache Database creates a default system parameter template for each database version, which includes all parameters supported by that version and their default values. If this parameter is left blank, the system will select and apply the corresponding version's system parameter template for the new instance based on the database version you set (i.e., EngineVersion). You can call the DescribeParameterGroups API to query basic information about all parameter templates under your account and region, including the parameter template ID.
    password String
    Set the password for the default account of the default database.
    port Number
    Custom port number for the private network connection address. Value range: 1024~65535. If this parameter is left blank, the private network connection address uses port 6379 by default. After the instance is created, you can also modify the port number of the private network address. For instructions, see Modify Port Number.
    privateAddress String
    The domain name for the instance's private network connection address.
    privatePort String
    Port number for the instance's private network connection address.
    projectName String
    Project to which the instance belongs.
    purchaseMonths Number
    Purchase duration, unit: month. Value options: Monthly purchase: 1, 2, 3, 4, 5, 6, 7, 8, 9. Annual purchase: 12, 24, 36. When ChargeType is PrePaid, this parameter is required.
    reserveAdditionalBandwidth Boolean
    Set whether to reserve additional bandwidth
    serviceType String
    Service type of the instance
    shardCapacity Number
    Memory capacity of each shard in the instance. Unit: MiB.
    shardNumber Number
    Number of shards in the instance. Value range: 2–256. Specify this parameter only when ShardedCluster is set to 1 (enabled).
    shardedCluster Number
    Whether to enable sharded cluster. Value options: 0: Disabled. 1: Enabled.
    status String
    Service type of the instance. Value options: Basic (default): Community Edition; Enterprise: Enterprise Edition.
    subnetId String
    Set the subnet ID for the instance. Subnets have availability zone attributes; you must select a subnet in the target private network that belongs to the same availability zone as the instance. A subnet is an IP address block within a private network. All cloud resources in the private network must be deployed in a subnet. The subnet assigns private IP addresses to cloud resources. You can call the CreateSubnet API to create a subnet. You can call the DescribeSubnets API to query the list of all subnets in a specified availability zone, including subnet IDs.
    tags List<Property Map>
    viPv6 String
    The IPv6 address corresponding to the instance's private network connection address. This parameter is returned only if the instance uses an IPv6 address.
    vip String
    IPv4 address corresponding to the instance's private network connection address.
    visitAddrs List<Property Map>
    vpcAuthMode String
    Enable or disable password-free access. Valid values: open: enable password-free access; close: disable password-free access. Values are case-insensitive.
    vpcId String
    Set the private network ID for the instance. It is recommended that the Redis instance and the ECS instance you want to connect to are in the same private network; otherwise, they cannot communicate optimally via the internal network. You can call the CreateVpc API to create a private network. You can call the DescribeVpcs API to query private network information that meets specified conditions, including the private network ID.
    zoneIds List<String>
    List of available zones where the instance is located.

    Supporting Types

    InstanceCapacity, InstanceCapacityArgs

    Total int
    Total memory capacity of the current instance. Unit: MiB.
    Used int
    Used capacity of the current instance. Unit: MiB.
    Total int
    Total memory capacity of the current instance. Unit: MiB.
    Used int
    Used capacity of the current instance. Unit: MiB.
    total Integer
    Total memory capacity of the current instance. Unit: MiB.
    used Integer
    Used capacity of the current instance. Unit: MiB.
    total number
    Total memory capacity of the current instance. Unit: MiB.
    used number
    Used capacity of the current instance. Unit: MiB.
    total int
    Total memory capacity of the current instance. Unit: MiB.
    used int
    Used capacity of the current instance. Unit: MiB.
    total Number
    Total memory capacity of the current instance. Unit: MiB.
    used Number
    Used capacity of the current instance. Unit: MiB.

    InstanceConfigureNode, InstanceConfigureNodeArgs

    Az string
    The availability zone each node belongs to.
    Az string
    The availability zone each node belongs to.
    az String
    The availability zone each node belongs to.
    az string
    The availability zone each node belongs to.
    az str
    The availability zone each node belongs to.
    az String
    The availability zone each node belongs to.

    InstanceInstanceShard, InstanceInstanceShardArgs

    NodeNumber int
    Number of nodes in each shard
    ServerNodes []InstanceInstanceShardServerNode
    ShardId string
    Shard ID.
    nodeNumber Integer
    Number of nodes in each shard
    serverNodes List<InstanceInstanceShardServerNode>
    shardId String
    Shard ID.
    nodeNumber number
    Number of nodes in each shard
    serverNodes InstanceInstanceShardServerNode[]
    shardId string
    Shard ID.
    nodeNumber Number
    Number of nodes in each shard
    serverNodes List<Property Map>
    shardId String
    Shard ID.

    InstanceInstanceShardServerNode, InstanceInstanceShardServerNodeArgs

    CurrentRole string
    Current role of the node. Valid values: PrimaryNode: primary node; SecondaryNode: secondary node.
    NodeId string
    Node ID.
    Status string
    Node status. Valid values: deploy: starting; running: running; loading: loading data; error: error.
    ZoneId string
    Availability zone where the node is located.
    CurrentRole string
    Current role of the node. Valid values: PrimaryNode: primary node; SecondaryNode: secondary node.
    NodeId string
    Node ID.
    Status string
    Node status. Valid values: deploy: starting; running: running; loading: loading data; error: error.
    ZoneId string
    Availability zone where the node is located.
    currentRole String
    Current role of the node. Valid values: PrimaryNode: primary node; SecondaryNode: secondary node.
    nodeId String
    Node ID.
    status String
    Node status. Valid values: deploy: starting; running: running; loading: loading data; error: error.
    zoneId String
    Availability zone where the node is located.
    currentRole string
    Current role of the node. Valid values: PrimaryNode: primary node; SecondaryNode: secondary node.
    nodeId string
    Node ID.
    status string
    Node status. Valid values: deploy: starting; running: running; loading: loading data; error: error.
    zoneId string
    Availability zone where the node is located.
    current_role str
    Current role of the node. Valid values: PrimaryNode: primary node; SecondaryNode: secondary node.
    node_id str
    Node ID.
    status str
    Node status. Valid values: deploy: starting; running: running; loading: loading data; error: error.
    zone_id str
    Availability zone where the node is located.
    currentRole String
    Current role of the node. Valid values: PrimaryNode: primary node; SecondaryNode: secondary node.
    nodeId String
    Node ID.
    status String
    Node status. Valid values: deploy: starting; running: running; loading: loading data; error: error.
    zoneId String
    Availability zone where the node is located.

    InstanceTag, InstanceTagArgs

    Key string
    Tag key.
    Value string
    Tag value.
    Key string
    Tag key.
    Value string
    Tag value.
    key String
    Tag key.
    value String
    Tag value.
    key string
    Tag key.
    value string
    Tag value.
    key str
    Tag key.
    value str
    Tag value.
    key String
    Tag key.
    value String
    Tag value.

    InstanceVisitAddr, InstanceVisitAddrArgs

    AddrType string
    Connection address type. Value options: Private: Private network connection address; Public: Public network connection address; DirectLink: Direct connection address.
    Address string
    IP address or domain name.
    EipId string
    EIP ID bound to the instance's public address. This parameter is returned only when the connection address type (AddrType) is Public.
    Port string
    Port number.
    ViPv6 string
    IPv6 address corresponding to the connection address.
    Vip string
    The IPv4 address corresponding to the connection address.
    AddrType string
    Connection address type. Value options: Private: Private network connection address; Public: Public network connection address; DirectLink: Direct connection address.
    Address string
    IP address or domain name.
    EipId string
    EIP ID bound to the instance's public address. This parameter is returned only when the connection address type (AddrType) is Public.
    Port string
    Port number.
    ViPv6 string
    IPv6 address corresponding to the connection address.
    Vip string
    The IPv4 address corresponding to the connection address.
    addrType String
    Connection address type. Value options: Private: Private network connection address; Public: Public network connection address; DirectLink: Direct connection address.
    address String
    IP address or domain name.
    eipId String
    EIP ID bound to the instance's public address. This parameter is returned only when the connection address type (AddrType) is Public.
    port String
    Port number.
    viPv6 String
    IPv6 address corresponding to the connection address.
    vip String
    The IPv4 address corresponding to the connection address.
    addrType string
    Connection address type. Value options: Private: Private network connection address; Public: Public network connection address; DirectLink: Direct connection address.
    address string
    IP address or domain name.
    eipId string
    EIP ID bound to the instance's public address. This parameter is returned only when the connection address type (AddrType) is Public.
    port string
    Port number.
    viPv6 string
    IPv6 address corresponding to the connection address.
    vip string
    The IPv4 address corresponding to the connection address.
    addr_type str
    Connection address type. Value options: Private: Private network connection address; Public: Public network connection address; DirectLink: Direct connection address.
    address str
    IP address or domain name.
    eip_id str
    EIP ID bound to the instance's public address. This parameter is returned only when the connection address type (AddrType) is Public.
    port str
    Port number.
    vi_pv6 str
    IPv6 address corresponding to the connection address.
    vip str
    The IPv4 address corresponding to the connection address.
    addrType String
    Connection address type. Value options: Private: Private network connection address; Public: Public network connection address; DirectLink: Direct connection address.
    address String
    IP address or domain name.
    eipId String
    EIP ID bound to the instance's public address. This parameter is returned only when the connection address type (AddrType) is Public.
    port String
    Port number.
    viPv6 String
    IPv6 address corresponding to the connection address.
    vip String
    The IPv4 address corresponding to the connection address.

    Import

    $ pulumi import volcenginecc:redis/instance:Instance example "instance_id"

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    volcenginecc volcengine/pulumi-volcenginecc
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the volcenginecc Terraform Provider.
    volcenginecc logo
    Viewing docs for volcenginecc v0.0.32
    published on Thursday, Apr 23, 2026 by Volcengine
    Schema (JSON)
    volcengine/pulumi-volcenginecc
      Try Pulumi Cloud free. Your team will thank you.