1. Packages
  2. Alibaba Cloud Provider
  3. API Docs
  4. selectdb
  5. DbInstance
Alibaba Cloud v3.76.0 published on Tuesday, Apr 8, 2025 by Pulumi

alicloud.selectdb.DbInstance

Explore with Pulumi AI

Provides a SelectDB DBInstance resource.

For information about SelectDB DBInstance and how to use it, see What is DBInstance.

NOTE: Available since v1.229.0.

Example Usage

Basic Usage

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

const _default = alicloud.getZones({
    availableResourceCreation: "VSwitch",
});
const config = new pulumi.Config();
const name = config.get("name") || "terraform_example";
const defaultGetNetworks = alicloud.vpc.getNetworks({
    nameRegex: "^default-NODELETING$",
});
const defaultGetSwitches = Promise.all([defaultGetNetworks, _default]).then(([defaultGetNetworks, _default]) => alicloud.vpc.getSwitches({
    vpcId: defaultGetNetworks.ids?.[0],
    zoneId: _default.zones?.[0]?.id,
}));
const defaultDbInstance = new alicloud.selectdb.DbInstance("default", {
    dbInstanceClass: "selectdb.xlarge",
    dbInstanceDescription: name,
    cacheSize: 200,
    paymentType: "PayAsYouGo",
    vpcId: defaultGetSwitches.then(defaultGetSwitches => defaultGetSwitches.vswitches?.[0]?.vpcId),
    zoneId: defaultGetSwitches.then(defaultGetSwitches => defaultGetSwitches.vswitches?.[0]?.zoneId),
    vswitchId: defaultGetSwitches.then(defaultGetSwitches => defaultGetSwitches.vswitches?.[0]?.id),
});
Copy
import pulumi
import pulumi_alicloud as alicloud

default = alicloud.get_zones(available_resource_creation="VSwitch")
config = pulumi.Config()
name = config.get("name")
if name is None:
    name = "terraform_example"
default_get_networks = alicloud.vpc.get_networks(name_regex="^default-NODELETING$")
default_get_switches = alicloud.vpc.get_switches(vpc_id=default_get_networks.ids[0],
    zone_id=default.zones[0].id)
default_db_instance = alicloud.selectdb.DbInstance("default",
    db_instance_class="selectdb.xlarge",
    db_instance_description=name,
    cache_size=200,
    payment_type="PayAsYouGo",
    vpc_id=default_get_switches.vswitches[0].vpc_id,
    zone_id=default_get_switches.vswitches[0].zone_id,
    vswitch_id=default_get_switches.vswitches[0].id)
Copy
package main

