Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Alibaba Cloud Provider
  3. API Docs
  4. gpdb
  5. Instance
Alibaba Cloud v3.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-alicloud

alicloud.gpdb.Instance

Explore with Pulumi AI

Alibaba Cloud v3.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-alicloud

Provides a AnalyticDB for PostgreSQL instance resource supports replica set instances only. the AnalyticDB for PostgreSQL provides stable, reliable, and automatic scalable database services. You can see detail product introduction here

NOTE: Available since v1.47.0.

Example Usage

Basic Usage

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

const config = new pulumi.Config();
const name = config.get("name") || "tf-example";
const _default = alicloud.resourcemanager.getResourceGroups({});
const defaultGetZones = alicloud.gpdb.getZones({});
const defaultGetNetworks = alicloud.vpc.getNetworks({
    nameRegex: "^default-NODELETING$",
});
const defaultGetSwitches = Promise.all([defaultGetNetworks, defaultGetZones]).then(([defaultGetNetworks, defaultGetZones]) => alicloud.vpc.getSwitches({
    vpcId: defaultGetNetworks.ids?.[0],
    zoneId: defaultGetZones.ids?.[0],
}));
const defaultInstance = new alicloud.gpdb.Instance("default", {
    dbInstanceCategory: "HighAvailability",
    dbInstanceClass: "gpdb.group.segsdx1",
    dbInstanceMode: "StorageElastic",
    description: name,
    engine: "gpdb",
    engineVersion: "6.0",
    zoneId: defaultGetZones.then(defaultGetZones => defaultGetZones.ids?.[0]),
    instanceNetworkType: "VPC",
    instanceSpec: "2C16G",
    paymentType: "PayAsYouGo",
    segStorageType: "cloud_essd",
    segNodeNum: 4,
    storageSize: 50,
    vpcId: defaultGetNetworks.then(defaultGetNetworks => defaultGetNetworks.ids?.[0]),
    vswitchId: defaultGetSwitches.then(defaultGetSwitches => defaultGetSwitches.ids?.[0]),
    ipWhitelists: [{
        securityIpList: "127.0.0.1",
    }],
});
Copy
import pulumi
import pulumi_alicloud as alicloud

config = pulumi.Config()
name = config.get("name")
if name is None:
    name = "tf-example"
default = alicloud.resourcemanager.get_resource_groups()
default_get_zones = alicloud.gpdb.get_zones()
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_get_zones.ids[0])
default_instance = alicloud.gpdb.Instance("default",
    db_instance_category="HighAvailability",
    db_instance_class="gpdb.group.segsdx1",
    db_instance_mode="StorageElastic",
    description=name,
    engine="gpdb",
    engine_version="6.0",
    zone_id=default_get_zones.ids[0],
    instance_network_type="VPC",
    instance_spec="2C16G",
    payment_type="PayAsYouGo",
    seg_storage_type="cloud_essd",
    seg_node_num=4,
    storage_size=50,
    vpc_id=default_get_networks.ids[0],
    vswitch_id=default_get_switches.ids[0],
    ip_whitelists=[{
        "security_ip_list": "127.0.0.1",
    }])
Copy
package main

import (
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/gpdb"
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/resourcemanager"
	"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 {
		cfg := config.New(ctx, "")
		name := "tf-example"
		if param := cfg.Get("name"); param != "" {
			name = param
		}
		_, err := resourcemanager.GetResourceGroups(ctx, &resourcemanager.GetResourceGroupsArgs{}, nil)
		if err != nil {
			return err
		}
		defaultGetZones, err := gpdb.GetZones(ctx, &gpdb.GetZonesArgs{}, nil)
		if err != nil {
			return err
		}
		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(defaultGetZones.Ids[0]),
		}, nil)
		if err != nil {
			return err
		}
		_, err = gpdb.NewInstance(ctx, "default", &gpdb.InstanceArgs{
			DbInstanceCategory:  pulumi.String("HighAvailability"),
			DbInstanceClass:     pulumi.String("gpdb.group.segsdx1"),
			DbInstanceMode:      pulumi.String("StorageElastic"),
			Description:         pulumi.String(name),
			Engine:              pulumi.String("gpdb"),
			EngineVersion:       pulumi.String("6.0"),
			ZoneId:              pulumi.String(defaultGetZones.Ids[0]),
			InstanceNetworkType: pulumi.String("VPC"),
			InstanceSpec:        pulumi.String("2C16G"),
			PaymentType:         pulumi.String("PayAsYouGo"),
			SegStorageType:      pulumi.String("cloud_essd"),
			SegNodeNum:          pulumi.Int(4),
			StorageSize:         pulumi.Int(50),
			VpcId:               pulumi.String(defaultGetNetworks.Ids[0]),
			VswitchId:           pulumi.String(defaultGetSwitches.Ids[0]),
			IpWhitelists: gpdb.InstanceIpWhitelistArray{
				&gpdb.InstanceIpWhitelistArgs{
					SecurityIpList: pulumi.String("127.0.0.1"),
				},
			},
		})
		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 config = new Config();
    var name = config.Get("name") ?? "tf-example";
    var @default = AliCloud.ResourceManager.GetResourceGroups.Invoke();

    var defaultGetZones = AliCloud.Gpdb.GetZones.Invoke();

    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 = defaultGetZones.Apply(getZonesResult => getZonesResult.Ids[0]),
    });

    var defaultInstance = new AliCloud.Gpdb.Instance("default", new()
    {
        DbInstanceCategory = "HighAvailability",
        DbInstanceClass = "gpdb.group.segsdx1",
        DbInstanceMode = "StorageElastic",
        Description = name,
        Engine = "gpdb",
        EngineVersion = "6.0",
        ZoneId = defaultGetZones.Apply(getZonesResult => getZonesResult.Ids[0]),
        InstanceNetworkType = "VPC",
        InstanceSpec = "2C16G",
        PaymentType = "PayAsYouGo",
        SegStorageType = "cloud_essd",
        SegNodeNum = 4,
        StorageSize = 50,
        VpcId = defaultGetNetworks.Apply(getNetworksResult => getNetworksResult.Ids[0]),
        VswitchId = defaultGetSwitches.Apply(getSwitchesResult => getSwitchesResult.Ids[0]),
        IpWhitelists = new[]
        {
            new AliCloud.Gpdb.Inputs.InstanceIpWhitelistArgs
            {
                SecurityIpList = "127.0.0.1",
            },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.resourcemanager.ResourcemanagerFunctions;
import com.pulumi.alicloud.resourcemanager.inputs.GetResourceGroupsArgs;
import com.pulumi.alicloud.gpdb.GpdbFunctions;
import com.pulumi.alicloud.gpdb.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.gpdb.Instance;
import com.pulumi.alicloud.gpdb.InstanceArgs;
import com.pulumi.alicloud.gpdb.inputs.InstanceIpWhitelistArgs;
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 name = config.get("name").orElse("tf-example");
        final var default = ResourcemanagerFunctions.getResourceGroups();

        final var defaultGetZones = GpdbFunctions.getZones();

        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(defaultGetZones.applyValue(getZonesResult -> getZonesResult.ids()[0]))
            .build());

        var defaultInstance = new Instance("defaultInstance", InstanceArgs.builder()
            .dbInstanceCategory("HighAvailability")
            .dbInstanceClass("gpdb.group.segsdx1")
            .dbInstanceMode("StorageElastic")
            .description(name)
            .engine("gpdb")
            .engineVersion("6.0")
            .zoneId(defaultGetZones.applyValue(getZonesResult -> getZonesResult.ids()[0]))
            .instanceNetworkType("VPC")
            .instanceSpec("2C16G")
            .paymentType("PayAsYouGo")
            .segStorageType("cloud_essd")
            .segNodeNum(4)
            .storageSize(50)
            .vpcId(defaultGetNetworks.applyValue(getNetworksResult -> getNetworksResult.ids()[0]))
            .vswitchId(defaultGetSwitches.applyValue(getSwitchesResult -> getSwitchesResult.ids()[0]))
            .ipWhitelists(InstanceIpWhitelistArgs.builder()
                .securityIpList("127.0.0.1")
                .build())
            .build());

    }
}
Copy
configuration:
  name:
    type: string
    default: tf-example
resources:
  defaultInstance:
    type: alicloud:gpdb:Instance
    name: default
    properties:
      dbInstanceCategory: HighAvailability
      dbInstanceClass: gpdb.group.segsdx1
      dbInstanceMode: StorageElastic
      description: ${name}
      engine: gpdb
      engineVersion: '6.0'
      zoneId: ${defaultGetZones.ids[0]}
      instanceNetworkType: VPC
      instanceSpec: 2C16G
      paymentType: PayAsYouGo
      segStorageType: cloud_essd
      segNodeNum: 4
      storageSize: 50
      vpcId: ${defaultGetNetworks.ids[0]}
      vswitchId: ${defaultGetSwitches.ids[0]}
      ipWhitelists:
        - securityIpList: 127.0.0.1
variables:
  default:
    fn::invoke:
      function: alicloud:resourcemanager:getResourceGroups
      arguments: {}
  defaultGetZones:
    fn::invoke:
      function: alicloud:gpdb:getZones
      arguments: {}
  defaultGetNetworks:
    fn::invoke:
      function: alicloud:vpc:getNetworks
      arguments:
        nameRegex: ^default-NODELETING$
  defaultGetSwitches:
    fn::invoke:
      function: alicloud:vpc:getSwitches
      arguments:
        vpcId: ${defaultGetNetworks.ids[0]}
        zoneId: ${defaultGetZones.ids[0]}
Copy

Create Instance Resource

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

Constructor syntax

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

@overload
def Instance(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             db_instance_mode: Optional[str] = None,
             vswitch_id: Optional[str] = None,
             engine_version: Optional[str] = None,
             engine: Optional[str] = None,
             parameters: Optional[Sequence[InstanceParameterArgs]] = None,
             db_instance_class: Optional[str] = None,
             description: Optional[str] = None,
             encryption_key: Optional[str] = None,
             encryption_type: Optional[str] = None,
             db_instance_category: Optional[str] = None,
             data_share_status: Optional[str] = None,
             instance_charge_type: Optional[str] = None,
             instance_group_count: Optional[int] = None,
             instance_network_type: Optional[str] = None,
             instance_spec: Optional[str] = None,
             ip_whitelists: Optional[Sequence[InstanceIpWhitelistArgs]] = None,
             maintain_end_time: Optional[str] = None,
             maintain_start_time: Optional[str] = None,
             master_cu: Optional[int] = None,
             master_node_num: Optional[int] = None,
             payment_type: Optional[str] = None,
             availability_zone: Optional[str] = None,
             ssl_enabled: Optional[int] = None,
             private_ip_address: Optional[str] = None,
             prod_type: Optional[str] = None,
             resource_group_id: Optional[str] = None,
             resource_management_mode: Optional[str] = None,
             security_ip_lists: Optional[Sequence[str]] = None,
             seg_disk_performance_level: Optional[str] = None,
             seg_node_num: Optional[int] = None,
             seg_storage_type: Optional[str] = None,
             serverless_mode: Optional[str] = None,
             period: Optional[str] = None,
             storage_size: Optional[int] = None,
             tags: Optional[Mapping[str, str]] = None,
             used_time: Optional[str] = None,
             vector_configuration_status: Optional[str] = None,
             vpc_id: Optional[str] = None,
             create_sample_data: Optional[bool] = None,
             zone_id: Optional[str] = None)
func NewInstance(ctx *Context, name string, args InstanceArgs, opts ...ResourceOption) (*Instance, error)
public Instance(string name, InstanceArgs args, CustomResourceOptions? opts = null)
public Instance(String name, InstanceArgs args)
public Instance(String name, InstanceArgs args, CustomResourceOptions options)

type: alicloud:gpdb:Instance
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. InstanceArgs
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. InstanceArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. InstanceArgs
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. InstanceArgs
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. InstanceArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

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

