1. Pulumi Registry
  2. Alibaba Cloud
  3. API Docs
  4. polardb
  5. Cluster
alicloud logo
Alibaba Cloud v3.34.0, Mar 17 23

alicloud.polardb.Cluster

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

NOTE: Available in v1.66.0+.

Example Usage

Create a PolarDB MySQL cluster

using System.Collections.Generic;
using Pulumi;
using AliCloud = Pulumi.AliCloud;

return await Deployment.RunAsync(() => 
{
    var config = new Config();
    var name = config.Get("name") ?? "polardbClusterconfig";
    var creation = config.Get("creation") ?? "PolarDB";
    var defaultZones = AliCloud.GetZones.Invoke(new()
    {
        AvailableResourceCreation = creation,
    });

    var defaultNetwork = new AliCloud.Vpc.Network("defaultNetwork", new()
    {
        VpcName = name,
        CidrBlock = "172.16.0.0/16",
    });

    var defaultSwitch = new AliCloud.Vpc.Switch("defaultSwitch", new()
    {
        VpcId = defaultNetwork.Id,
        CidrBlock = "172.16.0.0/24",
        ZoneId = defaultZones.Apply(getZonesResult => getZonesResult.Zones[0]?.Id),
        VswitchName = name,
    });

    var defaultCluster = new AliCloud.PolarDB.Cluster("defaultCluster", new()
    {
        DbType = "MySQL",
        DbVersion = "5.6",
        DbNodeClass = "polar.mysql.x4.medium",
        PayType = "PostPaid",
        Description = name,
        VswitchId = defaultSwitch.Id,
        DbClusterIpArrays = new[]
        {
            new AliCloud.PolarDB.Inputs.ClusterDbClusterIpArrayArgs
            {
                DbClusterIpArrayName = "default",
                SecurityIps = new[]
                {
                    "1.2.3.4",
                    "1.2.3.5",
                },
            },
            new AliCloud.PolarDB.Inputs.ClusterDbClusterIpArrayArgs
            {
                DbClusterIpArrayName = "test_ips1",
                SecurityIps = new[]
                {
                    "1.2.3.6",
                },
            },
        },
    });

});

package main

