alicloud.polardb.Cluster
Explore with Pulumi AI
Import
PolarDB cluster can be imported using the id, e.g.
$ pulumi import alicloud:polardb/cluster:Cluster example pc-abc12345678
Create Cluster Resource
new Cluster(name: string, args: ClusterArgs, opts?: CustomResourceOptions);
@overload
def Cluster(resource_name: str,
opts: Optional[ResourceOptions] = None,
allow_shut_down: Optional[str] = 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_node_num: Optional[int] = None,
db_type: Optional[str] = None,
db_version: Optional[str] = None,
default_time_zone: Optional[str] = None,
deletion_lock: Optional[int] = None,
description: Optional[str] = None,
encrypt_new_tables: Optional[str] = None,
encryption_key: Optional[str] = None,
from_time_service: Optional[str] = None,
gdn_id: Optional[str] = None,
hot_standby_cluster: Optional[str] = None,
imci_switch: Optional[str] = None,
loose_polar_log_bin: Optional[str] = None,
lower_case_table_names: Optional[int] = None,
maintain_time: Optional[str] = None,
modify_type: Optional[str] = None,
parameter_group_id: Optional[str] = None,
parameters: Optional[Sequence[ClusterParameterArgs]] = None,
pay_type: Optional[str] = None,
period: Optional[int] = None,
planned_end_time: Optional[str] = None,
planned_start_time: Optional[str] = None,
proxy_class: Optional[str] = None,
proxy_type: Optional[str] = None,
renewal_status: Optional[str] = None,
resource_group_id: Optional[str] = None,
role_arn: Optional[str] = None,
scale_max: Optional[int] = None,
scale_min: Optional[int] = None,
scale_ro_num_max: Optional[int] = None,
scale_ro_num_min: Optional[int] = None,
seconds_until_auto_pause: Optional[int] = None,
security_group_ids: Optional[Sequence[str]] = None,
security_ips: Optional[Sequence[str]] = None,
serverless_type: Optional[str] = None,
source_resource_id: Optional[str] = None,
storage_pay_type: Optional[str] = None,
storage_space: Optional[int] = None,
storage_type: Optional[str] = None,
sub_category: Optional[str] = None,
tags: Optional[Mapping[str, Any]] = None,
tde_status: Optional[str] = None,
upgrade_type: 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. From version 1.204.0, If you need to create a Serverless cluster,
db_node_class
can be set topolar.mysql.sl.small
.- 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
.- Allow
Shut stringDown Specifies whether to enable the no-activity suspension feature. Default value: false. Valid values are
true
,false
.NOTE: This parameter is valid only for serverless clusters.
- 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
,SENormal
.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
. From version 1.203.0,creation_category
can be set toSENormal
.- 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> db_cluster_ip_array defines how users can send requests to your API. See
db_cluster_ip_array
below.- 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
Node intNum The number of Standard Edition nodes. Default value: 1. Valid values are
1
,2
.- Default
Time stringZone The time zone of the cluster. You can set the parameter to a value that is on the hour from -12:00 to +13:00 based on UTC. Example: 00:00. Default value: SYSTEM. This value indicates that the time zone of the cluster is the same as the time zone of the region.
NOTE: This parameter is valid only when the DBType parameter is set to MySQL.
- 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.- From
Time stringService Immediate or scheduled kernel version upgrade. Valid values are
true
,false
. True means immediate execution, False means scheduled execution.- Gdn
Id string The ID of the global database network (GDN).
NOTE: This parameter is required if CreationOption is set to CreateGdnStandby.
- Hot
Standby stringCluster Whether to enable the hot standby cluster. Valid values are
ON
,OFF
. Only MySQL supports.- 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.
- Loose
Polar stringLog Bin Enable the Binlog function. Valid values are
OFF
,ON
.NOTE: This parameter is valid only MySQL Engine supports.
- Lower
Case intTable Names Specifies whether the table names are case-sensitive. Default value: 1. Valid values are
1
,0
.NOTE: This parameter is valid only when the DBType parameter is set to MySQL.
- 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
.- Parameter
Group stringId The ID of the parameter template
NOTE: You can call the DescribeParameterGroups operation to query the details of all parameter templates of a specified region, such as the ID of a parameter template.
- Parameters
List<Pulumi.
Ali Cloud. Polar DB. Inputs. Cluster Parameter> Set of parameters needs to be set after DB cluster was launched. Available parameters can refer to the latest docs View database parameter templates .See
parameters
below.- Pay
Type string Valid values are
PrePaid
,PostPaid
, Default toPostPaid
.- Period int
The duration that you will buy DB cluster (in month). It is valid when pay_type is
PrePaid
. Valid values: [1~9], 12, 24, 36.NOTE: The attribute
period
is only used to create Subscription instance or modify the PayAsYouGo instance to Subscription. Once effect, it will not be modified that means runningpulumi up
will not effect the resource.- Planned
End stringTime The latest time to start executing the target scheduled task. The format is YYYY-MM-DDThh: mm: ssZ (UTC).
NOTE: The latest time must be 30 minutes or more later than the start time. If PlannedStartTime is set but this parameter is not specified, the latest time to execute the target task defaults to the start time+30 minutes. For example, when the PlannedStartTime is set to 2021-01-14T09:00:00Z and this parameter is left blank, the target task will start executing at the latest on 2021-01-14T09:30:00Z.
- Planned
Start stringTime The earliest time to start executing a scheduled (i.e. within the target time period) kernel version upgrade task. The format is YYYY-MM-DDThh: mm: ssZ (UTC).
NOTE: The starting time range is any time point within the next 24 hours. For example, the current time is 2021-01-14T09:00:00Z, and the allowed start time range for filling in here is 2021-01-14T09:00:00Z~2021-01-15T09:00:00Z. If this parameter is left blank, the kernel version upgrade task will be executed immediately by default.
- Proxy
Class string The specifications of the Standard Edition PolarProxy. Available parameters can refer to the latest docs CreateDBCluster
ProxyType
NOTE: This parameter is valid only for standard clusters.
- Proxy
Type string The type of PolarProxy. Default value: OFF. Valid values are
OFF
,EXCLUSIVE
GENERAL
.NOTE: This parameter is valid only for standard clusters.
- 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.
- Scale
Max int The maximum number of PCUs per node for scaling. Valid values: 1 PCU to 32 PCUs.
NOTE: This parameter is valid only for serverless clusters.
- Scale
Min int The minimum number of PCUs per node for scaling. Valid values: 1 PCU to 31 PCUs.
NOTE: This parameter is valid only for serverless clusters.
- Scale
Ro intNum Max The maximum number of read-only nodes for scaling. Valid values: 0 to 15.
NOTE: This parameter is valid only for serverless clusters.
- Scale
Ro intNum Min The minimum number of read-only nodes for scaling. Valid values: 0 to 15.
NOTE: This parameter is valid only for serverless clusters.
- Seconds
Until intAuto Pause The detection period for No-activity Suspension. Valid values: 300 to 86,4005. Unit: seconds. The detection duration must be a multiple of 300 seconds.
NOTE: This parameter is valid only for serverless clusters.
- 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".- Serverless
Type string The type of the serverless cluster. Set the value to AgileServerless.
NOTE: This parameter is valid only for serverless clusters.
- 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
.- Storage
Pay stringType The billing method of the storage. Valid values
Postpaid
,Prepaid
.- Storage
Space int Storage space charged by space (monthly package). Unit: GB.
NOTE: Valid values for PolarDB for MySQL Standard Edition: 20 to 32000. It is valid when pay_type are
PrePaid
,PostPaid
. NOTE: Valid values for PolarDB for MySQL Enterprise Edition: 50 to 100000.It is valid when pay_type isPrePaid
.- Storage
Type string The storage type of the cluster. Enterprise storage type values are
PSL5
,PSL4
. The standard version storage type values areESSDPL1
,ESSDPL2
,ESSDPL3
. The standard version only supports MySQL.NOTE: Serverless cluster does not support this parameter.
- 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
.- Upgrade
Type string Version upgrade type. Valid values are PROXY, DB, ALL. PROXY means upgrading the proxy version, DB means upgrading the db version, ALL means upgrading both db and proxy versions simultaneously.
- 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. From version 1.204.0, If you need to create a Serverless cluster,
db_node_class
can be set topolar.mysql.sl.small
.- 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
.- Allow
Shut stringDown Specifies whether to enable the no-activity suspension feature. Default value: false. Valid values are
true
,false
.NOTE: This parameter is valid only for serverless clusters.
- 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
,SENormal
.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
. From version 1.203.0,creation_category
can be set toSENormal
.- 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. See
db_cluster_ip_array
below.- 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
Node intNum The number of Standard Edition nodes. Default value: 1. Valid values are
1
,2
.- Default
Time stringZone The time zone of the cluster. You can set the parameter to a value that is on the hour from -12:00 to +13:00 based on UTC. Example: 00:00. Default value: SYSTEM. This value indicates that the time zone of the cluster is the same as the time zone of the region.
NOTE: This parameter is valid only when the DBType parameter is set to MySQL.
- 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.- From
Time stringService Immediate or scheduled kernel version upgrade. Valid values are
true
,false
. True means immediate execution, False means scheduled execution.- Gdn
Id string The ID of the global database network (GDN).
NOTE: This parameter is required if CreationOption is set to CreateGdnStandby.
- Hot
Standby stringCluster Whether to enable the hot standby cluster. Valid values are
ON
,OFF
. Only MySQL supports.- 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.
- Loose
Polar stringLog Bin Enable the Binlog function. Valid values are
OFF
,ON
.NOTE: This parameter is valid only MySQL Engine supports.
- Lower
Case intTable Names Specifies whether the table names are case-sensitive. Default value: 1. Valid values are
1
,0
.NOTE: This parameter is valid only when the DBType parameter is set to MySQL.
- 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
.- Parameter
Group stringId The ID of the parameter template
NOTE: You can call the DescribeParameterGroups operation to query the details of all parameter templates of a specified region, such as the ID of a parameter template.
- 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 .See
parameters
below.- Pay
Type string Valid values are
PrePaid
,PostPaid
, Default toPostPaid
.- Period int
The duration that you will buy DB cluster (in month). It is valid when pay_type is
PrePaid
. Valid values: [1~9], 12, 24, 36.NOTE: The attribute
period
is only used to create Subscription instance or modify the PayAsYouGo instance to Subscription. Once effect, it will not be modified that means runningpulumi up
will not effect the resource.- Planned
End stringTime The latest time to start executing the target scheduled task. The format is YYYY-MM-DDThh: mm: ssZ (UTC).
NOTE: The latest time must be 30 minutes or more later than the start time. If PlannedStartTime is set but this parameter is not specified, the latest time to execute the target task defaults to the start time+30 minutes. For example, when the PlannedStartTime is set to 2021-01-14T09:00:00Z and this parameter is left blank, the target task will start executing at the latest on 2021-01-14T09:30:00Z.
- Planned
Start stringTime The earliest time to start executing a scheduled (i.e. within the target time period) kernel version upgrade task. The format is YYYY-MM-DDThh: mm: ssZ (UTC).
NOTE: The starting time range is any time point within the next 24 hours. For example, the current time is 2021-01-14T09:00:00Z, and the allowed start time range for filling in here is 2021-01-14T09:00:00Z~2021-01-15T09:00:00Z. If this parameter is left blank, the kernel version upgrade task will be executed immediately by default.
- Proxy
Class string The specifications of the Standard Edition PolarProxy. Available parameters can refer to the latest docs CreateDBCluster
ProxyType
NOTE: This parameter is valid only for standard clusters.
- Proxy
Type string The type of PolarProxy. Default value: OFF. Valid values are
OFF
,EXCLUSIVE
GENERAL
.NOTE: This parameter is valid only for standard clusters.
- 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.
- Scale
Max int The maximum number of PCUs per node for scaling. Valid values: 1 PCU to 32 PCUs.
NOTE: This parameter is valid only for serverless clusters.
- Scale
Min int The minimum number of PCUs per node for scaling. Valid values: 1 PCU to 31 PCUs.
NOTE: This parameter is valid only for serverless clusters.
- Scale
Ro intNum Max The maximum number of read-only nodes for scaling. Valid values: 0 to 15.
NOTE: This parameter is valid only for serverless clusters.
- Scale
Ro intNum Min The minimum number of read-only nodes for scaling. Valid values: 0 to 15.
NOTE: This parameter is valid only for serverless clusters.
- Seconds
Until intAuto Pause The detection period for No-activity Suspension. Valid values: 300 to 86,4005. Unit: seconds. The detection duration must be a multiple of 300 seconds.
NOTE: This parameter is valid only for serverless clusters.
- 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".- Serverless
Type string The type of the serverless cluster. Set the value to AgileServerless.
NOTE: This parameter is valid only for serverless clusters.
- 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
.- Storage
Pay stringType The billing method of the storage. Valid values
Postpaid
,Prepaid
.- Storage
Space int Storage space charged by space (monthly package). Unit: GB.
NOTE: Valid values for PolarDB for MySQL Standard Edition: 20 to 32000. It is valid when pay_type are
PrePaid
,PostPaid
. NOTE: Valid values for PolarDB for MySQL Enterprise Edition: 50 to 100000.It is valid when pay_type isPrePaid
.- Storage
Type string The storage type of the cluster. Enterprise storage type values are
PSL5
,PSL4
. The standard version storage type values areESSDPL1
,ESSDPL2
,ESSDPL3
. The standard version only supports MySQL.NOTE: Serverless cluster does not support this parameter.
- 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
.- Upgrade
Type string Version upgrade type. Valid values are PROXY, DB, ALL. PROXY means upgrading the proxy version, DB means upgrading the db version, ALL means upgrading both db and proxy versions simultaneously.
- 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. From version 1.204.0, If you need to create a Serverless cluster,
db_node_class
can be set topolar.mysql.sl.small
.- 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
.- allow
Shut StringDown Specifies whether to enable the no-activity suspension feature. Default value: false. Valid values are
true
,false
.NOTE: This parameter is valid only for serverless clusters.
- 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
,SENormal
.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
. From version 1.203.0,creation_category
can be set toSENormal
.- 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> db_cluster_ip_array defines how users can send requests to your API. See
db_cluster_ip_array
below.- 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
Node IntegerNum The number of Standard Edition nodes. Default value: 1. Valid values are
1
,2
.- default
Time StringZone The time zone of the cluster. You can set the parameter to a value that is on the hour from -12:00 to +13:00 based on UTC. Example: 00:00. Default value: SYSTEM. This value indicates that the time zone of the cluster is the same as the time zone of the region.
NOTE: This parameter is valid only when the DBType parameter is set to MySQL.
- 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.- from
Time StringService Immediate or scheduled kernel version upgrade. Valid values are
true
,false
. True means immediate execution, False means scheduled execution.- gdn
Id String The ID of the global database network (GDN).
NOTE: This parameter is required if CreationOption is set to CreateGdnStandby.
- hot
Standby StringCluster Whether to enable the hot standby cluster. Valid values are
ON
,OFF
. Only MySQL supports.- 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.
- loose
Polar StringLog Bin Enable the Binlog function. Valid values are
OFF
,ON
.NOTE: This parameter is valid only MySQL Engine supports.
- lower
Case IntegerTable Names Specifies whether the table names are case-sensitive. Default value: 1. Valid values are
1
,0
.NOTE: This parameter is valid only when the DBType parameter is set to MySQL.
- 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
.- parameter
Group StringId The ID of the parameter template
NOTE: You can call the DescribeParameterGroups operation to query the details of all parameter templates of a specified region, such as the ID of a parameter template.
- parameters
List<Cluster
Parameter> Set of parameters needs to be set after DB cluster was launched. Available parameters can refer to the latest docs View database parameter templates .See
parameters
below.- pay
Type String Valid values are
PrePaid
,PostPaid
, Default toPostPaid
.- period Integer
The duration that you will buy DB cluster (in month). It is valid when pay_type is
PrePaid
. Valid values: [1~9], 12, 24, 36.NOTE: The attribute
period
is only used to create Subscription instance or modify the PayAsYouGo instance to Subscription. Once effect, it will not be modified that means runningpulumi up
will not effect the resource.- planned
End StringTime The latest time to start executing the target scheduled task. The format is YYYY-MM-DDThh: mm: ssZ (UTC).
NOTE: The latest time must be 30 minutes or more later than the start time. If PlannedStartTime is set but this parameter is not specified, the latest time to execute the target task defaults to the start time+30 minutes. For example, when the PlannedStartTime is set to 2021-01-14T09:00:00Z and this parameter is left blank, the target task will start executing at the latest on 2021-01-14T09:30:00Z.
- planned
Start StringTime The earliest time to start executing a scheduled (i.e. within the target time period) kernel version upgrade task. The format is YYYY-MM-DDThh: mm: ssZ (UTC).
NOTE: The starting time range is any time point within the next 24 hours. For example, the current time is 2021-01-14T09:00:00Z, and the allowed start time range for filling in here is 2021-01-14T09:00:00Z~2021-01-15T09:00:00Z. If this parameter is left blank, the kernel version upgrade task will be executed immediately by default.
- proxy
Class String The specifications of the Standard Edition PolarProxy. Available parameters can refer to the latest docs CreateDBCluster
ProxyType
NOTE: This parameter is valid only for standard clusters.
- proxy
Type String The type of PolarProxy. Default value: OFF. Valid values are
OFF
,EXCLUSIVE
GENERAL
.NOTE: This parameter is valid only for standard clusters.
- 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.
- scale
Max Integer The maximum number of PCUs per node for scaling. Valid values: 1 PCU to 32 PCUs.
NOTE: This parameter is valid only for serverless clusters.
- scale
Min Integer The minimum number of PCUs per node for scaling. Valid values: 1 PCU to 31 PCUs.
NOTE: This parameter is valid only for serverless clusters.
- scale
Ro IntegerNum Max The maximum number of read-only nodes for scaling. Valid values: 0 to 15.
NOTE: This parameter is valid only for serverless clusters.
- scale
Ro IntegerNum Min The minimum number of read-only nodes for scaling. Valid values: 0 to 15.
NOTE: This parameter is valid only for serverless clusters.
- seconds
Until IntegerAuto Pause The detection period for No-activity Suspension. Valid values: 300 to 86,4005. Unit: seconds. The detection duration must be a multiple of 300 seconds.
NOTE: This parameter is valid only for serverless clusters.
- 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".- serverless
Type String The type of the serverless cluster. Set the value to AgileServerless.
NOTE: This parameter is valid only for serverless clusters.
- 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
.- storage
Pay StringType The billing method of the storage. Valid values
Postpaid
,Prepaid
.- storage
Space Integer Storage space charged by space (monthly package). Unit: GB.
NOTE: Valid values for PolarDB for MySQL Standard Edition: 20 to 32000. It is valid when pay_type are
PrePaid
,PostPaid
. NOTE: Valid values for PolarDB for MySQL Enterprise Edition: 50 to 100000.It is valid when pay_type isPrePaid
.- storage
Type String The storage type of the cluster. Enterprise storage type values are
PSL5
,PSL4
. The standard version storage type values areESSDPL1
,ESSDPL2
,ESSDPL3
. The standard version only supports MySQL.NOTE: Serverless cluster does not support this parameter.
- 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
.- upgrade
Type String Version upgrade type. Valid values are PROXY, DB, ALL. PROXY means upgrading the proxy version, DB means upgrading the db version, ALL means upgrading both db and proxy versions simultaneously.
- 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. From version 1.204.0, If you need to create a Serverless cluster,
db_node_class
can be set topolar.mysql.sl.small
.- 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
.- allow
Shut stringDown Specifies whether to enable the no-activity suspension feature. Default value: false. Valid values are
true
,false
.NOTE: This parameter is valid only for serverless clusters.
- 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
,SENormal
.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
. From version 1.203.0,creation_category
can be set toSENormal
.- 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[] db_cluster_ip_array defines how users can send requests to your API. See
db_cluster_ip_array
below.- 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
Node numberNum The number of Standard Edition nodes. Default value: 1. Valid values are
1
,2
.- default
Time stringZone The time zone of the cluster. You can set the parameter to a value that is on the hour from -12:00 to +13:00 based on UTC. Example: 00:00. Default value: SYSTEM. This value indicates that the time zone of the cluster is the same as the time zone of the region.
NOTE: This parameter is valid only when the DBType parameter is set to MySQL.
- 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.- from
Time stringService Immediate or scheduled kernel version upgrade. Valid values are
true
,false
. True means immediate execution, False means scheduled execution.- gdn
Id string The ID of the global database network (GDN).
NOTE: This parameter is required if CreationOption is set to CreateGdnStandby.
- hot
Standby stringCluster Whether to enable the hot standby cluster. Valid values are
ON
,OFF
. Only MySQL supports.- 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.
- loose
Polar stringLog Bin Enable the Binlog function. Valid values are
OFF
,ON
.NOTE: This parameter is valid only MySQL Engine supports.
- lower
Case numberTable Names Specifies whether the table names are case-sensitive. Default value: 1. Valid values are
1
,0
.NOTE: This parameter is valid only when the DBType parameter is set to MySQL.
- 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
.- parameter
Group stringId The ID of the parameter template
NOTE: You can call the DescribeParameterGroups operation to query the details of all parameter templates of a specified region, such as the ID of a parameter template.
- parameters
Cluster
Parameter[] Set of parameters needs to be set after DB cluster was launched. Available parameters can refer to the latest docs View database parameter templates .See
parameters
below.- pay
Type string Valid values are
PrePaid
,PostPaid
, Default toPostPaid
.- period number
The duration that you will buy DB cluster (in month). It is valid when pay_type is
PrePaid
. Valid values: [1~9], 12, 24, 36.NOTE: The attribute
period
is only used to create Subscription instance or modify the PayAsYouGo instance to Subscription. Once effect, it will not be modified that means runningpulumi up
will not effect the resource.- planned
End stringTime The latest time to start executing the target scheduled task. The format is YYYY-MM-DDThh: mm: ssZ (UTC).
NOTE: The latest time must be 30 minutes or more later than the start time. If PlannedStartTime is set but this parameter is not specified, the latest time to execute the target task defaults to the start time+30 minutes. For example, when the PlannedStartTime is set to 2021-01-14T09:00:00Z and this parameter is left blank, the target task will start executing at the latest on 2021-01-14T09:30:00Z.
- planned
Start stringTime The earliest time to start executing a scheduled (i.e. within the target time period) kernel version upgrade task. The format is YYYY-MM-DDThh: mm: ssZ (UTC).
NOTE: The starting time range is any time point within the next 24 hours. For example, the current time is 2021-01-14T09:00:00Z, and the allowed start time range for filling in here is 2021-01-14T09:00:00Z~2021-01-15T09:00:00Z. If this parameter is left blank, the kernel version upgrade task will be executed immediately by default.
- proxy
Class string The specifications of the Standard Edition PolarProxy. Available parameters can refer to the latest docs CreateDBCluster
ProxyType
NOTE: This parameter is valid only for standard clusters.
- proxy
Type string The type of PolarProxy. Default value: OFF. Valid values are
OFF
,EXCLUSIVE
GENERAL
.NOTE: This parameter is valid only for standard clusters.
- 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.
- scale
Max number The maximum number of PCUs per node for scaling. Valid values: 1 PCU to 32 PCUs.
NOTE: This parameter is valid only for serverless clusters.
- scale
Min number The minimum number of PCUs per node for scaling. Valid values: 1 PCU to 31 PCUs.
NOTE: This parameter is valid only for serverless clusters.
- scale
Ro numberNum Max The maximum number of read-only nodes for scaling. Valid values: 0 to 15.
NOTE: This parameter is valid only for serverless clusters.
- scale
Ro numberNum Min The minimum number of read-only nodes for scaling. Valid values: 0 to 15.
NOTE: This parameter is valid only for serverless clusters.
- seconds
Until numberAuto Pause The detection period for No-activity Suspension. Valid values: 300 to 86,4005. Unit: seconds. The detection duration must be a multiple of 300 seconds.
NOTE: This parameter is valid only for serverless clusters.
- 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".- serverless
Type string The type of the serverless cluster. Set the value to AgileServerless.
NOTE: This parameter is valid only for serverless clusters.
- 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
.- storage
Pay stringType The billing method of the storage. Valid values
Postpaid
,Prepaid
.- storage
Space number Storage space charged by space (monthly package). Unit: GB.
NOTE: Valid values for PolarDB for MySQL Standard Edition: 20 to 32000. It is valid when pay_type are
PrePaid
,PostPaid
. NOTE: Valid values for PolarDB for MySQL Enterprise Edition: 50 to 100000.It is valid when pay_type isPrePaid
.- storage
Type string The storage type of the cluster. Enterprise storage type values are
PSL5
,PSL4
. The standard version storage type values areESSDPL1
,ESSDPL2
,ESSDPL3
. The standard version only supports MySQL.NOTE: Serverless cluster does not support this parameter.
- 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
.- upgrade
Type string Version upgrade type. Valid values are PROXY, DB, ALL. PROXY means upgrading the proxy version, DB means upgrading the db version, ALL means upgrading both db and proxy versions simultaneously.
- 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. From version 1.204.0, If you need to create a Serverless cluster,
db_node_class
can be set topolar.mysql.sl.small
.- 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
.- allow_
shut_ strdown Specifies whether to enable the no-activity suspension feature. Default value: false. Valid values are
true
,false
.NOTE: This parameter is valid only for serverless clusters.
- 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
,SENormal
.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
. From version 1.203.0,creation_category
can be set toSENormal
.- 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. See
db_cluster_ip_array
below.- 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_
node_ intnum The number of Standard Edition nodes. Default value: 1. Valid values are
1
,2
.- default_
time_ strzone The time zone of the cluster. You can set the parameter to a value that is on the hour from -12:00 to +13:00 based on UTC. Example: 00:00. Default value: SYSTEM. This value indicates that the time zone of the cluster is the same as the time zone of the region.
NOTE: This parameter is valid only when the DBType parameter is set to MySQL.
- 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.- from_
time_ strservice Immediate or scheduled kernel version upgrade. Valid values are
true
,false
. True means immediate execution, False means scheduled execution.- gdn_
id str The ID of the global database network (GDN).
NOTE: This parameter is required if CreationOption is set to CreateGdnStandby.
- hot_
standby_ strcluster Whether to enable the hot standby cluster. Valid values are
ON
,OFF
. Only MySQL supports.- 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.
- loose_
polar_ strlog_ bin Enable the Binlog function. Valid values are
OFF
,ON
.NOTE: This parameter is valid only MySQL Engine supports.
- lower_
case_ inttable_ names Specifies whether the table names are case-sensitive. Default value: 1. Valid values are
1
,0
.NOTE: This parameter is valid only when the DBType parameter is set to MySQL.
- 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
.- parameter_
group_ strid The ID of the parameter template
NOTE: You can call the DescribeParameterGroups operation to query the details of all parameter templates of a specified region, such as the ID of a parameter template.
- 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 .See
parameters
below.- pay_
type str Valid values are
PrePaid
,PostPaid
, Default toPostPaid
.- period int
The duration that you will buy DB cluster (in month). It is valid when pay_type is
PrePaid
. Valid values: [1~9], 12, 24, 36.NOTE: The attribute
period
is only used to create Subscription instance or modify the PayAsYouGo instance to Subscription. Once effect, it will not be modified that means runningpulumi up
will not effect the resource.- planned_
end_ strtime The latest time to start executing the target scheduled task. The format is YYYY-MM-DDThh: mm: ssZ (UTC).
NOTE: The latest time must be 30 minutes or more later than the start time. If PlannedStartTime is set but this parameter is not specified, the latest time to execute the target task defaults to the start time+30 minutes. For example, when the PlannedStartTime is set to 2021-01-14T09:00:00Z and this parameter is left blank, the target task will start executing at the latest on 2021-01-14T09:30:00Z.
- planned_
start_ strtime The earliest time to start executing a scheduled (i.e. within the target time period) kernel version upgrade task. The format is YYYY-MM-DDThh: mm: ssZ (UTC).
NOTE: The starting time range is any time point within the next 24 hours. For example, the current time is 2021-01-14T09:00:00Z, and the allowed start time range for filling in here is 2021-01-14T09:00:00Z~2021-01-15T09:00:00Z. If this parameter is left blank, the kernel version upgrade task will be executed immediately by default.
- proxy_
class str The specifications of the Standard Edition PolarProxy. Available parameters can refer to the latest docs CreateDBCluster
ProxyType
NOTE: This parameter is valid only for standard clusters.
- proxy_
type str The type of PolarProxy. Default value: OFF. Valid values are
OFF
,EXCLUSIVE
GENERAL
.NOTE: This parameter is valid only for standard clusters.
- 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.
- scale_
max int The maximum number of PCUs per node for scaling. Valid values: 1 PCU to 32 PCUs.
NOTE: This parameter is valid only for serverless clusters.
- scale_
min int The minimum number of PCUs per node for scaling. Valid values: 1 PCU to 31 PCUs.
NOTE: This parameter is valid only for serverless clusters.
- scale_
ro_ intnum_ max The maximum number of read-only nodes for scaling. Valid values: 0 to 15.
NOTE: This parameter is valid only for serverless clusters.
- scale_
ro_ intnum_ min The minimum number of read-only nodes for scaling. Valid values: 0 to 15.
NOTE: This parameter is valid only for serverless clusters.
- seconds_
until_ intauto_ pause The detection period for No-activity Suspension. Valid values: 300 to 86,4005. Unit: seconds. The detection duration must be a multiple of 300 seconds.
NOTE: This parameter is valid only for serverless clusters.
- 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".- serverless_
type str The type of the serverless cluster. Set the value to AgileServerless.
NOTE: This parameter is valid only for serverless clusters.
- 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
.- storage_
pay_ strtype The billing method of the storage. Valid values
Postpaid
,Prepaid
.- storage_
space int Storage space charged by space (monthly package). Unit: GB.
NOTE: Valid values for PolarDB for MySQL Standard Edition: 20 to 32000. It is valid when pay_type are
PrePaid
,PostPaid
. NOTE: Valid values for PolarDB for MySQL Enterprise Edition: 50 to 100000.It is valid when pay_type isPrePaid
.- storage_
type str The storage type of the cluster. Enterprise storage type values are
PSL5
,PSL4
. The standard version storage type values areESSDPL1
,ESSDPL2
,ESSDPL3
. The standard version only supports MySQL.NOTE: Serverless cluster does not support this parameter.
- 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
.- upgrade_
type str Version upgrade type. Valid values are PROXY, DB, ALL. PROXY means upgrading the proxy version, DB means upgrading the db version, ALL means upgrading both db and proxy versions simultaneously.
- 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. From version 1.204.0, If you need to create a Serverless cluster,
db_node_class
can be set topolar.mysql.sl.small
.- 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
.- allow
Shut StringDown Specifies whether to enable the no-activity suspension feature. Default value: false. Valid values are
true
,false
.NOTE: This parameter is valid only for serverless clusters.
- 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
,SENormal
.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
. From version 1.203.0,creation_category
can be set toSENormal
.- 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. See
db_cluster_ip_array
below.- 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
Node NumberNum The number of Standard Edition nodes. Default value: 1. Valid values are
1
,2
.- default
Time StringZone The time zone of the cluster. You can set the parameter to a value that is on the hour from -12:00 to +13:00 based on UTC. Example: 00:00. Default value: SYSTEM. This value indicates that the time zone of the cluster is the same as the time zone of the region.
NOTE: This parameter is valid only when the DBType parameter is set to MySQL.
- 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.- from
Time StringService Immediate or scheduled kernel version upgrade. Valid values are
true
,false
. True means immediate execution, False means scheduled execution.- gdn
Id String The ID of the global database network (GDN).
NOTE: This parameter is required if CreationOption is set to CreateGdnStandby.
- hot
Standby StringCluster Whether to enable the hot standby cluster. Valid values are
ON
,OFF
. Only MySQL supports.- 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.
- loose
Polar StringLog Bin Enable the Binlog function. Valid values are
OFF
,ON
.NOTE: This parameter is valid only MySQL Engine supports.
- lower
Case NumberTable Names Specifies whether the table names are case-sensitive. Default value: 1. Valid values are
1
,0
.NOTE: This parameter is valid only when the DBType parameter is set to MySQL.
- 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
.- parameter
Group StringId The ID of the parameter template
NOTE: You can call the DescribeParameterGroups operation to query the details of all parameter templates of a specified region, such as the ID of a parameter template.
- 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 .See
parameters
below.- pay
Type String Valid values are
PrePaid
,PostPaid
, Default toPostPaid
.- period Number
The duration that you will buy DB cluster (in month). It is valid when pay_type is
PrePaid
. Valid values: [1~9], 12, 24, 36.NOTE: The attribute
period
is only used to create Subscription instance or modify the PayAsYouGo instance to Subscription. Once effect, it will not be modified that means runningpulumi up
will not effect the resource.- planned
End StringTime The latest time to start executing the target scheduled task. The format is YYYY-MM-DDThh: mm: ssZ (UTC).
NOTE: The latest time must be 30 minutes or more later than the start time. If PlannedStartTime is set but this parameter is not specified, the latest time to execute the target task defaults to the start time+30 minutes. For example, when the PlannedStartTime is set to 2021-01-14T09:00:00Z and this parameter is left blank, the target task will start executing at the latest on 2021-01-14T09:30:00Z.
- planned
Start StringTime The earliest time to start executing a scheduled (i.e. within the target time period) kernel version upgrade task. The format is YYYY-MM-DDThh: mm: ssZ (UTC).
NOTE: The starting time range is any time point within the next 24 hours. For example, the current time is 2021-01-14T09:00:00Z, and the allowed start time range for filling in here is 2021-01-14T09:00:00Z~2021-01-15T09:00:00Z. If this parameter is left blank, the kernel version upgrade task will be executed immediately by default.
- proxy
Class String The specifications of the Standard Edition PolarProxy. Available parameters can refer to the latest docs CreateDBCluster
ProxyType
NOTE: This parameter is valid only for standard clusters.
- proxy
Type String The type of PolarProxy. Default value: OFF. Valid values are
OFF
,EXCLUSIVE
GENERAL
.NOTE: This parameter is valid only for standard clusters.
- 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.
- scale
Max Number The maximum number of PCUs per node for scaling. Valid values: 1 PCU to 32 PCUs.
NOTE: This parameter is valid only for serverless clusters.
- scale
Min Number The minimum number of PCUs per node for scaling. Valid values: 1 PCU to 31 PCUs.
NOTE: This parameter is valid only for serverless clusters.
- scale
Ro NumberNum Max The maximum number of read-only nodes for scaling. Valid values: 0 to 15.
NOTE: This parameter is valid only for serverless clusters.
- scale
Ro NumberNum Min The minimum number of read-only nodes for scaling. Valid values: 0 to 15.
NOTE: This parameter is valid only for serverless clusters.
- seconds
Until NumberAuto Pause The detection period for No-activity Suspension. Valid values: 300 to 86,4005. Unit: seconds. The detection duration must be a multiple of 300 seconds.
NOTE: This parameter is valid only for serverless clusters.
- 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".- serverless
Type String The type of the serverless cluster. Set the value to AgileServerless.
NOTE: This parameter is valid only for serverless clusters.
- 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
.- storage
Pay StringType The billing method of the storage. Valid values
Postpaid
,Prepaid
.- storage
Space Number Storage space charged by space (monthly package). Unit: GB.
NOTE: Valid values for PolarDB for MySQL Standard Edition: 20 to 32000. It is valid when pay_type are
PrePaid
,PostPaid
. NOTE: Valid values for PolarDB for MySQL Enterprise Edition: 50 to 100000.It is valid when pay_type isPrePaid
.- storage
Type String The storage type of the cluster. Enterprise storage type values are
PSL5
,PSL4
. The standard version storage type values areESSDPL1
,ESSDPL2
,ESSDPL3
. The standard version only supports MySQL.NOTE: Serverless cluster does not support this parameter.
- 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
.- upgrade
Type String Version upgrade type. Valid values are PROXY, DB, ALL. PROXY means upgrading the proxy version, DB means upgrading the db version, ALL means upgrading both db and proxy versions simultaneously.
- 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 since 1.81.0+) PolarDB cluster connection string.
- Create
Time string (Available since 1.204.1+) PolarDB cluster creation time.
- Id string
The provider-assigned unique ID for this managed resource.
- Port string
(Available since 1.196.0+) PolarDB cluster connection port.
- Status string
(Available since 1.204.1+) PolarDB cluster status.
- Tde
Region string (Available since 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 since 1.81.0+) PolarDB cluster connection string.
- Create
Time string (Available since 1.204.1+) PolarDB cluster creation time.
- Id string
The provider-assigned unique ID for this managed resource.
- Port string
(Available since 1.196.0+) PolarDB cluster connection port.
- Status string
(Available since 1.204.1+) PolarDB cluster status.
- Tde
Region string (Available since 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 since 1.81.0+) PolarDB cluster connection string.
- create
Time String (Available since 1.204.1+) PolarDB cluster creation time.
- id String
The provider-assigned unique ID for this managed resource.
- port String
(Available since 1.196.0+) PolarDB cluster connection port.
- status String
(Available since 1.204.1+) PolarDB cluster status.
- tde
Region String (Available since 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 since 1.81.0+) PolarDB cluster connection string.
- create
Time string (Available since 1.204.1+) PolarDB cluster creation time.
- id string
The provider-assigned unique ID for this managed resource.
- port string
(Available since 1.196.0+) PolarDB cluster connection port.
- status string
(Available since 1.204.1+) PolarDB cluster status.
- tde
Region string (Available since 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 since 1.81.0+) PolarDB cluster connection string.
- create_
time str (Available since 1.204.1+) PolarDB cluster creation time.
- id str
The provider-assigned unique ID for this managed resource.
- port str
(Available since 1.196.0+) PolarDB cluster connection port.
- status str
(Available since 1.204.1+) PolarDB cluster status.
- tde_
region str (Available since 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 since 1.81.0+) PolarDB cluster connection string.
- create
Time String (Available since 1.204.1+) PolarDB cluster creation time.
- id String
The provider-assigned unique ID for this managed resource.
- port String
(Available since 1.196.0+) PolarDB cluster connection port.
- status String
(Available since 1.204.1+) PolarDB cluster status.
- tde
Region String (Available since 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,
allow_shut_down: Optional[str] = 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,
create_time: 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_node_num: Optional[int] = None,
db_type: Optional[str] = None,
db_version: Optional[str] = None,
default_time_zone: Optional[str] = None,
deletion_lock: Optional[int] = None,
description: Optional[str] = None,
encrypt_new_tables: Optional[str] = None,
encryption_key: Optional[str] = None,
from_time_service: Optional[str] = None,
gdn_id: Optional[str] = None,
hot_standby_cluster: Optional[str] = None,
imci_switch: Optional[str] = None,
loose_polar_log_bin: Optional[str] = None,
lower_case_table_names: Optional[int] = None,
maintain_time: Optional[str] = None,
modify_type: Optional[str] = None,
parameter_group_id: Optional[str] = None,
parameters: Optional[Sequence[ClusterParameterArgs]] = None,
pay_type: Optional[str] = None,
period: Optional[int] = None,
planned_end_time: Optional[str] = None,
planned_start_time: Optional[str] = None,
port: Optional[str] = None,
proxy_class: Optional[str] = None,
proxy_type: Optional[str] = None,
renewal_status: Optional[str] = None,
resource_group_id: Optional[str] = None,
role_arn: Optional[str] = None,
scale_max: Optional[int] = None,
scale_min: Optional[int] = None,
scale_ro_num_max: Optional[int] = None,
scale_ro_num_min: Optional[int] = None,
seconds_until_auto_pause: Optional[int] = None,
security_group_ids: Optional[Sequence[str]] = None,
security_ips: Optional[Sequence[str]] = None,
serverless_type: Optional[str] = None,
source_resource_id: Optional[str] = None,
status: Optional[str] = None,
storage_pay_type: Optional[str] = None,
storage_space: Optional[int] = None,
storage_type: Optional[str] = None,
sub_category: Optional[str] = None,
tags: Optional[Mapping[str, Any]] = None,
tde_region: Optional[str] = None,
tde_status: Optional[str] = None,
upgrade_type: 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.
- Allow
Shut stringDown Specifies whether to enable the no-activity suspension feature. Default value: false. Valid values are
true
,false
.NOTE: This parameter is valid only for serverless clusters.
- 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 since 1.81.0+) PolarDB cluster connection string.
- Create
Time string (Available since 1.204.1+) PolarDB cluster creation time.
- Creation
Category string The edition of the PolarDB service. Valid values are
Normal
,Basic
,ArchiveNormal
,NormalMultimaster
,SENormal
.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
. From version 1.203.0,creation_category
can be set toSENormal
.- 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> db_cluster_ip_array defines how users can send requests to your API. See
db_cluster_ip_array
below.- 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. From version 1.204.0, If you need to create a Serverless cluster,
db_node_class
can be set topolar.mysql.sl.small
.- 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
Node intNum The number of Standard Edition nodes. Default value: 1. Valid values are
1
,2
.- 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
.- Default
Time stringZone The time zone of the cluster. You can set the parameter to a value that is on the hour from -12:00 to +13:00 based on UTC. Example: 00:00. Default value: SYSTEM. This value indicates that the time zone of the cluster is the same as the time zone of the region.
NOTE: This parameter is valid only when the DBType parameter is set to MySQL.
- 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.- From
Time stringService Immediate or scheduled kernel version upgrade. Valid values are
true
,false
. True means immediate execution, False means scheduled execution.- Gdn
Id string The ID of the global database network (GDN).
NOTE: This parameter is required if CreationOption is set to CreateGdnStandby.
- Hot
Standby stringCluster Whether to enable the hot standby cluster. Valid values are
ON
,OFF
. Only MySQL supports.- 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.
- Loose
Polar stringLog Bin Enable the Binlog function. Valid values are
OFF
,ON
.NOTE: This parameter is valid only MySQL Engine supports.
- Lower
Case intTable Names Specifies whether the table names are case-sensitive. Default value: 1. Valid values are
1
,0
.NOTE: This parameter is valid only when the DBType parameter is set to MySQL.
- 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
.- Parameter
Group stringId The ID of the parameter template
NOTE: You can call the DescribeParameterGroups operation to query the details of all parameter templates of a specified region, such as the ID of a parameter template.
- Parameters
List<Pulumi.
Ali Cloud. Polar DB. Inputs. Cluster Parameter> Set of parameters needs to be set after DB cluster was launched. Available parameters can refer to the latest docs View database parameter templates .See
parameters
below.- Pay
Type string Valid values are
PrePaid
,PostPaid
, Default toPostPaid
.- Period int
The duration that you will buy DB cluster (in month). It is valid when pay_type is
PrePaid
. Valid values: [1~9], 12, 24, 36.NOTE: The attribute
period
is only used to create Subscription instance or modify the PayAsYouGo instance to Subscription. Once effect, it will not be modified that means runningpulumi up
will not effect the resource.- Planned
End stringTime The latest time to start executing the target scheduled task. The format is YYYY-MM-DDThh: mm: ssZ (UTC).
NOTE: The latest time must be 30 minutes or more later than the start time. If PlannedStartTime is set but this parameter is not specified, the latest time to execute the target task defaults to the start time+30 minutes. For example, when the PlannedStartTime is set to 2021-01-14T09:00:00Z and this parameter is left blank, the target task will start executing at the latest on 2021-01-14T09:30:00Z.
- Planned
Start stringTime The earliest time to start executing a scheduled (i.e. within the target time period) kernel version upgrade task. The format is YYYY-MM-DDThh: mm: ssZ (UTC).
NOTE: The starting time range is any time point within the next 24 hours. For example, the current time is 2021-01-14T09:00:00Z, and the allowed start time range for filling in here is 2021-01-14T09:00:00Z~2021-01-15T09:00:00Z. If this parameter is left blank, the kernel version upgrade task will be executed immediately by default.
- Port string
(Available since 1.196.0+) PolarDB cluster connection port.
- Proxy
Class string The specifications of the Standard Edition PolarProxy. Available parameters can refer to the latest docs CreateDBCluster
ProxyType
NOTE: This parameter is valid only for standard clusters.
- Proxy
Type string The type of PolarProxy. Default value: OFF. Valid values are
OFF
,EXCLUSIVE
GENERAL
.NOTE: This parameter is valid only for standard clusters.
- 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.
- Scale
Max int The maximum number of PCUs per node for scaling. Valid values: 1 PCU to 32 PCUs.
NOTE: This parameter is valid only for serverless clusters.
- Scale
Min int The minimum number of PCUs per node for scaling. Valid values: 1 PCU to 31 PCUs.
NOTE: This parameter is valid only for serverless clusters.
- Scale
Ro intNum Max The maximum number of read-only nodes for scaling. Valid values: 0 to 15.
NOTE: This parameter is valid only for serverless clusters.
- Scale
Ro intNum Min The minimum number of read-only nodes for scaling. Valid values: 0 to 15.
NOTE: This parameter is valid only for serverless clusters.
- Seconds
Until intAuto Pause The detection period for No-activity Suspension. Valid values: 300 to 86,4005. Unit: seconds. The detection duration must be a multiple of 300 seconds.
NOTE: This parameter is valid only for serverless clusters.
- 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".- Serverless
Type string The type of the serverless cluster. Set the value to AgileServerless.
NOTE: This parameter is valid only for serverless clusters.
- 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
.- Status string
(Available since 1.204.1+) PolarDB cluster status.
- Storage
Pay stringType The billing method of the storage. Valid values
Postpaid
,Prepaid
.- Storage
Space int Storage space charged by space (monthly package). Unit: GB.
NOTE: Valid values for PolarDB for MySQL Standard Edition: 20 to 32000. It is valid when pay_type are
PrePaid
,PostPaid
. NOTE: Valid values for PolarDB for MySQL Enterprise Edition: 50 to 100000.It is valid when pay_type isPrePaid
.- Storage
Type string The storage type of the cluster. Enterprise storage type values are
PSL5
,PSL4
. The standard version storage type values areESSDPL1
,ESSDPL2
,ESSDPL3
. The standard version only supports MySQL.NOTE: Serverless cluster does not support this parameter.
- 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 since 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
.- Upgrade
Type string Version upgrade type. Valid values are PROXY, DB, ALL. PROXY means upgrading the proxy version, DB means upgrading the db version, ALL means upgrading both db and proxy versions simultaneously.
- 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.
- Allow
Shut stringDown Specifies whether to enable the no-activity suspension feature. Default value: false. Valid values are
true
,false
.NOTE: This parameter is valid only for serverless clusters.
- 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 since 1.81.0+) PolarDB cluster connection string.
- Create
Time string (Available since 1.204.1+) PolarDB cluster creation time.
- Creation
Category string The edition of the PolarDB service. Valid values are
Normal
,Basic
,ArchiveNormal
,NormalMultimaster
,SENormal
.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
. From version 1.203.0,creation_category
can be set toSENormal
.- 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. See
db_cluster_ip_array
below.- 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. From version 1.204.0, If you need to create a Serverless cluster,
db_node_class
can be set topolar.mysql.sl.small
.- 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
Node intNum The number of Standard Edition nodes. Default value: 1. Valid values are
1
,2
.- 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
.- Default
Time stringZone The time zone of the cluster. You can set the parameter to a value that is on the hour from -12:00 to +13:00 based on UTC. Example: 00:00. Default value: SYSTEM. This value indicates that the time zone of the cluster is the same as the time zone of the region.
NOTE: This parameter is valid only when the DBType parameter is set to MySQL.
- 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.- From
Time stringService Immediate or scheduled kernel version upgrade. Valid values are
true
,false
. True means immediate execution, False means scheduled execution.- Gdn
Id string The ID of the global database network (GDN).
NOTE: This parameter is required if CreationOption is set to CreateGdnStandby.
- Hot
Standby stringCluster Whether to enable the hot standby cluster. Valid values are
ON
,OFF
. Only MySQL supports.- 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.
- Loose
Polar stringLog Bin Enable the Binlog function. Valid values are
OFF
,ON
.NOTE: This parameter is valid only MySQL Engine supports.
- Lower
Case intTable Names Specifies whether the table names are case-sensitive. Default value: 1. Valid values are
1
,0
.NOTE: This parameter is valid only when the DBType parameter is set to MySQL.
- 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
.- Parameter
Group stringId The ID of the parameter template
NOTE: You can call the DescribeParameterGroups operation to query the details of all parameter templates of a specified region, such as the ID of a parameter template.
- 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 .See
parameters
below.- Pay
Type string Valid values are
PrePaid
,PostPaid
, Default toPostPaid
.- Period int
The duration that you will buy DB cluster (in month). It is valid when pay_type is
PrePaid
. Valid values: [1~9], 12, 24, 36.NOTE: The attribute
period
is only used to create Subscription instance or modify the PayAsYouGo instance to Subscription. Once effect, it will not be modified that means runningpulumi up
will not effect the resource.- Planned
End stringTime The latest time to start executing the target scheduled task. The format is YYYY-MM-DDThh: mm: ssZ (UTC).
NOTE: The latest time must be 30 minutes or more later than the start time. If PlannedStartTime is set but this parameter is not specified, the latest time to execute the target task defaults to the start time+30 minutes. For example, when the PlannedStartTime is set to 2021-01-14T09:00:00Z and this parameter is left blank, the target task will start executing at the latest on 2021-01-14T09:30:00Z.
- Planned
Start stringTime The earliest time to start executing a scheduled (i.e. within the target time period) kernel version upgrade task. The format is YYYY-MM-DDThh: mm: ssZ (UTC).
NOTE: The starting time range is any time point within the next 24 hours. For example, the current time is 2021-01-14T09:00:00Z, and the allowed start time range for filling in here is 2021-01-14T09:00:00Z~2021-01-15T09:00:00Z. If this parameter is left blank, the kernel version upgrade task will be executed immediately by default.
- Port string
(Available since 1.196.0+) PolarDB cluster connection port.
- Proxy
Class string The specifications of the Standard Edition PolarProxy. Available parameters can refer to the latest docs CreateDBCluster
ProxyType
NOTE: This parameter is valid only for standard clusters.
- Proxy
Type string The type of PolarProxy. Default value: OFF. Valid values are
OFF
,EXCLUSIVE
GENERAL
.NOTE: This parameter is valid only for standard clusters.
- 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.
- Scale
Max int The maximum number of PCUs per node for scaling. Valid values: 1 PCU to 32 PCUs.
NOTE: This parameter is valid only for serverless clusters.
- Scale
Min int The minimum number of PCUs per node for scaling. Valid values: 1 PCU to 31 PCUs.
NOTE: This parameter is valid only for serverless clusters.
- Scale
Ro intNum Max The maximum number of read-only nodes for scaling. Valid values: 0 to 15.
NOTE: This parameter is valid only for serverless clusters.
- Scale
Ro intNum Min The minimum number of read-only nodes for scaling. Valid values: 0 to 15.
NOTE: This parameter is valid only for serverless clusters.
- Seconds
Until intAuto Pause The detection period for No-activity Suspension. Valid values: 300 to 86,4005. Unit: seconds. The detection duration must be a multiple of 300 seconds.
NOTE: This parameter is valid only for serverless clusters.
- 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".- Serverless
Type string The type of the serverless cluster. Set the value to AgileServerless.
NOTE: This parameter is valid only for serverless clusters.
- 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
.- Status string
(Available since 1.204.1+) PolarDB cluster status.
- Storage
Pay stringType The billing method of the storage. Valid values
Postpaid
,Prepaid
.- Storage
Space int Storage space charged by space (monthly package). Unit: GB.
NOTE: Valid values for PolarDB for MySQL Standard Edition: 20 to 32000. It is valid when pay_type are
PrePaid
,PostPaid
. NOTE: Valid values for PolarDB for MySQL Enterprise Edition: 50 to 100000.It is valid when pay_type isPrePaid
.- Storage
Type string The storage type of the cluster. Enterprise storage type values are
PSL5
,PSL4
. The standard version storage type values areESSDPL1
,ESSDPL2
,ESSDPL3
. The standard version only supports MySQL.NOTE: Serverless cluster does not support this parameter.
- 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 since 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
.- Upgrade
Type string Version upgrade type. Valid values are PROXY, DB, ALL. PROXY means upgrading the proxy version, DB means upgrading the db version, ALL means upgrading both db and proxy versions simultaneously.
- 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.
- allow
Shut StringDown Specifies whether to enable the no-activity suspension feature. Default value: false. Valid values are
true
,false
.NOTE: This parameter is valid only for serverless clusters.
- 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 since 1.81.0+) PolarDB cluster connection string.
- create
Time String (Available since 1.204.1+) PolarDB cluster creation time.
- creation
Category String The edition of the PolarDB service. Valid values are
Normal
,Basic
,ArchiveNormal
,NormalMultimaster
,SENormal
.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
. From version 1.203.0,creation_category
can be set toSENormal
.- 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> db_cluster_ip_array defines how users can send requests to your API. See
db_cluster_ip_array
below.- 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. From version 1.204.0, If you need to create a Serverless cluster,
db_node_class
can be set topolar.mysql.sl.small
.- 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
Node IntegerNum The number of Standard Edition nodes. Default value: 1. Valid values are
1
,2
.- 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
.- default
Time StringZone The time zone of the cluster. You can set the parameter to a value that is on the hour from -12:00 to +13:00 based on UTC. Example: 00:00. Default value: SYSTEM. This value indicates that the time zone of the cluster is the same as the time zone of the region.
NOTE: This parameter is valid only when the DBType parameter is set to MySQL.
- 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.- from
Time StringService Immediate or scheduled kernel version upgrade. Valid values are
true
,false
. True means immediate execution, False means scheduled execution.- gdn
Id String The ID of the global database network (GDN).
NOTE: This parameter is required if CreationOption is set to CreateGdnStandby.
- hot
Standby StringCluster Whether to enable the hot standby cluster. Valid values are
ON
,OFF
. Only MySQL supports.- 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.
- loose
Polar StringLog Bin Enable the Binlog function. Valid values are
OFF
,ON
.NOTE: This parameter is valid only MySQL Engine supports.
- lower
Case IntegerTable Names Specifies whether the table names are case-sensitive. Default value: 1. Valid values are
1
,0
.NOTE: This parameter is valid only when the DBType parameter is set to MySQL.
- 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
.- parameter
Group StringId The ID of the parameter template
NOTE: You can call the DescribeParameterGroups operation to query the details of all parameter templates of a specified region, such as the ID of a parameter template.
- parameters
List<Cluster
Parameter> Set of parameters needs to be set after DB cluster was launched. Available parameters can refer to the latest docs View database parameter templates .See
parameters
below.- pay
Type String Valid values are
PrePaid
,PostPaid
, Default toPostPaid
.- period Integer
The duration that you will buy DB cluster (in month). It is valid when pay_type is
PrePaid
. Valid values: [1~9], 12, 24, 36.NOTE: The attribute
period
is only used to create Subscription instance or modify the PayAsYouGo instance to Subscription. Once effect, it will not be modified that means runningpulumi up
will not effect the resource.- planned
End StringTime The latest time to start executing the target scheduled task. The format is YYYY-MM-DDThh: mm: ssZ (UTC).
NOTE: The latest time must be 30 minutes or more later than the start time. If PlannedStartTime is set but this parameter is not specified, the latest time to execute the target task defaults to the start time+30 minutes. For example, when the PlannedStartTime is set to 2021-01-14T09:00:00Z and this parameter is left blank, the target task will start executing at the latest on 2021-01-14T09:30:00Z.
- planned
Start StringTime The earliest time to start executing a scheduled (i.e. within the target time period) kernel version upgrade task. The format is YYYY-MM-DDThh: mm: ssZ (UTC).
NOTE: The starting time range is any time point within the next 24 hours. For example, the current time is 2021-01-14T09:00:00Z, and the allowed start time range for filling in here is 2021-01-14T09:00:00Z~2021-01-15T09:00:00Z. If this parameter is left blank, the kernel version upgrade task will be executed immediately by default.
- port String
(Available since 1.196.0+) PolarDB cluster connection port.
- proxy
Class String The specifications of the Standard Edition PolarProxy. Available parameters can refer to the latest docs CreateDBCluster
ProxyType
NOTE: This parameter is valid only for standard clusters.
- proxy
Type String The type of PolarProxy. Default value: OFF. Valid values are
OFF
,EXCLUSIVE
GENERAL
.NOTE: This parameter is valid only for standard clusters.
- 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.
- scale
Max Integer The maximum number of PCUs per node for scaling. Valid values: 1 PCU to 32 PCUs.
NOTE: This parameter is valid only for serverless clusters.
- scale
Min Integer The minimum number of PCUs per node for scaling. Valid values: 1 PCU to 31 PCUs.
NOTE: This parameter is valid only for serverless clusters.
- scale
Ro IntegerNum Max The maximum number of read-only nodes for scaling. Valid values: 0 to 15.
NOTE: This parameter is valid only for serverless clusters.
- scale
Ro IntegerNum Min The minimum number of read-only nodes for scaling. Valid values: 0 to 15.
NOTE: This parameter is valid only for serverless clusters.
- seconds
Until IntegerAuto Pause The detection period for No-activity Suspension. Valid values: 300 to 86,4005. Unit: seconds. The detection duration must be a multiple of 300 seconds.
NOTE: This parameter is valid only for serverless clusters.
- 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".- serverless
Type String The type of the serverless cluster. Set the value to AgileServerless.
NOTE: This parameter is valid only for serverless clusters.
- 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
.- status String
(Available since 1.204.1+) PolarDB cluster status.
- storage
Pay StringType The billing method of the storage. Valid values
Postpaid
,Prepaid
.- storage
Space Integer Storage space charged by space (monthly package). Unit: GB.
NOTE: Valid values for PolarDB for MySQL Standard Edition: 20 to 32000. It is valid when pay_type are
PrePaid
,PostPaid
. NOTE: Valid values for PolarDB for MySQL Enterprise Edition: 50 to 100000.It is valid when pay_type isPrePaid
.- storage
Type String The storage type of the cluster. Enterprise storage type values are
PSL5
,PSL4
. The standard version storage type values areESSDPL1
,ESSDPL2
,ESSDPL3
. The standard version only supports MySQL.NOTE: Serverless cluster does not support this parameter.
- 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 since 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
.- upgrade
Type String Version upgrade type. Valid values are PROXY, DB, ALL. PROXY means upgrading the proxy version, DB means upgrading the db version, ALL means upgrading both db and proxy versions simultaneously.
- 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.
- allow
Shut stringDown Specifies whether to enable the no-activity suspension feature. Default value: false. Valid values are
true
,false
.NOTE: This parameter is valid only for serverless clusters.
- 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 since 1.81.0+) PolarDB cluster connection string.
- create
Time string (Available since 1.204.1+) PolarDB cluster creation time.
- creation
Category string The edition of the PolarDB service. Valid values are
Normal
,Basic
,ArchiveNormal
,NormalMultimaster
,SENormal
.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
. From version 1.203.0,creation_category
can be set toSENormal
.- 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[] db_cluster_ip_array defines how users can send requests to your API. See
db_cluster_ip_array
below.- 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. From version 1.204.0, If you need to create a Serverless cluster,
db_node_class
can be set topolar.mysql.sl.small
.- 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
Node numberNum The number of Standard Edition nodes. Default value: 1. Valid values are
1
,2
.- 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
.- default
Time stringZone The time zone of the cluster. You can set the parameter to a value that is on the hour from -12:00 to +13:00 based on UTC. Example: 00:00. Default value: SYSTEM. This value indicates that the time zone of the cluster is the same as the time zone of the region.
NOTE: This parameter is valid only when the DBType parameter is set to MySQL.
- 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.- from
Time stringService Immediate or scheduled kernel version upgrade. Valid values are
true
,false
. True means immediate execution, False means scheduled execution.- gdn
Id string The ID of the global database network (GDN).
NOTE: This parameter is required if CreationOption is set to CreateGdnStandby.
- hot
Standby stringCluster Whether to enable the hot standby cluster. Valid values are
ON
,OFF
. Only MySQL supports.- 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.
- loose
Polar stringLog Bin Enable the Binlog function. Valid values are
OFF
,ON
.NOTE: This parameter is valid only MySQL Engine supports.
- lower
Case numberTable Names Specifies whether the table names are case-sensitive. Default value: 1. Valid values are
1
,0
.NOTE: This parameter is valid only when the DBType parameter is set to MySQL.
- 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
.- parameter
Group stringId The ID of the parameter template
NOTE: You can call the DescribeParameterGroups operation to query the details of all parameter templates of a specified region, such as the ID of a parameter template.
- parameters
Cluster
Parameter[] Set of parameters needs to be set after DB cluster was launched. Available parameters can refer to the latest docs View database parameter templates .See
parameters
below.- pay
Type string Valid values are
PrePaid
,PostPaid
, Default toPostPaid
.- period number
The duration that you will buy DB cluster (in month). It is valid when pay_type is
PrePaid
. Valid values: [1~9], 12, 24, 36.NOTE: The attribute
period
is only used to create Subscription instance or modify the PayAsYouGo instance to Subscription. Once effect, it will not be modified that means runningpulumi up
will not effect the resource.- planned
End stringTime The latest time to start executing the target scheduled task. The format is YYYY-MM-DDThh: mm: ssZ (UTC).
NOTE: The latest time must be 30 minutes or more later than the start time. If PlannedStartTime is set but this parameter is not specified, the latest time to execute the target task defaults to the start time+30 minutes. For example, when the PlannedStartTime is set to 2021-01-14T09:00:00Z and this parameter is left blank, the target task will start executing at the latest on 2021-01-14T09:30:00Z.
- planned
Start stringTime The earliest time to start executing a scheduled (i.e. within the target time period) kernel version upgrade task. The format is YYYY-MM-DDThh: mm: ssZ (UTC).
NOTE: The starting time range is any time point within the next 24 hours. For example, the current time is 2021-01-14T09:00:00Z, and the allowed start time range for filling in here is 2021-01-14T09:00:00Z~2021-01-15T09:00:00Z. If this parameter is left blank, the kernel version upgrade task will be executed immediately by default.
- port string
(Available since 1.196.0+) PolarDB cluster connection port.
- proxy
Class string The specifications of the Standard Edition PolarProxy. Available parameters can refer to the latest docs CreateDBCluster
ProxyType
NOTE: This parameter is valid only for standard clusters.
- proxy
Type string The type of PolarProxy. Default value: OFF. Valid values are
OFF
,EXCLUSIVE
GENERAL
.NOTE: This parameter is valid only for standard clusters.
- 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.
- scale
Max number The maximum number of PCUs per node for scaling. Valid values: 1 PCU to 32 PCUs.
NOTE: This parameter is valid only for serverless clusters.
- scale
Min number The minimum number of PCUs per node for scaling. Valid values: 1 PCU to 31 PCUs.
NOTE: This parameter is valid only for serverless clusters.
- scale
Ro numberNum Max The maximum number of read-only nodes for scaling. Valid values: 0 to 15.
NOTE: This parameter is valid only for serverless clusters.
- scale
Ro numberNum Min The minimum number of read-only nodes for scaling. Valid values: 0 to 15.
NOTE: This parameter is valid only for serverless clusters.
- seconds
Until numberAuto Pause The detection period for No-activity Suspension. Valid values: 300 to 86,4005. Unit: seconds. The detection duration must be a multiple of 300 seconds.
NOTE: This parameter is valid only for serverless clusters.
- 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".- serverless
Type string The type of the serverless cluster. Set the value to AgileServerless.
NOTE: This parameter is valid only for serverless clusters.
- 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
.- status string
(Available since 1.204.1+) PolarDB cluster status.
- storage
Pay stringType The billing method of the storage. Valid values
Postpaid
,Prepaid
.- storage
Space number Storage space charged by space (monthly package). Unit: GB.
NOTE: Valid values for PolarDB for MySQL Standard Edition: 20 to 32000. It is valid when pay_type are
PrePaid
,PostPaid
. NOTE: Valid values for PolarDB for MySQL Enterprise Edition: 50 to 100000.It is valid when pay_type isPrePaid
.- storage
Type string The storage type of the cluster. Enterprise storage type values are
PSL5
,PSL4
. The standard version storage type values areESSDPL1
,ESSDPL2
,ESSDPL3
. The standard version only supports MySQL.NOTE: Serverless cluster does not support this parameter.
- 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 since 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
.- upgrade
Type string Version upgrade type. Valid values are PROXY, DB, ALL. PROXY means upgrading the proxy version, DB means upgrading the db version, ALL means upgrading both db and proxy versions simultaneously.
- 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.
- allow_
shut_ strdown Specifies whether to enable the no-activity suspension feature. Default value: false. Valid values are
true
,false
.NOTE: This parameter is valid only for serverless clusters.
- 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 since 1.81.0+) PolarDB cluster connection string.
- create_
time str (Available since 1.204.1+) PolarDB cluster creation time.
- creation_
category str The edition of the PolarDB service. Valid values are
Normal
,Basic
,ArchiveNormal
,NormalMultimaster
,SENormal
.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
. From version 1.203.0,creation_category
can be set toSENormal
.- 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. See
db_cluster_ip_array
below.- 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. From version 1.204.0, If you need to create a Serverless cluster,
db_node_class
can be set topolar.mysql.sl.small
.- 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_
node_ intnum The number of Standard Edition nodes. Default value: 1. Valid values are
1
,2
.- 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
.- default_
time_ strzone The time zone of the cluster. You can set the parameter to a value that is on the hour from -12:00 to +13:00 based on UTC. Example: 00:00. Default value: SYSTEM. This value indicates that the time zone of the cluster is the same as the time zone of the region.
NOTE: This parameter is valid only when the DBType parameter is set to MySQL.
- 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.- from_
time_ strservice Immediate or scheduled kernel version upgrade. Valid values are
true
,false
. True means immediate execution, False means scheduled execution.- gdn_
id str The ID of the global database network (GDN).
NOTE: This parameter is required if CreationOption is set to CreateGdnStandby.
- hot_
standby_ strcluster Whether to enable the hot standby cluster. Valid values are
ON
,OFF
. Only MySQL supports.- 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.
- loose_
polar_ strlog_ bin Enable the Binlog function. Valid values are
OFF
,ON
.NOTE: This parameter is valid only MySQL Engine supports.
- lower_
case_ inttable_ names Specifies whether the table names are case-sensitive. Default value: 1. Valid values are
1
,0
.NOTE: This parameter is valid only when the DBType parameter is set to MySQL.
- 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
.- parameter_
group_ strid The ID of the parameter template
NOTE: You can call the DescribeParameterGroups operation to query the details of all parameter templates of a specified region, such as the ID of a parameter template.
- 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 .See
parameters
below.- pay_
type str Valid values are
PrePaid
,PostPaid
, Default toPostPaid
.- period int
The duration that you will buy DB cluster (in month). It is valid when pay_type is
PrePaid
. Valid values: [1~9], 12, 24, 36.NOTE: The attribute
period
is only used to create Subscription instance or modify the PayAsYouGo instance to Subscription. Once effect, it will not be modified that means runningpulumi up
will not effect the resource.- planned_
end_ strtime The latest time to start executing the target scheduled task. The format is YYYY-MM-DDThh: mm: ssZ (UTC).
NOTE: The latest time must be 30 minutes or more later than the start time. If PlannedStartTime is set but this parameter is not specified, the latest time to execute the target task defaults to the start time+30 minutes. For example, when the PlannedStartTime is set to 2021-01-14T09:00:00Z and this parameter is left blank, the target task will start executing at the latest on 2021-01-14T09:30:00Z.
- planned_
start_ strtime The earliest time to start executing a scheduled (i.e. within the target time period) kernel version upgrade task. The format is YYYY-MM-DDThh: mm: ssZ (UTC).
NOTE: The starting time range is any time point within the next 24 hours. For example, the current time is 2021-01-14T09:00:00Z, and the allowed start time range for filling in here is 2021-01-14T09:00:00Z~2021-01-15T09:00:00Z. If this parameter is left blank, the kernel version upgrade task will be executed immediately by default.
- port str
(Available since 1.196.0+) PolarDB cluster connection port.
- proxy_
class str The specifications of the Standard Edition PolarProxy. Available parameters can refer to the latest docs CreateDBCluster
ProxyType
NOTE: This parameter is valid only for standard clusters.
- proxy_
type str The type of PolarProxy. Default value: OFF. Valid values are
OFF
,EXCLUSIVE
GENERAL
.NOTE: This parameter is valid only for standard clusters.
- 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.
- scale_
max int The maximum number of PCUs per node for scaling. Valid values: 1 PCU to 32 PCUs.
NOTE: This parameter is valid only for serverless clusters.
- scale_
min int The minimum number of PCUs per node for scaling. Valid values: 1 PCU to 31 PCUs.
NOTE: This parameter is valid only for serverless clusters.
- scale_
ro_ intnum_ max The maximum number of read-only nodes for scaling. Valid values: 0 to 15.
NOTE: This parameter is valid only for serverless clusters.
- scale_
ro_ intnum_ min The minimum number of read-only nodes for scaling. Valid values: 0 to 15.
NOTE: This parameter is valid only for serverless clusters.
- seconds_
until_ intauto_ pause The detection period for No-activity Suspension. Valid values: 300 to 86,4005. Unit: seconds. The detection duration must be a multiple of 300 seconds.
NOTE: This parameter is valid only for serverless clusters.
- 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".- serverless_
type str The type of the serverless cluster. Set the value to AgileServerless.
NOTE: This parameter is valid only for serverless clusters.
- 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
.- status str
(Available since 1.204.1+) PolarDB cluster status.
- storage_
pay_ strtype The billing method of the storage. Valid values
Postpaid
,Prepaid
.- storage_
space int Storage space charged by space (monthly package). Unit: GB.
NOTE: Valid values for PolarDB for MySQL Standard Edition: 20 to 32000. It is valid when pay_type are
PrePaid
,PostPaid
. NOTE: Valid values for PolarDB for MySQL Enterprise Edition: 50 to 100000.It is valid when pay_type isPrePaid
.- storage_
type str The storage type of the cluster. Enterprise storage type values are
PSL5
,PSL4
. The standard version storage type values areESSDPL1
,ESSDPL2
,ESSDPL3
. The standard version only supports MySQL.NOTE: Serverless cluster does not support this parameter.
- 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 since 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
.- upgrade_
type str Version upgrade type. Valid values are PROXY, DB, ALL. PROXY means upgrading the proxy version, DB means upgrading the db version, ALL means upgrading both db and proxy versions simultaneously.
- 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.
- allow
Shut StringDown Specifies whether to enable the no-activity suspension feature. Default value: false. Valid values are
true
,false
.NOTE: This parameter is valid only for serverless clusters.
- 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 since 1.81.0+) PolarDB cluster connection string.
- create
Time String (Available since 1.204.1+) PolarDB cluster creation time.
- creation
Category String The edition of the PolarDB service. Valid values are
Normal
,Basic
,ArchiveNormal
,NormalMultimaster
,SENormal
.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
. From version 1.203.0,creation_category
can be set toSENormal
.- 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. See
db_cluster_ip_array
below.- 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. From version 1.204.0, If you need to create a Serverless cluster,
db_node_class
can be set topolar.mysql.sl.small
.- 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
Node NumberNum The number of Standard Edition nodes. Default value: 1. Valid values are
1
,2
.- 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
.- default
Time StringZone The time zone of the cluster. You can set the parameter to a value that is on the hour from -12:00 to +13:00 based on UTC. Example: 00:00. Default value: SYSTEM. This value indicates that the time zone of the cluster is the same as the time zone of the region.
NOTE: This parameter is valid only when the DBType parameter is set to MySQL.
- 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.- from
Time StringService Immediate or scheduled kernel version upgrade. Valid values are
true
,false
. True means immediate execution, False means scheduled execution.- gdn
Id String The ID of the global database network (GDN).
NOTE: This parameter is required if CreationOption is set to CreateGdnStandby.
- hot
Standby StringCluster Whether to enable the hot standby cluster. Valid values are
ON
,OFF
. Only MySQL supports.- 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.
- loose
Polar StringLog Bin Enable the Binlog function. Valid values are
OFF
,ON
.NOTE: This parameter is valid only MySQL Engine supports.
- lower
Case NumberTable Names Specifies whether the table names are case-sensitive. Default value: 1. Valid values are
1
,0
.NOTE: This parameter is valid only when the DBType parameter is set to MySQL.
- 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
.- parameter
Group StringId The ID of the parameter template
NOTE: You can call the DescribeParameterGroups operation to query the details of all parameter templates of a specified region, such as the ID of a parameter template.
- 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 .See
parameters
below.- pay
Type String Valid values are
PrePaid
,PostPaid
, Default toPostPaid
.- period Number
The duration that you will buy DB cluster (in month). It is valid when pay_type is
PrePaid
. Valid values: [1~9], 12, 24, 36.NOTE: The attribute
period
is only used to create Subscription instance or modify the PayAsYouGo instance to Subscription. Once effect, it will not be modified that means runningpulumi up
will not effect the resource.- planned
End StringTime The latest time to start executing the target scheduled task. The format is YYYY-MM-DDThh: mm: ssZ (UTC).
NOTE: The latest time must be 30 minutes or more later than the start time. If PlannedStartTime is set but this parameter is not specified, the latest time to execute the target task defaults to the start time+30 minutes. For example, when the PlannedStartTime is set to 2021-01-14T09:00:00Z and this parameter is left blank, the target task will start executing at the latest on 2021-01-14T09:30:00Z.
- planned
Start StringTime The earliest time to start executing a scheduled (i.e. within the target time period) kernel version upgrade task. The format is YYYY-MM-DDThh: mm: ssZ (UTC).
NOTE: The starting time range is any time point within the next 24 hours. For example, the current time is 2021-01-14T09:00:00Z, and the allowed start time range for filling in here is 2021-01-14T09:00:00Z~2021-01-15T09:00:00Z. If this parameter is left blank, the kernel version upgrade task will be executed immediately by default.
- port String
(Available since 1.196.0+) PolarDB cluster connection port.
- proxy
Class String The specifications of the Standard Edition PolarProxy. Available parameters can refer to the latest docs CreateDBCluster
ProxyType
NOTE: This parameter is valid only for standard clusters.
- proxy
Type String The type of PolarProxy. Default value: OFF. Valid values are
OFF
,EXCLUSIVE
GENERAL
.NOTE: This parameter is valid only for standard clusters.
- 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.
- scale
Max Number The maximum number of PCUs per node for scaling. Valid values: 1 PCU to 32 PCUs.
NOTE: This parameter is valid only for serverless clusters.
- scale
Min Number The minimum number of PCUs per node for scaling. Valid values: 1 PCU to 31 PCUs.
NOTE: This parameter is valid only for serverless clusters.
- scale
Ro NumberNum Max The maximum number of read-only nodes for scaling. Valid values: 0 to 15.
NOTE: This parameter is valid only for serverless clusters.
- scale
Ro NumberNum Min The minimum number of read-only nodes for scaling. Valid values: 0 to 15.
NOTE: This parameter is valid only for serverless clusters.
- seconds
Until NumberAuto Pause The detection period for No-activity Suspension. Valid values: 300 to 86,4005. Unit: seconds. The detection duration must be a multiple of 300 seconds.
NOTE: This parameter is valid only for serverless clusters.
- 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".- serverless
Type String The type of the serverless cluster. Set the value to AgileServerless.
NOTE: This parameter is valid only for serverless clusters.
- 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
.- status String
(Available since 1.204.1+) PolarDB cluster status.
- storage
Pay StringType The billing method of the storage. Valid values
Postpaid
,Prepaid
.- storage
Space Number Storage space charged by space (monthly package). Unit: GB.
NOTE: Valid values for PolarDB for MySQL Standard Edition: 20 to 32000. It is valid when pay_type are
PrePaid
,PostPaid
. NOTE: Valid values for PolarDB for MySQL Enterprise Edition: 50 to 100000.It is valid when pay_type isPrePaid
.- storage
Type String The storage type of the cluster. Enterprise storage type values are
PSL5
,PSL4
. The standard version storage type values areESSDPL1
,ESSDPL2
,ESSDPL3
. The standard version only supports MySQL.NOTE: Serverless cluster does not support this parameter.
- 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 since 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
.- upgrade
Type String Version upgrade type. Valid values are PROXY, DB, ALL. PROXY means upgrading the proxy version, DB means upgrading the db version, ALL means upgrading both db and proxy versions simultaneously.
- 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, ClusterDbClusterIpArrayArgs
- 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> List of IP addresses allowed to access all databases of a cluster. The list contains up to 1,000 IP addresses, separated by commas. Supported formats include 0.0.0.0/0, 10.23.12.24 (IP), and 10.23.12.24/24 (Classless Inter-Domain Routing (CIDR) mode. /24 represents the length of the prefix in an IP address. The range of the prefix length is [1,32]).
- 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 List of IP addresses allowed to access all databases of a cluster. The list contains up to 1,000 IP addresses, separated by commas. Supported formats include 0.0.0.0/0, 10.23.12.24 (IP), and 10.23.12.24/24 (Classless Inter-Domain Routing (CIDR) mode. /24 represents the length of the prefix in an IP address. The range of the prefix length is [1,32]).
- 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> List of IP addresses allowed to access all databases of a cluster. The list contains up to 1,000 IP addresses, separated by commas. Supported formats include 0.0.0.0/0, 10.23.12.24 (IP), and 10.23.12.24/24 (Classless Inter-Domain Routing (CIDR) mode. /24 represents the length of the prefix in an IP address. The range of the prefix length is [1,32]).
- 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[] List of IP addresses allowed to access all databases of a cluster. The list contains up to 1,000 IP addresses, separated by commas. Supported formats include 0.0.0.0/0, 10.23.12.24 (IP), and 10.23.12.24/24 (Classless Inter-Domain Routing (CIDR) mode. /24 represents the length of the prefix in an IP address. The range of the prefix length is [1,32]).
- 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] List of IP addresses allowed to access all databases of a cluster. The list contains up to 1,000 IP addresses, separated by commas. Supported formats include 0.0.0.0/0, 10.23.12.24 (IP), and 10.23.12.24/24 (Classless Inter-Domain Routing (CIDR) mode. /24 represents the length of the prefix in an IP address. The range of the prefix length is [1,32]).
- 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> List of IP addresses allowed to access all databases of a cluster. The list contains up to 1,000 IP addresses, separated by commas. Supported formats include 0.0.0.0/0, 10.23.12.24 (IP), and 10.23.12.24/24 (Classless Inter-Domain Routing (CIDR) mode. /24 represents the length of the prefix in an IP address. The range of the prefix length is [1,32]).
ClusterParameter, ClusterParameterArgs
Package Details
- Repository
- Alibaba Cloud pulumi/pulumi-alicloud
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
alicloud
Terraform Provider.