var exampleinstanceResourceResourceFromGpdbinstance = new AliCloud.Gpdb.Instance("exampleinstanceResourceResourceFromGpdbinstance", new()
{
    DbInstanceMode = "string",
    VswitchId = "string",
    EngineVersion = "string",
    Engine = "string",
    Parameters = new[]
    {
        new AliCloud.Gpdb.Inputs.InstanceParameterArgs
        {
            Name = "string",
            Value = "string",
            DefaultValue = "string",
            ForceRestartInstance = "string",
            IsChangeableConfig = "string",
            OptionalRange = "string",
            ParameterDescription = "string",
        },
    },
    DbInstanceClass = "string",
    Description = "string",
    EncryptionKey = "string",
    EncryptionType = "string",
    DbInstanceCategory = "string",
    DataShareStatus = "string",
    InstanceGroupCount = 0,
    InstanceNetworkType = "string",
    InstanceSpec = "string",
    IpWhitelists = new[]
    {
        new AliCloud.Gpdb.Inputs.InstanceIpWhitelistArgs
        {
            IpGroupAttribute = "string",
            IpGroupName = "string",
            SecurityIpList = "string",
        },
    },
    MaintainEndTime = "string",
    MaintainStartTime = "string",
    MasterCu = 0,
    PaymentType = "string",
    SslEnabled = 0,
    ProdType = "string",
    ResourceGroupId = "string",
    ResourceManagementMode = "string",
    SegDiskPerformanceLevel = "string",
    SegNodeNum = 0,
    SegStorageType = "string",
    ServerlessMode = "string",
    Period = "string",
    StorageSize = 0,
    Tags = 
    {
        { "string", "string" },
    },
    UsedTime = "string",
    VectorConfigurationStatus = "string",
    VpcId = "string",
    CreateSampleData = false,
    ZoneId = "string",
});
Copy
example, err := gpdb.NewInstance(ctx, "exampleinstanceResourceResourceFromGpdbinstance", &gpdb.InstanceArgs{
	DbInstanceMode: pulumi.String("string"),
	VswitchId:      pulumi.String("string"),
	EngineVersion:  pulumi.String("string"),
	Engine:         pulumi.String("string"),
	Parameters: gpdb.InstanceParameterArray{
		&gpdb.InstanceParameterArgs{
			Name:                 pulumi.String("string"),
			Value:                pulumi.String("string"),
			DefaultValue:         pulumi.String("string"),
			ForceRestartInstance: pulumi.String("string"),
			IsChangeableConfig:   pulumi.String("string"),
			OptionalRange:        pulumi.String("string"),
			ParameterDescription: pulumi.String("string"),
		},
	},
	DbInstanceClass:     pulumi.String("string"),
	Description:         pulumi.String("string"),
	EncryptionKey:       pulumi.String("string"),
	EncryptionType:      pulumi.String("string"),
	DbInstanceCategory:  pulumi.String("string"),
	DataShareStatus:     pulumi.String("string"),
	InstanceGroupCount:  pulumi.Int(0),
	InstanceNetworkType: pulumi.String("string"),
	InstanceSpec:        pulumi.String("string"),
	IpWhitelists: gpdb.InstanceIpWhitelistArray{
		&gpdb.InstanceIpWhitelistArgs{
			IpGroupAttribute: pulumi.String("string"),
			IpGroupName:      pulumi.String("string"),
			SecurityIpList:   pulumi.String("string"),
		},
	},
	MaintainEndTime:         pulumi.String("string"),
	MaintainStartTime:       pulumi.String("string"),
	MasterCu:                pulumi.Int(0),
	PaymentType:             pulumi.String("string"),
	SslEnabled:              pulumi.Int(0),
	ProdType:                pulumi.String("string"),
	ResourceGroupId:         pulumi.String("string"),
	ResourceManagementMode:  pulumi.String("string"),
	SegDiskPerformanceLevel: pulumi.String("string"),
	SegNodeNum:              pulumi.Int(0),
	SegStorageType:          pulumi.String("string"),
	ServerlessMode:          pulumi.String("string"),
	Period:                  pulumi.String("string"),
	StorageSize:             pulumi.Int(0),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	UsedTime:                  pulumi.String("string"),
	VectorConfigurationStatus: pulumi.String("string"),
	VpcId:                     pulumi.String("string"),
	CreateSampleData:          pulumi.Bool(false),
	ZoneId:                    pulumi.String("string"),
})
Copy
var exampleinstanceResourceResourceFromGpdbinstance = new Instance("exampleinstanceResourceResourceFromGpdbinstance", InstanceArgs.builder()
    .dbInstanceMode("string")
    .vswitchId("string")
    .engineVersion("string")
    .engine("string")
    .parameters(InstanceParameterArgs.builder()
        .name("string")
        .value("string")
        .defaultValue("string")
        .forceRestartInstance("string")
        .isChangeableConfig("string")
        .optionalRange("string")
        .parameterDescription("string")
        .build())
    .dbInstanceClass("string")
    .description("string")
    .encryptionKey("string")
    .encryptionType("string")
    .dbInstanceCategory("string")
    .dataShareStatus("string")
    .instanceGroupCount(0)
    .instanceNetworkType("string")
    .instanceSpec("string")
    .ipWhitelists(InstanceIpWhitelistArgs.builder()
        .ipGroupAttribute("string")
        .ipGroupName("string")
        .securityIpList("string")
        .build())
    .maintainEndTime("string")
    .maintainStartTime("string")
    .masterCu(0)
    .paymentType("string")
    .sslEnabled(0)
    .prodType("string")
    .resourceGroupId("string")
    .resourceManagementMode("string")
    .segDiskPerformanceLevel("string")
    .segNodeNum(0)
    .segStorageType("string")
    .serverlessMode("string")
    .period("string")
    .storageSize(0)
    .tags(Map.of("string", "string"))
    .usedTime("string")
    .vectorConfigurationStatus("string")
    .vpcId("string")
    .createSampleData(false)
    .zoneId("string")
    .build());
Copy
exampleinstance_resource_resource_from_gpdbinstance = alicloud.gpdb.Instance("exampleinstanceResourceResourceFromGpdbinstance",
    db_instance_mode="string",
    vswitch_id="string",
    engine_version="string",
    engine="string",
    parameters=[{
        "name": "string",
        "value": "string",
        "default_value": "string",
        "force_restart_instance": "string",
        "is_changeable_config": "string",
        "optional_range": "string",
        "parameter_description": "string",
    }],
    db_instance_class="string",
    description="string",
    encryption_key="string",
    encryption_type="string",
    db_instance_category="string",
    data_share_status="string",
    instance_group_count=0,
    instance_network_type="string",
    instance_spec="string",
    ip_whitelists=[{
        "ip_group_attribute": "string",
        "ip_group_name": "string",
        "security_ip_list": "string",
    }],
    maintain_end_time="string",
    maintain_start_time="string",
    master_cu=0,
    payment_type="string",
    ssl_enabled=0,
    prod_type="string",
    resource_group_id="string",
    resource_management_mode="string",
    seg_disk_performance_level="string",
    seg_node_num=0,
    seg_storage_type="string",
    serverless_mode="string",
    period="string",
    storage_size=0,
    tags={
        "string": "string",
    },
    used_time="string",
    vector_configuration_status="string",
    vpc_id="string",
    create_sample_data=False,
    zone_id="string")
Copy
const exampleinstanceResourceResourceFromGpdbinstance = new alicloud.gpdb.Instance("exampleinstanceResourceResourceFromGpdbinstance", {
    dbInstanceMode: "string",
    vswitchId: "string",
    engineVersion: "string",
    engine: "string",
    parameters: [{
        name: "string",
        value: "string",
        defaultValue: "string",
        forceRestartInstance: "string",
        isChangeableConfig: "string",
        optionalRange: "string",
        parameterDescription: "string",
    }],
    dbInstanceClass: "string",
    description: "string",
    encryptionKey: "string",
    encryptionType: "string",
    dbInstanceCategory: "string",
    dataShareStatus: "string",
    instanceGroupCount: 0,
    instanceNetworkType: "string",
    instanceSpec: "string",
    ipWhitelists: [{
        ipGroupAttribute: "string",
        ipGroupName: "string",
        securityIpList: "string",
    }],
    maintainEndTime: "string",
    maintainStartTime: "string",
    masterCu: 0,
    paymentType: "string",
    sslEnabled: 0,
    prodType: "string",
    resourceGroupId: "string",
    resourceManagementMode: "string",
    segDiskPerformanceLevel: "string",
    segNodeNum: 0,
    segStorageType: "string",
    serverlessMode: "string",
    period: "string",
    storageSize: 0,
    tags: {
        string: "string",
    },
    usedTime: "string",
    vectorConfigurationStatus: "string",
    vpcId: "string",
    createSampleData: false,
    zoneId: "string",
});
Copy
type: alicloud:gpdb:Instance
properties:
    createSampleData: false
    dataShareStatus: string
    dbInstanceCategory: string
    dbInstanceClass: string
    dbInstanceMode: string
    description: string
    encryptionKey: string
    encryptionType: string
    engine: string
    engineVersion: string
    instanceGroupCount: 0
    instanceNetworkType: string
    instanceSpec: string
    ipWhitelists:
        - ipGroupAttribute: string
          ipGroupName: string
          securityIpList: string
    maintainEndTime: string
    maintainStartTime: string
    masterCu: 0
    parameters:
        - defaultValue: string
          forceRestartInstance: string
          isChangeableConfig: string
          name: string
          optionalRange: string
          parameterDescription: string
          value: string
    paymentType: string
    period: string
    prodType: string
    resourceGroupId: string
    resourceManagementMode: string
    segDiskPerformanceLevel: string
    segNodeNum: 0
    segStorageType: string
    serverlessMode: string
    sslEnabled: 0
    storageSize: 0
    tags:
        string: string
    usedTime: string
    vectorConfigurationStatus: string
    vpcId: string
    vswitchId: string
    zoneId: string
Copy

Instance Resource Properties

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

Inputs

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

The Instance resource accepts the following input properties:

DbInstanceMode
This property is required.
Changes to this property will trigger replacement.
string
The db instance mode. Valid values: StorageElastic, Serverless, Classic.
Engine
This property is required.
Changes to this property will trigger replacement.
string
The database engine used by the instance. Value options can refer to the latest docs CreateDBInstance EngineVersion.
EngineVersion
This property is required.
Changes to this property will trigger replacement.
string
The version of the database engine used by the instance.
VswitchId
This property is required.
Changes to this property will trigger replacement.
string
The vswitch id.
AvailabilityZone Changes to this property will trigger replacement. string
Field availability_zone has been deprecated from provider version 1.187.0. New field zone_id instead.

Deprecated: Field 'availability_zone' has been deprecated from version 1.187.0. Use 'zone_id' instead.

CreateSampleData bool
Whether to load the sample dataset after the instance is created. Valid values: true, false.
DataShareStatus string
Specifies whether to enable or disable data sharing. Default value: closed. Valid values:
DbInstanceCategory Changes to this property will trigger replacement. string

The db instance category. Valid values: Basic, HighAvailability.

NOTE: This parameter must be passed in to create a storage reservation mode instance.

DbInstanceClass string

The db instance class. see Instance specifications.

NOTE: This parameter must be passed in to create a storage reservation mode instance.

Description string
The description of the instance.
EncryptionKey Changes to this property will trigger replacement. string

The ID of the encryption key.

NOTE: If encryption_type is set to CloudDisk, you must specify an encryption key that resides in the same region as the cloud disk that is specified by EncryptionType. Otherwise, leave this parameter empty.

EncryptionType Changes to this property will trigger replacement. string

The encryption type. Valid values: CloudDisk.

NOTE: Disk encryption cannot be disabled after it is enabled.

InstanceChargeType Changes to this property will trigger replacement. string
Field instance_charge_type has been deprecated from provider version 1.187.0. New field payment_type instead.

Deprecated: Field instance_charge_type has been deprecated from version 1.187.0. Use payment_type instead.

InstanceGroupCount int
The number of nodes. Valid values: 2, 4, 8, 12, 16, 24, 32, 64, 96, 128.
InstanceNetworkType Changes to this property will trigger replacement. string
The network type of the instance. Valid values: VPC.
InstanceSpec string

The specification of segment nodes.

  • When db_instance_category is HighAvailability, Valid values: 2C16G, 4C32G, 16C128G.
  • When db_instance_category is Basic, Valid values: 2C8G, 4C16G, 8C32G, 16C64G.
  • When db_instance_category is Serverless, Valid values: 4C16G, 8C32G.

NOTE: This parameter must be passed to create a storage elastic mode instance and a serverless version instance.

IpWhitelists List<Pulumi.AliCloud.Gpdb.Inputs.InstanceIpWhitelist>
The ip whitelist. See ip_whitelist below. Default to creating a whitelist group with the group name "default" and security_ip_list "127.0.0.1".
MaintainEndTime string
The end time of the maintenance window for the instance. in the format of HH:mmZ (UTC time), for example 03:00Z. start time should be later than end time.
MaintainStartTime string
The start time of the maintenance window for the instance. in the format of HH:mmZ (UTC time), for example 02:00Z.
MasterCu int
The amount of coordinator node resources. Valid values: 2, 4, 8, 16, 32.
MasterNodeNum int
The number of Master nodes. NOTE: Field master_node_num has been deprecated from provider version 1.213.0.

Deprecated: Field master_node_num has been deprecated from provider version 1.213.0.

Parameters List<Pulumi.AliCloud.Gpdb.Inputs.InstanceParameter>
The parameters. See parameters below.
PaymentType Changes to this property will trigger replacement. string
The billing method of the instance. Valid values: Subscription, PayAsYouGo.
Period string
The duration that you will buy the resource, in month. required when payment_type is Subscription. Valid values: Year, Month.
PrivateIpAddress string
The private ip address. NOTE: Field private_ip_address has been deprecated from provider version 1.213.0.

Deprecated: Field private_ip_address has been deprecated from provider version 1.213.0.

ProdType Changes to this property will trigger replacement. string
The type of the product. Default value: standard. Valid values: standard, cost-effective.
ResourceGroupId string
The ID of the enterprise resource group to which the instance belongs.
ResourceManagementMode string
Resource management mode. Valid values: resourceGroup, resourceQueue.
SecurityIpLists List<string>
Field security_ip_list has been deprecated from provider version 1.187.0. New field ip_whitelist instead.

Deprecated: Field 'security_ip_list' has been deprecated from version 1.187.0. Use 'ip_whitelist' instead.

SegDiskPerformanceLevel string
The ESSD cloud disk performance level. Valid values: pl0, pl1, pl2.
SegNodeNum int

Calculate the number of nodes. Valid values: 2 to 512. The value range of the high-availability version of the storage elastic mode is 4 to 512, and the value must be a multiple of 4. The value range of the basic version of the storage elastic mode is 2 to 512, and the value must be a multiple of 2. The-Serverless version has a value range of 2 to 512. The value must be a multiple of 2.

NOTE: This parameter must be passed in to create a storage elastic mode instance and a Serverless version instance. During the public beta of the Serverless version (from 0101, 2022 to 0131, 2022), a maximum of 12 compute nodes can be created.