import (
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud"
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/selectdb"
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/vpc"
	"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 {
		_default, err := alicloud.GetZones(ctx, &alicloud.GetZonesArgs{
			AvailableResourceCreation: pulumi.StringRef("VSwitch"),
		}, nil)
		if err != nil {
			return err
		}
		cfg := config.New(ctx, "")
		name := "terraform_example"
		if param := cfg.Get("name"); param != "" {
			name = param
		}
		defaultGetNetworks, err := vpc.GetNetworks(ctx, &vpc.GetNetworksArgs{
			NameRegex: pulumi.StringRef("^default-NODELETING$"),
		}, nil)
		if err != nil {
			return err
		}
		defaultGetSwitches, err := vpc.GetSwitches(ctx, &vpc.GetSwitchesArgs{
			VpcId:  pulumi.StringRef(defaultGetNetworks.Ids[0]),
			ZoneId: pulumi.StringRef(_default.Zones[0].Id),
		}, nil)
		if err != nil {
			return err
		}
		_, err = selectdb.NewDbInstance(ctx, "default", &selectdb.DbInstanceArgs{
			DbInstanceClass:       pulumi.String("selectdb.xlarge"),
			DbInstanceDescription: pulumi.String(name),
			CacheSize:             pulumi.Int(200),
			PaymentType:           pulumi.String("PayAsYouGo"),
			VpcId:                 pulumi.String(defaultGetSwitches.Vswitches[0].VpcId),
			ZoneId:                pulumi.String(defaultGetSwitches.Vswitches[0].ZoneId),
			VswitchId:             pulumi.String(defaultGetSwitches.Vswitches[0].Id),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AliCloud = Pulumi.AliCloud;

return await Deployment.RunAsync(() => 
{
    var @default = AliCloud.GetZones.Invoke(new()
    {
        AvailableResourceCreation = "VSwitch",
    });

    var config = new Config();
    var name = config.Get("name") ?? "terraform_example";
    var defaultGetNetworks = AliCloud.Vpc.GetNetworks.Invoke(new()
    {
        NameRegex = "^default-NODELETING$",
    });

    var defaultGetSwitches = AliCloud.Vpc.GetSwitches.Invoke(new()
    {
        VpcId = defaultGetNetworks.Apply(getNetworksResult => getNetworksResult.Ids[0]),
        ZoneId = @default.Apply(getZonesResult => getZonesResult.Zones[0]?.Id),
    });

    var defaultDbInstance = new AliCloud.SelectDB.DbInstance("default", new()
    {
        DbInstanceClass = "selectdb.xlarge",
        DbInstanceDescription = name,
        CacheSize = 200,
        PaymentType = "PayAsYouGo",
        VpcId = defaultGetSwitches.Apply(getSwitchesResult => getSwitchesResult.Vswitches[0]?.VpcId),
        ZoneId = defaultGetSwitches.Apply(getSwitchesResult => getSwitchesResult.Vswitches[0]?.ZoneId),
        VswitchId = defaultGetSwitches.Apply(getSwitchesResult => getSwitchesResult.Vswitches[0]?.Id),
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.AlicloudFunctions;
import com.pulumi.alicloud.inputs.GetZonesArgs;
import com.pulumi.alicloud.vpc.VpcFunctions;
import com.pulumi.alicloud.vpc.inputs.GetNetworksArgs;
import com.pulumi.alicloud.vpc.inputs.GetSwitchesArgs;
import com.pulumi.alicloud.selectdb.DbInstance;
import com.pulumi.alicloud.selectdb.DbInstanceArgs;
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 default = AlicloudFunctions.getZones(GetZonesArgs.builder()
            .availableResourceCreation("VSwitch")
            .build());

        final var name = config.get("name").orElse("terraform_example");
        final var defaultGetNetworks = VpcFunctions.getNetworks(GetNetworksArgs.builder()
            .nameRegex("^default-NODELETING$")
            .build());

        final var defaultGetSwitches = VpcFunctions.getSwitches(GetSwitchesArgs.builder()
            .vpcId(defaultGetNetworks.applyValue(getNetworksResult -> getNetworksResult.ids()[0]))
            .zoneId(default_.zones()[0].id())
            .build());

        var defaultDbInstance = new DbInstance("defaultDbInstance", DbInstanceArgs.builder()
            .dbInstanceClass("selectdb.xlarge")
            .dbInstanceDescription(name)
            .cacheSize(200)
            .paymentType("PayAsYouGo")
            .vpcId(defaultGetSwitches.applyValue(getSwitchesResult -> getSwitchesResult.vswitches()[0].vpcId()))
            .zoneId(defaultGetSwitches.applyValue(getSwitchesResult -> getSwitchesResult.vswitches()[0].zoneId()))
            .vswitchId(defaultGetSwitches.applyValue(getSwitchesResult -> getSwitchesResult.vswitches()[0].id()))
            .build());

    }
}
Copy
configuration:
  name:
    type: string
    default: terraform_example
resources:
  defaultDbInstance:
    type: alicloud:selectdb:DbInstance
    name: default
    properties:
      dbInstanceClass: selectdb.xlarge
      dbInstanceDescription: ${name}
      cacheSize: 200
      paymentType: PayAsYouGo
      vpcId: ${defaultGetSwitches.vswitches[0].vpcId}
      zoneId: ${defaultGetSwitches.vswitches[0].zoneId}
      vswitchId: ${defaultGetSwitches.vswitches[0].id}
variables:
  default:
    fn::invoke:
      function: alicloud:getZones
      arguments:
        availableResourceCreation: VSwitch
  defaultGetNetworks:
    fn::invoke:
      function: alicloud:vpc:getNetworks
      arguments:
        nameRegex: ^default-NODELETING$
  defaultGetSwitches:
    fn::invoke:
      function: alicloud:vpc:getSwitches
      arguments:
        vpcId: ${defaultGetNetworks.ids[0]}
        zoneId: ${default.zones[0].id}
Copy

Create DbInstance Resource

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

Constructor syntax

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

@overload
def DbInstance(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               payment_type: Optional[str] = None,
               vswitch_id: Optional[str] = None,
               db_instance_class: Optional[str] = None,
               db_instance_description: Optional[str] = None,
               zone_id: Optional[str] = None,
               vpc_id: Optional[str] = None,
               cache_size: Optional[int] = None,
               desired_security_ip_lists: Optional[Sequence[DbInstanceDesiredSecurityIpListArgs]] = None,
               period_time: Optional[int] = None,
               tags: Optional[Mapping[str, str]] = None,
               upgraded_engine_minor_version: Optional[str] = None,
               enable_public_network: Optional[bool] = None,
               period: Optional[str] = None,
               admin_pass: Optional[str] = None)
func NewDbInstance(ctx *Context, name string, args DbInstanceArgs, opts ...ResourceOption) (*DbInstance, error)
public DbInstance(string name, DbInstanceArgs args, CustomResourceOptions? opts = null)
public DbInstance(String name, DbInstanceArgs args)
public DbInstance(String name, DbInstanceArgs args, CustomResourceOptions options)
type: alicloud:selectdb:DbInstance
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

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

Constructor example

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

var alicloudDbInstanceResource = new AliCloud.SelectDB.DbInstance("alicloudDbInstanceResource", new()
{
    PaymentType = "string",
    VswitchId = "string",
    DbInstanceClass = "string",
    DbInstanceDescription = "string",
    ZoneId = "string",
    VpcId = "string",
    CacheSize = 0,
    DesiredSecurityIpLists = new[]
    {
        new AliCloud.SelectDB.Inputs.DbInstanceDesiredSecurityIpListArgs
        {
            GroupName = "string",
            SecurityIpList = "string",
        },
    },
    PeriodTime = 0,
    Tags = 
    {
        { "string", "string" },
    },
    UpgradedEngineMinorVersion = "string",
    EnablePublicNetwork = false,
    Period = "string",
    AdminPass = "string",
});
Copy
example, err := selectdb.NewDbInstance(ctx, "alicloudDbInstanceResource", &selectdb.DbInstanceArgs{
	PaymentType:           pulumi.String("string"),
	VswitchId:             pulumi.String("string"),
	DbInstanceClass:       pulumi.String("string"),
	DbInstanceDescription: pulumi.String("string"),
	ZoneId:                pulumi.String("string"),
	VpcId:                 pulumi.String("string"),
	CacheSize:             pulumi.Int(0),
	DesiredSecurityIpLists: selectdb.DbInstanceDesiredSecurityIpListArray{
		&selectdb.DbInstanceDesiredSecurityIpListArgs{
			GroupName:      pulumi.String("string"),
			SecurityIpList: pulumi.String("string"),
		},
	},
	PeriodTime: pulumi.Int(0),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	UpgradedEngineMinorVersion: pulumi.String("string"),
	EnablePublicNetwork:        pulumi.Bool(false),
	Period:                     pulumi.String("string"),
	AdminPass:                  pulumi.String("string"),
})
Copy
var alicloudDbInstanceResource = new DbInstance("alicloudDbInstanceResource", DbInstanceArgs.builder()
    .paymentType("string")
    .vswitchId("string")
    .dbInstanceClass("string")
    .dbInstanceDescription("string")
    .zoneId("string")
    .vpcId("string")
    .cacheSize(0)
    .desiredSecurityIpLists(DbInstanceDesiredSecurityIpListArgs.builder()
        .groupName("string")
        .securityIpList("string")
        .build())
    .periodTime(0)
    .tags(Map.of("string", "string"))
    .upgradedEngineMinorVersion("string")
    .enablePublicNetwork(false)
    .period("string")
    .adminPass("string")
    .build());
Copy
alicloud_db_instance_resource = alicloud.selectdb.DbInstance("alicloudDbInstanceResource",
    payment_type="string",
    vswitch_id="string",
    db_instance_class="string",
    db_instance_description="string",
    zone_id="string",
    vpc_id="string",
    cache_size=0,
    desired_security_ip_lists=[{
        "group_name": "string",
        "security_ip_list": "string",
    }],
    period_time=0,
    tags={
        "string": "string",
    },
    upgraded_engine_minor_version="string",
    enable_public_network=False,
    period="string",
    admin_pass="string")
Copy
const alicloudDbInstanceResource = new alicloud.selectdb.DbInstance("alicloudDbInstanceResource", {
    paymentType: "string",
    vswitchId: "string",
    dbInstanceClass: "string",
    dbInstanceDescription: "string",
    zoneId: "string",
    vpcId: "string",
    cacheSize: 0,
    desiredSecurityIpLists: [{
        groupName: "string",
        securityIpList: "string",
    }],
    periodTime: 0,
    tags: {
        string: "string",
    },
    upgradedEngineMinorVersion: "string",
    enablePublicNetwork: false,
    period: "string",
    adminPass: "string",
});
Copy
type: alicloud:selectdb:DbInstance
properties:
    adminPass: string
    cacheSize: 0
    dbInstanceClass: string
    dbInstanceDescription: string
    desiredSecurityIpLists:
        - groupName: string
          securityIpList: string
    enablePublicNetwork: false
    paymentType: string
    period: string
    periodTime: 0
    tags:
        string: string
    upgradedEngineMinorVersion: string
    vpcId: string
    vswitchId: string
    zoneId: string
Copy

DbInstance 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 DbInstance resource accepts the following input properties:

CacheSize This property is required. int
The cache size in DBInstance on creating default cluster. The number should be divided by 100.
DbInstanceClass This property is required. string
The class for default cluster in DBInstance. db_cluster_class has a range of class from selectdb.xlarge to selectdb.256xlarge.
DbInstanceDescription This property is required. string
The DBInstance description.
PaymentType This property is required. string
The payment type of the resource. Valid values: PayAsYouGo,Subscription.
VpcId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the VPC for DBInstance.
VswitchId
This property is required.
Changes to this property will trigger replacement.
string
The ID of vswitch for DBInstance.
ZoneId
This property is required.
Changes to this property will trigger replacement.
string
The ID of zone for DBInstance.
AdminPass string
The password for DBInstance using admin account.
DesiredSecurityIpLists List<Pulumi.AliCloud.SelectDB.Inputs.DbInstanceDesiredSecurityIpList>
The modified IP address whitelists. See desired_security_ip_lists below.
EnablePublicNetwork bool
If DBInstance need to open public network, set it to true.
Period string
It is valid when payment_type is Subscription. Valid values are Year, Month.
PeriodTime int
The duration that you will buy DBInstance. It is valid when payment_type is Subscription. Valid values: [1~9], 12, 24, 36.
Tags Dictionary<string, string>
A mapping of tags to assign to the resource.

  • Key: It can be up to 64 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It cannot be a null string.
  • Value: It can be up to 128 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It can be a null string.
UpgradedEngineMinorVersion string
The DBInstance minor version want to upgraded to. (Available since 1.245.0) Can be set to 4.0 in creating SelectDB 4.0 DBInstance.
CacheSize This property is required. int
The cache size in DBInstance on creating default cluster. The number should be divided by 100.
DbInstanceClass This property is required. string
The class for default cluster in DBInstance. db_cluster_class has a range of class from selectdb.xlarge to selectdb.256xlarge.
DbInstanceDescription This property is required. string
The DBInstance description.
PaymentType This property is required. string
The payment type of the resource. Valid values: PayAsYouGo,Subscription.
VpcId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the VPC for DBInstance.
VswitchId
This property is required.
Changes to this property will trigger replacement.
string
The ID of vswitch for DBInstance.
ZoneId
This property is required.
Changes to this property will trigger replacement.
string
The ID of zone for DBInstance.
AdminPass string
The password for DBInstance using admin account.
DesiredSecurityIpLists []DbInstanceDesiredSecurityIpListArgs
The modified IP address whitelists. See desired_security_ip_lists below.
EnablePublicNetwork bool
If DBInstance need to open public network, set it to true.
Period string
It is valid when payment_type is Subscription. Valid values are Year, Month.
PeriodTime int
The duration that you will buy DBInstance. It is valid when payment_type is Subscription. Valid values: [1~9], 12, 24, 36.
Tags map[string]string
A mapping of tags to assign to the resource.

  • Key: It can be up to 64 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It cannot be a null string.
  • Value: It can be up to 128 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It can be a null string.
UpgradedEngineMinorVersion string
The DBInstance minor version want to upgraded to. (Available since 1.245.0) Can be set to 4.0 in creating SelectDB 4.0 DBInstance.
cacheSize This property is required. Integer
The cache size in DBInstance on creating default cluster. The number should be divided by 100.
dbInstanceClass This property is required. String
The class for default cluster in DBInstance. db_cluster_class has a range of class from selectdb.xlarge to selectdb.256xlarge.
dbInstanceDescription This property is required. String
The DBInstance description.
paymentType This property is required. String
The payment type of the resource. Valid values: PayAsYouGo,Subscription.
vpcId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the VPC for DBInstance.
vswitchId
This property is required.
Changes to this property will trigger replacement.
String
The ID of vswitch for DBInstance.
zoneId
This property is required.
Changes to this property will trigger replacement.
String
The ID of zone for DBInstance.
adminPass String
The password for DBInstance using admin account.
desiredSecurityIpLists List<DbInstanceDesiredSecurityIpList>
The modified IP address whitelists. See desired_security_ip_lists below.
enablePublicNetwork Boolean
If DBInstance need to open public network, set it to true.
period String
It is valid when payment_type is Subscription. Valid values are Year, Month.
periodTime Integer
The duration that you will buy DBInstance. It is valid when payment_type is Subscription. Valid values: [1~9], 12, 24, 36.
tags Map<String,String>
A mapping of tags to assign to the resource.

  • Key: It can be up to 64 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It cannot be a null string.
  • Value: It can be up to 128 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It can be a null string.
upgradedEngineMinorVersion String
The DBInstance minor version want to upgraded to. (Available since 1.245.0) Can be set to 4.0 in creating SelectDB 4.0 DBInstance.
cacheSize This property is required. number
The cache size in DBInstance on creating default cluster. The number should be divided by 100.
dbInstanceClass This property is required. string
The class for default cluster in DBInstance. db_cluster_class has a range of class from selectdb.xlarge to selectdb.256xlarge.
dbInstanceDescription This property is required. string
The DBInstance description.
paymentType This property is required. string
The payment type of the resource. Valid values: PayAsYouGo,Subscription.
vpcId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the VPC for DBInstance.
vswitchId
This property is required.
Changes to this property will trigger replacement.
string
The ID of vswitch for DBInstance.
zoneId
This property is required.
Changes to this property will trigger replacement.
string
The ID of zone for DBInstance.
adminPass string
The password for DBInstance using admin account.
desiredSecurityIpLists DbInstanceDesiredSecurityIpList[]
The modified IP address whitelists. See desired_security_ip_lists below.
enablePublicNetwork boolean
If DBInstance need to open public network, set it to true.
period string
It is valid when payment_type is Subscription. Valid values are Year, Month.
periodTime number
The duration that you will buy DBInstance. It is valid when payment_type is Subscription. Valid values: [1~9], 12, 24, 36.
tags {[key: string]: string}
A mapping of tags to assign to the resource.

  • Key: It can be up to 64 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It cannot be a null string.
  • Value: It can be up to 128 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It can be a null string.
upgradedEngineMinorVersion string
The DBInstance minor version want to upgraded to. (Available since 1.245.0) Can be set to 4.0 in creating SelectDB 4.0 DBInstance.
cache_size This property is required. int
The cache size in DBInstance on creating default cluster. The number should be divided by 100.
db_instance_class This property is required. str
The class for default cluster in DBInstance. db_cluster_class has a range of class from selectdb.xlarge to selectdb.256xlarge.
db_instance_description This property is required. str
The DBInstance description.
payment_type This property is required. str
The payment type of the resource. Valid values: PayAsYouGo,Subscription.
vpc_id
This property is required.
Changes to this property will trigger replacement.
str
The ID of the VPC for DBInstance.
vswitch_id
This property is required.
Changes to this property will trigger replacement.
str
The ID of vswitch for DBInstance.
zone_id
This property is required.
Changes to this property will trigger replacement.
str
The ID of zone for DBInstance.
admin_pass str
The password for DBInstance using admin account.
desired_security_ip_lists Sequence[DbInstanceDesiredSecurityIpListArgs]
The modified IP address whitelists. See desired_security_ip_lists below.
enable_public_network bool
If DBInstance need to open public network, set it to true.
period str
It is valid when payment_type is Subscription. Valid values are Year, Month.
period_time int
The duration that you will buy DBInstance. It is valid when payment_type is Subscription. Valid values: [1~9], 12, 24, 36.
tags Mapping[str, str]
A mapping of tags to assign to the resource.

  • Key: It can be up to 64 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It cannot be a null string.
  • Value: It can be up to 128 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It can be a null string.
upgraded_engine_minor_version str
The DBInstance minor version want to upgraded to. (Available since 1.245.0) Can be set to 4.0 in creating SelectDB 4.0 DBInstance.
cacheSize This property is required. Number
The cache size in DBInstance on creating default cluster. The number should be divided by 100.
dbInstanceClass This property is required. String
The class for default cluster in DBInstance. db_cluster_class has a range of class from selectdb.xlarge to selectdb.256xlarge.
dbInstanceDescription This property is required. String
The DBInstance description.
paymentType This property is required. String
The payment type of the resource. Valid values: PayAsYouGo,Subscription.
vpcId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the VPC for DBInstance.
vswitchId
This property is required.
Changes to this property will trigger replacement.
String
The ID of vswitch for DBInstance.
zoneId
This property is required.
Changes to this property will trigger replacement.
String
The ID of zone for DBInstance.
adminPass String
The password for DBInstance using admin account.
desiredSecurityIpLists List<Property Map>
The modified IP address whitelists. See desired_security_ip_lists below.
enablePublicNetwork Boolean
If DBInstance need to open public network, set it to true.
period String
It is valid when payment_type is Subscription. Valid values are Year, Month.
periodTime Number
The duration that you will buy DBInstance. It is valid when payment_type is Subscription. Valid values: [1~9], 12, 24, 36.
tags Map<String>
A mapping of tags to assign to the resource.

  • Key: It can be up to 64 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It cannot be a null string.
  • Value: It can be up to 128 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It can be a null string.
upgradedEngineMinorVersion String
The DBInstance minor version want to upgraded to. (Available since 1.245.0) Can be set to 4.0 in creating SelectDB 4.0 DBInstance.

Outputs

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

CacheSizePostpaid int
The sum of cache size for every PayAsYouGo clusters in DBInstance.
CacheSizePrepaid int
The sum of cache size for every Subscription clusters in DBInstance.
ClusterCountPostpaid int
The sum of cluster counts for PayAsYouGo clusters in DBInstance.
ClusterCountPrepaid int
The sum of cluster counts for Subscription clusters in DBInstance.
CpuPostpaid int
The sum of cpu resource amount for every PayAsYouGo clusters in DBInstance.
CpuPrepaid int
The sum of cpu resource amount for every Subscription clusters in DBInstance.
Engine string
The engine of DBInstance. Always selectdb.
EngineMinorVersion string
The current DBInstance minor version.
GmtCreated string
The time when DBInstance is created.
GmtExpired string
The time when DBInstance will be expired. Available on Subscription DBInstance.
GmtModified string
The time when DBInstance is modified.
Id string
The provider-assigned unique ID for this managed resource.
InstanceNetInfos List<Pulumi.AliCloud.SelectDB.Outputs.DbInstanceInstanceNetInfo>
The net infos for instances.
LockMode string
The lock mode of the instance. Set the value to lock, which specifies that the instance is locked when it automatically expires or has an overdue payment.
LockReason string
The reason why the instance is locked.
MemoryPostpaid int
The sum of memory resource amount offor every PayAsYouGo clusters in DBInstance.
MemoryPrepaid int
The sum of memory resource amount offor every Subscription clusters in DBInstance.
RegionId string
The region ID of the instance.
SecurityIpLists List<Pulumi.AliCloud.SelectDB.Outputs.DbInstanceSecurityIpList>
The details about each IP address whitelist returned.
Status string
The status of the resource. Valid values: ACTIVATION,STOPPED,STARTING,RESTART.
SubDomain string
The sub domain of DBInstance.
CacheSizePostpaid int
The sum of cache size for every PayAsYouGo clusters in DBInstance.
CacheSizePrepaid int
The sum of cache size for every Subscription clusters in DBInstance.
ClusterCountPostpaid int
The sum of cluster counts for PayAsYouGo clusters in DBInstance.
ClusterCountPrepaid int
The sum of cluster counts for Subscription clusters in DBInstance.
CpuPostpaid int
The sum of cpu resource amount for every PayAsYouGo clusters in DBInstance.
CpuPrepaid int
The sum of cpu resource amount for every Subscription clusters in DBInstance.
Engine string
The engine of DBInstance. Always selectdb.
EngineMinorVersion string
The current DBInstance minor version.
GmtCreated string
The time when DBInstance is created.
GmtExpired string
The time when DBInstance will be expired. Available on Subscription DBInstance.
GmtModified string
The time when DBInstance is modified.
Id string
The provider-assigned unique ID for this managed resource.
InstanceNetInfos []DbInstanceInstanceNetInfo
The net infos for instances.
LockMode string
The lock mode of the instance. Set the value to lock, which specifies that the instance is locked when it automatically expires or has an overdue payment.
LockReason string
The reason why the instance is locked.
MemoryPostpaid int
The sum of memory resource amount offor every PayAsYouGo clusters in DBInstance.
MemoryPrepaid int
The sum of memory resource amount offor every Subscription clusters in DBInstance.
RegionId string
The region ID of the instance.
SecurityIpLists []DbInstanceSecurityIpList
The details about each IP address whitelist returned.
Status string
The status of the resource. Valid values: ACTIVATION,STOPPED,STARTING,RESTART.
SubDomain string
The sub domain of DBInstance.
cacheSizePostpaid Integer
The sum of cache size for every PayAsYouGo clusters in DBInstance.
cacheSizePrepaid Integer
The sum of cache size for every Subscription clusters in DBInstance.
clusterCountPostpaid Integer
The sum of cluster counts for PayAsYouGo clusters in DBInstance.
clusterCountPrepaid Integer
The sum of cluster counts for Subscription clusters in DBInstance.
cpuPostpaid Integer
The sum of cpu resource amount for every PayAsYouGo clusters in DBInstance.
cpuPrepaid Integer
The sum of cpu resource amount for every Subscription clusters in DBInstance.
engine String
The engine of DBInstance. Always selectdb.
engineMinorVersion String
The current DBInstance minor version.
gmtCreated String
The time when DBInstance is created.
gmtExpired String
The time when DBInstance will be expired. Available on Subscription DBInstance.
gmtModified String
The time when DBInstance is modified.
id String
The provider-assigned unique ID for this managed resource.
instanceNetInfos List<DbInstanceInstanceNetInfo>
The net infos for instances.
lockMode String
The lock mode of the instance. Set the value to lock, which specifies that the instance is locked when it automatically expires or has an overdue payment.
lockReason String
The reason why the instance is locked.
memoryPostpaid Integer
The sum of memory resource amount offor every PayAsYouGo clusters in DBInstance.
memoryPrepaid Integer
The sum of memory resource amount offor every Subscription clusters in DBInstance.
regionId String
The region ID of the instance.
securityIpLists List<DbInstanceSecurityIpList>
The details about each IP address whitelist returned.
status String
The status of the resource. Valid values: ACTIVATION,STOPPED,STARTING,RESTART.
subDomain String
The sub domain of DBInstance.
cacheSizePostpaid number
The sum of cache size for every PayAsYouGo clusters in DBInstance.
cacheSizePrepaid number
The sum of cache size for every Subscription clusters in DBInstance.
clusterCountPostpaid number
The sum of cluster counts for PayAsYouGo clusters in DBInstance.
clusterCountPrepaid number
The sum of cluster counts for Subscription clusters in DBInstance.
cpuPostpaid number
The sum of cpu resource amount for every PayAsYouGo clusters in DBInstance.
cpuPrepaid number
The sum of cpu resource amount for every Subscription clusters in DBInstance.
engine string
The engine of DBInstance. Always selectdb.
engineMinorVersion string
The current DBInstance minor version.
gmtCreated string
The time when DBInstance is created.
gmtExpired string
The time when DBInstance will be expired. Available on Subscription DBInstance.
gmtModified string
The time when DBInstance is modified.
id string
The provider-assigned unique ID for this managed resource.
instanceNetInfos DbInstanceInstanceNetInfo[]
The net infos for instances.
lockMode string
The lock mode of the instance. Set the value to lock, which specifies that the instance is locked when it automatically expires or has an overdue payment.
lockReason string
The reason why the instance is locked.
memoryPostpaid number
The sum of memory resource amount offor every PayAsYouGo clusters in DBInstance.
memoryPrepaid number
The sum of memory resource amount offor every Subscription clusters in DBInstance.
regionId string
The region ID of the instance.
securityIpLists DbInstanceSecurityIpList[]
The details about each IP address whitelist returned.
status string
The status of the resource. Valid values: ACTIVATION,STOPPED,STARTING,RESTART.
subDomain string
The sub domain of DBInstance.
cache_size_postpaid int
The sum of cache size for every PayAsYouGo clusters in DBInstance.
cache_size_prepaid int
The sum of cache size for every Subscription clusters in DBInstance.
cluster_count_postpaid int
The sum of cluster counts for PayAsYouGo clusters in DBInstance.
cluster_count_prepaid int
The sum of cluster counts for Subscription clusters in DBInstance.
cpu_postpaid int
The sum of cpu resource amount for every PayAsYouGo clusters in DBInstance.
cpu_prepaid int
The sum of cpu resource amount for every Subscription clusters in DBInstance.
engine str
The engine of DBInstance. Always selectdb.
engine_minor_version str
The current DBInstance minor version.
gmt_created str
The time when DBInstance is created.
gmt_expired str
The time when DBInstance will be expired. Available on Subscription DBInstance.
gmt_modified str
The time when DBInstance is modified.
id str
The provider-assigned unique ID for this managed resource.
instance_net_infos Sequence[DbInstanceInstanceNetInfo]
The net infos for instances.
lock_mode str
The lock mode of the instance. Set the value to lock, which specifies that the instance is locked when it automatically expires or has an overdue payment.
lock_reason str
The reason why the instance is locked.
memory_postpaid int
The sum of memory resource amount offor every PayAsYouGo clusters in DBInstance.
memory_prepaid int
The sum of memory resource amount offor every Subscription clusters in DBInstance.
region_id str
The region ID of the instance.
security_ip_lists Sequence[DbInstanceSecurityIpList]
The details about each IP address whitelist returned.
status str
The status of the resource. Valid values: ACTIVATION,STOPPED,STARTING,RESTART.
sub_domain str
The sub domain of DBInstance.
cacheSizePostpaid Number
The sum of cache size for every PayAsYouGo clusters in DBInstance.
cacheSizePrepaid Number
The sum of cache size for every Subscription clusters in DBInstance.
clusterCountPostpaid Number
The sum of cluster counts for PayAsYouGo clusters in DBInstance.
clusterCountPrepaid Number
The sum of cluster counts for Subscription clusters in DBInstance.
cpuPostpaid Number
The sum of cpu resource amount for every PayAsYouGo clusters in DBInstance.
cpuPrepaid Number
The sum of cpu resource amount for every Subscription clusters in DBInstance.
engine String
The engine of DBInstance. Always selectdb.
engineMinorVersion String
The current DBInstance minor version.
gmtCreated String
The time when DBInstance is created.
gmtExpired String
The time when DBInstance will be expired. Available on Subscription DBInstance.
gmtModified String
The time when DBInstance is modified.
id String
The provider-assigned unique ID for this managed resource.
instanceNetInfos List<Property Map>
The net infos for instances.
lockMode String
The lock mode of the instance. Set the value to lock, which specifies that the instance is locked when it automatically expires or has an overdue payment.
lockReason String
The reason why the instance is locked.
memoryPostpaid Number
The sum of memory resource amount offor every PayAsYouGo clusters in DBInstance.
memoryPrepaid Number
The sum of memory resource amount offor every Subscription clusters in DBInstance.
regionId String
The region ID of the instance.
securityIpLists List<Property Map>
The details about each IP address whitelist returned.
status String
The status of the resource. Valid values: ACTIVATION,STOPPED,STARTING,RESTART.
subDomain String
The sub domain of DBInstance.

Look up Existing DbInstance Resource

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

public static get(name: string, id: Input<ID>, state?: DbInstanceState, opts?: CustomResourceOptions): DbInstance
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        admin_pass: Optional[str] = None,
        cache_size: Optional[int] = None,
        cache_size_postpaid: Optional[int] = None,
        cache_size_prepaid: Optional[int] = None,
        cluster_count_postpaid: Optional[int] = None,
        cluster_count_prepaid: Optional[int] = None,
        cpu_postpaid: Optional[int] = None,
        cpu_prepaid: Optional[int] = None,
        db_instance_class: Optional[str] = None,
        db_instance_description: Optional[str] = None,
        desired_security_ip_lists: Optional[Sequence[DbInstanceDesiredSecurityIpListArgs]] = None,
        enable_public_network: Optional[bool] = None,
        engine: Optional[str] = None,
        engine_minor_version: Optional[str] = None,
        gmt_created: Optional[str] = None,
        gmt_expired: Optional[str] = None,
        gmt_modified: Optional[str] = None,
        instance_net_infos: Optional[Sequence[DbInstanceInstanceNetInfoArgs]] = None,
        lock_mode: Optional[str] = None,
        lock_reason: Optional[str] = None,
        memory_postpaid: Optional[int] = None,
        memory_prepaid: Optional[int] = None,
        payment_type: Optional[str] = None,
        period: Optional[str] = None,
        period_time: Optional[int] = None,
        region_id: Optional[str] = None,
        security_ip_lists: Optional[Sequence[DbInstanceSecurityIpListArgs]] = None,
        status: Optional[str] = None,
        sub_domain: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        upgraded_engine_minor_version: Optional[str] = None,
        vpc_id: Optional[str] = None,
        vswitch_id: Optional[str] = None,
        zone_id: Optional[str] = None) -> DbInstance
func GetDbInstance(ctx *Context, name string, id IDInput, state *DbInstanceState, opts ...ResourceOption) (*DbInstance, error)
public static DbInstance Get(string name, Input<string> id, DbInstanceState? state, CustomResourceOptions? opts = null)
public static DbInstance get(String name, Output<String> id, DbInstanceState state, CustomResourceOptions options)
resources:  _:    type: alicloud:selectdb:DbInstance    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
AdminPass string
The password for DBInstance using admin account.
CacheSize int
The cache size in DBInstance on creating default cluster. The number should be divided by 100.
CacheSizePostpaid int
The sum of cache size for every PayAsYouGo clusters in DBInstance.
CacheSizePrepaid int
The sum of cache size for every Subscription clusters in DBInstance.
ClusterCountPostpaid int
The sum of cluster counts for PayAsYouGo clusters in DBInstance.
ClusterCountPrepaid int
The sum of cluster counts for Subscription clusters in DBInstance.
CpuPostpaid int
The sum of cpu resource amount for every PayAsYouGo clusters in DBInstance.
CpuPrepaid int
The sum of cpu resource amount for every Subscription clusters in DBInstance.
DbInstanceClass string
The class for default cluster in DBInstance. db_cluster_class has a range of class from selectdb.xlarge to selectdb.256xlarge.
DbInstanceDescription string
The DBInstance description.
DesiredSecurityIpLists List<Pulumi.AliCloud.SelectDB.Inputs.DbInstanceDesiredSecurityIpList>
The modified IP address whitelists. See desired_security_ip_lists below.
EnablePublicNetwork bool
If DBInstance need to open public network, set it to true.
Engine string
The engine of DBInstance. Always selectdb.
EngineMinorVersion string
The current DBInstance minor version.
GmtCreated string
The time when DBInstance is created.
GmtExpired string
The time when DBInstance will be expired. Available on Subscription DBInstance.
GmtModified string
The time when DBInstance is modified.
InstanceNetInfos List<Pulumi.AliCloud.SelectDB.Inputs.DbInstanceInstanceNetInfo>
The net infos for instances.
LockMode string
The lock mode of the instance. Set the value to lock, which specifies that the instance is locked when it automatically expires or has an overdue payment.
LockReason string
The reason why the instance is locked.
MemoryPostpaid int
The sum of memory resource amount offor every PayAsYouGo clusters in DBInstance.
MemoryPrepaid int
The sum of memory resource amount offor every Subscription clusters in DBInstance.
PaymentType string
The payment type of the resource. Valid values: PayAsYouGo,Subscription.
Period string
It is valid when payment_type is Subscription. Valid values are Year, Month.
PeriodTime int
The duration that you will buy DBInstance. It is valid when payment_type is Subscription. Valid values: [1~9], 12, 24, 36.
RegionId string
The region ID of the instance.
SecurityIpLists List<Pulumi.AliCloud.SelectDB.Inputs.DbInstanceSecurityIpList>
The details about each IP address whitelist returned.
Status string
The status of the resource. Valid values: ACTIVATION,STOPPED,STARTING,RESTART.
SubDomain string
The sub domain of DBInstance.
Tags Dictionary<string, string>
A mapping of tags to assign to the resource.

  • Key: It can be up to 64 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It cannot be a null string.
  • Value: It can be up to 128 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It can be a null string.
UpgradedEngineMinorVersion string
The DBInstance minor version want to upgraded to. (Available since 1.245.0) Can be set to 4.0 in creating SelectDB 4.0 DBInstance.
VpcId Changes to this property will trigger replacement. string
The ID of the VPC for DBInstance.
VswitchId Changes to this property will trigger replacement. string
The ID of vswitch for DBInstance.
ZoneId Changes to this property will trigger replacement. string
The ID of zone for DBInstance.
AdminPass string
The password for DBInstance using admin account.
CacheSize int
The cache size in DBInstance on creating default cluster. The number should be divided by 100.
CacheSizePostpaid int
The sum of cache size for every PayAsYouGo clusters in DBInstance.
CacheSizePrepaid int
The sum of cache size for every Subscription clusters in DBInstance.
ClusterCountPostpaid int
The sum of cluster counts for PayAsYouGo clusters in DBInstance.
ClusterCountPrepaid int
The sum of cluster counts for Subscription clusters in DBInstance.
CpuPostpaid int
The sum of cpu resource amount for every PayAsYouGo clusters in DBInstance.
CpuPrepaid int
The sum of cpu resource amount for every Subscription clusters in DBInstance.
DbInstanceClass string
The class for default cluster in DBInstance. db_cluster_class has a range of class from selectdb.xlarge to selectdb.256xlarge.
DbInstanceDescription string
The DBInstance description.
DesiredSecurityIpLists []DbInstanceDesiredSecurityIpListArgs
The modified IP address whitelists. See desired_security_ip_lists below.
EnablePublicNetwork bool
If DBInstance need to open public network, set it to true.
Engine string
The engine of DBInstance. Always selectdb.
EngineMinorVersion string
The current DBInstance minor version.
GmtCreated string
The time when DBInstance is created.
GmtExpired string
The time when DBInstance will be expired. Available on Subscription DBInstance.
GmtModified string
The time when DBInstance is modified.
InstanceNetInfos []DbInstanceInstanceNetInfoArgs
The net infos for instances.
LockMode string
The lock mode of the instance. Set the value to lock, which specifies that the instance is locked when it automatically expires or has an overdue payment.
LockReason string
The reason why the instance is locked.
MemoryPostpaid int
The sum of memory resource amount offor every PayAsYouGo clusters in DBInstance.
MemoryPrepaid int
The sum of memory resource amount offor every Subscription clusters in DBInstance.
PaymentType string
The payment type of the resource. Valid values: PayAsYouGo,Subscription.
Period string
It is valid when payment_type is Subscription. Valid values are Year, Month.
PeriodTime int
The duration that you will buy DBInstance. It is valid when payment_type is Subscription. Valid values: [1~9], 12, 24, 36.
RegionId string
The region ID of the instance.
SecurityIpLists []DbInstanceSecurityIpListArgs
The details about each IP address whitelist returned.
Status string
The status of the resource. Valid values: ACTIVATION,STOPPED,STARTING,RESTART.
SubDomain string
The sub domain of DBInstance.
Tags map[string]string
A mapping of tags to assign to the resource.

  • Key: It can be up to 64 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It cannot be a null string.
  • Value: It can be up to 128 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It can be a null string.
UpgradedEngineMinorVersion string
The DBInstance minor version want to upgraded to. (Available since 1.245.0) Can be set to 4.0 in creating SelectDB 4.0 DBInstance.
VpcId Changes to this property will trigger replacement. string
The ID of the VPC for DBInstance.
VswitchId Changes to this property will trigger replacement. string
The ID of vswitch for DBInstance.
ZoneId Changes to this property will trigger replacement. string
The ID of zone for DBInstance.
adminPass String
The password for DBInstance using admin account.
cacheSize Integer
The cache size in DBInstance on creating default cluster. The number should be divided by 100.
cacheSizePostpaid Integer
The sum of cache size for every PayAsYouGo clusters in DBInstance.
cacheSizePrepaid Integer
The sum of cache size for every Subscription clusters in DBInstance.
clusterCountPostpaid Integer
The sum of cluster counts for PayAsYouGo clusters in DBInstance.
clusterCountPrepaid Integer
The sum of cluster counts for Subscription clusters in DBInstance.
cpuPostpaid Integer
The sum of cpu resource amount for every PayAsYouGo clusters in DBInstance.
cpuPrepaid Integer
The sum of cpu resource amount for every Subscription clusters in DBInstance.
dbInstanceClass String
The class for default cluster in DBInstance. db_cluster_class has a range of class from selectdb.xlarge to selectdb.256xlarge.
dbInstanceDescription String
The DBInstance description.
desiredSecurityIpLists List<DbInstanceDesiredSecurityIpList>
The modified IP address whitelists. See desired_security_ip_lists below.
enablePublicNetwork Boolean
If DBInstance need to open public network, set it to true.
engine String
The engine of DBInstance. Always selectdb.
engineMinorVersion String
The current DBInstance minor version.
gmtCreated String
The time when DBInstance is created.
gmtExpired String
The time when DBInstance will be expired. Available on Subscription DBInstance.
gmtModified String
The time when DBInstance is modified.
instanceNetInfos List<DbInstanceInstanceNetInfo>
The net infos for instances.
lockMode String
The lock mode of the instance. Set the value to lock, which specifies that the instance is locked when it automatically expires or has an overdue payment.
lockReason String
The reason why the instance is locked.
memoryPostpaid Integer
The sum of memory resource amount offor every PayAsYouGo clusters in DBInstance.
memoryPrepaid Integer
The sum of memory resource amount offor every Subscription clusters in DBInstance.
paymentType String
The payment type of the resource. Valid values: PayAsYouGo,Subscription.
period String
It is valid when payment_type is Subscription. Valid values are Year, Month.
periodTime Integer
The duration that you will buy DBInstance. It is valid when payment_type is Subscription. Valid values: [1~9], 12, 24, 36.
regionId String
The region ID of the instance.
securityIpLists List<DbInstanceSecurityIpList>
The details about each IP address whitelist returned.
status String
The status of the resource. Valid values: ACTIVATION,STOPPED,STARTING,RESTART.
subDomain String
The sub domain of DBInstance.
tags Map<String,String>
A mapping of tags to assign to the resource.

  • Key: It can be up to 64 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It cannot be a null string.
  • Value: It can be up to 128 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It can be a null string.
upgradedEngineMinorVersion String
The DBInstance minor version want to upgraded to. (Available since 1.245.0) Can be set to 4.0 in creating SelectDB 4.0 DBInstance.
vpcId Changes to this property will trigger replacement. String
The ID of the VPC for DBInstance.
vswitchId Changes to this property will trigger replacement. String
The ID of vswitch for DBInstance.
zoneId Changes to this property will trigger replacement. String
The ID of zone for DBInstance.
adminPass string
The password for DBInstance using admin account.
cacheSize number
The cache size in DBInstance on creating default cluster. The number should be divided by 100.
cacheSizePostpaid number
The sum of cache size for every PayAsYouGo clusters in DBInstance.
cacheSizePrepaid number
The sum of cache size for every Subscription clusters in DBInstance.
clusterCountPostpaid number
The sum of cluster counts for PayAsYouGo clusters in DBInstance.
clusterCountPrepaid number
The sum of cluster counts for Subscription clusters in DBInstance.
cpuPostpaid number
The sum of cpu resource amount for every PayAsYouGo clusters in DBInstance.
cpuPrepaid number
The sum of cpu resource amount for every Subscription clusters in DBInstance.
dbInstanceClass string
The class for default cluster in DBInstance. db_cluster_class has a range of class from selectdb.xlarge to selectdb.256xlarge.
dbInstanceDescription string
The DBInstance description.
desiredSecurityIpLists DbInstanceDesiredSecurityIpList[]
The modified IP address whitelists. See desired_security_ip_lists below.
enablePublicNetwork boolean
If DBInstance need to open public network, set it to true.
engine string
The engine of DBInstance. Always selectdb.
engineMinorVersion string
The current DBInstance minor version.
gmtCreated string
The time when DBInstance is created.
gmtExpired string
The time when DBInstance will be expired. Available on Subscription DBInstance.
gmtModified string
The time when DBInstance is modified.
instanceNetInfos DbInstanceInstanceNetInfo[]
The net infos for instances.
lockMode string
The lock mode of the instance. Set the value to lock, which specifies that the instance is locked when it automatically expires or has an overdue payment.
lockReason string
The reason why the instance is locked.
memoryPostpaid number
The sum of memory resource amount offor every PayAsYouGo clusters in DBInstance.
memoryPrepaid number
The sum of memory resource amount offor every Subscription clusters in DBInstance.
paymentType string
The payment type of the resource. Valid values: PayAsYouGo,Subscription.
period string
It is valid when payment_type is Subscription. Valid values are Year, Month.
periodTime number
The duration that you will buy DBInstance. It is valid when payment_type is Subscription. Valid values: [1~9], 12, 24, 36.
regionId string
The region ID of the instance.
securityIpLists DbInstanceSecurityIpList[]
The details about each IP address whitelist returned.
status string
The status of the resource. Valid values: ACTIVATION,STOPPED,STARTING,RESTART.
subDomain string
The sub domain of DBInstance.
tags {[key: string]: string}
A mapping of tags to assign to the resource.

  • Key: It can be up to 64 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It cannot be a null string.
  • Value: It can be up to 128 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It can be a null string.
upgradedEngineMinorVersion string
The DBInstance minor version want to upgraded to. (Available since 1.245.0) Can be set to 4.0 in creating SelectDB 4.0 DBInstance.
vpcId Changes to this property will trigger replacement. string
The ID of the VPC for DBInstance.
vswitchId Changes to this property will trigger replacement. string
The ID of vswitch for DBInstance.
zoneId Changes to this property will trigger replacement. string
The ID of zone for DBInstance.
admin_pass str
The password for DBInstance using admin account.
cache_size int
The cache size in DBInstance on creating default cluster. The number should be divided by 100.
cache_size_postpaid int
The sum of cache size for every PayAsYouGo clusters in DBInstance.
cache_size_prepaid int
The sum of cache size for every Subscription clusters in DBInstance.
cluster_count_postpaid int
The sum of cluster counts for PayAsYouGo clusters in DBInstance.
cluster_count_prepaid int
The sum of cluster counts for Subscription clusters in DBInstance.
cpu_postpaid int
The sum of cpu resource amount for every PayAsYouGo clusters in DBInstance.
cpu_prepaid int
The sum of cpu resource amount for every Subscription clusters in DBInstance.
db_instance_class str
The class for default cluster in DBInstance. db_cluster_class has a range of class from selectdb.xlarge to selectdb.256xlarge.
db_instance_description str
The DBInstance description.
desired_security_ip_lists Sequence[DbInstanceDesiredSecurityIpListArgs]
The modified IP address whitelists. See desired_security_ip_lists below.
enable_public_network bool
If DBInstance need to open public network, set it to true.
engine str
The engine of DBInstance. Always selectdb.
engine_minor_version str
The current DBInstance minor version.
gmt_created str
The time when DBInstance is created.
gmt_expired str
The time when DBInstance will be expired. Available on Subscription DBInstance.
gmt_modified str
The time when DBInstance is modified.
instance_net_infos Sequence[DbInstanceInstanceNetInfoArgs]
The net infos for instances.
lock_mode str
The lock mode of the instance. Set the value to lock, which specifies that the instance is locked when it automatically expires or has an overdue payment.
lock_reason str
The reason why the instance is locked.
memory_postpaid int
The sum of memory resource amount offor every PayAsYouGo clusters in DBInstance.
memory_prepaid int
The sum of memory resource amount offor every Subscription clusters in DBInstance.
payment_type str
The payment type of the resource. Valid values: PayAsYouGo,Subscription.
period str
It is valid when payment_type is Subscription. Valid values are Year, Month.
period_time int
The duration that you will buy DBInstance. It is valid when payment_type is Subscription. Valid values: [1~9], 12, 24, 36.
region_id str
The region ID of the instance.
security_ip_lists Sequence[DbInstanceSecurityIpListArgs]
The details about each IP address whitelist returned.
status str
The status of the resource. Valid values: ACTIVATION,STOPPED,STARTING,RESTART.
sub_domain str
The sub domain of DBInstance.
tags Mapping[str, str]
A mapping of tags to assign to the resource.

  • Key: It can be up to 64 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It cannot be a null string.
  • Value: It can be up to 128 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It can be a null string.
upgraded_engine_minor_version str
The DBInstance minor version want to upgraded to. (Available since 1.245.0) Can be set to 4.0 in creating SelectDB 4.0 DBInstance.
vpc_id Changes to this property will trigger replacement. str
The ID of the VPC for DBInstance.
vswitch_id Changes to this property will trigger replacement. str
The ID of vswitch for DBInstance.
zone_id Changes to this property will trigger replacement. str
The ID of zone for DBInstance.
adminPass String
The password for DBInstance using admin account.
cacheSize Number
The cache size in DBInstance on creating default cluster. The number should be divided by 100.
cacheSizePostpaid Number
The sum of cache size for every PayAsYouGo clusters in DBInstance.
cacheSizePrepaid Number
The sum of cache size for every Subscription clusters in DBInstance.
clusterCountPostpaid Number
The sum of cluster counts for PayAsYouGo clusters in DBInstance.
clusterCountPrepaid Number
The sum of cluster counts for Subscription clusters in DBInstance.
cpuPostpaid Number
The sum of cpu resource amount for every PayAsYouGo clusters in DBInstance.
cpuPrepaid Number
The sum of cpu resource amount for every Subscription clusters in DBInstance.
dbInstanceClass String
The class for default cluster in DBInstance. db_cluster_class has a range of class from selectdb.xlarge to selectdb.256xlarge.
dbInstanceDescription String
The DBInstance description.
desiredSecurityIpLists List<Property Map>
The modified IP address whitelists. See desired_security_ip_lists below.
enablePublicNetwork Boolean
If DBInstance need to open public network, set it to true.
engine String
The engine of DBInstance. Always selectdb.
engineMinorVersion String
The current DBInstance minor version.
gmtCreated String
The time when DBInstance is created.
gmtExpired String
The time when DBInstance will be expired. Available on Subscription DBInstance.
gmtModified String
The time when DBInstance is modified.
instanceNetInfos List<Property Map>
The net infos for instances.
lockMode String
The lock mode of the instance. Set the value to lock, which specifies that the instance is locked when it automatically expires or has an overdue payment.
lockReason String
The reason why the instance is locked.
memoryPostpaid Number
The sum of memory resource amount offor every PayAsYouGo clusters in DBInstance.
memoryPrepaid Number
The sum of memory resource amount offor every Subscription clusters in DBInstance.
paymentType String
The payment type of the resource. Valid values: PayAsYouGo,Subscription.
period String
It is valid when payment_type is Subscription. Valid values are Year, Month.
periodTime Number
The duration that you will buy DBInstance. It is valid when payment_type is Subscription. Valid values: [1~9], 12, 24, 36.
regionId String
The region ID of the instance.
securityIpLists List<Property Map>
The details about each IP address whitelist returned.
status String
The status of the resource. Valid values: ACTIVATION,STOPPED,STARTING,RESTART.
subDomain String
The sub domain of DBInstance.
tags Map<String>
A mapping of tags to assign to the resource.

  • Key: It can be up to 64 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It cannot be a null string.
  • Value: It can be up to 128 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It can be a null string.
upgradedEngineMinorVersion String
The DBInstance minor version want to upgraded to. (Available since 1.245.0) Can be set to 4.0 in creating SelectDB 4.0 DBInstance.
vpcId Changes to this property will trigger replacement. String
The ID of the VPC for DBInstance.
vswitchId Changes to this property will trigger replacement. String
The ID of vswitch for DBInstance.
zoneId Changes to this property will trigger replacement. String
The ID of zone for DBInstance.

Supporting Types

DbInstanceDesiredSecurityIpList
, DbInstanceDesiredSecurityIpListArgs

GroupName string
Security group name.
SecurityIpList string
The IP list of Security group. Each single IP value should be Separated by comma.
GroupName string
Security group name.
SecurityIpList string
The IP list of Security group. Each single IP value should be Separated by comma.
groupName String
Security group name.
securityIpList String
The IP list of Security group. Each single IP value should be Separated by comma.
groupName string
Security group name.
securityIpList string
The IP list of Security group. Each single IP value should be Separated by comma.
group_name str
Security group name.
security_ip_list str
The IP list of Security group. Each single IP value should be Separated by comma.
groupName String
Security group name.
securityIpList String
The IP list of Security group. Each single IP value should be Separated by comma.

DbInstanceInstanceNetInfo
, DbInstanceInstanceNetInfoArgs

ConnectionString string
The connection string of the instance.
DbIp string
The IP address of the instance.
NetType string
The network type of the instance.
PortLists List<Pulumi.AliCloud.SelectDB.Inputs.DbInstanceInstanceNetInfoPortList>
A list for port provides SelectDB service.
VpcInstanceId string
The VPC ID.
VswitchId string
The ID of vswitch for DBInstance.
ConnectionString string
The connection string of the instance.
DbIp string
The IP address of the instance.
NetType string
The network type of the instance.
PortLists []DbInstanceInstanceNetInfoPortList
A list for port provides SelectDB service.
VpcInstanceId string
The VPC ID.
VswitchId string
The ID of vswitch for DBInstance.
connectionString String
The connection string of the instance.
dbIp String
The IP address of the instance.
netType String
The network type of the instance.
portLists List<DbInstanceInstanceNetInfoPortList>
A list for port provides SelectDB service.
vpcInstanceId String
The VPC ID.
vswitchId String
The ID of vswitch for DBInstance.
connectionString string
The connection string of the instance.
dbIp string
The IP address of the instance.
netType string
The network type of the instance.
portLists DbInstanceInstanceNetInfoPortList[]
A list for port provides SelectDB service.
vpcInstanceId string
The VPC ID.
vswitchId string
The ID of vswitch for DBInstance.
connection_string str
The connection string of the instance.
db_ip str
The IP address of the instance.
net_type str
The network type of the instance.
port_lists Sequence[DbInstanceInstanceNetInfoPortList]
A list for port provides SelectDB service.
vpc_instance_id str
The VPC ID.
vswitch_id str
The ID of vswitch for DBInstance.
connectionString String
The connection string of the instance.
dbIp String
The IP address of the instance.
netType String
The network type of the instance.
portLists List<Property Map>
A list for port provides SelectDB service.
vpcInstanceId String
The VPC ID.
vswitchId String
The ID of vswitch for DBInstance.

DbInstanceInstanceNetInfoPortList
, DbInstanceInstanceNetInfoPortListArgs

Port string
The port that is used to connect.
Protocol string
The protocol of the port.
Port string
The port that is used to connect.
Protocol string
The protocol of the port.
port String
The port that is used to connect.
protocol String
The protocol of the port.
port string
The port that is used to connect.
protocol string
The protocol of the port.
port str
The port that is used to connect.
protocol str
The protocol of the port.
port String
The port that is used to connect.
protocol String
The protocol of the port.

DbInstanceSecurityIpList
, DbInstanceSecurityIpListArgs

GroupName string
Security group name.
GroupTag string
The tag of Security group.
ListNetType string
The network type of Security group.
SecurityIpList string
The IP list of Security group. Each single IP value should be Separated by comma.
SecurityIpType string
The IP address type. Valid values: ipv4, ipv6 (not supported).
GroupName string
Security group name.
GroupTag string
The tag of Security group.
ListNetType string
The network type of Security group.
SecurityIpList string
The IP list of Security group. Each single IP value should be Separated by comma.
SecurityIpType string
The IP address type. Valid values: ipv4, ipv6 (not supported).
groupName String
Security group name.
groupTag String
The tag of Security group.
listNetType String
The network type of Security group.
securityIpList String
The IP list of Security group. Each single IP value should be Separated by comma.
securityIpType String
The IP address type. Valid values: ipv4, ipv6 (not supported).
groupName string
Security group name.
groupTag string
The tag of Security group.
listNetType string
The network type of Security group.
securityIpList string
The IP list of Security group. Each single IP value should be Separated by comma.
securityIpType string
The IP address type. Valid values: ipv4, ipv6 (not supported).
group_name str
Security group name.
group_tag str
The tag of Security group.
list_net_type str
The network type of Security group.
security_ip_list str
The IP list of Security group. Each single IP value should be Separated by comma.
security_ip_type str
The IP address type. Valid values: ipv4, ipv6 (not supported).
groupName String
Security group name.
groupTag String
The tag of Security group.
listNetType String
The network type of Security group.
securityIpList String
The IP list of Security group. Each single IP value should be Separated by comma.
securityIpType String
The IP address type. Valid values: ipv4, ipv6 (not supported).

Import

SelectDB DBInstance can be imported using the id, e.g.

$ pulumi import alicloud:selectdb/dbInstance:DbInstance example <id>
Copy

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

Package Details

Repository
Alibaba Cloud pulumi/pulumi-alicloud
License
Apache-2.0
Notes
This Pulumi package is based on the alicloud Terraform Provider.