1. Packages
  2. Alibaba Cloud Provider
  3. API Docs
  4. polardb
  5. ZonalDbCluster
Alibaba Cloud v3.87.0 published on Saturday, Oct 18, 2025 by Pulumi
pulumi/pulumi-alicloud

alicloud.polardb.ZonalDbCluster

Get Started
alicloud logo
Alibaba Cloud v3.87.0 published on Saturday, Oct 18, 2025 by Pulumi
pulumi/pulumi-alicloud

    Provides an PolarDB zonal cluster resource. An PolarDB zonal cluster is an isolated database environment in the cloud. An PolarDB zonal cluster can contain multiple user-created databases.

    NOTE: Available since v1.66.0.

    Example Usage

    Create a PolarDB MySQL zonal cluster

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

const config = new pulumi.Config();
// The advanced configuration for all nodes in the cluster except for the RW node, including db_node_class, hot_replica_mode, and imci_switch properties.
const dbClusterNodesConfigs = config.getObject<Record<string, {dbNodeClass?: string, dbNodeRole?: string, hotReplicaMode?: string, imciSwitch?: string}>>("dbClusterNodesConfigs") || {
    db_node_1: {
        dbNodeClass: "polar.mysql.x4.medium.c",
        dbNodeRole: "Writer",
        hotReplicaMode: null,
        imciSwitch: null,
    },
    db_node_2: {
        dbNodeClass: "polar.mysql.x4.medium.c",
        dbNodeRole: "Reader",
        hotReplicaMode: null,
        imciSwitch: null,
    },
};
const _default = new alicloud.ens.Network("default", {
    networkName: "terraform-example",
    description: "LoadBalancerNetworkDescription_test",
    cidrBlock: "192.168.2.0/24",
    ensRegionId: "tr-Istanbul-1",
});
const defaultVswitch = new alicloud.ens.Vswitch("default", {
    description: "LoadBalancerVSwitchDescription_test",
    cidrBlock: "192.168.2.0/24",
    vswitchName: "terraform-example",
    ensRegionId: "tr-Istanbul-1",
    networkId: _default.id,
});
const defaultZonalDbCluster = new alicloud.polardb.ZonalDbCluster("default", {
    dbNodeClass: "polar.mysql.x4.medium.c",
    description: "terraform-example",
    ensRegionId: "tr-Istanbul-1",
    vpcId: _default.id,
    vswitchId: defaultVswitch.id,
    dbClusterNodesConfigs: Object.entries(dbClusterNodesConfigs).reduce((__obj, [node, config]) => ({ ...__obj, [node]: JSON.stringify(Object.entries(config).filter(([k, v]) => v != null).reduce((__obj, [k, v]) => ({ ...__obj, [k]: v }))) })),
});

    import pulumi
import json
import pulumi_alicloud as alicloud

config = pulumi.Config()
# The advanced configuration for all nodes in the cluster except for the RW node, including db_node_class, hot_replica_mode, and imci_switch properties.
db_cluster_nodes_configs = config.get_object("dbClusterNodesConfigs")
if db_cluster_nodes_configs is None:
    db_cluster_nodes_configs = {
        "db_node_1": {
            "dbNodeClass": "polar.mysql.x4.medium.c",
            "dbNodeRole": "Writer",
            "hotReplicaMode": None,
            "imciSwitch": None,
        },
        "db_node_2": {
            "dbNodeClass": "polar.mysql.x4.medium.c",
            "dbNodeRole": "Reader",
            "hotReplicaMode": None,
            "imciSwitch": None,
        },
    }
default = alicloud.ens.Network("default",
    network_name="terraform-example",
    description="LoadBalancerNetworkDescription_test",
    cidr_block="192.168.2.0/24",
    ens_region_id="tr-Istanbul-1")
default_vswitch = alicloud.ens.Vswitch("default",
    description="LoadBalancerVSwitchDescription_test",
    cidr_block="192.168.2.0/24",
    vswitch_name="terraform-example",
    ens_region_id="tr-Istanbul-1",
    network_id=default.id)
default_zonal_db_cluster = alicloud.polardb.ZonalDbCluster("default",
    db_node_class="polar.mysql.x4.medium.c",
    description="terraform-example",
    ens_region_id="tr-Istanbul-1",
    vpc_id=default.id,
    vswitch_id=default_vswitch.id,
    db_cluster_nodes_configs={node: json.dumps({k: v for k, v in config if v != None}) for node, config in db_cluster_nodes_configs})

    Example coming soon!

    using System.Collections.Generic;
using System.Linq;
using System.Text.Json;
using Pulumi;
using AliCloud = Pulumi.AliCloud;

return await Deployment.RunAsync(() => 
{
    var config = new Config();
    // The advanced configuration for all nodes in the cluster except for the RW node, including db_node_class, hot_replica_mode, and imci_switch properties.
    var dbClusterNodesConfigs = config.GetObject<Dictionary<string, DbClusterNodesConfigs>>("dbClusterNodesConfigs") ?? 
    {
        { "db_node_1", 
        {
            { "dbNodeClass", "polar.mysql.x4.medium.c" },
            { "dbNodeRole", "Writer" },
            { "hotReplicaMode", null },
            { "imciSwitch", null },
        } },
        { "db_node_2", 
        {
            { "dbNodeClass", "polar.mysql.x4.medium.c" },
            { "dbNodeRole", "Reader" },
            { "hotReplicaMode", null },
            { "imciSwitch", null },
        } },
    };
    var @default = new AliCloud.Ens.Network("default", new()
    {
        NetworkName = "terraform-example",
        Description = "LoadBalancerNetworkDescription_test",
        CidrBlock = "192.168.2.0/24",
        EnsRegionId = "tr-Istanbul-1",
    });

    var defaultVswitch = new AliCloud.Ens.Vswitch("default", new()
    {
        Description = "LoadBalancerVSwitchDescription_test",
        CidrBlock = "192.168.2.0/24",
        VswitchName = "terraform-example",
        EnsRegionId = "tr-Istanbul-1",
        NetworkId = @default.Id,
    });

    var defaultZonalDbCluster = new AliCloud.PolarDB.ZonalDbCluster("default", new()
    {
        DbNodeClass = "polar.mysql.x4.medium.c",
        Description = "terraform-example",
        EnsRegionId = "tr-Istanbul-1",
        VpcId = @default.Id,
        VswitchId = defaultVswitch.Id,
        DbClusterNodesConfigs = dbClusterNodesConfigs.Select(pair => new { pair.Key, pair.Value }).ToDictionary(item => {
            var node = item.Key;
            return node;
        }, item => {
            var config = item.Value;
            return JsonSerializer.Serialize(.ToDictionary(item => {
                var k = item.Key;
                return k;
            }, item => {
                var v = item.Value;
                return v;
            }));
        }),
    });

});