SegStorageType Changes to this property will trigger replacement. string
The seg storage type. Valid values: cloud_essd. NOTE: If db_instance_mode is set to StorageElastic, seg_storage_type is required. From version 1.233.1, seg_storage_type cannot be modified, or set to cloud_efficiency. seg_storage_type can only be set to cloud_essd.
ServerlessMode Changes to this property will trigger replacement. string
The mode of the Serverless instance. Valid values: Manual, Auto. NOTE: serverless_mode is valid only when db_instance_mode is set to Serverless.
SslEnabled int
Enable or disable SSL. Valid values: 0 and 1.
StorageSize int

The storage capacity. Unit: GB. Valid values: 50 to 4000.

NOTE: This parameter must be passed in to create a storage reservation mode instance.

Tags Dictionary<string, string>
A mapping of tags to assign to the resource.
UsedTime string
The used time. When the parameter period is Year, the used_time value is 1 to 3. When the parameter period is Month, the used_time value is 1 to 9.
VectorConfigurationStatus string
Specifies whether to enable vector engine optimization. Default value: disabled. Valid values: enabled and disabled.
VpcId Changes to this property will trigger replacement. string
The vpc ID of the resource.
ZoneId Changes to this property will trigger replacement. string
The zone ID of the instance.
DbInstanceMode
This property is required.
Changes to this property will trigger replacement.
string
The db instance mode. Valid values: StorageElastic, Serverless, Classic.
Engine
This property is required.
Changes to this property will trigger replacement.
string
The database engine used by the instance. Value options can refer to the latest docs CreateDBInstance EngineVersion.
EngineVersion
This property is required.
Changes to this property will trigger replacement.
string
The version of the database engine used by the instance.
VswitchId
This property is required.
Changes to this property will trigger replacement.
string
The vswitch id.
AvailabilityZone Changes to this property will trigger replacement. string
Field availability_zone has been deprecated from provider version 1.187.0. New field zone_id instead.

Deprecated: Field 'availability_zone' has been deprecated from version 1.187.0. Use 'zone_id' instead.

CreateSampleData bool
Whether to load the sample dataset after the instance is created. Valid values: true, false.
DataShareStatus string
Specifies whether to enable or disable data sharing. Default value: closed. Valid values:
DbInstanceCategory Changes to this property will trigger replacement. string

The db instance category. Valid values: Basic, HighAvailability.

NOTE: This parameter must be passed in to create a storage reservation mode instance.

DbInstanceClass string

The db instance class. see Instance specifications.

NOTE: This parameter must be passed in to create a storage reservation mode instance.

Description string
The description of the instance.
EncryptionKey Changes to this property will trigger replacement. string

The ID of the encryption key.

NOTE: If encryption_type is set to CloudDisk, you must specify an encryption key that resides in the same region as the cloud disk that is specified by EncryptionType. Otherwise, leave this parameter empty.

EncryptionType Changes to this property will trigger replacement. string

The encryption type. Valid values: CloudDisk.

NOTE: Disk encryption cannot be disabled after it is enabled.

InstanceChargeType Changes to this property will trigger replacement. string
Field instance_charge_type has been deprecated from provider version 1.187.0. New field payment_type instead.

Deprecated: Field instance_charge_type has been deprecated from version 1.187.0. Use payment_type instead.

InstanceGroupCount int
The number of nodes. Valid values: 2, 4, 8, 12, 16, 24, 32, 64, 96, 128.
InstanceNetworkType Changes to this property will trigger replacement. string
The network type of the instance. Valid values: VPC.
InstanceSpec string

The specification of segment nodes.

  • When db_instance_category is HighAvailability, Valid values: 2C16G, 4C32G, 16C128G.
  • When db_instance_category is Basic, Valid values: 2C8G, 4C16G, 8C32G, 16C64G.
  • When db_instance_category is Serverless, Valid values: 4C16G, 8C32G.

NOTE: This parameter must be passed to create a storage elastic mode instance and a serverless version instance.

IpWhitelists []InstanceIpWhitelistArgs
The ip whitelist. See ip_whitelist below. Default to creating a whitelist group with the group name "default" and security_ip_list "127.0.0.1".
MaintainEndTime string
The end time of the maintenance window for the instance. in the format of HH:mmZ (UTC time), for example 03:00Z. start time should be later than end time.
MaintainStartTime string
The start time of the maintenance window for the instance. in the format of HH:mmZ (UTC time), for example 02:00Z.
MasterCu int
The amount of coordinator node resources. Valid values: 2, 4, 8, 16, 32.
MasterNodeNum int
The number of Master nodes. NOTE: Field master_node_num has been deprecated from provider version 1.213.0.

Deprecated: Field master_node_num has been deprecated from provider version 1.213.0.

Parameters []InstanceParameterArgs
The parameters. See parameters below.
PaymentType Changes to this property will trigger replacement. string
The billing method of the instance. Valid values: Subscription, PayAsYouGo.
Period string
The duration that you will buy the resource, in month. required when payment_type is Subscription. Valid values: Year, Month.
PrivateIpAddress string
The private ip address. NOTE: Field private_ip_address has been deprecated from provider version 1.213.0.

Deprecated: Field private_ip_address has been deprecated from provider version 1.213.0.

ProdType Changes to this property will trigger replacement. string
The type of the product. Default value: standard. Valid values: standard, cost-effective.
ResourceGroupId string
The ID of the enterprise resource group to which the instance belongs.
ResourceManagementMode string
Resource management mode. Valid values: resourceGroup, resourceQueue.
SecurityIpLists []string
Field security_ip_list has been deprecated from provider version 1.187.0. New field ip_whitelist instead.

Deprecated: Field 'security_ip_list' has been deprecated from version 1.187.0. Use 'ip_whitelist' instead.

SegDiskPerformanceLevel string
The ESSD cloud disk performance level. Valid values: pl0, pl1, pl2.
SegNodeNum int

Calculate the number of nodes. Valid values: 2 to 512. The value range of the high-availability version of the storage elastic mode is 4 to 512, and the value must be a multiple of 4. The value range of the basic version of the storage elastic mode is 2 to 512, and the value must be a multiple of 2. The-Serverless version has a value range of 2 to 512. The value must be a multiple of 2.

NOTE: This parameter must be passed in to create a storage elastic mode instance and a Serverless version instance. During the public beta of the Serverless version (from 0101, 2022 to 0131, 2022), a maximum of 12 compute nodes can be created.

SegStorageType Changes to this property will trigger replacement. string
The seg storage type. Valid values: cloud_essd. NOTE: If db_instance_mode is set to StorageElastic, seg_storage_type is required. From version 1.233.1, seg_storage_type cannot be modified, or set to cloud_efficiency. seg_storage_type can only be set to cloud_essd.
ServerlessMode Changes to this property will trigger replacement. string
The mode of the Serverless instance. Valid values: Manual, Auto. NOTE: serverless_mode is valid only when db_instance_mode is set to Serverless.
SslEnabled int
Enable or disable SSL. Valid values: 0 and 1.
StorageSize int

The storage capacity. Unit: GB. Valid values: 50 to 4000.

NOTE: This parameter must be passed in to create a storage reservation mode instance.

Tags map[string]string
A mapping of tags to assign to the resource.
UsedTime string
The used time. When the parameter period is Year, the used_time value is 1 to 3. When the parameter period is Month, the used_time value is 1 to 9.
VectorConfigurationStatus string
Specifies whether to enable vector engine optimization. Default value: disabled. Valid values: enabled and disabled.
VpcId Changes to this property will trigger replacement. string
The vpc ID of the resource.
ZoneId Changes to this property will trigger replacement. string
The zone ID of the instance.
dbInstanceMode
This property is required.
Changes to this property will trigger replacement.
String
The db instance mode. Valid values: StorageElastic, Serverless, Classic.
engine
This property is required.
Changes to this property will trigger replacement.
String
The database engine used by the instance. Value options can refer to the latest docs CreateDBInstance EngineVersion.
engineVersion
This property is required.
Changes to this property will trigger replacement.
String
The version of the database engine used by the instance.
vswitchId
This property is required.
Changes to this property will trigger replacement.
String
The vswitch id.
availabilityZone Changes to this property will trigger replacement. String
Field availability_zone has been deprecated from provider version 1.187.0. New field zone_id instead.

Deprecated: Field 'availability_zone' has been deprecated from version 1.187.0. Use 'zone_id' instead.

createSampleData Boolean
Whether to load the sample dataset after the instance is created. Valid values: true, false.
dataShareStatus String
Specifies whether to enable or disable data sharing. Default value: closed. Valid values:
dbInstanceCategory Changes to this property will trigger replacement. String

The db instance category. Valid values: Basic, HighAvailability.

NOTE: This parameter must be passed in to create a storage reservation mode instance.

dbInstanceClass String

The db instance class. see Instance specifications.

NOTE: This parameter must be passed in to create a storage reservation mode instance.

description String
The description of the instance.
encryptionKey Changes to this property will trigger replacement. String

The ID of the encryption key.

NOTE: If encryption_type is set to CloudDisk, you must specify an encryption key that resides in the same region as the cloud disk that is specified by EncryptionType. Otherwise, leave this parameter empty.

encryptionType Changes to this property will trigger replacement. String

The encryption type. Valid values: CloudDisk.

NOTE: Disk encryption cannot be disabled after it is enabled.

instanceChargeType Changes to this property will trigger replacement. String
Field instance_charge_type has been deprecated from provider version 1.187.0. New field payment_type instead.

Deprecated: Field instance_charge_type has been deprecated from version 1.187.0. Use payment_type instead.

instanceGroupCount Integer
The number of nodes. Valid values: 2, 4, 8, 12, 16, 24, 32, 64, 96, 128.
instanceNetworkType Changes to this property will trigger replacement. String
The network type of the instance. Valid values: VPC.
instanceSpec String

The specification of segment nodes.

  • When db_instance_category is HighAvailability, Valid values: 2C16G, 4C32G, 16C128G.
  • When db_instance_category is Basic, Valid values: 2C8G, 4C16G, 8C32G, 16C64G.
  • When db_instance_category is Serverless, Valid values: 4C16G, 8C32G.

NOTE: This parameter must be passed to create a storage elastic mode instance and a serverless version instance.

ipWhitelists List<InstanceIpWhitelist>
The ip whitelist. See ip_whitelist below. Default to creating a whitelist group with the group name "default" and security_ip_list "127.0.0.1".
maintainEndTime String
The end time of the maintenance window for the instance. in the format of HH:mmZ (UTC time), for example 03:00Z. start time should be later than end time.
maintainStartTime String
The start time of the maintenance window for the instance. in the format of HH:mmZ (UTC time), for example 02:00Z.
masterCu Integer
The amount of coordinator node resources. Valid values: 2, 4, 8, 16, 32.
masterNodeNum Integer
The number of Master nodes. NOTE: Field master_node_num has been deprecated from provider version 1.213.0.

Deprecated: Field master_node_num has been deprecated from provider version 1.213.0.

parameters List<InstanceParameter>
The parameters. See parameters below.
paymentType Changes to this property will trigger replacement. String
The billing method of the instance. Valid values: Subscription, PayAsYouGo.
period String
The duration that you will buy the resource, in month. required when payment_type is Subscription. Valid values: Year, Month.
privateIpAddress String
The private ip address. NOTE: Field private_ip_address has been deprecated from provider version 1.213.0.

Deprecated: Field private_ip_address has been deprecated from provider version 1.213.0.

prodType Changes to this property will trigger replacement. String
The type of the product. Default value: standard. Valid values: standard, cost-effective.
resourceGroupId String
The ID of the enterprise resource group to which the instance belongs.
resourceManagementMode String
Resource management mode. Valid values: resourceGroup, resourceQueue.
securityIpLists List<String>
Field security_ip_list has been deprecated from provider version 1.187.0. New field ip_whitelist instead.

Deprecated: Field 'security_ip_list' has been deprecated from version 1.187.0. Use 'ip_whitelist' instead.

segDiskPerformanceLevel String
The ESSD cloud disk performance level. Valid values: pl0, pl1, pl2.
segNodeNum Integer

Calculate the number of nodes. Valid values: 2 to 512. The value range of the high-availability version of the storage elastic mode is 4 to 512, and the value must be a multiple of 4. The value range of the basic version of the storage elastic mode is 2 to 512, and the value must be a multiple of 2. The-Serverless version has a value range of 2 to 512. The value must be a multiple of 2.

NOTE: This parameter must be passed in to create a storage elastic mode instance and a Serverless version instance. During the public beta of the Serverless version (from 0101, 2022 to 0131, 2022), a maximum of 12 compute nodes can be created.

segStorageType Changes to this property will trigger replacement. String
The seg storage type. Valid values: cloud_essd. NOTE: If db_instance_mode is set to StorageElastic, seg_storage_type is required. From version 1.233.1, seg_storage_type cannot be modified, or set to cloud_efficiency. seg_storage_type can only be set to cloud_essd.
serverlessMode Changes to this property will trigger replacement. String
The mode of the Serverless instance. Valid values: Manual, Auto. NOTE: serverless_mode is valid only when db_instance_mode is set to Serverless.
sslEnabled Integer
Enable or disable SSL. Valid values: 0 and 1.
storageSize Integer

The storage capacity. Unit: GB. Valid values: 50 to 4000.

NOTE: This parameter must be passed in to create a storage reservation mode instance.

