opentelekomcloud 1.36.35, Apr 14 25

opentelekomcloud 1.36.35 published on Monday, Apr 14, 2025 by opentelekomcloud

opentelekomcloud/terraform-provider-opentelekomcloud

opentelekomcloud.DcsInstanceV2

Explore with Pulumi AI

opentelekomcloud 1.36.35 published on Monday, Apr 14, 2025 by opentelekomcloud

opentelekomcloud/terraform-provider-opentelekomcloud

Example Usage
Engine version 3.0 (security_group_id is required):
Engine version 5.0 (please pay attention of proper selection of flavor):
Create DcsInstanceV2 Resource
Constructor syntax
Constructor example
DcsInstanceV2 Resource Properties
Inputs
Outputs
Look up Existing DcsInstanceV2 Resource
Supporting Types
Import
Package Details

Request a Change

Up-to-date reference of API arguments for DCS V2 instance you can get at documentation portal

Manages a DCSv2 instance in the OpenTelekomCloud DCS Service.

Example Usage

Engine version 3.0 (`security_group_id` is required):

TypeScript
Python
Go
C#
Java
YAML

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

const config = new pulumi.Config();
const networkId = config.requireObject("networkId");
const vpcId = config.requireObject("vpcId");
const secgroup1 = new opentelekomcloud.NetworkingSecgroupV2("secgroup1", {description: "secgroup_1"});
const az1 = opentelekomcloud.getDcsAzV1({
    name: "eu-de-01",
});
const instance1 = new opentelekomcloud.DcsInstanceV2("instance1", {
    engineVersion: "3.0",
    password: "0TCTestP@ssw0rd",
    engine: "Redis",
    capacity: 2,
    vpcId: vpcId,
    securityGroupId: secgroup1.networkingSecgroupV2Id,
    subnetId: networkId,
    availabilityZones: ["eu-de-01"],
    flavor: "dcs.master_standby",
    backupPolicy: {
        saveDays: 1,
        backupType: "manual",
        beginAt: "00:00-01:00",
        periodType: "weekly",
        backupAts: [
            1,
            2,
            4,
            6,
        ],
    },
    tags: {
        environment: "basic",
        managed_by: "terraform",
    },
});

import pulumi
import pulumi_opentelekomcloud as opentelekomcloud

config = pulumi.Config()
network_id = config.require_object("networkId")
vpc_id = config.require_object("vpcId")
secgroup1 = opentelekomcloud.NetworkingSecgroupV2("secgroup1", description="secgroup_1")
az1 = opentelekomcloud.get_dcs_az_v1(name="eu-de-01")
instance1 = opentelekomcloud.DcsInstanceV2("instance1",
    engine_version="3.0",
    password="0TCTestP@ssw0rd",
    engine="Redis",
    capacity=2,
    vpc_id=vpc_id,
    security_group_id=secgroup1.networking_secgroup_v2_id,
    subnet_id=network_id,
    availability_zones=["eu-de-01"],
    flavor="dcs.master_standby",
    backup_policy={
        "save_days": 1,
        "backup_type": "manual",
        "begin_at": "00:00-01:00",
        "period_type": "weekly",
        "backup_ats": [
            1,
            2,
            4,
            6,
        ],
    },
    tags={
        "environment": "basic",
        "managed_by": "terraform",
    })