import (
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud"
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/polardb"
	"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 := "polardbClusterconfig"
		if param := cfg.Get("name"); param != "" {
			name = param
		}
		creation := "PolarDB"
		if param := cfg.Get("creation"); param != "" {
			creation = param
		}
		defaultZones, err := alicloud.GetZones(ctx, &alicloud.GetZonesArgs{
			AvailableResourceCreation: pulumi.StringRef(creation),
		}, nil)
		if err != nil {
			return err
		}
		defaultNetwork, err := vpc.NewNetwork(ctx, "defaultNetwork", &vpc.NetworkArgs{
			VpcName:   pulumi.String(name),
			CidrBlock: pulumi.String("172.16.0.0/16"),
		})
		if err != nil {
			return err
		}
		defaultSwitch, err := vpc.NewSwitch(ctx, "defaultSwitch", &vpc.SwitchArgs{
			VpcId:       defaultNetwork.ID(),
			CidrBlock:   pulumi.String("172.16.0.0/24"),
			ZoneId:      *pulumi.String(defaultZones.Zones[0].Id),
			VswitchName: pulumi.String(name),
		})
		if err != nil {
			return err
		}
		_, err = polardb.NewCluster(ctx, "defaultCluster", &polardb.ClusterArgs{
			DbType:      pulumi.String("MySQL"),
			DbVersion:   pulumi.String("5.6"),
			DbNodeClass: pulumi.String("polar.mysql.x4.medium"),
			PayType:     pulumi.String("PostPaid"),
			Description: pulumi.String(name),
			VswitchId:   defaultSwitch.ID(),
			DbClusterIpArrays: polardb.ClusterDbClusterIpArrayArray{
				&polardb.ClusterDbClusterIpArrayArgs{
					DbClusterIpArrayName: pulumi.String("default"),
					SecurityIps: pulumi.StringArray{
						pulumi.String("1.2.3.4"),
						pulumi.String("1.2.3.5"),
					},
				},
				&polardb.ClusterDbClusterIpArrayArgs{
					DbClusterIpArrayName: pulumi.String("test_ips1"),
					SecurityIps: pulumi.StringArray{
						pulumi.String("1.2.3.6"),
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.AlicloudFunctions;
import com.pulumi.alicloud.inputs.GetZonesArgs;
import com.pulumi.alicloud.vpc.Network;
import com.pulumi.alicloud.vpc.NetworkArgs;
import com.pulumi.alicloud.vpc.Switch;
import com.pulumi.alicloud.vpc.SwitchArgs;
import com.pulumi.alicloud.polardb.Cluster;
import com.pulumi.alicloud.polardb.ClusterArgs;
import com.pulumi.alicloud.polardb.inputs.ClusterDbClusterIpArrayArgs;
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("polardbClusterconfig");
        final var creation = config.get("creation").orElse("PolarDB");
        final var defaultZones = AlicloudFunctions.getZones(GetZonesArgs.builder()
            .availableResourceCreation(creation)
            .build());

        var defaultNetwork = new Network("defaultNetwork", NetworkArgs.builder()        
            .vpcName(name)
            .cidrBlock("172.16.0.0/16")
            .build());

        var defaultSwitch = new Switch("defaultSwitch", SwitchArgs.builder()        
            .vpcId(defaultNetwork.id())
            .cidrBlock("172.16.0.0/24")
            .zoneId(defaultZones.applyValue(getZonesResult -> getZonesResult.zones()[0].id()))
            .vswitchName(name)
            .build());

        var defaultCluster = new Cluster("defaultCluster", ClusterArgs.builder()        
            .dbType("MySQL")
            .dbVersion("5.6")
            .dbNodeClass("polar.mysql.x4.medium")
            .payType("PostPaid")
            .description(name)
            .vswitchId(defaultSwitch.id())
            .dbClusterIpArrays(            
                ClusterDbClusterIpArrayArgs.builder()
                    .dbClusterIpArrayName("default")
                    .securityIps(                    
                        "1.2.3.4",
                        "1.2.3.5")
                    .build(),
                ClusterDbClusterIpArrayArgs.builder()
                    .dbClusterIpArrayName("test_ips1")
                    .securityIps("1.2.3.6")
                    .build())
            .build());

    }
}

import pulumi
import pulumi_alicloud as alicloud

config = pulumi.Config()
name = config.get("name")
if name is None:
    name = "polardbClusterconfig"
creation = config.get("creation")
if creation is None:
    creation = "PolarDB"
default_zones = alicloud.get_zones(available_resource_creation=creation)
default_network = alicloud.vpc.Network("defaultNetwork",
    vpc_name=name,
    cidr_block="172.16.0.0/16")
default_switch = alicloud.vpc.Switch("defaultSwitch",
    vpc_id=default_network.id,
    cidr_block="172.16.0.0/24",
    zone_id=default_zones.zones[0].id,
    vswitch_name=name)
default_cluster = alicloud.polardb.Cluster("defaultCluster",
    db_type="MySQL",
    db_version="5.6",
    db_node_class="polar.mysql.x4.medium",
    pay_type="PostPaid",
    description=name,
    vswitch_id=default_switch.id,
    db_cluster_ip_arrays=[
        alicloud.polardb.ClusterDbClusterIpArrayArgs(
            db_cluster_ip_array_name="default",
            security_ips=[
                "1.2.3.4",
                "1.2.3.5",
            ],
        ),
        alicloud.polardb.ClusterDbClusterIpArrayArgs(
            db_cluster_ip_array_name="test_ips1",
            security_ips=["1.2.3.6"],
        ),
    ])

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

const config = new pulumi.Config();
const name = config.get("name") || "polardbClusterconfig";
const creation = config.get("creation") || "PolarDB";
const defaultZones = alicloud.getZones({
    availableResourceCreation: creation,
});
const defaultNetwork = new alicloud.vpc.Network("defaultNetwork", {
    vpcName: name,
    cidrBlock: "172.16.0.0/16",
});
const defaultSwitch = new alicloud.vpc.Switch("defaultSwitch", {
    vpcId: defaultNetwork.id,
    cidrBlock: "172.16.0.0/24",
    zoneId: defaultZones.then(defaultZones => defaultZones.zones?.[0]?.id),
    vswitchName: name,
});
const defaultCluster = new alicloud.polardb.Cluster("defaultCluster", {
    dbType: "MySQL",
    dbVersion: "5.6",
    dbNodeClass: "polar.mysql.x4.medium",
    payType: "PostPaid",
    description: name,
    vswitchId: defaultSwitch.id,
    dbClusterIpArrays: [
        {
            dbClusterIpArrayName: "default",
            securityIps: [
                "1.2.3.4",
                "1.2.3.5",
            ],
        },
        {
            dbClusterIpArrayName: "test_ips1",
            securityIps: ["1.2.3.6"],
        },
    ],
});

configuration:
  name:
    type: string
    default: polardbClusterconfig
  creation:
    type: string
    default: PolarDB
resources:
  defaultNetwork:
    type: alicloud:vpc:Network
    properties:
      vpcName: ${name}
      cidrBlock: 172.16.0.0/16
  defaultSwitch:
    type: alicloud:vpc:Switch
    properties:
      vpcId: ${defaultNetwork.id}
      cidrBlock: 172.16.0.0/24
      zoneId: ${defaultZones.zones[0].id}
      vswitchName: ${name}
  defaultCluster:
    type: alicloud:polardb:Cluster
    properties:
      dbType: MySQL
      dbVersion: '5.6'
      dbNodeClass: polar.mysql.x4.medium
      payType: PostPaid
      description: ${name}
      vswitchId: ${defaultSwitch.id}
      dbClusterIpArrays:
        - dbClusterIpArrayName: default
          securityIps:
            - 1.2.3.4
            - 1.2.3.5
        - dbClusterIpArrayName: test_ips1
          securityIps:
            - 1.2.3.6
variables:
  defaultZones:
    fn::invoke:
      Function: alicloud:getZones
      Arguments:
        availableResourceCreation: ${creation}

Create Cluster Resource

new Cluster(name: string, args: ClusterArgs, opts?: CustomResourceOptions);
@overload
def Cluster(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            auto_renew_period: Optional[int] = None,
            backup_retention_policy_on_cluster_deletion: Optional[str] = None,
            clone_data_point: Optional[str] = None,
            collector_status: Optional[str] = None,
            creation_category: Optional[str] = None,
            creation_option: Optional[str] = None,
            db_cluster_ip_arrays: Optional[Sequence[ClusterDbClusterIpArrayArgs]] = None,
            db_node_class: Optional[str] = None,
            db_node_count: Optional[int] = None,
            db_type: Optional[str] = None,
            db_version: Optional[str] = None,
            deletion_lock: Optional[int] = None,
            description: Optional[str] = None,
            encrypt_new_tables: Optional[str] = None,
            encryption_key: Optional[str] = None,
            gdn_id: Optional[str] = None,
            imci_switch: Optional[str] = None,
            maintain_time: Optional[str] = None,
            modify_type: Optional[str] = None,
            parameters: Optional[Sequence[ClusterParameterArgs]] = None,
            pay_type: Optional[str] = None,
            period: Optional[int] = None,
            renewal_status: Optional[str] = None,
            resource_group_id: Optional[str] = None,
            role_arn: Optional[str] = None,
            security_group_ids: Optional[Sequence[str]] = None,
            security_ips: Optional[Sequence[str]] = None,
            source_resource_id: Optional[str] = None,
            sub_category: Optional[str] = None,
            tags: Optional[Mapping[str, Any]] = None,
            tde_status: Optional[str] = None,
            vpc_id: Optional[str] = None,
            vswitch_id: Optional[str] = None,
            zone_id: Optional[str] = None)
@overload
def Cluster(resource_name: str,
            args: ClusterArgs,
            opts: Optional[ResourceOptions] = None)
func NewCluster(ctx *Context, name string, args ClusterArgs, opts ...ResourceOption) (*Cluster, error)
public Cluster(string name, ClusterArgs args, CustomResourceOptions? opts = null)
public Cluster(String name, ClusterArgs args)
public Cluster(String name, ClusterArgs args, CustomResourceOptions options)

type: alicloud:polardb:Cluster
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
name string
The unique name of the resource.
args ClusterArgs
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 ClusterArgs
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 ClusterArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args ClusterArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args ClusterArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

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

DbNodeClass string

The db_node_class of cluster node.

NOTE: Node specifications are divided into cluster version, single node version and History Library version. They can't change each other, but the general specification and exclusive specification of cluster version can be changed.

DbType string

Database type. Value options: MySQL, Oracle, PostgreSQL.

DbVersion string

Database version. Value options can refer to the latest docs CreateDBCluster DBVersion.

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.

BackupRetentionPolicyOnClusterDeletion string

The retention policy for the backup sets when you delete the cluster. Valid values are ALL, LATEST, NONE. Value options can refer to the latest docs DeleteDBCluster

CloneDataPoint string

The time point of data to be cloned. Valid values are LATEST,BackupID,Timestamp.Value options can refer to the latest docs CreateDBCluster CloneDataPoint.

NOTE: If CreationOption is set to CloneFromRDS, the value of this parameter must be LATEST.

CollectorStatus string

Specifies whether to enable or disable SQL data collector. Valid values are Enable, Disabled.

CreationCategory string

The edition of the PolarDB service. Valid values are Normal,Basic,ArchiveNormal,NormalMultimaster.Value options can refer to the latest docs CreateDBCluster CreationCategory.

NOTE: You can set this parameter to Basic only when DBType is set to MySQL and DBVersion is set to 5.6, 5.7, or 8.0. You can set this parameter to Archive only when DBType is set to MySQL and DBVersion is set to 8.0. From version 1.188.0, creation_category can be set to NormalMultimaster.

CreationOption string

The method that is used to create a cluster. Valid values are Normal,CloneFromPolarDB,CloneFromRDS,MigrationFromRDS,CreateGdnStandby.Value options can refer to the latest docs CreateDBCluster CreationOption.

NOTE: The default value is Normal. If DBType is set to MySQL and DBVersion is set to 5.6 or 5.7, this parameter can be set to CloneFromRDS or MigrationFromRDS. If DBType is set to MySQL and DBVersion is set to 8.0, this parameter can be set to CreateGdnStandby.

DbClusterIpArrays List<Pulumi.AliCloud.PolarDB.Inputs.ClusterDbClusterIpArrayArgs>

db_cluster_ip_array defines how users can send requests to your API.

DbNodeCount int

Number of the PolarDB cluster nodes, default is 2(Each cluster must contain at least a primary node and a read-only node). Add/remove nodes by modifying this parameter, valid values: [2~16].

NOTE: To avoid adding or removing multiple read-only nodes by mistake, the system allows you to add or remove one read-only node at a time.

DeletionLock int

turn on table deletion_lock. Valid values are 0, 1. 1 means to open the cluster protection lock, 0 means to close the cluster protection lock

NOTE: Cannot modify after created when pay_type is Prepaid .deletion_lock the cluster protection lock can be turned on or off when pay_type is Postpaid.

Description string

The description of cluster.

EncryptNewTables string

turn on table auto encryption. Valid values are ON, OFF. Only MySQL 8.0 supports.

NOTE: encrypt_new_tables Polardb MySQL 8.0 cluster, after TDE and Automatic Encryption are enabled, all newly created tables are automatically encrypted in the cluster.

EncryptionKey string

The ID of the custom key. encryption_key cannot be modified after TDE is opened.

GdnId string

The ID of the global database network (GDN).

NOTE: This parameter is required if CreationOption is set to CreateGdnStandby.

ImciSwitch string

Specifies whether to enable the In-Memory Column Index (IMCI) feature. Valid values are ON, OFF.

NOTE: Only polardb MySQL Cluster version is available. The cluster with minor version number of 8.0.1 supports the column index feature, and the specific kernel version must be 8.0.1.1.22 or above. NOTE: The single node, the single node version of the history library, and the cluster version of the history library do not support column save indexes.

MaintainTime string

Maintainable time period format of the instance: HH:MMZ-HH:MMZ (UTC time)

ModifyType string

Use as db_node_class change class, define upgrade or downgrade. Valid values are Upgrade, Downgrade, Default to Upgrade.

Parameters List<Pulumi.AliCloud.PolarDB.Inputs.ClusterParameterArgs>

Set of parameters needs to be set after DB cluster was launched. Available parameters can refer to the latest docs View database parameter templates .

PayType string

Valid values are PrePaid, PostPaid, Default to PostPaid.

Period int
RenewalStatus string

Valid values are AutoRenewal, Normal, NotRenewal, Default to NotRenewal.

ResourceGroupId string

The ID of resource group which the PolarDB cluster belongs. If not specified, then it belongs to the default resource group.

RoleArn string

The Alibaba Cloud Resource Name (ARN) of the RAM role. A RAM role is a virtual identity that you can create within your Alibaba Cloud account. For more information see RAM role overview.

SecurityGroupIds List<string>

The ID of the security group. Separate multiple security groups with commas (,). You can add a maximum of three security groups to a cluster.

NOTE: Because of data backup and migration, change DB cluster type and storage would cost 15~20 minutes. Please make full preparation before changing them.

SecurityIps List<string>

This attribute has been deprecated from v1.130.0 and using db_cluster_ip_array sub-element security_ips instead. Its value is same as db_cluster_ip_array sub-element security_ips value and its db_cluster_ip_array_name is "default".

SourceResourceId string

The ID of the source RDS instance or the ID of the source PolarDB cluster. This parameter is required only when CreationOption is set to MigrationFromRDS, CloneFromRDS, or CloneFromPolarDB.Value options can refer to the latest docs CreateDBCluster SourceResourceId.

SubCategory string

The category of the cluster. Valid values are Exclusive, General. Only MySQL supports.

Tags Dictionary<string, object>

A mapping of tags to assign to the resource.

  • Key: It can be up to 64 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It cannot be a null string.
  • Value: It can be up to 128 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It can be a null string.
TdeStatus string

turn on TDE encryption. Valid values are Enabled, Disabled. Default to Disabled. TDE cannot be closed after it is turned on.

NOTE: tde_status Cannot modify after created when db_type is PostgreSQL or Oracle.tde_status only support modification from Disabled to Enabled when db_type is MySQL.

VpcId string

The id of the VPC.

VswitchId string

The virtual switch ID to launch DB instances in one VPC.

NOTE: If vswitch_id is not specified, system will get a vswitch belongs to the user automatically.

ZoneId string

The Zone to launch the DB cluster. it supports multiple zone.

DbNodeClass string

The db_node_class of cluster node.

NOTE: Node specifications are divided into cluster version, single node version and History Library version. They can't change each other, but the general specification and exclusive specification of cluster version can be changed.

DbType string

Database type. Value options: MySQL, Oracle, PostgreSQL.

DbVersion string

Database version. Value options can refer to the latest docs CreateDBCluster DBVersion.

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.

BackupRetentionPolicyOnClusterDeletion string

The retention policy for the backup sets when you delete the cluster. Valid values are ALL, LATEST, NONE. Value options can refer to the latest docs DeleteDBCluster

CloneDataPoint string

The time point of data to be cloned. Valid values are LATEST,BackupID,Timestamp.Value options can refer to the latest docs CreateDBCluster CloneDataPoint.

NOTE: If CreationOption is set to CloneFromRDS, the value of this parameter must be LATEST.

CollectorStatus string

Specifies whether to enable or disable SQL data collector. Valid values are Enable, Disabled.

CreationCategory string

The edition of the PolarDB service. Valid values are Normal,Basic,ArchiveNormal,NormalMultimaster.Value options can refer to the latest docs CreateDBCluster CreationCategory.

NOTE: You can set this parameter to Basic only when DBType is set to MySQL and DBVersion is set to 5.6, 5.7, or 8.0. You can set this parameter to Archive only when DBType is set to MySQL and DBVersion is set to 8.0. From version 1.188.0, creation_category can be set to NormalMultimaster.

CreationOption string

The method that is used to create a cluster. Valid values are Normal,CloneFromPolarDB,CloneFromRDS,MigrationFromRDS,CreateGdnStandby.Value options can refer to the latest docs CreateDBCluster CreationOption.

NOTE: The default value is Normal. If DBType is set to MySQL and DBVersion is set to 5.6 or 5.7, this parameter can be set to CloneFromRDS or MigrationFromRDS. If DBType is set to MySQL and DBVersion is set to 8.0, this parameter can be set to CreateGdnStandby.

DbClusterIpArrays []ClusterDbClusterIpArrayArgs

db_cluster_ip_array defines how users can send requests to your API.

DbNodeCount int

Number of the PolarDB cluster nodes, default is 2(Each cluster must contain at least a primary node and a read-only node). Add/remove nodes by modifying this parameter, valid values: [2~16].

NOTE: To avoid adding or removing multiple read-only nodes by mistake, the system allows you to add or remove one read-only node at a time.

DeletionLock int

turn on table deletion_lock. Valid values are 0, 1. 1 means to open the cluster protection lock, 0 means to close the cluster protection lock

NOTE: Cannot modify after created when pay_type is Prepaid .deletion_lock the cluster protection lock can be turned on or off when pay_type is Postpaid.

Description string

The description of cluster.

EncryptNewTables string

turn on table auto encryption. Valid values are ON, OFF. Only MySQL 8.0 supports.

NOTE: encrypt_new_tables Polardb MySQL 8.0 cluster, after TDE and Automatic Encryption are enabled, all newly created tables are automatically encrypted in the cluster.

EncryptionKey string

The ID of the custom key. encryption_key cannot be modified after TDE is opened.

GdnId string

The ID of the global database network (GDN).

NOTE: This parameter is required if CreationOption is set to CreateGdnStandby.

ImciSwitch string

Specifies whether to enable the In-Memory Column Index (IMCI) feature. Valid values are ON, OFF.

NOTE: Only polardb MySQL Cluster version is available. The cluster with minor version number of 8.0.1 supports the column index feature, and the specific kernel version must be 8.0.1.1.22 or above. NOTE: The single node, the single node version of the history library, and the cluster version of the history library do not support column save indexes.

MaintainTime string

Maintainable time period format of the instance: HH:MMZ-HH:MMZ (UTC time)

ModifyType string

Use as db_node_class change class, define upgrade or downgrade. Valid values are Upgrade, Downgrade, Default to Upgrade.

Parameters []ClusterParameterArgs

Set of parameters needs to be set after DB cluster was launched. Available parameters can refer to the latest docs View database parameter templates .

PayType string

Valid values are PrePaid, PostPaid, Default to PostPaid.

Period int
RenewalStatus string

Valid values are AutoRenewal, Normal, NotRenewal, Default to NotRenewal.

ResourceGroupId string

The ID of resource group which the PolarDB cluster belongs. If not specified, then it belongs to the default resource group.

RoleArn string

The Alibaba Cloud Resource Name (ARN) of the RAM role. A RAM role is a virtual identity that you can create within your Alibaba Cloud account. For more information see RAM role overview.

SecurityGroupIds []string

The ID of the security group. Separate multiple security groups with commas (,). You can add a maximum of three security groups to a cluster.

NOTE: Because of data backup and migration, change DB cluster type and storage would cost 15~20 minutes. Please make full preparation before changing them.

SecurityIps []string

This attribute has been deprecated from v1.130.0 and using db_cluster_ip_array sub-element security_ips instead. Its value is same as db_cluster_ip_array sub-element security_ips value and its db_cluster_ip_array_name is "default".

SourceResourceId string

The ID of the source RDS instance or the ID of the source PolarDB cluster. This parameter is required only when CreationOption is set to MigrationFromRDS, CloneFromRDS, or CloneFromPolarDB.Value options can refer to the latest docs CreateDBCluster SourceResourceId.

SubCategory string

The category of the cluster. Valid values are Exclusive, General. Only MySQL supports.

Tags map[string]interface{}

A mapping of tags to assign to the resource.

  • Key: It can be up to 64 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It cannot be a null string.
  • Value: It can be up to 128 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It can be a null string.
TdeStatus string

turn on TDE encryption. Valid values are Enabled, Disabled. Default to Disabled. TDE cannot be closed after it is turned on.

NOTE: tde_status Cannot modify after created when db_type is PostgreSQL or Oracle.tde_status only support modification from Disabled to Enabled when db_type is MySQL.

VpcId string

The id of the VPC.

VswitchId string

The virtual switch ID to launch DB instances in one VPC.

NOTE: If vswitch_id is not specified, system will get a vswitch belongs to the user automatically.

ZoneId string

The Zone to launch the DB cluster. it supports multiple zone.

dbNodeClass String

The db_node_class of cluster node.

NOTE: Node specifications are divided into cluster version, single node version and History Library version. They can't change each other, but the general specification and exclusive specification of cluster version can be changed.

dbType String

Database type. Value options: MySQL, Oracle, PostgreSQL.

dbVersion String

Database version. Value options can refer to the latest docs CreateDBCluster DBVersion.

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.

backupRetentionPolicyOnClusterDeletion String

The retention policy for the backup sets when you delete the cluster. Valid values are ALL, LATEST, NONE. Value options can refer to the latest docs DeleteDBCluster

cloneDataPoint String

The time point of data to be cloned. Valid values are LATEST,BackupID,Timestamp.Value options can refer to the latest docs CreateDBCluster CloneDataPoint.

NOTE: If CreationOption is set to CloneFromRDS, the value of this parameter must be LATEST.

collectorStatus String

Specifies whether to enable or disable SQL data collector. Valid values are Enable, Disabled.

creationCategory String

The edition of the PolarDB service. Valid values are Normal,Basic,ArchiveNormal,NormalMultimaster.Value options can refer to the latest docs CreateDBCluster CreationCategory.

NOTE: You can set this parameter to Basic only when DBType is set to MySQL and DBVersion is set to 5.6, 5.7, or 8.0. You can set this parameter to Archive only when DBType is set to MySQL and DBVersion is set to 8.0. From version 1.188.0, creation_category can be set to NormalMultimaster.

creationOption String

The method that is used to create a cluster. Valid values are Normal,CloneFromPolarDB,CloneFromRDS,MigrationFromRDS,CreateGdnStandby.Value options can refer to the latest docs CreateDBCluster CreationOption.

NOTE: The default value is Normal. If DBType is set to MySQL and DBVersion is set to 5.6 or 5.7, this parameter can be set to CloneFromRDS or MigrationFromRDS. If DBType is set to MySQL and DBVersion is set to 8.0, this parameter can be set to CreateGdnStandby.

dbClusterIpArrays List<ClusterDbClusterIpArrayArgs>

db_cluster_ip_array defines how users can send requests to your API.

dbNodeCount Integer

Number of the PolarDB cluster nodes, default is 2(Each cluster must contain at least a primary node and a read-only node). Add/remove nodes by modifying this parameter, valid values: [2~16].

NOTE: To avoid adding or removing multiple read-only nodes by mistake, the system allows you to add or remove one read-only node at a time.

deletionLock Integer

turn on table deletion_lock. Valid values are 0, 1. 1 means to open the cluster protection lock, 0 means to close the cluster protection lock

NOTE: Cannot modify after created when pay_type is Prepaid .deletion_lock the cluster protection lock can be turned on or off when pay_type is Postpaid.

description String

The description of cluster.

encryptNewTables String

turn on table auto encryption. Valid values are ON, OFF. Only MySQL 8.0 supports.

NOTE: encrypt_new_tables Polardb MySQL 8.0 cluster, after TDE and Automatic Encryption are enabled, all newly created tables are automatically encrypted in the cluster.

encryptionKey String

The ID of the custom key. encryption_key cannot be modified after TDE is opened.

gdnId String

The ID of the global database network (GDN).

NOTE: This parameter is required if CreationOption is set to CreateGdnStandby.

imciSwitch String

Specifies whether to enable the In-Memory Column Index (IMCI) feature. Valid values are ON, OFF.

NOTE: Only polardb MySQL Cluster version is available. The cluster with minor version number of 8.0.1 supports the column index feature, and the specific kernel version must be 8.0.1.1.22 or above. NOTE: The single node, the single node version of the history library, and the cluster version of the history library do not support column save indexes.

maintainTime String

Maintainable time period format of the instance: HH:MMZ-HH:MMZ (UTC time)

modifyType String

Use as db_node_class change class, define upgrade or downgrade. Valid values are Upgrade, Downgrade, Default to Upgrade.

parameters List<ClusterParameterArgs>

Set of parameters needs to be set after DB cluster was launched. Available parameters can refer to the latest docs View database parameter templates .

payType String

Valid values are PrePaid, PostPaid, Default to PostPaid.

period Integer
renewalStatus String

Valid values are AutoRenewal, Normal, NotRenewal, Default to NotRenewal.

resourceGroupId String

The ID of resource group which the PolarDB cluster belongs. If not specified, then it belongs to the default resource group.

roleArn String

The Alibaba Cloud Resource Name (ARN) of the RAM role. A RAM role is a virtual identity that you can create within your Alibaba Cloud account. For more information see RAM role overview.

securityGroupIds List<String>

The ID of the security group. Separate multiple security groups with commas (,). You can add a maximum of three security groups to a cluster.

NOTE: Because of data backup and migration, change DB cluster type and storage would cost 15~20 minutes. Please make full preparation before changing them.

securityIps List<String>

This attribute has been deprecated from v1.130.0 and using db_cluster_ip_array sub-element security_ips instead. Its value is same as db_cluster_ip_array sub-element security_ips value and its db_cluster_ip_array_name is "default".

sourceResourceId String

The ID of the source RDS instance or the ID of the source PolarDB cluster. This parameter is required only when CreationOption is set to MigrationFromRDS, CloneFromRDS, or CloneFromPolarDB.Value options can refer to the latest docs CreateDBCluster SourceResourceId.

subCategory String

The category of the cluster. Valid values are Exclusive, General. Only MySQL supports.

tags Map<String,Object>

A mapping of tags to assign to the resource.

  • Key: It can be up to 64 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It cannot be a null string.
  • Value: It can be up to 128 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It can be a null string.
tdeStatus String

turn on TDE encryption. Valid values are Enabled, Disabled. Default to Disabled. TDE cannot be closed after it is turned on.

NOTE: tde_status Cannot modify after created when db_type is PostgreSQL or Oracle.tde_status only support modification from Disabled to Enabled when db_type is MySQL.

vpcId String

The id of the VPC.

vswitchId String

The virtual switch ID to launch DB instances in one VPC.

NOTE: If vswitch_id is not specified, system will get a vswitch belongs to the user automatically.

zoneId String

The Zone to launch the DB cluster. it supports multiple zone.

dbNodeClass string

The db_node_class of cluster node.

NOTE: Node specifications are divided into cluster version, single node version and History Library version. They can't change each other, but the general specification and exclusive specification of cluster version can be changed.

dbType string

Database type. Value options: MySQL, Oracle, PostgreSQL.

dbVersion string

Database version. Value options can refer to the latest docs CreateDBCluster DBVersion.

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.

backupRetentionPolicyOnClusterDeletion string

The retention policy for the backup sets when you delete the cluster. Valid values are ALL, LATEST, NONE. Value options can refer to the latest docs DeleteDBCluster

cloneDataPoint string

The time point of data to be cloned. Valid values are LATEST,BackupID,Timestamp.Value options can refer to the latest docs CreateDBCluster CloneDataPoint.

NOTE: If CreationOption is set to CloneFromRDS, the value of this parameter must be LATEST.

collectorStatus string

Specifies whether to enable or disable SQL data collector. Valid values are Enable, Disabled.

creationCategory string

The edition of the PolarDB service. Valid values are Normal,Basic,ArchiveNormal,NormalMultimaster.Value options can refer to the latest docs CreateDBCluster CreationCategory.

NOTE: You can set this parameter to Basic only when DBType is set to MySQL and DBVersion is set to 5.6, 5.7, or 8.0. You can set this parameter to Archive only when DBType is set to MySQL and DBVersion is set to 8.0. From version 1.188.0, creation_category can be set to NormalMultimaster.

creationOption string

The method that is used to create a cluster. Valid values are Normal,CloneFromPolarDB,CloneFromRDS,MigrationFromRDS,CreateGdnStandby.Value options can refer to the latest docs CreateDBCluster CreationOption.

NOTE: The default value is Normal. If DBType is set to MySQL and DBVersion is set to 5.6 or 5.7, this parameter can be set to CloneFromRDS or MigrationFromRDS. If DBType is set to MySQL and DBVersion is set to 8.0, this parameter can be set to CreateGdnStandby.

dbClusterIpArrays ClusterDbClusterIpArrayArgs[]

db_cluster_ip_array defines how users can send requests to your API.

dbNodeCount number

Number of the PolarDB cluster nodes, default is 2(Each cluster must contain at least a primary node and a read-only node). Add/remove nodes by modifying this parameter, valid values: [2~16].

NOTE: To avoid adding or removing multiple read-only nodes by mistake, the system allows you to add or remove one read-only node at a time.

deletionLock number

turn on table deletion_lock. Valid values are 0, 1. 1 means to open the cluster protection lock, 0 means to close the cluster protection lock

NOTE: Cannot modify after created when pay_type is Prepaid .deletion_lock the cluster protection lock can be turned on or off when pay_type is Postpaid.

description string

The description of cluster.

encryptNewTables string

turn on table auto encryption. Valid values are ON, OFF. Only MySQL 8.0 supports.

NOTE: encrypt_new_tables Polardb MySQL 8.0 cluster, after TDE and Automatic Encryption are enabled, all newly created tables are automatically encrypted in the cluster.

encryptionKey string

The ID of the custom key. encryption_key cannot be modified after TDE is opened.

gdnId string

The ID of the global database network (GDN).

NOTE: This parameter is required if CreationOption is set to CreateGdnStandby.

imciSwitch string

Specifies whether to enable the In-Memory Column Index (IMCI) feature. Valid values are ON, OFF.

NOTE: Only polardb MySQL Cluster version is available. The cluster with minor version number of 8.0.1 supports the column index feature, and the specific kernel version must be 8.0.1.1.22 or above. NOTE: The single node, the single node version of the history library, and the cluster version of the history library do not support column save indexes.

maintainTime string

Maintainable time period format of the instance: HH:MMZ-HH:MMZ (UTC time)

modifyType string

Use as db_node_class change class, define upgrade or downgrade. Valid values are Upgrade, Downgrade, Default to Upgrade.

parameters ClusterParameterArgs[]

Set of parameters needs to be set after DB cluster was launched. Available parameters can refer to the latest docs View database parameter templates .

payType string

Valid values are PrePaid, PostPaid, Default to PostPaid.

period number
renewalStatus string

Valid values are AutoRenewal, Normal, NotRenewal, Default to NotRenewal.

resourceGroupId string

The ID of resource group which the PolarDB cluster belongs. If not specified, then it belongs to the default resource group.

roleArn string

The Alibaba Cloud Resource Name (ARN) of the RAM role. A RAM role is a virtual identity that you can create within your Alibaba Cloud account. For more information see RAM role overview.

securityGroupIds string[]

The ID of the security group. Separate multiple security groups with commas (,). You can add a maximum of three security groups to a cluster.

NOTE: Because of data backup and migration, change DB cluster type and storage would cost 15~20 minutes. Please make full preparation before changing them.

securityIps string[]

This attribute has been deprecated from v1.130.0 and using db_cluster_ip_array sub-element security_ips instead. Its value is same as db_cluster_ip_array sub-element security_ips value and its db_cluster_ip_array_name is "default".

sourceResourceId string

The ID of the source RDS instance or the ID of the source PolarDB cluster. This parameter is required only when CreationOption is set to MigrationFromRDS, CloneFromRDS, or CloneFromPolarDB.Value options can refer to the latest docs CreateDBCluster SourceResourceId.

subCategory string

The category of the cluster. Valid values are Exclusive, General. Only MySQL supports.

tags {[key: string]: any}

A mapping of tags to assign to the resource.

  • Key: It can be up to 64 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It cannot be a null string.
  • Value: It can be up to 128 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It can be a null string.
tdeStatus string

turn on TDE encryption. Valid values are Enabled, Disabled. Default to Disabled. TDE cannot be closed after it is turned on.

NOTE: tde_status Cannot modify after created when db_type is PostgreSQL or Oracle.tde_status only support modification from Disabled to Enabled when db_type is MySQL.

vpcId string

The id of the VPC.

vswitchId string

The virtual switch ID to launch DB instances in one VPC.

NOTE: If vswitch_id is not specified, system will get a vswitch belongs to the user automatically.

zoneId string

The Zone to launch the DB cluster. it supports multiple zone.

db_node_class str

The db_node_class of cluster node.

NOTE: Node specifications are divided into cluster version, single node version and History Library version. They can't change each other, but the general specification and exclusive specification of cluster version can be changed.

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.

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.

backup_retention_policy_on_cluster_deletion str

The retention policy for the backup sets when you delete the cluster. Valid values are ALL, LATEST, NONE. Value options can refer to the latest docs DeleteDBCluster

clone_data_point str

The time point of data to be cloned. Valid values are LATEST,BackupID,Timestamp.Value options can refer to the latest docs CreateDBCluster CloneDataPoint.

NOTE: If CreationOption is set to CloneFromRDS, the value of this parameter must be LATEST.

collector_status str

Specifies whether to enable or disable SQL data collector. Valid values are Enable, Disabled.

creation_category str

The edition of the PolarDB service. Valid values are Normal,Basic,ArchiveNormal,NormalMultimaster.Value options can refer to the latest docs CreateDBCluster CreationCategory.

NOTE: You can set this parameter to Basic only when DBType is set to MySQL and DBVersion is set to 5.6, 5.7, or 8.0. You can set this parameter to Archive only when DBType is set to MySQL and DBVersion is set to 8.0. From version 1.188.0, creation_category can be set to NormalMultimaster.

creation_option str

The method that is used to create a cluster. Valid values are Normal,CloneFromPolarDB,CloneFromRDS,MigrationFromRDS,CreateGdnStandby.Value options can refer to the latest docs CreateDBCluster CreationOption.

NOTE: The default value is Normal. If DBType is set to MySQL and DBVersion is set to 5.6 or 5.7, this parameter can be set to CloneFromRDS or MigrationFromRDS. If DBType is set to MySQL and DBVersion is set to 8.0, this parameter can be set to CreateGdnStandby.

db_cluster_ip_arrays Sequence[ClusterDbClusterIpArrayArgs]

db_cluster_ip_array defines how users can send requests to your API.

db_node_count int

Number of the PolarDB cluster nodes, default is 2(Each cluster must contain at least a primary node and a read-only node). Add/remove nodes by modifying this parameter, valid values: [2~16].

NOTE: To avoid adding or removing multiple read-only nodes by mistake, the system allows you to add or remove one read-only node at a time.

deletion_lock int

turn on table deletion_lock. Valid values are 0, 1. 1 means to open the cluster protection lock, 0 means to close the cluster protection lock

NOTE: Cannot modify after created when pay_type is Prepaid .deletion_lock the cluster protection lock can be turned on or off when pay_type is Postpaid.

description str

The description of cluster.

encrypt_new_tables str

turn on table auto encryption. Valid values are ON, OFF. Only MySQL 8.0 supports.

NOTE: encrypt_new_tables Polardb MySQL 8.0 cluster, after TDE and Automatic Encryption are enabled, all newly created tables are automatically encrypted in the cluster.

encryption_key str

The ID of the custom key. encryption_key cannot be modified after TDE is opened.

gdn_id str

The ID of the global database network (GDN).

NOTE: This parameter is required if CreationOption is set to CreateGdnStandby.

imci_switch str

Specifies whether to enable the In-Memory Column Index (IMCI) feature. Valid values are ON, OFF.

NOTE: Only polardb MySQL Cluster version is available. The cluster with minor version number of 8.0.1 supports the column index feature, and the specific kernel version must be 8.0.1.1.22 or above. NOTE: The single node, the single node version of the history library, and the cluster version of the history library do not support column save indexes.

maintain_time str

Maintainable time period format of the instance: HH:MMZ-HH:MMZ (UTC time)

modify_type str

Use as db_node_class change class, define upgrade or downgrade. Valid values are Upgrade, Downgrade, Default to Upgrade.

parameters Sequence[ClusterParameterArgs]

Set of parameters needs to be set after DB cluster was launched. Available parameters can refer to the latest docs View database parameter templates .

pay_type str

Valid values are PrePaid, PostPaid, Default to PostPaid.

period int
renewal_status str

Valid values are AutoRenewal, Normal, NotRenewal, Default to NotRenewal.

resource_group_id str

The ID of resource group which the PolarDB cluster belongs. If not specified, then it belongs to the default resource group.

role_arn str

The Alibaba Cloud Resource Name (ARN) of the RAM role. A RAM role is a virtual identity that you can create within your Alibaba Cloud account. For more information see RAM role overview.

security_group_ids Sequence[str]

The ID of the security group. Separate multiple security groups with commas (,). You can add a maximum of three security groups to a cluster.

NOTE: Because of data backup and migration, change DB cluster type and storage would cost 15~20 minutes. Please make full preparation before changing them.

security_ips Sequence[str]

This attribute has been deprecated from v1.130.0 and using db_cluster_ip_array sub-element security_ips instead. Its value is same as db_cluster_ip_array sub-element security_ips value and its db_cluster_ip_array_name is "default".

source_resource_id str

The ID of the source RDS instance or the ID of the source PolarDB cluster. This parameter is required only when CreationOption is set to MigrationFromRDS, CloneFromRDS, or CloneFromPolarDB.Value options can refer to the latest docs CreateDBCluster SourceResourceId.

sub_category str

The category of the cluster. Valid values are Exclusive, General. Only MySQL supports.

tags Mapping[str, Any]

A mapping of tags to assign to the resource.

  • Key: It can be up to 64 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It cannot be a null string.
  • Value: It can be up to 128 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It can be a null string.
tde_status str

turn on TDE encryption. Valid values are Enabled, Disabled. Default to Disabled. TDE cannot be closed after it is turned on.

NOTE: tde_status Cannot modify after created when db_type is PostgreSQL or Oracle.tde_status only support modification from Disabled to Enabled when db_type is MySQL.

vpc_id str

The id of the VPC.

vswitch_id str

The virtual switch ID to launch DB instances in one VPC.

NOTE: If vswitch_id is not specified, system will get a vswitch belongs to the user automatically.

zone_id str

The Zone to launch the DB cluster. it supports multiple zone.

dbNodeClass String

The db_node_class of cluster node.

NOTE: Node specifications are divided into cluster version, single node version and History Library version. They can't change each other, but the general specification and exclusive specification of cluster version can be changed.

dbType String

Database type. Value options: MySQL, Oracle, PostgreSQL.

dbVersion String

Database version. Value options can refer to the latest docs CreateDBCluster DBVersion.

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.

backupRetentionPolicyOnClusterDeletion String

The retention policy for the backup sets when you delete the cluster. Valid values are ALL, LATEST, NONE. Value options can refer to the latest docs DeleteDBCluster

cloneDataPoint String

The time point of data to be cloned. Valid values are LATEST,BackupID,Timestamp.Value options can refer to the latest docs CreateDBCluster CloneDataPoint.

NOTE: If CreationOption is set to CloneFromRDS, the value of this parameter must be LATEST.

collectorStatus String

Specifies whether to enable or disable SQL data collector. Valid values are Enable, Disabled.

creationCategory String

The edition of the PolarDB service. Valid values are Normal,Basic,ArchiveNormal,NormalMultimaster.Value options can refer to the latest docs CreateDBCluster CreationCategory.

NOTE: You can set this parameter to Basic only when DBType is set to MySQL and DBVersion is set to 5.6, 5.7, or 8.0. You can set this parameter to Archive only when DBType is set to MySQL and DBVersion is set to 8.0. From version 1.188.0, creation_category can be set to NormalMultimaster.

creationOption String

The method that is used to create a cluster. Valid values are Normal,CloneFromPolarDB,CloneFromRDS,MigrationFromRDS,CreateGdnStandby.Value options can refer to the latest docs CreateDBCluster CreationOption.

NOTE: The default value is Normal. If DBType is set to MySQL and DBVersion is set to 5.6 or 5.7, this parameter can be set to CloneFromRDS or MigrationFromRDS. If DBType is set to MySQL and DBVersion is set to 8.0, this parameter can be set to CreateGdnStandby.

dbClusterIpArrays List<Property Map>

db_cluster_ip_array defines how users can send requests to your API.

dbNodeCount Number

Number of the PolarDB cluster nodes, default is 2(Each cluster must contain at least a primary node and a read-only node). Add/remove nodes by modifying this parameter, valid values: [2~16].

NOTE: To avoid adding or removing multiple read-only nodes by mistake, the system allows you to add or remove one read-only node at a time.

deletionLock Number

turn on table deletion_lock. Valid values are 0, 1. 1 means to open the cluster protection lock, 0 means to close the cluster protection lock

NOTE: Cannot modify after created when pay_type is Prepaid .deletion_lock the cluster protection lock can be turned on or off when pay_type is Postpaid.

description String

The description of cluster.

encryptNewTables String

turn on table auto encryption. Valid values are ON, OFF. Only MySQL 8.0 supports.

NOTE: encrypt_new_tables Polardb MySQL 8.0 cluster, after TDE and Automatic Encryption are enabled, all newly created tables are automatically encrypted in the cluster.

encryptionKey String

The ID of the custom key. encryption_key cannot be modified after TDE is opened.

gdnId String

The ID of the global database network (GDN).

NOTE: This parameter is required if CreationOption is set to CreateGdnStandby.

imciSwitch String

Specifies whether to enable the In-Memory Column Index (IMCI) feature. Valid values are ON, OFF.

NOTE: Only polardb MySQL Cluster version is available. The cluster with minor version number of 8.0.1 supports the column index feature, and the specific kernel version must be 8.0.1.1.22 or above. NOTE: The single node, the single node version of the history library, and the cluster version of the history library do not support column save indexes.

maintainTime String

Maintainable time period format of the instance: HH:MMZ-HH:MMZ (UTC time)

modifyType String

Use as db_node_class change class, define upgrade or downgrade. Valid values are Upgrade, Downgrade, Default to Upgrade.

parameters List<Property Map>

Set of parameters needs to be set after DB cluster was launched. Available parameters can refer to the latest docs View database parameter templates .

payType String

Valid values are PrePaid, PostPaid, Default to PostPaid.

period Number
renewalStatus String

Valid values are AutoRenewal, Normal, NotRenewal, Default to NotRenewal.

resourceGroupId String

The ID of resource group which the PolarDB cluster belongs. If not specified, then it belongs to the default resource group.

roleArn String

The Alibaba Cloud Resource Name (ARN) of the RAM role. A RAM role is a virtual identity that you can create within your Alibaba Cloud account. For more information see RAM role overview.

securityGroupIds List<String>

The ID of the security group. Separate multiple security groups with commas (,). You can add a maximum of three security groups to a cluster.

NOTE: Because of data backup and migration, change DB cluster type and storage would cost 15~20 minutes. Please make full preparation before changing them.

securityIps List<String>

This attribute has been deprecated from v1.130.0 and using db_cluster_ip_array sub-element security_ips instead. Its value is same as db_cluster_ip_array sub-element security_ips value and its db_cluster_ip_array_name is "default".

sourceResourceId String

The ID of the source RDS instance or the ID of the source PolarDB cluster. This parameter is required only when CreationOption is set to MigrationFromRDS, CloneFromRDS, or CloneFromPolarDB.Value options can refer to the latest docs CreateDBCluster SourceResourceId.

subCategory String

The category of the cluster. Valid values are Exclusive, General. Only MySQL supports.

tags Map<Any>

A mapping of tags to assign to the resource.

  • Key: It can be up to 64 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It cannot be a null string.
  • Value: It can be up to 128 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It can be a null string.
tdeStatus String

turn on TDE encryption. Valid values are Enabled, Disabled. Default to Disabled. TDE cannot be closed after it is turned on.

NOTE: tde_status Cannot modify after created when db_type is PostgreSQL or Oracle.tde_status only support modification from Disabled to Enabled when db_type is MySQL.

vpcId String

The id of the VPC.

vswitchId String

The virtual switch ID to launch DB instances in one VPC.

NOTE: If vswitch_id is not specified, system will get a vswitch belongs to the user automatically.

zoneId String

The Zone to launch the DB cluster. it supports multiple zone.

Outputs

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

ConnectionString string

(Available in 1.81.0+) PolarDB cluster connection string.

Id string

The provider-assigned unique ID for this managed resource.

Port string

(Available in 1.196.0+) PolarDB cluster connection port.

TdeRegion string

(Available in 1.200.0+) The region where the TDE key resides.

NOTE: TDE can be enabled on clusters that have joined a global database network (GDN). After TDE is enabled on the primary cluster in a GDN, TDE is enabled on the secondary clusters in the GDN by default. The key used by the secondary clusters and the region for the key resides must be the same as the primary cluster. The region of the key cannot be modified. NOTE: You cannot enable TDE for the secondary clusters in a GDN. Used to view user KMS activation status.

ConnectionString string

(Available in 1.81.0+) PolarDB cluster connection string.

Id string

The provider-assigned unique ID for this managed resource.

Port string

(Available in 1.196.0+) PolarDB cluster connection port.

TdeRegion string

(Available in 1.200.0+) The region where the TDE key resides.

NOTE: TDE can be enabled on clusters that have joined a global database network (GDN). After TDE is enabled on the primary cluster in a GDN, TDE is enabled on the secondary clusters in the GDN by default. The key used by the secondary clusters and the region for the key resides must be the same as the primary cluster. The region of the key cannot be modified. NOTE: You cannot enable TDE for the secondary clusters in a GDN. Used to view user KMS activation status.

connectionString String

(Available in 1.81.0+) PolarDB cluster connection string.

id String

The provider-assigned unique ID for this managed resource.

port String

(Available in 1.196.0+) PolarDB cluster connection port.

tdeRegion String

(Available in 1.200.0+) The region where the TDE key resides.

NOTE: TDE can be enabled on clusters that have joined a global database network (GDN). After TDE is enabled on the primary cluster in a GDN, TDE is enabled on the secondary clusters in the GDN by default. The key used by the secondary clusters and the region for the key resides must be the same as the primary cluster. The region of the key cannot be modified. NOTE: You cannot enable TDE for the secondary clusters in a GDN. Used to view user KMS activation status.

connectionString string

(Available in 1.81.0+) PolarDB cluster connection string.

id string

The provider-assigned unique ID for this managed resource.

port string

(Available in 1.196.0+) PolarDB cluster connection port.

tdeRegion string

(Available in 1.200.0+) The region where the TDE key resides.

NOTE: TDE can be enabled on clusters that have joined a global database network (GDN). After TDE is enabled on the primary cluster in a GDN, TDE is enabled on the secondary clusters in the GDN by default. The key used by the secondary clusters and the region for the key resides must be the same as the primary cluster. The region of the key cannot be modified. NOTE: You cannot enable TDE for the secondary clusters in a GDN. Used to view user KMS activation status.

connection_string str

(Available in 1.81.0+) PolarDB cluster connection string.

id str

The provider-assigned unique ID for this managed resource.

port str

(Available in 1.196.0+) PolarDB cluster connection port.

tde_region str

(Available in 1.200.0+) The region where the TDE key resides.

NOTE: TDE can be enabled on clusters that have joined a global database network (GDN). After TDE is enabled on the primary cluster in a GDN, TDE is enabled on the secondary clusters in the GDN by default. The key used by the secondary clusters and the region for the key resides must be the same as the primary cluster. The region of the key cannot be modified. NOTE: You cannot enable TDE for the secondary clusters in a GDN. Used to view user KMS activation status.

connectionString String

(Available in 1.81.0+) PolarDB cluster connection string.

id String

The provider-assigned unique ID for this managed resource.

port String

(Available in 1.196.0+) PolarDB cluster connection port.

tdeRegion String

(Available in 1.200.0+) The region where the TDE key resides.

NOTE: TDE can be enabled on clusters that have joined a global database network (GDN). After TDE is enabled on the primary cluster in a GDN, TDE is enabled on the secondary clusters in the GDN by default. The key used by the secondary clusters and the region for the key resides must be the same as the primary cluster. The region of the key cannot be modified. NOTE: You cannot enable TDE for the secondary clusters in a GDN. Used to view user KMS activation status.

Look up Existing Cluster Resource

Get an existing Cluster 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?: ClusterState, opts?: CustomResourceOptions): Cluster
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        auto_renew_period: Optional[int] = None,
        backup_retention_policy_on_cluster_deletion: Optional[str] = None,
        clone_data_point: Optional[str] = None,
        collector_status: Optional[str] = None,
        connection_string: Optional[str] = None,
        creation_category: Optional[str] = None,
        creation_option: Optional[str] = None,
        db_cluster_ip_arrays: Optional[Sequence[ClusterDbClusterIpArrayArgs]] = None,
        db_node_class: Optional[str] = None,
        db_node_count: Optional[int] = None,
        db_type: Optional[str] = None,
        db_version: Optional[str] = None,
        deletion_lock: Optional[int] = None,
        description: Optional[str] = None,
        encrypt_new_tables: Optional[str] = None,
        encryption_key: Optional[str] = None,
        gdn_id: Optional[str] = None,
        imci_switch: Optional[str] = None,
        maintain_time: Optional[str] = None,
        modify_type: Optional[str] = None,
        parameters: Optional[Sequence[ClusterParameterArgs]] = None,
        pay_type: Optional[str] = None,
        period: Optional[int] = None,
        port: Optional[str] = None,
        renewal_status: Optional[str] = None,
        resource_group_id: Optional[str] = None,
        role_arn: Optional[str] = None,
        security_group_ids: Optional[Sequence[str]] = None,
        security_ips: Optional[Sequence[str]] = None,
        source_resource_id: Optional[str] = None,
        sub_category: Optional[str] = None,
        tags: Optional[Mapping[str, Any]] = None,
        tde_region: Optional[str] = None,
        tde_status: Optional[str] = None,
        vpc_id: Optional[str] = None,
        vswitch_id: Optional[str] = None,
        zone_id: Optional[str] = None) -> Cluster
func GetCluster(ctx *Context, name string, id IDInput, state *ClusterState, opts ...ResourceOption) (*Cluster, error)
public static Cluster Get(string name, Input<string> id, ClusterState? state, CustomResourceOptions? opts = null)
public static Cluster get(String name, Output<String> id, ClusterState 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:
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.

BackupRetentionPolicyOnClusterDeletion string

The retention policy for the backup sets when you delete the cluster. Valid values are ALL, LATEST, NONE. Value options can refer to the latest docs DeleteDBCluster

CloneDataPoint string

The time point of data to be cloned. Valid values are LATEST,BackupID,Timestamp.Value options can refer to the latest docs CreateDBCluster CloneDataPoint.

NOTE: If CreationOption is set to CloneFromRDS, the value of this parameter must be LATEST.

CollectorStatus string

Specifies whether to enable or disable SQL data collector. Valid values are Enable, Disabled.

ConnectionString string

(Available in 1.81.0+) PolarDB cluster connection string.

CreationCategory string

The edition of the PolarDB service. Valid values are Normal,Basic,ArchiveNormal,NormalMultimaster.Value options can refer to the latest docs CreateDBCluster CreationCategory.

NOTE: You can set this parameter to Basic only when DBType is set to MySQL and DBVersion is set to 5.6, 5.7, or 8.0. You can set this parameter to Archive only when DBType is set to MySQL and DBVersion is set to 8.0. From version 1.188.0, creation_category can be set to NormalMultimaster.

CreationOption string

The method that is used to create a cluster. Valid values are Normal,CloneFromPolarDB,CloneFromRDS,MigrationFromRDS,CreateGdnStandby.Value options can refer to the latest docs CreateDBCluster CreationOption.

NOTE: The default value is Normal. If DBType is set to MySQL and DBVersion is set to 5.6 or 5.7, this parameter can be set to CloneFromRDS or MigrationFromRDS. If DBType is set to MySQL and DBVersion is set to 8.0, this parameter can be set to CreateGdnStandby.

DbClusterIpArrays List<Pulumi.AliCloud.PolarDB.Inputs.ClusterDbClusterIpArrayArgs>

db_cluster_ip_array defines how users can send requests to your API.

DbNodeClass string

The db_node_class of cluster node.

NOTE: Node specifications are divided into cluster version, single node version and History Library version. They can't change each other, but the general specification and exclusive specification of cluster version can be changed.

DbNodeCount int

Number of the PolarDB cluster nodes, default is 2(Each cluster must contain at least a primary node and a read-only node). Add/remove nodes by modifying this parameter, valid values: [2~16].

NOTE: To avoid adding or removing multiple read-only nodes by mistake, the system allows you to add or remove one read-only node at a time.

DbType string

Database type. Value options: MySQL, Oracle, PostgreSQL.

DbVersion string

Database version. Value options can refer to the latest docs CreateDBCluster DBVersion.

DeletionLock int

turn on table deletion_lock. Valid values are 0, 1. 1 means to open the cluster protection lock, 0 means to close the cluster protection lock

NOTE: Cannot modify after created when pay_type is Prepaid .deletion_lock the cluster protection lock can be turned on or off when pay_type is Postpaid.

Description string

The description of cluster.

EncryptNewTables string

turn on table auto encryption. Valid values are ON, OFF. Only MySQL 8.0 supports.

NOTE: encrypt_new_tables Polardb MySQL 8.0 cluster, after TDE and Automatic Encryption are enabled, all newly created tables are automatically encrypted in the cluster.

EncryptionKey string

The ID of the custom key. encryption_key cannot be modified after TDE is opened.

GdnId string

The ID of the global database network (GDN).

NOTE: This parameter is required if CreationOption is set to CreateGdnStandby.

ImciSwitch string

Specifies whether to enable the In-Memory Column Index (IMCI) feature. Valid values are ON, OFF.

NOTE: Only polardb MySQL Cluster version is available. The cluster with minor version number of 8.0.1 supports the column index feature, and the specific kernel version must be 8.0.1.1.22 or above. NOTE: The single node, the single node version of the history library, and the cluster version of the history library do not support column save indexes.

MaintainTime string

Maintainable time period format of the instance: HH:MMZ-HH:MMZ (UTC time)

ModifyType string

Use as db_node_class change class, define upgrade or downgrade. Valid values are Upgrade, Downgrade, Default to Upgrade.

Parameters List<Pulumi.AliCloud.PolarDB.Inputs.ClusterParameterArgs>

Set of parameters needs to be set after DB cluster was launched. Available parameters can refer to the latest docs View database parameter templates .

PayType string

Valid values are PrePaid, PostPaid, Default to PostPaid.

Period int
Port string

(Available in 1.196.0+) PolarDB cluster connection port.

RenewalStatus string

Valid values are AutoRenewal, Normal, NotRenewal, Default to NotRenewal.

ResourceGroupId string

The ID of resource group which the PolarDB cluster belongs. If not specified, then it belongs to the default resource group.

RoleArn string

The Alibaba Cloud Resource Name (ARN) of the RAM role. A RAM role is a virtual identity that you can create within your Alibaba Cloud account. For more information see RAM role overview.

SecurityGroupIds List<string>

The ID of the security group. Separate multiple security groups with commas (,). You can add a maximum of three security groups to a cluster.

NOTE: Because of data backup and migration, change DB cluster type and storage would cost 15~20 minutes. Please make full preparation before changing them.

SecurityIps List<string>

This attribute has been deprecated from v1.130.0 and using db_cluster_ip_array sub-element security_ips instead. Its value is same as db_cluster_ip_array sub-element security_ips value and its db_cluster_ip_array_name is "default".

SourceResourceId string

The ID of the source RDS instance or the ID of the source PolarDB cluster. This parameter is required only when CreationOption is set to MigrationFromRDS, CloneFromRDS, or CloneFromPolarDB.Value options can refer to the latest docs CreateDBCluster SourceResourceId.

SubCategory string

The category of the cluster. Valid values are Exclusive, General. Only MySQL supports.

Tags Dictionary<string, object>

A mapping of tags to assign to the resource.

  • Key: It can be up to 64 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It cannot be a null string.
  • Value: It can be up to 128 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It can be a null string.
TdeRegion string

(Available in 1.200.0+) The region where the TDE key resides.

NOTE: TDE can be enabled on clusters that have joined a global database network (GDN). After TDE is enabled on the primary cluster in a GDN, TDE is enabled on the secondary clusters in the GDN by default. The key used by the secondary clusters and the region for the key resides must be the same as the primary cluster. The region of the key cannot be modified. NOTE: You cannot enable TDE for the secondary clusters in a GDN. Used to view user KMS activation status.

TdeStatus string

turn on TDE encryption. Valid values are Enabled, Disabled. Default to Disabled. TDE cannot be closed after it is turned on.

NOTE: tde_status Cannot modify after created when db_type is PostgreSQL or Oracle.tde_status only support modification from Disabled to Enabled when db_type is MySQL.

VpcId string

The id of the VPC.

VswitchId string

The virtual switch ID to launch DB instances in one VPC.

NOTE: If vswitch_id is not specified, system will get a vswitch belongs to the user automatically.

ZoneId string

The Zone to launch the DB cluster. it supports multiple zone.

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.

BackupRetentionPolicyOnClusterDeletion string

The retention policy for the backup sets when you delete the cluster. Valid values are ALL, LATEST, NONE. Value options can refer to the latest docs DeleteDBCluster

CloneDataPoint string

The time point of data to be cloned. Valid values are LATEST,BackupID,Timestamp.Value options can refer to the latest docs CreateDBCluster CloneDataPoint.

NOTE: If CreationOption is set to CloneFromRDS, the value of this parameter must be LATEST.

CollectorStatus string

Specifies whether to enable or disable SQL data collector. Valid values are Enable, Disabled.

ConnectionString string

(Available in 1.81.0+) PolarDB cluster connection string.

CreationCategory string

The edition of the PolarDB service. Valid values are Normal,Basic,ArchiveNormal,NormalMultimaster.Value options can refer to the latest docs CreateDBCluster CreationCategory.

NOTE: You can set this parameter to Basic only when DBType is set to MySQL and DBVersion is set to 5.6, 5.7, or 8.0. You can set this parameter to Archive only when DBType is set to MySQL and DBVersion is set to 8.0. From version 1.188.0, creation_category can be set to NormalMultimaster.

CreationOption string

The method that is used to create a cluster. Valid values are Normal,CloneFromPolarDB,CloneFromRDS,MigrationFromRDS,CreateGdnStandby.Value options can refer to the latest docs CreateDBCluster CreationOption.

NOTE: The default value is Normal. If DBType is set to MySQL and DBVersion is set to 5.6 or 5.7, this parameter can be set to CloneFromRDS or MigrationFromRDS. If DBType is set to MySQL and DBVersion is set to 8.0, this parameter can be set to CreateGdnStandby.

DbClusterIpArrays []ClusterDbClusterIpArrayArgs

db_cluster_ip_array defines how users can send requests to your API.

DbNodeClass string

The db_node_class of cluster node.

NOTE: Node specifications are divided into cluster version, single node version and History Library version. They can't change each other, but the general specification and exclusive specification of cluster version can be changed.

DbNodeCount int

Number of the PolarDB cluster nodes, default is 2(Each cluster must contain at least a primary node and a read-only node). Add/remove nodes by modifying this parameter, valid values: [2~16].

NOTE: To avoid adding or removing multiple read-only nodes by mistake, the system allows you to add or remove one read-only node at a time.

DbType string

Database type. Value options: MySQL, Oracle, PostgreSQL.

DbVersion string

Database version. Value options can refer to the latest docs CreateDBCluster DBVersion.

DeletionLock int

turn on table deletion_lock. Valid values are 0, 1. 1 means to open the cluster protection lock, 0 means to close the cluster protection lock

NOTE: Cannot modify after created when pay_type is Prepaid .deletion_lock the cluster protection lock can be turned on or off when pay_type is Postpaid.

Description string

The description of cluster.

EncryptNewTables string

turn on table auto encryption. Valid values are ON, OFF. Only MySQL 8.0 supports.

NOTE: encrypt_new_tables Polardb MySQL 8.0 cluster, after TDE and Automatic Encryption are enabled, all newly created tables are automatically encrypted in the cluster.

EncryptionKey string

The ID of the custom key. encryption_key cannot be modified after TDE is opened.

GdnId string

The ID of the global database network (GDN).

NOTE: This parameter is required if CreationOption is set to CreateGdnStandby.

ImciSwitch string

Specifies whether to enable the In-Memory Column Index (IMCI) feature. Valid values are ON, OFF.

NOTE: Only polardb MySQL Cluster version is available. The cluster with minor version number of 8.0.1 supports the column index feature, and the specific kernel version must be 8.0.1.1.22 or above. NOTE: The single node, the single node version of the history library, and the cluster version of the history library do not support column save indexes.

MaintainTime string

Maintainable time period format of the instance: HH:MMZ-HH:MMZ (UTC time)

ModifyType string

Use as db_node_class change class, define upgrade or downgrade. Valid values are Upgrade, Downgrade, Default to Upgrade.

Parameters []ClusterParameterArgs

Set of parameters needs to be set after DB cluster was launched. Available parameters can refer to the latest docs View database parameter templates .

PayType string

Valid values are PrePaid, PostPaid, Default to PostPaid.

Period int
Port string

(Available in 1.196.0+) PolarDB cluster connection port.

RenewalStatus string

Valid values are AutoRenewal, Normal, NotRenewal, Default to NotRenewal.

ResourceGroupId string

The ID of resource group which the PolarDB cluster belongs. If not specified, then it belongs to the default resource group.

RoleArn string

The Alibaba Cloud Resource Name (ARN) of the RAM role. A RAM role is a virtual identity that you can create within your Alibaba Cloud account. For more information see RAM role overview.

SecurityGroupIds []string

The ID of the security group. Separate multiple security groups with commas (,). You can add a maximum of three security groups to a cluster.

NOTE: Because of data backup and migration, change DB cluster type and storage would cost 15~20 minutes. Please make full preparation before changing them.

SecurityIps []string

This attribute has been deprecated from v1.130.0 and using db_cluster_ip_array sub-element security_ips instead. Its value is same as db_cluster_ip_array sub-element security_ips value and its db_cluster_ip_array_name is "default".

SourceResourceId string

The ID of the source RDS instance or the ID of the source PolarDB cluster. This parameter is required only when CreationOption is set to MigrationFromRDS, CloneFromRDS, or CloneFromPolarDB.Value options can refer to the latest docs CreateDBCluster SourceResourceId.

SubCategory string

The category of the cluster. Valid values are Exclusive, General. Only MySQL supports.

Tags map[string]interface{}

A mapping of tags to assign to the resource.

  • Key: It can be up to 64 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It cannot be a null string.
  • Value: It can be up to 128 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It can be a null string.
TdeRegion string

(Available in 1.200.0+) The region where the TDE key resides.

NOTE: TDE can be enabled on clusters that have joined a global database network (GDN). After TDE is enabled on the primary cluster in a GDN, TDE is enabled on the secondary clusters in the GDN by default. The key used by the secondary clusters and the region for the key resides must be the same as the primary cluster. The region of the key cannot be modified. NOTE: You cannot enable TDE for the secondary clusters in a GDN. Used to view user KMS activation status.

TdeStatus string

turn on TDE encryption. Valid values are Enabled, Disabled. Default to Disabled. TDE cannot be closed after it is turned on.

NOTE: tde_status Cannot modify after created when db_type is PostgreSQL or Oracle.tde_status only support modification from Disabled to Enabled when db_type is MySQL.

VpcId string

The id of the VPC.

VswitchId string

The virtual switch ID to launch DB instances in one VPC.

NOTE: If vswitch_id is not specified, system will get a vswitch belongs to the user automatically.

ZoneId string

The Zone to launch the DB cluster. it supports multiple zone.

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.

backupRetentionPolicyOnClusterDeletion String

The retention policy for the backup sets when you delete the cluster. Valid values are ALL, LATEST, NONE. Value options can refer to the latest docs DeleteDBCluster

cloneDataPoint String

The time point of data to be cloned. Valid values are LATEST,BackupID,Timestamp.Value options can refer to the latest docs CreateDBCluster CloneDataPoint.

NOTE: If CreationOption is set to CloneFromRDS, the value of this parameter must be LATEST.

collectorStatus String

Specifies whether to enable or disable SQL data collector. Valid values are Enable, Disabled.

connectionString String

(Available in 1.81.0+) PolarDB cluster connection string.

creationCategory String

The edition of the PolarDB service. Valid values are Normal,Basic,ArchiveNormal,NormalMultimaster.Value options can refer to the latest docs CreateDBCluster CreationCategory.

NOTE: You can set this parameter to Basic only when DBType is set to MySQL and DBVersion is set to 5.6, 5.7, or 8.0. You can set this parameter to Archive only when DBType is set to MySQL and DBVersion is set to 8.0. From version 1.188.0, creation_category can be set to NormalMultimaster.

creationOption String

The method that is used to create a cluster. Valid values are Normal,CloneFromPolarDB,CloneFromRDS,MigrationFromRDS,CreateGdnStandby.Value options can refer to the latest docs CreateDBCluster CreationOption.

NOTE: The default value is Normal. If DBType is set to MySQL and DBVersion is set to 5.6 or 5.7, this parameter can be set to CloneFromRDS or MigrationFromRDS. If DBType is set to MySQL and DBVersion is set to 8.0, this parameter can be set to CreateGdnStandby.

dbClusterIpArrays List<ClusterDbClusterIpArrayArgs>

db_cluster_ip_array defines how users can send requests to your API.

dbNodeClass String

The db_node_class of cluster node.

NOTE: Node specifications are divided into cluster version, single node version and History Library version. They can't change each other, but the general specification and exclusive specification of cluster version can be changed.

dbNodeCount Integer

Number of the PolarDB cluster nodes, default is 2(Each cluster must contain at least a primary node and a read-only node). Add/remove nodes by modifying this parameter, valid values: [2~16].

NOTE: To avoid adding or removing multiple read-only nodes by mistake, the system allows you to add or remove one read-only node at a time.

dbType String

Database type. Value options: MySQL, Oracle, PostgreSQL.

dbVersion String

Database version. Value options can refer to the latest docs CreateDBCluster DBVersion.

deletionLock Integer

turn on table deletion_lock. Valid values are 0, 1. 1 means to open the cluster protection lock, 0 means to close the cluster protection lock

NOTE: Cannot modify after created when pay_type is Prepaid .deletion_lock the cluster protection lock can be turned on or off when pay_type is Postpaid.

description String

The description of cluster.

encryptNewTables String

turn on table auto encryption. Valid values are ON, OFF. Only MySQL 8.0 supports.

NOTE: encrypt_new_tables Polardb MySQL 8.0 cluster, after TDE and Automatic Encryption are enabled, all newly created tables are automatically encrypted in the cluster.

encryptionKey String

The ID of the custom key. encryption_key cannot be modified after TDE is opened.

gdnId String

The ID of the global database network (GDN).

NOTE: This parameter is required if CreationOption is set to CreateGdnStandby.

imciSwitch String

Specifies whether to enable the In-Memory Column Index (IMCI) feature. Valid values are ON, OFF.

NOTE: Only polardb MySQL Cluster version is available. The cluster with minor version number of 8.0.1 supports the column index feature, and the specific kernel version must be 8.0.1.1.22 or above. NOTE: The single node, the single node version of the history library, and the cluster version of the history library do not support column save indexes.

maintainTime String

Maintainable time period format of the instance: HH:MMZ-HH:MMZ (UTC time)

modifyType String

Use as db_node_class change class, define upgrade or downgrade. Valid values are Upgrade, Downgrade, Default to Upgrade.

parameters List<ClusterParameterArgs>

Set of parameters needs to be set after DB cluster was launched. Available parameters can refer to the latest docs View database parameter templates .

payType String

Valid values are PrePaid, PostPaid, Default to PostPaid.

period Integer
port String

(Available in 1.196.0+) PolarDB cluster connection port.

renewalStatus String

Valid values are AutoRenewal, Normal, NotRenewal, Default to NotRenewal.

resourceGroupId String

The ID of resource group which the PolarDB cluster belongs. If not specified, then it belongs to the default resource group.

roleArn String

The Alibaba Cloud Resource Name (ARN) of the RAM role. A RAM role is a virtual identity that you can create within your Alibaba Cloud account. For more information see RAM role overview.

securityGroupIds List<String>

The ID of the security group. Separate multiple security groups with commas (,). You can add a maximum of three security groups to a cluster.

NOTE: Because of data backup and migration, change DB cluster type and storage would cost 15~20 minutes. Please make full preparation before changing them.

securityIps List<String>

This attribute has been deprecated from v1.130.0 and using db_cluster_ip_array sub-element security_ips instead. Its value is same as db_cluster_ip_array sub-element security_ips value and its db_cluster_ip_array_name is "default".

sourceResourceId String

The ID of the source RDS instance or the ID of the source PolarDB cluster. This parameter is required only when CreationOption is set to MigrationFromRDS, CloneFromRDS, or CloneFromPolarDB.Value options can refer to the latest docs CreateDBCluster SourceResourceId.

subCategory String

The category of the cluster. Valid values are Exclusive, General. Only MySQL supports.

tags Map<String,Object>

A mapping of tags to assign to the resource.

  • Key: It can be up to 64 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It cannot be a null string.
  • Value: It can be up to 128 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It can be a null string.
tdeRegion String

(Available in 1.200.0+) The region where the TDE key resides.

NOTE: TDE can be enabled on clusters that have joined a global database network (GDN). After TDE is enabled on the primary cluster in a GDN, TDE is enabled on the secondary clusters in the GDN by default. The key used by the secondary clusters and the region for the key resides must be the same as the primary cluster. The region of the key cannot be modified. NOTE: You cannot enable TDE for the secondary clusters in a GDN. Used to view user KMS activation status.

tdeStatus String

turn on TDE encryption. Valid values are Enabled, Disabled. Default to Disabled. TDE cannot be closed after it is turned on.

NOTE: tde_status Cannot modify after created when db_type is PostgreSQL or Oracle.tde_status only support modification from Disabled to Enabled when db_type is MySQL.

vpcId String

The id of the VPC.

vswitchId String

The virtual switch ID to launch DB instances in one VPC.

NOTE: If vswitch_id is not specified, system will get a vswitch belongs to the user automatically.

zoneId String

The Zone to launch the DB cluster. it supports multiple zone.

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.

backupRetentionPolicyOnClusterDeletion string

The retention policy for the backup sets when you delete the cluster. Valid values are ALL, LATEST, NONE. Value options can refer to the latest docs DeleteDBCluster

cloneDataPoint string

The time point of data to be cloned. Valid values are LATEST,BackupID,Timestamp.Value options can refer to the latest docs CreateDBCluster CloneDataPoint.

NOTE: If CreationOption is set to CloneFromRDS, the value of this parameter must be LATEST.

collectorStatus string

Specifies whether to enable or disable SQL data collector. Valid values are Enable, Disabled.

connectionString string

(Available in 1.81.0+) PolarDB cluster connection string.

creationCategory string

The edition of the PolarDB service. Valid values are Normal,Basic,ArchiveNormal,NormalMultimaster.Value options can refer to the latest docs CreateDBCluster CreationCategory.

NOTE: You can set this parameter to Basic only when DBType is set to MySQL and DBVersion is set to 5.6, 5.7, or 8.0. You can set this parameter to Archive only when DBType is set to MySQL and DBVersion is set to 8.0. From version 1.188.0, creation_category can be set to NormalMultimaster.

creationOption string

The method that is used to create a cluster. Valid values are Normal,CloneFromPolarDB,CloneFromRDS,MigrationFromRDS,CreateGdnStandby.Value options can refer to the latest docs CreateDBCluster CreationOption.

NOTE: The default value is Normal. If DBType is set to MySQL and DBVersion is set to 5.6 or 5.7, this parameter can be set to CloneFromRDS or MigrationFromRDS. If DBType is set to MySQL and DBVersion is set to 8.0, this parameter can be set to CreateGdnStandby.

dbClusterIpArrays ClusterDbClusterIpArrayArgs[]

db_cluster_ip_array defines how users can send requests to your API.

dbNodeClass string

The db_node_class of cluster node.

NOTE: Node specifications are divided into cluster version, single node version and History Library version. They can't change each other, but the general specification and exclusive specification of cluster version can be changed.

dbNodeCount number

Number of the PolarDB cluster nodes, default is 2(Each cluster must contain at least a primary node and a read-only node). Add/remove nodes by modifying this parameter, valid values: [2~16].

NOTE: To avoid adding or removing multiple read-only nodes by mistake, the system allows you to add or remove one read-only node at a time.

dbType string

Database type. Value options: MySQL, Oracle, PostgreSQL.

dbVersion string

Database version. Value options can refer to the latest docs CreateDBCluster DBVersion.

deletionLock number

turn on table deletion_lock. Valid values are 0, 1. 1 means to open the cluster protection lock, 0 means to close the cluster protection lock

NOTE: Cannot modify after created when pay_type is Prepaid .deletion_lock the cluster protection lock can be turned on or off when pay_type is Postpaid.

description string

The description of cluster.

encryptNewTables string

turn on table auto encryption. Valid values are ON, OFF. Only MySQL 8.0 supports.

NOTE: encrypt_new_tables Polardb MySQL 8.0 cluster, after TDE and Automatic Encryption are enabled, all newly created tables are automatically encrypted in the cluster.

encryptionKey string

The ID of the custom key. encryption_key cannot be modified after TDE is opened.

gdnId string

The ID of the global database network (GDN).

NOTE: This parameter is required if CreationOption is set to CreateGdnStandby.

imciSwitch string

Specifies whether to enable the In-Memory Column Index (IMCI) feature. Valid values are ON, OFF.

NOTE: Only polardb MySQL Cluster version is available. The cluster with minor version number of 8.0.1 supports the column index feature, and the specific kernel version must be 8.0.1.1.22 or above. NOTE: The single node, the single node version of the history library, and the cluster version of the history library do not support column save indexes.

maintainTime string

Maintainable time period format of the instance: HH:MMZ-HH:MMZ (UTC time)

modifyType string

Use as db_node_class change class, define upgrade or downgrade. Valid values are Upgrade, Downgrade, Default to Upgrade.

parameters ClusterParameterArgs[]

Set of parameters needs to be set after DB cluster was launched. Available parameters can refer to the latest docs View database parameter templates .

payType string

Valid values are PrePaid, PostPaid, Default to PostPaid.

period number
port string

(Available in 1.196.0+) PolarDB cluster connection port.

renewalStatus string

Valid values are AutoRenewal, Normal, NotRenewal, Default to NotRenewal.

resourceGroupId string

The ID of resource group which the PolarDB cluster belongs. If not specified, then it belongs to the default resource group.

roleArn string

The Alibaba Cloud Resource Name (ARN) of the RAM role. A RAM role is a virtual identity that you can create within your Alibaba Cloud account. For more information see RAM role overview.

securityGroupIds string[]

The ID of the security group. Separate multiple security groups with commas (,). You can add a maximum of three security groups to a cluster.

NOTE: Because of data backup and migration, change DB cluster type and storage would cost 15~20 minutes. Please make full preparation before changing them.

securityIps string[]

This attribute has been deprecated from v1.130.0 and using db_cluster_ip_array sub-element security_ips instead. Its value is same as db_cluster_ip_array sub-element security_ips value and its db_cluster_ip_array_name is "default".

sourceResourceId string

The ID of the source RDS instance or the ID of the source PolarDB cluster. This parameter is required only when CreationOption is set to MigrationFromRDS, CloneFromRDS, or CloneFromPolarDB.Value options can refer to the latest docs CreateDBCluster SourceResourceId.

subCategory string

The category of the cluster. Valid values are Exclusive, General. Only MySQL supports.

tags {[key: string]: any}

A mapping of tags to assign to the resource.

  • Key: It can be up to 64 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It cannot be a null string.
  • Value: It can be up to 128 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It can be a null string.
tdeRegion string

(Available in 1.200.0+) The region where the TDE key resides.

NOTE: TDE can be enabled on clusters that have joined a global database network (GDN). After TDE is enabled on the primary cluster in a GDN, TDE is enabled on the secondary clusters in the GDN by default. The key used by the secondary clusters and the region for the key resides must be the same as the primary cluster. The region of the key cannot be modified. NOTE: You cannot enable TDE for the secondary clusters in a GDN. Used to view user KMS activation status.

tdeStatus string

turn on TDE encryption. Valid values are Enabled, Disabled. Default to Disabled. TDE cannot be closed after it is turned on.

NOTE: tde_status Cannot modify after created when db_type is PostgreSQL or Oracle.tde_status only support modification from Disabled to Enabled when db_type is MySQL.

vpcId string

The id of the VPC.

vswitchId string

The virtual switch ID to launch DB instances in one VPC.

NOTE: If vswitch_id is not specified, system will get a vswitch belongs to the user automatically.

zoneId string

The Zone to launch the DB cluster. it supports multiple zone.

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.

backup_retention_policy_on_cluster_deletion str

The retention policy for the backup sets when you delete the cluster. Valid values are ALL, LATEST, NONE. Value options can refer to the latest docs DeleteDBCluster

clone_data_point str

The time point of data to be cloned. Valid values are LATEST,BackupID,Timestamp.Value options can refer to the latest docs CreateDBCluster CloneDataPoint.

NOTE: If CreationOption is set to CloneFromRDS, the value of this parameter must be LATEST.

collector_status str

Specifies whether to enable or disable SQL data collector. Valid values are Enable, Disabled.

connection_string str

(Available in 1.81.0+) PolarDB cluster connection string.

creation_category str

The edition of the PolarDB service. Valid values are Normal,Basic,ArchiveNormal,NormalMultimaster.Value options can refer to the latest docs CreateDBCluster CreationCategory.

NOTE: You can set this parameter to Basic only when DBType is set to MySQL and DBVersion is set to 5.6, 5.7, or 8.0. You can set this parameter to Archive only when DBType is set to MySQL and DBVersion is set to 8.0. From version 1.188.0, creation_category can be set to NormalMultimaster.

creation_option str

The method that is used to create a cluster. Valid values are Normal,CloneFromPolarDB,CloneFromRDS,MigrationFromRDS,CreateGdnStandby.Value options can refer to the latest docs CreateDBCluster CreationOption.

NOTE: The default value is Normal. If DBType is set to MySQL and DBVersion is set to 5.6 or 5.7, this parameter can be set to CloneFromRDS or MigrationFromRDS. If DBType is set to MySQL and DBVersion is set to 8.0, this parameter can be set to CreateGdnStandby.

db_cluster_ip_arrays Sequence[ClusterDbClusterIpArrayArgs]

db_cluster_ip_array defines how users can send requests to your API.

db_node_class str

The db_node_class of cluster node.

NOTE: Node specifications are divided into cluster version, single node version and History Library version. They can't change each other, but the general specification and exclusive specification of cluster version can be changed.

db_node_count int

Number of the PolarDB cluster nodes, default is 2(Each cluster must contain at least a primary node and a read-only node). Add/remove nodes by modifying this parameter, valid values: [2~16].

NOTE: To avoid adding or removing multiple read-only nodes by mistake, the system allows you to add or remove one read-only node at a time.

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.

deletion_lock int

turn on table deletion_lock. Valid values are 0, 1. 1 means to open the cluster protection lock, 0 means to close the cluster protection lock

NOTE: Cannot modify after created when pay_type is Prepaid .deletion_lock the cluster protection lock can be turned on or off when pay_type is Postpaid.

description str

The description of cluster.

encrypt_new_tables str

turn on table auto encryption. Valid values are ON, OFF. Only MySQL 8.0 supports.

NOTE: encrypt_new_tables Polardb MySQL 8.0 cluster, after TDE and Automatic Encryption are enabled, all newly created tables are automatically encrypted in the cluster.

encryption_key str

The ID of the custom key. encryption_key cannot be modified after TDE is opened.

gdn_id str

The ID of the global database network (GDN).

NOTE: This parameter is required if CreationOption is set to CreateGdnStandby.

imci_switch str

Specifies whether to enable the In-Memory Column Index (IMCI) feature. Valid values are ON, OFF.

NOTE: Only polardb MySQL Cluster version is available. The cluster with minor version number of 8.0.1 supports the column index feature, and the specific kernel version must be 8.0.1.1.22 or above. NOTE: The single node, the single node version of the history library, and the cluster version of the history library do not support column save indexes.

maintain_time str

Maintainable time period format of the instance: HH:MMZ-HH:MMZ (UTC time)

modify_type str

Use as db_node_class change class, define upgrade or downgrade. Valid values are Upgrade, Downgrade, Default to Upgrade.

parameters Sequence[ClusterParameterArgs]

Set of parameters needs to be set after DB cluster was launched. Available parameters can refer to the latest docs View database parameter templates .

pay_type str

Valid values are PrePaid, PostPaid, Default to PostPaid.

period int
port str

(Available in 1.196.0+) PolarDB cluster connection port.

renewal_status str

Valid values are AutoRenewal, Normal, NotRenewal, Default to NotRenewal.

resource_group_id str

The ID of resource group which the PolarDB cluster belongs. If not specified, then it belongs to the default resource group.

role_arn str

The Alibaba Cloud Resource Name (ARN) of the RAM role. A RAM role is a virtual identity that you can create within your Alibaba Cloud account. For more information see RAM role overview.

security_group_ids Sequence[str]

The ID of the security group. Separate multiple security groups with commas (,). You can add a maximum of three security groups to a cluster.

NOTE: Because of data backup and migration, change DB cluster type and storage would cost 15~20 minutes. Please make full preparation before changing them.

security_ips Sequence[str]

This attribute has been deprecated from v1.130.0 and using db_cluster_ip_array sub-element security_ips instead. Its value is same as db_cluster_ip_array sub-element security_ips value and its db_cluster_ip_array_name is "default".

source_resource_id str

The ID of the source RDS instance or the ID of the source PolarDB cluster. This parameter is required only when CreationOption is set to MigrationFromRDS, CloneFromRDS, or CloneFromPolarDB.Value options can refer to the latest docs CreateDBCluster SourceResourceId.

sub_category str

The category of the cluster. Valid values are Exclusive, General. Only MySQL supports.

tags Mapping[str, Any]

A mapping of tags to assign to the resource.

  • Key: It can be up to 64 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It cannot be a null string.
  • Value: It can be up to 128 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It can be a null string.
tde_region str

(Available in 1.200.0+) The region where the TDE key resides.

NOTE: TDE can be enabled on clusters that have joined a global database network (GDN). After TDE is enabled on the primary cluster in a GDN, TDE is enabled on the secondary clusters in the GDN by default. The key used by the secondary clusters and the region for the key resides must be the same as the primary cluster. The region of the key cannot be modified. NOTE: You cannot enable TDE for the secondary clusters in a GDN. Used to view user KMS activation status.

tde_status str

turn on TDE encryption. Valid values are Enabled, Disabled. Default to Disabled. TDE cannot be closed after it is turned on.

NOTE: tde_status Cannot modify after created when db_type is PostgreSQL or Oracle.tde_status only support modification from Disabled to Enabled when db_type is MySQL.

vpc_id str

The id of the VPC.

vswitch_id str

The virtual switch ID to launch DB instances in one VPC.

NOTE: If vswitch_id is not specified, system will get a vswitch belongs to the user automatically.

zone_id str

The Zone to launch the DB cluster. it supports multiple zone.

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.

backupRetentionPolicyOnClusterDeletion String

The retention policy for the backup sets when you delete the cluster. Valid values are ALL, LATEST, NONE. Value options can refer to the latest docs DeleteDBCluster

cloneDataPoint String

The time point of data to be cloned. Valid values are LATEST,BackupID,Timestamp.Value options can refer to the latest docs CreateDBCluster CloneDataPoint.

NOTE: If CreationOption is set to CloneFromRDS, the value of this parameter must be LATEST.

collectorStatus String

Specifies whether to enable or disable SQL data collector. Valid values are Enable, Disabled.

connectionString String

(Available in 1.81.0+) PolarDB cluster connection string.

creationCategory String

The edition of the PolarDB service. Valid values are Normal,Basic,ArchiveNormal,NormalMultimaster.Value options can refer to the latest docs CreateDBCluster CreationCategory.

NOTE: You can set this parameter to Basic only when DBType is set to MySQL and DBVersion is set to 5.6, 5.7, or 8.0. You can set this parameter to Archive only when DBType is set to MySQL and DBVersion is set to 8.0. From version 1.188.0, creation_category can be set to NormalMultimaster.

creationOption String

The method that is used to create a cluster. Valid values are Normal,CloneFromPolarDB,CloneFromRDS,MigrationFromRDS,CreateGdnStandby.Value options can refer to the latest docs CreateDBCluster CreationOption.

NOTE: The default value is Normal. If DBType is set to MySQL and DBVersion is set to 5.6 or 5.7, this parameter can be set to CloneFromRDS or MigrationFromRDS. If DBType is set to MySQL and DBVersion is set to 8.0, this parameter can be set to CreateGdnStandby.

dbClusterIpArrays List<Property Map>

db_cluster_ip_array defines how users can send requests to your API.

dbNodeClass String

The db_node_class of cluster node.

NOTE: Node specifications are divided into cluster version, single node version and History Library version. They can't change each other, but the general specification and exclusive specification of cluster version can be changed.

dbNodeCount Number

Number of the PolarDB cluster nodes, default is 2(Each cluster must contain at least a primary node and a read-only node). Add/remove nodes by modifying this parameter, valid values: [2~16].

NOTE: To avoid adding or removing multiple read-only nodes by mistake, the system allows you to add or remove one read-only node at a time.

dbType String

Database type. Value options: MySQL, Oracle, PostgreSQL.

dbVersion String

Database version. Value options can refer to the latest docs CreateDBCluster DBVersion.

deletionLock Number

turn on table deletion_lock. Valid values are 0, 1. 1 means to open the cluster protection lock, 0 means to close the cluster protection lock

NOTE: Cannot modify after created when pay_type is Prepaid .deletion_lock the cluster protection lock can be turned on or off when pay_type is Postpaid.

description String

The description of cluster.

encryptNewTables String

turn on table auto encryption. Valid values are ON, OFF. Only MySQL 8.0 supports.

NOTE: encrypt_new_tables Polardb MySQL 8.0 cluster, after TDE and Automatic Encryption are enabled, all newly created tables are automatically encrypted in the cluster.

encryptionKey String

The ID of the custom key. encryption_key cannot be modified after TDE is opened.

gdnId String

The ID of the global database network (GDN).

NOTE: This parameter is required if CreationOption is set to CreateGdnStandby.

imciSwitch String

Specifies whether to enable the In-Memory Column Index (IMCI) feature. Valid values are ON, OFF.

NOTE: Only polardb MySQL Cluster version is available. The cluster with minor version number of 8.0.1 supports the column index feature, and the specific kernel version must be 8.0.1.1.22 or above. NOTE: The single node, the single node version of the history library, and the cluster version of the history library do not support column save indexes.

maintainTime String

Maintainable time period format of the instance: HH:MMZ-HH:MMZ (UTC time)

modifyType String

Use as db_node_class change class, define upgrade or downgrade. Valid values are Upgrade, Downgrade, Default to Upgrade.

parameters List<Property Map>

Set of parameters needs to be set after DB cluster was launched. Available parameters can refer to the latest docs View database parameter templates .

payType String

Valid values are PrePaid, PostPaid, Default to PostPaid.

period Number
port String

(Available in 1.196.0+) PolarDB cluster connection port.

renewalStatus String

Valid values are AutoRenewal, Normal, NotRenewal, Default to NotRenewal.

resourceGroupId String

The ID of resource group which the PolarDB cluster belongs. If not specified, then it belongs to the default resource group.

roleArn String

The Alibaba Cloud Resource Name (ARN) of the RAM role. A RAM role is a virtual identity that you can create within your Alibaba Cloud account. For more information see RAM role overview.

securityGroupIds List<String>

The ID of the security group. Separate multiple security groups with commas (,). You can add a maximum of three security groups to a cluster.

NOTE: Because of data backup and migration, change DB cluster type and storage would cost 15~20 minutes. Please make full preparation before changing them.

securityIps List<String>

This attribute has been deprecated from v1.130.0 and using db_cluster_ip_array sub-element security_ips instead. Its value is same as db_cluster_ip_array sub-element security_ips value and its db_cluster_ip_array_name is "default".

sourceResourceId String

The ID of the source RDS instance or the ID of the source PolarDB cluster. This parameter is required only when CreationOption is set to MigrationFromRDS, CloneFromRDS, or CloneFromPolarDB.Value options can refer to the latest docs CreateDBCluster SourceResourceId.

subCategory String

The category of the cluster. Valid values are Exclusive, General. Only MySQL supports.

tags Map<Any>

A mapping of tags to assign to the resource.

  • Key: It can be up to 64 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It cannot be a null string.
  • Value: It can be up to 128 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It can be a null string.
tdeRegion String

(Available in 1.200.0+) The region where the TDE key resides.

NOTE: TDE can be enabled on clusters that have joined a global database network (GDN). After TDE is enabled on the primary cluster in a GDN, TDE is enabled on the secondary clusters in the GDN by default. The key used by the secondary clusters and the region for the key resides must be the same as the primary cluster. The region of the key cannot be modified. NOTE: You cannot enable TDE for the secondary clusters in a GDN. Used to view user KMS activation status.

tdeStatus String

turn on TDE encryption. Valid values are Enabled, Disabled. Default to Disabled. TDE cannot be closed after it is turned on.

NOTE: tde_status Cannot modify after created when db_type is PostgreSQL or Oracle.tde_status only support modification from Disabled to Enabled when db_type is MySQL.

vpcId String

The id of the VPC.

vswitchId String

The virtual switch ID to launch DB instances in one VPC.

NOTE: If vswitch_id is not specified, system will get a vswitch belongs to the user automatically.

zoneId String

The Zone to launch the DB cluster. it supports multiple zone.

Supporting Types

ClusterDbClusterIpArray

DbClusterIpArrayName string

The name of the IP whitelist group. The group name must be 2 to 120 characters in length and consists of lowercase letters and digits. It must start with a letter, and end with a letter or a digit. NOTE: If the specified whitelist group name does not exist, the whitelist group is created. If the specified whitelist group name exists, the whitelist group is modified. If you do not specify this parameter, the default group is modified. You can create a maximum of 50 IP whitelist groups for a cluster.

ModifyMode string

The method for modifying the IP whitelist. Valid values are Cover, Append, Delete. NOTE: There does not recommend setting modify_mode to Append or Delete and it will bring a potential diff error.

SecurityIps List<string>

This attribute has been deprecated from v1.130.0 and using db_cluster_ip_array sub-element security_ips instead. Its value is same as db_cluster_ip_array sub-element security_ips value and its db_cluster_ip_array_name is "default".

DbClusterIpArrayName string

The name of the IP whitelist group. The group name must be 2 to 120 characters in length and consists of lowercase letters and digits. It must start with a letter, and end with a letter or a digit. NOTE: If the specified whitelist group name does not exist, the whitelist group is created. If the specified whitelist group name exists, the whitelist group is modified. If you do not specify this parameter, the default group is modified. You can create a maximum of 50 IP whitelist groups for a cluster.

ModifyMode string

The method for modifying the IP whitelist. Valid values are Cover, Append, Delete. NOTE: There does not recommend setting modify_mode to Append or Delete and it will bring a potential diff error.

SecurityIps []string

This attribute has been deprecated from v1.130.0 and using db_cluster_ip_array sub-element security_ips instead. Its value is same as db_cluster_ip_array sub-element security_ips value and its db_cluster_ip_array_name is "default".

dbClusterIpArrayName String

The name of the IP whitelist group. The group name must be 2 to 120 characters in length and consists of lowercase letters and digits. It must start with a letter, and end with a letter or a digit. NOTE: If the specified whitelist group name does not exist, the whitelist group is created. If the specified whitelist group name exists, the whitelist group is modified. If you do not specify this parameter, the default group is modified. You can create a maximum of 50 IP whitelist groups for a cluster.

modifyMode String

The method for modifying the IP whitelist. Valid values are Cover, Append, Delete. NOTE: There does not recommend setting modify_mode to Append or Delete and it will bring a potential diff error.

securityIps List<String>

This attribute has been deprecated from v1.130.0 and using db_cluster_ip_array sub-element security_ips instead. Its value is same as db_cluster_ip_array sub-element security_ips value and its db_cluster_ip_array_name is "default".

dbClusterIpArrayName string

The name of the IP whitelist group. The group name must be 2 to 120 characters in length and consists of lowercase letters and digits. It must start with a letter, and end with a letter or a digit. NOTE: If the specified whitelist group name does not exist, the whitelist group is created. If the specified whitelist group name exists, the whitelist group is modified. If you do not specify this parameter, the default group is modified. You can create a maximum of 50 IP whitelist groups for a cluster.

modifyMode string

The method for modifying the IP whitelist. Valid values are Cover, Append, Delete. NOTE: There does not recommend setting modify_mode to Append or Delete and it will bring a potential diff error.

securityIps string[]

This attribute has been deprecated from v1.130.0 and using db_cluster_ip_array sub-element security_ips instead. Its value is same as db_cluster_ip_array sub-element security_ips value and its db_cluster_ip_array_name is "default".

db_cluster_ip_array_name str

The name of the IP whitelist group. The group name must be 2 to 120 characters in length and consists of lowercase letters and digits. It must start with a letter, and end with a letter or a digit. NOTE: If the specified whitelist group name does not exist, the whitelist group is created. If the specified whitelist group name exists, the whitelist group is modified. If you do not specify this parameter, the default group is modified. You can create a maximum of 50 IP whitelist groups for a cluster.

modify_mode str

The method for modifying the IP whitelist. Valid values are Cover, Append, Delete. NOTE: There does not recommend setting modify_mode to Append or Delete and it will bring a potential diff error.

security_ips Sequence[str]

This attribute has been deprecated from v1.130.0 and using db_cluster_ip_array sub-element security_ips instead. Its value is same as db_cluster_ip_array sub-element security_ips value and its db_cluster_ip_array_name is "default".

dbClusterIpArrayName String

The name of the IP whitelist group. The group name must be 2 to 120 characters in length and consists of lowercase letters and digits. It must start with a letter, and end with a letter or a digit. NOTE: If the specified whitelist group name does not exist, the whitelist group is created. If the specified whitelist group name exists, the whitelist group is modified. If you do not specify this parameter, the default group is modified. You can create a maximum of 50 IP whitelist groups for a cluster.

modifyMode String

The method for modifying the IP whitelist. Valid values are Cover, Append, Delete. NOTE: There does not recommend setting modify_mode to Append or Delete and it will bring a potential diff error.

securityIps List<String>

This attribute has been deprecated from v1.130.0 and using db_cluster_ip_array sub-element security_ips instead. Its value is same as db_cluster_ip_array sub-element security_ips value and its db_cluster_ip_array_name is "default".

ClusterParameter

Name string
Value string
Name string
Value string
name String
value String
name string
value string
name str
value str
name String
value String

Import

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

 $ pulumi import alicloud:polardb/cluster:Cluster example pc-abc12345678

Package Details

Repository
Alibaba Cloud pulumi/pulumi-alicloud
License
Apache-2.0
Notes

This Pulumi package is based on the alicloud Terraform Provider.