public class DbClusterNodesConfigs
{
    public string dbNodeClass { get; set; }
    public string dbNodeRole { get; set; }
    public string hotReplicaMode { get; set; }
    public string imciSwitch { get; set; }
}

    Example coming soon!

    Example coming soon!

    Create ZonalDbCluster Resource

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

    Constructor syntax

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

@overload
def ZonalDbCluster(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   db_node_class: Optional[str] = None,
                   vswitch_id: Optional[str] = None,
                   vpc_id: Optional[str] = None,
                   db_cluster_nodes_configs: Optional[Mapping[str, str]] = None,
                   ens_region_id: Optional[str] = None,
                   description: Optional[str] = None,
                   db_type: Optional[str] = None,
                   db_version: Optional[str] = None,
                   auto_renew_period: Optional[int] = None,
                   db_minor_version: Optional[str] = None,
                   pay_type: Optional[str] = None,
                   renewal_status: Optional[str] = None,
                   storage_space: Optional[int] = None,
                   storage_type: Optional[str] = None,
                   target_minor_version: Optional[str] = None,
                   used_time: Optional[int] = None,
                   creation_category: Optional[str] = None,
                   cluster_version: Optional[str] = None)
    func NewZonalDbCluster(ctx *Context, name string, args ZonalDbClusterArgs, opts ...ResourceOption) (*ZonalDbCluster, error)
    public ZonalDbCluster(string name, ZonalDbClusterArgs args, CustomResourceOptions? opts = null)
    public ZonalDbCluster(String name, ZonalDbClusterArgs args)
public ZonalDbCluster(String name, ZonalDbClusterArgs args, CustomResourceOptions options)

    type: alicloud:polardb:ZonalDbCluster
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 ZonalDbClusterArgs
    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 ZonalDbClusterArgs
    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 ZonalDbClusterArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ZonalDbClusterArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ZonalDbClusterArgs
    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 zonalDbClusterResource = new AliCloud.PolarDB.ZonalDbCluster("zonalDbClusterResource", new()
{
    DbNodeClass = "string",
    VswitchId = "string",
    VpcId = "string",
    DbClusterNodesConfigs = 
    {
        { "string", "string" },
    },
    EnsRegionId = "string",
    Description = "string",
    DbType = "string",
    DbVersion = "string",
    AutoRenewPeriod = 0,
    DbMinorVersion = "string",
    PayType = "string",
    RenewalStatus = "string",
    StorageSpace = 0,
    StorageType = "string",
    TargetMinorVersion = "string",
    UsedTime = 0,
    CreationCategory = "string",
    ClusterVersion = "string",
});

    example, err := polardb.NewZonalDbCluster(ctx, "zonalDbClusterResource", &polardb.ZonalDbClusterArgs{
	DbNodeClass: pulumi.String("string"),
	VswitchId:   pulumi.String("string"),
	VpcId:       pulumi.String("string"),
	DbClusterNodesConfigs: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	EnsRegionId:        pulumi.String("string"),
	Description:        pulumi.String("string"),
	DbType:             pulumi.String("string"),
	DbVersion:          pulumi.String("string"),
	AutoRenewPeriod:    pulumi.Int(0),
	DbMinorVersion:     pulumi.String("string"),
	PayType:            pulumi.String("string"),
	RenewalStatus:      pulumi.String("string"),
	StorageSpace:       pulumi.Int(0),
	StorageType:        pulumi.String("string"),
	TargetMinorVersion: pulumi.String("string"),
	UsedTime:           pulumi.Int(0),
	CreationCategory:   pulumi.String("string"),
	ClusterVersion:     pulumi.String("string"),
})

    var zonalDbClusterResource = new ZonalDbCluster("zonalDbClusterResource", ZonalDbClusterArgs.builder()
    .dbNodeClass("string")
    .vswitchId("string")
    .vpcId("string")
    .dbClusterNodesConfigs(Map.of("string", "string"))
    .ensRegionId("string")
    .description("string")
    .dbType("string")
    .dbVersion("string")
    .autoRenewPeriod(0)
    .dbMinorVersion("string")
    .payType("string")
    .renewalStatus("string")
    .storageSpace(0)
    .storageType("string")
    .targetMinorVersion("string")
    .usedTime(0)
    .creationCategory("string")
    .clusterVersion("string")
    .build());

    zonal_db_cluster_resource = alicloud.polardb.ZonalDbCluster("zonalDbClusterResource",
    db_node_class="string",
    vswitch_id="string",
    vpc_id="string",
    db_cluster_nodes_configs={
        "string": "string",
    },
    ens_region_id="string",
    description="string",
    db_type="string",
    db_version="string",
    auto_renew_period=0,
    db_minor_version="string",
    pay_type="string",
    renewal_status="string",
    storage_space=0,
    storage_type="string",
    target_minor_version="string",
    used_time=0,
    creation_category="string",
    cluster_version="string")

    const zonalDbClusterResource = new alicloud.polardb.ZonalDbCluster("zonalDbClusterResource", {
    dbNodeClass: "string",
    vswitchId: "string",
    vpcId: "string",
    dbClusterNodesConfigs: {
        string: "string",
    },
    ensRegionId: "string",
    description: "string",
    dbType: "string",
    dbVersion: "string",
    autoRenewPeriod: 0,
    dbMinorVersion: "string",
    payType: "string",
    renewalStatus: "string",
    storageSpace: 0,
    storageType: "string",
    targetMinorVersion: "string",
    usedTime: 0,
    creationCategory: "string",
    clusterVersion: "string",
});

    type: alicloud:polardb:ZonalDbCluster