tags Map<String,String>
A mapping of tags to assign to the resource.
usedTime String
The used time. When the parameter period is Year, the used_time value is 1 to 3. When the parameter period is Month, the used_time value is 1 to 9.
vectorConfigurationStatus String
Specifies whether to enable vector engine optimization. Default value: disabled. Valid values: enabled and disabled.
vpcId Changes to this property will trigger replacement. String
The vpc ID of the resource.
zoneId Changes to this property will trigger replacement. String
The zone ID of the instance.
dbInstanceMode
This property is required.
Changes to this property will trigger replacement.
string
The db instance mode. Valid values: StorageElastic, Serverless, Classic.
engine
This property is required.
Changes to this property will trigger replacement.
string
The database engine used by the instance. Value options can refer to the latest docs CreateDBInstance EngineVersion.
engineVersion
This property is required.
Changes to this property will trigger replacement.
string
The version of the database engine used by the instance.
vswitchId
This property is required.
Changes to this property will trigger replacement.
string
The vswitch id.
availabilityZone Changes to this property will trigger replacement. string
Field availability_zone has been deprecated from provider version 1.187.0. New field zone_id instead.

Deprecated: Field 'availability_zone' has been deprecated from version 1.187.0. Use 'zone_id' instead.

createSampleData boolean
Whether to load the sample dataset after the instance is created. Valid values: true, false.
dataShareStatus string
Specifies whether to enable or disable data sharing. Default value: closed. Valid values:
dbInstanceCategory Changes to this property will trigger replacement. string

The db instance category. Valid values: Basic, HighAvailability.

NOTE: This parameter must be passed in to create a storage reservation mode instance.

dbInstanceClass string

The db instance class. see Instance specifications.

NOTE: This parameter must be passed in to create a storage reservation mode instance.

description string
The description of the instance.
encryptionKey Changes to this property will trigger replacement. string

The ID of the encryption key.

NOTE: If encryption_type is set to CloudDisk, you must specify an encryption key that resides in the same region as the cloud disk that is specified by EncryptionType. Otherwise, leave this parameter empty.

encryptionType Changes to this property will trigger replacement. string

The encryption type. Valid values: CloudDisk.

NOTE: Disk encryption cannot be disabled after it is enabled.

instanceChargeType Changes to this property will trigger replacement. string
Field instance_charge_type has been deprecated from provider version 1.187.0. New field payment_type instead.

Deprecated: Field instance_charge_type has been deprecated from version 1.187.0. Use payment_type instead.

instanceGroupCount number
The number of nodes. Valid values: 2, 4, 8, 12, 16, 24, 32, 64, 96, 128.
instanceNetworkType Changes to this property will trigger replacement. string
The network type of the instance. Valid values: VPC.
instanceSpec string

The specification of segment nodes.

  • When db_instance_category is HighAvailability, Valid values: 2C16G, 4C32G, 16C128G.
  • When db_instance_category is Basic, Valid values: 2C8G, 4C16G, 8C32G, 16C64G.
  • When db_instance_category is Serverless, Valid values: 4C16G, 8C32G.

NOTE: This parameter must be passed to create a storage elastic mode instance and a serverless version instance.

ipWhitelists InstanceIpWhitelist[]
The ip whitelist. See ip_whitelist below. Default to creating a whitelist group with the group name "default" and security_ip_list "127.0.0.1".
maintainEndTime string
The end time of the maintenance window for the instance. in the format of HH:mmZ (UTC time), for example 03:00Z. start time should be later than end time.
maintainStartTime string
The start time of the maintenance window for the instance. in the format of HH:mmZ (UTC time), for example 02:00Z.
masterCu number
The amount of coordinator node resources. Valid values: 2, 4, 8, 16, 32.
masterNodeNum number
The number of Master nodes. NOTE: Field master_node_num has been deprecated from provider version 1.213.0.

Deprecated: Field master_node_num has been deprecated from provider version 1.213.0.

parameters InstanceParameter[]
The parameters. See parameters below.
paymentType Changes to this property will trigger replacement. string
The billing method of the instance. Valid values: Subscription, PayAsYouGo.
period string
The duration that you will buy the resource, in month. required when payment_type is Subscription. Valid values: Year, Month.
privateIpAddress string
The private ip address. NOTE: Field private_ip_address has been deprecated from provider version 1.213.0.

Deprecated: Field private_ip_address has been deprecated from provider version 1.213.0.

prodType Changes to this property will trigger replacement. string
The type of the product. Default value: standard. Valid values: standard, cost-effective.
resourceGroupId string
The ID of the enterprise resource group to which the instance belongs.
resourceManagementMode string
Resource management mode. Valid values: resourceGroup, resourceQueue.
securityIpLists string[]
Field security_ip_list has been deprecated from provider version 1.187.0. New field ip_whitelist instead.

Deprecated: Field 'security_ip_list' has been deprecated from version 1.187.0. Use 'ip_whitelist' instead.

segDiskPerformanceLevel string
The ESSD cloud disk performance level. Valid values: pl0, pl1, pl2.
segNodeNum number

Calculate the number of nodes. Valid values: 2 to 512. The value range of the high-availability version of the storage elastic mode is 4 to 512, and the value must be a multiple of 4. The value range of the basic version of the storage elastic mode is 2 to 512, and the value must be a multiple of 2. The-Serverless version has a value range of 2 to 512. The value must be a multiple of 2.

NOTE: This parameter must be passed in to create a storage elastic mode instance and a Serverless version instance. During the public beta of the Serverless version (from 0101, 2022 to 0131, 2022), a maximum of 12 compute nodes can be created.

segStorageType Changes to this property will trigger replacement. string
The seg storage type. Valid values: cloud_essd. NOTE: If db_instance_mode is set to StorageElastic, seg_storage_type is required. From version 1.233.1, seg_storage_type cannot be modified, or set to cloud_efficiency. seg_storage_type can only be set to cloud_essd.
serverlessMode Changes to this property will trigger replacement. string
The mode of the Serverless instance. Valid values: Manual, Auto. NOTE: serverless_mode is valid only when db_instance_mode is set to Serverless.
sslEnabled number
Enable or disable SSL. Valid values: 0 and 1.
storageSize number

The storage capacity. Unit: GB. Valid values: 50 to 4000.

NOTE: This parameter must be passed in to create a storage reservation mode instance.

tags {[key: string]: string}
A mapping of tags to assign to the resource.
usedTime string
The used time. When the parameter period is Year, the used_time value is 1 to 3. When the parameter period is Month, the used_time value is 1 to 9.
vectorConfigurationStatus string
Specifies whether to enable vector engine optimization. Default value: disabled. Valid values: enabled and disabled.
vpcId Changes to this property will trigger replacement. string
The vpc ID of the resource.
zoneId Changes to this property will trigger replacement. string
The zone ID of the instance.
db_instance_mode
This property is required.
Changes to this property will trigger replacement.
str
The db instance mode. Valid values: StorageElastic, Serverless, Classic.
engine
This property is required.
Changes to this property will trigger replacement.
str
The database engine used by the instance. Value options can refer to the latest docs CreateDBInstance EngineVersion.
engine_version
This property is required.
Changes to this property will trigger replacement.
str
The version of the database engine used by the instance.
vswitch_id
This property is required.
Changes to this property will trigger replacement.
str
The vswitch id.
availability_zone Changes to this property will trigger replacement. str
Field availability_zone has been deprecated from provider version 1.187.0. New field zone_id instead.

Deprecated: Field 'availability_zone' has been deprecated from version 1.187.0. Use 'zone_id' instead.

create_sample_data bool
Whether to load the sample dataset after the instance is created. Valid values: true, false.
data_share_status str
Specifies whether to enable or disable data sharing. Default value: closed. Valid values:
db_instance_category Changes to this property will trigger replacement. str

The db instance category. Valid values: Basic, HighAvailability.

NOTE: This parameter must be passed in to create a storage reservation mode instance.

db_instance_class str

The db instance class. see Instance specifications.

NOTE: This parameter must be passed in to create a storage reservation mode instance.

description str
The description of the instance.
encryption_key Changes to this property will trigger replacement. str

The ID of the encryption key.

NOTE: If encryption_type is set to CloudDisk, you must specify an encryption key that resides in the same region as the cloud disk that is specified by EncryptionType. Otherwise, leave this parameter empty.

encryption_type Changes to this property will trigger replacement. str

The encryption type. Valid values: CloudDisk.

NOTE: Disk encryption cannot be disabled after it is enabled.

instance_charge_type Changes to this property will trigger replacement. str
Field instance_charge_type has been deprecated from provider version 1.187.0. New field payment_type instead.

Deprecated: Field instance_charge_type has been deprecated from version 1.187.0. Use payment_type instead.

instance_group_count int
The number of nodes. Valid values: 2, 4, 8, 12, 16, 24, 32, 64, 96, 128.
instance_network_type Changes to this property will trigger replacement. str
The network type of the instance. Valid values: VPC.
instance_spec str

The specification of segment nodes.

  • When db_instance_category is HighAvailability, Valid values: 2C16G, 4C32G, 16C128G.
  • When db_instance_category is Basic, Valid values: 2C8G, 4C16G, 8C32G, 16C64G.
  • When db_instance_category is Serverless, Valid values: 4C16G, 8C32G.

NOTE: This parameter must be passed to create a storage elastic mode instance and a serverless version instance.

ip_whitelists Sequence[InstanceIpWhitelistArgs]
The ip whitelist. See ip_whitelist below. Default to creating a whitelist group with the group name "default" and security_ip_list "127.0.0.1".
maintain_end_time str
The end time of the maintenance window for the instance. in the format of HH:mmZ (UTC time), for example 03:00Z. start time should be later than end time.
maintain_start_time str
The start time of the maintenance window for the instance. in the format of HH:mmZ (UTC time), for example 02:00Z.
master_cu int
The amount of coordinator node resources. Valid values: 2, 4, 8, 16, 32.
master_node_num int
The number of Master nodes. NOTE: Field master_node_num has been deprecated from provider version 1.213.0.

Deprecated: Field master_node_num has been deprecated from provider version 1.213.0.

parameters Sequence[InstanceParameterArgs]
The parameters. See parameters below.
payment_type Changes to this property will trigger replacement. str
The billing method of the instance. Valid values: Subscription, PayAsYouGo.
period str
The duration that you will buy the resource, in month. required when payment_type is Subscription. Valid values: Year, Month.
private_ip_address str
The private ip address. NOTE: Field private_ip_address has been deprecated from provider version 1.213.0.

Deprecated: Field private_ip_address has been deprecated from provider version 1.213.0.

prod_type Changes to this property will trigger replacement. str
The type of the product. Default value: standard. Valid values: standard, cost-effective.
resource_group_id str
The ID of the enterprise resource group to which the instance belongs.
resource_management_mode str
Resource management mode. Valid values: resourceGroup, resourceQueue.
security_ip_lists Sequence[str]
Field security_ip_list has been deprecated from provider version 1.187.0. New field ip_whitelist instead.

Deprecated: Field 'security_ip_list' has been deprecated from version 1.187.0. Use 'ip_whitelist' instead.

seg_disk_performance_level str
The ESSD cloud disk performance level. Valid values: pl0, pl1, pl2.
seg_node_num int

Calculate the number of nodes. Valid values: 2 to 512. The value range of the high-availability version of the storage elastic mode is 4 to 512, and the value must be a multiple of 4. The value range of the basic version of the storage elastic mode is 2 to 512, and the value must be a multiple of 2. The-Serverless version has a value range of 2 to 512. The value must be a multiple of 2.

NOTE: This parameter must be passed in to create a storage elastic mode instance and a Serverless version instance. During the public beta of the Serverless version (from 0101, 2022 to 0131, 2022), a maximum of 12 compute nodes can be created.

seg_storage_type Changes to this property will trigger replacement. str
The seg storage type. Valid values: cloud_essd. NOTE: If db_instance_mode is set to StorageElastic, seg_storage_type is required. From version 1.233.1, seg_storage_type cannot be modified, or set to cloud_efficiency. seg_storage_type can only be set to cloud_essd.
serverless_mode Changes to this property will trigger replacement. str
The mode of the Serverless instance. Valid values: Manual, Auto. NOTE: serverless_mode is valid only when db_instance_mode is set to Serverless.
ssl_enabled int
Enable or disable SSL. Valid values: 0 and 1.
storage_size int

The storage capacity. Unit: GB. Valid values: 50 to 4000.

NOTE: This parameter must be passed in to create a storage reservation mode instance.

tags Mapping[str, str]
A mapping of tags to assign to the resource.
used_time str
The used time. When the parameter period is Year, the used_time value is 1 to 3. When the parameter period is Month, the used_time value is 1 to 9.
vector_configuration_status str
Specifies whether to enable vector engine optimization. Default value: disabled. Valid values: enabled and disabled.
vpc_id Changes to this property will trigger replacement. str
The vpc ID of the resource.
zone_id Changes to this property will trigger replacement. str
The zone ID of the instance.
dbInstanceMode
This property is required.
Changes to this property will trigger replacement.
String
The db instance mode. Valid values: StorageElastic, Serverless, Classic.
engine
This property is required.
Changes to this property will trigger replacement.
String
The database engine used by the instance. Value options can refer to the latest docs CreateDBInstance EngineVersion.
engineVersion
This property is required.
Changes to this property will trigger replacement.
String
The version of the database engine used by the instance.
vswitchId
This property is required.
Changes to this property will trigger replacement.
String
The vswitch id.
availabilityZone Changes to this property will trigger replacement. String
Field availability_zone has been deprecated from provider version 1.187.0. New field zone_id instead.

Deprecated: Field 'availability_zone' has been deprecated from version 1.187.0. Use 'zone_id' instead.

