1. Packages
  2. Volcenginecc Provider
  3. API Docs
  4. redis
  5. Instance
volcenginecc v0.0.3 published on Thursday, Oct 30, 2025 by Volcengine
volcengine/pulumi-volcenginecc

volcenginecc.redis.Instance

Get Started
volcenginecc logo
volcenginecc v0.0.3 published on Thursday, Oct 30, 2025 by Volcengine
volcengine/pulumi-volcenginecc

    缓存数据库 Redis 版的基本单位是实例。实例是独立的、虚拟化的数据库运行环境，是多个数据节点与代理节点的集合，数据节点上运行 Redis 引擎。

    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.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var exampleinstanceResourceResourceFromRedisinstance = new Volcenginecc.Redis.Instance("exampleinstanceResourceResourceFromRedisinstance", new()
{
    MultiAz = "string",
    VpcId = "string",
    SubnetId = "string",
    ShardedCluster = 0,
    ConfigureNodes = new[]
    {
        new Volcenginecc.Redis.Inputs.InstanceConfigureNodeArgs
        {
            Az = "string",
        },
    },
    ShardCapacity = 0,
    NodeNumber = 0,
    EngineVersion = "string",
    DeletionProtection = "string",
    ProjectName = "string",
    NoAuthMode = "string",
    AllowListIds = new[]
    {
        "string",
    },
    ParameterGroupId = "string",
    Password = "string",
    Port = 0,
    InstanceName = "string",
    PurchaseMonths = 0,
    ReserveAdditionalBandwidth = false,
    CreateBackup = false,
    ShardNumber = 0,
    ChargeType = "string",
    BackupPointName = "string",
    Tags = new[]
    {
        new Volcenginecc.Redis.Inputs.InstanceTagArgs
        {
            Key = "string",
            Value = "string",
        },
    },
    AutoRenew = false,
});

    example, err := redis.NewInstance(ctx, "exampleinstanceResourceResourceFromRedisinstance", &redis.InstanceArgs{
	MultiAz:        pulumi.String("string"),
	VpcId:          pulumi.String("string"),
	SubnetId:       pulumi.String("string"),
	ShardedCluster: pulumi.Int(0),
	ConfigureNodes: redis.InstanceConfigureNodeArray{
		&redis.InstanceConfigureNodeArgs{
			Az: pulumi.String("string"),
		},
	},
	ShardCapacity:      pulumi.Int(0),
	NodeNumber:         pulumi.Int(0),
	EngineVersion:      pulumi.String("string"),
	DeletionProtection: pulumi.String("string"),
	ProjectName:        pulumi.String("string"),
	NoAuthMode:         pulumi.String("string"),
	AllowListIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	ParameterGroupId:           pulumi.String("string"),
	Password:                   pulumi.String("string"),
	Port:                       pulumi.Int(0),
	InstanceName:               pulumi.String("string"),
	PurchaseMonths:             pulumi.Int(0),
	ReserveAdditionalBandwidth: pulumi.Bool(false),
	CreateBackup:               pulumi.Bool(false),
	ShardNumber:                pulumi.Int(0),
	ChargeType:                 pulumi.String("string"),
	BackupPointName:            pulumi.String("string"),
	Tags: redis.InstanceTagArray{
		&redis.InstanceTagArgs{
			Key:   pulumi.String("string"),
			Value: pulumi.String("string"),
		},
	},
	AutoRenew: pulumi.Bool(false),
})

    var exampleinstanceResourceResourceFromRedisinstance = new com.volcengine.volcenginecc.redis.Instance("exampleinstanceResourceResourceFromRedisinstance", com.volcengine.volcenginecc.redis.InstanceArgs.builder()
    .multiAz("string")
    .vpcId("string")
    .subnetId("string")
    .shardedCluster(0)
    .configureNodes(InstanceConfigureNodeArgs.builder()
        .az("string")
        .build())
    .shardCapacity(0)
    .nodeNumber(0)
    .engineVersion("string")
    .deletionProtection("string")
    .projectName("string")
    .noAuthMode("string")
    .allowListIds("string")
    .parameterGroupId("string")
    .password("string")
    .port(0)
    .instanceName("string")
    .purchaseMonths(0)
    .reserveAdditionalBandwidth(false)
    .createBackup(false)
    .shardNumber(0)
    .chargeType("string")
    .backupPointName("string")
    .tags(InstanceTagArgs.builder()
        .key("string")
        .value("string")
        .build())
    .autoRenew(false)
    .build());

    exampleinstance_resource_resource_from_redisinstance = volcenginecc.redis.Instance("exampleinstanceResourceResourceFromRedisinstance",
    multi_az="string",
    vpc_id="string",
    subnet_id="string",
    sharded_cluster=0,
    configure_nodes=[{
        "az": "string",
    }],
    shard_capacity=0,
    node_number=0,
    engine_version="string",
    deletion_protection="string",
    project_name="string",
    no_auth_mode="string",
    allow_list_ids=["string"],
    parameter_group_id="string",
    password="string",
    port=0,
    instance_name="string",
    purchase_months=0,
    reserve_additional_bandwidth=False,
    create_backup=False,
    shard_number=0,
    charge_type="string",
    backup_point_name="string",
    tags=[{
        "key": "string",
        "value": "string",
    }],
    auto_renew=False)

    const exampleinstanceResourceResourceFromRedisinstance = new volcenginecc.redis.Instance("exampleinstanceResourceResourceFromRedisinstance", {
    multiAz: "string",
    vpcId: "string",
    subnetId: "string",
    shardedCluster: 0,
    configureNodes: [{
        az: "string",
    }],
    shardCapacity: 0,
    nodeNumber: 0,
    engineVersion: "string",
    deletionProtection: "string",
    projectName: "string",
    noAuthMode: "string",
    allowListIds: ["string"],
    parameterGroupId: "string",
    password: "string",
    port: 0,
    instanceName: "string",
    purchaseMonths: 0,
    reserveAdditionalBandwidth: false,
    createBackup: false,
    shardNumber: 0,
    chargeType: "string",
    backupPointName: "string",
    tags: [{
        key: "string",
        value: "string",
    }],
    autoRenew: false,
});

    type: volcenginecc:redis:Instance