package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/opentelekomcloud/opentelekomcloud"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		networkId := cfg.RequireObject("networkId")
		vpcId := cfg.RequireObject("vpcId")
		secgroup1, err := opentelekomcloud.NewNetworkingSecgroupV2(ctx, "secgroup1", &opentelekomcloud.NetworkingSecgroupV2Args{
			Description: pulumi.String("secgroup_1"),
		})
		if err != nil {
			return err
		}
		_, err = opentelekomcloud.GetDcsAzV1(ctx, &opentelekomcloud.GetDcsAzV1Args{
			Name: pulumi.StringRef("eu-de-01"),
		}, nil)
		if err != nil {
			return err
		}
		_, err = opentelekomcloud.NewDcsInstanceV2(ctx, "instance1", &opentelekomcloud.DcsInstanceV2Args{
			EngineVersion:   pulumi.String("3.0"),
			Password:        pulumi.String("0TCTestP@ssw0rd"),
			Engine:          pulumi.String("Redis"),
			Capacity:        pulumi.Float64(2),
			VpcId:           pulumi.Any(vpcId),
			SecurityGroupId: secgroup1.NetworkingSecgroupV2Id,
			SubnetId:        pulumi.Any(networkId),
			AvailabilityZones: pulumi.StringArray{
				pulumi.String("eu-de-01"),
			},
			Flavor: pulumi.String("dcs.master_standby"),
			BackupPolicy: &opentelekomcloud.DcsInstanceV2BackupPolicyArgs{
				SaveDays:   pulumi.Float64(1),
				BackupType: pulumi.String("manual"),
				BeginAt:    pulumi.String("00:00-01:00"),
				PeriodType: pulumi.String("weekly"),
				BackupAts: pulumi.Float64Array{
					pulumi.Float64(1),
					pulumi.Float64(2),
					pulumi.Float64(4),
					pulumi.Float64(6),
				},
			},
			Tags: pulumi.StringMap{
				"environment": pulumi.String("basic"),
				"managed_by":  pulumi.String("terraform"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Opentelekomcloud = Pulumi.Opentelekomcloud;

return await Deployment.RunAsync(() => 
{
    var config = new Config();
    var networkId = config.RequireObject<dynamic>("networkId");
    var vpcId = config.RequireObject<dynamic>("vpcId");
    var secgroup1 = new Opentelekomcloud.NetworkingSecgroupV2("secgroup1", new()
    {
        Description = "secgroup_1",
    });

    var az1 = Opentelekomcloud.GetDcsAzV1.Invoke(new()
    {
        Name = "eu-de-01",
    });

    var instance1 = new Opentelekomcloud.DcsInstanceV2("instance1", new()
    {
        EngineVersion = "3.0",
        Password = "0TCTestP@ssw0rd",
        Engine = "Redis",
        Capacity = 2,
        VpcId = vpcId,
        SecurityGroupId = secgroup1.NetworkingSecgroupV2Id,
        SubnetId = networkId,
        AvailabilityZones = new[]
        {
            "eu-de-01",
        },
        Flavor = "dcs.master_standby",
        BackupPolicy = new Opentelekomcloud.Inputs.DcsInstanceV2BackupPolicyArgs
        {
            SaveDays = 1,
            BackupType = "manual",
            BeginAt = "00:00-01:00",
            PeriodType = "weekly",
            BackupAts = new[]
            {
                1,
                2,
                4,
                6,
            },
        },
        Tags = 
        {
            { "environment", "basic" },
            { "managed_by", "terraform" },
        },
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.opentelekomcloud.NetworkingSecgroupV2;
import com.pulumi.opentelekomcloud.NetworkingSecgroupV2Args;
import com.pulumi.opentelekomcloud.OpentelekomcloudFunctions;
import com.pulumi.opentelekomcloud.inputs.GetDcsAzV1Args;
import com.pulumi.opentelekomcloud.DcsInstanceV2;
import com.pulumi.opentelekomcloud.DcsInstanceV2Args;
import com.pulumi.opentelekomcloud.inputs.DcsInstanceV2BackupPolicyArgs;
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 config = ctx.config();
        final var networkId = config.get("networkId");
        final var vpcId = config.get("vpcId");
        var secgroup1 = new NetworkingSecgroupV2("secgroup1", NetworkingSecgroupV2Args.builder()
            .description("secgroup_1")
            .build());

        final var az1 = OpentelekomcloudFunctions.getDcsAzV1(GetDcsAzV1Args.builder()
            .name("eu-de-01")
            .build());

        var instance1 = new DcsInstanceV2("instance1", DcsInstanceV2Args.builder()
            .engineVersion("3.0")
            .password("0TCTestP@ssw0rd")
            .engine("Redis")
            .capacity(2)
            .vpcId(vpcId)
            .securityGroupId(secgroup1.networkingSecgroupV2Id())
            .subnetId(networkId)
            .availabilityZones("eu-de-01")
            .flavor("dcs.master_standby")
            .backupPolicy(DcsInstanceV2BackupPolicyArgs.builder()
                .saveDays(1)
                .backupType("manual")
                .beginAt("00:00-01:00")
                .periodType("weekly")
                .backupAts(                
                    1,
                    2,
                    4,
                    6)
                .build())
            .tags(Map.ofEntries(
                Map.entry("environment", "basic"),
                Map.entry("managed_by", "terraform")
            ))
            .build());

    }
}

configuration:
  networkId:
    type: dynamic
  vpcId:
    type: dynamic
resources:
  secgroup1:
    type: opentelekomcloud:NetworkingSecgroupV2
    properties:
      description: secgroup_1
  instance1:
    type: opentelekomcloud:DcsInstanceV2
    properties:
      engineVersion: '3.0'
      password: 0TCTestP@ssw0rd
      engine: Redis
      capacity: 2
      vpcId: ${vpcId}
      securityGroupId: ${secgroup1.networkingSecgroupV2Id}
      subnetId: ${networkId}
      availabilityZones:
        - eu-de-01
      flavor: dcs.master_standby
      backupPolicy:
        saveDays: 1
        backupType: manual
        beginAt: 00:00-01:00
        periodType: weekly
        backupAts:
          - 1
          - 2
          - 4
          - 6
      tags:
        environment: basic
        managed_by: terraform
variables:
  az1:
    fn::invoke:
      function: opentelekomcloud:getDcsAzV1
      arguments:
        name: eu-de-01

Engine version 5.0 (please pay attention of proper selection of flavor):

TypeScript
Python
Go
C#
Java
YAML

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

const zones = opentelekomcloud.getComputeAvailabilityZonesV2({});
const instance1 = new opentelekomcloud.DcsInstanceV2("instance1", {
    engineVersion: "5.0",
    password: "0TCTestP@ssw0rd",
    engine: "Redis",
    capacity: 0.125,
    vpcId: data.opentelekomcloud_vpc_subnet_v1.shared_subnet.vpc_id,
    subnetId: data.opentelekomcloud_vpc_subnet_v1.shared_subnet.network_id,
    availabilityZones: [zones.then(zones => zones.names?.[0])],
    flavor: "redis.single.xu1.tiny.128",
    enableWhitelist: true,
    whitelists: [
        {
            groupName: "test-group-name",
            ipLists: [
                "10.10.10.1",
                "10.10.10.2",
            ],
        },
        {
            groupName: "test-group-name-2",
            ipLists: [
                "10.10.10.11",
                "10.10.10.3",
                "10.10.10.4",
            ],
        },
    ],
});

import pulumi
import pulumi_opentelekomcloud as opentelekomcloud

zones = opentelekomcloud.get_compute_availability_zones_v2()
instance1 = opentelekomcloud.DcsInstanceV2("instance1",
    engine_version="5.0",
    password="0TCTestP@ssw0rd",
    engine="Redis",
    capacity=0.125,
    vpc_id=data["opentelekomcloud_vpc_subnet_v1"]["shared_subnet"]["vpc_id"],
    subnet_id=data["opentelekomcloud_vpc_subnet_v1"]["shared_subnet"]["network_id"],
    availability_zones=[zones.names[0]],
    flavor="redis.single.xu1.tiny.128",
    enable_whitelist=True,
    whitelists=[
        {
            "group_name": "test-group-name",
            "ip_lists": [
                "10.10.10.1",
                "10.10.10.2",
            ],
        },
        {
            "group_name": "test-group-name-2",
            "ip_lists": [
                "10.10.10.11",
                "10.10.10.3",
                "10.10.10.4",
            ],
        },
    ])

package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/opentelekomcloud/opentelekomcloud"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		zones, err := opentelekomcloud.GetComputeAvailabilityZonesV2(ctx, &opentelekomcloud.GetComputeAvailabilityZonesV2Args{}, nil)
		if err != nil {
			return err
		}
		_, err = opentelekomcloud.NewDcsInstanceV2(ctx, "instance1", &opentelekomcloud.DcsInstanceV2Args{
			EngineVersion: pulumi.String("5.0"),
			Password:      pulumi.String("0TCTestP@ssw0rd"),
			Engine:        pulumi.String("Redis"),
			Capacity:      pulumi.Float64(0.125),
			VpcId:         pulumi.Any(data.Opentelekomcloud_vpc_subnet_v1.Shared_subnet.Vpc_id),
			SubnetId:      pulumi.Any(data.Opentelekomcloud_vpc_subnet_v1.Shared_subnet.Network_id),
			AvailabilityZones: pulumi.StringArray{
				pulumi.String(zones.Names[0]),
			},
			Flavor:          pulumi.String("redis.single.xu1.tiny.128"),
			EnableWhitelist: pulumi.Bool(true),
			Whitelists: opentelekomcloud.DcsInstanceV2WhitelistArray{
				&opentelekomcloud.DcsInstanceV2WhitelistArgs{
					GroupName: pulumi.String("test-group-name"),
					IpLists: pulumi.StringArray{
						pulumi.String("10.10.10.1"),
						pulumi.String("10.10.10.2"),
					},
				},
				&opentelekomcloud.DcsInstanceV2WhitelistArgs{
					GroupName: pulumi.String("test-group-name-2"),
					IpLists: pulumi.StringArray{
						pulumi.String("10.10.10.11"),
						pulumi.String("10.10.10.3"),
						pulumi.String("10.10.10.4"),
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Opentelekomcloud = Pulumi.Opentelekomcloud;

return await Deployment.RunAsync(() => 
{
    var zones = Opentelekomcloud.GetComputeAvailabilityZonesV2.Invoke();

    var instance1 = new Opentelekomcloud.DcsInstanceV2("instance1", new()
    {
        EngineVersion = "5.0",
        Password = "0TCTestP@ssw0rd",
        Engine = "Redis",
        Capacity = 0.125,
        VpcId = data.Opentelekomcloud_vpc_subnet_v1.Shared_subnet.Vpc_id,
        SubnetId = data.Opentelekomcloud_vpc_subnet_v1.Shared_subnet.Network_id,
        AvailabilityZones = new[]
        {
            zones.Apply(getComputeAvailabilityZonesV2Result => getComputeAvailabilityZonesV2Result.Names[0]),
        },
        Flavor = "redis.single.xu1.tiny.128",
        EnableWhitelist = true,
        Whitelists = new[]
        {
            new Opentelekomcloud.Inputs.DcsInstanceV2WhitelistArgs
            {
                GroupName = "test-group-name",
                IpLists = new[]
                {
                    "10.10.10.1",
                    "10.10.10.2",
                },
            },
            new Opentelekomcloud.Inputs.DcsInstanceV2WhitelistArgs
            {
                GroupName = "test-group-name-2",
                IpLists = new[]
                {
                    "10.10.10.11",
                    "10.10.10.3",
                    "10.10.10.4",
                },
            },
        },
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.opentelekomcloud.OpentelekomcloudFunctions;
import com.pulumi.opentelekomcloud.inputs.GetComputeAvailabilityZonesV2Args;
import com.pulumi.opentelekomcloud.DcsInstanceV2;
import com.pulumi.opentelekomcloud.DcsInstanceV2Args;
import com.pulumi.opentelekomcloud.inputs.DcsInstanceV2WhitelistArgs;
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 zones = OpentelekomcloudFunctions.getComputeAvailabilityZonesV2();

        var instance1 = new DcsInstanceV2("instance1", DcsInstanceV2Args.builder()
            .engineVersion("5.0")
            .password("0TCTestP@ssw0rd")
            .engine("Redis")
            .capacity(0.125)
            .vpcId(data.opentelekomcloud_vpc_subnet_v1().shared_subnet().vpc_id())
            .subnetId(data.opentelekomcloud_vpc_subnet_v1().shared_subnet().network_id())
            .availabilityZones(zones.applyValue(getComputeAvailabilityZonesV2Result -> getComputeAvailabilityZonesV2Result.names()[0]))
            .flavor("redis.single.xu1.tiny.128")
            .enableWhitelist(true)
            .whitelists(            
                DcsInstanceV2WhitelistArgs.builder()
                    .groupName("test-group-name")
                    .ipLists(                    
                        "10.10.10.1",
                        "10.10.10.2")
                    .build(),
                DcsInstanceV2WhitelistArgs.builder()
                    .groupName("test-group-name-2")
                    .ipLists(                    
                        "10.10.10.11",
                        "10.10.10.3",
                        "10.10.10.4")
                    .build())
            .build());

    }
}

resources:
  instance1:
    type: opentelekomcloud:DcsInstanceV2
    properties:
      engineVersion: '5.0'
      password: 0TCTestP@ssw0rd
      engine: Redis
      capacity: 0.125
      vpcId: ${data.opentelekomcloud_vpc_subnet_v1.shared_subnet.vpc_id}
      subnetId: ${data.opentelekomcloud_vpc_subnet_v1.shared_subnet.network_id}
      availabilityZones:
        - ${zones.names[0]}
      flavor: redis.single.xu1.tiny.128
      enableWhitelist: true
      whitelists:
        - groupName: test-group-name
          ipLists:
            - 10.10.10.1
            - 10.10.10.2
        - groupName: test-group-name-2
          ipLists:
            - 10.10.10.11
            - 10.10.10.3
            - 10.10.10.4
variables:
  zones:
    fn::invoke:
      function: opentelekomcloud:getComputeAvailabilityZonesV2
      arguments: {}

Create DcsInstanceV2 Resource

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

new DcsInstanceV2(name: string, args: DcsInstanceV2Args, opts?: CustomResourceOptions);

@overload
def DcsInstanceV2(resource_name: str,
                  args: DcsInstanceV2Args,
                  opts: Optional[ResourceOptions] = None)

@overload
def DcsInstanceV2(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  engine: Optional[str] = None,
                  availability_zones: Optional[Sequence[str]] = None,
                  vpc_id: Optional[str] = None,
                  capacity: Optional[float] = None,
                  subnet_id: Optional[str] = None,
                  flavor: Optional[str] = None,
                  parameters: Optional[Sequence[DcsInstanceV2ParameterArgs]] = None,
                  private_ip: Optional[str] = None,
                  description: Optional[str] = None,
                  engine_version: Optional[str] = None,
                  deleted_nodes: Optional[Sequence[str]] = None,
                  maintain_begin: Optional[str] = None,
                  maintain_end: Optional[str] = None,
                  name: Optional[str] = None,
                  access_user: Optional[str] = None,
                  password: Optional[str] = None,
                  port: Optional[float] = None,
                  enable_whitelist: Optional[bool] = None,
                  rename_commands: Optional[Mapping[str, str]] = None,
                  reserved_ips: Optional[Sequence[str]] = None,
                  security_group_id: Optional[str] = None,
                  ssl_enable: Optional[bool] = None,
                  dcs_instance_v2_id: Optional[str] = None,
                  tags: Optional[Mapping[str, str]] = None,
                  template_id: Optional[str] = None,
                  timeouts: Optional[DcsInstanceV2TimeoutsArgs] = None,
                  backup_policy: Optional[DcsInstanceV2BackupPolicyArgs] = None,
                  whitelists: Optional[Sequence[DcsInstanceV2WhitelistArgs]] = None)

func NewDcsInstanceV2(ctx *Context, name string, args DcsInstanceV2Args, opts ...ResourceOption) (*DcsInstanceV2, error)

public DcsInstanceV2(string name, DcsInstanceV2Args args, CustomResourceOptions? opts = null)

public DcsInstanceV2(String name, DcsInstanceV2Args args)
public DcsInstanceV2(String name, DcsInstanceV2Args args, CustomResourceOptions options)

type: opentelekomcloud:DcsInstanceV2
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args DcsInstanceV2Args: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args DcsInstanceV2Args: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args DcsInstanceV2Args: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args DcsInstanceV2Args: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args DcsInstanceV2Args: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Constructor example

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

TypeScript
Python
Go
C#
Java
YAML

var dcsInstanceV2Resource = new Opentelekomcloud.DcsInstanceV2("dcsInstanceV2Resource", new()
{
    Engine = "string",
    AvailabilityZones = new[]
    {
        "string",
    },
    VpcId = "string",
    Capacity = 0,
    SubnetId = "string",
    Flavor = "string",
    Parameters = new[]
    {
        new Opentelekomcloud.Inputs.DcsInstanceV2ParameterArgs
        {
            Id = "string",
            Name = "string",
            Value = "string",
        },
    },
    PrivateIp = "string",
    Description = "string",
    EngineVersion = "string",
    DeletedNodes = new[]
    {
        "string",
    },
    MaintainBegin = "string",
    MaintainEnd = "string",
    Name = "string",
    AccessUser = "string",
    Password = "string",
    Port = 0,
    EnableWhitelist = false,
    RenameCommands = 
    {
        { "string", "string" },
    },
    ReservedIps = new[]
    {
        "string",
    },
    SecurityGroupId = "string",
    SslEnable = false,
    DcsInstanceV2Id = "string",
    Tags = 
    {
        { "string", "string" },
    },
    TemplateId = "string",
    Timeouts = new Opentelekomcloud.Inputs.DcsInstanceV2TimeoutsArgs
    {
        Create = "string",
        Delete = "string",
        Update = "string",
    },
    BackupPolicy = new Opentelekomcloud.Inputs.DcsInstanceV2BackupPolicyArgs
    {
        BackupAts = new[]
        {
            0,
        },
        BeginAt = "string",
        BackupType = "string",
        PeriodType = "string",
        SaveDays = 0,
    },
    Whitelists = new[]
    {
        new Opentelekomcloud.Inputs.DcsInstanceV2WhitelistArgs
        {
            GroupName = "string",
            IpLists = new[]
            {
                "string",
            },
        },
    },
});

example, err := opentelekomcloud.NewDcsInstanceV2(ctx, "dcsInstanceV2Resource", &opentelekomcloud.DcsInstanceV2Args{
Engine: pulumi.String("string"),
AvailabilityZones: pulumi.StringArray{
pulumi.String("string"),
},
VpcId: pulumi.String("string"),
Capacity: pulumi.Float64(0),
SubnetId: pulumi.String("string"),
Flavor: pulumi.String("string"),
Parameters: .DcsInstanceV2ParameterArray{
&.DcsInstanceV2ParameterArgs{
Id: pulumi.String("string"),
Name: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
PrivateIp: pulumi.String("string"),
Description: pulumi.String("string"),
EngineVersion: pulumi.String("string"),
DeletedNodes: pulumi.StringArray{
pulumi.String("string"),
},
MaintainBegin: pulumi.String("string"),
MaintainEnd: pulumi.String("string"),
Name: pulumi.String("string"),
AccessUser: pulumi.String("string"),
Password: pulumi.String("string"),
Port: pulumi.Float64(0),
EnableWhitelist: pulumi.Bool(false),
RenameCommands: pulumi.StringMap{
"string": pulumi.String("string"),
},
ReservedIps: pulumi.StringArray{
pulumi.String("string"),
},
SecurityGroupId: pulumi.String("string"),
SslEnable: pulumi.Bool(false),
DcsInstanceV2Id: pulumi.String("string"),
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
TemplateId: pulumi.String("string"),
Timeouts: &.DcsInstanceV2TimeoutsArgs{
Create: pulumi.String("string"),
Delete: pulumi.String("string"),
Update: pulumi.String("string"),
},
BackupPolicy: &.DcsInstanceV2BackupPolicyArgs{
BackupAts: pulumi.Float64Array{
pulumi.Float64(0),
},
BeginAt: pulumi.String("string"),
BackupType: pulumi.String("string"),
PeriodType: pulumi.String("string"),
SaveDays: pulumi.Float64(0),
},
Whitelists: .DcsInstanceV2WhitelistArray{
&.DcsInstanceV2WhitelistArgs{
GroupName: pulumi.String("string"),
IpLists: pulumi.StringArray{
pulumi.String("string"),
},
},
},
})

var dcsInstanceV2Resource = new DcsInstanceV2("dcsInstanceV2Resource", DcsInstanceV2Args.builder()
    .engine("string")
    .availabilityZones("string")
    .vpcId("string")
    .capacity(0)
    .subnetId("string")
    .flavor("string")
    .parameters(DcsInstanceV2ParameterArgs.builder()
        .id("string")
        .name("string")
        .value("string")
        .build())
    .privateIp("string")
    .description("string")
    .engineVersion("string")
    .deletedNodes("string")
    .maintainBegin("string")
    .maintainEnd("string")
    .name("string")
    .accessUser("string")
    .password("string")
    .port(0)
    .enableWhitelist(false)
    .renameCommands(Map.of("string", "string"))
    .reservedIps("string")
    .securityGroupId("string")
    .sslEnable(false)
    .dcsInstanceV2Id("string")
    .tags(Map.of("string", "string"))
    .templateId("string")
    .timeouts(DcsInstanceV2TimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .update("string")
        .build())
    .backupPolicy(DcsInstanceV2BackupPolicyArgs.builder()
        .backupAts(0)
        .beginAt("string")
        .backupType("string")
        .periodType("string")
        .saveDays(0)
        .build())
    .whitelists(DcsInstanceV2WhitelistArgs.builder()
        .groupName("string")
        .ipLists("string")
        .build())
    .build());

dcs_instance_v2_resource = opentelekomcloud.DcsInstanceV2("dcsInstanceV2Resource",
    engine="string",
    availability_zones=["string"],
    vpc_id="string",
    capacity=0,
    subnet_id="string",
    flavor="string",
    parameters=[{
        "id": "string",
        "name": "string",
        "value": "string",
    }],
    private_ip="string",
    description="string",
    engine_version="string",
    deleted_nodes=["string"],
    maintain_begin="string",
    maintain_end="string",
    name="string",
    access_user="string",
    password="string",
    port=0,
    enable_whitelist=False,
    rename_commands={
        "string": "string",
    },
    reserved_ips=["string"],
    security_group_id="string",
    ssl_enable=False,
    dcs_instance_v2_id="string",
    tags={
        "string": "string",
    },
    template_id="string",
    timeouts={
        "create": "string",
        "delete": "string",
        "update": "string",
    },
    backup_policy={
        "backup_ats": [0],
        "begin_at": "string",
        "backup_type": "string",
        "period_type": "string",
        "save_days": 0,
    },
    whitelists=[{
        "group_name": "string",
        "ip_lists": ["string"],
    }])

const dcsInstanceV2Resource = new opentelekomcloud.DcsInstanceV2("dcsInstanceV2Resource", {
    engine: "string",
    availabilityZones: ["string"],
    vpcId: "string",
    capacity: 0,
    subnetId: "string",
    flavor: "string",
    parameters: [{
        id: "string",
        name: "string",
        value: "string",
    }],
    privateIp: "string",
    description: "string",
    engineVersion: "string",
    deletedNodes: ["string"],
    maintainBegin: "string",
    maintainEnd: "string",
    name: "string",
    accessUser: "string",
    password: "string",
    port: 0,
    enableWhitelist: false,
    renameCommands: {
        string: "string",
    },
    reservedIps: ["string"],
    securityGroupId: "string",
    sslEnable: false,
    dcsInstanceV2Id: "string",
    tags: {
        string: "string",
    },
    templateId: "string",
    timeouts: {
        create: "string",
        "delete": "string",
        update: "string",
    },
    backupPolicy: {
        backupAts: [0],
        beginAt: "string",
        backupType: "string",
        periodType: "string",
        saveDays: 0,
    },
    whitelists: [{
        groupName: "string",
        ipLists: ["string"],
    }],
});

type: opentelekomcloud:DcsInstanceV2
properties:
    accessUser: string
    availabilityZones:
        - string
    backupPolicy:
        backupAts:
            - 0
        backupType: string
        beginAt: string
        periodType: string
        saveDays: 0
    capacity: 0
    dcsInstanceV2Id: string
    deletedNodes:
        - string
    description: string
    enableWhitelist: false
    engine: string
    engineVersion: string
    flavor: string
    maintainBegin: string
    maintainEnd: string
    name: string
    parameters:
        - id: string
          name: string
          value: string
    password: string
    port: 0
    privateIp: string
    renameCommands:
        string: string
    reservedIps:
        - string
    securityGroupId: string
    sslEnable: false
    subnetId: string
    tags:
        string: string
    templateId: string
    timeouts:
        create: string
        delete: string
        update: string
    vpcId: string
    whitelists:
        - groupName: string
          ipLists:
            - string

DcsInstanceV2 Resource Properties

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

Inputs

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

The DcsInstanceV2 resource accepts the following input properties:

AvailabilityZones List<string>

The code of the AZ where the cache node resides. Master/Standby, Proxy Cluster, and Redis Cluster DCS instances support cross-AZ deployment. You can specify an AZ for the standby node. When specifying AZs for nodes, use commas (,) to separate AZs. Changing this creates a new instance.

Capacity double

Specifies the cache capacity. Unit: GB.

Engine string

Specifies a cache engine. Options: Redis and Memcached. Changing this creates a new instance.

Flavor string

The flavor of the cache instance, which including the total memory, available memory, maximum number of connections allowed, maximum/assured bandwidth and reference performance. It also includes the modes of Redis instances. You can query the flavor as follows:

Query flavors in DCS Instance Specifications
Log in to the DCS console, click Create DCS Instance, and find the corresponding instance specification.

SubnetId string

The ID of subnet which the instance belongs to. Changing this creates a new instance resource.

VpcId string

The ID of VPC which the instance belongs to. Changing this creates a new instance resource.

AccessUser string

Specifies the username used for accessing a DCS instance. The username starts with a letter, consists of 1 to 64 characters, and supports only letters, digits, and hyphens (-). Changing this creates a new instance.

BackupPolicy DcsInstanceV2BackupPolicy

Specifies the backup configuration to be used with the instance. The structure is described below.

NOTE: This parameter is not supported when the instance type is single.

DcsInstanceV2Id string

A resource ID in UUID format.

DeletedNodes List<string>

Specifies the ID of the replica to delete. This parameter is mandatory when you delete replicas of a master/standby DCS Redis 4.0 or 5.0 instance. Currently, only one replica can be deleted at a time.

Description string

Specifies the description of an instance. It is a string that contains a maximum of 1024 characters.

EnableWhitelist bool

Enable or disable the IP address whitelists. Defaults to true. If the whitelist is disabled, all IP addresses connected to the VPC can access the instance.

EngineVersion string

Specifies the version of a cache engine. It is mandatory when the engine is Redis, the value can be 3.0, 4.0, 5.0 or 6.0. Changing this creates a new instance.

MaintainBegin string

Time at which the maintenance time window starts. Defaults to 02:00:00.

The start time and end time of a maintenance time window must indicate the time segment of a supported maintenance time window.
The start time must be on the hour, such as 18:00:00.
If parameter maintain_begin is left blank, parameter maintain_end is also blank. In this case, the system automatically allocates the default start time 02:00:00.

MaintainEnd string

Time at which the maintenance time window ends. Defaults to 06:00:00.

The start time and end time of a maintenance time window must indicate the time segment of a supported maintenance time window.
The end time is one hour later than the start time. For example, if the start time is 18:00:00, the end time is 19:00:00.
If parameter maintain_end is left blank, parameter maintain_begin is also blank. In this case, the system automatically allocates the default end time 06:00:00.

NOTE: Parameters maintain_begin and maintain_end must be set in pairs.

Name string

Specifies the name of an instance. The name must be 4 to 64 characters and start with a letter. Only chinese, letters (case-insensitive), digits, underscores (_) ,and hyphens (-) are allowed.

Parameters List<DcsInstanceV2Parameter>

Specify an array of one or more parameters to be set to the DCS instance after launched. You can check on console to see which parameters supported. The parameters structure is documented below.

Password string

Specifies the password of a DCS instance. The password of a DCS instance must meet the following complexity requirements:

Must be a string of 8 to 32 bits in length.
Must contain three combinations of the following four characters: Lower case letters, uppercase letter, digital, Special characters include (`~!@#$^&*()-_=+\|{}:,<.>/?).
The new password cannot be the same as the old password.

Port double

Port customization, which is supported only by Redis 4.0 and Redis 5.0 instances. Redis instance defaults to 6379. Memcached instance does not use this argument.

PrivateIp string

The IP address of the DCS instance, which can only be the currently available IP address the selected subnet. You can specify an available IP for the Redis instance (except for the Redis Cluster type). If omitted, the system will automatically allocate an available IP address to the Redis instance. Changing this creates a new instance resource.

RenameCommands Dictionary<string, string>

Critical command renaming, which is supported only by Redis 4.0 and Redis 5.0 instances but not by Redis 3.0 instance. The valid commands that can be renamed are: command, keys, flushdb, flushall and hgetall.

ReservedIps List<string>

Specifies IP addresses to retain. Mandatory during cluster scale-in. If this parameter is not set, the system randomly deletes unnecessary shards.

SecurityGroupId string

The ID of the security group which the instance belongs to. This parameter is mandatory for Memcached and Redis 3.0 version.

SslEnable bool

Specifies whether to enable the SSL. Value options: true, false.

Tags Dictionary<string, string>

The key/value pairs to associate with the dcs instance.

TemplateId string

The Parameter Template ID. Changing this creates a new instance resource.

Timeouts DcsInstanceV2Timeouts

Whitelists List<DcsInstanceV2Whitelist>

Specifies the IP addresses which can access the instance. This parameter is valid for Redis 4.0 and 5.0 versions. The structure is described below.

AvailabilityZones []string

Capacity float64

Specifies the cache capacity. Unit: GB.

Engine string

Specifies a cache engine. Options: Redis and Memcached. Changing this creates a new instance.

Flavor string

Query flavors in DCS Instance Specifications
Log in to the DCS console, click Create DCS Instance, and find the corresponding instance specification.

SubnetId string

The ID of subnet which the instance belongs to. Changing this creates a new instance resource.

VpcId string

The ID of VPC which the instance belongs to. Changing this creates a new instance resource.

AccessUser string

BackupPolicy DcsInstanceV2BackupPolicyArgs

Specifies the backup configuration to be used with the instance. The structure is described below.

NOTE: This parameter is not supported when the instance type is single.

DcsInstanceV2Id string

A resource ID in UUID format.

DeletedNodes []string

Description string

Specifies the description of an instance. It is a string that contains a maximum of 1024 characters.

EnableWhitelist bool

Enable or disable the IP address whitelists. Defaults to true. If the whitelist is disabled, all IP addresses connected to the VPC can access the instance.

EngineVersion string

Specifies the version of a cache engine. It is mandatory when the engine is Redis, the value can be 3.0, 4.0, 5.0 or 6.0. Changing this creates a new instance.

MaintainBegin string

Time at which the maintenance time window starts. Defaults to 02:00:00.

The start time and end time of a maintenance time window must indicate the time segment of a supported maintenance time window.
The start time must be on the hour, such as 18:00:00.
If parameter maintain_begin is left blank, parameter maintain_end is also blank. In this case, the system automatically allocates the default start time 02:00:00.

MaintainEnd string

Time at which the maintenance time window ends. Defaults to 06:00:00.

The start time and end time of a maintenance time window must indicate the time segment of a supported maintenance time window.
The end time is one hour later than the start time. For example, if the start time is 18:00:00, the end time is 19:00:00.
If parameter maintain_end is left blank, parameter maintain_begin is also blank. In this case, the system automatically allocates the default end time 06:00:00.

NOTE: Parameters maintain_begin and maintain_end must be set in pairs.

Name string

Specifies the name of an instance. The name must be 4 to 64 characters and start with a letter. Only chinese, letters (case-insensitive), digits, underscores (_) ,and hyphens (-) are allowed.

Parameters []DcsInstanceV2ParameterArgs

Specify an array of one or more parameters to be set to the DCS instance after launched. You can check on console to see which parameters supported. The parameters structure is documented below.

Password string

Specifies the password of a DCS instance. The password of a DCS instance must meet the following complexity requirements:

Must be a string of 8 to 32 bits in length.
Must contain three combinations of the following four characters: Lower case letters, uppercase letter, digital, Special characters include (`~!@#$^&*()-_=+\|{}:,<.>/?).
The new password cannot be the same as the old password.

Port float64

Port customization, which is supported only by Redis 4.0 and Redis 5.0 instances. Redis instance defaults to 6379. Memcached instance does not use this argument.

PrivateIp string

RenameCommands map[string]string

ReservedIps []string

Specifies IP addresses to retain. Mandatory during cluster scale-in. If this parameter is not set, the system randomly deletes unnecessary shards.

SecurityGroupId string

The ID of the security group which the instance belongs to. This parameter is mandatory for Memcached and Redis 3.0 version.

SslEnable bool

Specifies whether to enable the SSL. Value options: true, false.

Tags map[string]string

The key/value pairs to associate with the dcs instance.

TemplateId string

The Parameter Template ID. Changing this creates a new instance resource.

Timeouts DcsInstanceV2TimeoutsArgs

Whitelists []DcsInstanceV2WhitelistArgs

Specifies the IP addresses which can access the instance. This parameter is valid for Redis 4.0 and 5.0 versions. The structure is described below.

availabilityZones List<String>

capacity Double

Specifies the cache capacity. Unit: GB.

engine String

Specifies a cache engine. Options: Redis and Memcached. Changing this creates a new instance.

flavor String

Query flavors in DCS Instance Specifications
Log in to the DCS console, click Create DCS Instance, and find the corresponding instance specification.

subnetId String

The ID of subnet which the instance belongs to. Changing this creates a new instance resource.

vpcId String

The ID of VPC which the instance belongs to. Changing this creates a new instance resource.

accessUser String

backupPolicy DcsInstanceV2BackupPolicy

Specifies the backup configuration to be used with the instance. The structure is described below.

NOTE: This parameter is not supported when the instance type is single.

dcsInstanceV2Id String

A resource ID in UUID format.

deletedNodes List<String>

description String

Specifies the description of an instance. It is a string that contains a maximum of 1024 characters.

enableWhitelist Boolean

Enable or disable the IP address whitelists. Defaults to true. If the whitelist is disabled, all IP addresses connected to the VPC can access the instance.

engineVersion String

Specifies the version of a cache engine. It is mandatory when the engine is Redis, the value can be 3.0, 4.0, 5.0 or 6.0. Changing this creates a new instance.

maintainBegin String

Time at which the maintenance time window starts. Defaults to 02:00:00.

The start time and end time of a maintenance time window must indicate the time segment of a supported maintenance time window.
The start time must be on the hour, such as 18:00:00.
If parameter maintain_begin is left blank, parameter maintain_end is also blank. In this case, the system automatically allocates the default start time 02:00:00.

maintainEnd String

Time at which the maintenance time window ends. Defaults to 06:00:00.

The start time and end time of a maintenance time window must indicate the time segment of a supported maintenance time window.
The end time is one hour later than the start time. For example, if the start time is 18:00:00, the end time is 19:00:00.
If parameter maintain_end is left blank, parameter maintain_begin is also blank. In this case, the system automatically allocates the default end time 06:00:00.

NOTE: Parameters maintain_begin and maintain_end must be set in pairs.

name String

Specifies the name of an instance. The name must be 4 to 64 characters and start with a letter. Only chinese, letters (case-insensitive), digits, underscores (_) ,and hyphens (-) are allowed.

parameters List<DcsInstanceV2Parameter>

Specify an array of one or more parameters to be set to the DCS instance after launched. You can check on console to see which parameters supported. The parameters structure is documented below.

password String

Specifies the password of a DCS instance. The password of a DCS instance must meet the following complexity requirements:

Must be a string of 8 to 32 bits in length.
Must contain three combinations of the following four characters: Lower case letters, uppercase letter, digital, Special characters include (`~!@#$^&*()-_=+\|{}:,<.>/?).
The new password cannot be the same as the old password.

port Double

Port customization, which is supported only by Redis 4.0 and Redis 5.0 instances. Redis instance defaults to 6379. Memcached instance does not use this argument.

privateIp String

renameCommands Map<String,String>

reservedIps List<String>

Specifies IP addresses to retain. Mandatory during cluster scale-in. If this parameter is not set, the system randomly deletes unnecessary shards.

securityGroupId String

The ID of the security group which the instance belongs to. This parameter is mandatory for Memcached and Redis 3.0 version.

sslEnable Boolean

Specifies whether to enable the SSL. Value options: true, false.

tags Map<String,String>

The key/value pairs to associate with the dcs instance.

templateId String

The Parameter Template ID. Changing this creates a new instance resource.

timeouts DcsInstanceV2Timeouts

whitelists List<DcsInstanceV2Whitelist>

Specifies the IP addresses which can access the instance. This parameter is valid for Redis 4.0 and 5.0 versions. The structure is described below.

availabilityZones string[]

capacity number

Specifies the cache capacity. Unit: GB.

engine string

Specifies a cache engine. Options: Redis and Memcached. Changing this creates a new instance.

flavor string

Query flavors in DCS Instance Specifications
Log in to the DCS console, click Create DCS Instance, and find the corresponding instance specification.

subnetId string

The ID of subnet which the instance belongs to. Changing this creates a new instance resource.

vpcId string

The ID of VPC which the instance belongs to. Changing this creates a new instance resource.

accessUser string

backupPolicy DcsInstanceV2BackupPolicy

Specifies the backup configuration to be used with the instance. The structure is described below.

NOTE: This parameter is not supported when the instance type is single.

dcsInstanceV2Id string

A resource ID in UUID format.

deletedNodes string[]

description string

Specifies the description of an instance. It is a string that contains a maximum of 1024 characters.

enableWhitelist boolean

Enable or disable the IP address whitelists. Defaults to true. If the whitelist is disabled, all IP addresses connected to the VPC can access the instance.

engineVersion string

Specifies the version of a cache engine. It is mandatory when the engine is Redis, the value can be 3.0, 4.0, 5.0 or 6.0. Changing this creates a new instance.

maintainBegin string

Time at which the maintenance time window starts. Defaults to 02:00:00.

The start time and end time of a maintenance time window must indicate the time segment of a supported maintenance time window.
The start time must be on the hour, such as 18:00:00.
If parameter maintain_begin is left blank, parameter maintain_end is also blank. In this case, the system automatically allocates the default start time 02:00:00.

maintainEnd string

Time at which the maintenance time window ends. Defaults to 06:00:00.

The start time and end time of a maintenance time window must indicate the time segment of a supported maintenance time window.
The end time is one hour later than the start time. For example, if the start time is 18:00:00, the end time is 19:00:00.
If parameter maintain_end is left blank, parameter maintain_begin is also blank. In this case, the system automatically allocates the default end time 06:00:00.

NOTE: Parameters maintain_begin and maintain_end must be set in pairs.

name string

Specifies the name of an instance. The name must be 4 to 64 characters and start with a letter. Only chinese, letters (case-insensitive), digits, underscores (_) ,and hyphens (-) are allowed.

parameters DcsInstanceV2Parameter[]

Specify an array of one or more parameters to be set to the DCS instance after launched. You can check on console to see which parameters supported. The parameters structure is documented below.

password string

Specifies the password of a DCS instance. The password of a DCS instance must meet the following complexity requirements:

Must be a string of 8 to 32 bits in length.
Must contain three combinations of the following four characters: Lower case letters, uppercase letter, digital, Special characters include (`~!@#$^&*()-_=+\|{}:,<.>/?).
The new password cannot be the same as the old password.

port number

Port customization, which is supported only by Redis 4.0 and Redis 5.0 instances. Redis instance defaults to 6379. Memcached instance does not use this argument.

privateIp string

renameCommands {[key: string]: string}

reservedIps string[]

Specifies IP addresses to retain. Mandatory during cluster scale-in. If this parameter is not set, the system randomly deletes unnecessary shards.

securityGroupId string

The ID of the security group which the instance belongs to. This parameter is mandatory for Memcached and Redis 3.0 version.

sslEnable boolean

Specifies whether to enable the SSL. Value options: true, false.

tags {[key: string]: string}

The key/value pairs to associate with the dcs instance.

templateId string

The Parameter Template ID. Changing this creates a new instance resource.

timeouts DcsInstanceV2Timeouts

whitelists DcsInstanceV2Whitelist[]

Specifies the IP addresses which can access the instance. This parameter is valid for Redis 4.0 and 5.0 versions. The structure is described below.

availability_zones Sequence[str]

capacity float

Specifies the cache capacity. Unit: GB.

engine str

Specifies a cache engine. Options: Redis and Memcached. Changing this creates a new instance.

flavor str

Query flavors in DCS Instance Specifications
Log in to the DCS console, click Create DCS Instance, and find the corresponding instance specification.

subnet_id str

The ID of subnet which the instance belongs to. Changing this creates a new instance resource.

vpc_id str

The ID of VPC which the instance belongs to. Changing this creates a new instance resource.

access_user str

backup_policy DcsInstanceV2BackupPolicyArgs

Specifies the backup configuration to be used with the instance. The structure is described below.

NOTE: This parameter is not supported when the instance type is single.

dcs_instance_v2_id str

A resource ID in UUID format.

deleted_nodes Sequence[str]

description str

Specifies the description of an instance. It is a string that contains a maximum of 1024 characters.

enable_whitelist bool

Enable or disable the IP address whitelists. Defaults to true. If the whitelist is disabled, all IP addresses connected to the VPC can access the instance.

engine_version str

Specifies the version of a cache engine. It is mandatory when the engine is Redis, the value can be 3.0, 4.0, 5.0 or 6.0. Changing this creates a new instance.

maintain_begin str

Time at which the maintenance time window starts. Defaults to 02:00:00.

The start time and end time of a maintenance time window must indicate the time segment of a supported maintenance time window.
The start time must be on the hour, such as 18:00:00.
If parameter maintain_begin is left blank, parameter maintain_end is also blank. In this case, the system automatically allocates the default start time 02:00:00.

maintain_end str

Time at which the maintenance time window ends. Defaults to 06:00:00.

The start time and end time of a maintenance time window must indicate the time segment of a supported maintenance time window.
The end time is one hour later than the start time. For example, if the start time is 18:00:00, the end time is 19:00:00.
If parameter maintain_end is left blank, parameter maintain_begin is also blank. In this case, the system automatically allocates the default end time 06:00:00.

NOTE: Parameters maintain_begin and maintain_end must be set in pairs.

name str

Specifies the name of an instance. The name must be 4 to 64 characters and start with a letter. Only chinese, letters (case-insensitive), digits, underscores (_) ,and hyphens (-) are allowed.

parameters Sequence[DcsInstanceV2ParameterArgs]

Specify an array of one or more parameters to be set to the DCS instance after launched. You can check on console to see which parameters supported. The parameters structure is documented below.

password str

Specifies the password of a DCS instance. The password of a DCS instance must meet the following complexity requirements:

Must be a string of 8 to 32 bits in length.
Must contain three combinations of the following four characters: Lower case letters, uppercase letter, digital, Special characters include (`~!@#$^&*()-_=+\|{}:,<.>/?).
The new password cannot be the same as the old password.

port float

Port customization, which is supported only by Redis 4.0 and Redis 5.0 instances. Redis instance defaults to 6379. Memcached instance does not use this argument.

private_ip str

rename_commands Mapping[str, str]

reserved_ips Sequence[str]

Specifies IP addresses to retain. Mandatory during cluster scale-in. If this parameter is not set, the system randomly deletes unnecessary shards.

security_group_id str

The ID of the security group which the instance belongs to. This parameter is mandatory for Memcached and Redis 3.0 version.

ssl_enable bool

Specifies whether to enable the SSL. Value options: true, false.

tags Mapping[str, str]

The key/value pairs to associate with the dcs instance.

template_id str

The Parameter Template ID. Changing this creates a new instance resource.

timeouts DcsInstanceV2TimeoutsArgs

whitelists Sequence[DcsInstanceV2WhitelistArgs]

Specifies the IP addresses which can access the instance. This parameter is valid for Redis 4.0 and 5.0 versions. The structure is described below.

availabilityZones List<String>

capacity Number

Specifies the cache capacity. Unit: GB.

engine String

Specifies a cache engine. Options: Redis and Memcached. Changing this creates a new instance.

flavor String

Query flavors in DCS Instance Specifications
Log in to the DCS console, click Create DCS Instance, and find the corresponding instance specification.

subnetId String

The ID of subnet which the instance belongs to. Changing this creates a new instance resource.

vpcId String

The ID of VPC which the instance belongs to. Changing this creates a new instance resource.

accessUser String

backupPolicy Property Map

Specifies the backup configuration to be used with the instance. The structure is described below.

NOTE: This parameter is not supported when the instance type is single.

dcsInstanceV2Id String

A resource ID in UUID format.

deletedNodes List<String>

description String

Specifies the description of an instance. It is a string that contains a maximum of 1024 characters.

enableWhitelist Boolean

Enable or disable the IP address whitelists. Defaults to true. If the whitelist is disabled, all IP addresses connected to the VPC can access the instance.

engineVersion String

Specifies the version of a cache engine. It is mandatory when the engine is Redis, the value can be 3.0, 4.0, 5.0 or 6.0. Changing this creates a new instance.

maintainBegin String

Time at which the maintenance time window starts. Defaults to 02:00:00.

The start time and end time of a maintenance time window must indicate the time segment of a supported maintenance time window.
The start time must be on the hour, such as 18:00:00.
If parameter maintain_begin is left blank, parameter maintain_end is also blank. In this case, the system automatically allocates the default start time 02:00:00.

maintainEnd String

Time at which the maintenance time window ends. Defaults to 06:00:00.

The start time and end time of a maintenance time window must indicate the time segment of a supported maintenance time window.
The end time is one hour later than the start time. For example, if the start time is 18:00:00, the end time is 19:00:00.
If parameter maintain_end is left blank, parameter maintain_begin is also blank. In this case, the system automatically allocates the default end time 06:00:00.

NOTE: Parameters maintain_begin and maintain_end must be set in pairs.

name String

Specifies the name of an instance. The name must be 4 to 64 characters and start with a letter. Only chinese, letters (case-insensitive), digits, underscores (_) ,and hyphens (-) are allowed.

parameters List<Property Map>

Specify an array of one or more parameters to be set to the DCS instance after launched. You can check on console to see which parameters supported. The parameters structure is documented below.

password String

Specifies the password of a DCS instance. The password of a DCS instance must meet the following complexity requirements:

Must be a string of 8 to 32 bits in length.
Must contain three combinations of the following four characters: Lower case letters, uppercase letter, digital, Special characters include (`~!@#$^&*()-_=+\|{}:,<.>/?).
The new password cannot be the same as the old password.

port Number

Port customization, which is supported only by Redis 4.0 and Redis 5.0 instances. Redis instance defaults to 6379. Memcached instance does not use this argument.

privateIp String

renameCommands Map<String>

reservedIps List<String>

Specifies IP addresses to retain. Mandatory during cluster scale-in. If this parameter is not set, the system randomly deletes unnecessary shards.

securityGroupId String

The ID of the security group which the instance belongs to. This parameter is mandatory for Memcached and Redis 3.0 version.

sslEnable Boolean

Specifies whether to enable the SSL. Value options: true, false.

tags Map<String>

The key/value pairs to associate with the dcs instance.

templateId String

The Parameter Template ID. Changing this creates a new instance resource.

timeouts Property Map

whitelists List<Property Map>

Specifies the IP addresses which can access the instance. This parameter is valid for Redis 4.0 and 5.0 versions. The structure is described below.

Outputs

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

BandwidthInfos List<DcsInstanceV2BandwidthInfo>

Indicates the bandwidth information of the instance. The bandwidth_info structure is documented below.

CacheMode string

Indicates the instance type. The value can be single, ha, cluster or proxy.

CpuType string

Indicates the CPU type of the instance. The value can be x86_64 or aarch64.

CreatedAt string

Indicates the time when the instance is created, in RFC3339 format.

DomainName string

Domain name of the instance. Usually, we use domain name and port to connect to the DCS instances.

Id string

The provider-assigned unique ID for this managed resource.

LaunchedAt string

Indicates the time when the instance is started, in RFC3339 format.

MaxMemory double

Total memory size. Unit: MB.

ProductType string

Indicates the product type of the instance. The value can be: generic or enterprise.

ReadonlyDomainName string

Indicates the read-only domain name of the instance. This parameter is available only for master/standby instances.

Region string

Indicates the region in which DCS instance resource is created.

ReplicaCount double

Indicates the number of replicas in the instance.

SecurityGroupName string

The name of security group which the instance belongs to.

ShardingCount double

Indicates the number of shards in a cluster instance.

Status string

Cache instance status. The valid values are as follows:

RUNNING: The instance is running properly. Only instances in the Running state can provide in-memory cache service.
ERROR: The instance is not running properly.
RESTARTING: The instance is being restarted.
FROZEN: The instance has been frozen due to low balance. You can unfreeze the instance by recharging your account in My Order.
EXTENDING: The instance is being scaled up.
RESTORING: The instance data is being restored.
FLUSHING: The DCS instance is being cleared.

SubnetCidr string

Indicates the subnet segment.

SubnetName string

The name of subnet which the instance belongs to.

TransparentClientIpEnable bool

Indicates whether client IP pass-through is enabled.

UsedMemory double

Size of the used memory. Unit: MB.

UserId string

UserName string

VpcName string

The name of VPC which the instance belongs to.

BandwidthInfos []DcsInstanceV2BandwidthInfo

Indicates the bandwidth information of the instance. The bandwidth_info structure is documented below.

CacheMode string

Indicates the instance type. The value can be single, ha, cluster or proxy.

CpuType string

Indicates the CPU type of the instance. The value can be x86_64 or aarch64.

CreatedAt string

Indicates the time when the instance is created, in RFC3339 format.

DomainName string

Domain name of the instance. Usually, we use domain name and port to connect to the DCS instances.

Id string

The provider-assigned unique ID for this managed resource.

LaunchedAt string

Indicates the time when the instance is started, in RFC3339 format.

MaxMemory float64

Total memory size. Unit: MB.

ProductType string

Indicates the product type of the instance. The value can be: generic or enterprise.

ReadonlyDomainName string

Indicates the read-only domain name of the instance. This parameter is available only for master/standby instances.

Region string

Indicates the region in which DCS instance resource is created.

ReplicaCount float64

Indicates the number of replicas in the instance.

SecurityGroupName string

The name of security group which the instance belongs to.

ShardingCount float64

Indicates the number of shards in a cluster instance.

Status string

Cache instance status. The valid values are as follows:

RUNNING: The instance is running properly. Only instances in the Running state can provide in-memory cache service.
ERROR: The instance is not running properly.
RESTARTING: The instance is being restarted.
FROZEN: The instance has been frozen due to low balance. You can unfreeze the instance by recharging your account in My Order.
EXTENDING: The instance is being scaled up.
RESTORING: The instance data is being restored.
FLUSHING: The DCS instance is being cleared.

SubnetCidr string

Indicates the subnet segment.

SubnetName string

The name of subnet which the instance belongs to.

TransparentClientIpEnable bool

Indicates whether client IP pass-through is enabled.

UsedMemory float64

Size of the used memory. Unit: MB.

UserId string

UserName string

VpcName string

The name of VPC which the instance belongs to.

bandwidthInfos List<DcsInstanceV2BandwidthInfo>

Indicates the bandwidth information of the instance. The bandwidth_info structure is documented below.

cacheMode String

Indicates the instance type. The value can be single, ha, cluster or proxy.

cpuType String

Indicates the CPU type of the instance. The value can be x86_64 or aarch64.

createdAt String

Indicates the time when the instance is created, in RFC3339 format.

domainName String

Domain name of the instance. Usually, we use domain name and port to connect to the DCS instances.

id String

The provider-assigned unique ID for this managed resource.

launchedAt String

Indicates the time when the instance is started, in RFC3339 format.

maxMemory Double

Total memory size. Unit: MB.

productType String

Indicates the product type of the instance. The value can be: generic or enterprise.

readonlyDomainName String

Indicates the read-only domain name of the instance. This parameter is available only for master/standby instances.

region String

Indicates the region in which DCS instance resource is created.

replicaCount Double

Indicates the number of replicas in the instance.

securityGroupName String

The name of security group which the instance belongs to.

shardingCount Double

Indicates the number of shards in a cluster instance.

status String

Cache instance status. The valid values are as follows:

RUNNING: The instance is running properly. Only instances in the Running state can provide in-memory cache service.
ERROR: The instance is not running properly.
RESTARTING: The instance is being restarted.
FROZEN: The instance has been frozen due to low balance. You can unfreeze the instance by recharging your account in My Order.
EXTENDING: The instance is being scaled up.
RESTORING: The instance data is being restored.
FLUSHING: The DCS instance is being cleared.

subnetCidr String

Indicates the subnet segment.

subnetName String

The name of subnet which the instance belongs to.

transparentClientIpEnable Boolean

Indicates whether client IP pass-through is enabled.

usedMemory Double

Size of the used memory. Unit: MB.

userId String

userName String

vpcName String

The name of VPC which the instance belongs to.

bandwidthInfos DcsInstanceV2BandwidthInfo[]

Indicates the bandwidth information of the instance. The bandwidth_info structure is documented below.

cacheMode string

Indicates the instance type. The value can be single, ha, cluster or proxy.

cpuType string

Indicates the CPU type of the instance. The value can be x86_64 or aarch64.

createdAt string

Indicates the time when the instance is created, in RFC3339 format.

domainName string

Domain name of the instance. Usually, we use domain name and port to connect to the DCS instances.

id string

The provider-assigned unique ID for this managed resource.

launchedAt string

Indicates the time when the instance is started, in RFC3339 format.

maxMemory number

Total memory size. Unit: MB.

productType string

Indicates the product type of the instance. The value can be: generic or enterprise.

readonlyDomainName string

Indicates the read-only domain name of the instance. This parameter is available only for master/standby instances.

region string

Indicates the region in which DCS instance resource is created.

replicaCount number

Indicates the number of replicas in the instance.

securityGroupName string

The name of security group which the instance belongs to.

shardingCount number

Indicates the number of shards in a cluster instance.

status string

Cache instance status. The valid values are as follows:

RUNNING: The instance is running properly. Only instances in the Running state can provide in-memory cache service.
ERROR: The instance is not running properly.
RESTARTING: The instance is being restarted.
FROZEN: The instance has been frozen due to low balance. You can unfreeze the instance by recharging your account in My Order.
EXTENDING: The instance is being scaled up.
RESTORING: The instance data is being restored.
FLUSHING: The DCS instance is being cleared.

subnetCidr string

Indicates the subnet segment.

subnetName string

The name of subnet which the instance belongs to.

transparentClientIpEnable boolean

Indicates whether client IP pass-through is enabled.

usedMemory number

Size of the used memory. Unit: MB.

userId string

userName string

vpcName string

The name of VPC which the instance belongs to.

bandwidth_infos Sequence[DcsInstanceV2BandwidthInfo]

Indicates the bandwidth information of the instance. The bandwidth_info structure is documented below.

cache_mode str

Indicates the instance type. The value can be single, ha, cluster or proxy.

cpu_type str

Indicates the CPU type of the instance. The value can be x86_64 or aarch64.

created_at str

Indicates the time when the instance is created, in RFC3339 format.

domain_name str

Domain name of the instance. Usually, we use domain name and port to connect to the DCS instances.

id str

The provider-assigned unique ID for this managed resource.

launched_at str

Indicates the time when the instance is started, in RFC3339 format.

max_memory float

Total memory size. Unit: MB.

product_type str

Indicates the product type of the instance. The value can be: generic or enterprise.

readonly_domain_name str

Indicates the read-only domain name of the instance. This parameter is available only for master/standby instances.

region str

Indicates the region in which DCS instance resource is created.

replica_count float

Indicates the number of replicas in the instance.

security_group_name str

The name of security group which the instance belongs to.

sharding_count float

Indicates the number of shards in a cluster instance.

status str

Cache instance status. The valid values are as follows:

RUNNING: The instance is running properly. Only instances in the Running state can provide in-memory cache service.
ERROR: The instance is not running properly.
RESTARTING: The instance is being restarted.
FROZEN: The instance has been frozen due to low balance. You can unfreeze the instance by recharging your account in My Order.
EXTENDING: The instance is being scaled up.
RESTORING: The instance data is being restored.
FLUSHING: The DCS instance is being cleared.

subnet_cidr str

Indicates the subnet segment.

subnet_name str

The name of subnet which the instance belongs to.

transparent_client_ip_enable bool

Indicates whether client IP pass-through is enabled.

used_memory float

Size of the used memory. Unit: MB.

user_id str

user_name str

vpc_name str

The name of VPC which the instance belongs to.

bandwidthInfos List<Property Map>

Indicates the bandwidth information of the instance. The bandwidth_info structure is documented below.

cacheMode String

Indicates the instance type. The value can be single, ha, cluster or proxy.

cpuType String

Indicates the CPU type of the instance. The value can be x86_64 or aarch64.

createdAt String

Indicates the time when the instance is created, in RFC3339 format.

domainName String

Domain name of the instance. Usually, we use domain name and port to connect to the DCS instances.

id String

The provider-assigned unique ID for this managed resource.

launchedAt String

Indicates the time when the instance is started, in RFC3339 format.

maxMemory Number

Total memory size. Unit: MB.

productType String

Indicates the product type of the instance. The value can be: generic or enterprise.

readonlyDomainName String

Indicates the read-only domain name of the instance. This parameter is available only for master/standby instances.

region String

Indicates the region in which DCS instance resource is created.

replicaCount Number

Indicates the number of replicas in the instance.

securityGroupName String

The name of security group which the instance belongs to.

shardingCount Number

Indicates the number of shards in a cluster instance.

status String

Cache instance status. The valid values are as follows:

RUNNING: The instance is running properly. Only instances in the Running state can provide in-memory cache service.
ERROR: The instance is not running properly.
RESTARTING: The instance is being restarted.
FROZEN: The instance has been frozen due to low balance. You can unfreeze the instance by recharging your account in My Order.
EXTENDING: The instance is being scaled up.
RESTORING: The instance data is being restored.
FLUSHING: The DCS instance is being cleared.

subnetCidr String

Indicates the subnet segment.

subnetName String

The name of subnet which the instance belongs to.

transparentClientIpEnable Boolean

Indicates whether client IP pass-through is enabled.

usedMemory Number

Size of the used memory. Unit: MB.

userId String

userName String

vpcName String

The name of VPC which the instance belongs to.

Look up Existing DcsInstanceV2 Resource

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

TypeScript
Python
Go
C#
Java
YAML

public static get(name: string, id: Input<ID>, state?: DcsInstanceV2State, opts?: CustomResourceOptions): DcsInstanceV2

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        access_user: Optional[str] = None,
        availability_zones: Optional[Sequence[str]] = None,
        backup_policy: Optional[DcsInstanceV2BackupPolicyArgs] = None,
        bandwidth_infos: Optional[Sequence[DcsInstanceV2BandwidthInfoArgs]] = None,
        cache_mode: Optional[str] = None,
        capacity: Optional[float] = None,
        cpu_type: Optional[str] = None,
        created_at: Optional[str] = None,
        dcs_instance_v2_id: Optional[str] = None,
        deleted_nodes: Optional[Sequence[str]] = None,
        description: Optional[str] = None,
        domain_name: Optional[str] = None,
        enable_whitelist: Optional[bool] = None,
        engine: Optional[str] = None,
        engine_version: Optional[str] = None,
        flavor: Optional[str] = None,
        launched_at: Optional[str] = None,
        maintain_begin: Optional[str] = None,
        maintain_end: Optional[str] = None,
        max_memory: Optional[float] = None,
        name: Optional[str] = None,
        parameters: Optional[Sequence[DcsInstanceV2ParameterArgs]] = None,
        password: Optional[str] = None,
        port: Optional[float] = None,
        private_ip: Optional[str] = None,
        product_type: Optional[str] = None,
        readonly_domain_name: Optional[str] = None,
        region: Optional[str] = None,
        rename_commands: Optional[Mapping[str, str]] = None,
        replica_count: Optional[float] = None,
        reserved_ips: Optional[Sequence[str]] = None,
        security_group_id: Optional[str] = None,
        security_group_name: Optional[str] = None,
        sharding_count: Optional[float] = None,
        ssl_enable: Optional[bool] = None,
        status: Optional[str] = None,
        subnet_cidr: Optional[str] = None,
        subnet_id: Optional[str] = None,
        subnet_name: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        template_id: Optional[str] = None,
        timeouts: Optional[DcsInstanceV2TimeoutsArgs] = None,
        transparent_client_ip_enable: Optional[bool] = None,
        used_memory: Optional[float] = None,
        user_id: Optional[str] = None,
        user_name: Optional[str] = None,
        vpc_id: Optional[str] = None,
        vpc_name: Optional[str] = None,
        whitelists: Optional[Sequence[DcsInstanceV2WhitelistArgs]] = None) -> DcsInstanceV2

func GetDcsInstanceV2(ctx *Context, name string, id IDInput, state *DcsInstanceV2State, opts ...ResourceOption) (*DcsInstanceV2, error)

public static DcsInstanceV2 Get(string name, Input<string> id, DcsInstanceV2State? state, CustomResourceOptions? opts = null)

public static DcsInstanceV2 get(String name, Output<String> id, DcsInstanceV2State state, CustomResourceOptions options)

resources:  _:    type: opentelekomcloud:DcsInstanceV2    get:      id: ${id}

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

AccessUser string

AvailabilityZones List<string>

BackupPolicy DcsInstanceV2BackupPolicy

Specifies the backup configuration to be used with the instance. The structure is described below.

NOTE: This parameter is not supported when the instance type is single.

BandwidthInfos List<DcsInstanceV2BandwidthInfo>

Indicates the bandwidth information of the instance. The bandwidth_info structure is documented below.

CacheMode string

Indicates the instance type. The value can be single, ha, cluster or proxy.

Capacity double

Specifies the cache capacity. Unit: GB.

CpuType string

Indicates the CPU type of the instance. The value can be x86_64 or aarch64.

CreatedAt string

Indicates the time when the instance is created, in RFC3339 format.

DcsInstanceV2Id string

A resource ID in UUID format.

DeletedNodes List<string>

Description string

Specifies the description of an instance. It is a string that contains a maximum of 1024 characters.

DomainName string

Domain name of the instance. Usually, we use domain name and port to connect to the DCS instances.

EnableWhitelist bool

Enable or disable the IP address whitelists. Defaults to true. If the whitelist is disabled, all IP addresses connected to the VPC can access the instance.

Engine string

Specifies a cache engine. Options: Redis and Memcached. Changing this creates a new instance.

EngineVersion string

Specifies the version of a cache engine. It is mandatory when the engine is Redis, the value can be 3.0, 4.0, 5.0 or 6.0. Changing this creates a new instance.

Flavor string

Query flavors in DCS Instance Specifications
Log in to the DCS console, click Create DCS Instance, and find the corresponding instance specification.

LaunchedAt string

Indicates the time when the instance is started, in RFC3339 format.

MaintainBegin string

Time at which the maintenance time window starts. Defaults to 02:00:00.

The start time and end time of a maintenance time window must indicate the time segment of a supported maintenance time window.
The start time must be on the hour, such as 18:00:00.
If parameter maintain_begin is left blank, parameter maintain_end is also blank. In this case, the system automatically allocates the default start time 02:00:00.

MaintainEnd string

Time at which the maintenance time window ends. Defaults to 06:00:00.

The start time and end time of a maintenance time window must indicate the time segment of a supported maintenance time window.
The end time is one hour later than the start time. For example, if the start time is 18:00:00, the end time is 19:00:00.
If parameter maintain_end is left blank, parameter maintain_begin is also blank. In this case, the system automatically allocates the default end time 06:00:00.

NOTE: Parameters maintain_begin and maintain_end must be set in pairs.

MaxMemory double

Total memory size. Unit: MB.

Name string

Specifies the name of an instance. The name must be 4 to 64 characters and start with a letter. Only chinese, letters (case-insensitive), digits, underscores (_) ,and hyphens (-) are allowed.

Parameters List<DcsInstanceV2Parameter>

Specify an array of one or more parameters to be set to the DCS instance after launched. You can check on console to see which parameters supported. The parameters structure is documented below.

Password string

Specifies the password of a DCS instance. The password of a DCS instance must meet the following complexity requirements:

Must be a string of 8 to 32 bits in length.
Must contain three combinations of the following four characters: Lower case letters, uppercase letter, digital, Special characters include (`~!@#$^&*()-_=+\|{}:,<.>/?).
The new password cannot be the same as the old password.

Port double

Port customization, which is supported only by Redis 4.0 and Redis 5.0 instances. Redis instance defaults to 6379. Memcached instance does not use this argument.

PrivateIp string

ProductType string

Indicates the product type of the instance. The value can be: generic or enterprise.

ReadonlyDomainName string

Indicates the read-only domain name of the instance. This parameter is available only for master/standby instances.

Region string

Indicates the region in which DCS instance resource is created.

RenameCommands Dictionary<string, string>

ReplicaCount double

Indicates the number of replicas in the instance.

ReservedIps List<string>

Specifies IP addresses to retain. Mandatory during cluster scale-in. If this parameter is not set, the system randomly deletes unnecessary shards.

SecurityGroupId string

The ID of the security group which the instance belongs to. This parameter is mandatory for Memcached and Redis 3.0 version.

SecurityGroupName string

The name of security group which the instance belongs to.

ShardingCount double

Indicates the number of shards in a cluster instance.

SslEnable bool

Specifies whether to enable the SSL. Value options: true, false.

Status string

Cache instance status. The valid values are as follows:

RUNNING: The instance is running properly. Only instances in the Running state can provide in-memory cache service.
ERROR: The instance is not running properly.
RESTARTING: The instance is being restarted.
FROZEN: The instance has been frozen due to low balance. You can unfreeze the instance by recharging your account in My Order.
EXTENDING: The instance is being scaled up.
RESTORING: The instance data is being restored.
FLUSHING: The DCS instance is being cleared.

SubnetCidr string

Indicates the subnet segment.

SubnetId string

The ID of subnet which the instance belongs to. Changing this creates a new instance resource.

SubnetName string

The name of subnet which the instance belongs to.

Tags Dictionary<string, string>

The key/value pairs to associate with the dcs instance.

TemplateId string

The Parameter Template ID. Changing this creates a new instance resource.

Timeouts DcsInstanceV2Timeouts

TransparentClientIpEnable bool

Indicates whether client IP pass-through is enabled.

UsedMemory double

Size of the used memory. Unit: MB.

UserId string

UserName string

VpcId string

The ID of VPC which the instance belongs to. Changing this creates a new instance resource.

VpcName string

The name of VPC which the instance belongs to.

Whitelists List<DcsInstanceV2Whitelist>

Specifies the IP addresses which can access the instance. This parameter is valid for Redis 4.0 and 5.0 versions. The structure is described below.

AccessUser string

AvailabilityZones []string

BackupPolicy DcsInstanceV2BackupPolicyArgs

Specifies the backup configuration to be used with the instance. The structure is described below.

NOTE: This parameter is not supported when the instance type is single.

BandwidthInfos []DcsInstanceV2BandwidthInfoArgs

Indicates the bandwidth information of the instance. The bandwidth_info structure is documented below.

CacheMode string

Indicates the instance type. The value can be single, ha, cluster or proxy.

Capacity float64

Specifies the cache capacity. Unit: GB.

CpuType string

Indicates the CPU type of the instance. The value can be x86_64 or aarch64.

CreatedAt string

Indicates the time when the instance is created, in RFC3339 format.

DcsInstanceV2Id string

A resource ID in UUID format.

DeletedNodes []string

Description string

Specifies the description of an instance. It is a string that contains a maximum of 1024 characters.

DomainName string

Domain name of the instance. Usually, we use domain name and port to connect to the DCS instances.

EnableWhitelist bool

Enable or disable the IP address whitelists. Defaults to true. If the whitelist is disabled, all IP addresses connected to the VPC can access the instance.

Engine string

Specifies a cache engine. Options: Redis and Memcached. Changing this creates a new instance.

EngineVersion string

Specifies the version of a cache engine. It is mandatory when the engine is Redis, the value can be 3.0, 4.0, 5.0 or 6.0. Changing this creates a new instance.

Flavor string

Query flavors in DCS Instance Specifications
Log in to the DCS console, click Create DCS Instance, and find the corresponding instance specification.

LaunchedAt string

Indicates the time when the instance is started, in RFC3339 format.

MaintainBegin string

Time at which the maintenance time window starts. Defaults to 02:00:00.

The start time and end time of a maintenance time window must indicate the time segment of a supported maintenance time window.
The start time must be on the hour, such as 18:00:00.
If parameter maintain_begin is left blank, parameter maintain_end is also blank. In this case, the system automatically allocates the default start time 02:00:00.

MaintainEnd string

Time at which the maintenance time window ends. Defaults to 06:00:00.

The start time and end time of a maintenance time window must indicate the time segment of a supported maintenance time window.
The end time is one hour later than the start time. For example, if the start time is 18:00:00, the end time is 19:00:00.
If parameter maintain_end is left blank, parameter maintain_begin is also blank. In this case, the system automatically allocates the default end time 06:00:00.

NOTE: Parameters maintain_begin and maintain_end must be set in pairs.

MaxMemory float64

Total memory size. Unit: MB.

Name string

Specifies the name of an instance. The name must be 4 to 64 characters and start with a letter. Only chinese, letters (case-insensitive), digits, underscores (_) ,and hyphens (-) are allowed.

Parameters []DcsInstanceV2ParameterArgs

Specify an array of one or more parameters to be set to the DCS instance after launched. You can check on console to see which parameters supported. The parameters structure is documented below.

Password string

Specifies the password of a DCS instance. The password of a DCS instance must meet the following complexity requirements:

Must be a string of 8 to 32 bits in length.
Must contain three combinations of the following four characters: Lower case letters, uppercase letter, digital, Special characters include (`~!@#$^&*()-_=+\|{}:,<.>/?).
The new password cannot be the same as the old password.

Port float64

Port customization, which is supported only by Redis 4.0 and Redis 5.0 instances. Redis instance defaults to 6379. Memcached instance does not use this argument.

PrivateIp string

ProductType string

Indicates the product type of the instance. The value can be: generic or enterprise.

ReadonlyDomainName string

Indicates the read-only domain name of the instance. This parameter is available only for master/standby instances.

Region string

Indicates the region in which DCS instance resource is created.

RenameCommands map[string]string

ReplicaCount float64

Indicates the number of replicas in the instance.

ReservedIps []string

Specifies IP addresses to retain. Mandatory during cluster scale-in. If this parameter is not set, the system randomly deletes unnecessary shards.

SecurityGroupId string

The ID of the security group which the instance belongs to. This parameter is mandatory for Memcached and Redis 3.0 version.

SecurityGroupName string

The name of security group which the instance belongs to.

ShardingCount float64

Indicates the number of shards in a cluster instance.

SslEnable bool

Specifies whether to enable the SSL. Value options: true, false.

Status string

Cache instance status. The valid values are as follows:

RUNNING: The instance is running properly. Only instances in the Running state can provide in-memory cache service.
ERROR: The instance is not running properly.
RESTARTING: The instance is being restarted.
FROZEN: The instance has been frozen due to low balance. You can unfreeze the instance by recharging your account in My Order.
EXTENDING: The instance is being scaled up.
RESTORING: The instance data is being restored.
FLUSHING: The DCS instance is being cleared.

SubnetCidr string

Indicates the subnet segment.

SubnetId string

The ID of subnet which the instance belongs to. Changing this creates a new instance resource.

SubnetName string

The name of subnet which the instance belongs to.

Tags map[string]string

The key/value pairs to associate with the dcs instance.

TemplateId string

The Parameter Template ID. Changing this creates a new instance resource.

Timeouts DcsInstanceV2TimeoutsArgs

TransparentClientIpEnable bool

Indicates whether client IP pass-through is enabled.

UsedMemory float64

Size of the used memory. Unit: MB.

UserId string

UserName string

VpcId string

The ID of VPC which the instance belongs to. Changing this creates a new instance resource.

VpcName string

The name of VPC which the instance belongs to.

Whitelists []DcsInstanceV2WhitelistArgs

Specifies the IP addresses which can access the instance. This parameter is valid for Redis 4.0 and 5.0 versions. The structure is described below.

accessUser String

availabilityZones List<String>

backupPolicy DcsInstanceV2BackupPolicy

Specifies the backup configuration to be used with the instance. The structure is described below.

NOTE: This parameter is not supported when the instance type is single.

bandwidthInfos List<DcsInstanceV2BandwidthInfo>

Indicates the bandwidth information of the instance. The bandwidth_info structure is documented below.

cacheMode String

Indicates the instance type. The value can be single, ha, cluster or proxy.

capacity Double

Specifies the cache capacity. Unit: GB.

cpuType String

Indicates the CPU type of the instance. The value can be x86_64 or aarch64.

createdAt String

Indicates the time when the instance is created, in RFC3339 format.

dcsInstanceV2Id String

A resource ID in UUID format.

deletedNodes List<String>

description String

Specifies the description of an instance. It is a string that contains a maximum of 1024 characters.

domainName String

Domain name of the instance. Usually, we use domain name and port to connect to the DCS instances.

enableWhitelist Boolean

Enable or disable the IP address whitelists. Defaults to true. If the whitelist is disabled, all IP addresses connected to the VPC can access the instance.

engine String

Specifies a cache engine. Options: Redis and Memcached. Changing this creates a new instance.

engineVersion String

Specifies the version of a cache engine. It is mandatory when the engine is Redis, the value can be 3.0, 4.0, 5.0 or 6.0. Changing this creates a new instance.

flavor String

Query flavors in DCS Instance Specifications
Log in to the DCS console, click Create DCS Instance, and find the corresponding instance specification.

launchedAt String

Indicates the time when the instance is started, in RFC3339 format.

maintainBegin String

Time at which the maintenance time window starts. Defaults to 02:00:00.

The start time and end time of a maintenance time window must indicate the time segment of a supported maintenance time window.
The start time must be on the hour, such as 18:00:00.
If parameter maintain_begin is left blank, parameter maintain_end is also blank. In this case, the system automatically allocates the default start time 02:00:00.

maintainEnd String

Time at which the maintenance time window ends. Defaults to 06:00:00.

The start time and end time of a maintenance time window must indicate the time segment of a supported maintenance time window.
The end time is one hour later than the start time. For example, if the start time is 18:00:00, the end time is 19:00:00.
If parameter maintain_end is left blank, parameter maintain_begin is also blank. In this case, the system automatically allocates the default end time 06:00:00.

NOTE: Parameters maintain_begin and maintain_end must be set in pairs.

maxMemory Double

Total memory size. Unit: MB.

name String

Specifies the name of an instance. The name must be 4 to 64 characters and start with a letter. Only chinese, letters (case-insensitive), digits, underscores (_) ,and hyphens (-) are allowed.

parameters List<DcsInstanceV2Parameter>

Specify an array of one or more parameters to be set to the DCS instance after launched. You can check on console to see which parameters supported. The parameters structure is documented below.

password String

Specifies the password of a DCS instance. The password of a DCS instance must meet the following complexity requirements:

Must be a string of 8 to 32 bits in length.
Must contain three combinations of the following four characters: Lower case letters, uppercase letter, digital, Special characters include (`~!@#$^&*()-_=+\|{}:,<.>/?).
The new password cannot be the same as the old password.

port Double

Port customization, which is supported only by Redis 4.0 and Redis 5.0 instances. Redis instance defaults to 6379. Memcached instance does not use this argument.

privateIp String

productType String

Indicates the product type of the instance. The value can be: generic or enterprise.

readonlyDomainName String

Indicates the read-only domain name of the instance. This parameter is available only for master/standby instances.

region String

Indicates the region in which DCS instance resource is created.

renameCommands Map<String,String>

replicaCount Double

Indicates the number of replicas in the instance.

reservedIps List<String>

Specifies IP addresses to retain. Mandatory during cluster scale-in. If this parameter is not set, the system randomly deletes unnecessary shards.

securityGroupId String

The ID of the security group which the instance belongs to. This parameter is mandatory for Memcached and Redis 3.0 version.

securityGroupName String

The name of security group which the instance belongs to.

shardingCount Double

Indicates the number of shards in a cluster instance.

sslEnable Boolean

Specifies whether to enable the SSL. Value options: true, false.

status String

Cache instance status. The valid values are as follows:

RUNNING: The instance is running properly. Only instances in the Running state can provide in-memory cache service.
ERROR: The instance is not running properly.
RESTARTING: The instance is being restarted.
FROZEN: The instance has been frozen due to low balance. You can unfreeze the instance by recharging your account in My Order.
EXTENDING: The instance is being scaled up.
RESTORING: The instance data is being restored.
FLUSHING: The DCS instance is being cleared.

subnetCidr String

Indicates the subnet segment.

subnetId String

The ID of subnet which the instance belongs to. Changing this creates a new instance resource.

subnetName String

The name of subnet which the instance belongs to.

tags Map<String,String>

The key/value pairs to associate with the dcs instance.

templateId String

The Parameter Template ID. Changing this creates a new instance resource.

timeouts DcsInstanceV2Timeouts

transparentClientIpEnable Boolean

Indicates whether client IP pass-through is enabled.

usedMemory Double

Size of the used memory. Unit: MB.

userId String

userName String

vpcId String

The ID of VPC which the instance belongs to. Changing this creates a new instance resource.

vpcName String

The name of VPC which the instance belongs to.

whitelists List<DcsInstanceV2Whitelist>

Specifies the IP addresses which can access the instance. This parameter is valid for Redis 4.0 and 5.0 versions. The structure is described below.

accessUser string

availabilityZones string[]

backupPolicy DcsInstanceV2BackupPolicy

Specifies the backup configuration to be used with the instance. The structure is described below.

NOTE: This parameter is not supported when the instance type is single.

bandwidthInfos DcsInstanceV2BandwidthInfo[]

Indicates the bandwidth information of the instance. The bandwidth_info structure is documented below.

cacheMode string

Indicates the instance type. The value can be single, ha, cluster or proxy.

capacity number

Specifies the cache capacity. Unit: GB.

cpuType string

Indicates the CPU type of the instance. The value can be x86_64 or aarch64.

createdAt string

Indicates the time when the instance is created, in RFC3339 format.

dcsInstanceV2Id string

A resource ID in UUID format.

deletedNodes string[]

description string

Specifies the description of an instance. It is a string that contains a maximum of 1024 characters.

domainName string

Domain name of the instance. Usually, we use domain name and port to connect to the DCS instances.

enableWhitelist boolean

Enable or disable the IP address whitelists. Defaults to true. If the whitelist is disabled, all IP addresses connected to the VPC can access the instance.

engine string

Specifies a cache engine. Options: Redis and Memcached. Changing this creates a new instance.

engineVersion string

Specifies the version of a cache engine. It is mandatory when the engine is Redis, the value can be 3.0, 4.0, 5.0 or 6.0. Changing this creates a new instance.

flavor string

Query flavors in DCS Instance Specifications
Log in to the DCS console, click Create DCS Instance, and find the corresponding instance specification.

launchedAt string

Indicates the time when the instance is started, in RFC3339 format.

maintainBegin string

Time at which the maintenance time window starts. Defaults to 02:00:00.

The start time and end time of a maintenance time window must indicate the time segment of a supported maintenance time window.
The start time must be on the hour, such as 18:00:00.
If parameter maintain_begin is left blank, parameter maintain_end is also blank. In this case, the system automatically allocates the default start time 02:00:00.

maintainEnd string

Time at which the maintenance time window ends. Defaults to 06:00:00.

The start time and end time of a maintenance time window must indicate the time segment of a supported maintenance time window.
The end time is one hour later than the start time. For example, if the start time is 18:00:00, the end time is 19:00:00.
If parameter maintain_end is left blank, parameter maintain_begin is also blank. In this case, the system automatically allocates the default end time 06:00:00.

NOTE: Parameters maintain_begin and maintain_end must be set in pairs.

maxMemory number

Total memory size. Unit: MB.

name string

Specifies the name of an instance. The name must be 4 to 64 characters and start with a letter. Only chinese, letters (case-insensitive), digits, underscores (_) ,and hyphens (-) are allowed.

parameters DcsInstanceV2Parameter[]

Specify an array of one or more parameters to be set to the DCS instance after launched. You can check on console to see which parameters supported. The parameters structure is documented below.

password string

Specifies the password of a DCS instance. The password of a DCS instance must meet the following complexity requirements:

Must be a string of 8 to 32 bits in length.
Must contain three combinations of the following four characters: Lower case letters, uppercase letter, digital, Special characters include (`~!@#$^&*()-_=+\|{}:,<.>/?).
The new password cannot be the same as the old password.

port number

Port customization, which is supported only by Redis 4.0 and Redis 5.0 instances. Redis instance defaults to 6379. Memcached instance does not use this argument.

privateIp string

productType string

Indicates the product type of the instance. The value can be: generic or enterprise.

readonlyDomainName string

Indicates the read-only domain name of the instance. This parameter is available only for master/standby instances.

region string

Indicates the region in which DCS instance resource is created.

renameCommands {[key: string]: string}

replicaCount number

Indicates the number of replicas in the instance.

reservedIps string[]

Specifies IP addresses to retain. Mandatory during cluster scale-in. If this parameter is not set, the system randomly deletes unnecessary shards.

securityGroupId string

The ID of the security group which the instance belongs to. This parameter is mandatory for Memcached and Redis 3.0 version.

securityGroupName string

The name of security group which the instance belongs to.

shardingCount number

Indicates the number of shards in a cluster instance.

sslEnable boolean

Specifies whether to enable the SSL. Value options: true, false.

status string

Cache instance status. The valid values are as follows:

RUNNING: The instance is running properly. Only instances in the Running state can provide in-memory cache service.
ERROR: The instance is not running properly.
RESTARTING: The instance is being restarted.
FROZEN: The instance has been frozen due to low balance. You can unfreeze the instance by recharging your account in My Order.
EXTENDING: The instance is being scaled up.
RESTORING: The instance data is being restored.
FLUSHING: The DCS instance is being cleared.

subnetCidr string

Indicates the subnet segment.

subnetId string

The ID of subnet which the instance belongs to. Changing this creates a new instance resource.

subnetName string

The name of subnet which the instance belongs to.

tags {[key: string]: string}

The key/value pairs to associate with the dcs instance.

templateId string

The Parameter Template ID. Changing this creates a new instance resource.

timeouts DcsInstanceV2Timeouts

transparentClientIpEnable boolean

Indicates whether client IP pass-through is enabled.

usedMemory number

Size of the used memory. Unit: MB.

userId string

userName string

vpcId string

The ID of VPC which the instance belongs to. Changing this creates a new instance resource.

vpcName string

The name of VPC which the instance belongs to.

whitelists DcsInstanceV2Whitelist[]

Specifies the IP addresses which can access the instance. This parameter is valid for Redis 4.0 and 5.0 versions. The structure is described below.

access_user str

availability_zones Sequence[str]

backup_policy DcsInstanceV2BackupPolicyArgs

Specifies the backup configuration to be used with the instance. The structure is described below.

NOTE: This parameter is not supported when the instance type is single.

bandwidth_infos Sequence[DcsInstanceV2BandwidthInfoArgs]

Indicates the bandwidth information of the instance. The bandwidth_info structure is documented below.

cache_mode str

Indicates the instance type. The value can be single, ha, cluster or proxy.

capacity float

Specifies the cache capacity. Unit: GB.

cpu_type str

Indicates the CPU type of the instance. The value can be x86_64 or aarch64.

created_at str

Indicates the time when the instance is created, in RFC3339 format.

dcs_instance_v2_id str

A resource ID in UUID format.

deleted_nodes Sequence[str]

description str

Specifies the description of an instance. It is a string that contains a maximum of 1024 characters.

domain_name str

Domain name of the instance. Usually, we use domain name and port to connect to the DCS instances.

enable_whitelist bool

Enable or disable the IP address whitelists. Defaults to true. If the whitelist is disabled, all IP addresses connected to the VPC can access the instance.

engine str

Specifies a cache engine. Options: Redis and Memcached. Changing this creates a new instance.

engine_version str

Specifies the version of a cache engine. It is mandatory when the engine is Redis, the value can be 3.0, 4.0, 5.0 or 6.0. Changing this creates a new instance.

flavor str

Query flavors in DCS Instance Specifications
Log in to the DCS console, click Create DCS Instance, and find the corresponding instance specification.

launched_at str

Indicates the time when the instance is started, in RFC3339 format.

maintain_begin str

Time at which the maintenance time window starts. Defaults to 02:00:00.

The start time and end time of a maintenance time window must indicate the time segment of a supported maintenance time window.
The start time must be on the hour, such as 18:00:00.
If parameter maintain_begin is left blank, parameter maintain_end is also blank. In this case, the system automatically allocates the default start time 02:00:00.

maintain_end str

Time at which the maintenance time window ends. Defaults to 06:00:00.

The start time and end time of a maintenance time window must indicate the time segment of a supported maintenance time window.
The end time is one hour later than the start time. For example, if the start time is 18:00:00, the end time is 19:00:00.
If parameter maintain_end is left blank, parameter maintain_begin is also blank. In this case, the system automatically allocates the default end time 06:00:00.

NOTE: Parameters maintain_begin and maintain_end must be set in pairs.

max_memory float

Total memory size. Unit: MB.

name str

Specifies the name of an instance. The name must be 4 to 64 characters and start with a letter. Only chinese, letters (case-insensitive), digits, underscores (_) ,and hyphens (-) are allowed.

parameters Sequence[DcsInstanceV2ParameterArgs]

Specify an array of one or more parameters to be set to the DCS instance after launched. You can check on console to see which parameters supported. The parameters structure is documented below.

password str

Specifies the password of a DCS instance. The password of a DCS instance must meet the following complexity requirements:

Must be a string of 8 to 32 bits in length.
Must contain three combinations of the following four characters: Lower case letters, uppercase letter, digital, Special characters include (`~!@#$^&*()-_=+\|{}:,<.>/?).
The new password cannot be the same as the old password.

port float

Port customization, which is supported only by Redis 4.0 and Redis 5.0 instances. Redis instance defaults to 6379. Memcached instance does not use this argument.

private_ip str

product_type str

Indicates the product type of the instance. The value can be: generic or enterprise.

readonly_domain_name str

Indicates the read-only domain name of the instance. This parameter is available only for master/standby instances.

region str

Indicates the region in which DCS instance resource is created.

rename_commands Mapping[str, str]

replica_count float

Indicates the number of replicas in the instance.

reserved_ips Sequence[str]

Specifies IP addresses to retain. Mandatory during cluster scale-in. If this parameter is not set, the system randomly deletes unnecessary shards.

security_group_id str

The ID of the security group which the instance belongs to. This parameter is mandatory for Memcached and Redis 3.0 version.

security_group_name str

The name of security group which the instance belongs to.

sharding_count float

Indicates the number of shards in a cluster instance.

ssl_enable bool

Specifies whether to enable the SSL. Value options: true, false.

status str

Cache instance status. The valid values are as follows:

RUNNING: The instance is running properly. Only instances in the Running state can provide in-memory cache service.
ERROR: The instance is not running properly.
RESTARTING: The instance is being restarted.
FROZEN: The instance has been frozen due to low balance. You can unfreeze the instance by recharging your account in My Order.
EXTENDING: The instance is being scaled up.
RESTORING: The instance data is being restored.
FLUSHING: The DCS instance is being cleared.

subnet_cidr str

Indicates the subnet segment.

subnet_id str

The ID of subnet which the instance belongs to. Changing this creates a new instance resource.

subnet_name str

The name of subnet which the instance belongs to.

tags Mapping[str, str]

The key/value pairs to associate with the dcs instance.

template_id str

The Parameter Template ID. Changing this creates a new instance resource.

timeouts DcsInstanceV2TimeoutsArgs

transparent_client_ip_enable bool

Indicates whether client IP pass-through is enabled.

used_memory float

Size of the used memory. Unit: MB.

user_id str

user_name str

vpc_id str

The ID of VPC which the instance belongs to. Changing this creates a new instance resource.

vpc_name str

The name of VPC which the instance belongs to.

whitelists Sequence[DcsInstanceV2WhitelistArgs]

Specifies the IP addresses which can access the instance. This parameter is valid for Redis 4.0 and 5.0 versions. The structure is described below.

accessUser String

availabilityZones List<String>

backupPolicy Property Map

Specifies the backup configuration to be used with the instance. The structure is described below.

NOTE: This parameter is not supported when the instance type is single.

bandwidthInfos List<Property Map>

Indicates the bandwidth information of the instance. The bandwidth_info structure is documented below.

cacheMode String

Indicates the instance type. The value can be single, ha, cluster or proxy.

capacity Number

Specifies the cache capacity. Unit: GB.

cpuType String

Indicates the CPU type of the instance. The value can be x86_64 or aarch64.

createdAt String

Indicates the time when the instance is created, in RFC3339 format.

dcsInstanceV2Id String

A resource ID in UUID format.

deletedNodes List<String>

description String

Specifies the description of an instance. It is a string that contains a maximum of 1024 characters.

domainName String

Domain name of the instance. Usually, we use domain name and port to connect to the DCS instances.

enableWhitelist Boolean

Enable or disable the IP address whitelists. Defaults to true. If the whitelist is disabled, all IP addresses connected to the VPC can access the instance.

engine String

Specifies a cache engine. Options: Redis and Memcached. Changing this creates a new instance.

engineVersion String

Specifies the version of a cache engine. It is mandatory when the engine is Redis, the value can be 3.0, 4.0, 5.0 or 6.0. Changing this creates a new instance.

flavor String

Query flavors in DCS Instance Specifications
Log in to the DCS console, click Create DCS Instance, and find the corresponding instance specification.

launchedAt String

Indicates the time when the instance is started, in RFC3339 format.

maintainBegin String

Time at which the maintenance time window starts. Defaults to 02:00:00.

The start time and end time of a maintenance time window must indicate the time segment of a supported maintenance time window.
The start time must be on the hour, such as 18:00:00.
If parameter maintain_begin is left blank, parameter maintain_end is also blank. In this case, the system automatically allocates the default start time 02:00:00.

maintainEnd String

Time at which the maintenance time window ends. Defaults to 06:00:00.

The start time and end time of a maintenance time window must indicate the time segment of a supported maintenance time window.
The end time is one hour later than the start time. For example, if the start time is 18:00:00, the end time is 19:00:00.
If parameter maintain_end is left blank, parameter maintain_begin is also blank. In this case, the system automatically allocates the default end time 06:00:00.

NOTE: Parameters maintain_begin and maintain_end must be set in pairs.

maxMemory Number

Total memory size. Unit: MB.

name String

Specifies the name of an instance. The name must be 4 to 64 characters and start with a letter. Only chinese, letters (case-insensitive), digits, underscores (_) ,and hyphens (-) are allowed.

parameters List<Property Map>

Specify an array of one or more parameters to be set to the DCS instance after launched. You can check on console to see which parameters supported. The parameters structure is documented below.

password String

Specifies the password of a DCS instance. The password of a DCS instance must meet the following complexity requirements:

Must be a string of 8 to 32 bits in length.
Must contain three combinations of the following four characters: Lower case letters, uppercase letter, digital, Special characters include (`~!@#$^&*()-_=+\|{}:,<.>/?).
The new password cannot be the same as the old password.

port Number

Port customization, which is supported only by Redis 4.0 and Redis 5.0 instances. Redis instance defaults to 6379. Memcached instance does not use this argument.

privateIp String

productType String

Indicates the product type of the instance. The value can be: generic or enterprise.

readonlyDomainName String

Indicates the read-only domain name of the instance. This parameter is available only for master/standby instances.

region String

Indicates the region in which DCS instance resource is created.

renameCommands Map<String>

replicaCount Number

Indicates the number of replicas in the instance.

reservedIps List<String>

Specifies IP addresses to retain. Mandatory during cluster scale-in. If this parameter is not set, the system randomly deletes unnecessary shards.

securityGroupId String

The ID of the security group which the instance belongs to. This parameter is mandatory for Memcached and Redis 3.0 version.

securityGroupName String

The name of security group which the instance belongs to.

shardingCount Number

Indicates the number of shards in a cluster instance.

sslEnable Boolean

Specifies whether to enable the SSL. Value options: true, false.

status String

Cache instance status. The valid values are as follows:

RUNNING: The instance is running properly. Only instances in the Running state can provide in-memory cache service.
ERROR: The instance is not running properly.
RESTARTING: The instance is being restarted.
FROZEN: The instance has been frozen due to low balance. You can unfreeze the instance by recharging your account in My Order.
EXTENDING: The instance is being scaled up.
RESTORING: The instance data is being restored.
FLUSHING: The DCS instance is being cleared.

subnetCidr String

Indicates the subnet segment.

subnetId String

The ID of subnet which the instance belongs to. Changing this creates a new instance resource.

subnetName String

The name of subnet which the instance belongs to.

tags Map<String>

The key/value pairs to associate with the dcs instance.

templateId String

The Parameter Template ID. Changing this creates a new instance resource.

timeouts Property Map

transparentClientIpEnable Boolean

Indicates whether client IP pass-through is enabled.

usedMemory Number

Size of the used memory. Unit: MB.

userId String

userName String

vpcId String

The ID of VPC which the instance belongs to. Changing this creates a new instance resource.

vpcName String

The name of VPC which the instance belongs to.

whitelists List<Property Map>

Specifies the IP addresses which can access the instance. This parameter is valid for Redis 4.0 and 5.0 versions. The structure is described below.

Supporting Types

DcsInstanceV2BackupPolicy
, DcsInstanceV2BackupPolicyArgs

BackupAts List<double>

Day in a week on which backup starts, the value ranges from 1 to 7. Where: 1 indicates Monday; 7 indicates Sunday.

BeginAt string

Time at which backup starts. Format: hh24:00-hh24:00, "00:00-01:00" indicates that backup starts at 00:00:00.

The parameters block supports:

BackupType string

Backup type. Default value is auto. The valid values are as follows:

PeriodType string

Interval at which backup is performed. Default value is weekly. Currently, only weekly backup is supported.

SaveDays double

Retention time. Unit: day, the value ranges from 1 to 7. This parameter is required if the backup_type is auto.

BackupAts []float64

Day in a week on which backup starts, the value ranges from 1 to 7. Where: 1 indicates Monday; 7 indicates Sunday.

BeginAt string

Time at which backup starts. Format: hh24:00-hh24:00, "00:00-01:00" indicates that backup starts at 00:00:00.

The parameters block supports:

BackupType string

Backup type. Default value is auto. The valid values are as follows:

PeriodType string

Interval at which backup is performed. Default value is weekly. Currently, only weekly backup is supported.

SaveDays float64

Retention time. Unit: day, the value ranges from 1 to 7. This parameter is required if the backup_type is auto.

backupAts List<Double>

Day in a week on which backup starts, the value ranges from 1 to 7. Where: 1 indicates Monday; 7 indicates Sunday.

beginAt String

Time at which backup starts. Format: hh24:00-hh24:00, "00:00-01:00" indicates that backup starts at 00:00:00.

The parameters block supports:

backupType String

Backup type. Default value is auto. The valid values are as follows:

periodType String

Interval at which backup is performed. Default value is weekly. Currently, only weekly backup is supported.

saveDays Double

Retention time. Unit: day, the value ranges from 1 to 7. This parameter is required if the backup_type is auto.

backupAts number[]

Day in a week on which backup starts, the value ranges from 1 to 7. Where: 1 indicates Monday; 7 indicates Sunday.

beginAt string

Time at which backup starts. Format: hh24:00-hh24:00, "00:00-01:00" indicates that backup starts at 00:00:00.

The parameters block supports:

backupType string

Backup type. Default value is auto. The valid values are as follows:

periodType string

Interval at which backup is performed. Default value is weekly. Currently, only weekly backup is supported.

saveDays number

Retention time. Unit: day, the value ranges from 1 to 7. This parameter is required if the backup_type is auto.

backup_ats Sequence[float]

Day in a week on which backup starts, the value ranges from 1 to 7. Where: 1 indicates Monday; 7 indicates Sunday.

begin_at str

Time at which backup starts. Format: hh24:00-hh24:00, "00:00-01:00" indicates that backup starts at 00:00:00.

The parameters block supports:

backup_type str

Backup type. Default value is auto. The valid values are as follows:

period_type str

Interval at which backup is performed. Default value is weekly. Currently, only weekly backup is supported.

save_days float

Retention time. Unit: day, the value ranges from 1 to 7. This parameter is required if the backup_type is auto.

backupAts List<Number>

Day in a week on which backup starts, the value ranges from 1 to 7. Where: 1 indicates Monday; 7 indicates Sunday.

beginAt String

Time at which backup starts. Format: hh24:00-hh24:00, "00:00-01:00" indicates that backup starts at 00:00:00.

The parameters block supports:

backupType String

Backup type. Default value is auto. The valid values are as follows:

periodType String

Interval at which backup is performed. Default value is weekly. Currently, only weekly backup is supported.

saveDays Number

Retention time. Unit: day, the value ranges from 1 to 7. This parameter is required if the backup_type is auto.

DcsInstanceV2BandwidthInfo
, DcsInstanceV2BandwidthInfoArgs

Bandwidth double: Indicates the bandwidth size, the unit is GB.
BeginTime string: Indicates the begin time of temporary increase.
CurrentTime string: Indicates the current time.
EndTime string: Indicates the end time of temporary increase.
ExpandCount double: Indicates the number of increases.
ExpandEffectTime double: Indicates the interval between temporary increases, the unit is ms.
ExpandIntervalTime double: Indicates the time interval to the next increase, the unit is ms.
MaxExpandCount double: Indicates the maximum number of increases.
NextExpandTime string: Indicates the next increase time.
TaskRunning bool: Indicates whether the increase task is running.

Bandwidth float64: Indicates the bandwidth size, the unit is GB.
BeginTime string: Indicates the begin time of temporary increase.
CurrentTime string: Indicates the current time.
EndTime string: Indicates the end time of temporary increase.
ExpandCount float64: Indicates the number of increases.
ExpandEffectTime float64: Indicates the interval between temporary increases, the unit is ms.
ExpandIntervalTime float64: Indicates the time interval to the next increase, the unit is ms.
MaxExpandCount float64: Indicates the maximum number of increases.
NextExpandTime string: Indicates the next increase time.
TaskRunning bool: Indicates whether the increase task is running.

bandwidth Double: Indicates the bandwidth size, the unit is GB.
beginTime String: Indicates the begin time of temporary increase.
currentTime String: Indicates the current time.
endTime String: Indicates the end time of temporary increase.
expandCount Double: Indicates the number of increases.
expandEffectTime Double: Indicates the interval between temporary increases, the unit is ms.
expandIntervalTime Double: Indicates the time interval to the next increase, the unit is ms.
maxExpandCount Double: Indicates the maximum number of increases.
nextExpandTime String: Indicates the next increase time.
taskRunning Boolean: Indicates whether the increase task is running.

bandwidth number: Indicates the bandwidth size, the unit is GB.
beginTime string: Indicates the begin time of temporary increase.
currentTime string: Indicates the current time.
endTime string: Indicates the end time of temporary increase.
expandCount number: Indicates the number of increases.
expandEffectTime number: Indicates the interval between temporary increases, the unit is ms.
expandIntervalTime number: Indicates the time interval to the next increase, the unit is ms.
maxExpandCount number: Indicates the maximum number of increases.
nextExpandTime string: Indicates the next increase time.
taskRunning boolean: Indicates whether the increase task is running.

bandwidth float: Indicates the bandwidth size, the unit is GB.
begin_time str: Indicates the begin time of temporary increase.
current_time str: Indicates the current time.
end_time str: Indicates the end time of temporary increase.
expand_count float: Indicates the number of increases.
expand_effect_time float: Indicates the interval between temporary increases, the unit is ms.
expand_interval_time float: Indicates the time interval to the next increase, the unit is ms.
max_expand_count float: Indicates the maximum number of increases.
next_expand_time str: Indicates the next increase time.
task_running bool: Indicates whether the increase task is running.

bandwidth Number: Indicates the bandwidth size, the unit is GB.
beginTime String: Indicates the begin time of temporary increase.
currentTime String: Indicates the current time.
endTime String: Indicates the end time of temporary increase.
expandCount Number: Indicates the number of increases.
expandEffectTime Number: Indicates the interval between temporary increases, the unit is ms.
expandIntervalTime Number: Indicates the time interval to the next increase, the unit is ms.
maxExpandCount Number: Indicates the maximum number of increases.
nextExpandTime String: Indicates the next increase time.
taskRunning Boolean: Indicates whether the increase task is running.

DcsInstanceV2Parameter
, DcsInstanceV2ParameterArgs

Id string: A resource ID in UUID format.
Name string: Specifies the name of an instance. The name must be 4 to 64 characters and start with a letter. Only chinese, letters (case-insensitive), digits, underscores (_) ,and hyphens (-) are allowed.
Value string: Specifies the value of the configuration item.

Id string: A resource ID in UUID format.
Name string: Specifies the name of an instance. The name must be 4 to 64 characters and start with a letter. Only chinese, letters (case-insensitive), digits, underscores (_) ,and hyphens (-) are allowed.
Value string: Specifies the value of the configuration item.

id String: A resource ID in UUID format.
name String: Specifies the name of an instance. The name must be 4 to 64 characters and start with a letter. Only chinese, letters (case-insensitive), digits, underscores (_) ,and hyphens (-) are allowed.
value String: Specifies the value of the configuration item.

id string: A resource ID in UUID format.
name string: Specifies the name of an instance. The name must be 4 to 64 characters and start with a letter. Only chinese, letters (case-insensitive), digits, underscores (_) ,and hyphens (-) are allowed.
value string: Specifies the value of the configuration item.

id str: A resource ID in UUID format.
name str: Specifies the name of an instance. The name must be 4 to 64 characters and start with a letter. Only chinese, letters (case-insensitive), digits, underscores (_) ,and hyphens (-) are allowed.
value str: Specifies the value of the configuration item.

id String: A resource ID in UUID format.
name String: Specifies the name of an instance. The name must be 4 to 64 characters and start with a letter. Only chinese, letters (case-insensitive), digits, underscores (_) ,and hyphens (-) are allowed.
value String: Specifies the value of the configuration item.

DcsInstanceV2Timeouts
, DcsInstanceV2TimeoutsArgs

Create string
Delete string
Update string

Create string
Delete string
Update string

create String
delete String
update String

create string
delete string
update string

create str
delete str
update str

create String
delete String
update String

DcsInstanceV2Whitelist
, DcsInstanceV2WhitelistArgs

GroupName string: Specifies the name of IP address group.
IpLists List<string>: Specifies the list of IP address or CIDR which can be whitelisted for an instance. The maximum is 20.

GroupName string: Specifies the name of IP address group.
IpLists []string: Specifies the list of IP address or CIDR which can be whitelisted for an instance. The maximum is 20.

groupName String: Specifies the name of IP address group.
ipLists List<String>: Specifies the list of IP address or CIDR which can be whitelisted for an instance. The maximum is 20.

groupName string: Specifies the name of IP address group.
ipLists string[]: Specifies the list of IP address or CIDR which can be whitelisted for an instance. The maximum is 20.

group_name str: Specifies the name of IP address group.
ip_lists Sequence[str]: Specifies the list of IP address or CIDR which can be whitelisted for an instance. The maximum is 20.

groupName String: Specifies the name of IP address group.
ipLists List<String>: Specifies the list of IP address or CIDR which can be whitelisted for an instance. The maximum is 20.

Import

DCS instance can be imported using the id, e.g.

bash

$ pulumi import opentelekomcloud:index/dcsInstanceV2:DcsInstanceV2 instance_1 80e373f9-872e-4046-aae9-ccd9ddc55511

Note that the imported state may not be identical to your resource definition, due to some attributes missing from the

API response, security or some other reason.

The missing attributes include: backup_policy, parameters, password,

bandwidth_info.0.current_time.

It is generally recommended running pulumi preview after importing an instance.

You can then decide if changes should be applied to the instance, or the resource definition should be updated to

align with the instance. Also, you can ignore changes as below.

resource “opentelekomcloud_dcs_instance_v2” “instance_1” {

...

lifecycle {

ignore_changes = [

  password, rename_commands, backup_policy, parameters,

  bandwidth_info.0.current_time

]

}

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

Package Details

Repository: opentelekomcloud opentelekomcloud/terraform-provider-opentelekomcloud
License
Notes: This Pulumi package is based on the opentelekomcloud Terraform Provider.

opentelekomcloud 1.36.35 published on Monday, Apr 14, 2025 by opentelekomcloud

opentelekomcloud/terraform-provider-opentelekomcloud

Example Usage
Engine version 3.0 (security_group_id is required):
Engine version 5.0 (please pay attention of proper selection of flavor):
Create DcsInstanceV2 Resource
Constructor syntax
Constructor example
DcsInstanceV2 Resource Properties
Inputs
Outputs
Look up Existing DcsInstanceV2 Resource
Supporting Types
Import
Package Details

Request a Change

opentelekomcloud.DcsInstanceV2

On this page

On this page

Example Usage

Engine version 3.0 (`security_group_id` is required):

Engine version 5.0 (please pay attention of proper selection of flavor):

Create DcsInstanceV2 Resource

Constructor syntax

Parameters

Constructor example

DcsInstanceV2 Resource Properties

Inputs

Outputs

Look up Existing DcsInstanceV2 Resource

Supporting Types

DcsInstanceV2BackupPolicy
, DcsInstanceV2BackupPolicyArgs

DcsInstanceV2BandwidthInfo
, DcsInstanceV2BandwidthInfoArgs

DcsInstanceV2Parameter
, DcsInstanceV2ParameterArgs

DcsInstanceV2Timeouts
, DcsInstanceV2TimeoutsArgs

DcsInstanceV2Whitelist
, DcsInstanceV2WhitelistArgs

Import

Package Details

On this page

On this page

opentelekomcloud.DcsInstanceV2

On this page

On this page

Example Usage

Engine version 3.0 (security_group_id is required):

Engine version 5.0 (please pay attention of proper selection of flavor):

Create DcsInstanceV2 Resource

Constructor syntax

Parameters

Constructor example

DcsInstanceV2 Resource Properties

Inputs

Outputs

Look up Existing DcsInstanceV2 Resource

Supporting Types

DcsInstanceV2BackupPolicy, DcsInstanceV2BackupPolicyArgs

DcsInstanceV2BandwidthInfo, DcsInstanceV2BandwidthInfoArgs

DcsInstanceV2Parameter, DcsInstanceV2ParameterArgs

DcsInstanceV2Timeouts, DcsInstanceV2TimeoutsArgs

DcsInstanceV2Whitelist, DcsInstanceV2WhitelistArgs

Import

Package Details

On this page

On this page

Engine version 3.0 (`security_group_id` is required):

DcsInstanceV2BackupPolicy
, DcsInstanceV2BackupPolicyArgs

DcsInstanceV2BandwidthInfo
, DcsInstanceV2BandwidthInfoArgs

DcsInstanceV2Parameter
, DcsInstanceV2ParameterArgs

DcsInstanceV2Timeouts
, DcsInstanceV2TimeoutsArgs

DcsInstanceV2Whitelist
, DcsInstanceV2WhitelistArgs