createSampleData Boolean
Whether to load the sample dataset after the instance is created. Valid values: true, false.
dataShareStatus String
Specifies whether to enable or disable data sharing. Default value: closed. Valid values:
dbInstanceCategory Changes to this property will trigger replacement. String

The db instance category. Valid values: Basic, HighAvailability.

NOTE: This parameter must be passed in to create a storage reservation mode instance.

dbInstanceClass String

The db instance class. see Instance specifications.

NOTE: This parameter must be passed in to create a storage reservation mode instance.

description String
The description of the instance.
encryptionKey Changes to this property will trigger replacement. String

The ID of the encryption key.

NOTE: If encryption_type is set to CloudDisk, you must specify an encryption key that resides in the same region as the cloud disk that is specified by EncryptionType. Otherwise, leave this parameter empty.

encryptionType Changes to this property will trigger replacement. String

The encryption type. Valid values: CloudDisk.

NOTE: Disk encryption cannot be disabled after it is enabled.

instanceChargeType Changes to this property will trigger replacement. String
Field instance_charge_type has been deprecated from provider version 1.187.0. New field payment_type instead.

Deprecated: Field instance_charge_type has been deprecated from version 1.187.0. Use payment_type instead.

instanceGroupCount Number
The number of nodes. Valid values: 2, 4, 8, 12, 16, 24, 32, 64, 96, 128.
instanceNetworkType Changes to this property will trigger replacement. String
The network type of the instance. Valid values: VPC.
instanceSpec String

The specification of segment nodes.

  • When db_instance_category is HighAvailability, Valid values: 2C16G, 4C32G, 16C128G.
  • When db_instance_category is Basic, Valid values: 2C8G, 4C16G, 8C32G, 16C64G.
  • When db_instance_category is Serverless, Valid values: 4C16G, 8C32G.

NOTE: This parameter must be passed to create a storage elastic mode instance and a serverless version instance.

ipWhitelists List<Property Map>
The ip whitelist. See ip_whitelist below. Default to creating a whitelist group with the group name "default" and security_ip_list "127.0.0.1".
maintainEndTime String
The end time of the maintenance window for the instance. in the format of HH:mmZ (UTC time), for example 03:00Z. start time should be later than end time.
maintainStartTime String
The start time of the maintenance window for the instance. in the format of HH:mmZ (UTC time), for example 02:00Z.
masterCu Number
The amount of coordinator node resources. Valid values: 2, 4, 8, 16, 32.
masterNodeNum Number
The number of Master nodes. NOTE: Field master_node_num has been deprecated from provider version 1.213.0.

Deprecated: Field master_node_num has been deprecated from provider version 1.213.0.

parameters List<Property Map>
The parameters. See parameters below.
paymentType Changes to this property will trigger replacement. String
The billing method of the instance. Valid values: Subscription, PayAsYouGo.
period String
The duration that you will buy the resource, in month. required when payment_type is Subscription. Valid values: Year, Month.
privateIpAddress String
The private ip address. NOTE: Field private_ip_address has been deprecated from provider version 1.213.0.

Deprecated: Field private_ip_address has been deprecated from provider version 1.213.0.

prodType Changes to this property will trigger replacement. String
The type of the product. Default value: standard. Valid values: standard, cost-effective.
resourceGroupId String
The ID of the enterprise resource group to which the instance belongs.
resourceManagementMode String
Resource management mode. Valid values: resourceGroup, resourceQueue.
securityIpLists List<String>
Field security_ip_list has been deprecated from provider version 1.187.0. New field ip_whitelist instead.

Deprecated: Field 'security_ip_list' has been deprecated from version 1.187.0. Use 'ip_whitelist' instead.

segDiskPerformanceLevel String
The ESSD cloud disk performance level. Valid values: pl0, pl1, pl2.
segNodeNum Number

Calculate the number of nodes. Valid values: 2 to 512. The value range of the high-availability version of the storage elastic mode is 4 to 512, and the value must be a multiple of 4. The value range of the basic version of the storage elastic mode is 2 to 512, and the value must be a multiple of 2. The-Serverless version has a value range of 2 to 512. The value must be a multiple of 2.

NOTE: This parameter must be passed in to create a storage elastic mode instance and a Serverless version instance. During the public beta of the Serverless version (from 0101, 2022 to 0131, 2022), a maximum of 12 compute nodes can be created.

segStorageType Changes to this property will trigger replacement. String
The seg storage type. Valid values: cloud_essd. NOTE: If db_instance_mode is set to StorageElastic, seg_storage_type is required. From version 1.233.1, seg_storage_type cannot be modified, or set to cloud_efficiency. seg_storage_type can only be set to cloud_essd.
serverlessMode Changes to this property will trigger replacement. String
The mode of the Serverless instance. Valid values: Manual, Auto. NOTE: serverless_mode is valid only when db_instance_mode is set to Serverless.
sslEnabled Number
Enable or disable SSL. Valid values: 0 and 1.
storageSize Number

The storage capacity. Unit: GB. Valid values: 50 to 4000.

NOTE: This parameter must be passed in to create a storage reservation mode instance.

tags Map<String>
A mapping of tags to assign to the resource.
usedTime String
The used time. When the parameter period is Year, the used_time value is 1 to 3. When the parameter period is Month, the used_time value is 1 to 9.
vectorConfigurationStatus String
Specifies whether to enable vector engine optimization. Default value: disabled. Valid values: enabled and disabled.
vpcId Changes to this property will trigger replacement. String
The vpc ID of the resource.
zoneId Changes to this property will trigger replacement. String
The zone ID of the instance.

Outputs

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

ConnectionString string
(Available since v1.196.0) The connection string of the instance.
Id string
The provider-assigned unique ID for this managed resource.
Port string
(Available since v1.196.0) The connection port of the instance.
Status string
The status of the instance.
ConnectionString string
(Available since v1.196.0) The connection string of the instance.
Id string
The provider-assigned unique ID for this managed resource.
Port string
(Available since v1.196.0) The connection port of the instance.
Status string
The status of the instance.
connectionString String
(Available since v1.196.0) The connection string of the instance.
id String
The provider-assigned unique ID for this managed resource.
port String
(Available since v1.196.0) The connection port of the instance.
status String
The status of the instance.
connectionString string
(Available since v1.196.0) The connection string of the instance.
id string
The provider-assigned unique ID for this managed resource.
port string
(Available since v1.196.0) The connection port of the instance.
status string
The status of the instance.
connection_string str
(Available since v1.196.0) The connection string of the instance.
id str
The provider-assigned unique ID for this managed resource.
port str
(Available since v1.196.0) The connection port of the instance.
status str
The status of the instance.
connectionString String
(Available since v1.196.0) The connection string of the instance.
id String
The provider-assigned unique ID for this managed resource.
port String
(Available since v1.196.0) The connection port of the instance.
status String
The status of the instance.

Look up Existing Instance Resource

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

public static get(name: string, id: Input<ID>, state?: InstanceState, opts?: CustomResourceOptions): Instance
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        availability_zone: Optional[str] = None,
        connection_string: Optional[str] = None,
        create_sample_data: Optional[bool] = None,
        data_share_status: Optional[str] = None,
        db_instance_category: Optional[str] = None,
        db_instance_class: Optional[str] = None,
        db_instance_mode: Optional[str] = None,
        description: Optional[str] = None,
        encryption_key: Optional[str] = None,
        encryption_type: Optional[str] = None,
        engine: Optional[str] = None,
        engine_version: Optional[str] = None,
        instance_charge_type: Optional[str] = None,
        instance_group_count: Optional[int] = None,
        instance_network_type: Optional[str] = None,
        instance_spec: Optional[str] = None,
        ip_whitelists: Optional[Sequence[InstanceIpWhitelistArgs]] = None,
        maintain_end_time: Optional[str] = None,
        maintain_start_time: Optional[str] = None,
        master_cu: Optional[int] = None,
        master_node_num: Optional[int] = None,
        parameters: Optional[Sequence[InstanceParameterArgs]] = None,
        payment_type: Optional[str] = None,
        period: Optional[str] = None,
        port: Optional[str] = None,
        private_ip_address: Optional[str] = None,
        prod_type: Optional[str] = None,
        resource_group_id: Optional[str] = None,
        resource_management_mode: Optional[str] = None,
        security_ip_lists: Optional[Sequence[str]] = None,
        seg_disk_performance_level: Optional[str] = None,
        seg_node_num: Optional[int] = None,
        seg_storage_type: Optional[str] = None,
        serverless_mode: Optional[str] = None,
        ssl_enabled: Optional[int] = None,
        status: Optional[str] = None,
        storage_size: Optional[int] = None,
        tags: Optional[Mapping[str, str]] = None,
        used_time: Optional[str] = None,
        vector_configuration_status: Optional[str] = None,
        vpc_id: Optional[str] = None,
        vswitch_id: Optional[str] = None,
        zone_id: Optional[str] = None) -> Instance
func GetInstance(ctx *Context, name string, id IDInput, state *InstanceState, opts ...ResourceOption) (*Instance, error)
public static Instance Get(string name, Input<string> id, InstanceState? state, CustomResourceOptions? opts = null)
public static Instance get(String name, Output<String> id, InstanceState state, CustomResourceOptions options)
resources:  _:    type: alicloud:gpdb:Instance    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:
AvailabilityZone Changes to this property will trigger replacement. string
Field availability_zone has been deprecated from provider version 1.187.0. New field zone_id instead.

Deprecated: Field 'availability_zone' has been deprecated from version 1.187.0. Use 'zone_id' instead.

ConnectionString string
(Available since v1.196.0) The connection string of the instance.
CreateSampleData bool
Whether to load the sample dataset after the instance is created. Valid values: true, false.
DataShareStatus string
Specifies whether to enable or disable data sharing. Default value: closed. Valid values:
DbInstanceCategory Changes to this property will trigger replacement. string

The db instance category. Valid values: Basic, HighAvailability.

NOTE: This parameter must be passed in to create a storage reservation mode instance.

DbInstanceClass string

The db instance class. see Instance specifications.

NOTE: This parameter must be passed in to create a storage reservation mode instance.

DbInstanceMode Changes to this property will trigger replacement. string
The db instance mode. Valid values: StorageElastic, Serverless, Classic.
Description string
The description of the instance.
EncryptionKey Changes to this property will trigger replacement. string

The ID of the encryption key.

NOTE: If encryption_type is set to CloudDisk, you must specify an encryption key that resides in the same region as the cloud disk that is specified by EncryptionType. Otherwise, leave this parameter empty.

EncryptionType Changes to this property will trigger replacement. string

The encryption type. Valid values: CloudDisk.

NOTE: Disk encryption cannot be disabled after it is enabled.

Engine Changes to this property will trigger replacement. string
The database engine used by the instance. Value options can refer to the latest docs CreateDBInstance EngineVersion.
EngineVersion Changes to this property will trigger replacement. string
The version of the database engine used by the instance.
InstanceChargeType Changes to this property will trigger replacement. string
Field instance_charge_type has been deprecated from provider version 1.187.0. New field payment_type instead.

Deprecated: Field instance_charge_type has been deprecated from version 1.187.0. Use payment_type instead.

InstanceGroupCount int
The number of nodes. Valid values: 2, 4, 8, 12, 16, 24, 32, 64, 96, 128.
InstanceNetworkType Changes to this property will trigger replacement. string
The network type of the instance. Valid values: VPC.
InstanceSpec string

The specification of segment nodes.

  • When db_instance_category is HighAvailability, Valid values: 2C16G, 4C32G, 16C128G.
  • When db_instance_category is Basic, Valid values: 2C8G, 4C16G, 8C32G, 16C64G.
  • When db_instance_category is Serverless, Valid values: 4C16G, 8C32G.

NOTE: This parameter must be passed to create a storage elastic mode instance and a serverless version instance.

IpWhitelists List<Pulumi.AliCloud.Gpdb.Inputs.InstanceIpWhitelist>
The ip whitelist. See ip_whitelist below. Default to creating a whitelist group with the group name "default" and security_ip_list "127.0.0.1".
MaintainEndTime string
The end time of the maintenance window for the instance. in the format of HH:mmZ (UTC time), for example 03:00Z. start time should be later than end time.
MaintainStartTime string
The start time of the maintenance window for the instance. in the format of HH:mmZ (UTC time), for example 02:00Z.
MasterCu int
The amount of coordinator node resources. Valid values: 2, 4, 8, 16, 32.
MasterNodeNum int
The number of Master nodes. NOTE: Field master_node_num has been deprecated from provider version 1.213.0.

Deprecated: Field master_node_num has been deprecated from provider version 1.213.0.

Parameters List<Pulumi.AliCloud.Gpdb.Inputs.InstanceParameter>
The parameters. See parameters below.
PaymentType Changes to this property will trigger replacement. string
The billing method of the instance. Valid values: Subscription, PayAsYouGo.
Period string
The duration that you will buy the resource, in month. required when payment_type is Subscription. Valid values: Year, Month.
Port string
(Available since v1.196.0) The connection port of the instance.
PrivateIpAddress string
The private ip address. NOTE: Field private_ip_address has been deprecated from provider version 1.213.0.

Deprecated: Field private_ip_address has been deprecated from provider version 1.213.0.

ProdType Changes to this property will trigger replacement. string
The type of the product. Default value: standard. Valid values: standard, cost-effective.
ResourceGroupId string
The ID of the enterprise resource group to which the instance belongs.
ResourceManagementMode string
Resource management mode. Valid values: resourceGroup, resourceQueue.
SecurityIpLists List<string>
Field security_ip_list has been deprecated from provider version 1.187.0. New field ip_whitelist instead.