properties:
    allowListIds:
        - string
    autoRenew: false
    backupPointName: string
    chargeType: string
    configureNodes:
        - az: string
    createBackup: false
    deletionProtection: string
    engineVersion: string
    instanceName: string
    multiAz: string
    noAuthMode: string
    nodeNumber: 0
    parameterGroupId: string
    password: string
    port: 0
    projectName: string
    purchaseMonths: 0
    reserveAdditionalBandwidth: false
    shardCapacity: 0
    shardNumber: 0
    shardedCluster: 0
    subnetId: string
    tags:
        - key: string
          value: string
    vpcId: string

    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
    数据库版本号。
    MultiAz string
    设置实例的可用区部署方案。
    NodeNumber int
    每个分片中的节点数。取值范围为1~6。每个账号在每个地域下默认最多可创建4个256MiB规格的节点，若需要调整配额上限为10个，请参见账号配额。取值为1时表示创建单节点实例；取值大于1时表示创建主备实例。关于两种类型实例的功能特性差异详情，请参见功能特性差异。
    ShardCapacity int
    实例中每个分片的内存容量。单位：MiB。
    ShardedCluster int
    是否启用分片集群。取值范围如下：0：不启用。1：启用。
    SubnetId string
    设置实例的子网ID。子网具有可用区属性，必须选择目标私有网络中与实例属于同一可用区下的子网。子网是私有网络内的IP地址块私有网络中的所有云资源都必须部署在子网内，子网为云资源分配私网IP地址，您可以调用CreateSubnet接口创建子网。您可以调用DescribeSubnets接口查询指定可用区内的所有子网列表信息，包括子网ID。
    VpcId string
    设置实例的私有网络ID。建议Redis实例与需要连接的ECS实例在同一私有网络，否则它们无法通过内网互通来实现最佳性能。您可以调用CreateVpc接口创建私有网络。您可以调用DescribeVpcs接口查询符合指定条件的私有网络信息，包括私有网络ID。
    AllowListIds List<string>
    白名单 ID 列表。若该参数留空，新建实例默认不加入任何白名单。您可以调用 DescribeAllowLists 接口查询当前账号下指定地域内的所有 IP 白名单信息，包括白名单 ID 信息。每个实例最多支持绑定 100 个白名单，每次可最多批量绑定 100 个白名单。每个实例最多支持绑定 1000 个 IP 地址或 CIDR 格式的 IP 地址段。
    AutoRenew bool
    是否开启自动续费。取值范围如下：false（默认值）：不开启。true：开启。
    BackupPointName string
    为变更前创建的全量备份设置备份名称。
    ChargeType string
    实例计费类型。取值范围如下：PrePaid：包年包月（也称预付费）。PostPaid：按量计费（也称后付费）。
    CreateBackup bool
    是否在变更前创建备份。
    DeletionProtection string
    开启或关闭实例删除保护功能。
    InstanceName string
    实例名称。命名规则：不能以数字、中划线（-）开头；只能包含中文、字母、数字、下划线（_）和中划线（-）；长度需要在1~128个字符内。
    NoAuthMode string
    为新建实例开启或关闭免密访问功能。取值范围如下：open：开启免密访问。close（默认值）：关闭免密访问。
    ParameterGroupId string
    需要应用到新实例的参数模板。缓存数据库 Redis 版为每个数据库版本都创建了一份默认的系统参数模板，模板中包含了该版本支持设置的所有参数和默认参数值。若该参数留空，默认会根据您设置的数据库版本（即 EngineVersion）为新建实例选择并应用对应版本的系统参数模板。您可以调用 DescribeParameterGroups 接口查询当前账号和地域下的所有参数模板的基本信息，包括参数模板 ID。
    Password string
    设置默认数据库 default 账号的密码。
    Port int
    自定义私网连接地址的端口号。取值范围：1024~65535。若该参数留空，私网连接地址默认使用6379端口。实例创建成功后，还可以修改私网地址的端口号，修改方法请参见修改端口号。
    ProjectName string
    实例所属的项目。
    PurchaseMonths int
    购买时长，单位：月。取值范围如下：按月购买：1，2，3，4，5，6，7，8，9。按年购买：12，24，36。当ChargeType为PrePaid时，该参数必填。
    ReserveAdditionalBandwidth bool
    设置是否保留额外带宽
    ShardNumber int
    实例中的分片数量。取值范围为 2~256。仅当 ShardedCluster 取值为 1（即启用分片集群）时，需要指定该参数。
    Tags List<Volcengine.InstanceTag>
    ConfigureNodes []InstanceConfigureNodeArgs
    EngineVersion string
    数据库版本号。
    MultiAz string
    设置实例的可用区部署方案。
    NodeNumber int
    每个分片中的节点数。取值范围为1~6。每个账号在每个地域下默认最多可创建4个256MiB规格的节点，若需要调整配额上限为10个，请参见账号配额。取值为1时表示创建单节点实例；取值大于1时表示创建主备实例。关于两种类型实例的功能特性差异详情，请参见功能特性差异。
    ShardCapacity int
    实例中每个分片的内存容量。单位：MiB。
    ShardedCluster int
    是否启用分片集群。取值范围如下：0：不启用。1：启用。
    SubnetId string
    设置实例的子网ID。子网具有可用区属性，必须选择目标私有网络中与实例属于同一可用区下的子网。子网是私有网络内的IP地址块私有网络中的所有云资源都必须部署在子网内，子网为云资源分配私网IP地址，您可以调用CreateSubnet接口创建子网。您可以调用DescribeSubnets接口查询指定可用区内的所有子网列表信息，包括子网ID。
    VpcId string
    设置实例的私有网络ID。建议Redis实例与需要连接的ECS实例在同一私有网络，否则它们无法通过内网互通来实现最佳性能。您可以调用CreateVpc接口创建私有网络。您可以调用DescribeVpcs接口查询符合指定条件的私有网络信息，包括私有网络ID。
    AllowListIds []string
    白名单 ID 列表。若该参数留空，新建实例默认不加入任何白名单。您可以调用 DescribeAllowLists 接口查询当前账号下指定地域内的所有 IP 白名单信息，包括白名单 ID 信息。每个实例最多支持绑定 100 个白名单，每次可最多批量绑定 100 个白名单。每个实例最多支持绑定 1000 个 IP 地址或 CIDR 格式的 IP 地址段。
    AutoRenew bool
    是否开启自动续费。取值范围如下：false（默认值）：不开启。true：开启。
    BackupPointName string
    为变更前创建的全量备份设置备份名称。
    ChargeType string
    实例计费类型。取值范围如下：PrePaid：包年包月（也称预付费）。PostPaid：按量计费（也称后付费）。
    CreateBackup bool
    是否在变更前创建备份。
    DeletionProtection string
    开启或关闭实例删除保护功能。
    InstanceName string
    实例名称。命名规则：不能以数字、中划线（-）开头；只能包含中文、字母、数字、下划线（_）和中划线（-）；长度需要在1~128个字符内。
    NoAuthMode string
    为新建实例开启或关闭免密访问功能。取值范围如下：open：开启免密访问。close（默认值）：关闭免密访问。
    ParameterGroupId string
    需要应用到新实例的参数模板。缓存数据库 Redis 版为每个数据库版本都创建了一份默认的系统参数模板，模板中包含了该版本支持设置的所有参数和默认参数值。若该参数留空，默认会根据您设置的数据库版本（即 EngineVersion）为新建实例选择并应用对应版本的系统参数模板。您可以调用 DescribeParameterGroups 接口查询当前账号和地域下的所有参数模板的基本信息，包括参数模板 ID。
    Password string
    设置默认数据库 default 账号的密码。
    Port int
    自定义私网连接地址的端口号。取值范围：1024~65535。若该参数留空，私网连接地址默认使用6379端口。实例创建成功后，还可以修改私网地址的端口号，修改方法请参见修改端口号。
    ProjectName string
    实例所属的项目。
    PurchaseMonths int
    购买时长，单位：月。取值范围如下：按月购买：1，2，3，4，5，6，7，8，9。按年购买：12，24，36。当ChargeType为PrePaid时，该参数必填。
    ReserveAdditionalBandwidth bool
    设置是否保留额外带宽
    ShardNumber int
    实例中的分片数量。取值范围为 2~256。仅当 ShardedCluster 取值为 1（即启用分片集群）时，需要指定该参数。
    Tags []InstanceTagArgs
    configureNodes List<InstanceConfigureNode>
    engineVersion String
    数据库版本号。
    multiAz String
    设置实例的可用区部署方案。
    nodeNumber Integer
    每个分片中的节点数。取值范围为1~6。每个账号在每个地域下默认最多可创建4个256MiB规格的节点，若需要调整配额上限为10个，请参见账号配额。取值为1时表示创建单节点实例；取值大于1时表示创建主备实例。关于两种类型实例的功能特性差异详情，请参见功能特性差异。
    shardCapacity Integer
    实例中每个分片的内存容量。单位：MiB。
    shardedCluster Integer
    是否启用分片集群。取值范围如下：0：不启用。1：启用。
    subnetId String
    设置实例的子网ID。子网具有可用区属性，必须选择目标私有网络中与实例属于同一可用区下的子网。子网是私有网络内的IP地址块私有网络中的所有云资源都必须部署在子网内，子网为云资源分配私网IP地址，您可以调用CreateSubnet接口创建子网。您可以调用DescribeSubnets接口查询指定可用区内的所有子网列表信息，包括子网ID。
    vpcId String
    设置实例的私有网络ID。建议Redis实例与需要连接的ECS实例在同一私有网络，否则它们无法通过内网互通来实现最佳性能。您可以调用CreateVpc接口创建私有网络。您可以调用DescribeVpcs接口查询符合指定条件的私有网络信息，包括私有网络ID。
    allowListIds List<String>
    白名单 ID 列表。若该参数留空，新建实例默认不加入任何白名单。您可以调用 DescribeAllowLists 接口查询当前账号下指定地域内的所有 IP 白名单信息，包括白名单 ID 信息。每个实例最多支持绑定 100 个白名单，每次可最多批量绑定 100 个白名单。每个实例最多支持绑定 1000 个 IP 地址或 CIDR 格式的 IP 地址段。
    autoRenew Boolean
    是否开启自动续费。取值范围如下：false（默认值）：不开启。true：开启。
    backupPointName String
    为变更前创建的全量备份设置备份名称。
    chargeType String
    实例计费类型。取值范围如下：PrePaid：包年包月（也称预付费）。PostPaid：按量计费（也称后付费）。
    createBackup Boolean
    是否在变更前创建备份。
    deletionProtection String
    开启或关闭实例删除保护功能。
    instanceName String
    实例名称。命名规则：不能以数字、中划线（-）开头；只能包含中文、字母、数字、下划线（_）和中划线（-）；长度需要在1~128个字符内。
    noAuthMode String
    为新建实例开启或关闭免密访问功能。取值范围如下：open：开启免密访问。close（默认值）：关闭免密访问。
    parameterGroupId String
    需要应用到新实例的参数模板。缓存数据库 Redis 版为每个数据库版本都创建了一份默认的系统参数模板，模板中包含了该版本支持设置的所有参数和默认参数值。若该参数留空，默认会根据您设置的数据库版本（即 EngineVersion）为新建实例选择并应用对应版本的系统参数模板。您可以调用 DescribeParameterGroups 接口查询当前账号和地域下的所有参数模板的基本信息，包括参数模板 ID。
    password String
    设置默认数据库 default 账号的密码。
    port Integer
    自定义私网连接地址的端口号。取值范围：1024~65535。若该参数留空，私网连接地址默认使用6379端口。实例创建成功后，还可以修改私网地址的端口号，修改方法请参见修改端口号。
    projectName String
    实例所属的项目。
    purchaseMonths Integer
    购买时长，单位：月。取值范围如下：按月购买：1，2，3，4，5，6，7，8，9。按年购买：12，24，36。当ChargeType为PrePaid时，该参数必填。
    reserveAdditionalBandwidth Boolean
    设置是否保留额外带宽
    shardNumber Integer
    实例中的分片数量。取值范围为 2~256。仅当 ShardedCluster 取值为 1（即启用分片集群）时，需要指定该参数。
    tags List<InstanceTag>
    configureNodes InstanceConfigureNode[]
    engineVersion string
    数据库版本号。
    multiAz string
    设置实例的可用区部署方案。
    nodeNumber number
    每个分片中的节点数。取值范围为1~6。每个账号在每个地域下默认最多可创建4个256MiB规格的节点，若需要调整配额上限为10个，请参见账号配额。取值为1时表示创建单节点实例；取值大于1时表示创建主备实例。关于两种类型实例的功能特性差异详情，请参见功能特性差异。
    shardCapacity number
    实例中每个分片的内存容量。单位：MiB。
    shardedCluster number
    是否启用分片集群。取值范围如下：0：不启用。1：启用。
    subnetId string
    设置实例的子网ID。子网具有可用区属性，必须选择目标私有网络中与实例属于同一可用区下的子网。子网是私有网络内的IP地址块私有网络中的所有云资源都必须部署在子网内，子网为云资源分配私网IP地址，您可以调用CreateSubnet接口创建子网。您可以调用DescribeSubnets接口查询指定可用区内的所有子网列表信息，包括子网ID。
    vpcId string
    设置实例的私有网络ID。建议Redis实例与需要连接的ECS实例在同一私有网络，否则它们无法通过内网互通来实现最佳性能。您可以调用CreateVpc接口创建私有网络。您可以调用DescribeVpcs接口查询符合指定条件的私有网络信息，包括私有网络ID。
    allowListIds string[]
    白名单 ID 列表。若该参数留空，新建实例默认不加入任何白名单。您可以调用 DescribeAllowLists 接口查询当前账号下指定地域内的所有 IP 白名单信息，包括白名单 ID 信息。每个实例最多支持绑定 100 个白名单，每次可最多批量绑定 100 个白名单。每个实例最多支持绑定 1000 个 IP 地址或 CIDR 格式的 IP 地址段。
    autoRenew boolean
    是否开启自动续费。取值范围如下：false（默认值）：不开启。true：开启。
    backupPointName string
    为变更前创建的全量备份设置备份名称。
    chargeType string
    实例计费类型。取值范围如下：PrePaid：包年包月（也称预付费）。PostPaid：按量计费（也称后付费）。
    createBackup boolean
    是否在变更前创建备份。
    deletionProtection string
    开启或关闭实例删除保护功能。
    instanceName string
    实例名称。命名规则：不能以数字、中划线（-）开头；只能包含中文、字母、数字、下划线（_）和中划线（-）；长度需要在1~128个字符内。
    noAuthMode string
    为新建实例开启或关闭免密访问功能。取值范围如下：open：开启免密访问。close（默认值）：关闭免密访问。
    parameterGroupId string
    需要应用到新实例的参数模板。缓存数据库 Redis 版为每个数据库版本都创建了一份默认的系统参数模板，模板中包含了该版本支持设置的所有参数和默认参数值。若该参数留空，默认会根据您设置的数据库版本（即 EngineVersion）为新建实例选择并应用对应版本的系统参数模板。您可以调用 DescribeParameterGroups 接口查询当前账号和地域下的所有参数模板的基本信息，包括参数模板 ID。
    password string
    设置默认数据库 default 账号的密码。
    port number
    自定义私网连接地址的端口号。取值范围：1024~65535。若该参数留空，私网连接地址默认使用6379端口。实例创建成功后，还可以修改私网地址的端口号，修改方法请参见修改端口号。
    projectName string
    实例所属的项目。
    purchaseMonths number
    购买时长，单位：月。取值范围如下：按月购买：1，2，3，4，5，6，7，8，9。按年购买：12，24，36。当ChargeType为PrePaid时，该参数必填。
    reserveAdditionalBandwidth boolean
    设置是否保留额外带宽
    shardNumber number
    实例中的分片数量。取值范围为 2~256。仅当 ShardedCluster 取值为 1（即启用分片集群）时，需要指定该参数。
    tags InstanceTag[]
    configure_nodes Sequence[InstanceConfigureNodeArgs]
    engine_version str
    数据库版本号。
    multi_az str
    设置实例的可用区部署方案。
    node_number int
    每个分片中的节点数。取值范围为1~6。每个账号在每个地域下默认最多可创建4个256MiB规格的节点，若需要调整配额上限为10个，请参见账号配额。取值为1时表示创建单节点实例；取值大于1时表示创建主备实例。关于两种类型实例的功能特性差异详情，请参见功能特性差异。
    shard_capacity int
    实例中每个分片的内存容量。单位：MiB。
    sharded_cluster int
    是否启用分片集群。取值范围如下：0：不启用。1：启用。
    subnet_id str
    设置实例的子网ID。子网具有可用区属性，必须选择目标私有网络中与实例属于同一可用区下的子网。子网是私有网络内的IP地址块私有网络中的所有云资源都必须部署在子网内，子网为云资源分配私网IP地址，您可以调用CreateSubnet接口创建子网。您可以调用DescribeSubnets接口查询指定可用区内的所有子网列表信息，包括子网ID。
    vpc_id str
    设置实例的私有网络ID。建议Redis实例与需要连接的ECS实例在同一私有网络，否则它们无法通过内网互通来实现最佳性能。您可以调用CreateVpc接口创建私有网络。您可以调用DescribeVpcs接口查询符合指定条件的私有网络信息，包括私有网络ID。
    allow_list_ids Sequence[str]
    白名单 ID 列表。若该参数留空，新建实例默认不加入任何白名单。您可以调用 DescribeAllowLists 接口查询当前账号下指定地域内的所有 IP 白名单信息，包括白名单 ID 信息。每个实例最多支持绑定 100 个白名单，每次可最多批量绑定 100 个白名单。每个实例最多支持绑定 1000 个 IP 地址或 CIDR 格式的 IP 地址段。
    auto_renew bool
    是否开启自动续费。取值范围如下：false（默认值）：不开启。true：开启。
    backup_point_name str
    为变更前创建的全量备份设置备份名称。
    charge_type str
    实例计费类型。取值范围如下：PrePaid：包年包月（也称预付费）。PostPaid：按量计费（也称后付费）。
    create_backup bool
    是否在变更前创建备份。
    deletion_protection str
    开启或关闭实例删除保护功能。
    instance_name str
    实例名称。命名规则：不能以数字、中划线（-）开头；只能包含中文、字母、数字、下划线（_）和中划线（-）；长度需要在1~128个字符内。
    no_auth_mode str
    为新建实例开启或关闭免密访问功能。取值范围如下：open：开启免密访问。close（默认值）：关闭免密访问。
    parameter_group_id str
    需要应用到新实例的参数模板。缓存数据库 Redis 版为每个数据库版本都创建了一份默认的系统参数模板，模板中包含了该版本支持设置的所有参数和默认参数值。若该参数留空，默认会根据您设置的数据库版本（即 EngineVersion）为新建实例选择并应用对应版本的系统参数模板。您可以调用 DescribeParameterGroups 接口查询当前账号和地域下的所有参数模板的基本信息，包括参数模板 ID。
    password str
    设置默认数据库 default 账号的密码。
    port int
    自定义私网连接地址的端口号。取值范围：1024~65535。若该参数留空，私网连接地址默认使用6379端口。实例创建成功后，还可以修改私网地址的端口号，修改方法请参见修改端口号。
    project_name str
    实例所属的项目。
    purchase_months int
    购买时长，单位：月。取值范围如下：按月购买：1，2，3，4，5，6，7，8，9。按年购买：12，24，36。当ChargeType为PrePaid时，该参数必填。
    reserve_additional_bandwidth bool
    设置是否保留额外带宽
    shard_number int
    实例中的分片数量。取值范围为 2~256。仅当 ShardedCluster 取值为 1（即启用分片集群）时，需要指定该参数。
    tags Sequence[InstanceTagArgs]
    configureNodes List<Property Map>
    engineVersion String
    数据库版本号。
    multiAz String
    设置实例的可用区部署方案。
    nodeNumber Number
    每个分片中的节点数。取值范围为1~6。每个账号在每个地域下默认最多可创建4个256MiB规格的节点，若需要调整配额上限为10个，请参见账号配额。取值为1时表示创建单节点实例；取值大于1时表示创建主备实例。关于两种类型实例的功能特性差异详情，请参见功能特性差异。
    shardCapacity Number
    实例中每个分片的内存容量。单位：MiB。
    shardedCluster Number
    是否启用分片集群。取值范围如下：0：不启用。1：启用。
    subnetId String
    设置实例的子网ID。子网具有可用区属性，必须选择目标私有网络中与实例属于同一可用区下的子网。子网是私有网络内的IP地址块私有网络中的所有云资源都必须部署在子网内，子网为云资源分配私网IP地址，您可以调用CreateSubnet接口创建子网。您可以调用DescribeSubnets接口查询指定可用区内的所有子网列表信息，包括子网ID。
    vpcId String
    设置实例的私有网络ID。建议Redis实例与需要连接的ECS实例在同一私有网络，否则它们无法通过内网互通来实现最佳性能。您可以调用CreateVpc接口创建私有网络。您可以调用DescribeVpcs接口查询符合指定条件的私有网络信息，包括私有网络ID。
    allowListIds List<String>
    白名单 ID 列表。若该参数留空，新建实例默认不加入任何白名单。您可以调用 DescribeAllowLists 接口查询当前账号下指定地域内的所有 IP 白名单信息，包括白名单 ID 信息。每个实例最多支持绑定 100 个白名单，每次可最多批量绑定 100 个白名单。每个实例最多支持绑定 1000 个 IP 地址或 CIDR 格式的 IP 地址段。
    autoRenew Boolean
    是否开启自动续费。取值范围如下：false（默认值）：不开启。true：开启。
    backupPointName String
    为变更前创建的全量备份设置备份名称。
    chargeType String
    实例计费类型。取值范围如下：PrePaid：包年包月（也称预付费）。PostPaid：按量计费（也称后付费）。
    createBackup Boolean
    是否在变更前创建备份。
    deletionProtection String
    开启或关闭实例删除保护功能。
    instanceName String
    实例名称。命名规则：不能以数字、中划线（-）开头；只能包含中文、字母、数字、下划线（_）和中划线（-）；长度需要在1~128个字符内。
    noAuthMode String
    为新建实例开启或关闭免密访问功能。取值范围如下：open：开启免密访问。close（默认值）：关闭免密访问。
    parameterGroupId String
    需要应用到新实例的参数模板。缓存数据库 Redis 版为每个数据库版本都创建了一份默认的系统参数模板，模板中包含了该版本支持设置的所有参数和默认参数值。若该参数留空，默认会根据您设置的数据库版本（即 EngineVersion）为新建实例选择并应用对应版本的系统参数模板。您可以调用 DescribeParameterGroups 接口查询当前账号和地域下的所有参数模板的基本信息，包括参数模板 ID。
    password String
    设置默认数据库 default 账号的密码。
    port Number
    自定义私网连接地址的端口号。取值范围：1024~65535。若该参数留空，私网连接地址默认使用6379端口。实例创建成功后，还可以修改私网地址的端口号，修改方法请参见修改端口号。
    projectName String
    实例所属的项目。
    purchaseMonths Number
    购买时长，单位：月。取值范围如下：按月购买：1，2，3，4，5，6，7，8，9。按年购买：12，24，36。当ChargeType为PrePaid时，该参数必填。
    reserveAdditionalBandwidth Boolean
    设置是否保留额外带宽
    shardNumber Number
    实例中的分片数量。取值范围为 2~256。仅当 ShardedCluster 取值为 1（即启用分片集群）时，需要指定该参数。
    tags List<Property Map>

    Outputs

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

    Capacity Volcengine.InstanceCapacity
    实例的容量信息。
    CreateTime string
    实例的创建时间。
    DataLayout string
    实例的数据存储形态。该参数仅对企业版（即ServiceType为Enterprise）实例有意义；社区版（即ServiceType为Basic）实例不涉及数据存储形态，DataLayout取值固定为RAM。若该参数留空，表示不使用数据存储形态进行筛选。
    ExpiredTime string
    实例到期时间。
    Id string
    The provider-assigned unique ID for this managed resource.
    InstanceClass string
    Redis 实例的类型。取值范围如下：PrimarySecondary：主备实例；Standalone：单节点实例。若该参数留空，表示不使用实例类型条件进行筛选。关于实例类型的更多信息，请参见产品架构。
    InstanceId string
    实例 ID。
    InstanceShards List<Volcengine.InstanceInstanceShard>
    MaintenanceTime string
    实例的可维护时间段，格式为HH:mm-HH:mm（UTC+8）。
    MaxConnections int
    实例当前单分片最大连接数。每分片的默认连接数为10000，您也可以根据业务需要调用ModifyDBInstanceMaxConn接口修改单分片的最大连接数。
    NodeIds List<string>
    Proxy 和 Server 节点 ID 列表。
    PrivateAddress string
    实例私网连接地址的域名。
    ServiceType string
    实例的服务类型
    Status string
    实例的服务类型，取值范围如下：Basic（默认值）：社区版；Enterprise：企业版。
    ViPv6 string
    实例私网连接地址所对应的 IPv6 地址。仅当实例使用了 IPv6 地址时才会返回该参数。
    Vip string
    实例私网连接地址所对应的 IPv4 地址。
    VisitAddrs List<Volcengine.InstanceVisitAddr>
    VpcAuthMode string
    开启或关闭免密访问功能。取值范围如下：open：开启免密访问；close：关闭免密访问。参数取值不区分大小写。
    ZoneIds List<string>
    实例所在的可用区列表。
    Capacity InstanceCapacity
    实例的容量信息。
    CreateTime string
    实例的创建时间。
    DataLayout string
    实例的数据存储形态。该参数仅对企业版（即ServiceType为Enterprise）实例有意义；社区版（即ServiceType为Basic）实例不涉及数据存储形态，DataLayout取值固定为RAM。若该参数留空，表示不使用数据存储形态进行筛选。
    ExpiredTime string
    实例到期时间。
    Id string
    The provider-assigned unique ID for this managed resource.
    InstanceClass string
    Redis 实例的类型。取值范围如下：PrimarySecondary：主备实例；Standalone：单节点实例。若该参数留空，表示不使用实例类型条件进行筛选。关于实例类型的更多信息，请参见产品架构。
    InstanceId string
    实例 ID。
    InstanceShards []InstanceInstanceShard
    MaintenanceTime string
    实例的可维护时间段，格式为HH:mm-HH:mm（UTC+8）。
    MaxConnections int
    实例当前单分片最大连接数。每分片的默认连接数为10000，您也可以根据业务需要调用ModifyDBInstanceMaxConn接口修改单分片的最大连接数。
    NodeIds []string
    Proxy 和 Server 节点 ID 列表。
    PrivateAddress string
    实例私网连接地址的域名。
    ServiceType string
    实例的服务类型
    Status string
    实例的服务类型，取值范围如下：Basic（默认值）：社区版；Enterprise：企业版。
    ViPv6 string
    实例私网连接地址所对应的 IPv6 地址。仅当实例使用了 IPv6 地址时才会返回该参数。
    Vip string
    实例私网连接地址所对应的 IPv4 地址。
    VisitAddrs []InstanceVisitAddr
    VpcAuthMode string
    开启或关闭免密访问功能。取值范围如下：open：开启免密访问；close：关闭免密访问。参数取值不区分大小写。
    ZoneIds []string
    实例所在的可用区列表。
    capacity InstanceCapacity
    实例的容量信息。
    createTime String
    实例的创建时间。
    dataLayout String
    实例的数据存储形态。该参数仅对企业版（即ServiceType为Enterprise）实例有意义；社区版（即ServiceType为Basic）实例不涉及数据存储形态，DataLayout取值固定为RAM。若该参数留空，表示不使用数据存储形态进行筛选。
    expiredTime String
    实例到期时间。
    id String
    The provider-assigned unique ID for this managed resource.
    instanceClass String
    Redis 实例的类型。取值范围如下：PrimarySecondary：主备实例；Standalone：单节点实例。若该参数留空，表示不使用实例类型条件进行筛选。关于实例类型的更多信息，请参见产品架构。
    instanceId String
    实例 ID。
    instanceShards List<InstanceInstanceShard>
    maintenanceTime String
    实例的可维护时间段，格式为HH:mm-HH:mm（UTC+8）。
    maxConnections Integer
    实例当前单分片最大连接数。每分片的默认连接数为10000，您也可以根据业务需要调用ModifyDBInstanceMaxConn接口修改单分片的最大连接数。
    nodeIds List<String>
    Proxy 和 Server 节点 ID 列表。
    privateAddress String
    实例私网连接地址的域名。
    serviceType String
    实例的服务类型
    status String
    实例的服务类型，取值范围如下：Basic（默认值）：社区版；Enterprise：企业版。
    viPv6 String
    实例私网连接地址所对应的 IPv6 地址。仅当实例使用了 IPv6 地址时才会返回该参数。
    vip String
    实例私网连接地址所对应的 IPv4 地址。
    visitAddrs List<InstanceVisitAddr>
    vpcAuthMode String
    开启或关闭免密访问功能。取值范围如下：open：开启免密访问；close：关闭免密访问。参数取值不区分大小写。
    zoneIds List<String>
    实例所在的可用区列表。
    capacity InstanceCapacity
    实例的容量信息。
    createTime string
    实例的创建时间。
    dataLayout string
    实例的数据存储形态。该参数仅对企业版（即ServiceType为Enterprise）实例有意义；社区版（即ServiceType为Basic）实例不涉及数据存储形态，DataLayout取值固定为RAM。若该参数留空，表示不使用数据存储形态进行筛选。
    expiredTime string
    实例到期时间。
    id string
    The provider-assigned unique ID for this managed resource.
    instanceClass string
    Redis 实例的类型。取值范围如下：PrimarySecondary：主备实例；Standalone：单节点实例。若该参数留空，表示不使用实例类型条件进行筛选。关于实例类型的更多信息，请参见产品架构。
    instanceId string
    实例 ID。
    instanceShards InstanceInstanceShard[]
    maintenanceTime string
    实例的可维护时间段，格式为HH:mm-HH:mm（UTC+8）。
    maxConnections number
    实例当前单分片最大连接数。每分片的默认连接数为10000，您也可以根据业务需要调用ModifyDBInstanceMaxConn接口修改单分片的最大连接数。
    nodeIds string[]
    Proxy 和 Server 节点 ID 列表。
    privateAddress string
    实例私网连接地址的域名。
    serviceType string
    实例的服务类型
    status string
    实例的服务类型，取值范围如下：Basic（默认值）：社区版；Enterprise：企业版。
    viPv6 string
    实例私网连接地址所对应的 IPv6 地址。仅当实例使用了 IPv6 地址时才会返回该参数。
    vip string
    实例私网连接地址所对应的 IPv4 地址。
    visitAddrs InstanceVisitAddr[]
    vpcAuthMode string
    开启或关闭免密访问功能。取值范围如下：open：开启免密访问；close：关闭免密访问。参数取值不区分大小写。
    zoneIds string[]
    实例所在的可用区列表。
    capacity InstanceCapacity
    实例的容量信息。
    create_time str
    实例的创建时间。
    data_layout str
    实例的数据存储形态。该参数仅对企业版（即ServiceType为Enterprise）实例有意义；社区版（即ServiceType为Basic）实例不涉及数据存储形态，DataLayout取值固定为RAM。若该参数留空，表示不使用数据存储形态进行筛选。
    expired_time str
    实例到期时间。
    id str
    The provider-assigned unique ID for this managed resource.
    instance_class str
    Redis 实例的类型。取值范围如下：PrimarySecondary：主备实例；Standalone：单节点实例。若该参数留空，表示不使用实例类型条件进行筛选。关于实例类型的更多信息，请参见产品架构。
    instance_id str
    实例 ID。
    instance_shards Sequence[InstanceInstanceShard]
    maintenance_time str
    实例的可维护时间段，格式为HH:mm-HH:mm（UTC+8）。
    max_connections int
    实例当前单分片最大连接数。每分片的默认连接数为10000，您也可以根据业务需要调用ModifyDBInstanceMaxConn接口修改单分片的最大连接数。
    node_ids Sequence[str]
    Proxy 和 Server 节点 ID 列表。
    private_address str
    实例私网连接地址的域名。
    service_type str
    实例的服务类型
    status str
    实例的服务类型，取值范围如下：Basic（默认值）：社区版；Enterprise：企业版。
    vi_pv6 str
    实例私网连接地址所对应的 IPv6 地址。仅当实例使用了 IPv6 地址时才会返回该参数。
    vip str
    实例私网连接地址所对应的 IPv4 地址。
    visit_addrs Sequence[InstanceVisitAddr]
    vpc_auth_mode str
    开启或关闭免密访问功能。取值范围如下：open：开启免密访问；close：关闭免密访问。参数取值不区分大小写。
    zone_ids Sequence[str]
    实例所在的可用区列表。
    capacity Property Map
    实例的容量信息。
    createTime String
    实例的创建时间。
    dataLayout String
    实例的数据存储形态。该参数仅对企业版（即ServiceType为Enterprise）实例有意义；社区版（即ServiceType为Basic）实例不涉及数据存储形态，DataLayout取值固定为RAM。若该参数留空，表示不使用数据存储形态进行筛选。
    expiredTime String
    实例到期时间。
    id String
    The provider-assigned unique ID for this managed resource.
    instanceClass String
    Redis 实例的类型。取值范围如下：PrimarySecondary：主备实例；Standalone：单节点实例。若该参数留空，表示不使用实例类型条件进行筛选。关于实例类型的更多信息，请参见产品架构。
    instanceId String
    实例 ID。
    instanceShards List<Property Map>
    maintenanceTime String
    实例的可维护时间段，格式为HH:mm-HH:mm（UTC+8）。
    maxConnections Number
    实例当前单分片最大连接数。每分片的默认连接数为10000，您也可以根据业务需要调用ModifyDBInstanceMaxConn接口修改单分片的最大连接数。
    nodeIds List<String>
    Proxy 和 Server 节点 ID 列表。
    privateAddress String
    实例私网连接地址的域名。
    serviceType String
    实例的服务类型
    status String
    实例的服务类型，取值范围如下：Basic（默认值）：社区版；Enterprise：企业版。
    viPv6 String
    实例私网连接地址所对应的 IPv6 地址。仅当实例使用了 IPv6 地址时才会返回该参数。
    vip String
    实例私网连接地址所对应的 IPv4 地址。
    visitAddrs List<Property Map>
    vpcAuthMode String
    开启或关闭免密访问功能。取值范围如下：open：开启免密访问；close：关闭免密访问。参数取值不区分大小写。
    zoneIds List<String>
    实例所在的可用区列表。

    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,
        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,
        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>
    白名单 ID 列表。若该参数留空，新建实例默认不加入任何白名单。您可以调用 DescribeAllowLists 接口查询当前账号下指定地域内的所有 IP 白名单信息，包括白名单 ID 信息。每个实例最多支持绑定 100 个白名单，每次可最多批量绑定 100 个白名单。每个实例最多支持绑定 1000 个 IP 地址或 CIDR 格式的 IP 地址段。
    AutoRenew bool
    是否开启自动续费。取值范围如下：false（默认值）：不开启。true：开启。
    BackupPointName string
    为变更前创建的全量备份设置备份名称。
    Capacity Volcengine.InstanceCapacity
    实例的容量信息。
    ChargeType string
    实例计费类型。取值范围如下：PrePaid：包年包月（也称预付费）。PostPaid：按量计费（也称后付费）。
    ConfigureNodes List<Volcengine.InstanceConfigureNode>
    CreateBackup bool
    是否在变更前创建备份。
    CreateTime string
    实例的创建时间。
    DataLayout string
    实例的数据存储形态。该参数仅对企业版（即ServiceType为Enterprise）实例有意义；社区版（即ServiceType为Basic）实例不涉及数据存储形态，DataLayout取值固定为RAM。若该参数留空，表示不使用数据存储形态进行筛选。
    DeletionProtection string
    开启或关闭实例删除保护功能。
    EngineVersion string
    数据库版本号。
    ExpiredTime string
    实例到期时间。
    InstanceClass string
    Redis 实例的类型。取值范围如下：PrimarySecondary：主备实例；Standalone：单节点实例。若该参数留空，表示不使用实例类型条件进行筛选。关于实例类型的更多信息，请参见产品架构。
    InstanceId string
    实例 ID。
    InstanceName string
    实例名称。命名规则：不能以数字、中划线（-）开头；只能包含中文、字母、数字、下划线（_）和中划线（-）；长度需要在1~128个字符内。
    InstanceShards List<Volcengine.InstanceInstanceShard>
    MaintenanceTime string
    实例的可维护时间段，格式为HH:mm-HH:mm（UTC+8）。
    MaxConnections int
    实例当前单分片最大连接数。每分片的默认连接数为10000，您也可以根据业务需要调用ModifyDBInstanceMaxConn接口修改单分片的最大连接数。
    MultiAz string
    设置实例的可用区部署方案。
    NoAuthMode string
    为新建实例开启或关闭免密访问功能。取值范围如下：open：开启免密访问。close（默认值）：关闭免密访问。
    NodeIds List<string>
    Proxy 和 Server 节点 ID 列表。
    NodeNumber int
    每个分片中的节点数。取值范围为1~6。每个账号在每个地域下默认最多可创建4个256MiB规格的节点，若需要调整配额上限为10个，请参见账号配额。取值为1时表示创建单节点实例；取值大于1时表示创建主备实例。关于两种类型实例的功能特性差异详情，请参见功能特性差异。
    ParameterGroupId string
    需要应用到新实例的参数模板。缓存数据库 Redis 版为每个数据库版本都创建了一份默认的系统参数模板，模板中包含了该版本支持设置的所有参数和默认参数值。若该参数留空，默认会根据您设置的数据库版本（即 EngineVersion）为新建实例选择并应用对应版本的系统参数模板。您可以调用 DescribeParameterGroups 接口查询当前账号和地域下的所有参数模板的基本信息，包括参数模板 ID。
    Password string
    设置默认数据库 default 账号的密码。
    Port int
    自定义私网连接地址的端口号。取值范围：1024~65535。若该参数留空，私网连接地址默认使用6379端口。实例创建成功后，还可以修改私网地址的端口号，修改方法请参见修改端口号。
    PrivateAddress string
    实例私网连接地址的域名。
    ProjectName string
    实例所属的项目。
    PurchaseMonths int
    购买时长，单位：月。取值范围如下：按月购买：1，2，3，4，5，6，7，8，9。按年购买：12，24，36。当ChargeType为PrePaid时，该参数必填。
    ReserveAdditionalBandwidth bool
    设置是否保留额外带宽
    ServiceType string
    实例的服务类型
    ShardCapacity int
    实例中每个分片的内存容量。单位：MiB。
    ShardNumber int
    实例中的分片数量。取值范围为 2~256。仅当 ShardedCluster 取值为 1（即启用分片集群）时，需要指定该参数。
    ShardedCluster int
    是否启用分片集群。取值范围如下：0：不启用。1：启用。
    Status string
    实例的服务类型，取值范围如下：Basic（默认值）：社区版；Enterprise：企业版。
    SubnetId string
    设置实例的子网ID。子网具有可用区属性，必须选择目标私有网络中与实例属于同一可用区下的子网。子网是私有网络内的IP地址块私有网络中的所有云资源都必须部署在子网内，子网为云资源分配私网IP地址，您可以调用CreateSubnet接口创建子网。您可以调用DescribeSubnets接口查询指定可用区内的所有子网列表信息，包括子网ID。
    Tags List<Volcengine.InstanceTag>
    ViPv6 string
    实例私网连接地址所对应的 IPv6 地址。仅当实例使用了 IPv6 地址时才会返回该参数。
    Vip string
    实例私网连接地址所对应的 IPv4 地址。
    VisitAddrs List<Volcengine.InstanceVisitAddr>
    VpcAuthMode string
    开启或关闭免密访问功能。取值范围如下：open：开启免密访问；close：关闭免密访问。参数取值不区分大小写。
    VpcId string
    设置实例的私有网络ID。建议Redis实例与需要连接的ECS实例在同一私有网络，否则它们无法通过内网互通来实现最佳性能。您可以调用CreateVpc接口创建私有网络。您可以调用DescribeVpcs接口查询符合指定条件的私有网络信息，包括私有网络ID。
    ZoneIds List<string>
    实例所在的可用区列表。
    AllowListIds []string
    白名单 ID 列表。若该参数留空，新建实例默认不加入任何白名单。您可以调用 DescribeAllowLists 接口查询当前账号下指定地域内的所有 IP 白名单信息，包括白名单 ID 信息。每个实例最多支持绑定 100 个白名单，每次可最多批量绑定 100 个白名单。每个实例最多支持绑定 1000 个 IP 地址或 CIDR 格式的 IP 地址段。
    AutoRenew bool
    是否开启自动续费。取值范围如下：false（默认值）：不开启。true：开启。
    BackupPointName string
    为变更前创建的全量备份设置备份名称。
    Capacity InstanceCapacityArgs
    实例的容量信息。
    ChargeType string
    实例计费类型。取值范围如下：PrePaid：包年包月（也称预付费）。PostPaid：按量计费（也称后付费）。
    ConfigureNodes []InstanceConfigureNodeArgs
    CreateBackup bool
    是否在变更前创建备份。
    CreateTime string
    实例的创建时间。
    DataLayout string
    实例的数据存储形态。该参数仅对企业版（即ServiceType为Enterprise）实例有意义；社区版（即ServiceType为Basic）实例不涉及数据存储形态，DataLayout取值固定为RAM。若该参数留空，表示不使用数据存储形态进行筛选。
    DeletionProtection string
    开启或关闭实例删除保护功能。
    EngineVersion string
    数据库版本号。
    ExpiredTime string
    实例到期时间。
    InstanceClass string
    Redis 实例的类型。取值范围如下：PrimarySecondary：主备实例；Standalone：单节点实例。若该参数留空，表示不使用实例类型条件进行筛选。关于实例类型的更多信息，请参见产品架构。
    InstanceId string
    实例 ID。
    InstanceName string
    实例名称。命名规则：不能以数字、中划线（-）开头；只能包含中文、字母、数字、下划线（_）和中划线（-）；长度需要在1~128个字符内。
    InstanceShards []InstanceInstanceShardArgs
    MaintenanceTime string
    实例的可维护时间段，格式为HH:mm-HH:mm（UTC+8）。
    MaxConnections int
    实例当前单分片最大连接数。每分片的默认连接数为10000，您也可以根据业务需要调用ModifyDBInstanceMaxConn接口修改单分片的最大连接数。
    MultiAz string
    设置实例的可用区部署方案。
    NoAuthMode string
    为新建实例开启或关闭免密访问功能。取值范围如下：open：开启免密访问。close（默认值）：关闭免密访问。
    NodeIds []string
    Proxy 和 Server 节点 ID 列表。
    NodeNumber int
    每个分片中的节点数。取值范围为1~6。每个账号在每个地域下默认最多可创建4个256MiB规格的节点，若需要调整配额上限为10个，请参见账号配额。取值为1时表示创建单节点实例；取值大于1时表示创建主备实例。关于两种类型实例的功能特性差异详情，请参见功能特性差异。
    ParameterGroupId string
    需要应用到新实例的参数模板。缓存数据库 Redis 版为每个数据库版本都创建了一份默认的系统参数模板，模板中包含了该版本支持设置的所有参数和默认参数值。若该参数留空，默认会根据您设置的数据库版本（即 EngineVersion）为新建实例选择并应用对应版本的系统参数模板。您可以调用 DescribeParameterGroups 接口查询当前账号和地域下的所有参数模板的基本信息，包括参数模板 ID。
    Password string
    设置默认数据库 default 账号的密码。
    Port int
    自定义私网连接地址的端口号。取值范围：1024~65535。若该参数留空，私网连接地址默认使用6379端口。实例创建成功后，还可以修改私网地址的端口号，修改方法请参见修改端口号。
    PrivateAddress string
    实例私网连接地址的域名。
    ProjectName string
    实例所属的项目。
    PurchaseMonths int
    购买时长，单位：月。取值范围如下：按月购买：1，2，3，4，5，6，7，8，9。按年购买：12，24，36。当ChargeType为PrePaid时，该参数必填。
    ReserveAdditionalBandwidth bool
    设置是否保留额外带宽
    ServiceType string
    实例的服务类型
    ShardCapacity int
    实例中每个分片的内存容量。单位：MiB。
    ShardNumber int
    实例中的分片数量。取值范围为 2~256。仅当 ShardedCluster 取值为 1（即启用分片集群）时，需要指定该参数。
    ShardedCluster int
    是否启用分片集群。取值范围如下：0：不启用。1：启用。
    Status string
    实例的服务类型，取值范围如下：Basic（默认值）：社区版；Enterprise：企业版。
    SubnetId string
    设置实例的子网ID。子网具有可用区属性，必须选择目标私有网络中与实例属于同一可用区下的子网。子网是私有网络内的IP地址块私有网络中的所有云资源都必须部署在子网内，子网为云资源分配私网IP地址，您可以调用CreateSubnet接口创建子网。您可以调用DescribeSubnets接口查询指定可用区内的所有子网列表信息，包括子网ID。
    Tags []InstanceTagArgs
    ViPv6 string
    实例私网连接地址所对应的 IPv6 地址。仅当实例使用了 IPv6 地址时才会返回该参数。
    Vip string
    实例私网连接地址所对应的 IPv4 地址。
    VisitAddrs []InstanceVisitAddrArgs
    VpcAuthMode string
    开启或关闭免密访问功能。取值范围如下：open：开启免密访问；close：关闭免密访问。参数取值不区分大小写。
    VpcId string
    设置实例的私有网络ID。建议Redis实例与需要连接的ECS实例在同一私有网络，否则它们无法通过内网互通来实现最佳性能。您可以调用CreateVpc接口创建私有网络。您可以调用DescribeVpcs接口查询符合指定条件的私有网络信息，包括私有网络ID。
    ZoneIds []string
    实例所在的可用区列表。
    allowListIds List<String>
    白名单 ID 列表。若该参数留空，新建实例默认不加入任何白名单。您可以调用 DescribeAllowLists 接口查询当前账号下指定地域内的所有 IP 白名单信息，包括白名单 ID 信息。每个实例最多支持绑定 100 个白名单，每次可最多批量绑定 100 个白名单。每个实例最多支持绑定 1000 个 IP 地址或 CIDR 格式的 IP 地址段。
    autoRenew Boolean
    是否开启自动续费。取值范围如下：false（默认值）：不开启。true：开启。
    backupPointName String
    为变更前创建的全量备份设置备份名称。
    capacity InstanceCapacity
    实例的容量信息。
    chargeType String
    实例计费类型。取值范围如下：PrePaid：包年包月（也称预付费）。PostPaid：按量计费（也称后付费）。
    configureNodes List<InstanceConfigureNode>
    createBackup Boolean
    是否在变更前创建备份。
    createTime String
    实例的创建时间。
    dataLayout String
    实例的数据存储形态。该参数仅对企业版（即ServiceType为Enterprise）实例有意义；社区版（即ServiceType为Basic）实例不涉及数据存储形态，DataLayout取值固定为RAM。若该参数留空，表示不使用数据存储形态进行筛选。
    deletionProtection String
    开启或关闭实例删除保护功能。
    engineVersion String
    数据库版本号。
    expiredTime String
    实例到期时间。
    instanceClass String
    Redis 实例的类型。取值范围如下：PrimarySecondary：主备实例；Standalone：单节点实例。若该参数留空，表示不使用实例类型条件进行筛选。关于实例类型的更多信息，请参见产品架构。
    instanceId String
    实例 ID。
    instanceName String
    实例名称。命名规则：不能以数字、中划线（-）开头；只能包含中文、字母、数字、下划线（_）和中划线（-）；长度需要在1~128个字符内。
    instanceShards List<InstanceInstanceShard>
    maintenanceTime String
    实例的可维护时间段，格式为HH:mm-HH:mm（UTC+8）。
    maxConnections Integer
    实例当前单分片最大连接数。每分片的默认连接数为10000，您也可以根据业务需要调用ModifyDBInstanceMaxConn接口修改单分片的最大连接数。
    multiAz String
    设置实例的可用区部署方案。
    noAuthMode String
    为新建实例开启或关闭免密访问功能。取值范围如下：open：开启免密访问。close（默认值）：关闭免密访问。
    nodeIds List<String>
    Proxy 和 Server 节点 ID 列表。
    nodeNumber Integer
    每个分片中的节点数。取值范围为1~6。每个账号在每个地域下默认最多可创建4个256MiB规格的节点，若需要调整配额上限为10个，请参见账号配额。取值为1时表示创建单节点实例；取值大于1时表示创建主备实例。关于两种类型实例的功能特性差异详情，请参见功能特性差异。
    parameterGroupId String
    需要应用到新实例的参数模板。缓存数据库 Redis 版为每个数据库版本都创建了一份默认的系统参数模板，模板中包含了该版本支持设置的所有参数和默认参数值。若该参数留空，默认会根据您设置的数据库版本（即 EngineVersion）为新建实例选择并应用对应版本的系统参数模板。您可以调用 DescribeParameterGroups 接口查询当前账号和地域下的所有参数模板的基本信息，包括参数模板 ID。
    password String
    设置默认数据库 default 账号的密码。
    port Integer
    自定义私网连接地址的端口号。取值范围：1024~65535。若该参数留空，私网连接地址默认使用6379端口。实例创建成功后，还可以修改私网地址的端口号，修改方法请参见修改端口号。
    privateAddress String
    实例私网连接地址的域名。
    projectName String
    实例所属的项目。
    purchaseMonths Integer
    购买时长，单位：月。取值范围如下：按月购买：1，2，3，4，5，6，7，8，9。按年购买：12，24，36。当ChargeType为PrePaid时，该参数必填。
    reserveAdditionalBandwidth Boolean
    设置是否保留额外带宽
    serviceType String
    实例的服务类型
    shardCapacity Integer
    实例中每个分片的内存容量。单位：MiB。
    shardNumber Integer
    实例中的分片数量。取值范围为 2~256。仅当 ShardedCluster 取值为 1（即启用分片集群）时，需要指定该参数。
    shardedCluster Integer
    是否启用分片集群。取值范围如下：0：不启用。1：启用。
    status String
    实例的服务类型，取值范围如下：Basic（默认值）：社区版；Enterprise：企业版。
    subnetId String
    设置实例的子网ID。子网具有可用区属性，必须选择目标私有网络中与实例属于同一可用区下的子网。子网是私有网络内的IP地址块私有网络中的所有云资源都必须部署在子网内，子网为云资源分配私网IP地址，您可以调用CreateSubnet接口创建子网。您可以调用DescribeSubnets接口查询指定可用区内的所有子网列表信息，包括子网ID。
    tags List<InstanceTag>
    viPv6 String
    实例私网连接地址所对应的 IPv6 地址。仅当实例使用了 IPv6 地址时才会返回该参数。
    vip String
    实例私网连接地址所对应的 IPv4 地址。
    visitAddrs List<InstanceVisitAddr>
    vpcAuthMode String
    开启或关闭免密访问功能。取值范围如下：open：开启免密访问；close：关闭免密访问。参数取值不区分大小写。
    vpcId String
    设置实例的私有网络ID。建议Redis实例与需要连接的ECS实例在同一私有网络，否则它们无法通过内网互通来实现最佳性能。您可以调用CreateVpc接口创建私有网络。您可以调用DescribeVpcs接口查询符合指定条件的私有网络信息，包括私有网络ID。
    zoneIds List<String>
    实例所在的可用区列表。
    allowListIds string[]
    白名单 ID 列表。若该参数留空，新建实例默认不加入任何白名单。您可以调用 DescribeAllowLists 接口查询当前账号下指定地域内的所有 IP 白名单信息，包括白名单 ID 信息。每个实例最多支持绑定 100 个白名单，每次可最多批量绑定 100 个白名单。每个实例最多支持绑定 1000 个 IP 地址或 CIDR 格式的 IP 地址段。
    autoRenew boolean
    是否开启自动续费。取值范围如下：false（默认值）：不开启。true：开启。
    backupPointName string
    为变更前创建的全量备份设置备份名称。
    capacity InstanceCapacity
    实例的容量信息。
    chargeType string
    实例计费类型。取值范围如下：PrePaid：包年包月（也称预付费）。PostPaid：按量计费（也称后付费）。
    configureNodes InstanceConfigureNode[]
    createBackup boolean
    是否在变更前创建备份。
    createTime string
    实例的创建时间。
    dataLayout string
    实例的数据存储形态。该参数仅对企业版（即ServiceType为Enterprise）实例有意义；社区版（即ServiceType为Basic）实例不涉及数据存储形态，DataLayout取值固定为RAM。若该参数留空，表示不使用数据存储形态进行筛选。
    deletionProtection string
    开启或关闭实例删除保护功能。
    engineVersion string
    数据库版本号。
    expiredTime string
    实例到期时间。
    instanceClass string
    Redis 实例的类型。取值范围如下：PrimarySecondary：主备实例；Standalone：单节点实例。若该参数留空，表示不使用实例类型条件进行筛选。关于实例类型的更多信息，请参见产品架构。
    instanceId string
    实例 ID。
    instanceName string
    实例名称。命名规则：不能以数字、中划线（-）开头；只能包含中文、字母、数字、下划线（_）和中划线（-）；长度需要在1~128个字符内。
    instanceShards InstanceInstanceShard[]
    maintenanceTime string
    实例的可维护时间段，格式为HH:mm-HH:mm（UTC+8）。
    maxConnections number
    实例当前单分片最大连接数。每分片的默认连接数为10000，您也可以根据业务需要调用ModifyDBInstanceMaxConn接口修改单分片的最大连接数。
    multiAz string
    设置实例的可用区部署方案。
    noAuthMode string
    为新建实例开启或关闭免密访问功能。取值范围如下：open：开启免密访问。close（默认值）：关闭免密访问。
    nodeIds string[]
    Proxy 和 Server 节点 ID 列表。
    nodeNumber number
    每个分片中的节点数。取值范围为1~6。每个账号在每个地域下默认最多可创建4个256MiB规格的节点，若需要调整配额上限为10个，请参见账号配额。取值为1时表示创建单节点实例；取值大于1时表示创建主备实例。关于两种类型实例的功能特性差异详情，请参见功能特性差异。
    parameterGroupId string
    需要应用到新实例的参数模板。缓存数据库 Redis 版为每个数据库版本都创建了一份默认的系统参数模板，模板中包含了该版本支持设置的所有参数和默认参数值。若该参数留空，默认会根据您设置的数据库版本（即 EngineVersion）为新建实例选择并应用对应版本的系统参数模板。您可以调用 DescribeParameterGroups 接口查询当前账号和地域下的所有参数模板的基本信息，包括参数模板 ID。
    password string
    设置默认数据库 default 账号的密码。
    port number
    自定义私网连接地址的端口号。取值范围：1024~65535。若该参数留空，私网连接地址默认使用6379端口。实例创建成功后，还可以修改私网地址的端口号，修改方法请参见修改端口号。
    privateAddress string
    实例私网连接地址的域名。
    projectName string
    实例所属的项目。
    purchaseMonths number
    购买时长，单位：月。取值范围如下：按月购买：1，2，3，4，5，6，7，8，9。按年购买：12，24，36。当ChargeType为PrePaid时，该参数必填。
    reserveAdditionalBandwidth boolean
    设置是否保留额外带宽
    serviceType string
    实例的服务类型
    shardCapacity number
    实例中每个分片的内存容量。单位：MiB。
    shardNumber number
    实例中的分片数量。取值范围为 2~256。仅当 ShardedCluster 取值为 1（即启用分片集群）时，需要指定该参数。
    shardedCluster number
    是否启用分片集群。取值范围如下：0：不启用。1：启用。
    status string
    实例的服务类型，取值范围如下：Basic（默认值）：社区版；Enterprise：企业版。
    subnetId string
    设置实例的子网ID。子网具有可用区属性，必须选择目标私有网络中与实例属于同一可用区下的子网。子网是私有网络内的IP地址块私有网络中的所有云资源都必须部署在子网内，子网为云资源分配私网IP地址，您可以调用CreateSubnet接口创建子网。您可以调用DescribeSubnets接口查询指定可用区内的所有子网列表信息，包括子网ID。
    tags InstanceTag[]
    viPv6 string
    实例私网连接地址所对应的 IPv6 地址。仅当实例使用了 IPv6 地址时才会返回该参数。
    vip string
    实例私网连接地址所对应的 IPv4 地址。
    visitAddrs InstanceVisitAddr[]
    vpcAuthMode string
    开启或关闭免密访问功能。取值范围如下：open：开启免密访问；close：关闭免密访问。参数取值不区分大小写。
    vpcId string
    设置实例的私有网络ID。建议Redis实例与需要连接的ECS实例在同一私有网络，否则它们无法通过内网互通来实现最佳性能。您可以调用CreateVpc接口创建私有网络。您可以调用DescribeVpcs接口查询符合指定条件的私有网络信息，包括私有网络ID。
    zoneIds string[]
    实例所在的可用区列表。
    allow_list_ids Sequence[str]
    白名单 ID 列表。若该参数留空，新建实例默认不加入任何白名单。您可以调用 DescribeAllowLists 接口查询当前账号下指定地域内的所有 IP 白名单信息，包括白名单 ID 信息。每个实例最多支持绑定 100 个白名单，每次可最多批量绑定 100 个白名单。每个实例最多支持绑定 1000 个 IP 地址或 CIDR 格式的 IP 地址段。
    auto_renew bool
    是否开启自动续费。取值范围如下：false（默认值）：不开启。true：开启。
    backup_point_name str
    为变更前创建的全量备份设置备份名称。
    capacity InstanceCapacityArgs
    实例的容量信息。
    charge_type str
    实例计费类型。取值范围如下：PrePaid：包年包月（也称预付费）。PostPaid：按量计费（也称后付费）。
    configure_nodes Sequence[InstanceConfigureNodeArgs]
    create_backup bool
    是否在变更前创建备份。
    create_time str
    实例的创建时间。
    data_layout str
    实例的数据存储形态。该参数仅对企业版（即ServiceType为Enterprise）实例有意义；社区版（即ServiceType为Basic）实例不涉及数据存储形态，DataLayout取值固定为RAM。若该参数留空，表示不使用数据存储形态进行筛选。
    deletion_protection str
    开启或关闭实例删除保护功能。
    engine_version str
    数据库版本号。
    expired_time str
    实例到期时间。
    instance_class str
    Redis 实例的类型。取值范围如下：PrimarySecondary：主备实例；Standalone：单节点实例。若该参数留空，表示不使用实例类型条件进行筛选。关于实例类型的更多信息，请参见产品架构。
    instance_id str
    实例 ID。
    instance_name str
    实例名称。命名规则：不能以数字、中划线（-）开头；只能包含中文、字母、数字、下划线（_）和中划线（-）；长度需要在1~128个字符内。
    instance_shards Sequence[InstanceInstanceShardArgs]
    maintenance_time str
    实例的可维护时间段，格式为HH:mm-HH:mm（UTC+8）。
    max_connections int
    实例当前单分片最大连接数。每分片的默认连接数为10000，您也可以根据业务需要调用ModifyDBInstanceMaxConn接口修改单分片的最大连接数。
    multi_az str
    设置实例的可用区部署方案。
    no_auth_mode str
    为新建实例开启或关闭免密访问功能。取值范围如下：open：开启免密访问。close（默认值）：关闭免密访问。
    node_ids Sequence[str]
    Proxy 和 Server 节点 ID 列表。
    node_number int
    每个分片中的节点数。取值范围为1~6。每个账号在每个地域下默认最多可创建4个256MiB规格的节点，若需要调整配额上限为10个，请参见账号配额。取值为1时表示创建单节点实例；取值大于1时表示创建主备实例。关于两种类型实例的功能特性差异详情，请参见功能特性差异。
    parameter_group_id str
    需要应用到新实例的参数模板。缓存数据库 Redis 版为每个数据库版本都创建了一份默认的系统参数模板，模板中包含了该版本支持设置的所有参数和默认参数值。若该参数留空，默认会根据您设置的数据库版本（即 EngineVersion）为新建实例选择并应用对应版本的系统参数模板。您可以调用 DescribeParameterGroups 接口查询当前账号和地域下的所有参数模板的基本信息，包括参数模板 ID。
    password str
    设置默认数据库 default 账号的密码。
    port int
    自定义私网连接地址的端口号。取值范围：1024~65535。若该参数留空，私网连接地址默认使用6379端口。实例创建成功后，还可以修改私网地址的端口号，修改方法请参见修改端口号。
    private_address str
    实例私网连接地址的域名。
    project_name str
    实例所属的项目。
    purchase_months int
    购买时长，单位：月。取值范围如下：按月购买：1，2，3，4，5，6，7，8，9。按年购买：12，24，36。当ChargeType为PrePaid时，该参数必填。
    reserve_additional_bandwidth bool
    设置是否保留额外带宽
    service_type str
    实例的服务类型
    shard_capacity int
    实例中每个分片的内存容量。单位：MiB。
    shard_number int
    实例中的分片数量。取值范围为 2~256。仅当 ShardedCluster 取值为 1（即启用分片集群）时，需要指定该参数。
    sharded_cluster int
    是否启用分片集群。取值范围如下：0：不启用。1：启用。
    status str
    实例的服务类型，取值范围如下：Basic（默认值）：社区版；Enterprise：企业版。
    subnet_id str
    设置实例的子网ID。子网具有可用区属性，必须选择目标私有网络中与实例属于同一可用区下的子网。子网是私有网络内的IP地址块私有网络中的所有云资源都必须部署在子网内，子网为云资源分配私网IP地址，您可以调用CreateSubnet接口创建子网。您可以调用DescribeSubnets接口查询指定可用区内的所有子网列表信息，包括子网ID。
    tags Sequence[InstanceTagArgs]
    vi_pv6 str
    实例私网连接地址所对应的 IPv6 地址。仅当实例使用了 IPv6 地址时才会返回该参数。
    vip str
    实例私网连接地址所对应的 IPv4 地址。
    visit_addrs Sequence[InstanceVisitAddrArgs]
    vpc_auth_mode str
    开启或关闭免密访问功能。取值范围如下：open：开启免密访问；close：关闭免密访问。参数取值不区分大小写。
    vpc_id str
    设置实例的私有网络ID。建议Redis实例与需要连接的ECS实例在同一私有网络，否则它们无法通过内网互通来实现最佳性能。您可以调用CreateVpc接口创建私有网络。您可以调用DescribeVpcs接口查询符合指定条件的私有网络信息，包括私有网络ID。
    zone_ids Sequence[str]
    实例所在的可用区列表。
    allowListIds List<String>
    白名单 ID 列表。若该参数留空，新建实例默认不加入任何白名单。您可以调用 DescribeAllowLists 接口查询当前账号下指定地域内的所有 IP 白名单信息，包括白名单 ID 信息。每个实例最多支持绑定 100 个白名单，每次可最多批量绑定 100 个白名单。每个实例最多支持绑定 1000 个 IP 地址或 CIDR 格式的 IP 地址段。
    autoRenew Boolean
    是否开启自动续费。取值范围如下：false（默认值）：不开启。true：开启。
    backupPointName String
    为变更前创建的全量备份设置备份名称。
    capacity Property Map
    实例的容量信息。
    chargeType String
    实例计费类型。取值范围如下：PrePaid：包年包月（也称预付费）。PostPaid：按量计费（也称后付费）。
    configureNodes List<Property Map>
    createBackup Boolean
    是否在变更前创建备份。
    createTime String
    实例的创建时间。
    dataLayout String
    实例的数据存储形态。该参数仅对企业版（即ServiceType为Enterprise）实例有意义；社区版（即ServiceType为Basic）实例不涉及数据存储形态，DataLayout取值固定为RAM。若该参数留空，表示不使用数据存储形态进行筛选。
    deletionProtection String
    开启或关闭实例删除保护功能。
    engineVersion String
    数据库版本号。
    expiredTime String
    实例到期时间。
    instanceClass String
    Redis 实例的类型。取值范围如下：PrimarySecondary：主备实例；Standalone：单节点实例。若该参数留空，表示不使用实例类型条件进行筛选。关于实例类型的更多信息，请参见产品架构。
    instanceId String
    实例 ID。
    instanceName String
    实例名称。命名规则：不能以数字、中划线（-）开头；只能包含中文、字母、数字、下划线（_）和中划线（-）；长度需要在1~128个字符内。
    instanceShards List<Property Map>
    maintenanceTime String
    实例的可维护时间段，格式为HH:mm-HH:mm（UTC+8）。
    maxConnections Number
    实例当前单分片最大连接数。每分片的默认连接数为10000，您也可以根据业务需要调用ModifyDBInstanceMaxConn接口修改单分片的最大连接数。
    multiAz String
    设置实例的可用区部署方案。
    noAuthMode String
    为新建实例开启或关闭免密访问功能。取值范围如下：open：开启免密访问。close（默认值）：关闭免密访问。
    nodeIds List<String>
    Proxy 和 Server 节点 ID 列表。
    nodeNumber Number
    每个分片中的节点数。取值范围为1~6。每个账号在每个地域下默认最多可创建4个256MiB规格的节点，若需要调整配额上限为10个，请参见账号配额。取值为1时表示创建单节点实例；取值大于1时表示创建主备实例。关于两种类型实例的功能特性差异详情，请参见功能特性差异。
    parameterGroupId String
    需要应用到新实例的参数模板。缓存数据库 Redis 版为每个数据库版本都创建了一份默认的系统参数模板，模板中包含了该版本支持设置的所有参数和默认参数值。若该参数留空，默认会根据您设置的数据库版本（即 EngineVersion）为新建实例选择并应用对应版本的系统参数模板。您可以调用 DescribeParameterGroups 接口查询当前账号和地域下的所有参数模板的基本信息，包括参数模板 ID。
    password String
    设置默认数据库 default 账号的密码。
    port Number
    自定义私网连接地址的端口号。取值范围：1024~65535。若该参数留空，私网连接地址默认使用6379端口。实例创建成功后，还可以修改私网地址的端口号，修改方法请参见修改端口号。
    privateAddress String
    实例私网连接地址的域名。
    projectName String
    实例所属的项目。
    purchaseMonths Number
    购买时长，单位：月。取值范围如下：按月购买：1，2，3，4，5，6，7，8，9。按年购买：12，24，36。当ChargeType为PrePaid时，该参数必填。
    reserveAdditionalBandwidth Boolean
    设置是否保留额外带宽
    serviceType String
    实例的服务类型
    shardCapacity Number
    实例中每个分片的内存容量。单位：MiB。
    shardNumber Number
    实例中的分片数量。取值范围为 2~256。仅当 ShardedCluster 取值为 1（即启用分片集群）时，需要指定该参数。
    shardedCluster Number
    是否启用分片集群。取值范围如下：0：不启用。1：启用。
    status String
    实例的服务类型，取值范围如下：Basic（默认值）：社区版；Enterprise：企业版。
    subnetId String
    设置实例的子网ID。子网具有可用区属性，必须选择目标私有网络中与实例属于同一可用区下的子网。子网是私有网络内的IP地址块私有网络中的所有云资源都必须部署在子网内，子网为云资源分配私网IP地址，您可以调用CreateSubnet接口创建子网。您可以调用DescribeSubnets接口查询指定可用区内的所有子网列表信息，包括子网ID。
    tags List<Property Map>
    viPv6 String
    实例私网连接地址所对应的 IPv6 地址。仅当实例使用了 IPv6 地址时才会返回该参数。
    vip String
    实例私网连接地址所对应的 IPv4 地址。
    visitAddrs List<Property Map>
    vpcAuthMode String
    开启或关闭免密访问功能。取值范围如下：open：开启免密访问；close：关闭免密访问。参数取值不区分大小写。
    vpcId String
    设置实例的私有网络ID。建议Redis实例与需要连接的ECS实例在同一私有网络，否则它们无法通过内网互通来实现最佳性能。您可以调用CreateVpc接口创建私有网络。您可以调用DescribeVpcs接口查询符合指定条件的私有网络信息，包括私有网络ID。
    zoneIds List<String>
    实例所在的可用区列表。

    Supporting Types

    InstanceCapacity, InstanceCapacityArgs

    Total int
    当前实例的内存总容量。单位：MiB。
    Used int
    当前实例已用容量。单位：MiB。
    Total int
    当前实例的内存总容量。单位：MiB。
    Used int
    当前实例已用容量。单位：MiB。
    total Integer
    当前实例的内存总容量。单位：MiB。
    used Integer
    当前实例已用容量。单位：MiB。
    total number
    当前实例的内存总容量。单位：MiB。
    used number
    当前实例已用容量。单位：MiB。
    total int
    当前实例的内存总容量。单位：MiB。
    used int
    当前实例已用容量。单位：MiB。
    total Number
    当前实例的内存总容量。单位：MiB。
    used Number
    当前实例已用容量。单位：MiB。

    InstanceConfigureNode, InstanceConfigureNodeArgs

    Az string
    每个节点所属的可用区。
    Az string
    每个节点所属的可用区。
    az String
    每个节点所属的可用区。
    az string
    每个节点所属的可用区。
    az str
    每个节点所属的可用区。
    az String
    每个节点所属的可用区。

    InstanceInstanceShard, InstanceInstanceShardArgs

    NodeNumber int
    分片中的节点数量
    ServerNodes []InstanceInstanceShardServerNode
    ShardId string
    分片 ID。
    nodeNumber Integer
    分片中的节点数量
    serverNodes List<InstanceInstanceShardServerNode>
    shardId String
    分片 ID。
    nodeNumber number
    分片中的节点数量
    serverNodes InstanceInstanceShardServerNode[]
    shardId string
    分片 ID。
    nodeNumber Number
    分片中的节点数量
    serverNodes List<Property Map>
    shardId String
    分片 ID。

    InstanceInstanceShardServerNode, InstanceInstanceShardServerNodeArgs

    CurrentRole string
    节点当前的角色。取值范围如下：PrimaryNode：主节点。SecondaryNode：从节点。
    NodeId string
    节点 ID。
    Status string
    节点状态。取值范围如下：deploy：启动中。running：运行中。loading：数据加载中。error：错误。
    ZoneId string
    节点所在的可用区。
    CurrentRole string
    节点当前的角色。取值范围如下：PrimaryNode：主节点。SecondaryNode：从节点。
    NodeId string
    节点 ID。
    Status string
    节点状态。取值范围如下：deploy：启动中。running：运行中。loading：数据加载中。error：错误。
    ZoneId string
    节点所在的可用区。
    currentRole String
    节点当前的角色。取值范围如下：PrimaryNode：主节点。SecondaryNode：从节点。
    nodeId String
    节点 ID。
    status String
    节点状态。取值范围如下：deploy：启动中。running：运行中。loading：数据加载中。error：错误。
    zoneId String
    节点所在的可用区。
    currentRole string
    节点当前的角色。取值范围如下：PrimaryNode：主节点。SecondaryNode：从节点。
    nodeId string
    节点 ID。
    status string
    节点状态。取值范围如下：deploy：启动中。running：运行中。loading：数据加载中。error：错误。
    zoneId string
    节点所在的可用区。
    current_role str
    节点当前的角色。取值范围如下：PrimaryNode：主节点。SecondaryNode：从节点。
    node_id str
    节点 ID。
    status str
    节点状态。取值范围如下：deploy：启动中。running：运行中。loading：数据加载中。error：错误。
    zone_id str
    节点所在的可用区。
    currentRole String
    节点当前的角色。取值范围如下：PrimaryNode：主节点。SecondaryNode：从节点。
    nodeId String
    节点 ID。
    status String
    节点状态。取值范围如下：deploy：启动中。running：运行中。loading：数据加载中。error：错误。
    zoneId String
    节点所在的可用区。

    InstanceTag, InstanceTagArgs

    Key string
    标签键。
    Value string
    标签值。
    Key string
    标签键。
    Value string
    标签值。
    key String
    标签键。
    value String
    标签值。
    key string
    标签键。
    value string
    标签值。
    key str
    标签键。
    value str
    标签值。
    key String
    标签键。
    value String
    标签值。

    InstanceVisitAddr, InstanceVisitAddrArgs

    AddrType string
    连接地址类型，取值范围如下：Private：私网连接地址；Public：公网连接地址；DirectLink：直连地址。
    Address string
    IP 地址或者域名。
    EipId string
    实例公网地址所绑定的EIP ID。仅当连接地址类型（即AddrType）为Public公网连接地址时，返回该参数。
    Port string
    端口号。
    ViPv6 string
    连接地址所对应的 IPv6 地址。
    Vip string
    连接地址所对应的 IPv4 地址。
    AddrType string
    连接地址类型，取值范围如下：Private：私网连接地址；Public：公网连接地址；DirectLink：直连地址。
    Address string
    IP 地址或者域名。
    EipId string
    实例公网地址所绑定的EIP ID。仅当连接地址类型（即AddrType）为Public公网连接地址时，返回该参数。
    Port string
    端口号。
    ViPv6 string
    连接地址所对应的 IPv6 地址。
    Vip string
    连接地址所对应的 IPv4 地址。
    addrType String
    连接地址类型，取值范围如下：Private：私网连接地址；Public：公网连接地址；DirectLink：直连地址。
    address String
    IP 地址或者域名。
    eipId String
    实例公网地址所绑定的EIP ID。仅当连接地址类型（即AddrType）为Public公网连接地址时，返回该参数。
    port String
    端口号。
    viPv6 String
    连接地址所对应的 IPv6 地址。
    vip String
    连接地址所对应的 IPv4 地址。
    addrType string
    连接地址类型，取值范围如下：Private：私网连接地址；Public：公网连接地址；DirectLink：直连地址。
    address string
    IP 地址或者域名。
    eipId string
    实例公网地址所绑定的EIP ID。仅当连接地址类型（即AddrType）为Public公网连接地址时，返回该参数。
    port string
    端口号。
    viPv6 string
    连接地址所对应的 IPv6 地址。
    vip string
    连接地址所对应的 IPv4 地址。
    addr_type str
    连接地址类型，取值范围如下：Private：私网连接地址；Public：公网连接地址；DirectLink：直连地址。
    address str
    IP 地址或者域名。
    eip_id str
    实例公网地址所绑定的EIP ID。仅当连接地址类型（即AddrType）为Public公网连接地址时，返回该参数。
    port str
    端口号。
    vi_pv6 str
    连接地址所对应的 IPv6 地址。
    vip str
    连接地址所对应的 IPv4 地址。
    addrType String
    连接地址类型，取值范围如下：Private：私网连接地址；Public：公网连接地址；DirectLink：直连地址。
    address String
    IP 地址或者域名。
    eipId String
    实例公网地址所绑定的EIP ID。仅当连接地址类型（即AddrType）为Public公网连接地址时，返回该参数。
    port String
    端口号。
    viPv6 String
    连接地址所对应的 IPv6 地址。
    vip String
    连接地址所对应的 IPv4 地址。

    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
    volcenginecc v0.0.3 published on Thursday, Oct 30, 2025 by Volcengine
    volcengine/pulumi-volcenginecc
      Meet Neo: Your AI Platform Teammate