Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Alicloud Provider
  3. API Docs
  4. gpdb
  5. Instance
Alibaba Cloud v3.62.1 published on Monday, Sep 16, 2024 by Pulumi
pulumi/pulumi-alicloud

alicloud.gpdb.Instance

Explore with Pulumi AI

alicloud logo
Alibaba Cloud v3.62.1 published on Monday, Sep 16, 2024 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",
    }],
});

    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",
    }])

    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, nil, nil)
		if err != nil {
			return err
		}
		defaultGetZones, err := gpdb.GetZones(ctx, nil, 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
	})
}

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

});

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

    }
}

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

    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,
             maintain_start_time: Optional[str] = None,
             payment_type: Optional[str] = None,
             encryption_key: Optional[str] = None,
             encryption_type: Optional[str] = None,
             db_instance_class: Optional[str] = None,
             db_instance_category: 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,
             availability_zone: Optional[str] = None,
             master_cu: Optional[int] = None,
             master_node_num: Optional[int] = None,
             description: Optional[str] = None,
             period: Optional[str] = None,
             private_ip_address: Optional[str] = None,
             resource_group_id: Optional[str] = None,
             resource_management_mode: Optional[str] = None,
             security_ip_lists: Optional[Sequence[str]] = None,
             seg_node_num: Optional[int] = None,
             seg_storage_type: Optional[str] = None,
             ssl_enabled: Optional[int] = 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 string
    The unique name of the resource.
    args InstanceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args 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 string
    The unique name of the resource.
    args InstanceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args InstanceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args 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",
    MaintainStartTime = "string",
    PaymentType = "string",
    EncryptionKey = "string",
    EncryptionType = "string",
    DbInstanceClass = "string",
    DbInstanceCategory = "string",
    InstanceGroupCount = 0,
    InstanceNetworkType = "string",
    InstanceSpec = "string",
    IpWhitelists = new[]
    {
        new AliCloud.Gpdb.Inputs.InstanceIpWhitelistArgs
        {
            IpGroupAttribute = "string",
            IpGroupName = "string",
            SecurityIpList = "string",
        },
    },
    MaintainEndTime = "string",
    MasterCu = 0,
    Description = "string",
    Period = "string",
    ResourceGroupId = "string",
    ResourceManagementMode = "string",
    SegNodeNum = 0,
    SegStorageType = "string",
    SslEnabled = 0,
    StorageSize = 0,
    Tags = 
    {
        { "string", "string" },
    },
    UsedTime = "string",
    VectorConfigurationStatus = "string",
    VpcId = "string",
    CreateSampleData = false,
    ZoneId = "string",
});

    example, err := gpdb.NewInstance(ctx, "exampleinstanceResourceResourceFromGpdbinstance", &gpdb.InstanceArgs{
	DbInstanceMode:      pulumi.String("string"),
	VswitchId:           pulumi.String("string"),
	EngineVersion:       pulumi.String("string"),
	Engine:              pulumi.String("string"),
	MaintainStartTime:   pulumi.String("string"),
	PaymentType:         pulumi.String("string"),
	EncryptionKey:       pulumi.String("string"),
	EncryptionType:      pulumi.String("string"),
	DbInstanceClass:     pulumi.String("string"),
	DbInstanceCategory:  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"),
	MasterCu:               pulumi.Int(0),
	Description:            pulumi.String("string"),
	Period:                 pulumi.String("string"),
	ResourceGroupId:        pulumi.String("string"),
	ResourceManagementMode: pulumi.String("string"),
	SegNodeNum:             pulumi.Int(0),
	SegStorageType:         pulumi.String("string"),
	SslEnabled:             pulumi.Int(0),
	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"),
})

    var exampleinstanceResourceResourceFromGpdbinstance = new Instance("exampleinstanceResourceResourceFromGpdbinstance", InstanceArgs.builder()
    .dbInstanceMode("string")
    .vswitchId("string")
    .engineVersion("string")
    .engine("string")
    .maintainStartTime("string")
    .paymentType("string")
    .encryptionKey("string")
    .encryptionType("string")
    .dbInstanceClass("string")
    .dbInstanceCategory("string")
    .instanceGroupCount(0)
    .instanceNetworkType("string")
    .instanceSpec("string")
    .ipWhitelists(InstanceIpWhitelistArgs.builder()
        .ipGroupAttribute("string")
        .ipGroupName("string")
        .securityIpList("string")
        .build())
    .maintainEndTime("string")
    .masterCu(0)
    .description("string")
    .period("string")
    .resourceGroupId("string")
    .resourceManagementMode("string")
    .segNodeNum(0)
    .segStorageType("string")
    .sslEnabled(0)
    .storageSize(0)
    .tags(Map.of("string", "string"))
    .usedTime("string")
    .vectorConfigurationStatus("string")
    .vpcId("string")
    .createSampleData(false)
    .zoneId("string")
    .build());

    exampleinstance_resource_resource_from_gpdbinstance = alicloud.gpdb.Instance("exampleinstanceResourceResourceFromGpdbinstance",
    db_instance_mode="string",
    vswitch_id="string",
    engine_version="string",
    engine="string",
    maintain_start_time="string",
    payment_type="string",
    encryption_key="string",
    encryption_type="string",
    db_instance_class="string",
    db_instance_category="string",
    instance_group_count=0,
    instance_network_type="string",
    instance_spec="string",
    ip_whitelists=[alicloud.gpdb.InstanceIpWhitelistArgs(
        ip_group_attribute="string",
        ip_group_name="string",
        security_ip_list="string",
    )],
    maintain_end_time="string",
    master_cu=0,
    description="string",
    period="string",
    resource_group_id="string",
    resource_management_mode="string",
    seg_node_num=0,
    seg_storage_type="string",
    ssl_enabled=0,
    storage_size=0,
    tags={
        "string": "string",
    },
    used_time="string",
    vector_configuration_status="string",
    vpc_id="string",
    create_sample_data=False,
    zone_id="string")

    const exampleinstanceResourceResourceFromGpdbinstance = new alicloud.gpdb.Instance("exampleinstanceResourceResourceFromGpdbinstance", {
    dbInstanceMode: "string",
    vswitchId: "string",
    engineVersion: "string",
    engine: "string",
    maintainStartTime: "string",
    paymentType: "string",
    encryptionKey: "string",
    encryptionType: "string",
    dbInstanceClass: "string",
    dbInstanceCategory: "string",
    instanceGroupCount: 0,
    instanceNetworkType: "string",
    instanceSpec: "string",
    ipWhitelists: [{
        ipGroupAttribute: "string",
        ipGroupName: "string",
        securityIpList: "string",
    }],
    maintainEndTime: "string",
    masterCu: 0,
    description: "string",
    period: "string",
    resourceGroupId: "string",
    resourceManagementMode: "string",
    segNodeNum: 0,
    segStorageType: "string",
    sslEnabled: 0,
    storageSize: 0,
    tags: {
        string: "string",
    },
    usedTime: "string",
    vectorConfigurationStatus: "string",
    vpcId: "string",
    createSampleData: false,
    zoneId: "string",
});

    type: alicloud:gpdb:Instance