Deprecated: Field 'security_ip_list' has been deprecated from version 1.187.0. Use 'ip_whitelist' instead.

SegDiskPerformanceLevel string
The ESSD cloud disk performance level. Valid values: pl0, pl1, pl2.
SegNodeNum int

Calculate the number of nodes. Valid values: 2 to 512. The value range of the high-availability version of the storage elastic mode is 4 to 512, and the value must be a multiple of 4. The value range of the basic version of the storage elastic mode is 2 to 512, and the value must be a multiple of 2. The-Serverless version has a value range of 2 to 512. The value must be a multiple of 2.

NOTE: This parameter must be passed in to create a storage elastic mode instance and a Serverless version instance. During the public beta of the Serverless version (from 0101, 2022 to 0131, 2022), a maximum of 12 compute nodes can be created.

SegStorageType Changes to this property will trigger replacement. string
The seg storage type. Valid values: cloud_essd. NOTE: If db_instance_mode is set to StorageElastic, seg_storage_type is required. From version 1.233.1, seg_storage_type cannot be modified, or set to cloud_efficiency. seg_storage_type can only be set to cloud_essd.
ServerlessMode Changes to this property will trigger replacement. string
The mode of the Serverless instance. Valid values: Manual, Auto. NOTE: serverless_mode is valid only when db_instance_mode is set to Serverless.
SslEnabled int
Enable or disable SSL. Valid values: 0 and 1.
Status string
The status of the instance.
StorageSize int

The storage capacity. Unit: GB. Valid values: 50 to 4000.

NOTE: This parameter must be passed in to create a storage reservation mode instance.

Tags Dictionary<string, string>
A mapping of tags to assign to the resource.
UsedTime string
The used time. When the parameter period is Year, the used_time value is 1 to 3. When the parameter period is Month, the used_time value is 1 to 9.
VectorConfigurationStatus string
Specifies whether to enable vector engine optimization. Default value: disabled. Valid values: enabled and disabled.
VpcId Changes to this property will trigger replacement. string
The vpc ID of the resource.
VswitchId Changes to this property will trigger replacement. string
The vswitch id.
ZoneId Changes to this property will trigger replacement. string
The zone ID of the instance.
AvailabilityZone Changes to this property will trigger replacement. string
Field availability_zone has been deprecated from provider version 1.187.0. New field zone_id instead.

Deprecated: Field 'availability_zone' has been deprecated from version 1.187.0. Use 'zone_id' instead.

ConnectionString string
(Available since v1.196.0) The connection string of the instance.
CreateSampleData bool
Whether to load the sample dataset after the instance is created. Valid values: true, false.
DataShareStatus string
Specifies whether to enable or disable data sharing. Default value: closed. Valid values:
DbInstanceCategory Changes to this property will trigger replacement. string

The db instance category. Valid values: Basic, HighAvailability.

NOTE: This parameter must be passed in to create a storage reservation mode instance.

DbInstanceClass string

The db instance class. see Instance specifications.

NOTE: This parameter must be passed in to create a storage reservation mode instance.

DbInstanceMode Changes to this property will trigger replacement. string
The db instance mode. Valid values: StorageElastic, Serverless, Classic.
Description string
The description of the instance.
EncryptionKey Changes to this property will trigger replacement. string

The ID of the encryption key.

NOTE: If encryption_type is set to CloudDisk, you must specify an encryption key that resides in the same region as the cloud disk that is specified by EncryptionType. Otherwise, leave this parameter empty.

EncryptionType Changes to this property will trigger replacement. string

The encryption type. Valid values: CloudDisk.

NOTE: Disk encryption cannot be disabled after it is enabled.

Engine Changes to this property will trigger replacement. string
The database engine used by the instance. Value options can refer to the latest docs CreateDBInstance EngineVersion.
EngineVersion Changes to this property will trigger replacement. string
The version of the database engine used by the instance.
InstanceChargeType Changes to this property will trigger replacement. string
Field instance_charge_type has been deprecated from provider version 1.187.0. New field payment_type instead.

Deprecated: Field instance_charge_type has been deprecated from version 1.187.0. Use payment_type instead.

InstanceGroupCount int
The number of nodes. Valid values: 2, 4, 8, 12, 16, 24, 32, 64, 96, 128.
InstanceNetworkType Changes to this property will trigger replacement. string
The network type of the instance. Valid values: VPC.
InstanceSpec string

The specification of segment nodes.

  • When db_instance_category is HighAvailability, Valid values: 2C16G, 4C32G, 16C128G.
  • When db_instance_category is Basic, Valid values: 2C8G, 4C16G, 8C32G, 16C64G.
  • When db_instance_category is Serverless, Valid values: 4C16G, 8C32G.

NOTE: This parameter must be passed to create a storage elastic mode instance and a serverless version instance.

IpWhitelists []InstanceIpWhitelistArgs
The ip whitelist. See ip_whitelist below. Default to creating a whitelist group with the group name "default" and security_ip_list "127.0.0.1".
MaintainEndTime string
The end time of the maintenance window for the instance. in the format of HH:mmZ (UTC time), for example 03:00Z. start time should be later than end time.
MaintainStartTime string
The start time of the maintenance window for the instance. in the format of HH:mmZ (UTC time), for example 02:00Z.
MasterCu int
The amount of coordinator node resources. Valid values: 2, 4, 8, 16, 32.
MasterNodeNum int
The number of Master nodes. NOTE: Field master_node_num has been deprecated from provider version 1.213.0.

Deprecated: Field master_node_num has been deprecated from provider version 1.213.0.

Parameters []InstanceParameterArgs
The parameters. See parameters below.
PaymentType Changes to this property will trigger replacement. string
The billing method of the instance. Valid values: Subscription, PayAsYouGo.
Period string
The duration that you will buy the resource, in month. required when payment_type is Subscription. Valid values: Year, Month.
Port string
(Available since v1.196.0) The connection port of the instance.
PrivateIpAddress string
The private ip address. NOTE: Field private_ip_address has been deprecated from provider version 1.213.0.

Deprecated: Field private_ip_address has been deprecated from provider version 1.213.0.

ProdType Changes to this property will trigger replacement. string
The type of the product. Default value: standard. Valid values: standard, cost-effective.
ResourceGroupId string
The ID of the enterprise resource group to which the instance belongs.
ResourceManagementMode string
Resource management mode. Valid values: resourceGroup, resourceQueue.
SecurityIpLists []string
Field security_ip_list has been deprecated from provider version 1.187.0. New field ip_whitelist instead.

Deprecated: Field 'security_ip_list' has been deprecated from version 1.187.0. Use 'ip_whitelist' instead.

SegDiskPerformanceLevel string
The ESSD cloud disk performance level. Valid values: pl0, pl1, pl2.
SegNodeNum int

Calculate the number of nodes. Valid values: 2 to 512. The value range of the high-availability version of the storage elastic mode is 4 to 512, and the value must be a multiple of 4. The value range of the basic version of the storage elastic mode is 2 to 512, and the value must be a multiple of 2. The-Serverless version has a value range of 2 to 512. The value must be a multiple of 2.

NOTE: This parameter must be passed in to create a storage elastic mode instance and a Serverless version instance. During the public beta of the Serverless version (from 0101, 2022 to 0131, 2022), a maximum of 12 compute nodes can be created.

SegStorageType Changes to this property will trigger replacement. string
The seg storage type. Valid values: cloud_essd. NOTE: If db_instance_mode is set to StorageElastic, seg_storage_type is required. From version 1.233.1, seg_storage_type cannot be modified, or set to cloud_efficiency. seg_storage_type can only be set to cloud_essd.
ServerlessMode Changes to this property will trigger replacement. string
The mode of the Serverless instance. Valid values: Manual, Auto. NOTE: serverless_mode is valid only when db_instance_mode is set to Serverless.
SslEnabled int
Enable or disable SSL. Valid values: 0 and 1.
Status string
The status of the instance.
StorageSize int

The storage capacity. Unit: GB. Valid values: 50 to 4000.

NOTE: This parameter must be passed in to create a storage reservation mode instance.

Tags map[string]string
A mapping of tags to assign to the resource.
UsedTime string
The used time. When the parameter period is Year, the used_time value is 1 to 3. When the parameter period is Month, the used_time value is 1 to 9.
VectorConfigurationStatus string
Specifies whether to enable vector engine optimization. Default value: disabled. Valid values: enabled and disabled.
VpcId Changes to this property will trigger replacement. string
The vpc ID of the resource.
VswitchId Changes to this property will trigger replacement. string
The vswitch id.
ZoneId Changes to this property will trigger replacement. string
The zone ID of the instance.
availabilityZone Changes to this property will trigger replacement. String
Field availability_zone has been deprecated from provider version 1.187.0. New field zone_id instead.

Deprecated: Field 'availability_zone' has been deprecated from version 1.187.0. Use 'zone_id' instead.

connectionString String
(Available since v1.196.0) The connection string of the instance.
createSampleData Boolean
Whether to load the sample dataset after the instance is created. Valid values: true, false.
dataShareStatus String
Specifies whether to enable or disable data sharing. Default value: closed. Valid values:
dbInstanceCategory Changes to this property will trigger replacement. String

The db instance category. Valid values: Basic, HighAvailability.

NOTE: This parameter must be passed in to create a storage reservation mode instance.

dbInstanceClass String

The db instance class. see Instance specifications.

NOTE: This parameter must be passed in to create a storage reservation mode instance.

dbInstanceMode Changes to this property will trigger replacement. String
The db instance mode. Valid values: StorageElastic, Serverless, Classic.
description String
The description of the instance.
encryptionKey Changes to this property will trigger replacement. String

The ID of the encryption key.

NOTE: If encryption_type is set to CloudDisk, you must specify an encryption key that resides in the same region as the cloud disk that is specified by EncryptionType. Otherwise, leave this parameter empty.

encryptionType Changes to this property will trigger replacement. String

The encryption type. Valid values: CloudDisk.

NOTE: Disk encryption cannot be disabled after it is enabled.

engine Changes to this property will trigger replacement. String
The database engine used by the instance. Value options can refer to the latest docs CreateDBInstance EngineVersion.
engineVersion Changes to this property will trigger replacement. String
The version of the database engine used by the instance.
instanceChargeType Changes to this property will trigger replacement. String
Field instance_charge_type has been deprecated from provider version 1.187.0. New field payment_type instead.

Deprecated: Field instance_charge_type has been deprecated from version 1.187.0. Use payment_type instead.

instanceGroupCount Integer
The number of nodes. Valid values: 2, 4, 8, 12, 16, 24, 32, 64, 96, 128.
instanceNetworkType Changes to this property will trigger replacement. String
The network type of the instance. Valid values: VPC.
instanceSpec String

The specification of segment nodes.

  • When db_instance_category is HighAvailability, Valid values: 2C16G, 4C32G, 16C128G.
  • When db_instance_category is Basic, Valid values: 2C8G, 4C16G, 8C32G, 16C64G.
  • When db_instance_category is Serverless, Valid values: 4C16G, 8C32G.

NOTE: This parameter must be passed to create a storage elastic mode instance and a serverless version instance.

ipWhitelists List<InstanceIpWhitelist>
The ip whitelist. See ip_whitelist below. Default to creating a whitelist group with the group name "default" and security_ip_list "127.0.0.1".
maintainEndTime String
The end time of the maintenance window for the instance. in the format of HH:mmZ (UTC time), for example 03:00Z. start time should be later than end time.
maintainStartTime String
The start time of the maintenance window for the instance. in the format of HH:mmZ (UTC time), for example 02:00Z.
masterCu Integer
The amount of coordinator node resources. Valid values: 2, 4, 8, 16, 32.
masterNodeNum Integer
The number of Master nodes. NOTE: Field master_node_num has been deprecated from provider version 1.213.0.

Deprecated: Field master_node_num has been deprecated from provider version 1.213.0.

parameters List<InstanceParameter>
The parameters. See parameters below.
paymentType Changes to this property will trigger replacement. String
The billing method of the instance. Valid values: Subscription, PayAsYouGo.
period String
The duration that you will buy the resource, in month. required when payment_type is Subscription. Valid values: Year, Month.
port String
(Available since v1.196.0) The connection port of the instance.
privateIpAddress String
The private ip address. NOTE: Field private_ip_address has been deprecated from provider version 1.213.0.

Deprecated: Field private_ip_address has been deprecated from provider version 1.213.0.

prodType Changes to this property will trigger replacement. String
The type of the product. Default value: standard. Valid values: standard, cost-effective.
resourceGroupId String
The ID of the enterprise resource group to which the instance belongs.
resourceManagementMode String
Resource management mode. Valid values: resourceGroup, resourceQueue.
securityIpLists List<String>
Field security_ip_list has been deprecated from provider version 1.187.0. New field ip_whitelist instead.

Deprecated: Field 'security_ip_list' has been deprecated from version 1.187.0. Use 'ip_whitelist' instead.

segDiskPerformanceLevel String
The ESSD cloud disk performance level. Valid values: pl0, pl1, pl2.
segNodeNum Integer

Calculate the number of nodes. Valid values: 2 to 512. The value range of the high-availability version of the storage elastic mode is 4 to 512, and the value must be a multiple of 4. The value range of the basic version of the storage elastic mode is 2 to 512, and the value must be a multiple of 2. The-Serverless version has a value range of 2 to 512. The value must be a multiple of 2.

