1. Packages
  2. Volcengine
  3. API Docs
  4. redis
  5. Instances
Volcengine v0.0.27 published on Tuesday, Dec 10, 2024 by Volcengine

volcengine.redis.Instances

Explore with Pulumi AI

Volcengine v0.0.27 published on Tuesday, Dec 10, 2024 by Volcengine

Use this data source to query detailed information of redis instances

Example Usage

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

const fooZones = volcengine.ecs.Zones({});
const fooVpc = new volcengine.vpc.Vpc("fooVpc", {
    vpcName: "acc-test-vpc",
    cidrBlock: "172.16.0.0/16",
});
const fooSubnet = new volcengine.vpc.Subnet("fooSubnet", {
    subnetName: "acc-test-subnet",
    cidrBlock: "172.16.0.0/24",
    zoneId: fooZones.then(fooZones => fooZones.zones?.[0]?.id),
    vpcId: fooVpc.id,
});
const fooInstance = new volcengine.redis.Instance("fooInstance", {
    zoneIds: [fooZones.then(fooZones => fooZones.zones?.[0]?.id)],
    instanceName: "acc-test-tf-redis",
    shardedCluster: 1,
    password: "1qaz!QAZ12",
    nodeNumber: 2,
    shardCapacity: 1024,
    shardNumber: 2,
    engineVersion: "5.0",
    subnetId: fooSubnet.id,
    deletionProtection: "disabled",
    vpcAuthMode: "close",
    chargeType: "PostPaid",
    port: 6381,
    projectName: "default",
});
const fooInstances = volcengine.redis.InstancesOutput({
    instanceId: fooInstance.id,
});
Copy
import pulumi
import pulumi_volcengine as volcengine

foo_zones = volcengine.ecs.zones()
foo_vpc = volcengine.vpc.Vpc("fooVpc",
    vpc_name="acc-test-vpc",
    cidr_block="172.16.0.0/16")
foo_subnet = volcengine.vpc.Subnet("fooSubnet",
    subnet_name="acc-test-subnet",
    cidr_block="172.16.0.0/24",
    zone_id=foo_zones.zones[0].id,
    vpc_id=foo_vpc.id)
foo_instance = volcengine.redis.Instance("fooInstance",
    zone_ids=[foo_zones.zones[0].id],
    instance_name="acc-test-tf-redis",
    sharded_cluster=1,
    password="1qaz!QAZ12",
    node_number=2,
    shard_capacity=1024,
    shard_number=2,
    engine_version="5.0",
    subnet_id=foo_subnet.id,
    deletion_protection="disabled",
    vpc_auth_mode="close",
    charge_type="PostPaid",
    port=6381,
    project_name="default")
foo_instances = volcengine.redis.instances_output(instance_id=foo_instance.id)
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		fooZones, err := ecs.Zones(ctx, nil, nil)
		if err != nil {
			return err
		}
		fooVpc, err := vpc.NewVpc(ctx, "fooVpc", &vpc.VpcArgs{
			VpcName:   pulumi.String("acc-test-vpc"),
			CidrBlock: pulumi.String("172.16.0.0/16"),
		})
		if err != nil {
			return err
		}
		fooSubnet, err := vpc.NewSubnet(ctx, "fooSubnet", &vpc.SubnetArgs{
			SubnetName: pulumi.String("acc-test-subnet"),
			CidrBlock:  pulumi.String("172.16.0.0/24"),
			ZoneId:     pulumi.String(fooZones.Zones[0].Id),
			VpcId:      fooVpc.ID(),
		})
		if err != nil {
			return err
		}
		fooInstance, err := redis.NewInstance(ctx, "fooInstance", &redis.InstanceArgs{
			ZoneIds: pulumi.StringArray{
				pulumi.String(fooZones.Zones[0].Id),
			},
			InstanceName:       pulumi.String("acc-test-tf-redis"),
			ShardedCluster:     pulumi.Int(1),
			Password:           pulumi.String("1qaz!QAZ12"),
			NodeNumber:         pulumi.Int(2),
			ShardCapacity:      pulumi.Int(1024),
			ShardNumber:        pulumi.Int(2),
			EngineVersion:      pulumi.String("5.0"),
			SubnetId:           fooSubnet.ID(),
			DeletionProtection: pulumi.String("disabled"),
			VpcAuthMode:        pulumi.String("close"),
			ChargeType:         pulumi.String("PostPaid"),
			Port:               pulumi.Int(6381),
			ProjectName:        pulumi.String("default"),
		})
		if err != nil {
			return err
		}
		_ = redis.InstancesOutput(ctx, redis.InstancesOutputArgs{
			InstanceId: fooInstance.ID(),
		}, nil)
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Volcengine = Pulumi.Volcengine;