properties:
    autoRenewPeriod: 0
    clusterVersion: string
    creationCategory: string
    dbClusterNodesConfigs:
        string: string
    dbMinorVersion: string
    dbNodeClass: string
    dbType: string
    dbVersion: string
    description: string
    ensRegionId: string
    payType: string
    renewalStatus: string
    storageSpace: 0
    storageType: string
    targetMinorVersion: string
    usedTime: 0
    vpcId: string
    vswitchId: string

    ZonalDbCluster Resource Properties

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

    Inputs

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

    The ZonalDbCluster resource accepts the following input properties:

    DbClusterNodesConfigs Dictionary<string, string>
    Map of node needs to be created after DB cluster was launched.
    DbNodeClass string
    The db_node_class of cluster node.Only effective when the cluster is created for the first time. After the cluster is started, the cluster specification is maintained through the node class.
    EnsRegionId string
    The Zone to launch the DB cluster.
    VpcId string
    The id of the ENS VPC.
    VswitchId string
    The ENS virtual switch ID to launch DB instances in one VPC.
    AutoRenewPeriod int
    Auto-renewal period of an cluster, in the unit of the month. It is valid when pay_type is PrePaid. Valid value:1, 2, 3, 6, 12, 24, 36, Default to 1.
    ClusterVersion string
    current DB Cluster revision Version.
    CreationCategory string
    The edition of the PolarDB service. Valid values are SENormal.
    DbMinorVersion string
    Database minor version. Value options can refer to the latest docs CreateDBCluster DBMinorVersion. This parameter takes effect only when db_type is MySQL and db_version is 8.0.
    DbType string
    Database type. Value options: MySQL, Oracle, PostgreSQL.
    DbVersion string
    Database version. Value options can refer to the latest docs CreateDBCluster DBVersion.
    Description string
    The description of cluster.
    PayType string
    Valid values are PrePaid, PostPaid, Default to PostPaid.
    RenewalStatus string
    Valid values are AutoRenewal, Normal, NotRenewal, Default to NotRenewal.
    StorageSpace int

    Storage space charged by space (monthly package). Unit: GB.

    NOTE: Valid values for PolarDB for MySQL Standard Edition: 20 to 32000. It is valid when pay_type are PrePaid ,PostPaid.

    StorageType string
    The storage type of the cluster. Valid values are ESSDPL1, ESSDPL0.
    TargetMinorVersion string
    The Version Code of the target version, whose parameter values can be obtained from the DescribeDBClusterVersionZonal interface.
    UsedTime int

    The duration that you will buy DB cluster (in month). It is valid when pay_type is PrePaid. Valid values: [1~9], 12, 24, 36.

    NOTE: The attribute period is only used to create Subscription instance or modify the PayAsYouGo instance to PostPaid. Once effect, it will not be modified that means running pulumi up will not affect the resource.

    DbClusterNodesConfigs map[string]string
    Map of node needs to be created after DB cluster was launched.
    DbNodeClass string
    The db_node_class of cluster node.Only effective when the cluster is created for the first time. After the cluster is started, the cluster specification is maintained through the node class.
    EnsRegionId string
    The Zone to launch the DB cluster.
    VpcId string
    The id of the ENS VPC.
    VswitchId string
    The ENS virtual switch ID to launch DB instances in one VPC.
    AutoRenewPeriod int
    Auto-renewal period of an cluster, in the unit of the month. It is valid when pay_type is PrePaid. Valid value:1, 2, 3, 6, 12, 24, 36, Default to 1.
    ClusterVersion string
    current DB Cluster revision Version.
    CreationCategory string
    The edition of the PolarDB service. Valid values are SENormal.
    DbMinorVersion string
    Database minor version. Value options can refer to the latest docs CreateDBCluster DBMinorVersion. This parameter takes effect only when db_type is MySQL and db_version is 8.0.
    DbType string
    Database type. Value options: MySQL, Oracle, PostgreSQL.
    DbVersion string
    Database version. Value options can refer to the latest docs CreateDBCluster DBVersion.
    Description string
    The description of cluster.
    PayType string
    Valid values are PrePaid, PostPaid, Default to PostPaid.
    RenewalStatus string
    Valid values are AutoRenewal, Normal, NotRenewal, Default to NotRenewal.
    StorageSpace int

    Storage space charged by space (monthly package). Unit: GB.

    NOTE: Valid values for PolarDB for MySQL Standard Edition: 20 to 32000. It is valid when pay_type are PrePaid ,PostPaid.

    StorageType string
    The storage type of the cluster. Valid values are ESSDPL1, ESSDPL0.
    TargetMinorVersion string
    The Version Code of the target version, whose parameter values can be obtained from the DescribeDBClusterVersionZonal interface.
    UsedTime int

    The duration that you will buy DB cluster (in month). It is valid when pay_type is PrePaid. Valid values: [1~9], 12, 24, 36.

    NOTE: The attribute period is only used to create Subscription instance or modify the PayAsYouGo instance to PostPaid. Once effect, it will not be modified that means running pulumi up will not affect the resource.

    dbClusterNodesConfigs Map<String,String>
    Map of node needs to be created after DB cluster was launched.
    dbNodeClass String
    The db_node_class of cluster node.Only effective when the cluster is created for the first time. After the cluster is started, the cluster specification is maintained through the node class.
    ensRegionId String
    The Zone to launch the DB cluster.
    vpcId String
    The id of the ENS VPC.
    vswitchId String
    The ENS virtual switch ID to launch DB instances in one VPC.
    autoRenewPeriod Integer
    Auto-renewal period of an cluster, in the unit of the month. It is valid when pay_type is PrePaid. Valid value:1, 2, 3, 6, 12, 24, 36, Default to 1.
    clusterVersion String
    current DB Cluster revision Version.
    creationCategory String
    The edition of the PolarDB service. Valid values are SENormal.
    dbMinorVersion String
    Database minor version. Value options can refer to the latest docs CreateDBCluster DBMinorVersion. This parameter takes effect only when db_type is MySQL and db_version is 8.0.
    dbType String
    Database type. Value options: MySQL, Oracle, PostgreSQL.
    dbVersion String
    Database version. Value options can refer to the latest docs CreateDBCluster DBVersion.
    description String
    The description of cluster.
    payType String
    Valid values are PrePaid, PostPaid, Default to PostPaid.
    renewalStatus String
    Valid values are AutoRenewal, Normal, NotRenewal, Default to NotRenewal.
    storageSpace Integer

    Storage space charged by space (monthly package). Unit: GB.

    NOTE: Valid values for PolarDB for MySQL Standard Edition: 20 to 32000. It is valid when pay_type are PrePaid ,PostPaid.

    storageType String
    The storage type of the cluster. Valid values are ESSDPL1, ESSDPL0.
    targetMinorVersion String
    The Version Code of the target version, whose parameter values can be obtained from the DescribeDBClusterVersionZonal interface.
    usedTime Integer

    The duration that you will buy DB cluster (in month). It is valid when pay_type is PrePaid. Valid values: [1~9], 12, 24, 36.

    NOTE: The attribute period is only used to create Subscription instance or modify the PayAsYouGo instance to PostPaid. Once effect, it will not be modified that means running pulumi up will not affect the resource.

    dbClusterNodesConfigs {[key: string]: string}
    Map of node needs to be created after DB cluster was launched.
    dbNodeClass string
    The db_node_class of cluster node.Only effective when the cluster is created for the first time. After the cluster is started, the cluster specification is maintained through the node class.
    ensRegionId string
    The Zone to launch the DB cluster.
    vpcId string
    The id of the ENS VPC.
    vswitchId string
    The ENS virtual switch ID to launch DB instances in one VPC.
    autoRenewPeriod number
    Auto-renewal period of an cluster, in the unit of the month. It is valid when pay_type is PrePaid. Valid value:1, 2, 3, 6, 12, 24, 36, Default to 1.
    clusterVersion string
    current DB Cluster revision Version.
    creationCategory string
    The edition of the PolarDB service. Valid values are SENormal.
    dbMinorVersion string
    Database minor version. Value options can refer to the latest docs CreateDBCluster DBMinorVersion. This parameter takes effect only when db_type is MySQL and db_version is 8.0.
    dbType string
    Database type. Value options: MySQL, Oracle, PostgreSQL.
    dbVersion string
    Database version. Value options can refer to the latest docs CreateDBCluster DBVersion.
    description string
    The description of cluster.
    payType string
    Valid values are PrePaid, PostPaid, Default to PostPaid.
    renewalStatus string
    Valid values are AutoRenewal, Normal, NotRenewal, Default to NotRenewal.
    storageSpace number

    Storage space charged by space (monthly package). Unit: GB.

    NOTE: Valid values for PolarDB for MySQL Standard Edition: 20 to 32000. It is valid when pay_type are PrePaid ,PostPaid.

    storageType string
    The storage type of the cluster. Valid values are ESSDPL1, ESSDPL0.
    targetMinorVersion string
    The Version Code of the target version, whose parameter values can be obtained from the DescribeDBClusterVersionZonal interface.
    usedTime number

    The duration that you will buy DB cluster (in month). It is valid when pay_type is PrePaid. Valid values: [1~9], 12, 24, 36.

    NOTE: The attribute period is only used to create Subscription instance or modify the PayAsYouGo instance to PostPaid. Once effect, it will not be modified that means running pulumi up will not affect the resource.

    db_cluster_nodes_configs Mapping[str, str]
    Map of node needs to be created after DB cluster was launched.
    db_node_class str
    The db_node_class of cluster node.Only effective when the cluster is created for the first time. After the cluster is started, the cluster specification is maintained through the node class.
    ens_region_id str
    The Zone to launch the DB cluster.
    vpc_id str
    The id of the ENS VPC.
    vswitch_id str
    The ENS virtual switch ID to launch DB instances in one VPC.
    auto_renew_period int
    Auto-renewal period of an cluster, in the unit of the month. It is valid when pay_type is PrePaid. Valid value:1, 2, 3, 6, 12, 24, 36, Default to 1.
    cluster_version str
    current DB Cluster revision Version.
    creation_category str
    The edition of the PolarDB service. Valid values are SENormal.
    db_minor_version str
    Database minor version. Value options can refer to the latest docs CreateDBCluster DBMinorVersion. This parameter takes effect only when db_type is MySQL and db_version is 8.0.
    db_type str
    Database type. Value options: MySQL, Oracle, PostgreSQL.
    db_version str
    Database version. Value options can refer to the latest docs CreateDBCluster DBVersion.
    description str
    The description of cluster.
    pay_type str
    Valid values are PrePaid, PostPaid, Default to PostPaid.
    renewal_status str
    Valid values are AutoRenewal, Normal, NotRenewal, Default to NotRenewal.
    storage_space int

    Storage space charged by space (monthly package). Unit: GB.

    NOTE: Valid values for PolarDB for MySQL Standard Edition: 20 to 32000. It is valid when pay_type are PrePaid ,PostPaid.

    storage_type str
    The storage type of the cluster. Valid values are ESSDPL1, ESSDPL0.
    target_minor_version str
    The Version Code of the target version, whose parameter values can be obtained from the DescribeDBClusterVersionZonal interface.
    used_time int

    The duration that you will buy DB cluster (in month). It is valid when pay_type is PrePaid. Valid values: [1~9], 12, 24, 36.

    NOTE: The attribute period is only used to create Subscription instance or modify the PayAsYouGo instance to PostPaid. Once effect, it will not be modified that means running pulumi up will not affect the resource.

    dbClusterNodesConfigs Map<String>
    Map of node needs to be created after DB cluster was launched.
    dbNodeClass String
    The db_node_class of cluster node.Only effective when the cluster is created for the first time. After the cluster is started, the cluster specification is maintained through the node class.
    ensRegionId String
    The Zone to launch the DB cluster.
    vpcId String
    The id of the ENS VPC.
    vswitchId String
    The ENS virtual switch ID to launch DB instances in one VPC.
    autoRenewPeriod Number
    Auto-renewal period of an cluster, in the unit of the month. It is valid when pay_type is PrePaid. Valid value:1, 2, 3, 6, 12, 24, 36, Default to 1.
    clusterVersion String
    current DB Cluster revision Version.
    creationCategory String
    The edition of the PolarDB service. Valid values are SENormal.
    dbMinorVersion String
    Database minor version. Value options can refer to the latest docs CreateDBCluster DBMinorVersion. This parameter takes effect only when db_type is MySQL and db_version is 8.0.
    dbType String
    Database type. Value options: MySQL, Oracle, PostgreSQL.
    dbVersion String
    Database version. Value options can refer to the latest docs CreateDBCluster DBVersion.
    description String
    The description of cluster.
    payType String
    Valid values are PrePaid, PostPaid, Default to PostPaid.
    renewalStatus String
    Valid values are AutoRenewal, Normal, NotRenewal, Default to NotRenewal.
    storageSpace Number

    Storage space charged by space (monthly package). Unit: GB.

    NOTE: Valid values for PolarDB for MySQL Standard Edition: 20 to 32000. It is valid when pay_type are PrePaid ,PostPaid.

    storageType String
    The storage type of the cluster. Valid values are ESSDPL1, ESSDPL0.
    targetMinorVersion String
    The Version Code of the target version, whose parameter values can be obtained from the DescribeDBClusterVersionZonal interface.
    usedTime Number

    The duration that you will buy DB cluster (in month). It is valid when pay_type is PrePaid. Valid values: [1~9], 12, 24, 36.

    NOTE: The attribute period is only used to create Subscription instance or modify the PayAsYouGo instance to PostPaid. Once effect, it will not be modified that means running pulumi up will not affect the resource.

    Outputs

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

    ClusterLatestVersion string
    PolarDB zonal cluster latest version.
    CreateTime string
    PolarDB zonal cluster creation time.
    DbClusterNodesAttributes Dictionary<string, string>
    Cache of the relationship between node key and node ID for PolarDB zonal Cluster
    DbClusterNodesIds Dictionary<string, string>
    Cache of node ID for PolarDB zonal Cluster
    Id string
    The provider-assigned unique ID for this managed resource.
    RegionId string
    PolarDB zonal cluster region
    StoragePayType string
    The billing method of the storage. Valid values Prepaid.
    ClusterLatestVersion string
    PolarDB zonal cluster latest version.
    CreateTime string
    PolarDB zonal cluster creation time.
    DbClusterNodesAttributes map[string]string
    Cache of the relationship between node key and node ID for PolarDB zonal Cluster
    DbClusterNodesIds map[string]string
    Cache of node ID for PolarDB zonal Cluster
    Id string
    The provider-assigned unique ID for this managed resource.
    RegionId string
    PolarDB zonal cluster region
    StoragePayType string
    The billing method of the storage. Valid values Prepaid.
    clusterLatestVersion String
    PolarDB zonal cluster latest version.
    createTime String
    PolarDB zonal cluster creation time.
    dbClusterNodesAttributes Map<String,String>
    Cache of the relationship between node key and node ID for PolarDB zonal Cluster
    dbClusterNodesIds Map<String,String>
    Cache of node ID for PolarDB zonal Cluster
    id String
    The provider-assigned unique ID for this managed resource.
    regionId String
    PolarDB zonal cluster region
    storagePayType String
    The billing method of the storage. Valid values Prepaid.
    clusterLatestVersion string
    PolarDB zonal cluster latest version.
    createTime string
    PolarDB zonal cluster creation time.
    dbClusterNodesAttributes {[key: string]: string}
    Cache of the relationship between node key and node ID for PolarDB zonal Cluster
    dbClusterNodesIds {[key: string]: string}
    Cache of node ID for PolarDB zonal Cluster
    id string
    The provider-assigned unique ID for this managed resource.
    regionId string
    PolarDB zonal cluster region
    storagePayType string
    The billing method of the storage. Valid values Prepaid.
    cluster_latest_version str
    PolarDB zonal cluster latest version.
    create_time str
    PolarDB zonal cluster creation time.
    db_cluster_nodes_attributes Mapping[str, str]
    Cache of the relationship between node key and node ID for PolarDB zonal Cluster
    db_cluster_nodes_ids Mapping[str, str]
    Cache of node ID for PolarDB zonal Cluster
    id str
    The provider-assigned unique ID for this managed resource.
    region_id str
    PolarDB zonal cluster region
    storage_pay_type str
    The billing method of the storage. Valid values Prepaid.
    clusterLatestVersion String
    PolarDB zonal cluster latest version.
    createTime String
    PolarDB zonal cluster creation time.
    dbClusterNodesAttributes Map<String>
    Cache of the relationship between node key and node ID for PolarDB zonal Cluster
    dbClusterNodesIds Map<String>
    Cache of node ID for PolarDB zonal Cluster
    id String
    The provider-assigned unique ID for this managed resource.
    regionId String
    PolarDB zonal cluster region
    storagePayType String
    The billing method of the storage. Valid values Prepaid.

    Look up Existing ZonalDbCluster Resource

    Get an existing ZonalDbCluster 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?: ZonalDbClusterState, opts?: CustomResourceOptions): ZonalDbCluster
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        auto_renew_period: Optional[int] = None,
        cluster_latest_version: Optional[str] = None,
        cluster_version: Optional[str] = None,
        create_time: Optional[str] = None,
        creation_category: Optional[str] = None,
        db_cluster_nodes_attributes: Optional[Mapping[str, str]] = None,
        db_cluster_nodes_configs: Optional[Mapping[str, str]] = None,
        db_cluster_nodes_ids: Optional[Mapping[str, str]] = None,
        db_minor_version: Optional[str] = None,
        db_node_class: Optional[str] = None,
        db_type: Optional[str] = None,
        db_version: Optional[str] = None,
        description: Optional[str] = None,
        ens_region_id: Optional[str] = None,
        pay_type: Optional[str] = None,
        region_id: Optional[str] = None,
        renewal_status: Optional[str] = None,
        storage_pay_type: Optional[str] = None,
        storage_space: Optional[int] = None,
        storage_type: Optional[str] = None,
        target_minor_version: Optional[str] = None,
        used_time: Optional[int] = None,
        vpc_id: Optional[str] = None,
        vswitch_id: Optional[str] = None) -> ZonalDbCluster
    func GetZonalDbCluster(ctx *Context, name string, id IDInput, state *ZonalDbClusterState, opts ...ResourceOption) (*ZonalDbCluster, error)
    public static ZonalDbCluster Get(string name, Input<string> id, ZonalDbClusterState? state, CustomResourceOptions? opts = null)
    public static ZonalDbCluster get(String name, Output<String> id, ZonalDbClusterState state, CustomResourceOptions options)
    resources:  _:    type: alicloud:polardb:ZonalDbCluster    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AutoRenewPeriod int
    Auto-renewal period of an cluster, in the unit of the month. It is valid when pay_type is PrePaid. Valid value:1, 2, 3, 6, 12, 24, 36, Default to 1.
    ClusterLatestVersion string
    PolarDB zonal cluster latest version.
    ClusterVersion string
    current DB Cluster revision Version.
    CreateTime string
    PolarDB zonal cluster creation time.
    CreationCategory string
    The edition of the PolarDB service. Valid values are SENormal.
    DbClusterNodesAttributes Dictionary<string, string>
    Cache of the relationship between node key and node ID for PolarDB zonal Cluster
    DbClusterNodesConfigs Dictionary<string, string>
    Map of node needs to be created after DB cluster was launched.
    DbClusterNodesIds Dictionary<string, string>
    Cache of node ID for PolarDB zonal Cluster
    DbMinorVersion string
    Database minor version. Value options can refer to the latest docs CreateDBCluster DBMinorVersion. This parameter takes effect only when db_type is MySQL and db_version is 8.0.
    DbNodeClass string
    The db_node_class of cluster node.Only effective when the cluster is created for the first time. After the cluster is started, the cluster specification is maintained through the node class.
    DbType string
    Database type. Value options: MySQL, Oracle, PostgreSQL.
    DbVersion string
    Database version. Value options can refer to the latest docs CreateDBCluster DBVersion.
    Description string
    The description of cluster.
    EnsRegionId string
    The Zone to launch the DB cluster.
    PayType string
    Valid values are PrePaid, PostPaid, Default to PostPaid.
    RegionId string
    PolarDB zonal cluster region
    RenewalStatus string
    Valid values are AutoRenewal, Normal, NotRenewal, Default to NotRenewal.
    StoragePayType string
    The billing method of the storage. Valid values Prepaid.
    StorageSpace int

    Storage space charged by space (monthly package). Unit: GB.

    NOTE: Valid values for PolarDB for MySQL Standard Edition: 20 to 32000. It is valid when pay_type are PrePaid ,PostPaid.

    StorageType string
    The storage type of the cluster. Valid values are ESSDPL1, ESSDPL0.
    TargetMinorVersion string
    The Version Code of the target version, whose parameter values can be obtained from the DescribeDBClusterVersionZonal interface.
    UsedTime int

    The duration that you will buy DB cluster (in month). It is valid when pay_type is PrePaid. Valid values: [1~9], 12, 24, 36.

    NOTE: The attribute period is only used to create Subscription instance or modify the PayAsYouGo instance to PostPaid. Once effect, it will not be modified that means running pulumi up will not affect the resource.

    VpcId string
    The id of the ENS VPC.
    VswitchId string
    The ENS virtual switch ID to launch DB instances in one VPC.
    AutoRenewPeriod int
    Auto-renewal period of an cluster, in the unit of the month. It is valid when pay_type is PrePaid. Valid value:1, 2, 3, 6, 12, 24, 36, Default to 1.
    ClusterLatestVersion string
    PolarDB zonal cluster latest version.
    ClusterVersion string
    current DB Cluster revision Version.
    CreateTime string
    PolarDB zonal cluster creation time.
    CreationCategory string
    The edition of the PolarDB service. Valid values are SENormal.
    DbClusterNodesAttributes map[string]string
    Cache of the relationship between node key and node ID for PolarDB zonal Cluster
    DbClusterNodesConfigs map[string]string
    Map of node needs to be created after DB cluster was launched.
    DbClusterNodesIds map[string]string
    Cache of node ID for PolarDB zonal Cluster
    DbMinorVersion string
    Database minor version. Value options can refer to the latest docs CreateDBCluster DBMinorVersion. This parameter takes effect only when db_type is MySQL and db_version is 8.0.
    DbNodeClass string
    The db_node_class of cluster node.Only effective when the cluster is created for the first time. After the cluster is started, the cluster specification is maintained through the node class.
    DbType string
    Database type. Value options: MySQL, Oracle, PostgreSQL.
    DbVersion string
    Database version. Value options can refer to the latest docs CreateDBCluster DBVersion.
    Description string
    The description of cluster.
    EnsRegionId string
    The Zone to launch the DB cluster.
    PayType string
    Valid values are PrePaid, PostPaid, Default to PostPaid.
    RegionId string
    PolarDB zonal cluster region
    RenewalStatus string
    Valid values are AutoRenewal, Normal, NotRenewal, Default to NotRenewal.
    StoragePayType string
    The billing method of the storage. Valid values Prepaid.
    StorageSpace int

    Storage space charged by space (monthly package). Unit: GB.

    NOTE: Valid values for PolarDB for MySQL Standard Edition: 20 to 32000. It is valid when pay_type are PrePaid ,PostPaid.

    StorageType string
    The storage type of the cluster. Valid values are ESSDPL1, ESSDPL0.
    TargetMinorVersion string
    The Version Code of the target version, whose parameter values can be obtained from the DescribeDBClusterVersionZonal interface.
    UsedTime int

    The duration that you will buy DB cluster (in month). It is valid when pay_type is PrePaid. Valid values: [1~9], 12, 24, 36.

    NOTE: The attribute period is only used to create Subscription instance or modify the PayAsYouGo instance to PostPaid. Once effect, it will not be modified that means running pulumi up will not affect the resource.

    VpcId string
    The id of the ENS VPC.
    VswitchId string
    The ENS virtual switch ID to launch DB instances in one VPC.
    autoRenewPeriod Integer
    Auto-renewal period of an cluster, in the unit of the month. It is valid when pay_type is PrePaid. Valid value:1, 2, 3, 6, 12, 24, 36, Default to 1.
    clusterLatestVersion String
    PolarDB zonal cluster latest version.
    clusterVersion String
    current DB Cluster revision Version.
    createTime String
    PolarDB zonal cluster creation time.
    creationCategory String
    The edition of the PolarDB service. Valid values are SENormal.
    dbClusterNodesAttributes Map<String,String>
    Cache of the relationship between node key and node ID for PolarDB zonal Cluster
    dbClusterNodesConfigs Map<String,String>
    Map of node needs to be created after DB cluster was launched.
    dbClusterNodesIds Map<String,String>
    Cache of node ID for PolarDB zonal Cluster
    dbMinorVersion String
    Database minor version. Value options can refer to the latest docs CreateDBCluster DBMinorVersion. This parameter takes effect only when db_type is MySQL and db_version is 8.0.
    dbNodeClass String
    The db_node_class of cluster node.Only effective when the cluster is created for the first time. After the cluster is started, the cluster specification is maintained through the node class.
    dbType String
    Database type. Value options: MySQL, Oracle, PostgreSQL.
    dbVersion String
    Database version. Value options can refer to the latest docs CreateDBCluster DBVersion.
    description String
    The description of cluster.
    ensRegionId String
    The Zone to launch the DB cluster.
    payType String
    Valid values are PrePaid, PostPaid, Default to PostPaid.
    regionId String
    PolarDB zonal cluster region
    renewalStatus String
    Valid values are AutoRenewal, Normal, NotRenewal, Default to NotRenewal.
    storagePayType String
    The billing method of the storage. Valid values Prepaid.
    storageSpace Integer

    Storage space charged by space (monthly package). Unit: GB.

    NOTE: Valid values for PolarDB for MySQL Standard Edition: 20 to 32000. It is valid when pay_type are PrePaid ,PostPaid.

    storageType String
    The storage type of the cluster. Valid values are ESSDPL1, ESSDPL0.
    targetMinorVersion String
    The Version Code of the target version, whose parameter values can be obtained from the DescribeDBClusterVersionZonal interface.
    usedTime Integer

    The duration that you will buy DB cluster (in month). It is valid when pay_type is PrePaid. Valid values: [1~9], 12, 24, 36.

    NOTE: The attribute period is only used to create Subscription instance or modify the PayAsYouGo instance to PostPaid. Once effect, it will not be modified that means running pulumi up will not affect the resource.

    vpcId String
    The id of the ENS VPC.
    vswitchId String
    The ENS virtual switch ID to launch DB instances in one VPC.
    autoRenewPeriod number
    Auto-renewal period of an cluster, in the unit of the month. It is valid when pay_type is PrePaid. Valid value:1, 2, 3, 6, 12, 24, 36, Default to 1.
    clusterLatestVersion string
    PolarDB zonal cluster latest version.
    clusterVersion string
    current DB Cluster revision Version.
    createTime string
    PolarDB zonal cluster creation time.
    creationCategory string
    The edition of the PolarDB service. Valid values are SENormal.
    dbClusterNodesAttributes {[key: string]: string}
    Cache of the relationship between node key and node ID for PolarDB zonal Cluster
    dbClusterNodesConfigs {[key: string]: string}
    Map of node needs to be created after DB cluster was launched.
    dbClusterNodesIds {[key: string]: string}
    Cache of node ID for PolarDB zonal Cluster
    dbMinorVersion string
    Database minor version. Value options can refer to the latest docs CreateDBCluster DBMinorVersion. This parameter takes effect only when db_type is MySQL and db_version is 8.0.
    dbNodeClass string
    The db_node_class of cluster node.Only effective when the cluster is created for the first time. After the cluster is started, the cluster specification is maintained through the node class.
    dbType string
    Database type. Value options: MySQL, Oracle, PostgreSQL.
    dbVersion string
    Database version. Value options can refer to the latest docs CreateDBCluster DBVersion.
    description string
    The description of cluster.
    ensRegionId string
    The Zone to launch the DB cluster.
    payType string
    Valid values are PrePaid, PostPaid, Default to PostPaid.
    regionId string
    PolarDB zonal cluster region
    renewalStatus string
    Valid values are AutoRenewal, Normal, NotRenewal, Default to NotRenewal.
    storagePayType string
    The billing method of the storage. Valid values Prepaid.
    storageSpace number

    Storage space charged by space (monthly package). Unit: GB.

    NOTE: Valid values for PolarDB for MySQL Standard Edition: 20 to 32000. It is valid when pay_type are PrePaid ,PostPaid.

    storageType string
    The storage type of the cluster. Valid values are ESSDPL1, ESSDPL0.
    targetMinorVersion string
    The Version Code of the target version, whose parameter values can be obtained from the DescribeDBClusterVersionZonal interface.
    usedTime number

    The duration that you will buy DB cluster (in month). It is valid when pay_type is PrePaid. Valid values: [1~9], 12, 24, 36.

    NOTE: The attribute period is only used to create Subscription instance or modify the PayAsYouGo instance to PostPaid. Once effect, it will not be modified that means running pulumi up will not affect the resource.

    vpcId string
    The id of the ENS VPC.
    vswitchId string
    The ENS virtual switch ID to launch DB instances in one VPC.
    auto_renew_period int
    Auto-renewal period of an cluster, in the unit of the month. It is valid when pay_type is PrePaid. Valid value:1, 2, 3, 6, 12, 24, 36, Default to 1.
    cluster_latest_version str
    PolarDB zonal cluster latest version.
    cluster_version str
    current DB Cluster revision Version.
    create_time str
    PolarDB zonal cluster creation time.
    creation_category str
    The edition of the PolarDB service. Valid values are SENormal.
    db_cluster_nodes_attributes Mapping[str, str]
    Cache of the relationship between node key and node ID for PolarDB zonal Cluster
    db_cluster_nodes_configs Mapping[str, str]
    Map of node needs to be created after DB cluster was launched.
    db_cluster_nodes_ids Mapping[str, str]
    Cache of node ID for PolarDB zonal Cluster
    db_minor_version str
    Database minor version. Value options can refer to the latest docs CreateDBCluster DBMinorVersion. This parameter takes effect only when db_type is MySQL and db_version is 8.0.
    db_node_class str
    The db_node_class of cluster node.Only effective when the cluster is created for the first time. After the cluster is started, the cluster specification is maintained through the node class.
    db_type str
    Database type. Value options: MySQL, Oracle, PostgreSQL.
    db_version str
    Database version. Value options can refer to the latest docs CreateDBCluster DBVersion.
    description str
    The description of cluster.
    ens_region_id str
    The Zone to launch the DB cluster.
    pay_type str
    Valid values are PrePaid, PostPaid, Default to PostPaid.
    region_id str
    PolarDB zonal cluster region
    renewal_status str
    Valid values are AutoRenewal, Normal, NotRenewal, Default to NotRenewal.
    storage_pay_type str
    The billing method of the storage. Valid values Prepaid.
    storage_space int

    Storage space charged by space (monthly package). Unit: GB.

    NOTE: Valid values for PolarDB for MySQL Standard Edition: 20 to 32000. It is valid when pay_type are PrePaid ,PostPaid.

    storage_type str
    The storage type of the cluster. Valid values are ESSDPL1, ESSDPL0.
    target_minor_version str
    The Version Code of the target version, whose parameter values can be obtained from the DescribeDBClusterVersionZonal interface.
    used_time int

    The duration that you will buy DB cluster (in month). It is valid when pay_type is PrePaid. Valid values: [1~9], 12, 24, 36.

    NOTE: The attribute period is only used to create Subscription instance or modify the PayAsYouGo instance to PostPaid. Once effect, it will not be modified that means running pulumi up will not affect the resource.

    vpc_id str
    The id of the ENS VPC.
    vswitch_id str
    The ENS virtual switch ID to launch DB instances in one VPC.
    autoRenewPeriod Number
    Auto-renewal period of an cluster, in the unit of the month. It is valid when pay_type is PrePaid. Valid value:1, 2, 3, 6, 12, 24, 36, Default to 1.
    clusterLatestVersion String
    PolarDB zonal cluster latest version.
    clusterVersion String
    current DB Cluster revision Version.
    createTime String
    PolarDB zonal cluster creation time.
    creationCategory String
    The edition of the PolarDB service. Valid values are SENormal.
    dbClusterNodesAttributes Map<String>
    Cache of the relationship between node key and node ID for PolarDB zonal Cluster
    dbClusterNodesConfigs Map<String>
    Map of node needs to be created after DB cluster was launched.
    dbClusterNodesIds Map<String>
    Cache of node ID for PolarDB zonal Cluster
    dbMinorVersion String
    Database minor version. Value options can refer to the latest docs CreateDBCluster DBMinorVersion. This parameter takes effect only when db_type is MySQL and db_version is 8.0.
    dbNodeClass String
    The db_node_class of cluster node.Only effective when the cluster is created for the first time. After the cluster is started, the cluster specification is maintained through the node class.
    dbType String
    Database type. Value options: MySQL, Oracle, PostgreSQL.
    dbVersion String
    Database version. Value options can refer to the latest docs CreateDBCluster DBVersion.
    description String
    The description of cluster.
    ensRegionId String
    The Zone to launch the DB cluster.
    payType String
    Valid values are PrePaid, PostPaid, Default to PostPaid.
    regionId String
    PolarDB zonal cluster region
    renewalStatus String
    Valid values are AutoRenewal, Normal, NotRenewal, Default to NotRenewal.
    storagePayType String
    The billing method of the storage. Valid values Prepaid.
    storageSpace Number

    Storage space charged by space (monthly package). Unit: GB.

    NOTE: Valid values for PolarDB for MySQL Standard Edition: 20 to 32000. It is valid when pay_type are PrePaid ,PostPaid.

    storageType String
    The storage type of the cluster. Valid values are ESSDPL1, ESSDPL0.
    targetMinorVersion String
    The Version Code of the target version, whose parameter values can be obtained from the DescribeDBClusterVersionZonal interface.
    usedTime Number

    The duration that you will buy DB cluster (in month). It is valid when pay_type is PrePaid. Valid values: [1~9], 12, 24, 36.

    NOTE: The attribute period is only used to create Subscription instance or modify the PayAsYouGo instance to PostPaid. Once effect, it will not be modified that means running pulumi up will not affect the resource.

    vpcId String
    The id of the ENS VPC.
    vswitchId String
    The ENS virtual switch ID to launch DB instances in one VPC.

    Import

    PolarDB zonal cluster can be imported using the id, e.g.

    $ pulumi import alicloud:polardb/zonalDbCluster:ZonalDbCluster example pc-abc12345678

    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.87.0 published on Saturday, Oct 18, 2025 by Pulumi
    pulumi/pulumi-alicloud
      Meet Neo: Your AI Platform Teammate