NOTE: This parameter must be passed in to create a storage elastic mode instance and a Serverless version instance. During the public beta of the Serverless version (from 0101, 2022 to 0131, 2022), a maximum of 12 compute nodes can be created.

segStorageType Changes to this property will trigger replacement. String
The seg storage type. Valid values: cloud_essd. NOTE: If db_instance_mode is set to StorageElastic, seg_storage_type is required. From version 1.233.1, seg_storage_type cannot be modified, or set to cloud_efficiency. seg_storage_type can only be set to cloud_essd.
serverlessMode Changes to this property will trigger replacement. String
The mode of the Serverless instance. Valid values: Manual, Auto. NOTE: serverless_mode is valid only when db_instance_mode is set to Serverless.
sslEnabled Integer
Enable or disable SSL. Valid values: 0 and 1.
status String
The status of the instance.
storageSize Integer

The storage capacity. Unit: GB. Valid values: 50 to 4000.

NOTE: This parameter must be passed in to create a storage reservation mode instance.

tags Map<String,String>
A mapping of tags to assign to the resource.
usedTime String
The used time. When the parameter period is Year, the used_time value is 1 to 3. When the parameter period is Month, the used_time value is 1 to 9.
vectorConfigurationStatus String
Specifies whether to enable vector engine optimization. Default value: disabled. Valid values: enabled and disabled.
vpcId Changes to this property will trigger replacement. String
The vpc ID of the resource.
vswitchId Changes to this property will trigger replacement. String
The vswitch id.
zoneId Changes to this property will trigger replacement. String
The zone ID of the instance.
availabilityZone Changes to this property will trigger replacement. string
Field availability_zone has been deprecated from provider version 1.187.0. New field zone_id instead.

Deprecated: Field 'availability_zone' has been deprecated from version 1.187.0. Use 'zone_id' instead.

connectionString string
(Available since v1.196.0) The connection string of the instance.
createSampleData boolean
Whether to load the sample dataset after the instance is created. Valid values: true, false.
dataShareStatus string
Specifies whether to enable or disable data sharing. Default value: closed. Valid values:
dbInstanceCategory Changes to this property will trigger replacement. string

The db instance category. Valid values: Basic, HighAvailability.

NOTE: This parameter must be passed in to create a storage reservation mode instance.

dbInstanceClass string

The db instance class. see Instance specifications.

NOTE: This parameter must be passed in to create a storage reservation mode instance.

dbInstanceMode Changes to this property will trigger replacement. string
The db instance mode. Valid values: StorageElastic, Serverless, Classic.
description string
The description of the instance.
encryptionKey Changes to this property will trigger replacement. string

The ID of the encryption key.

NOTE: If encryption_type is set to CloudDisk, you must specify an encryption key that resides in the same region as the cloud disk that is specified by EncryptionType. Otherwise, leave this parameter empty.

encryptionType Changes to this property will trigger replacement. string

The encryption type. Valid values: CloudDisk.

NOTE: Disk encryption cannot be disabled after it is enabled.

engine Changes to this property will trigger replacement. string
The database engine used by the instance. Value options can refer to the latest docs CreateDBInstance EngineVersion.
engineVersion Changes to this property will trigger replacement. string
The version of the database engine used by the instance.
instanceChargeType Changes to this property will trigger replacement. string
Field instance_charge_type has been deprecated from provider version 1.187.0. New field payment_type instead.

Deprecated: Field instance_charge_type has been deprecated from version 1.187.0. Use payment_type instead.

instanceGroupCount number
The number of nodes. Valid values: 2, 4, 8, 12, 16, 24, 32, 64, 96, 128.
instanceNetworkType Changes to this property will trigger replacement. string
The network type of the instance. Valid values: VPC.
instanceSpec string

The specification of segment nodes.

  • When db_instance_category is HighAvailability, Valid values: 2C16G, 4C32G, 16C128G.
  • When db_instance_category is Basic, Valid values: 2C8G, 4C16G, 8C32G, 16C64G.
  • When db_instance_category is Serverless, Valid values: 4C16G, 8C32G.

NOTE: This parameter must be passed to create a storage elastic mode instance and a serverless version instance.

ipWhitelists InstanceIpWhitelist[]
The ip whitelist. See ip_whitelist below. Default to creating a whitelist group with the group name "default" and security_ip_list "127.0.0.1".
maintainEndTime string
The end time of the maintenance window for the instance. in the format of HH:mmZ (UTC time), for example 03:00Z. start time should be later than end time.
maintainStartTime string
The start time of the maintenance window for the instance. in the format of HH:mmZ (UTC time), for example 02:00Z.
masterCu number
The amount of coordinator node resources. Valid values: 2, 4, 8, 16, 32.
masterNodeNum number
The number of Master nodes. NOTE: Field master_node_num has been deprecated from provider version 1.213.0.

Deprecated: Field master_node_num has been deprecated from provider version 1.213.0.

parameters InstanceParameter[]
The parameters. See parameters below.
paymentType Changes to this property will trigger replacement. string
The billing method of the instance. Valid values: Subscription, PayAsYouGo.
period string
The duration that you will buy the resource, in month. required when payment_type is Subscription. Valid values: Year, Month.
port string
(Available since v1.196.0) The connection port of the instance.
privateIpAddress string
The private ip address. NOTE: Field private_ip_address has been deprecated from provider version 1.213.0.

Deprecated: Field private_ip_address has been deprecated from provider version 1.213.0.

prodType Changes to this property will trigger replacement. string
The type of the product. Default value: standard. Valid values: standard, cost-effective.
resourceGroupId string
The ID of the enterprise resource group to which the instance belongs.
resourceManagementMode string
Resource management mode. Valid values: resourceGroup, resourceQueue.
securityIpLists string[]
Field security_ip_list has been deprecated from provider version 1.187.0. New field ip_whitelist instead.

Deprecated: Field 'security_ip_list' has been deprecated from version 1.187.0. Use 'ip_whitelist' instead.

segDiskPerformanceLevel string
The ESSD cloud disk performance level. Valid values: pl0, pl1, pl2.
segNodeNum number

Calculate the number of nodes. Valid values: 2 to 512. The value range of the high-availability version of the storage elastic mode is 4 to 512, and the value must be a multiple of 4. The value range of the basic version of the storage elastic mode is 2 to 512, and the value must be a multiple of 2. The-Serverless version has a value range of 2 to 512. The value must be a multiple of 2.

NOTE: This parameter must be passed in to create a storage elastic mode instance and a Serverless version instance. During the public beta of the Serverless version (from 0101, 2022 to 0131, 2022), a maximum of 12 compute nodes can be created.

segStorageType Changes to this property will trigger replacement. string
The seg storage type. Valid values: cloud_essd. NOTE: If db_instance_mode is set to StorageElastic, seg_storage_type is required. From version 1.233.1, seg_storage_type cannot be modified, or set to cloud_efficiency. seg_storage_type can only be set to cloud_essd.
serverlessMode Changes to this property will trigger replacement. string
The mode of the Serverless instance. Valid values: Manual, Auto. NOTE: serverless_mode is valid only when db_instance_mode is set to Serverless.
sslEnabled number
Enable or disable SSL. Valid values: 0 and 1.
status string
The status of the instance.
storageSize number

The storage capacity. Unit: GB. Valid values: 50 to 4000.

NOTE: This parameter must be passed in to create a storage reservation mode instance.

tags {[key: string]: string}
A mapping of tags to assign to the resource.
usedTime string
The used time. When the parameter period is Year, the used_time value is 1 to 3. When the parameter period is Month, the used_time value is 1 to 9.
vectorConfigurationStatus string
Specifies whether to enable vector engine optimization. Default value: disabled. Valid values: enabled and disabled.
vpcId Changes to this property will trigger replacement. string
The vpc ID of the resource.
vswitchId Changes to this property will trigger replacement. string
The vswitch id.
zoneId Changes to this property will trigger replacement. string
The zone ID of the instance.
availability_zone Changes to this property will trigger replacement. str
Field availability_zone has been deprecated from provider version 1.187.0. New field zone_id instead.

Deprecated: Field 'availability_zone' has been deprecated from version 1.187.0. Use 'zone_id' instead.

connection_string str
(Available since v1.196.0) The connection string of the instance.
create_sample_data bool
Whether to load the sample dataset after the instance is created. Valid values: true, false.
data_share_status str
Specifies whether to enable or disable data sharing. Default value: closed. Valid values:
db_instance_category Changes to this property will trigger replacement. str

The db instance category. Valid values: Basic, HighAvailability.

NOTE: This parameter must be passed in to create a storage reservation mode instance.

db_instance_class str

The db instance class. see Instance specifications.

NOTE: This parameter must be passed in to create a storage reservation mode instance.

db_instance_mode Changes to this property will trigger replacement. str
The db instance mode. Valid values: StorageElastic, Serverless, Classic.
description str
The description of the instance.
encryption_key Changes to this property will trigger replacement. str

The ID of the encryption key.

NOTE: If encryption_type is set to CloudDisk, you must specify an encryption key that resides in the same region as the cloud disk that is specified by EncryptionType. Otherwise, leave this parameter empty.

encryption_type Changes to this property will trigger replacement. str

The encryption type. Valid values: CloudDisk.

NOTE: Disk encryption cannot be disabled after it is enabled.

engine Changes to this property will trigger replacement. str
The database engine used by the instance. Value options can refer to the latest docs CreateDBInstance EngineVersion.
engine_version Changes to this property will trigger replacement. str
The version of the database engine used by the instance.
instance_charge_type Changes to this property will trigger replacement. str
Field instance_charge_type has been deprecated from provider version 1.187.0. New field payment_type instead.

Deprecated: Field instance_charge_type has been deprecated from version 1.187.0. Use payment_type instead.

instance_group_count int
The number of nodes. Valid values: 2, 4, 8, 12, 16, 24, 32, 64, 96, 128.
instance_network_type Changes to this property will trigger replacement. str
The network type of the instance. Valid values: VPC.
instance_spec str

The specification of segment nodes.

  • When db_instance_category is HighAvailability, Valid values: 2C16G, 4C32G, 16C128G.
  • When db_instance_category is Basic, Valid values: 2C8G, 4C16G, 8C32G, 16C64G.
  • When db_instance_category is Serverless, Valid values: 4C16G, 8C32G.

NOTE: This parameter must be passed to create a storage elastic mode instance and a serverless version instance.

ip_whitelists Sequence[InstanceIpWhitelistArgs]
The ip whitelist. See ip_whitelist below. Default to creating a whitelist group with the group name "default" and security_ip_list "127.0.0.1".
maintain_end_time str
The end time of the maintenance window for the instance. in the format of HH:mmZ (UTC time), for example 03:00Z. start time should be later than end time.
maintain_start_time str
The start time of the maintenance window for the instance. in the format of HH:mmZ (UTC time), for example 02:00Z.
master_cu int
The amount of coordinator node resources. Valid values: 2, 4, 8, 16, 32.
master_node_num int
The number of Master nodes. NOTE: Field master_node_num has been deprecated from provider version 1.213.0.

Deprecated: Field master_node_num has been deprecated from provider version 1.213.0.

parameters Sequence[InstanceParameterArgs]
The parameters. See parameters below.
payment_type Changes to this property will trigger replacement. str
The billing method of the instance. Valid values: Subscription, PayAsYouGo.
period str
The duration that you will buy the resource, in month. required when payment_type is Subscription. Valid values: Year, Month.
port str
(Available since v1.196.0) The connection port of the instance.
private_ip_address str
The private ip address. NOTE: Field private_ip_address has been deprecated from provider version 1.213.0.

Deprecated: Field private_ip_address has been deprecated from provider version 1.213.0.

prod_type Changes to this property will trigger replacement. str
The type of the product. Default value: standard. Valid values: standard, cost-effective.
resource_group_id str
The ID of the enterprise resource group to which the instance belongs.
resource_management_mode str
Resource management mode. Valid values: resourceGroup, resourceQueue.
security_ip_lists Sequence[str]
Field security_ip_list has been deprecated from provider version 1.187.0. New field ip_whitelist instead.

Deprecated: Field 'security_ip_list' has been deprecated from version 1.187.0. Use 'ip_whitelist' instead.

seg_disk_performance_level str
The ESSD cloud disk performance level. Valid values: pl0, pl1, pl2.
seg_node_num int

Calculate the number of nodes. Valid values: 2 to 512. The value range of the high-availability version of the storage elastic mode is 4 to 512, and the value must be a multiple of 4. The value range of the basic version of the storage elastic mode is 2 to 512, and the value must be a multiple of 2. The-Serverless version has a value range of 2 to 512. The value must be a multiple of 2.

NOTE: This parameter must be passed in to create a storage elastic mode instance and a Serverless version instance. During the public beta of the Serverless version (from 0101, 2022 to 0131, 2022), a maximum of 12 compute nodes can be created.

seg_storage_type Changes to this property will trigger replacement. str
The seg storage type. Valid values: cloud_essd. NOTE: If db_instance_mode is set to StorageElastic, seg_storage_type is required. From version 1.233.1, seg_storage_type cannot be modified, or set to cloud_efficiency. seg_storage_type can only be set to cloud_essd.
serverless_mode Changes to this property will trigger replacement. str
The mode of the Serverless instance. Valid values: Manual, Auto. NOTE: serverless_mode is valid only when db_instance_mode is set to Serverless.
ssl_enabled int
Enable or disable SSL. Valid values: 0 and 1.
status str
The status of the instance.
storage_size int

The storage capacity. Unit: GB. Valid values: 50 to 4000.

NOTE: This parameter must be passed in to create a storage reservation mode instance.

