Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Volcengine
  3. API Docs
  4. redis
  5. Instances
Volcengine v0.0.26 published on Friday, Sep 13, 2024 by Volcengine
volcengine/pulumi-volcengine

volcengine.redis.Instances

Explore with Pulumi AI

volcengine logo
Volcengine v0.0.26 published on Friday, Sep 13, 2024 by Volcengine
volcengine/pulumi-volcengine

    Use this data source to query detailed information of redis instances

    Example Usage

    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,
    });

});

    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
	})
}

    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());

    }
}

    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)

    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,
});

    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}

    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>
    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]
    func Instances(ctx *Context, args *InstancesArgs, opts ...InvokeOption) (*InstancesResult, error)
func InstancesOutput(ctx *Context, args *InstancesOutputArgs, opts ...InvokeOption) InstancesResultOutput
    public static class Instances 
{
    public static Task<InstancesResult> InvokeAsync(InstancesArgs args, InvokeOptions? opts = null)
    public static Output<InstancesResult> Invoke(InstancesInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<InstancesResult> instances(InstancesArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: volcengine:redis:Instances
  arguments:
    # arguments dictionary

    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 InstancesInstanceBackupPlan
    The list of backup plans.
    Capacity InstancesInstanceCapacity
    The memory capacity information.
    ChargeType string
    The charge type of redis instance to query. Valid values: PostPaid, PrePaid.
    CreateTime string
    The creation time of the redis instance.
    DeletionProtection string
    whether enable deletion protection.
    EngineVersion string
    The engine version of redis instance to query. Valid values: 4.0, 5.0, 6.0.
    ExpiredTime string
    The expire time of the redis instance, valid when charge type is PrePaid.
    Id string
    The id of the redis instance.
    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.
    MaintenanceTime string
    The maintainable time of the redis instance.
    NodeIds List<string>
    The list of redis instance node IDs.
    NodeNumber int
    The number of nodes in each shard.
    Params List<InstancesInstanceParam>
    The list of params.
    ProjectName string
    The project name of redis instance to query.
    RegionId string
    The region id of the redis instance.
    ShardCapacity double
    The memory capacity of each shard. Unit: GiB.
    ShardNumber int
    The number of shards in the redis instance.
    ShardedCluster int
    Whether enable sharded cluster for redis instance. Valid values: 0, 1.
    Status string
    The status of redis instance to query.
    SubnetId string
    The subnet id of the redis instance.
    Tags List<InstancesInstanceTag>
    Tags.
    VisitAddrs List<InstancesInstanceVisitAddr>
    The list of connection information.
    VpcAuthMode string
    Whether to enable password-free access when connecting to an instance through a private network.
    VpcId string
    The vpc id of redis instance to query. This field supports fuzzy queries.
    ZoneIds List<string>
    The list of zone ID which the redis instance belongs.
    BackupPlan InstancesInstanceBackupPlan
    The list of backup plans.
    Capacity InstancesInstanceCapacity
    The memory capacity information.
    ChargeType string
    The charge type of redis instance to query. Valid values: PostPaid, PrePaid.
    CreateTime string
    The creation time of the redis instance.
    DeletionProtection string
    whether enable deletion protection.
    EngineVersion string
    The engine version of redis instance to query. Valid values: 4.0, 5.0, 6.0.
    ExpiredTime string
    The expire time of the redis instance, valid when charge type is PrePaid.
    Id string
    The id of the redis instance.
    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.
    MaintenanceTime string
    The maintainable time of the redis instance.
    NodeIds []string
    The list of redis instance node IDs.
    NodeNumber int
    The number of nodes in each shard.
    Params []InstancesInstanceParam
    The list of params.
    ProjectName string
    The project name of redis instance to query.
    RegionId string
    The region id of the redis instance.
    ShardCapacity float64
    The memory capacity of each shard. Unit: GiB.
    ShardNumber int
    The number of shards in the redis instance.
    ShardedCluster int
    Whether enable sharded cluster for redis instance. Valid values: 0, 1.
    Status string
    The status of redis instance to query.
    SubnetId string
    The subnet id of the redis instance.
    Tags []InstancesInstanceTag
    Tags.
    VisitAddrs []InstancesInstanceVisitAddr
    The list of connection information.
    VpcAuthMode string
    Whether to enable password-free access when connecting to an instance through a private network.
    VpcId string
    The vpc id of redis instance to query. This field supports fuzzy queries.
    ZoneIds []string
    The list of zone ID which the redis instance belongs.
    backupPlan InstancesInstanceBackupPlan
    The list of backup plans.
    capacity InstancesInstanceCapacity
    The memory capacity information.
    chargeType String
    The charge type of redis instance to query. Valid values: PostPaid, PrePaid.
    createTime String
    The creation time of the redis instance.
    deletionProtection String
    whether enable deletion protection.
    engineVersion String
    The engine version of redis instance to query. Valid values: 4.0, 5.0, 6.0.
    expiredTime String
    The expire time of the redis instance, valid when charge type is PrePaid.
    id String
    The id of the redis instance.
    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.
    maintenanceTime String
    The maintainable time of the redis instance.
    nodeIds List<String>
    The list of redis instance node IDs.
    nodeNumber Integer
    The number of nodes in each shard.
    params List<InstancesInstanceParam>
    The list of params.
    projectName String
    The project name of redis instance to query.
    regionId String
    The region id of the redis instance.
    shardCapacity Double
    The memory capacity of each shard. Unit: GiB.
    shardNumber Integer
    The number of shards in the redis instance.
    shardedCluster Integer
    Whether enable sharded cluster for redis instance. Valid values: 0, 1.
    status String
    The status of redis instance to query.
    subnetId String
    The subnet id of the redis instance.
    tags List<InstancesInstanceTag>
    Tags.
    visitAddrs List<InstancesInstanceVisitAddr>
    The list of connection information.
    vpcAuthMode String
    Whether to enable password-free access when connecting to an instance through a private network.
    vpcId String
    The vpc id of redis instance to query. This field supports fuzzy queries.
    zoneIds List<String>
    The list of zone ID which the redis instance belongs.
    backupPlan InstancesInstanceBackupPlan
    The list of backup plans.
    capacity InstancesInstanceCapacity
    The memory capacity information.
    chargeType string
    The charge type of redis instance to query. Valid values: PostPaid, PrePaid.
    createTime string
    The creation time of the redis instance.
    deletionProtection string
    whether enable deletion protection.
    engineVersion string
    The engine version of redis instance to query. Valid values: 4.0, 5.0, 6.0.
    expiredTime string
    The expire time of the redis instance, valid when charge type is PrePaid.
    id string
    The id of the redis instance.
    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.
    maintenanceTime string
    The maintainable time of the redis instance.
    nodeIds string[]
    The list of redis instance node IDs.
    nodeNumber number
    The number of nodes in each shard.
    params InstancesInstanceParam[]
    The list of params.
    projectName string
    The project name of redis instance to query.
    regionId string
    The region id of the redis instance.
    shardCapacity number
    The memory capacity of each shard. Unit: GiB.
    shardNumber number
    The number of shards in the redis instance.
    shardedCluster number
    Whether enable sharded cluster for redis instance. Valid values: 0, 1.
    status string
    The status of redis instance to query.
    subnetId string
    The subnet id of the redis instance.
    tags InstancesInstanceTag[]
    Tags.
    visitAddrs InstancesInstanceVisitAddr[]
    The list of connection information.
    vpcAuthMode string
    Whether to enable password-free access when connecting to an instance through a private network.
    vpcId string
    The vpc id of redis instance to query. This field supports fuzzy queries.
    zoneIds string[]
    The list of zone ID which the redis instance belongs.
    backup_plan InstancesInstanceBackupPlan
    The list of backup plans.
    capacity InstancesInstanceCapacity
    The memory capacity information.
    charge_type str
    The charge type of redis instance to query. Valid values: PostPaid, PrePaid.
    create_time str
    The creation time of the redis instance.
    deletion_protection str
    whether enable deletion protection.
    engine_version str
    The engine version of redis instance to query. Valid values: 4.0, 5.0, 6.0.
    expired_time str
    The expire time of the redis instance, valid when charge type is PrePaid.
    id str
    The id of the redis instance.
    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.
    maintenance_time str
    The maintainable time of the redis instance.
    node_ids Sequence[str]
    The list of redis instance node IDs.
    node_number int
    The number of nodes in each shard.
    params Sequence[InstancesInstanceParam]
    The list of params.
    project_name str
    The project name of redis instance to query.
    region_id str
    The region id of the redis instance.
    shard_capacity float
    The memory capacity of each shard. Unit: GiB.
    shard_number int
    The number of shards in the redis instance.
    sharded_cluster int
    Whether enable sharded cluster for redis instance. Valid values: 0, 1.
    status str
    The status of redis instance to query.
    subnet_id str
    The subnet id of the redis instance.
    tags Sequence[InstancesInstanceTag]
    Tags.
    visit_addrs Sequence[InstancesInstanceVisitAddr]
    The list of connection information.
    vpc_auth_mode str
    Whether to enable password-free access when connecting to an instance through a private network.
    vpc_id str
    The vpc id of redis instance to query. This field supports fuzzy queries.
    zone_ids Sequence[str]
    The list of zone ID which the redis instance belongs.
    backupPlan Property Map
    The list of backup plans.
    capacity Property Map
    The memory capacity information.
    chargeType String
    The charge type of redis instance to query. Valid values: PostPaid, PrePaid.
    createTime String
    The creation time of the redis instance.
    deletionProtection String
    whether enable deletion protection.
    engineVersion String
    The engine version of redis instance to query. Valid values: 4.0, 5.0, 6.0.
    expiredTime String
    The expire time of the redis instance, valid when charge type is PrePaid.
    id String
    The id of the redis instance.
    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.
    maintenanceTime String
    The maintainable time of the redis instance.
    nodeIds List<String>
    The list of redis instance node IDs.
    nodeNumber Number
    The number of nodes in each shard.
    params List<Property Map>
    The list of params.
    projectName String
    The project name of redis instance to query.
    regionId String
    The region id of the redis instance.
    shardCapacity Number
    The memory capacity of each shard. Unit: GiB.
    shardNumber Number
    The number of shards in the redis instance.
    shardedCluster Number
    Whether enable sharded cluster for redis instance. Valid values: 0, 1.
    status String
    The status of redis instance to query.
    subnetId String
    The subnet id of the redis instance.
    tags List<Property Map>
    Tags.
    visitAddrs List<Property Map>
    The list of connection information.
    vpcAuthMode String
    Whether to enable password-free access when connecting to an instance through a private network.
    vpcId String
    The vpc id of redis instance to query. This field supports fuzzy queries.
    zoneIds List<String>
    The list of zone ID which the redis instance belongs.

    InstancesInstanceBackupPlan

    Active bool
    Whether enable auto backup.
    BackupHour 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 string
    The backup type.
    ExpectNextBackupTime string
    The expected time for the next backup to be performed.
    InstanceId string
    The id of redis instance to query. This field supports fuzzy queries.
    LastUpdateTime string
    The last time the backup policy was modified.
    Periods 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 int
    The number of days to keep backups, the default is 7 days.
    Active bool
    Whether enable auto backup.
    BackupHour 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 string
    The backup type.
    ExpectNextBackupTime string
    The expected time for the next backup to be performed.
    InstanceId string
    The id of redis instance to query. This field supports fuzzy queries.
    LastUpdateTime string
    The last time the backup policy was modified.
    Periods []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 int
    The number of days to keep backups, the default is 7 days.
    active Boolean
    Whether enable auto backup.
    backupHour 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 String
    The backup type.
    expectNextBackupTime String
    The expected time for the next backup to be performed.
    instanceId String
    The id of redis instance to query. This field supports fuzzy queries.
    lastUpdateTime String
    The last time the backup policy was modified.
    periods 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 Integer
    The number of days to keep backups, the default is 7 days.
    active boolean
    Whether enable auto backup.
    backupHour 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 string
    The backup type.
    expectNextBackupTime string
    The expected time for the next backup to be performed.
    instanceId string
    The id of redis instance to query. This field supports fuzzy queries.
    lastUpdateTime string
    The last time the backup policy was modified.
    periods 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 number
    The number of days to keep backups, the default is 7 days.
    active bool
    Whether enable auto backup.
    backup_hour 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 str
    The backup type.
    expect_next_backup_time str
    The expected time for the next backup to be performed.
    instance_id str
    The id of redis instance to query. This field supports fuzzy queries.
    last_update_time str
    The last time the backup policy was modified.
    periods 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 int
    The number of days to keep backups, the default is 7 days.
    active Boolean
    Whether enable auto backup.
    backupHour 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 String
    The backup type.
    expectNextBackupTime String
    The expected time for the next backup to be performed.
    instanceId String
    The id of redis instance to query. This field supports fuzzy queries.
    lastUpdateTime String
    The last time the backup policy was modified.
    periods 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 Number
    The number of days to keep backups, the default is 7 days.

    InstancesInstanceCapacity

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

    InstancesInstanceParam

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

    InstancesInstanceParamOption

    Description string
    The description of this option item.
    Value string
    The Value of Tags.
    Description string
    The description of this option item.
    Value string
    The Value of Tags.
    description String
    The description of this option item.
    value String
    The Value of Tags.
    description string
    The description of this option item.
    value string
    The Value of Tags.
    description str
    The description of this option item.
    value str
    The Value of Tags.
    description String
    The description of this option item.
    value String
    The Value of Tags.

    InstancesInstanceTag

    Key string
    The Key of Tags.
    Value string
    The Value of Tags.
    Key string
    The Key of Tags.
    Value string
    The Value of Tags.
    key String
    The Key of Tags.
    value String
    The Value of Tags.
    key string
    The Key of Tags.
    value string
    The Value of Tags.
    key str
    The Key of Tags.
    value str
    The Value of Tags.
    key String
    The Key of Tags.
    value String
    The Value of Tags.

    InstancesInstanceVisitAddr

    AddrType string
    The connection address type.
    Address string
    The connection address.
    EipId string
    The EIP ID bound to the instance's public network address.
    Port string
    The connection port.
    AddrType string
    The connection address type.
    Address string
    The connection address.
    EipId string
    The EIP ID bound to the instance's public network address.
    Port string
    The connection port.
    addrType String
    The connection address type.
    address String
    The connection address.
    eipId String
    The EIP ID bound to the instance's public network address.
    port String
    The connection port.
    addrType string
    The connection address type.
    address string
    The connection address.
    eipId string
    The EIP ID bound to the instance's public network address.
    port string
    The connection port.
    addr_type str
    The connection address type.
    address str
    The connection address.
    eip_id str
    The EIP ID bound to the instance's public network address.
    port str
    The connection port.
    addrType String
    The connection address type.
    address String
    The connection address.
    eipId String
    The EIP ID bound to the instance's public network address.
    port String
    The connection port.

    InstancesTag

    Key string
    The Key of Tags.
    Value string
    The Value of Tags.
    Key string
    The Key of Tags.
    Value string
    The Value of Tags.
    key String
    The Key of Tags.
    value String
    The Value of Tags.
    key string
    The Key of Tags.
    value string
    The Value of Tags.
    key str
    The Key of Tags.
    value str
    The Value of Tags.
    key String
    The Key of Tags.
    value 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 logo
    Volcengine v0.0.26 published on Friday, Sep 13, 2024 by Volcengine
    volcengine/pulumi-volcengine