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:
- Db
Node stringClass 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 string Database type. Value options: MySQL, Oracle, PostgreSQL.
- Db
Version string Database version. Value options can refer to the latest docs CreateDBCluster
DBVersion
.- Auto
Renew intPeriod 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 stringPolicy On Cluster Deletion 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 stringPoint The time point of data to be cloned. Valid values are
LATEST
,BackupID
,Timestamp
.Value options can refer to the latest docs CreateDBClusterCloneDataPoint
.NOTE: If CreationOption is set to CloneFromRDS, the value of this parameter must be LATEST.
- Collector
Status string Specifies whether to enable or disable SQL data collector. Valid values are
Enable
,Disabled
.- Creation
Category string The edition of the PolarDB service. Valid values are
Normal
,Basic
,ArchiveNormal
,NormalMultimaster
.Value options can refer to the latest docs CreateDBClusterCreationCategory
.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 toNormalMultimaster
.- Creation
Option 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 CreateDBClusterCreationOption
.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 List<Pulumi.Ip Arrays Ali Cloud. Polar DB. Inputs. Cluster Db Cluster Ip Array Args> db_cluster_ip_array defines how users can send requests to your API.
- Db
Node intCount 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
isPrepaid
.deletion_lock
the cluster protection lock can be turned on or off whenpay_type
isPostpaid
.- Description string
The description of cluster.
- Encrypt
New stringTables 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 string The ID of the custom key.
encryption_key
cannot be modified after TDE is opened.- Gdn
Id string The ID of the global database network (GDN).
NOTE: This parameter is required if CreationOption is set to CreateGdnStandby.
- Imci
Switch 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.
- Maintain
Time string Maintainable time period format of the instance: HH:MMZ-HH:MMZ (UTC time)
- Modify
Type string Use as
db_node_class
change class, define upgrade or downgrade. Valid values areUpgrade
,Downgrade
, Default toUpgrade
.- Parameters
List<Pulumi.
Ali Cloud. Polar DB. Inputs. Cluster Parameter Args> 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 string Valid values are
PrePaid
,PostPaid
, Default toPostPaid
.- Period int
- Renewal
Status string Valid values are
AutoRenewal
,Normal
,NotRenewal
, Default toNotRenewal
.- Resource
Group stringId The ID of resource group which the PolarDB cluster belongs. If not specified, then it belongs to the default resource group.
- Role
Arn 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.
- Security
Group List<string>Ids 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 List<string> This attribute has been deprecated from v1.130.0 and using
db_cluster_ip_array
sub-elementsecurity_ips
instead. Its value is same asdb_cluster_ip_array
sub-elementsecurity_ips
value and its db_cluster_ip_array_name is "default".- Source
Resource stringId 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 string The category of the cluster. Valid values are
Exclusive
,General
. Only MySQL supports.- 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.
- Tde
Status string turn on TDE encryption. Valid values are
Enabled
,Disabled
. Default toDisabled
. TDE cannot be closed after it is turned on.NOTE:
tde_status
Cannot modify after created whendb_type
isPostgreSQL
orOracle
.tde_status
only support modification fromDisabled
toEnabled
whendb_type
isMySQL
.- Vpc
Id string The id of the VPC.
- Vswitch
Id 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.
- Zone
Id string The Zone to launch the DB cluster. it supports multiple zone.
- Db
Node stringClass 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 string Database type. Value options: MySQL, Oracle, PostgreSQL.
- Db
Version string Database version. Value options can refer to the latest docs CreateDBCluster
DBVersion
.- Auto
Renew intPeriod 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 stringPolicy On Cluster Deletion 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 stringPoint The time point of data to be cloned. Valid values are
LATEST
,BackupID
,Timestamp
.Value options can refer to the latest docs CreateDBClusterCloneDataPoint
.NOTE: If CreationOption is set to CloneFromRDS, the value of this parameter must be LATEST.
- Collector
Status string Specifies whether to enable or disable SQL data collector. Valid values are
Enable
,Disabled
.- Creation
Category string The edition of the PolarDB service. Valid values are
Normal
,Basic
,ArchiveNormal
,NormalMultimaster
.Value options can refer to the latest docs CreateDBClusterCreationCategory
.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 toNormalMultimaster
.- Creation
Option 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 CreateDBClusterCreationOption
.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 []ClusterIp Arrays Db Cluster Ip Array Args db_cluster_ip_array defines how users can send requests to your API.
- Db
Node intCount 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
isPrepaid
.deletion_lock
the cluster protection lock can be turned on or off whenpay_type
isPostpaid
.- Description string
The description of cluster.
- Encrypt
New stringTables 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 string The ID of the custom key.
encryption_key
cannot be modified after TDE is opened.- Gdn
Id string The ID of the global database network (GDN).
NOTE: This parameter is required if CreationOption is set to CreateGdnStandby.
- Imci
Switch 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.
- Maintain
Time string Maintainable time period format of the instance: HH:MMZ-HH:MMZ (UTC time)
- Modify
Type string Use as
db_node_class
change class, define upgrade or downgrade. Valid values areUpgrade
,Downgrade
, Default toUpgrade
.- Parameters
[]Cluster
Parameter Args 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 string Valid values are
PrePaid
,PostPaid
, Default toPostPaid
.- Period int
- Renewal
Status string Valid values are
AutoRenewal
,Normal
,NotRenewal
, Default toNotRenewal
.- Resource
Group stringId The ID of resource group which the PolarDB cluster belongs. If not specified, then it belongs to the default resource group.
- Role
Arn 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.
- Security
Group []stringIds 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 []string This attribute has been deprecated from v1.130.0 and using
db_cluster_ip_array
sub-elementsecurity_ips
instead. Its value is same asdb_cluster_ip_array
sub-elementsecurity_ips
value and its db_cluster_ip_array_name is "default".- Source
Resource stringId 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 string The category of the cluster. Valid values are
Exclusive
,General
. Only MySQL supports.- 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.
- Tde
Status string turn on TDE encryption. Valid values are
Enabled
,Disabled
. Default toDisabled
. TDE cannot be closed after it is turned on.NOTE:
tde_status
Cannot modify after created whendb_type
isPostgreSQL
orOracle
.tde_status
only support modification fromDisabled
toEnabled
whendb_type
isMySQL
.- Vpc
Id string The id of the VPC.
- Vswitch
Id 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.
- Zone
Id string The Zone to launch the DB cluster. it supports multiple zone.
- db
Node StringClass 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 String Database type. Value options: MySQL, Oracle, PostgreSQL.
- db
Version String Database version. Value options can refer to the latest docs CreateDBCluster
DBVersion
.- auto
Renew IntegerPeriod 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 StringPolicy On Cluster Deletion 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 StringPoint The time point of data to be cloned. Valid values are
LATEST
,BackupID
,Timestamp
.Value options can refer to the latest docs CreateDBClusterCloneDataPoint
.NOTE: If CreationOption is set to CloneFromRDS, the value of this parameter must be LATEST.
- collector
Status String Specifies whether to enable or disable SQL data collector. Valid values are
Enable
,Disabled
.- creation
Category String The edition of the PolarDB service. Valid values are
Normal
,Basic
,ArchiveNormal
,NormalMultimaster
.Value options can refer to the latest docs CreateDBClusterCreationCategory
.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 toNormalMultimaster
.- creation
Option 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 CreateDBClusterCreationOption
.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 List<ClusterIp Arrays Db Cluster Ip Array Args> db_cluster_ip_array defines how users can send requests to your API.
- db
Node IntegerCount 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 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
isPrepaid
.deletion_lock
the cluster protection lock can be turned on or off whenpay_type
isPostpaid
.- description String
The description of cluster.
- encrypt
New StringTables 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 String The ID of the custom key.
encryption_key
cannot be modified after TDE is opened.- gdn
Id String The ID of the global database network (GDN).
NOTE: This parameter is required if CreationOption is set to CreateGdnStandby.
- imci
Switch 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.
- maintain
Time String Maintainable time period format of the instance: HH:MMZ-HH:MMZ (UTC time)
- modify
Type String Use as
db_node_class
change class, define upgrade or downgrade. Valid values areUpgrade
,Downgrade
, Default toUpgrade
.- parameters
List<Cluster
Parameter Args> 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 String Valid values are
PrePaid
,PostPaid
, Default toPostPaid
.- period Integer
- renewal
Status String Valid values are
AutoRenewal
,Normal
,NotRenewal
, Default toNotRenewal
.- resource
Group StringId The ID of resource group which the PolarDB cluster belongs. If not specified, then it belongs to the default resource group.
- role
Arn 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.
- security
Group List<String>Ids 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 List<String> This attribute has been deprecated from v1.130.0 and using
db_cluster_ip_array
sub-elementsecurity_ips
instead. Its value is same asdb_cluster_ip_array
sub-elementsecurity_ips
value and its db_cluster_ip_array_name is "default".- source
Resource StringId 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 String The category of the cluster. Valid values are
Exclusive
,General
. Only MySQL supports.- 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.
- tde
Status String turn on TDE encryption. Valid values are
Enabled
,Disabled
. Default toDisabled
. TDE cannot be closed after it is turned on.NOTE:
tde_status
Cannot modify after created whendb_type
isPostgreSQL
orOracle
.tde_status
only support modification fromDisabled
toEnabled
whendb_type
isMySQL
.- vpc
Id String The id of the VPC.
- vswitch
Id 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.
- zone
Id String The Zone to launch the DB cluster. it supports multiple zone.
- db
Node stringClass 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 string Database type. Value options: MySQL, Oracle, PostgreSQL.
- db
Version string Database version. Value options can refer to the latest docs CreateDBCluster
DBVersion
.- auto
Renew numberPeriod 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 stringPolicy On Cluster Deletion 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 stringPoint The time point of data to be cloned. Valid values are
LATEST
,BackupID
,Timestamp
.Value options can refer to the latest docs CreateDBClusterCloneDataPoint
.NOTE: If CreationOption is set to CloneFromRDS, the value of this parameter must be LATEST.
- collector
Status string Specifies whether to enable or disable SQL data collector. Valid values are
Enable
,Disabled
.- creation
Category string The edition of the PolarDB service. Valid values are
Normal
,Basic
,ArchiveNormal
,NormalMultimaster
.Value options can refer to the latest docs CreateDBClusterCreationCategory
.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 toNormalMultimaster
.- creation
Option 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 CreateDBClusterCreationOption
.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 ClusterIp Arrays Db Cluster Ip Array Args[] db_cluster_ip_array defines how users can send requests to your API.
- db
Node numberCount 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 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
isPrepaid
.deletion_lock
the cluster protection lock can be turned on or off whenpay_type
isPostpaid
.- description string
The description of cluster.
- encrypt
New stringTables 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 string The ID of the custom key.
encryption_key
cannot be modified after TDE is opened.- gdn
Id string The ID of the global database network (GDN).
NOTE: This parameter is required if CreationOption is set to CreateGdnStandby.
- imci
Switch 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.
- maintain
Time string Maintainable time period format of the instance: HH:MMZ-HH:MMZ (UTC time)
- modify
Type string Use as
db_node_class
change class, define upgrade or downgrade. Valid values areUpgrade
,Downgrade
, Default toUpgrade
.- parameters
Cluster
Parameter Args[] 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 string Valid values are
PrePaid
,PostPaid
, Default toPostPaid
.- period number
- renewal
Status string Valid values are
AutoRenewal
,Normal
,NotRenewal
, Default toNotRenewal
.- resource
Group stringId The ID of resource group which the PolarDB cluster belongs. If not specified, then it belongs to the default resource group.
- role
Arn 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.
- security
Group string[]Ids 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 string[] This attribute has been deprecated from v1.130.0 and using
db_cluster_ip_array
sub-elementsecurity_ips
instead. Its value is same asdb_cluster_ip_array
sub-elementsecurity_ips
value and its db_cluster_ip_array_name is "default".- source
Resource stringId 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 string The category of the cluster. Valid values are
Exclusive
,General
. Only MySQL supports.- {[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.
- tde
Status string turn on TDE encryption. Valid values are
Enabled
,Disabled
. Default toDisabled
. TDE cannot be closed after it is turned on.NOTE:
tde_status
Cannot modify after created whendb_type
isPostgreSQL
orOracle
.tde_status
only support modification fromDisabled
toEnabled
whendb_type
isMySQL
.- vpc
Id string The id of the VPC.
- vswitch
Id 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.
- zone
Id string The Zone to launch the DB cluster. it supports multiple zone.
- db_
node_ strclass 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_ intperiod 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_ strpolicy_ on_ cluster_ deletion 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_ strpoint The time point of data to be cloned. Valid values are
LATEST
,BackupID
,Timestamp
.Value options can refer to the latest docs CreateDBClusterCloneDataPoint
.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 CreateDBClusterCreationCategory
.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 toNormalMultimaster
.- 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 CreateDBClusterCreationOption
.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_ Sequence[Clusterip_ arrays Db Cluster Ip Array Args] db_cluster_ip_array defines how users can send requests to your API.
- db_
node_ intcount 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
isPrepaid
.deletion_lock
the cluster protection lock can be turned on or off whenpay_type
isPostpaid
.- description str
The description of cluster.
- encrypt_
new_ strtables 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 areUpgrade
,Downgrade
, Default toUpgrade
.- parameters
Sequence[Cluster
Parameter Args] 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 toPostPaid
.- period int
- renewal_
status str Valid values are
AutoRenewal
,Normal
,NotRenewal
, Default toNotRenewal
.- resource_
group_ strid 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_ Sequence[str]ids 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-elementsecurity_ips
instead. Its value is same asdb_cluster_ip_array
sub-elementsecurity_ips
value and its db_cluster_ip_array_name is "default".- source_
resource_ strid 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.- 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 toDisabled
. TDE cannot be closed after it is turned on.NOTE:
tde_status
Cannot modify after created whendb_type
isPostgreSQL
orOracle
.tde_status
only support modification fromDisabled
toEnabled
whendb_type
isMySQL
.- 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.
- db
Node StringClass 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 String Database type. Value options: MySQL, Oracle, PostgreSQL.
- db
Version String Database version. Value options can refer to the latest docs CreateDBCluster
DBVersion
.- auto
Renew NumberPeriod 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 StringPolicy On Cluster Deletion 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 StringPoint The time point of data to be cloned. Valid values are
LATEST
,BackupID
,Timestamp
.Value options can refer to the latest docs CreateDBClusterCloneDataPoint
.NOTE: If CreationOption is set to CloneFromRDS, the value of this parameter must be LATEST.
- collector
Status String Specifies whether to enable or disable SQL data collector. Valid values are
Enable
,Disabled
.- creation
Category String The edition of the PolarDB service. Valid values are
Normal
,Basic
,ArchiveNormal
,NormalMultimaster
.Value options can refer to the latest docs CreateDBClusterCreationCategory
.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 toNormalMultimaster
.- creation
Option 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 CreateDBClusterCreationOption
.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 List<Property Map>Ip Arrays db_cluster_ip_array defines how users can send requests to your API.
- db
Node NumberCount 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 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
isPrepaid
.deletion_lock
the cluster protection lock can be turned on or off whenpay_type
isPostpaid
.- description String
The description of cluster.
- encrypt
New StringTables 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 String The ID of the custom key.
encryption_key
cannot be modified after TDE is opened.- gdn
Id String The ID of the global database network (GDN).
NOTE: This parameter is required if CreationOption is set to CreateGdnStandby.
- imci
Switch 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.
- maintain
Time String Maintainable time period format of the instance: HH:MMZ-HH:MMZ (UTC time)
- modify
Type String Use as
db_node_class
change class, define upgrade or downgrade. Valid values areUpgrade
,Downgrade
, Default toUpgrade
.- 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 .
- pay
Type String Valid values are
PrePaid
,PostPaid
, Default toPostPaid
.- period Number
- renewal
Status String Valid values are
AutoRenewal
,Normal
,NotRenewal
, Default toNotRenewal
.- resource
Group StringId The ID of resource group which the PolarDB cluster belongs. If not specified, then it belongs to the default resource group.
- role
Arn 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.
- security
Group List<String>Ids 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 List<String> This attribute has been deprecated from v1.130.0 and using
db_cluster_ip_array
sub-elementsecurity_ips
instead. Its value is same asdb_cluster_ip_array
sub-elementsecurity_ips
value and its db_cluster_ip_array_name is "default".- source
Resource StringId 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 String The category of the cluster. Valid values are
Exclusive
,General
. Only MySQL supports.- 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.
- tde
Status String turn on TDE encryption. Valid values are
Enabled
,Disabled
. Default toDisabled
. TDE cannot be closed after it is turned on.NOTE:
tde_status
Cannot modify after created whendb_type
isPostgreSQL
orOracle
.tde_status
only support modification fromDisabled
toEnabled
whendb_type
isMySQL
.- vpc
Id String The id of the VPC.
- vswitch
Id 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.
- zone
Id 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:
- Connection
String 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.
- Tde
Region 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 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.
- Tde
Region 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 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.
- tde
Region 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 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.
- tde
Region 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.
- connection
String 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.
- tde
Region 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.
- Auto
Renew intPeriod 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 stringPolicy On Cluster Deletion 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 stringPoint The time point of data to be cloned. Valid values are
LATEST
,BackupID
,Timestamp
.Value options can refer to the latest docs CreateDBClusterCloneDataPoint
.NOTE: If CreationOption is set to CloneFromRDS, the value of this parameter must be LATEST.
- Collector
Status string Specifies whether to enable or disable SQL data collector. Valid values are
Enable
,Disabled
.- Connection
String string (Available in 1.81.0+) PolarDB cluster connection string.
- Creation
Category string The edition of the PolarDB service. Valid values are
Normal
,Basic
,ArchiveNormal
,NormalMultimaster
.Value options can refer to the latest docs CreateDBClusterCreationCategory
.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 toNormalMultimaster
.- Creation
Option 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 CreateDBClusterCreationOption
.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 List<Pulumi.Ip Arrays Ali Cloud. Polar DB. Inputs. Cluster Db Cluster Ip Array Args> db_cluster_ip_array defines how users can send requests to your API.
- Db
Node stringClass 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 intCount 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 string Database type. Value options: MySQL, Oracle, PostgreSQL.
- Db
Version string 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
isPrepaid
.deletion_lock
the cluster protection lock can be turned on or off whenpay_type
isPostpaid
.- Description string
The description of cluster.
- Encrypt
New stringTables 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 string The ID of the custom key.
encryption_key
cannot be modified after TDE is opened.- Gdn
Id string The ID of the global database network (GDN).
NOTE: This parameter is required if CreationOption is set to CreateGdnStandby.
- Imci
Switch 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.
- Maintain
Time string Maintainable time period format of the instance: HH:MMZ-HH:MMZ (UTC time)
- Modify
Type string Use as
db_node_class
change class, define upgrade or downgrade. Valid values areUpgrade
,Downgrade
, Default toUpgrade
.- Parameters
List<Pulumi.
Ali Cloud. Polar DB. Inputs. Cluster Parameter Args> 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 string Valid values are
PrePaid
,PostPaid
, Default toPostPaid
.- Period int
- Port string
(Available in 1.196.0+) PolarDB cluster connection port.
- Renewal
Status string Valid values are
AutoRenewal
,Normal
,NotRenewal
, Default toNotRenewal
.- Resource
Group stringId The ID of resource group which the PolarDB cluster belongs. If not specified, then it belongs to the default resource group.
- Role
Arn 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.
- Security
Group List<string>Ids 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 List<string> This attribute has been deprecated from v1.130.0 and using
db_cluster_ip_array
sub-elementsecurity_ips
instead. Its value is same asdb_cluster_ip_array
sub-elementsecurity_ips
value and its db_cluster_ip_array_name is "default".- Source
Resource stringId 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 string The category of the cluster. Valid values are
Exclusive
,General
. Only MySQL supports.- 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.
- Tde
Region 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.
- Tde
Status string turn on TDE encryption. Valid values are
Enabled
,Disabled
. Default toDisabled
. TDE cannot be closed after it is turned on.NOTE:
tde_status
Cannot modify after created whendb_type
isPostgreSQL
orOracle
.tde_status
only support modification fromDisabled
toEnabled
whendb_type
isMySQL
.- Vpc
Id string The id of the VPC.
- Vswitch
Id 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.
- Zone
Id string The Zone to launch the DB cluster. it supports multiple zone.
- Auto
Renew intPeriod 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 stringPolicy On Cluster Deletion 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 stringPoint The time point of data to be cloned. Valid values are
LATEST
,BackupID
,Timestamp
.Value options can refer to the latest docs CreateDBClusterCloneDataPoint
.NOTE: If CreationOption is set to CloneFromRDS, the value of this parameter must be LATEST.
- Collector
Status string Specifies whether to enable or disable SQL data collector. Valid values are
Enable
,Disabled
.- Connection
String string (Available in 1.81.0+) PolarDB cluster connection string.
- Creation
Category string The edition of the PolarDB service. Valid values are
Normal
,Basic
,ArchiveNormal
,NormalMultimaster
.Value options can refer to the latest docs CreateDBClusterCreationCategory
.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 toNormalMultimaster
.- Creation
Option 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 CreateDBClusterCreationOption
.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 []ClusterIp Arrays Db Cluster Ip Array Args db_cluster_ip_array defines how users can send requests to your API.
- Db
Node stringClass 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 intCount 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 string Database type. Value options: MySQL, Oracle, PostgreSQL.
- Db
Version string 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
isPrepaid
.deletion_lock
the cluster protection lock can be turned on or off whenpay_type
isPostpaid
.- Description string
The description of cluster.
- Encrypt
New stringTables 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 string The ID of the custom key.
encryption_key
cannot be modified after TDE is opened.- Gdn
Id string The ID of the global database network (GDN).
NOTE: This parameter is required if CreationOption is set to CreateGdnStandby.
- Imci
Switch 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.
- Maintain
Time string Maintainable time period format of the instance: HH:MMZ-HH:MMZ (UTC time)
- Modify
Type string Use as
db_node_class
change class, define upgrade or downgrade. Valid values areUpgrade
,Downgrade
, Default toUpgrade
.- Parameters
[]Cluster
Parameter Args 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 string Valid values are
PrePaid
,PostPaid
, Default toPostPaid
.- Period int
- Port string
(Available in 1.196.0+) PolarDB cluster connection port.
- Renewal
Status string Valid values are
AutoRenewal
,Normal
,NotRenewal
, Default toNotRenewal
.- Resource
Group stringId The ID of resource group which the PolarDB cluster belongs. If not specified, then it belongs to the default resource group.
- Role
Arn 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.
- Security
Group []stringIds 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 []string This attribute has been deprecated from v1.130.0 and using
db_cluster_ip_array
sub-elementsecurity_ips
instead. Its value is same asdb_cluster_ip_array
sub-elementsecurity_ips
value and its db_cluster_ip_array_name is "default".- Source
Resource stringId 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 string The category of the cluster. Valid values are
Exclusive
,General
. Only MySQL supports.- 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.
- Tde
Region 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.
- Tde
Status string turn on TDE encryption. Valid values are
Enabled
,Disabled
. Default toDisabled
. TDE cannot be closed after it is turned on.NOTE:
tde_status
Cannot modify after created whendb_type
isPostgreSQL
orOracle
.tde_status
only support modification fromDisabled
toEnabled
whendb_type
isMySQL
.- Vpc
Id string The id of the VPC.
- Vswitch
Id 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.
- Zone
Id string The Zone to launch the DB cluster. it supports multiple zone.
- auto
Renew IntegerPeriod 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 StringPolicy On Cluster Deletion 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 StringPoint The time point of data to be cloned. Valid values are
LATEST
,BackupID
,Timestamp
.Value options can refer to the latest docs CreateDBClusterCloneDataPoint
.NOTE: If CreationOption is set to CloneFromRDS, the value of this parameter must be LATEST.
- collector
Status String Specifies whether to enable or disable SQL data collector. Valid values are
Enable
,Disabled
.- connection
String String (Available in 1.81.0+) PolarDB cluster connection string.
- creation
Category String The edition of the PolarDB service. Valid values are
Normal
,Basic
,ArchiveNormal
,NormalMultimaster
.Value options can refer to the latest docs CreateDBClusterCreationCategory
.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 toNormalMultimaster
.- creation
Option 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 CreateDBClusterCreationOption
.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 List<ClusterIp Arrays Db Cluster Ip Array Args> db_cluster_ip_array defines how users can send requests to your API.
- db
Node StringClass 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 IntegerCount 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 String Database type. Value options: MySQL, Oracle, PostgreSQL.
- db
Version String Database version. Value options can refer to the latest docs CreateDBCluster
DBVersion
.- deletion
Lock 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
isPrepaid
.deletion_lock
the cluster protection lock can be turned on or off whenpay_type
isPostpaid
.- description String
The description of cluster.
- encrypt
New StringTables 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 String The ID of the custom key.
encryption_key
cannot be modified after TDE is opened.- gdn
Id String The ID of the global database network (GDN).
NOTE: This parameter is required if CreationOption is set to CreateGdnStandby.
- imci
Switch 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.
- maintain
Time String Maintainable time period format of the instance: HH:MMZ-HH:MMZ (UTC time)
- modify
Type String Use as
db_node_class
change class, define upgrade or downgrade. Valid values areUpgrade
,Downgrade
, Default toUpgrade
.- parameters
List<Cluster
Parameter Args> 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 String Valid values are
PrePaid
,PostPaid
, Default toPostPaid
.- period Integer
- port String
(Available in 1.196.0+) PolarDB cluster connection port.
- renewal
Status String Valid values are
AutoRenewal
,Normal
,NotRenewal
, Default toNotRenewal
.- resource
Group StringId The ID of resource group which the PolarDB cluster belongs. If not specified, then it belongs to the default resource group.
- role
Arn 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.
- security
Group List<String>Ids 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 List<String> This attribute has been deprecated from v1.130.0 and using
db_cluster_ip_array
sub-elementsecurity_ips
instead. Its value is same asdb_cluster_ip_array
sub-elementsecurity_ips
value and its db_cluster_ip_array_name is "default".- source
Resource StringId 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 String The category of the cluster. Valid values are
Exclusive
,General
. Only MySQL supports.- 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.
- tde
Region 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.
- tde
Status String turn on TDE encryption. Valid values are
Enabled
,Disabled
. Default toDisabled
. TDE cannot be closed after it is turned on.NOTE:
tde_status
Cannot modify after created whendb_type
isPostgreSQL
orOracle
.tde_status
only support modification fromDisabled
toEnabled
whendb_type
isMySQL
.- vpc
Id String The id of the VPC.
- vswitch
Id 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.
- zone
Id String The Zone to launch the DB cluster. it supports multiple zone.
- auto
Renew numberPeriod 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 stringPolicy On Cluster Deletion 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 stringPoint The time point of data to be cloned. Valid values are
LATEST
,BackupID
,Timestamp
.Value options can refer to the latest docs CreateDBClusterCloneDataPoint
.NOTE: If CreationOption is set to CloneFromRDS, the value of this parameter must be LATEST.
- collector
Status string Specifies whether to enable or disable SQL data collector. Valid values are
Enable
,Disabled
.- connection
String string (Available in 1.81.0+) PolarDB cluster connection string.
- creation
Category string The edition of the PolarDB service. Valid values are
Normal
,Basic
,ArchiveNormal
,NormalMultimaster
.Value options can refer to the latest docs CreateDBClusterCreationCategory
.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 toNormalMultimaster
.- creation
Option 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 CreateDBClusterCreationOption
.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 ClusterIp Arrays Db Cluster Ip Array Args[] db_cluster_ip_array defines how users can send requests to your API.
- db
Node stringClass 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 numberCount 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 string Database type. Value options: MySQL, Oracle, PostgreSQL.
- db
Version string Database version. Value options can refer to the latest docs CreateDBCluster
DBVersion
.- deletion
Lock 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
isPrepaid
.deletion_lock
the cluster protection lock can be turned on or off whenpay_type
isPostpaid
.- description string
The description of cluster.
- encrypt
New stringTables 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 string The ID of the custom key.
encryption_key
cannot be modified after TDE is opened.- gdn
Id string The ID of the global database network (GDN).
NOTE: This parameter is required if CreationOption is set to CreateGdnStandby.
- imci
Switch 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.
- maintain
Time string Maintainable time period format of the instance: HH:MMZ-HH:MMZ (UTC time)
- modify
Type string Use as
db_node_class
change class, define upgrade or downgrade. Valid values areUpgrade
,Downgrade
, Default toUpgrade
.- parameters
Cluster
Parameter Args[] 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 string Valid values are
PrePaid
,PostPaid
, Default toPostPaid
.- period number
- port string
(Available in 1.196.0+) PolarDB cluster connection port.
- renewal
Status string Valid values are
AutoRenewal
,Normal
,NotRenewal
, Default toNotRenewal
.- resource
Group stringId The ID of resource group which the PolarDB cluster belongs. If not specified, then it belongs to the default resource group.
- role
Arn 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.
- security
Group string[]Ids 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 string[] This attribute has been deprecated from v1.130.0 and using
db_cluster_ip_array
sub-elementsecurity_ips
instead. Its value is same asdb_cluster_ip_array
sub-elementsecurity_ips
value and its db_cluster_ip_array_name is "default".- source
Resource stringId 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 string The category of the cluster. Valid values are
Exclusive
,General
. Only MySQL supports.- {[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.
- tde
Region 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.
- tde
Status string turn on TDE encryption. Valid values are
Enabled
,Disabled
. Default toDisabled
. TDE cannot be closed after it is turned on.NOTE:
tde_status
Cannot modify after created whendb_type
isPostgreSQL
orOracle
.tde_status
only support modification fromDisabled
toEnabled
whendb_type
isMySQL
.- vpc
Id string The id of the VPC.
- vswitch
Id 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.
- zone
Id string The Zone to launch the DB cluster. it supports multiple zone.
- auto_
renew_ intperiod 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_ strpolicy_ on_ cluster_ deletion 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_ strpoint The time point of data to be cloned. Valid values are
LATEST
,BackupID
,Timestamp
.Value options can refer to the latest docs CreateDBClusterCloneDataPoint
.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 CreateDBClusterCreationCategory
.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 toNormalMultimaster
.- 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 CreateDBClusterCreationOption
.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_ Sequence[Clusterip_ arrays Db Cluster Ip Array Args] db_cluster_ip_array defines how users can send requests to your API.
- db_
node_ strclass 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_ intcount 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
isPrepaid
.deletion_lock
the cluster protection lock can be turned on or off whenpay_type
isPostpaid
.- description str
The description of cluster.
- encrypt_
new_ strtables 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 areUpgrade
,Downgrade
, Default toUpgrade
.- parameters
Sequence[Cluster
Parameter Args] 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 toPostPaid
.- period int
- port str
(Available in 1.196.0+) PolarDB cluster connection port.
- renewal_
status str Valid values are
AutoRenewal
,Normal
,NotRenewal
, Default toNotRenewal
.- resource_
group_ strid 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_ Sequence[str]ids 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-elementsecurity_ips
instead. Its value is same asdb_cluster_ip_array
sub-elementsecurity_ips
value and its db_cluster_ip_array_name is "default".- source_
resource_ strid 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.- 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 toDisabled
. TDE cannot be closed after it is turned on.NOTE:
tde_status
Cannot modify after created whendb_type
isPostgreSQL
orOracle
.tde_status
only support modification fromDisabled
toEnabled
whendb_type
isMySQL
.- 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.
- auto
Renew NumberPeriod 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 StringPolicy On Cluster Deletion 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 StringPoint The time point of data to be cloned. Valid values are
LATEST
,BackupID
,Timestamp
.Value options can refer to the latest docs CreateDBClusterCloneDataPoint
.NOTE: If CreationOption is set to CloneFromRDS, the value of this parameter must be LATEST.
- collector
Status String Specifies whether to enable or disable SQL data collector. Valid values are
Enable
,Disabled
.- connection
String String (Available in 1.81.0+) PolarDB cluster connection string.
- creation
Category String The edition of the PolarDB service. Valid values are
Normal
,Basic
,ArchiveNormal
,NormalMultimaster
.Value options can refer to the latest docs CreateDBClusterCreationCategory
.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 toNormalMultimaster
.- creation
Option 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 CreateDBClusterCreationOption
.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 List<Property Map>Ip Arrays db_cluster_ip_array defines how users can send requests to your API.
- db
Node StringClass 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 NumberCount 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 String Database type. Value options: MySQL, Oracle, PostgreSQL.
- db
Version String Database version. Value options can refer to the latest docs CreateDBCluster
DBVersion
.- deletion
Lock 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
isPrepaid
.deletion_lock
the cluster protection lock can be turned on or off whenpay_type
isPostpaid
.- description String
The description of cluster.
- encrypt
New StringTables 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 String The ID of the custom key.
encryption_key
cannot be modified after TDE is opened.- gdn
Id String The ID of the global database network (GDN).
NOTE: This parameter is required if CreationOption is set to CreateGdnStandby.
- imci
Switch 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.
- maintain
Time String Maintainable time period format of the instance: HH:MMZ-HH:MMZ (UTC time)
- modify
Type String Use as
db_node_class
change class, define upgrade or downgrade. Valid values areUpgrade
,Downgrade
, Default toUpgrade
.- 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 .
- pay
Type String Valid values are
PrePaid
,PostPaid
, Default toPostPaid
.- period Number
- port String
(Available in 1.196.0+) PolarDB cluster connection port.
- renewal
Status String Valid values are
AutoRenewal
,Normal
,NotRenewal
, Default toNotRenewal
.- resource
Group StringId The ID of resource group which the PolarDB cluster belongs. If not specified, then it belongs to the default resource group.
- role
Arn 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.
- security
Group List<String>Ids 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 List<String> This attribute has been deprecated from v1.130.0 and using
db_cluster_ip_array
sub-elementsecurity_ips
instead. Its value is same asdb_cluster_ip_array
sub-elementsecurity_ips
value and its db_cluster_ip_array_name is "default".- source
Resource StringId 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 String The category of the cluster. Valid values are
Exclusive
,General
. Only MySQL supports.- 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.
- tde
Region 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.
- tde
Status String turn on TDE encryption. Valid values are
Enabled
,Disabled
. Default toDisabled
. TDE cannot be closed after it is turned on.NOTE:
tde_status
Cannot modify after created whendb_type
isPostgreSQL
orOracle
.tde_status
only support modification fromDisabled
toEnabled
whendb_type
isMySQL
.- vpc
Id String The id of the VPC.
- vswitch
Id 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.
- zone
Id String The Zone to launch the DB cluster. it supports multiple zone.
Supporting Types
ClusterDbClusterIpArray
- Db
Cluster stringIp Array Name 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 string The method for modifying the IP whitelist. Valid values are
Cover
,Append
,Delete
. NOTE: There does not recommend setting modify_mode toAppend
orDelete
and it will bring a potential diff error.- Security
Ips List<string> This attribute has been deprecated from v1.130.0 and using
db_cluster_ip_array
sub-elementsecurity_ips
instead. Its value is same asdb_cluster_ip_array
sub-elementsecurity_ips
value and its db_cluster_ip_array_name is "default".
- Db
Cluster stringIp Array Name 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 string The method for modifying the IP whitelist. Valid values are
Cover
,Append
,Delete
. NOTE: There does not recommend setting modify_mode toAppend
orDelete
and it will bring a potential diff error.- Security
Ips []string This attribute has been deprecated from v1.130.0 and using
db_cluster_ip_array
sub-elementsecurity_ips
instead. Its value is same asdb_cluster_ip_array
sub-elementsecurity_ips
value and its db_cluster_ip_array_name is "default".
- db
Cluster StringIp Array Name 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 String The method for modifying the IP whitelist. Valid values are
Cover
,Append
,Delete
. NOTE: There does not recommend setting modify_mode toAppend
orDelete
and it will bring a potential diff error.- security
Ips List<String> This attribute has been deprecated from v1.130.0 and using
db_cluster_ip_array
sub-elementsecurity_ips
instead. Its value is same asdb_cluster_ip_array
sub-elementsecurity_ips
value and its db_cluster_ip_array_name is "default".
- db
Cluster stringIp Array Name 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 string The method for modifying the IP whitelist. Valid values are
Cover
,Append
,Delete
. NOTE: There does not recommend setting modify_mode toAppend
orDelete
and it will bring a potential diff error.- security
Ips string[] This attribute has been deprecated from v1.130.0 and using
db_cluster_ip_array
sub-elementsecurity_ips
instead. Its value is same asdb_cluster_ip_array
sub-elementsecurity_ips
value and its db_cluster_ip_array_name is "default".
- db_
cluster_ strip_ array_ name 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 toAppend
orDelete
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-elementsecurity_ips
instead. Its value is same asdb_cluster_ip_array
sub-elementsecurity_ips
value and its db_cluster_ip_array_name is "default".
- db
Cluster StringIp Array Name 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 String The method for modifying the IP whitelist. Valid values are
Cover
,Append
,Delete
. NOTE: There does not recommend setting modify_mode toAppend
orDelete
and it will bring a potential diff error.- security
Ips List<String> This attribute has been deprecated from v1.130.0 and using
db_cluster_ip_array
sub-elementsecurity_ips
instead. Its value is same asdb_cluster_ip_array
sub-elementsecurity_ips
value and its db_cluster_ip_array_name is "default".
ClusterParameter
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.