tags Mapping[str, str]
A mapping of tags to assign to the resource.
used_time str
The used time. When the parameter period is Year, the used_time value is 1 to 3. When the parameter period is Month, the used_time value is 1 to 9.
vector_configuration_status str
Specifies whether to enable vector engine optimization. Default value: disabled. Valid values: enabled and disabled.
vpc_id Changes to this property will trigger replacement. str
The vpc ID of the resource.
vswitch_id Changes to this property will trigger replacement. str
The vswitch id.
zone_id Changes to this property will trigger replacement. str
The zone ID of the instance.
availabilityZone Changes to this property will trigger replacement. String
Field availability_zone has been deprecated from provider version 1.187.0. New field zone_id instead.

Deprecated: Field 'availability_zone' has been deprecated from version 1.187.0. Use 'zone_id' instead.

connectionString String
(Available since v1.196.0) The connection string of the instance.
createSampleData Boolean
Whether to load the sample dataset after the instance is created. Valid values: true, false.
dataShareStatus String
Specifies whether to enable or disable data sharing. Default value: closed. Valid values:
dbInstanceCategory Changes to this property will trigger replacement. String

The db instance category. Valid values: Basic, HighAvailability.

NOTE: This parameter must be passed in to create a storage reservation mode instance.

dbInstanceClass String

The db instance class. see Instance specifications.

NOTE: This parameter must be passed in to create a storage reservation mode instance.

dbInstanceMode Changes to this property will trigger replacement. String
The db instance mode. Valid values: StorageElastic, Serverless, Classic.
description String
The description of the instance.
encryptionKey Changes to this property will trigger replacement. String

The ID of the encryption key.

NOTE: If encryption_type is set to CloudDisk, you must specify an encryption key that resides in the same region as the cloud disk that is specified by EncryptionType. Otherwise, leave this parameter empty.

encryptionType Changes to this property will trigger replacement. String

The encryption type. Valid values: CloudDisk.

NOTE: Disk encryption cannot be disabled after it is enabled.

engine Changes to this property will trigger replacement. String
The database engine used by the instance. Value options can refer to the latest docs CreateDBInstance EngineVersion.
engineVersion Changes to this property will trigger replacement. String
The version of the database engine used by the instance.
instanceChargeType Changes to this property will trigger replacement. String
Field instance_charge_type has been deprecated from provider version 1.187.0. New field payment_type instead.

Deprecated: Field instance_charge_type has been deprecated from version 1.187.0. Use payment_type instead.

instanceGroupCount Number
The number of nodes. Valid values: 2, 4, 8, 12, 16, 24, 32, 64, 96, 128.
instanceNetworkType Changes to this property will trigger replacement. String
The network type of the instance. Valid values: VPC.
instanceSpec String

The specification of segment nodes.

  • When db_instance_category is HighAvailability, Valid values: 2C16G, 4C32G, 16C128G.
  • When db_instance_category is Basic, Valid values: 2C8G, 4C16G, 8C32G, 16C64G.
  • When db_instance_category is Serverless, Valid values: 4C16G, 8C32G.

NOTE: This parameter must be passed to create a storage elastic mode instance and a serverless version instance.

ipWhitelists List<Property Map>
The ip whitelist. See ip_whitelist below. Default to creating a whitelist group with the group name "default" and security_ip_list "127.0.0.1".
maintainEndTime String
The end time of the maintenance window for the instance. in the format of HH:mmZ (UTC time), for example 03:00Z. start time should be later than end time.
maintainStartTime String
The start time of the maintenance window for the instance. in the format of HH:mmZ (UTC time), for example 02:00Z.
masterCu Number
The amount of coordinator node resources. Valid values: 2, 4, 8, 16, 32.
masterNodeNum Number
The number of Master nodes. NOTE: Field master_node_num has been deprecated from provider version 1.213.0.

Deprecated: Field master_node_num has been deprecated from provider version 1.213.0.

parameters List<Property Map>
The parameters. See parameters below.
paymentType Changes to this property will trigger replacement. String
The billing method of the instance. Valid values: Subscription, PayAsYouGo.
period String
The duration that you will buy the resource, in month. required when payment_type is Subscription. Valid values: Year, Month.
port String
(Available since v1.196.0) The connection port of the instance.
privateIpAddress String
The private ip address. NOTE: Field private_ip_address has been deprecated from provider version 1.213.0.

Deprecated: Field private_ip_address has been deprecated from provider version 1.213.0.

prodType Changes to this property will trigger replacement. String
The type of the product. Default value: standard. Valid values: standard, cost-effective.
resourceGroupId String
The ID of the enterprise resource group to which the instance belongs.
resourceManagementMode String
Resource management mode. Valid values: resourceGroup, resourceQueue.
securityIpLists List<String>
Field security_ip_list has been deprecated from provider version 1.187.0. New field ip_whitelist instead.

Deprecated: Field 'security_ip_list' has been deprecated from version 1.187.0. Use 'ip_whitelist' instead.

segDiskPerformanceLevel String
The ESSD cloud disk performance level. Valid values: pl0, pl1, pl2.
segNodeNum Number

Calculate the number of nodes. Valid values: 2 to 512. The value range of the high-availability version of the storage elastic mode is 4 to 512, and the value must be a multiple of 4. The value range of the basic version of the storage elastic mode is 2 to 512, and the value must be a multiple of 2. The-Serverless version has a value range of 2 to 512. The value must be a multiple of 2.

NOTE: This parameter must be passed in to create a storage elastic mode instance and a Serverless version instance. During the public beta of the Serverless version (from 0101, 2022 to 0131, 2022), a maximum of 12 compute nodes can be created.

segStorageType Changes to this property will trigger replacement. String
The seg storage type. Valid values: cloud_essd. NOTE: If db_instance_mode is set to StorageElastic, seg_storage_type is required. From version 1.233.1, seg_storage_type cannot be modified, or set to cloud_efficiency. seg_storage_type can only be set to cloud_essd.
serverlessMode Changes to this property will trigger replacement. String
The mode of the Serverless instance. Valid values: Manual, Auto. NOTE: serverless_mode is valid only when db_instance_mode is set to Serverless.
sslEnabled Number
Enable or disable SSL. Valid values: 0 and 1.
status String
The status of the instance.
storageSize Number

The storage capacity. Unit: GB. Valid values: 50 to 4000.

NOTE: This parameter must be passed in to create a storage reservation mode instance.

tags Map<String>
A mapping of tags to assign to the resource.
usedTime String
The used time. When the parameter period is Year, the used_time value is 1 to 3. When the parameter period is Month, the used_time value is 1 to 9.
vectorConfigurationStatus String
Specifies whether to enable vector engine optimization. Default value: disabled. Valid values: enabled and disabled.
vpcId Changes to this property will trigger replacement. String
The vpc ID of the resource.
vswitchId Changes to this property will trigger replacement. String
The vswitch id.
zoneId Changes to this property will trigger replacement. String
The zone ID of the instance.

Supporting Types

InstanceIpWhitelist
, InstanceIpWhitelistArgs

IpGroupAttribute string
The value of this parameter is empty by default. The attribute of the whitelist group. If the value contains hidden, this white list item will not output.
IpGroupName string
IP whitelist group name.
SecurityIpList string
List of IP addresses allowed to access all databases of an instance. The list contains up to 1,000 IP addresses, separated by commas. Supported formats include 0.0.0.0/0, 10.23.12.24 (IP), and 10.23.12.24/24 (Classless Inter-Domain Routing (CIDR) mode. /24 represents the length of the prefix in an IP address. The range of the prefix length is [1,32]). System default to ["127.0.0.1"].
IpGroupAttribute string
The value of this parameter is empty by default. The attribute of the whitelist group. If the value contains hidden, this white list item will not output.
IpGroupName string
IP whitelist group name.
SecurityIpList string
List of IP addresses allowed to access all databases of an instance. The list contains up to 1,000 IP addresses, separated by commas. Supported formats include 0.0.0.0/0, 10.23.12.24 (IP), and 10.23.12.24/24 (Classless Inter-Domain Routing (CIDR) mode. /24 represents the length of the prefix in an IP address. The range of the prefix length is [1,32]). System default to ["127.0.0.1"].
ipGroupAttribute String
The value of this parameter is empty by default. The attribute of the whitelist group. If the value contains hidden, this white list item will not output.
ipGroupName String
IP whitelist group name.
securityIpList String
List of IP addresses allowed to access all databases of an instance. The list contains up to 1,000 IP addresses, separated by commas. Supported formats include 0.0.0.0/0, 10.23.12.24 (IP), and 10.23.12.24/24 (Classless Inter-Domain Routing (CIDR) mode. /24 represents the length of the prefix in an IP address. The range of the prefix length is [1,32]). System default to ["127.0.0.1"].
ipGroupAttribute string
The value of this parameter is empty by default. The attribute of the whitelist group. If the value contains hidden, this white list item will not output.
ipGroupName string
IP whitelist group name.
securityIpList string
List of IP addresses allowed to access all databases of an instance. The list contains up to 1,000 IP addresses, separated by commas. Supported formats include 0.0.0.0/0, 10.23.12.24 (IP), and 10.23.12.24/24 (Classless Inter-Domain Routing (CIDR) mode. /24 represents the length of the prefix in an IP address. The range of the prefix length is [1,32]). System default to ["127.0.0.1"].
ip_group_attribute str
The value of this parameter is empty by default. The attribute of the whitelist group. If the value contains hidden, this white list item will not output.
ip_group_name str
IP whitelist group name.
security_ip_list str
List of IP addresses allowed to access all databases of an instance. The list contains up to 1,000 IP addresses, separated by commas. Supported formats include 0.0.0.0/0, 10.23.12.24 (IP), and 10.23.12.24/24 (Classless Inter-Domain Routing (CIDR) mode. /24 represents the length of the prefix in an IP address. The range of the prefix length is [1,32]). System default to ["127.0.0.1"].
ipGroupAttribute String
The value of this parameter is empty by default. The attribute of the whitelist group. If the value contains hidden, this white list item will not output.
ipGroupName String
IP whitelist group name.
securityIpList String
List of IP addresses allowed to access all databases of an instance. The list contains up to 1,000 IP addresses, separated by commas. Supported formats include 0.0.0.0/0, 10.23.12.24 (IP), and 10.23.12.24/24 (Classless Inter-Domain Routing (CIDR) mode. /24 represents the length of the prefix in an IP address. The range of the prefix length is [1,32]). System default to ["127.0.0.1"].

InstanceParameter
, InstanceParameterArgs

Name This property is required. string
The name of the parameter.
Value This property is required. string
The value of the parameter.
DefaultValue string
(Available since v1.231.0) The default value of the parameter.
ForceRestartInstance string
(Available since v1.231.0) Whether to force restart the instance to config the parameter.
IsChangeableConfig string
(Available since v1.231.0) Whether the parameter is changeable.
OptionalRange string
(Available since v1.231.0) The optional range of the parameter.
ParameterDescription string
(Available since v1.231.0) The description of the parameter.
Name This property is required. string
The name of the parameter.
Value This property is required. string
The value of the parameter.
DefaultValue string
(Available since v1.231.0) The default value of the parameter.
ForceRestartInstance string
(Available since v1.231.0) Whether to force restart the instance to config the parameter.
IsChangeableConfig string
(Available since v1.231.0) Whether the parameter is changeable.
OptionalRange string
(Available since v1.231.0) The optional range of the parameter.
ParameterDescription string
(Available since v1.231.0) The description of the parameter.
name This property is required. String
The name of the parameter.
value This property is required. String
The value of the parameter.
defaultValue String
(Available since v1.231.0) The default value of the parameter.
forceRestartInstance String
(Available since v1.231.0) Whether to force restart the instance to config the parameter.
isChangeableConfig String
(Available since v1.231.0) Whether the parameter is changeable.
optionalRange String
(Available since v1.231.0) The optional range of the parameter.
parameterDescription String
(Available since v1.231.0) The description of the parameter.
name This property is required. string
The name of the parameter.
value This property is required. string
The value of the parameter.
defaultValue string
(Available since v1.231.0) The default value of the parameter.
forceRestartInstance string
(Available since v1.231.0) Whether to force restart the instance to config the parameter.
isChangeableConfig string
(Available since v1.231.0) Whether the parameter is changeable.
optionalRange string
(Available since v1.231.0) The optional range of the parameter.
parameterDescription string
(Available since v1.231.0) The description of the parameter.
name This property is required. str
The name of the parameter.
value This property is required. str
The value of the parameter.
default_value str
(Available since v1.231.0) The default value of the parameter.
force_restart_instance str
(Available since v1.231.0) Whether to force restart the instance to config the parameter.
is_changeable_config str
(Available since v1.231.0) Whether the parameter is changeable.
optional_range str
(Available since v1.231.0) The optional range of the parameter.
parameter_description str
(Available since v1.231.0) The description of the parameter.
name This property is required. String
The name of the parameter.
value This property is required. String
The value of the parameter.
defaultValue String
(Available since v1.231.0) The default value of the parameter.
forceRestartInstance String
(Available since v1.231.0) Whether to force restart the instance to config the parameter.
isChangeableConfig String
(Available since v1.231.0) Whether the parameter is changeable.
optionalRange String
(Available since v1.231.0) The optional range of the parameter.
parameterDescription String
(Available since v1.231.0) The description of the parameter.

Import

AnalyticDB for PostgreSQL can be imported using the id, e.g.

$ pulumi import alicloud:gpdb/instance:Instance 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.
Alibaba Cloud v3.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-alicloud