properties:
    createSampleData: false
    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
    paymentType: string
    period: string
    resourceGroupId: string
    resourceManagementMode: string
    segNodeNum: 0
    segStorageType: string
    sslEnabled: 0
    storageSize: 0
    tags:
        string: string
    usedTime: string
    vectorConfigurationStatus: string
    vpcId: string
    vswitchId: string
    zoneId: string

    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

    The Instance resource accepts the following input properties:

    DbInstanceMode string
    The db instance mode. Valid values: StorageElastic, Serverless, Classic.
    Engine string
    The database engine used by the instance. Value options can refer to the latest docs CreateDBInstance EngineVersion.
    EngineVersion string
    The version of the database engine used by the instance.
    VswitchId string
    The vswitch id.
    AvailabilityZone 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.
    DbInstanceCategory 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 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 string

    The encryption type. Valid values: CloudDisk.

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

    InstanceChargeType 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 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.

    PaymentType 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.

    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.

    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 string

    The seg storage type. Valid values: cloud_essd, cloud_efficiency.

    NOTE: This parameter must be passed in to create a storage elastic mode instance. Storage Elastic Mode Basic Edition instances only support ESSD cloud disks.

    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 string
    The vpc ID of the resource.
    ZoneId string
    The zone ID of the instance.
    DbInstanceMode string
    The db instance mode. Valid values: StorageElastic, Serverless, Classic.
    Engine string
    The database engine used by the instance. Value options can refer to the latest docs CreateDBInstance EngineVersion.
    EngineVersion string
    The version of the database engine used by the instance.
    VswitchId string
    The vswitch id.
    AvailabilityZone 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.
    DbInstanceCategory 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 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 string

    The encryption type. Valid values: CloudDisk.

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

    InstanceChargeType 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 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.

    PaymentType 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.

    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.

    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 string

    The seg storage type. Valid values: cloud_essd, cloud_efficiency.

    NOTE: This parameter must be passed in to create a storage elastic mode instance. Storage Elastic Mode Basic Edition instances only support ESSD cloud disks.

    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 string
    The vpc ID of the resource.
    ZoneId string
    The zone ID of the instance.
    dbInstanceMode String
    The db instance mode. Valid values: StorageElastic, Serverless, Classic.
    engine String
    The database engine used by the instance. Value options can refer to the latest docs CreateDBInstance EngineVersion.
    engineVersion String
    The version of the database engine used by the instance.
    vswitchId String
    The vswitch id.
    availabilityZone 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.
    dbInstanceCategory 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 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 String

    The encryption type. Valid values: CloudDisk.

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

    instanceChargeType 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 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.

    paymentType 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.

    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.

    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 String

    The seg storage type. Valid values: cloud_essd, cloud_efficiency.

    NOTE: This parameter must be passed in to create a storage elastic mode instance. Storage Elastic Mode Basic Edition instances only support ESSD cloud disks.

    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 String
    The vpc ID of the resource.
    zoneId String
    The zone ID of the instance.
    dbInstanceMode string
    The db instance mode. Valid values: StorageElastic, Serverless, Classic.
    engine string
    The database engine used by the instance. Value options can refer to the latest docs CreateDBInstance EngineVersion.
    engineVersion string
    The version of the database engine used by the instance.
    vswitchId string
    The vswitch id.
    availabilityZone 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.
    dbInstanceCategory 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 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 string

    The encryption type. Valid values: CloudDisk.

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

    instanceChargeType 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 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.

    paymentType 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.

    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.

    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 string

    The seg storage type. Valid values: cloud_essd, cloud_efficiency.

    NOTE: This parameter must be passed in to create a storage elastic mode instance. Storage Elastic Mode Basic Edition instances only support ESSD cloud disks.

    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 string
    The vpc ID of the resource.
    zoneId string
    The zone ID of the instance.
    db_instance_mode str
    The db instance mode. Valid values: StorageElastic, Serverless, Classic.
    engine str
    The database engine used by the instance. Value options can refer to the latest docs CreateDBInstance EngineVersion.
    engine_version str
    The version of the database engine used by the instance.
    vswitch_id str
    The vswitch id.
    availability_zone 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.
    db_instance_category 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 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 str

    The encryption type. Valid values: CloudDisk.

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

    instance_charge_type 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 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.

    payment_type 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.

    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_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 str

    The seg storage type. Valid values: cloud_essd, cloud_efficiency.

    NOTE: This parameter must be passed in to create a storage elastic mode instance. Storage Elastic Mode Basic Edition instances only support ESSD cloud disks.

    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 str
    The vpc ID of the resource.
    zone_id str
    The zone ID of the instance.
    dbInstanceMode String
    The db instance mode. Valid values: StorageElastic, Serverless, Classic.
    engine String
    The database engine used by the instance. Value options can refer to the latest docs CreateDBInstance EngineVersion.
    engineVersion String
    The version of the database engine used by the instance.
    vswitchId String
    The vswitch id.
    availabilityZone 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.
    dbInstanceCategory 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 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 String

    The encryption type. Valid values: CloudDisk.

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

    instanceChargeType 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 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.

    paymentType 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.

    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.

    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 String

    The seg storage type. Valid values: cloud_essd, cloud_efficiency.

    NOTE: This parameter must be passed in to create a storage elastic mode instance. Storage Elastic Mode Basic Edition instances only support ESSD cloud disks.

    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 String
    The vpc ID of the resource.
    zoneId 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,
        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,
        payment_type: Optional[str] = None,
        period: Optional[str] = None,
        port: Optional[str] = None,
        private_ip_address: Optional[str] = None,
        resource_group_id: Optional[str] = None,
        resource_management_mode: Optional[str] = None,
        security_ip_lists: Optional[Sequence[str]] = None,
        seg_node_num: Optional[int] = None,
        seg_storage_type: 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)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AvailabilityZone 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.
    DbInstanceCategory 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 string
    The db instance mode. Valid values: StorageElastic, Serverless, Classic.
    Description string
    The description of the instance.
    EncryptionKey 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 string

    The encryption type. Valid values: CloudDisk.

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

    Engine string
    The database engine used by the instance. Value options can refer to the latest docs CreateDBInstance EngineVersion.
    EngineVersion string
    The version of the database engine used by the instance.
    InstanceChargeType 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 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.

    PaymentType 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.

    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.

    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 string

    The seg storage type. Valid values: cloud_essd, cloud_efficiency.

    NOTE: This parameter must be passed in to create a storage elastic mode instance. Storage Elastic Mode Basic Edition instances only support ESSD cloud disks.

    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 string
    The vpc ID of the resource.
    VswitchId string
    The vswitch id.
    ZoneId string
    The zone ID of the instance.
    AvailabilityZone 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.
    DbInstanceCategory 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 string
    The db instance mode. Valid values: StorageElastic, Serverless, Classic.
    Description string
    The description of the instance.
    EncryptionKey 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 string

    The encryption type. Valid values: CloudDisk.

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

    Engine string
    The database engine used by the instance. Value options can refer to the latest docs CreateDBInstance EngineVersion.
    EngineVersion string
    The version of the database engine used by the instance.
    InstanceChargeType 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 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.

    PaymentType 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.

    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.

    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 string

    The seg storage type. Valid values: cloud_essd, cloud_efficiency.

    NOTE: This parameter must be passed in to create a storage elastic mode instance. Storage Elastic Mode Basic Edition instances only support ESSD cloud disks.

    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 string
    The vpc ID of the resource.
    VswitchId string
    The vswitch id.
    ZoneId string
    The zone ID of the instance.
    availabilityZone 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.
    dbInstanceCategory 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 String
    The db instance mode. Valid values: StorageElastic, Serverless, Classic.
    description String
    The description of the instance.
    encryptionKey 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 String

    The encryption type. Valid values: CloudDisk.

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

    engine String
    The database engine used by the instance. Value options can refer to the latest docs CreateDBInstance EngineVersion.
    engineVersion String
    The version of the database engine used by the instance.
    instanceChargeType 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 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.

    paymentType 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.

    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.

    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 String

    The seg storage type. Valid values: cloud_essd, cloud_efficiency.

    NOTE: This parameter must be passed in to create a storage elastic mode instance. Storage Elastic Mode Basic Edition instances only support ESSD cloud disks.

    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 String
    The vpc ID of the resource.
    vswitchId String
    The vswitch id.
    zoneId String
    The zone ID of the instance.
    availabilityZone 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.
    dbInstanceCategory 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 string
    The db instance mode. Valid values: StorageElastic, Serverless, Classic.
    description string
    The description of the instance.
    encryptionKey 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 string

    The encryption type. Valid values: CloudDisk.

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

    engine string
    The database engine used by the instance. Value options can refer to the latest docs CreateDBInstance EngineVersion.
    engineVersion string
    The version of the database engine used by the instance.
    instanceChargeType 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 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.

    paymentType 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.

    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.

    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 string

    The seg storage type. Valid values: cloud_essd, cloud_efficiency.

    NOTE: This parameter must be passed in to create a storage elastic mode instance. Storage Elastic Mode Basic Edition instances only support ESSD cloud disks.

    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 string
    The vpc ID of the resource.
    vswitchId string
    The vswitch id.
    zoneId string
    The zone ID of the instance.
    availability_zone 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.
    db_instance_category 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 str
    The db instance mode. Valid values: StorageElastic, Serverless, Classic.
    description str
    The description of the instance.
    encryption_key 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 str

    The encryption type. Valid values: CloudDisk.

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

    engine str
    The database engine used by the instance. Value options can refer to the latest docs CreateDBInstance EngineVersion.
    engine_version str
    The version of the database engine used by the instance.
    instance_charge_type 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 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.

    payment_type 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.

    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_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 str

    The seg storage type. Valid values: cloud_essd, cloud_efficiency.

    NOTE: This parameter must be passed in to create a storage elastic mode instance. Storage Elastic Mode Basic Edition instances only support ESSD cloud disks.

    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 str
    The vpc ID of the resource.
    vswitch_id str
    The vswitch id.
    zone_id str
    The zone ID of the instance.
    availabilityZone 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.
    dbInstanceCategory 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 String
    The db instance mode. Valid values: StorageElastic, Serverless, Classic.
    description String
    The description of the instance.
    encryptionKey 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 String

    The encryption type. Valid values: CloudDisk.

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

    engine String
    The database engine used by the instance. Value options can refer to the latest docs CreateDBInstance EngineVersion.
    engineVersion String
    The version of the database engine used by the instance.
    instanceChargeType 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 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.

    paymentType 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.

    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.

    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 String

    The seg storage type. Valid values: cloud_essd, cloud_efficiency.

    NOTE: This parameter must be passed in to create a storage elastic mode instance. Storage Elastic Mode Basic Edition instances only support ESSD cloud disks.

    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 String
    The vpc ID of the resource.
    vswitchId String
    The vswitch id.
    zoneId 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"].

    Import

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

    $ pulumi import alicloud:gpdb/instance:Instance example <id>

    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.
    alicloud logo
    Alibaba Cloud v3.62.1 published on Monday, Sep 16, 2024 by Pulumi
    pulumi/pulumi-alicloud