return await Deployment.RunAsync(() => 
{
    var fooZones = Volcengine.Ecs.Zones.Invoke();

    var fooVpc = new Volcengine.Vpc.Vpc("fooVpc", new()
    {
        VpcName = "acc-test-vpc",
        CidrBlock = "172.16.0.0/16",
    });

    var fooSubnet = new Volcengine.Vpc.Subnet("fooSubnet", new()
    {
        SubnetName = "acc-test-subnet",
        CidrBlock = "172.16.0.0/24",
        ZoneId = fooZones.Apply(zonesResult => zonesResult.Zones[0]?.Id),
        VpcId = fooVpc.Id,
    });

    var fooInstance = new Volcengine.Redis.Instance("fooInstance", new()
    {
        ZoneIds = new[]
        {
            fooZones.Apply(zonesResult => zonesResult.Zones[0]?.Id),
        },
        InstanceName = "acc-test-tf-redis",
        ShardedCluster = 1,
        Password = "1qaz!QAZ12",
        NodeNumber = 2,
        ShardCapacity = 1024,
        ShardNumber = 2,
        EngineVersion = "5.0",
        SubnetId = fooSubnet.Id,
        DeletionProtection = "disabled",
        VpcAuthMode = "close",
        ChargeType = "PostPaid",
        Port = 6381,
        ProjectName = "default",
    });

    var fooInstances = Volcengine.Redis.Instances.Invoke(new()
    {
        InstanceId = fooInstance.Id,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.ecs.EcsFunctions;
import com.pulumi.volcengine.ecs.inputs.ZonesArgs;
import com.pulumi.volcengine.vpc.Vpc;
import com.pulumi.volcengine.vpc.VpcArgs;
import com.pulumi.volcengine.vpc.Subnet;
import com.pulumi.volcengine.vpc.SubnetArgs;
import com.pulumi.volcengine.redis.Instance;
import com.pulumi.volcengine.redis.InstanceArgs;
import com.pulumi.volcengine.redis.RedisFunctions;
import com.pulumi.volcengine.redis.inputs.InstancesArgs;
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) {
        final var fooZones = EcsFunctions.Zones();

        var fooVpc = new Vpc("fooVpc", VpcArgs.builder()        
            .vpcName("acc-test-vpc")
            .cidrBlock("172.16.0.0/16")
            .build());

        var fooSubnet = new Subnet("fooSubnet", SubnetArgs.builder()        
            .subnetName("acc-test-subnet")
            .cidrBlock("172.16.0.0/24")
            .zoneId(fooZones.applyValue(zonesResult -> zonesResult.zones()[0].id()))
            .vpcId(fooVpc.id())
            .build());

        var fooInstance = new Instance("fooInstance", InstanceArgs.builder()        
            .zoneIds(fooZones.applyValue(zonesResult -> zonesResult.zones()[0].id()))
            .instanceName("acc-test-tf-redis")
            .shardedCluster(1)
            .password("1qaz!QAZ12")
            .nodeNumber(2)
            .shardCapacity(1024)
            .shardNumber(2)
            .engineVersion("5.0")
            .subnetId(fooSubnet.id())
            .deletionProtection("disabled")
            .vpcAuthMode("close")
            .chargeType("PostPaid")
            .port(6381)
            .projectName("default")
            .build());

        final var fooInstances = RedisFunctions.Instances(InstancesArgs.builder()
            .instanceId(fooInstance.id())
            .build());

    }
}
Copy
resources:
  fooVpc:
    type: volcengine:vpc:Vpc
    properties:
      vpcName: acc-test-vpc
      cidrBlock: 172.16.0.0/16
  fooSubnet:
    type: volcengine:vpc:Subnet
    properties:
      subnetName: acc-test-subnet
      cidrBlock: 172.16.0.0/24
      zoneId: ${fooZones.zones[0].id}
      vpcId: ${fooVpc.id}
  fooInstance:
    type: volcengine:redis:Instance
    properties:
      zoneIds:
        - ${fooZones.zones[0].id}
      instanceName: acc-test-tf-redis
      shardedCluster: 1
      password: 1qaz!QAZ12
      nodeNumber: 2
      shardCapacity: 1024
      shardNumber: 2
      engineVersion: '5.0'
      subnetId: ${fooSubnet.id}
      deletionProtection: disabled
      vpcAuthMode: close
      chargeType: PostPaid
      port: 6381
      projectName: default
variables:
  fooZones:
    fn::invoke:
      Function: volcengine:ecs:Zones
      Arguments: {}
  fooInstances:
    fn::invoke:
      Function: volcengine:redis:Instances
      Arguments:
        instanceId: ${fooInstance.id}
Copy

Using Instances

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function instances(args: InstancesArgs, opts?: InvokeOptions): Promise<InstancesResult>
function instancesOutput(args: InstancesOutputArgs, opts?: InvokeOptions): Output<InstancesResult>
Copy
def instances(charge_type: Optional[str] = None,
              engine_version: Optional[str] = None,
              instance_id: Optional[str] = None,
              instance_name: Optional[str] = None,
              name_regex: Optional[str] = None,
              output_file: Optional[str] = None,
              project_name: Optional[str] = None,
              sharded_cluster: Optional[int] = None,
              status: Optional[str] = None,
              tags: Optional[Sequence[InstancesTag]] = None,
              vpc_id: Optional[str] = None,
              zone_id: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> InstancesResult
def instances_output(charge_type: Optional[pulumi.Input[str]] = None,
              engine_version: Optional[pulumi.Input[str]] = None,
              instance_id: Optional[pulumi.Input[str]] = None,
              instance_name: Optional[pulumi.Input[str]] = None,
              name_regex: Optional[pulumi.Input[str]] = None,
              output_file: Optional[pulumi.Input[str]] = None,
              project_name: Optional[pulumi.Input[str]] = None,
              sharded_cluster: Optional[pulumi.Input[int]] = None,
              status: Optional[pulumi.Input[str]] = None,
              tags: Optional[pulumi.Input[Sequence[pulumi.Input[InstancesTagArgs]]]] = None,
              vpc_id: Optional[pulumi.Input[str]] = None,
              zone_id: Optional[pulumi.Input[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[InstancesResult]
Copy
func Instances(ctx *Context, args *InstancesArgs, opts ...InvokeOption) (*InstancesResult, error)
func InstancesOutput(ctx *Context, args *InstancesOutputArgs, opts ...InvokeOption) InstancesResultOutput
Copy
public static class Instances 
{
    public static Task<InstancesResult> InvokeAsync(InstancesArgs args, InvokeOptions? opts = null)
    public static Output<InstancesResult> Invoke(InstancesInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<InstancesResult> instances(InstancesArgs args, InvokeOptions options)
public static Output<InstancesResult> instances(InstancesArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: volcengine:redis:Instances
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ChargeType string
The charge type of redis instance to query. Valid values: PostPaid, PrePaid.
EngineVersion string
The engine version of redis instance to query. Valid values: 4.0, 5.0, 6.0.
InstanceId string
The id of redis instance to query. This field supports fuzzy queries.
InstanceName string
The name of redis instance to query. This field supports fuzzy queries.
NameRegex string
A name regex of redis.
OutputFile string
File name where to save data source results.
ProjectName string
The project name of redis instance to query.
ShardedCluster int
Whether enable sharded cluster for redis instance. Valid values: 0, 1.
Status string
The status of redis instance to query.
Tags List<InstancesTag>
Tags.
VpcId string
The vpc id of redis instance to query. This field supports fuzzy queries.
ZoneId string
The zone id of redis instance to query. This field supports fuzzy queries.
ChargeType string
The charge type of redis instance to query. Valid values: PostPaid, PrePaid.
EngineVersion string
The engine version of redis instance to query. Valid values: 4.0, 5.0, 6.0.
InstanceId string
The id of redis instance to query. This field supports fuzzy queries.
InstanceName string
The name of redis instance to query. This field supports fuzzy queries.
NameRegex string
A name regex of redis.
OutputFile string
File name where to save data source results.
ProjectName string
The project name of redis instance to query.
ShardedCluster int
Whether enable sharded cluster for redis instance. Valid values: 0, 1.
Status string
The status of redis instance to query.
Tags []InstancesTag
Tags.
VpcId string
The vpc id of redis instance to query. This field supports fuzzy queries.
ZoneId string
The zone id of redis instance to query. This field supports fuzzy queries.
chargeType String
The charge type of redis instance to query. Valid values: PostPaid, PrePaid.
engineVersion String
The engine version of redis instance to query. Valid values: 4.0, 5.0, 6.0.
instanceId String
The id of redis instance to query. This field supports fuzzy queries.
instanceName String
The name of redis instance to query. This field supports fuzzy queries.
nameRegex String
A name regex of redis.
outputFile String
File name where to save data source results.
projectName String
The project name of redis instance to query.
shardedCluster Integer
Whether enable sharded cluster for redis instance. Valid values: 0, 1.
status String
The status of redis instance to query.
tags List<InstancesTag>
Tags.
vpcId String
The vpc id of redis instance to query. This field supports fuzzy queries.
zoneId String
The zone id of redis instance to query. This field supports fuzzy queries.
chargeType string
The charge type of redis instance to query. Valid values: PostPaid, PrePaid.
engineVersion string
The engine version of redis instance to query. Valid values: 4.0, 5.0, 6.0.
instanceId string
The id of redis instance to query. This field supports fuzzy queries.
instanceName string
The name of redis instance to query. This field supports fuzzy queries.
nameRegex string
A name regex of redis.
outputFile string
File name where to save data source results.
projectName string
The project name of redis instance to query.
shardedCluster number
Whether enable sharded cluster for redis instance. Valid values: 0, 1.
status string
The status of redis instance to query.
tags InstancesTag[]
Tags.
vpcId string
The vpc id of redis instance to query. This field supports fuzzy queries.
zoneId string
The zone id of redis instance to query. This field supports fuzzy queries.
charge_type str
The charge type of redis instance to query. Valid values: PostPaid, PrePaid.
engine_version str
The engine version of redis instance to query. Valid values: 4.0, 5.0, 6.0.
instance_id str
The id of redis instance to query. This field supports fuzzy queries.
instance_name str
The name of redis instance to query. This field supports fuzzy queries.
name_regex str
A name regex of redis.
output_file str
File name where to save data source results.
project_name str
The project name of redis instance to query.
sharded_cluster int
Whether enable sharded cluster for redis instance. Valid values: 0, 1.
status str
The status of redis instance to query.
tags Sequence[InstancesTag]
Tags.
vpc_id str
The vpc id of redis instance to query. This field supports fuzzy queries.
zone_id str
The zone id of redis instance to query. This field supports fuzzy queries.
chargeType String
The charge type of redis instance to query. Valid values: PostPaid, PrePaid.
engineVersion String
The engine version of redis instance to query. Valid values: 4.0, 5.0, 6.0.
instanceId String
The id of redis instance to query. This field supports fuzzy queries.
instanceName String
The name of redis instance to query. This field supports fuzzy queries.
nameRegex String
A name regex of redis.
outputFile String
File name where to save data source results.
projectName String
The project name of redis instance to query.
shardedCluster Number
Whether enable sharded cluster for redis instance. Valid values: 0, 1.
status String
The status of redis instance to query.
tags List<Property Map>
Tags.
vpcId String
The vpc id of redis instance to query. This field supports fuzzy queries.
zoneId String
The zone id of redis instance to query. This field supports fuzzy queries.

Instances Result

The following output properties are available:

Id string
The provider-assigned unique ID for this managed resource.
Instances List<InstancesInstance>
The collection of redis instances query.
TotalCount int
The total count of redis instances query.
ChargeType string
The charge type of the redis instance.
EngineVersion string
The engine version of the redis instance.
InstanceId string
The id of the redis instance.
InstanceName string
The name of the redis instance.
NameRegex string
OutputFile string
ProjectName string
The project name of the redis instance.
ShardedCluster int
Whether enable sharded cluster for the redis instance.
Status string
The status of the redis instance.
Tags List<InstancesTag>
Tags.
VpcId string
The vpc ID of the redis instance.
ZoneId string
Id string
The provider-assigned unique ID for this managed resource.
Instances []InstancesInstance
The collection of redis instances query.
TotalCount int
The total count of redis instances query.
ChargeType string
The charge type of the redis instance.
EngineVersion string
The engine version of the redis instance.
InstanceId string
The id of the redis instance.
InstanceName string
The name of the redis instance.
NameRegex string
OutputFile string
ProjectName string
The project name of the redis instance.
ShardedCluster int
Whether enable sharded cluster for the redis instance.
Status string
The status of the redis instance.
Tags []InstancesTag
Tags.
VpcId string
The vpc ID of the redis instance.
ZoneId string
id String
The provider-assigned unique ID for this managed resource.
instances List<InstancesInstance>
The collection of redis instances query.
totalCount Integer
The total count of redis instances query.
chargeType String
The charge type of the redis instance.
engineVersion String
The engine version of the redis instance.
instanceId String
The id of the redis instance.
instanceName String
The name of the redis instance.
nameRegex String
outputFile String
projectName String
The project name of the redis instance.
shardedCluster Integer
Whether enable sharded cluster for the redis instance.
status String
The status of the redis instance.
tags List<InstancesTag>
Tags.
vpcId String
The vpc ID of the redis instance.
zoneId String
id string
The provider-assigned unique ID for this managed resource.
instances InstancesInstance[]
The collection of redis instances query.
totalCount number
The total count of redis instances query.
chargeType string
The charge type of the redis instance.
engineVersion string
The engine version of the redis instance.
instanceId string
The id of the redis instance.
instanceName string
The name of the redis instance.
nameRegex string
outputFile string
projectName string
The project name of the redis instance.
shardedCluster number
Whether enable sharded cluster for the redis instance.
status string
The status of the redis instance.
tags InstancesTag[]
Tags.
vpcId string
The vpc ID of the redis instance.
zoneId string
id str
The provider-assigned unique ID for this managed resource.
instances Sequence[InstancesInstance]
The collection of redis instances query.
total_count int
The total count of redis instances query.
charge_type str
The charge type of the redis instance.
engine_version str
The engine version of the redis instance.
instance_id str
The id of the redis instance.
instance_name str
The name of the redis instance.
name_regex str
output_file str
project_name str
The project name of the redis instance.
sharded_cluster int
Whether enable sharded cluster for the redis instance.
status str
The status of the redis instance.
tags Sequence[InstancesTag]
Tags.
vpc_id str
The vpc ID of the redis instance.
zone_id str
id String
The provider-assigned unique ID for this managed resource.
instances List<Property Map>
The collection of redis instances query.
totalCount Number
The total count of redis instances query.
chargeType String
The charge type of the redis instance.
engineVersion String
The engine version of the redis instance.
instanceId String
The id of the redis instance.
instanceName String
The name of the redis instance.
nameRegex String
outputFile String
projectName String
The project name of the redis instance.
shardedCluster Number
Whether enable sharded cluster for the redis instance.
status String
The status of the redis instance.
tags List<Property Map>
Tags.
vpcId String
The vpc ID of the redis instance.
zoneId String

Supporting Types

InstancesInstance

BackupPlan This property is required. InstancesInstanceBackupPlan
The list of backup plans.
Capacity This property is required. InstancesInstanceCapacity
The memory capacity information.
ChargeType This property is required. string
The charge type of redis instance to query. Valid values: PostPaid, PrePaid.
ConfigureNodes This property is required. List<InstancesInstanceConfigureNode>
Set the list of available zones to which the node belongs.
CreateTime This property is required. string
The creation time of the redis instance.
DeletionProtection This property is required. string
whether enable deletion protection.
EngineVersion This property is required. string
The engine version of redis instance to query. Valid values: 4.0, 5.0, 6.0.
ExpiredTime This property is required. string
The expire time of the redis instance, valid when charge type is PrePaid.
Id This property is required. string
The id of the redis instance.
InstanceId This property is required. string
The id of redis instance to query. This field supports fuzzy queries.
InstanceName This property is required. string
The name of redis instance to query. This field supports fuzzy queries.
MaintenanceTime This property is required. string
The maintainable time of the redis instance.
MultiAz This property is required. string
Set the availability zone deployment scheme for the instance. The value range is as follows: disabled: Single availability zone deployment scheme. enabled: Multi-availability zone deployment scheme. Description: When the newly created instance is a single-node instance (that is, when the value of NodeNumber is 1), only the single availability zone deployment scheme is allowed. At this time, the value of MultiAZ must be disabled.
NodeIds This property is required. List<string>
The list of redis instance node IDs.
NodeNumber This property is required. int
The number of nodes in each shard.
Params This property is required. List<InstancesInstanceParam>
The list of params.
ProjectName This property is required. string
The project name of redis instance to query.
RegionId This property is required. string
The region id of the redis instance.
ShardCapacity This property is required. double
The memory capacity of each shard. Unit: GiB.
ShardNumber This property is required. int
The number of shards in the redis instance.
ShardedCluster This property is required. int
Whether enable sharded cluster for redis instance. Valid values: 0, 1.
Status This property is required. string
The status of redis instance to query.
SubnetId This property is required. string
The subnet id of the redis instance.
Tags This property is required. List<InstancesInstanceTag>
Tags.
VisitAddrs This property is required. List<InstancesInstanceVisitAddr>
The list of connection information.
VpcAuthMode This property is required. string
Whether to enable password-free access when connecting to an instance through a private network.
VpcId This property is required. string
The vpc id of redis instance to query. This field supports fuzzy queries.
ZoneIds This property is required. List<string>
The list of zone ID which the redis instance belongs.
BackupPlan This property is required. InstancesInstanceBackupPlan
The list of backup plans.
Capacity This property is required. InstancesInstanceCapacity
The memory capacity information.
ChargeType This property is required. string
The charge type of redis instance to query. Valid values: PostPaid, PrePaid.
ConfigureNodes This property is required. []InstancesInstanceConfigureNode
Set the list of available zones to which the node belongs.
CreateTime This property is required. string
The creation time of the redis instance.
DeletionProtection This property is required. string
whether enable deletion protection.
EngineVersion This property is required. string
The engine version of redis instance to query. Valid values: 4.0, 5.0, 6.0.
ExpiredTime This property is required. string
The expire time of the redis instance, valid when charge type is PrePaid.
Id This property is required. string
The id of the redis instance.
InstanceId This property is required. string
The id of redis instance to query. This field supports fuzzy queries.
InstanceName This property is required. string
The name of redis instance to query. This field supports fuzzy queries.
MaintenanceTime This property is required. string
The maintainable time of the redis instance.
MultiAz This property is required. string
Set the availability zone deployment scheme for the instance. The value range is as follows: disabled: Single availability zone deployment scheme. enabled: Multi-availability zone deployment scheme. Description: When the newly created instance is a single-node instance (that is, when the value of NodeNumber is 1), only the single availability zone deployment scheme is allowed. At this time, the value of MultiAZ must be disabled.
NodeIds This property is required. []string
The list of redis instance node IDs.
NodeNumber This property is required. int
The number of nodes in each shard.
Params This property is required. []InstancesInstanceParam
The list of params.
ProjectName This property is required. string
The project name of redis instance to query.
RegionId This property is required. string
The region id of the redis instance.
ShardCapacity This property is required. float64
The memory capacity of each shard. Unit: GiB.
ShardNumber This property is required. int
The number of shards in the redis instance.
ShardedCluster This property is required. int
Whether enable sharded cluster for redis instance. Valid values: 0, 1.
Status This property is required. string
The status of redis instance to query.
SubnetId This property is required. string
The subnet id of the redis instance.
Tags This property is required. []InstancesInstanceTag
Tags.
VisitAddrs This property is required. []InstancesInstanceVisitAddr
The list of connection information.
VpcAuthMode This property is required. string
Whether to enable password-free access when connecting to an instance through a private network.
VpcId This property is required. string
The vpc id of redis instance to query. This field supports fuzzy queries.
ZoneIds This property is required. []string
The list of zone ID which the redis instance belongs.
backupPlan This property is required. InstancesInstanceBackupPlan
The list of backup plans.
capacity This property is required. InstancesInstanceCapacity
The memory capacity information.
chargeType This property is required. String
The charge type of redis instance to query. Valid values: PostPaid, PrePaid.
configureNodes This property is required. List<InstancesInstanceConfigureNode>
Set the list of available zones to which the node belongs.
createTime This property is required. String
The creation time of the redis instance.
deletionProtection This property is required. String
whether enable deletion protection.
engineVersion This property is required. String
The engine version of redis instance to query. Valid values: 4.0, 5.0, 6.0.
expiredTime This property is required. String
The expire time of the redis instance, valid when charge type is PrePaid.
id This property is required. String
The id of the redis instance.
instanceId This property is required. String
The id of redis instance to query. This field supports fuzzy queries.
instanceName This property is required. String
The name of redis instance to query. This field supports fuzzy queries.
maintenanceTime This property is required. String
The maintainable time of the redis instance.
multiAz This property is required. String
Set the availability zone deployment scheme for the instance. The value range is as follows: disabled: Single availability zone deployment scheme. enabled: Multi-availability zone deployment scheme. Description: When the newly created instance is a single-node instance (that is, when the value of NodeNumber is 1), only the single availability zone deployment scheme is allowed. At this time, the value of MultiAZ must be disabled.
nodeIds This property is required. List<String>
The list of redis instance node IDs.
nodeNumber This property is required. Integer
The number of nodes in each shard.
params This property is required. List<InstancesInstanceParam>
The list of params.
projectName This property is required. String
The project name of redis instance to query.
regionId This property is required. String
The region id of the redis instance.
shardCapacity This property is required. Double
The memory capacity of each shard. Unit: GiB.
shardNumber This property is required. Integer
The number of shards in the redis instance.
shardedCluster This property is required. Integer
Whether enable sharded cluster for redis instance. Valid values: 0, 1.
status This property is required. String
The status of redis instance to query.
subnetId This property is required. String
The subnet id of the redis instance.
tags This property is required. List<InstancesInstanceTag>
Tags.
visitAddrs This property is required. List<InstancesInstanceVisitAddr>
The list of connection information.
vpcAuthMode This property is required. String
Whether to enable password-free access when connecting to an instance through a private network.
vpcId This property is required. String
The vpc id of redis instance to query. This field supports fuzzy queries.
zoneIds This property is required. List<String>
The list of zone ID which the redis instance belongs.
backupPlan This property is required. InstancesInstanceBackupPlan
The list of backup plans.
capacity This property is required. InstancesInstanceCapacity
The memory capacity information.
chargeType This property is required. string
The charge type of redis instance to query. Valid values: PostPaid, PrePaid.
configureNodes This property is required. InstancesInstanceConfigureNode[]
Set the list of available zones to which the node belongs.
createTime This property is required. string
The creation time of the redis instance.
deletionProtection This property is required. string
whether enable deletion protection.
engineVersion This property is required. string
The engine version of redis instance to query. Valid values: 4.0, 5.0, 6.0.
expiredTime This property is required. string
The expire time of the redis instance, valid when charge type is PrePaid.
id This property is required. string
The id of the redis instance.
instanceId This property is required. string
The id of redis instance to query. This field supports fuzzy queries.
instanceName This property is required. string
The name of redis instance to query. This field supports fuzzy queries.
maintenanceTime This property is required. string
The maintainable time of the redis instance.
multiAz This property is required. string
Set the availability zone deployment scheme for the instance. The value range is as follows: disabled: Single availability zone deployment scheme. enabled: Multi-availability zone deployment scheme. Description: When the newly created instance is a single-node instance (that is, when the value of NodeNumber is 1), only the single availability zone deployment scheme is allowed. At this time, the value of MultiAZ must be disabled.
nodeIds This property is required. string[]
The list of redis instance node IDs.
nodeNumber This property is required. number
The number of nodes in each shard.
params This property is required. InstancesInstanceParam[]
The list of params.
projectName This property is required. string
The project name of redis instance to query.
regionId This property is required. string
The region id of the redis instance.
shardCapacity This property is required. number
The memory capacity of each shard. Unit: GiB.
shardNumber This property is required. number
The number of shards in the redis instance.
shardedCluster This property is required. number
Whether enable sharded cluster for redis instance. Valid values: 0, 1.
status This property is required. string
The status of redis instance to query.
subnetId This property is required. string
The subnet id of the redis instance.
tags This property is required. InstancesInstanceTag[]
Tags.
visitAddrs This property is required. InstancesInstanceVisitAddr[]
The list of connection information.
vpcAuthMode This property is required. string
Whether to enable password-free access when connecting to an instance through a private network.
vpcId This property is required. string
The vpc id of redis instance to query. This field supports fuzzy queries.
zoneIds This property is required. string[]
The list of zone ID which the redis instance belongs.
backup_plan This property is required. InstancesInstanceBackupPlan
The list of backup plans.
capacity This property is required. InstancesInstanceCapacity
The memory capacity information.
charge_type This property is required. str
The charge type of redis instance to query. Valid values: PostPaid, PrePaid.
configure_nodes This property is required. Sequence[InstancesInstanceConfigureNode]
Set the list of available zones to which the node belongs.
create_time This property is required. str
The creation time of the redis instance.
deletion_protection This property is required. str
whether enable deletion protection.
engine_version This property is required. str
The engine version of redis instance to query. Valid values: 4.0, 5.0, 6.0.
expired_time This property is required. str
The expire time of the redis instance, valid when charge type is PrePaid.
id This property is required. str
The id of the redis instance.
instance_id This property is required. str
The id of redis instance to query. This field supports fuzzy queries.
instance_name This property is required. str
The name of redis instance to query. This field supports fuzzy queries.
maintenance_time This property is required. str
The maintainable time of the redis instance.
multi_az This property is required. str
Set the availability zone deployment scheme for the instance. The value range is as follows: disabled: Single availability zone deployment scheme. enabled: Multi-availability zone deployment scheme. Description: When the newly created instance is a single-node instance (that is, when the value of NodeNumber is 1), only the single availability zone deployment scheme is allowed. At this time, the value of MultiAZ must be disabled.
node_ids This property is required. Sequence[str]
The list of redis instance node IDs.
node_number This property is required. int
The number of nodes in each shard.
params This property is required. Sequence[InstancesInstanceParam]
The list of params.
project_name This property is required. str
The project name of redis instance to query.
region_id This property is required. str
The region id of the redis instance.
shard_capacity This property is required. float
The memory capacity of each shard. Unit: GiB.
shard_number This property is required. int
The number of shards in the redis instance.
sharded_cluster This property is required. int
Whether enable sharded cluster for redis instance. Valid values: 0, 1.
status This property is required. str
The status of redis instance to query.
subnet_id This property is required. str
The subnet id of the redis instance.
tags This property is required. Sequence[InstancesInstanceTag]
Tags.
visit_addrs This property is required. Sequence[InstancesInstanceVisitAddr]
The list of connection information.
vpc_auth_mode This property is required. str
Whether to enable password-free access when connecting to an instance through a private network.
vpc_id This property is required. str
The vpc id of redis instance to query. This field supports fuzzy queries.
zone_ids This property is required. Sequence[str]
The list of zone ID which the redis instance belongs.
backupPlan This property is required. Property Map
The list of backup plans.
capacity This property is required. Property Map
The memory capacity information.
chargeType This property is required. String
The charge type of redis instance to query. Valid values: PostPaid, PrePaid.
configureNodes This property is required. List<Property Map>
Set the list of available zones to which the node belongs.
createTime This property is required. String
The creation time of the redis instance.
deletionProtection This property is required. String
whether enable deletion protection.
engineVersion This property is required. String
The engine version of redis instance to query. Valid values: 4.0, 5.0, 6.0.
expiredTime This property is required. String
The expire time of the redis instance, valid when charge type is PrePaid.
id This property is required. String
The id of the redis instance.
instanceId This property is required. String
The id of redis instance to query. This field supports fuzzy queries.
instanceName This property is required. String
The name of redis instance to query. This field supports fuzzy queries.
maintenanceTime This property is required. String
The maintainable time of the redis instance.
multiAz This property is required. String
Set the availability zone deployment scheme for the instance. The value range is as follows: disabled: Single availability zone deployment scheme. enabled: Multi-availability zone deployment scheme. Description: When the newly created instance is a single-node instance (that is, when the value of NodeNumber is 1), only the single availability zone deployment scheme is allowed. At this time, the value of MultiAZ must be disabled.
nodeIds This property is required. List<String>
The list of redis instance node IDs.
nodeNumber This property is required. Number
The number of nodes in each shard.
params This property is required. List<Property Map>
The list of params.
projectName This property is required. String
The project name of redis instance to query.
regionId This property is required. String
The region id of the redis instance.
shardCapacity This property is required. Number
The memory capacity of each shard. Unit: GiB.
shardNumber This property is required. Number
The number of shards in the redis instance.
shardedCluster This property is required. Number
Whether enable sharded cluster for redis instance. Valid values: 0, 1.
status This property is required. String
The status of redis instance to query.
subnetId This property is required. String
The subnet id of the redis instance.
tags This property is required. List<Property Map>
Tags.
visitAddrs This property is required. List<Property Map>
The list of connection information.
vpcAuthMode This property is required. String
Whether to enable password-free access when connecting to an instance through a private network.
vpcId This property is required. String
The vpc id of redis instance to query. This field supports fuzzy queries.
zoneIds This property is required. List<String>
The list of zone ID which the redis instance belongs.

InstancesInstanceBackupPlan

Active This property is required. bool
Whether enable auto backup.
BackupHour This property is required. int
The time period to start performing the backup. The value range is any integer between 0 and 23, where 0 means that the system will perform the backup in the period of 00:00~01:00, 1 means that the backup will be performed in the period of 01:00~02:00, and so on.
BackupType This property is required. string
The backup type.
ExpectNextBackupTime This property is required. string
The expected time for the next backup to be performed.
InstanceId This property is required. string
The id of redis instance to query. This field supports fuzzy queries.
LastUpdateTime This property is required. string
The last time the backup policy was modified.
Periods This property is required. List<int>
The backup cycle. The value can be any integer between 1 and 7. Among them, 1 means backup every Monday, 2 means backup every Tuesday, and so on.
Ttl This property is required. int
The number of days to keep backups, the default is 7 days.
Active This property is required. bool
Whether enable auto backup.
BackupHour This property is required. int
The time period to start performing the backup. The value range is any integer between 0 and 23, where 0 means that the system will perform the backup in the period of 00:00~01:00, 1 means that the backup will be performed in the period of 01:00~02:00, and so on.
BackupType This property is required. string
The backup type.
ExpectNextBackupTime This property is required. string
The expected time for the next backup to be performed.
InstanceId This property is required. string
The id of redis instance to query. This field supports fuzzy queries.
LastUpdateTime This property is required. string
The last time the backup policy was modified.
Periods This property is required. []int
The backup cycle. The value can be any integer between 1 and 7. Among them, 1 means backup every Monday, 2 means backup every Tuesday, and so on.
Ttl This property is required. int
The number of days to keep backups, the default is 7 days.
active This property is required. Boolean
Whether enable auto backup.
backupHour This property is required. Integer
The time period to start performing the backup. The value range is any integer between 0 and 23, where 0 means that the system will perform the backup in the period of 00:00~01:00, 1 means that the backup will be performed in the period of 01:00~02:00, and so on.
backupType This property is required. String
The backup type.
expectNextBackupTime This property is required. String
The expected time for the next backup to be performed.
instanceId This property is required. String
The id of redis instance to query. This field supports fuzzy queries.
lastUpdateTime This property is required. String
The last time the backup policy was modified.
periods This property is required. List<Integer>
The backup cycle. The value can be any integer between 1 and 7. Among them, 1 means backup every Monday, 2 means backup every Tuesday, and so on.
ttl This property is required. Integer
The number of days to keep backups, the default is 7 days.
active This property is required. boolean
Whether enable auto backup.
backupHour This property is required. number
The time period to start performing the backup. The value range is any integer between 0 and 23, where 0 means that the system will perform the backup in the period of 00:00~01:00, 1 means that the backup will be performed in the period of 01:00~02:00, and so on.
backupType This property is required. string
The backup type.
expectNextBackupTime This property is required. string
The expected time for the next backup to be performed.
instanceId This property is required. string
The id of redis instance to query. This field supports fuzzy queries.
lastUpdateTime This property is required. string
The last time the backup policy was modified.
periods This property is required. number[]
The backup cycle. The value can be any integer between 1 and 7. Among them, 1 means backup every Monday, 2 means backup every Tuesday, and so on.
ttl This property is required. number
The number of days to keep backups, the default is 7 days.
active This property is required. bool
Whether enable auto backup.
backup_hour This property is required. int
The time period to start performing the backup. The value range is any integer between 0 and 23, where 0 means that the system will perform the backup in the period of 00:00~01:00, 1 means that the backup will be performed in the period of 01:00~02:00, and so on.
backup_type This property is required. str
The backup type.
expect_next_backup_time This property is required. str
The expected time for the next backup to be performed.
instance_id This property is required. str
The id of redis instance to query. This field supports fuzzy queries.
last_update_time This property is required. str
The last time the backup policy was modified.
periods This property is required. Sequence[int]
The backup cycle. The value can be any integer between 1 and 7. Among them, 1 means backup every Monday, 2 means backup every Tuesday, and so on.
ttl This property is required. int
The number of days to keep backups, the default is 7 days.
active This property is required. Boolean
Whether enable auto backup.
backupHour This property is required. Number
The time period to start performing the backup. The value range is any integer between 0 and 23, where 0 means that the system will perform the backup in the period of 00:00~01:00, 1 means that the backup will be performed in the period of 01:00~02:00, and so on.
backupType This property is required. String
The backup type.
expectNextBackupTime This property is required. String
The expected time for the next backup to be performed.
instanceId This property is required. String
The id of redis instance to query. This field supports fuzzy queries.
lastUpdateTime This property is required. String
The last time the backup policy was modified.
periods This property is required. List<Number>
The backup cycle. The value can be any integer between 1 and 7. Among them, 1 means backup every Monday, 2 means backup every Tuesday, and so on.
ttl This property is required. Number
The number of days to keep backups, the default is 7 days.

InstancesInstanceCapacity

Total This property is required. int
The total memory capacity of the redis instance. Unit: MiB.
Used This property is required. int
The used memory capacity of the redis instance. Unit: MiB.
Total This property is required. int
The total memory capacity of the redis instance. Unit: MiB.
Used This property is required. int
The used memory capacity of the redis instance. Unit: MiB.
total This property is required. Integer
The total memory capacity of the redis instance. Unit: MiB.
used This property is required. Integer
The used memory capacity of the redis instance. Unit: MiB.
total This property is required. number
The total memory capacity of the redis instance. Unit: MiB.
used This property is required. number
The used memory capacity of the redis instance. Unit: MiB.
total This property is required. int
The total memory capacity of the redis instance. Unit: MiB.
used This property is required. int
The used memory capacity of the redis instance. Unit: MiB.
total This property is required. Number
The total memory capacity of the redis instance. Unit: MiB.
used This property is required. Number
The used memory capacity of the redis instance. Unit: MiB.

InstancesInstanceConfigureNode

Az This property is required. string
Set the availability zone to which the node belongs. The number of nodes of an instance (i.e., NodeNumber) and the availability zone deployment scheme (i.e., the value of the MultiAZ parameter) will affect the filling of the current parameter. Among them: When a new instance is a single-node instance (i.e., the value of NodeNumber is 1), only a single availability zone deployment scheme is allowed (i.e., the value of MultiAZ must be disabled). At this time, only one availability zone needs to be passed in AZ, and all nodes in the instance will be deployed in this availability zone. When creating a new instance as a primary-standby instance (that is, when the value of NodeNumber is greater than or equal to 2), the number of availability zones passed in must be equal to the number of nodes in a single shard (that is, the value of the NodeNumber parameter), and the value of AZ must comply with the multi-availability zone deployment scheme rules. The specific rules are as follows: If the primary-standby instance selects the multi-availability zone deployment scheme (that is, the value of MultiAZ is enabled), then at least two different availability zone IDs must be passed in in AZ, and the first availability zone is the availability zone where the primary node is located. If the primary and standby instances choose a single availability zone deployment scheme (that is, the value of MultiAZ is disabled), then the availability zones passed in for each node must be the same.
Az This property is required. string
Set the availability zone to which the node belongs. The number of nodes of an instance (i.e., NodeNumber) and the availability zone deployment scheme (i.e., the value of the MultiAZ parameter) will affect the filling of the current parameter. Among them: When a new instance is a single-node instance (i.e., the value of NodeNumber is 1), only a single availability zone deployment scheme is allowed (i.e., the value of MultiAZ must be disabled). At this time, only one availability zone needs to be passed in AZ, and all nodes in the instance will be deployed in this availability zone. When creating a new instance as a primary-standby instance (that is, when the value of NodeNumber is greater than or equal to 2), the number of availability zones passed in must be equal to the number of nodes in a single shard (that is, the value of the NodeNumber parameter), and the value of AZ must comply with the multi-availability zone deployment scheme rules. The specific rules are as follows: If the primary-standby instance selects the multi-availability zone deployment scheme (that is, the value of MultiAZ is enabled), then at least two different availability zone IDs must be passed in in AZ, and the first availability zone is the availability zone where the primary node is located. If the primary and standby instances choose a single availability zone deployment scheme (that is, the value of MultiAZ is disabled), then the availability zones passed in for each node must be the same.
az This property is required. String
Set the availability zone to which the node belongs. The number of nodes of an instance (i.e., NodeNumber) and the availability zone deployment scheme (i.e., the value of the MultiAZ parameter) will affect the filling of the current parameter. Among them: When a new instance is a single-node instance (i.e., the value of NodeNumber is 1), only a single availability zone deployment scheme is allowed (i.e., the value of MultiAZ must be disabled). At this time, only one availability zone needs to be passed in AZ, and all nodes in the instance will be deployed in this availability zone. When creating a new instance as a primary-standby instance (that is, when the value of NodeNumber is greater than or equal to 2), the number of availability zones passed in must be equal to the number of nodes in a single shard (that is, the value of the NodeNumber parameter), and the value of AZ must comply with the multi-availability zone deployment scheme rules. The specific rules are as follows: If the primary-standby instance selects the multi-availability zone deployment scheme (that is, the value of MultiAZ is enabled), then at least two different availability zone IDs must be passed in in AZ, and the first availability zone is the availability zone where the primary node is located. If the primary and standby instances choose a single availability zone deployment scheme (that is, the value of MultiAZ is disabled), then the availability zones passed in for each node must be the same.
az This property is required. string
Set the availability zone to which the node belongs. The number of nodes of an instance (i.e., NodeNumber) and the availability zone deployment scheme (i.e., the value of the MultiAZ parameter) will affect the filling of the current parameter. Among them: When a new instance is a single-node instance (i.e., the value of NodeNumber is 1), only a single availability zone deployment scheme is allowed (i.e., the value of MultiAZ must be disabled). At this time, only one availability zone needs to be passed in AZ, and all nodes in the instance will be deployed in this availability zone. When creating a new instance as a primary-standby instance (that is, when the value of NodeNumber is greater than or equal to 2), the number of availability zones passed in must be equal to the number of nodes in a single shard (that is, the value of the NodeNumber parameter), and the value of AZ must comply with the multi-availability zone deployment scheme rules. The specific rules are as follows: If the primary-standby instance selects the multi-availability zone deployment scheme (that is, the value of MultiAZ is enabled), then at least two different availability zone IDs must be passed in in AZ, and the first availability zone is the availability zone where the primary node is located. If the primary and standby instances choose a single availability zone deployment scheme (that is, the value of MultiAZ is disabled), then the availability zones passed in for each node must be the same.
az This property is required. str
Set the availability zone to which the node belongs. The number of nodes of an instance (i.e., NodeNumber) and the availability zone deployment scheme (i.e., the value of the MultiAZ parameter) will affect the filling of the current parameter. Among them: When a new instance is a single-node instance (i.e., the value of NodeNumber is 1), only a single availability zone deployment scheme is allowed (i.e., the value of MultiAZ must be disabled). At this time, only one availability zone needs to be passed in AZ, and all nodes in the instance will be deployed in this availability zone. When creating a new instance as a primary-standby instance (that is, when the value of NodeNumber is greater than or equal to 2), the number of availability zones passed in must be equal to the number of nodes in a single shard (that is, the value of the NodeNumber parameter), and the value of AZ must comply with the multi-availability zone deployment scheme rules. The specific rules are as follows: If the primary-standby instance selects the multi-availability zone deployment scheme (that is, the value of MultiAZ is enabled), then at least two different availability zone IDs must be passed in in AZ, and the first availability zone is the availability zone where the primary node is located. If the primary and standby instances choose a single availability zone deployment scheme (that is, the value of MultiAZ is disabled), then the availability zones passed in for each node must be the same.
az This property is required. String
Set the availability zone to which the node belongs. The number of nodes of an instance (i.e., NodeNumber) and the availability zone deployment scheme (i.e., the value of the MultiAZ parameter) will affect the filling of the current parameter. Among them: When a new instance is a single-node instance (i.e., the value of NodeNumber is 1), only a single availability zone deployment scheme is allowed (i.e., the value of MultiAZ must be disabled). At this time, only one availability zone needs to be passed in AZ, and all nodes in the instance will be deployed in this availability zone. When creating a new instance as a primary-standby instance (that is, when the value of NodeNumber is greater than or equal to 2), the number of availability zones passed in must be equal to the number of nodes in a single shard (that is, the value of the NodeNumber parameter), and the value of AZ must comply with the multi-availability zone deployment scheme rules. The specific rules are as follows: If the primary-standby instance selects the multi-availability zone deployment scheme (that is, the value of MultiAZ is enabled), then at least two different availability zone IDs must be passed in in AZ, and the first availability zone is the availability zone where the primary node is located. If the primary and standby instances choose a single availability zone deployment scheme (that is, the value of MultiAZ is disabled), then the availability zones passed in for each node must be the same.

InstancesInstanceParam

CurrentValue This property is required. string
Current value of the configuration parameter.
DefaultValue This property is required. string
Default value of the configuration parameter.
Description This property is required. string
The description of this option item.
EditableForInstance This property is required. bool
Whether the current redis instance supports editing this parameter.
NeedReboot This property is required. bool
Whether need to reboot the redis instance when modifying this parameter.
Options This property is required. List<InstancesInstanceParamOption>
The list of options. Valid when the configuration parameter type is Radio.
ParamName This property is required. string
The name of the configuration parameter.
Range This property is required. string
The valid value range of the numeric type configuration parameter.
Type This property is required. string
The type of the configuration parameter.
Unit This property is required. string
The unit of the numeric type configuration parameter.
CurrentValue This property is required. string
Current value of the configuration parameter.
DefaultValue This property is required. string
Default value of the configuration parameter.
Description This property is required. string
The description of this option item.
EditableForInstance This property is required. bool
Whether the current redis instance supports editing this parameter.
NeedReboot This property is required. bool
Whether need to reboot the redis instance when modifying this parameter.
Options This property is required. []InstancesInstanceParamOption
The list of options. Valid when the configuration parameter type is Radio.
ParamName This property is required. string
The name of the configuration parameter.
Range This property is required. string
The valid value range of the numeric type configuration parameter.
Type This property is required. string
The type of the configuration parameter.
Unit This property is required. string
The unit of the numeric type configuration parameter.
currentValue This property is required. String
Current value of the configuration parameter.
defaultValue This property is required. String
Default value of the configuration parameter.
description This property is required. String
The description of this option item.
editableForInstance This property is required. Boolean
Whether the current redis instance supports editing this parameter.
needReboot This property is required. Boolean
Whether need to reboot the redis instance when modifying this parameter.
options This property is required. List<InstancesInstanceParamOption>
The list of options. Valid when the configuration parameter type is Radio.
paramName This property is required. String
The name of the configuration parameter.
range This property is required. String
The valid value range of the numeric type configuration parameter.
type This property is required. String
The type of the configuration parameter.
unit This property is required. String
The unit of the numeric type configuration parameter.
currentValue This property is required. string
Current value of the configuration parameter.
defaultValue This property is required. string
Default value of the configuration parameter.
description This property is required. string
The description of this option item.
editableForInstance This property is required. boolean
Whether the current redis instance supports editing this parameter.
needReboot This property is required. boolean
Whether need to reboot the redis instance when modifying this parameter.
options This property is required. InstancesInstanceParamOption[]
The list of options. Valid when the configuration parameter type is Radio.
paramName This property is required. string
The name of the configuration parameter.
range This property is required. string
The valid value range of the numeric type configuration parameter.
type This property is required. string
The type of the configuration parameter.
unit This property is required. string
The unit of the numeric type configuration parameter.
current_value This property is required. str
Current value of the configuration parameter.
default_value This property is required. str
Default value of the configuration parameter.
description This property is required. str
The description of this option item.
editable_for_instance This property is required. bool
Whether the current redis instance supports editing this parameter.
need_reboot This property is required. bool
Whether need to reboot the redis instance when modifying this parameter.
options This property is required. Sequence[InstancesInstanceParamOption]
The list of options. Valid when the configuration parameter type is Radio.
param_name This property is required. str
The name of the configuration parameter.
range This property is required. str
The valid value range of the numeric type configuration parameter.
type This property is required. str
The type of the configuration parameter.
unit This property is required. str
The unit of the numeric type configuration parameter.
currentValue This property is required. String
Current value of the configuration parameter.
defaultValue This property is required. String
Default value of the configuration parameter.
description This property is required. String
The description of this option item.
editableForInstance This property is required. Boolean
Whether the current redis instance supports editing this parameter.
needReboot This property is required. Boolean
Whether need to reboot the redis instance when modifying this parameter.
options This property is required. List<Property Map>
The list of options. Valid when the configuration parameter type is Radio.
paramName This property is required. String
The name of the configuration parameter.
range This property is required. String
The valid value range of the numeric type configuration parameter.
type This property is required. String
The type of the configuration parameter.
unit This property is required. String
The unit of the numeric type configuration parameter.

InstancesInstanceParamOption

Description This property is required. string
The description of this option item.
Value This property is required. string
The Value of Tags.
Description This property is required. string
The description of this option item.
Value This property is required. string
The Value of Tags.
description This property is required. String
The description of this option item.
value This property is required. String
The Value of Tags.
description This property is required. string
The description of this option item.
value This property is required. string
The Value of Tags.
description This property is required. str
The description of this option item.
value This property is required. str
The Value of Tags.
description This property is required. String
The description of this option item.
value This property is required. String
The Value of Tags.

InstancesInstanceTag

Key This property is required. string
The Key of Tags.
Value This property is required. string
The Value of Tags.
Key This property is required. string
The Key of Tags.
Value This property is required. string
The Value of Tags.
key This property is required. String
The Key of Tags.
value This property is required. String
The Value of Tags.
key This property is required. string
The Key of Tags.
value This property is required. string
The Value of Tags.
key This property is required. str
The Key of Tags.
value This property is required. str
The Value of Tags.
key This property is required. String
The Key of Tags.
value This property is required. String
The Value of Tags.

InstancesInstanceVisitAddr

AddrType This property is required. string
The connection address type.
Address This property is required. string
The connection address.
EipId This property is required. string
The EIP ID bound to the instance's public network address.
Port This property is required. string
The connection port.
Vip This property is required. string
The ipv4 address of the connection address.
VipV6 This property is required. string
The ipv6 address of the connection address.
AddrType This property is required. string
The connection address type.
Address This property is required. string
The connection address.
EipId This property is required. string
The EIP ID bound to the instance's public network address.
Port This property is required. string
The connection port.
Vip This property is required. string
The ipv4 address of the connection address.
VipV6 This property is required. string
The ipv6 address of the connection address.
addrType This property is required. String
The connection address type.
address This property is required. String
The connection address.
eipId This property is required. String
The EIP ID bound to the instance's public network address.
port This property is required. String
The connection port.
vip This property is required. String
The ipv4 address of the connection address.
vipV6 This property is required. String
The ipv6 address of the connection address.
addrType This property is required. string
The connection address type.
address This property is required. string
The connection address.
eipId This property is required. string
The EIP ID bound to the instance's public network address.
port This property is required. string
The connection port.
vip This property is required. string
The ipv4 address of the connection address.
vipV6 This property is required. string
The ipv6 address of the connection address.
addr_type This property is required. str
The connection address type.
address This property is required. str
The connection address.
eip_id This property is required. str
The EIP ID bound to the instance's public network address.
port This property is required. str
The connection port.
vip This property is required. str
The ipv4 address of the connection address.
vip_v6 This property is required. str
The ipv6 address of the connection address.
addrType This property is required. String
The connection address type.
address This property is required. String
The connection address.
eipId This property is required. String
The EIP ID bound to the instance's public network address.
port This property is required. String
The connection port.
vip This property is required. String
The ipv4 address of the connection address.
vipV6 This property is required. String
The ipv6 address of the connection address.

InstancesTag

Key This property is required. string
The Key of Tags.
Value This property is required. string
The Value of Tags.
Key This property is required. string
The Key of Tags.
Value This property is required. string
The Value of Tags.
key This property is required. String
The Key of Tags.
value This property is required. String
The Value of Tags.
key This property is required. string
The Key of Tags.
value This property is required. string
The Value of Tags.
key This property is required. str
The Key of Tags.
value This property is required. str
The Value of Tags.
key This property is required. String
The Key of Tags.
value This property is required. String
The Value of Tags.

Package Details

Repository
volcengine volcengine/pulumi-volcengine
License
Apache-2.0
Notes
This Pulumi package is based on the volcengine Terraform Provider.
Volcengine v0.0.27 published on Tuesday, Dec 10, 2024 by Volcengine