Alibaba Cloud v3.57.1, Jun 26 24

Alibaba Cloud v3.57.1 published on Wednesday, Jun 26, 2024 by Pulumi

alicloud.polardb.Cluster

Explore with Pulumi AI

Alibaba Cloud v3.57.1 published on Wednesday, Jun 26, 2024 by Pulumi

pulumi/pulumi-alicloud

Import

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

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

Create Cluster Resource

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

Constructor syntax

new Cluster(name: string, args: ClusterArgs, opts?: CustomResourceOptions);

@overload
def Cluster(resource_name: str,
            args: ClusterArgs,
            opts: Optional[ResourceOptions] = None)

@overload
def Cluster(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            db_node_class: Optional[str] = None,
            db_type: Optional[str] = None,
            db_version: Optional[str] = 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_count: Optional[int] = None,
            db_node_id: Optional[str] = None,
            db_node_num: Optional[int] = 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_replica_mode: 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_ap_ro_num_max: Optional[int] = None,
            scale_ap_ro_num_min: Optional[int] = 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_steady_switch: Optional[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,
            target_db_revision_version_code: 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)

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.

Parameters

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.

Constructor example

The following reference example uses placeholder values for all input properties.

var exampleclusterResourceResourceFromPolardbcluster = new AliCloud.PolarDB.Cluster("exampleclusterResourceResourceFromPolardbcluster", new()
{
    DbNodeClass = "string",
    DbType = "string",
    DbVersion = "string",
    AllowShutDown = "string",
    AutoRenewPeriod = 0,
    BackupRetentionPolicyOnClusterDeletion = "string",
    CloneDataPoint = "string",
    CollectorStatus = "string",
    CreationCategory = "string",
    CreationOption = "string",
    DbClusterIpArrays = new[]
    {
        new AliCloud.PolarDB.Inputs.ClusterDbClusterIpArrayArgs
        {
            DbClusterIpArrayName = "string",
            ModifyMode = "string",
            SecurityIps = new[]
            {
                "string",
            },
        },
    },
    DbNodeCount = 0,
    DbNodeId = "string",
    DbNodeNum = 0,
    DefaultTimeZone = "string",
    DeletionLock = 0,
    Description = "string",
    EncryptNewTables = "string",
    EncryptionKey = "string",
    FromTimeService = "string",
    GdnId = "string",
    HotReplicaMode = "string",
    HotStandbyCluster = "string",
    ImciSwitch = "string",
    LoosePolarLogBin = "string",
    LowerCaseTableNames = 0,
    MaintainTime = "string",
    ModifyType = "string",
    ParameterGroupId = "string",
    Parameters = new[]
    {
        new AliCloud.PolarDB.Inputs.ClusterParameterArgs
        {
            Name = "string",
            Value = "string",
        },
    },
    PayType = "string",
    Period = 0,
    PlannedEndTime = "string",
    PlannedStartTime = "string",
    ProxyClass = "string",
    ProxyType = "string",
    RenewalStatus = "string",
    ResourceGroupId = "string",
    RoleArn = "string",
    ScaleApRoNumMax = 0,
    ScaleApRoNumMin = 0,
    ScaleMax = 0,
    ScaleMin = 0,
    ScaleRoNumMax = 0,
    ScaleRoNumMin = 0,
    SecondsUntilAutoPause = 0,
    SecurityGroupIds = new[]
    {
        "string",
    },
    SecurityIps = new[]
    {
        "string",
    },
    ServerlessSteadySwitch = "string",
    ServerlessType = "string",
    SourceResourceId = "string",
    StoragePayType = "string",
    StorageSpace = 0,
    StorageType = "string",
    SubCategory = "string",
    Tags = 
    {
        { "string", "any" },
    },
    TargetDbRevisionVersionCode = "string",
    TdeStatus = "string",
    UpgradeType = "string",
    VpcId = "string",
    VswitchId = "string",
    ZoneId = "string",
});

example, err := polardb.NewCluster(ctx, "exampleclusterResourceResourceFromPolardbcluster", &polardb.ClusterArgs{
	DbNodeClass:                            pulumi.String("string"),
	DbType:                                 pulumi.String("string"),
	DbVersion:                              pulumi.String("string"),
	AllowShutDown:                          pulumi.String("string"),
	AutoRenewPeriod:                        pulumi.Int(0),
	BackupRetentionPolicyOnClusterDeletion: pulumi.String("string"),
	CloneDataPoint:                         pulumi.String("string"),
	CollectorStatus:                        pulumi.String("string"),
	CreationCategory:                       pulumi.String("string"),
	CreationOption:                         pulumi.String("string"),
	DbClusterIpArrays: polardb.ClusterDbClusterIpArrayArray{
		&polardb.ClusterDbClusterIpArrayArgs{
			DbClusterIpArrayName: pulumi.String("string"),
			ModifyMode:           pulumi.String("string"),
			SecurityIps: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
	},
	DbNodeCount:         pulumi.Int(0),
	DbNodeId:            pulumi.String("string"),
	DbNodeNum:           pulumi.Int(0),
	DefaultTimeZone:     pulumi.String("string"),
	DeletionLock:        pulumi.Int(0),
	Description:         pulumi.String("string"),
	EncryptNewTables:    pulumi.String("string"),
	EncryptionKey:       pulumi.String("string"),
	FromTimeService:     pulumi.String("string"),
	GdnId:               pulumi.String("string"),
	HotReplicaMode:      pulumi.String("string"),
	HotStandbyCluster:   pulumi.String("string"),
	ImciSwitch:          pulumi.String("string"),
	LoosePolarLogBin:    pulumi.String("string"),
	LowerCaseTableNames: pulumi.Int(0),
	MaintainTime:        pulumi.String("string"),
	ModifyType:          pulumi.String("string"),
	ParameterGroupId:    pulumi.String("string"),
	Parameters: polardb.ClusterParameterArray{
		&polardb.ClusterParameterArgs{
			Name:  pulumi.String("string"),
			Value: pulumi.String("string"),
		},
	},
	PayType:               pulumi.String("string"),
	Period:                pulumi.Int(0),
	PlannedEndTime:        pulumi.String("string"),
	PlannedStartTime:      pulumi.String("string"),
	ProxyClass:            pulumi.String("string"),
	ProxyType:             pulumi.String("string"),
	RenewalStatus:         pulumi.String("string"),
	ResourceGroupId:       pulumi.String("string"),
	RoleArn:               pulumi.String("string"),
	ScaleApRoNumMax:       pulumi.Int(0),
	ScaleApRoNumMin:       pulumi.Int(0),
	ScaleMax:              pulumi.Int(0),
	ScaleMin:              pulumi.Int(0),
	ScaleRoNumMax:         pulumi.Int(0),
	ScaleRoNumMin:         pulumi.Int(0),
	SecondsUntilAutoPause: pulumi.Int(0),
	SecurityGroupIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	SecurityIps: pulumi.StringArray{
		pulumi.String("string"),
	},
	ServerlessSteadySwitch: pulumi.String("string"),
	ServerlessType:         pulumi.String("string"),
	SourceResourceId:       pulumi.String("string"),
	StoragePayType:         pulumi.String("string"),
	StorageSpace:           pulumi.Int(0),
	StorageType:            pulumi.String("string"),
	SubCategory:            pulumi.String("string"),
	Tags: pulumi.Map{
		"string": pulumi.Any("any"),
	},
	TargetDbRevisionVersionCode: pulumi.String("string"),
	TdeStatus:                   pulumi.String("string"),
	UpgradeType:                 pulumi.String("string"),
	VpcId:                       pulumi.String("string"),
	VswitchId:                   pulumi.String("string"),
	ZoneId:                      pulumi.String("string"),
})

var exampleclusterResourceResourceFromPolardbcluster = new Cluster("exampleclusterResourceResourceFromPolardbcluster", ClusterArgs.builder()
    .dbNodeClass("string")
    .dbType("string")
    .dbVersion("string")
    .allowShutDown("string")
    .autoRenewPeriod(0)
    .backupRetentionPolicyOnClusterDeletion("string")
    .cloneDataPoint("string")
    .collectorStatus("string")
    .creationCategory("string")
    .creationOption("string")
    .dbClusterIpArrays(ClusterDbClusterIpArrayArgs.builder()
        .dbClusterIpArrayName("string")
        .modifyMode("string")
        .securityIps("string")
        .build())
    .dbNodeCount(0)
    .dbNodeId("string")
    .dbNodeNum(0)
    .defaultTimeZone("string")
    .deletionLock(0)
    .description("string")
    .encryptNewTables("string")
    .encryptionKey("string")
    .fromTimeService("string")
    .gdnId("string")
    .hotReplicaMode("string")
    .hotStandbyCluster("string")
    .imciSwitch("string")
    .loosePolarLogBin("string")
    .lowerCaseTableNames(0)
    .maintainTime("string")
    .modifyType("string")
    .parameterGroupId("string")
    .parameters(ClusterParameterArgs.builder()
        .name("string")
        .value("string")
        .build())
    .payType("string")
    .period(0)
    .plannedEndTime("string")
    .plannedStartTime("string")
    .proxyClass("string")
    .proxyType("string")
    .renewalStatus("string")
    .resourceGroupId("string")
    .roleArn("string")
    .scaleApRoNumMax(0)
    .scaleApRoNumMin(0)
    .scaleMax(0)
    .scaleMin(0)
    .scaleRoNumMax(0)
    .scaleRoNumMin(0)
    .secondsUntilAutoPause(0)
    .securityGroupIds("string")
    .securityIps("string")
    .serverlessSteadySwitch("string")
    .serverlessType("string")
    .sourceResourceId("string")
    .storagePayType("string")
    .storageSpace(0)
    .storageType("string")
    .subCategory("string")
    .tags(Map.of("string", "any"))
    .targetDbRevisionVersionCode("string")
    .tdeStatus("string")
    .upgradeType("string")
    .vpcId("string")
    .vswitchId("string")
    .zoneId("string")
    .build());

examplecluster_resource_resource_from_polardbcluster = alicloud.polardb.Cluster("exampleclusterResourceResourceFromPolardbcluster",
    db_node_class="string",
    db_type="string",
    db_version="string",
    allow_shut_down="string",
    auto_renew_period=0,
    backup_retention_policy_on_cluster_deletion="string",
    clone_data_point="string",
    collector_status="string",
    creation_category="string",
    creation_option="string",
    db_cluster_ip_arrays=[alicloud.polardb.ClusterDbClusterIpArrayArgs(
        db_cluster_ip_array_name="string",
        modify_mode="string",
        security_ips=["string"],
    )],
    db_node_count=0,
    db_node_id="string",
    db_node_num=0,
    default_time_zone="string",
    deletion_lock=0,
    description="string",
    encrypt_new_tables="string",
    encryption_key="string",
    from_time_service="string",
    gdn_id="string",
    hot_replica_mode="string",
    hot_standby_cluster="string",
    imci_switch="string",
    loose_polar_log_bin="string",
    lower_case_table_names=0,
    maintain_time="string",
    modify_type="string",
    parameter_group_id="string",
    parameters=[alicloud.polardb.ClusterParameterArgs(
        name="string",
        value="string",
    )],
    pay_type="string",
    period=0,
    planned_end_time="string",
    planned_start_time="string",
    proxy_class="string",
    proxy_type="string",
    renewal_status="string",
    resource_group_id="string",
    role_arn="string",
    scale_ap_ro_num_max=0,
    scale_ap_ro_num_min=0,
    scale_max=0,
    scale_min=0,
    scale_ro_num_max=0,
    scale_ro_num_min=0,
    seconds_until_auto_pause=0,
    security_group_ids=["string"],
    security_ips=["string"],
    serverless_steady_switch="string",
    serverless_type="string",
    source_resource_id="string",
    storage_pay_type="string",
    storage_space=0,
    storage_type="string",
    sub_category="string",
    tags={
        "string": "any",
    },
    target_db_revision_version_code="string",
    tde_status="string",
    upgrade_type="string",
    vpc_id="string",
    vswitch_id="string",
    zone_id="string")

const exampleclusterResourceResourceFromPolardbcluster = new alicloud.polardb.Cluster("exampleclusterResourceResourceFromPolardbcluster", {
    dbNodeClass: "string",
    dbType: "string",
    dbVersion: "string",
    allowShutDown: "string",
    autoRenewPeriod: 0,
    backupRetentionPolicyOnClusterDeletion: "string",
    cloneDataPoint: "string",
    collectorStatus: "string",
    creationCategory: "string",
    creationOption: "string",
    dbClusterIpArrays: [{
        dbClusterIpArrayName: "string",
        modifyMode: "string",
        securityIps: ["string"],
    }],
    dbNodeCount: 0,
    dbNodeId: "string",
    dbNodeNum: 0,
    defaultTimeZone: "string",
    deletionLock: 0,
    description: "string",
    encryptNewTables: "string",
    encryptionKey: "string",
    fromTimeService: "string",
    gdnId: "string",
    hotReplicaMode: "string",
    hotStandbyCluster: "string",
    imciSwitch: "string",
    loosePolarLogBin: "string",
    lowerCaseTableNames: 0,
    maintainTime: "string",
    modifyType: "string",
    parameterGroupId: "string",
    parameters: [{
        name: "string",
        value: "string",
    }],
    payType: "string",
    period: 0,
    plannedEndTime: "string",
    plannedStartTime: "string",
    proxyClass: "string",
    proxyType: "string",
    renewalStatus: "string",
    resourceGroupId: "string",
    roleArn: "string",
    scaleApRoNumMax: 0,
    scaleApRoNumMin: 0,
    scaleMax: 0,
    scaleMin: 0,
    scaleRoNumMax: 0,
    scaleRoNumMin: 0,
    secondsUntilAutoPause: 0,
    securityGroupIds: ["string"],
    securityIps: ["string"],
    serverlessSteadySwitch: "string",
    serverlessType: "string",
    sourceResourceId: "string",
    storagePayType: "string",
    storageSpace: 0,
    storageType: "string",
    subCategory: "string",
    tags: {
        string: "any",
    },
    targetDbRevisionVersionCode: "string",
    tdeStatus: "string",
    upgradeType: "string",
    vpcId: "string",
    vswitchId: "string",
    zoneId: "string",
});

type: alicloud:polardb:Cluster
properties:
    allowShutDown: string
    autoRenewPeriod: 0
    backupRetentionPolicyOnClusterDeletion: string
    cloneDataPoint: string
    collectorStatus: string
    creationCategory: string
    creationOption: string
    dbClusterIpArrays:
        - dbClusterIpArrayName: string
          modifyMode: string
          securityIps:
            - string
    dbNodeClass: string
    dbNodeCount: 0
    dbNodeId: string
    dbNodeNum: 0
    dbType: string
    dbVersion: string
    defaultTimeZone: string
    deletionLock: 0
    description: string
    encryptNewTables: string
    encryptionKey: string
    fromTimeService: string
    gdnId: string
    hotReplicaMode: string
    hotStandbyCluster: string
    imciSwitch: string
    loosePolarLogBin: string
    lowerCaseTableNames: 0
    maintainTime: string
    modifyType: string
    parameterGroupId: string
    parameters:
        - name: string
          value: string
    payType: string
    period: 0
    plannedEndTime: string
    plannedStartTime: string
    proxyClass: string
    proxyType: string
    renewalStatus: string
    resourceGroupId: string
    roleArn: string
    scaleApRoNumMax: 0
    scaleApRoNumMin: 0
    scaleMax: 0
    scaleMin: 0
    scaleRoNumMax: 0
    scaleRoNumMin: 0
    secondsUntilAutoPause: 0
    securityGroupIds:
        - string
    securityIps:
        - string
    serverlessSteadySwitch: string
    serverlessType: string
    sourceResourceId: string
    storagePayType: string
    storageSpace: 0
    storageType: string
    subCategory: string
    tags:
        string: any
    targetDbRevisionVersionCode: string
    tdeStatus: string
    upgradeType: string
    vpcId: string
    vswitchId: string
    zoneId: string

Cluster Resource Properties

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

Inputs

The Cluster resource accepts the following input properties:

DbNodeClass string

The db_node_class of cluster node.

NOTE: Node specifications are divided into cluster version, single node version and History Library version. They can't change each other, but the general specification and exclusive specification of cluster version can be changed. From version 1.204.0, If you need to create a Serverless cluster, db_node_class can be set to polar.mysql.sl.small.

DbType string

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

DbVersion string

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

AllowShutDown string

Specifies whether to enable the no-activity suspension feature. Default value: false. Valid values are true, false. This parameter is valid only for serverless clusters.

AutoRenewPeriod int

Auto-renewal period of an cluster, in the unit of the month. It is valid when pay_type is PrePaid. Valid value:1, 2, 3, 6, 12, 24, 36, Default to 1.

BackupRetentionPolicyOnClusterDeletion string

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

CloneDataPoint string

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

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

CollectorStatus string

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

CreationCategory string

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

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

CreationOption string

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

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

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

db_cluster_ip_array defines how users can send requests to your API. See db_cluster_ip_array below.

DbNodeCount int

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

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

DbNodeId string

The ID of the node or node subscript. Node subscript values: 1 to 15.

DbNodeNum int

The number of Standard Edition nodes. Default value: 1. Valid values are 1, 2.

DefaultTimeZone string

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.

DeletionLock int

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

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

Description string

The description of cluster.

EncryptNewTables string

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

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

EncryptionKey string

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

FromTimeService string

Immediate or scheduled kernel version upgrade. Valid values are true, false. True means immediate execution, False means scheduled execution.

GdnId string

The ID of the global database network (GDN).

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

HotReplicaMode string

Indicates whether the hot standby feature is enabled. Valid values are ON, OFF. Only MySQL supports.

HotStandbyCluster string

Whether to enable the hot standby cluster. Valid values are ON, OFF. Only MySQL supports.

ImciSwitch string

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

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

LoosePolarLogBin string

Enable the Binlog function. Default value: OFF. Valid values are OFF, ON.

NOTE: This parameter is valid only MySQL Engine supports.

LowerCaseTableNames int

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.

MaintainTime string

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

ModifyType string

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

ParameterGroupId string

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.AliCloud.PolarDB.Inputs.ClusterParameter>

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.

PayType string

Valid values are PrePaid, PostPaid, Default to PostPaid.

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 running pulumi up will not effect the resource.

PlannedEndTime string

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.

PlannedStartTime string

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.

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

ProxyType string

The type of PolarProxy. Default value: OFF. Valid values are OFF, EXCLUSIVE GENERAL.

NOTE: This parameter is valid only for standard clusters.

RenewalStatus string

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

ResourceGroupId string

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

RoleArn string

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

ScaleApRoNumMax int

Number of Read-only Columnar Nodes. Valid values: 0 to 7. This parameter is valid only for serverless clusters. This parameter is required when there are column nodes that support steady-state serverless.

ScaleApRoNumMin int

ScaleMax int

The maximum number of PCUs per node for scaling. Valid values: 1 PCU to 32 PCUs. It is valid when serverless_type is AgileServerless. Valid values: 1 PCU to 8 PCUs.It is valid when serverless_type is SteadyServerless. This parameter is valid only for serverless clusters.

ScaleMin int

The minimum number of PCUs per node for scaling. Valid values: 1 PCU to 31 PCUs. It is valid when serverless_type is AgileServerless. Valid values: 1 PCU to 8 PCUs.It is valid when serverless_type is SteadyServerless.· This parameter is valid only for serverless clusters.

ScaleRoNumMax int

The maximum number of read-only nodes for scaling. Valid values: 0 to 15. It is valid when serverless_type is AgileServerless. Valid values: 0 to 7. It is valid when serverless_type is SteadyServerless. This parameter is valid only for serverless clusters.

ScaleRoNumMin int

The minimum number of read-only nodes for scaling. Valid values: 0 to 15 . It is valid when serverless_type is AgileServerless. Valid values: 0 to 7 .It is valid when serverless_type is SteadyServerless. This parameter is valid only for serverless clusters.

SecondsUntilAutoPause int

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. This parameter is valid only for serverless clusters.

SecurityGroupIds List<string>

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

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

SecurityIps List<string>

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

ServerlessSteadySwitch string

Serverless steady-state switch. Valid values are ON, OFF. This parameter is valid only for serverless clusters.

NOTE: When serverless_steady_switch is ON and serverless_type is SteadyServerless, parameters scale_min, scale_max, scale_ro_num_min and scale_ro_num_max are all required.

ServerlessType string

The type of the serverless cluster. Valid values AgileServerless, SteadyServerless. This parameter is valid only for serverless clusters.

SourceResourceId string

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

StoragePayType string

The billing method of the storage. Valid values Postpaid, Prepaid.

StorageSpace int

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

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

StorageType string

The storage type of the cluster. Enterprise storage type values are PSL5, PSL4. The standard version storage type values are ESSDPL1, ESSDPL2, ESSDPL3. The standard version only supports MySQL.

NOTE: Serverless cluster does not support this parameter.

SubCategory string

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

Tags Dictionary<string, object>

A mapping of tags to assign to the resource.

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

TargetDbRevisionVersionCode string

The Version Code of the target version, whose parameter values can be obtained from the DescribeDBClusterVersion interface.

TdeStatus string

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

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

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

VpcId string

The id of the VPC.

VswitchId string

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

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

ZoneId string

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

DbNodeClass string

The db_node_class of cluster node.

NOTE: Node specifications are divided into cluster version, single node version and History Library version. They can't change each other, but the general specification and exclusive specification of cluster version can be changed. From version 1.204.0, If you need to create a Serverless cluster, db_node_class can be set to polar.mysql.sl.small.

DbType string

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

DbVersion string

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

AllowShutDown string

Specifies whether to enable the no-activity suspension feature. Default value: false. Valid values are true, false. This parameter is valid only for serverless clusters.

AutoRenewPeriod int

Auto-renewal period of an cluster, in the unit of the month. It is valid when pay_type is PrePaid. Valid value:1, 2, 3, 6, 12, 24, 36, Default to 1.

BackupRetentionPolicyOnClusterDeletion string

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

CloneDataPoint string

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

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

CollectorStatus string

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

CreationCategory string

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

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

CreationOption string

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

DbClusterIpArrays []ClusterDbClusterIpArrayArgs

db_cluster_ip_array defines how users can send requests to your API. See db_cluster_ip_array below.

DbNodeCount int

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

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

DbNodeId string

The ID of the node or node subscript. Node subscript values: 1 to 15.

DbNodeNum int

The number of Standard Edition nodes. Default value: 1. Valid values are 1, 2.

DefaultTimeZone string

NOTE: This parameter is valid only when the DBType parameter is set to MySQL.

DeletionLock int

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

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

Description string

The description of cluster.

EncryptNewTables string

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

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

EncryptionKey string

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

FromTimeService string

Immediate or scheduled kernel version upgrade. Valid values are true, false. True means immediate execution, False means scheduled execution.

GdnId string

The ID of the global database network (GDN).

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

HotReplicaMode string

Indicates whether the hot standby feature is enabled. Valid values are ON, OFF. Only MySQL supports.

HotStandbyCluster string

Whether to enable the hot standby cluster. Valid values are ON, OFF. Only MySQL supports.

ImciSwitch string

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

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

LoosePolarLogBin string

Enable the Binlog function. Default value: OFF. Valid values are OFF, ON.

NOTE: This parameter is valid only MySQL Engine supports.

LowerCaseTableNames int

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.

MaintainTime string

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

ModifyType string

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

ParameterGroupId string

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 []ClusterParameterArgs

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

PayType string

Valid values are PrePaid, PostPaid, Default to PostPaid.

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 running pulumi up will not effect the resource.

PlannedEndTime string

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.

PlannedStartTime string

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.

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

ProxyType string

The type of PolarProxy. Default value: OFF. Valid values are OFF, EXCLUSIVE GENERAL.

NOTE: This parameter is valid only for standard clusters.

RenewalStatus string

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

ResourceGroupId string

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

RoleArn string

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

ScaleApRoNumMax int

ScaleApRoNumMin int

ScaleMax int

ScaleMin int

ScaleRoNumMax int

ScaleRoNumMin int

SecondsUntilAutoPause int

SecurityGroupIds []string

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

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

SecurityIps []string

ServerlessSteadySwitch string

Serverless steady-state switch. Valid values are ON, OFF. This parameter is valid only for serverless clusters.

NOTE: When serverless_steady_switch is ON and serverless_type is SteadyServerless, parameters scale_min, scale_max, scale_ro_num_min and scale_ro_num_max are all required.

ServerlessType string

The type of the serverless cluster. Valid values AgileServerless, SteadyServerless. This parameter is valid only for serverless clusters.

SourceResourceId string

StoragePayType string

The billing method of the storage. Valid values Postpaid, Prepaid.

StorageSpace int

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

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

StorageType string

NOTE: Serverless cluster does not support this parameter.

SubCategory string

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

Tags map[string]interface{}

A mapping of tags to assign to the resource.

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

TargetDbRevisionVersionCode string

The Version Code of the target version, whose parameter values can be obtained from the DescribeDBClusterVersion interface.

TdeStatus string

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

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

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

VpcId string

The id of the VPC.

VswitchId string

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

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

ZoneId string

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

dbNodeClass String

The db_node_class of cluster node.

NOTE: Node specifications are divided into cluster version, single node version and History Library version. They can't change each other, but the general specification and exclusive specification of cluster version can be changed. From version 1.204.0, If you need to create a Serverless cluster, db_node_class can be set to polar.mysql.sl.small.

dbType String

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

dbVersion String

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

allowShutDown String

Specifies whether to enable the no-activity suspension feature. Default value: false. Valid values are true, false. This parameter is valid only for serverless clusters.

autoRenewPeriod Integer

Auto-renewal period of an cluster, in the unit of the month. It is valid when pay_type is PrePaid. Valid value:1, 2, 3, 6, 12, 24, 36, Default to 1.

backupRetentionPolicyOnClusterDeletion String

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

cloneDataPoint String

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

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

collectorStatus String

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

creationCategory String

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

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

creationOption String

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

dbClusterIpArrays List<ClusterDbClusterIpArray>

db_cluster_ip_array defines how users can send requests to your API. See db_cluster_ip_array below.

dbNodeCount Integer

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

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

dbNodeId String

The ID of the node or node subscript. Node subscript values: 1 to 15.

dbNodeNum Integer

The number of Standard Edition nodes. Default value: 1. Valid values are 1, 2.

defaultTimeZone String

NOTE: This parameter is valid only when the DBType parameter is set to MySQL.

deletionLock Integer

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

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

description String

The description of cluster.

encryptNewTables String

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

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

encryptionKey String

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

fromTimeService String

Immediate or scheduled kernel version upgrade. Valid values are true, false. True means immediate execution, False means scheduled execution.

gdnId String

The ID of the global database network (GDN).

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

hotReplicaMode String

Indicates whether the hot standby feature is enabled. Valid values are ON, OFF. Only MySQL supports.

hotStandbyCluster String

Whether to enable the hot standby cluster. Valid values are ON, OFF. Only MySQL supports.

imciSwitch String

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

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

loosePolarLogBin String

Enable the Binlog function. Default value: OFF. Valid values are OFF, ON.

NOTE: This parameter is valid only MySQL Engine supports.

lowerCaseTableNames Integer

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.

maintainTime String

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

modifyType String

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

parameterGroupId String

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<ClusterParameter>

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.

payType String

Valid values are PrePaid, PostPaid, Default to PostPaid.

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 running pulumi up will not effect the resource.

plannedEndTime String

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.

plannedStartTime String

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.

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

proxyType String

The type of PolarProxy. Default value: OFF. Valid values are OFF, EXCLUSIVE GENERAL.

NOTE: This parameter is valid only for standard clusters.

renewalStatus String

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

resourceGroupId String

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

roleArn String

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

scaleApRoNumMax Integer

scaleApRoNumMin Integer

scaleMax Integer

scaleMin Integer

scaleRoNumMax Integer

scaleRoNumMin Integer

secondsUntilAutoPause Integer

securityGroupIds List<String>

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

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

securityIps List<String>

serverlessSteadySwitch String

Serverless steady-state switch. Valid values are ON, OFF. This parameter is valid only for serverless clusters.

NOTE: When serverless_steady_switch is ON and serverless_type is SteadyServerless, parameters scale_min, scale_max, scale_ro_num_min and scale_ro_num_max are all required.

serverlessType String

The type of the serverless cluster. Valid values AgileServerless, SteadyServerless. This parameter is valid only for serverless clusters.

sourceResourceId String

storagePayType String

The billing method of the storage. Valid values Postpaid, Prepaid.

storageSpace Integer

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

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

storageType String

NOTE: Serverless cluster does not support this parameter.

subCategory String

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

tags Map<String,Object>

A mapping of tags to assign to the resource.

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

targetDbRevisionVersionCode String

The Version Code of the target version, whose parameter values can be obtained from the DescribeDBClusterVersion interface.

tdeStatus String

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

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

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

vpcId String

The id of the VPC.

vswitchId String

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

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

zoneId String

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

dbNodeClass string

The db_node_class of cluster node.

NOTE: Node specifications are divided into cluster version, single node version and History Library version. They can't change each other, but the general specification and exclusive specification of cluster version can be changed. From version 1.204.0, If you need to create a Serverless cluster, db_node_class can be set to polar.mysql.sl.small.

dbType string

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

dbVersion string

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

allowShutDown string

Specifies whether to enable the no-activity suspension feature. Default value: false. Valid values are true, false. This parameter is valid only for serverless clusters.

autoRenewPeriod number

Auto-renewal period of an cluster, in the unit of the month. It is valid when pay_type is PrePaid. Valid value:1, 2, 3, 6, 12, 24, 36, Default to 1.

backupRetentionPolicyOnClusterDeletion string

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

cloneDataPoint string

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

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

collectorStatus string

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

creationCategory string

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

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

creationOption string

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

dbClusterIpArrays ClusterDbClusterIpArray[]

db_cluster_ip_array defines how users can send requests to your API. See db_cluster_ip_array below.

dbNodeCount number

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

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

dbNodeId string

The ID of the node or node subscript. Node subscript values: 1 to 15.

dbNodeNum number

The number of Standard Edition nodes. Default value: 1. Valid values are 1, 2.

defaultTimeZone string

NOTE: This parameter is valid only when the DBType parameter is set to MySQL.

deletionLock number

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

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

description string

The description of cluster.

encryptNewTables string

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

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

encryptionKey string

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

fromTimeService string

Immediate or scheduled kernel version upgrade. Valid values are true, false. True means immediate execution, False means scheduled execution.

gdnId string

The ID of the global database network (GDN).

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

hotReplicaMode string

Indicates whether the hot standby feature is enabled. Valid values are ON, OFF. Only MySQL supports.

hotStandbyCluster string

Whether to enable the hot standby cluster. Valid values are ON, OFF. Only MySQL supports.

imciSwitch string

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

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

loosePolarLogBin string

Enable the Binlog function. Default value: OFF. Valid values are OFF, ON.

NOTE: This parameter is valid only MySQL Engine supports.

lowerCaseTableNames number

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.

maintainTime string

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

modifyType string

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

parameterGroupId string

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 ClusterParameter[]

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.

payType string

Valid values are PrePaid, PostPaid, Default to PostPaid.

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 running pulumi up will not effect the resource.

plannedEndTime string

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.

plannedStartTime string

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.

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

proxyType string

The type of PolarProxy. Default value: OFF. Valid values are OFF, EXCLUSIVE GENERAL.

NOTE: This parameter is valid only for standard clusters.

renewalStatus string

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

resourceGroupId string

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

roleArn string

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

scaleApRoNumMax number

scaleApRoNumMin number

scaleMax number

scaleMin number

scaleRoNumMax number

scaleRoNumMin number

secondsUntilAutoPause number

securityGroupIds string[]

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

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

securityIps string[]

serverlessSteadySwitch string

Serverless steady-state switch. Valid values are ON, OFF. This parameter is valid only for serverless clusters.

NOTE: When serverless_steady_switch is ON and serverless_type is SteadyServerless, parameters scale_min, scale_max, scale_ro_num_min and scale_ro_num_max are all required.

serverlessType string

The type of the serverless cluster. Valid values AgileServerless, SteadyServerless. This parameter is valid only for serverless clusters.

sourceResourceId string

storagePayType string

The billing method of the storage. Valid values Postpaid, Prepaid.

storageSpace number

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

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

storageType string

NOTE: Serverless cluster does not support this parameter.

subCategory string

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

tags {[key: string]: any}

A mapping of tags to assign to the resource.

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

targetDbRevisionVersionCode string

The Version Code of the target version, whose parameter values can be obtained from the DescribeDBClusterVersion interface.

tdeStatus string

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

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

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

vpcId string

The id of the VPC.

vswitchId string

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

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

zoneId string

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

db_node_class str

The db_node_class of cluster node.

NOTE: Node specifications are divided into cluster version, single node version and History Library version. They can't change each other, but the general specification and exclusive specification of cluster version can be changed. From version 1.204.0, If you need to create a Serverless cluster, db_node_class can be set to polar.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_down str

Specifies whether to enable the no-activity suspension feature. Default value: false. Valid values are true, false. This parameter is valid only for serverless clusters.

auto_renew_period int

Auto-renewal period of an cluster, in the unit of the month. It is valid when pay_type is PrePaid. Valid value:1, 2, 3, 6, 12, 24, 36, Default to 1.

backup_retention_policy_on_cluster_deletion str

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

clone_data_point str

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

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

collector_status str

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

creation_category str

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

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

creation_option str

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

db_cluster_ip_arrays Sequence[ClusterDbClusterIpArrayArgs]

db_cluster_ip_array defines how users can send requests to your API. See db_cluster_ip_array below.

db_node_count int

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

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

db_node_id str

The ID of the node or node subscript. Node subscript values: 1 to 15.

db_node_num int

The number of Standard Edition nodes. Default value: 1. Valid values are 1, 2.

default_time_zone str

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 is Prepaid .deletion_lock the cluster protection lock can be turned on or off when pay_type is Postpaid.

description str

The description of cluster.

encrypt_new_tables str

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

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

encryption_key str

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

from_time_service str

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

Indicates whether the hot standby feature is enabled. Valid values are ON, OFF. Only MySQL supports.

hot_standby_cluster str

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

Enable the Binlog function. Default value: OFF. Valid values are OFF, ON.

NOTE: This parameter is valid only MySQL Engine supports.

lower_case_table_names int

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 are Upgrade, Downgrade, Default to Upgrade.

parameter_group_id str

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[ClusterParameterArgs]

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

pay_type str

Valid values are PrePaid, PostPaid, Default to PostPaid.

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 running pulumi up will not effect the resource.

planned_end_time str

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

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 to NotRenewal.

resource_group_id str

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

role_arn str

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

scale_ap_ro_num_max int

scale_ap_ro_num_min int

scale_max int

scale_min int

scale_ro_num_max int

scale_ro_num_min int

seconds_until_auto_pause int

security_group_ids Sequence[str]

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

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

security_ips Sequence[str]

serverless_steady_switch str

Serverless steady-state switch. Valid values are ON, OFF. This parameter is valid only for serverless clusters.

NOTE: When serverless_steady_switch is ON and serverless_type is SteadyServerless, parameters scale_min, scale_max, scale_ro_num_min and scale_ro_num_max are all required.

serverless_type str

The type of the serverless cluster. Valid values AgileServerless, SteadyServerless. This parameter is valid only for serverless clusters.

source_resource_id str

storage_pay_type str

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 is PrePaid.

storage_type str

NOTE: Serverless cluster does not support this parameter.

sub_category str

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

tags Mapping[str, Any]

A mapping of tags to assign to the resource.

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

target_db_revision_version_code str

The Version Code of the target version, whose parameter values can be obtained from the DescribeDBClusterVersion interface.

tde_status str

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

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

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.

dbNodeClass String

The db_node_class of cluster node.

NOTE: Node specifications are divided into cluster version, single node version and History Library version. They can't change each other, but the general specification and exclusive specification of cluster version can be changed. From version 1.204.0, If you need to create a Serverless cluster, db_node_class can be set to polar.mysql.sl.small.

dbType String

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

dbVersion String

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

allowShutDown String

Specifies whether to enable the no-activity suspension feature. Default value: false. Valid values are true, false. This parameter is valid only for serverless clusters.

autoRenewPeriod Number

Auto-renewal period of an cluster, in the unit of the month. It is valid when pay_type is PrePaid. Valid value:1, 2, 3, 6, 12, 24, 36, Default to 1.

backupRetentionPolicyOnClusterDeletion String

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

cloneDataPoint String

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

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

collectorStatus String

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

creationCategory String

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

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

creationOption String

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

dbClusterIpArrays List<Property Map>

db_cluster_ip_array defines how users can send requests to your API. See db_cluster_ip_array below.

dbNodeCount Number

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

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

dbNodeId String

The ID of the node or node subscript. Node subscript values: 1 to 15.

dbNodeNum Number

The number of Standard Edition nodes. Default value: 1. Valid values are 1, 2.

defaultTimeZone String

NOTE: This parameter is valid only when the DBType parameter is set to MySQL.

deletionLock Number

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

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

description String

The description of cluster.

encryptNewTables String

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

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

encryptionKey String

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

fromTimeService String

Immediate or scheduled kernel version upgrade. Valid values are true, false. True means immediate execution, False means scheduled execution.

gdnId String

The ID of the global database network (GDN).

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

hotReplicaMode String

Indicates whether the hot standby feature is enabled. Valid values are ON, OFF. Only MySQL supports.

hotStandbyCluster String

Whether to enable the hot standby cluster. Valid values are ON, OFF. Only MySQL supports.

imciSwitch String

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

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

loosePolarLogBin String

Enable the Binlog function. Default value: OFF. Valid values are OFF, ON.

NOTE: This parameter is valid only MySQL Engine supports.

lowerCaseTableNames Number

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.

maintainTime String

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

modifyType String

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

parameterGroupId String

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.

payType String

Valid values are PrePaid, PostPaid, Default to PostPaid.

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 running pulumi up will not effect the resource.

plannedEndTime String

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.

plannedStartTime String

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.

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

proxyType String

The type of PolarProxy. Default value: OFF. Valid values are OFF, EXCLUSIVE GENERAL.

NOTE: This parameter is valid only for standard clusters.

renewalStatus String

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

resourceGroupId String

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

roleArn String

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

scaleApRoNumMax Number

scaleApRoNumMin Number

scaleMax Number

scaleMin Number

scaleRoNumMax Number

scaleRoNumMin Number

secondsUntilAutoPause Number

securityGroupIds List<String>

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

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

securityIps List<String>

serverlessSteadySwitch String

Serverless steady-state switch. Valid values are ON, OFF. This parameter is valid only for serverless clusters.

NOTE: When serverless_steady_switch is ON and serverless_type is SteadyServerless, parameters scale_min, scale_max, scale_ro_num_min and scale_ro_num_max are all required.

serverlessType String

The type of the serverless cluster. Valid values AgileServerless, SteadyServerless. This parameter is valid only for serverless clusters.

sourceResourceId String

storagePayType String

The billing method of the storage. Valid values Postpaid, Prepaid.

storageSpace Number

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

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

storageType String

NOTE: Serverless cluster does not support this parameter.

subCategory String

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

tags Map<Any>

A mapping of tags to assign to the resource.

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

targetDbRevisionVersionCode String

The Version Code of the target version, whose parameter values can be obtained from the DescribeDBClusterVersion interface.

tdeStatus String

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

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

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

vpcId String

The id of the VPC.

vswitchId String

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

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

zoneId String

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

Outputs

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

ConnectionString string: (Available since 1.81.0) PolarDB cluster connection string.
CreateTime string: (Available since 1.204.1) PolarDB cluster creation time.
DbRevisionVersionLists List<Pulumi.AliCloud.PolarDB.Outputs.ClusterDbRevisionVersionList>: (Available since v1.216.0) The db_revision_version_list supports the following:
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.
TdeRegion 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.

ConnectionString string: (Available since 1.81.0) PolarDB cluster connection string.
CreateTime string: (Available since 1.204.1) PolarDB cluster creation time.
DbRevisionVersionLists []ClusterDbRevisionVersionList: (Available since v1.216.0) The db_revision_version_list supports the following:
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.
TdeRegion 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.

connectionString String: (Available since 1.81.0) PolarDB cluster connection string.
createTime String: (Available since 1.204.1) PolarDB cluster creation time.
dbRevisionVersionLists List<ClusterDbRevisionVersionList>: (Available since v1.216.0) The db_revision_version_list supports the following:
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.
tdeRegion 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.

connectionString string: (Available since 1.81.0) PolarDB cluster connection string.
createTime string: (Available since 1.204.1) PolarDB cluster creation time.
dbRevisionVersionLists ClusterDbRevisionVersionList[]: (Available since v1.216.0) The db_revision_version_list supports the following:
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.
tdeRegion 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.
db_revision_version_lists Sequence[ClusterDbRevisionVersionList]: (Available since v1.216.0) The db_revision_version_list supports the following:
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.

connectionString String: (Available since 1.81.0) PolarDB cluster connection string.
createTime String: (Available since 1.204.1) PolarDB cluster creation time.
dbRevisionVersionLists List<Property Map>: (Available since v1.216.0) The db_revision_version_list supports the following:
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.
tdeRegion 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_id: Optional[str] = None,
        db_node_num: Optional[int] = None,
        db_revision_version_lists: Optional[Sequence[ClusterDbRevisionVersionListArgs]] = 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_replica_mode: 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_ap_ro_num_max: Optional[int] = None,
        scale_ap_ro_num_min: Optional[int] = 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_steady_switch: Optional[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,
        target_db_revision_version_code: Optional[str] = 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.

The following state arguments are supported:

AllowShutDown string

Specifies whether to enable the no-activity suspension feature. Default value: false. Valid values are true, false. This parameter is valid only for serverless clusters.

AutoRenewPeriod int

Auto-renewal period of an cluster, in the unit of the month. It is valid when pay_type is PrePaid. Valid value:1, 2, 3, 6, 12, 24, 36, Default to 1.

BackupRetentionPolicyOnClusterDeletion string

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

CloneDataPoint string

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

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

CollectorStatus string

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

ConnectionString string

(Available since 1.81.0) PolarDB cluster connection string.

CreateTime string

(Available since 1.204.1) PolarDB cluster creation time.

CreationCategory string

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

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

CreationOption string

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

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

db_cluster_ip_array defines how users can send requests to your API. See db_cluster_ip_array below.

DbNodeClass string

The db_node_class of cluster node.

NOTE: Node specifications are divided into cluster version, single node version and History Library version. They can't change each other, but the general specification and exclusive specification of cluster version can be changed. From version 1.204.0, If you need to create a Serverless cluster, db_node_class can be set to polar.mysql.sl.small.

DbNodeCount int

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

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

DbNodeId string

The ID of the node or node subscript. Node subscript values: 1 to 15.

DbNodeNum int

The number of Standard Edition nodes. Default value: 1. Valid values are 1, 2.

DbRevisionVersionLists List<Pulumi.AliCloud.PolarDB.Inputs.ClusterDbRevisionVersionList>

(Available since v1.216.0) The db_revision_version_list supports the following:

DbType string

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

DbVersion string

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

DefaultTimeZone string

NOTE: This parameter is valid only when the DBType parameter is set to MySQL.

DeletionLock int

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

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

Description string

The description of cluster.

EncryptNewTables string

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

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

EncryptionKey string

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

FromTimeService string

Immediate or scheduled kernel version upgrade. Valid values are true, false. True means immediate execution, False means scheduled execution.

GdnId string

The ID of the global database network (GDN).

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

HotReplicaMode string

Indicates whether the hot standby feature is enabled. Valid values are ON, OFF. Only MySQL supports.

HotStandbyCluster string

Whether to enable the hot standby cluster. Valid values are ON, OFF. Only MySQL supports.

ImciSwitch string

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

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

LoosePolarLogBin string

Enable the Binlog function. Default value: OFF. Valid values are OFF, ON.

NOTE: This parameter is valid only MySQL Engine supports.

LowerCaseTableNames int

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.

MaintainTime string

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

ModifyType string

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

ParameterGroupId string

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.AliCloud.PolarDB.Inputs.ClusterParameter>

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.

PayType string

Valid values are PrePaid, PostPaid, Default to PostPaid.

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 running pulumi up will not effect the resource.

PlannedEndTime string

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.

PlannedStartTime string

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.

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

ProxyType string

The type of PolarProxy. Default value: OFF. Valid values are OFF, EXCLUSIVE GENERAL.

NOTE: This parameter is valid only for standard clusters.

RenewalStatus string

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

ResourceGroupId string

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

RoleArn string

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

ScaleApRoNumMax int

ScaleApRoNumMin int

ScaleMax int

ScaleMin int

ScaleRoNumMax int

ScaleRoNumMin int

SecondsUntilAutoPause int

SecurityGroupIds List<string>

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

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

SecurityIps List<string>

ServerlessSteadySwitch string

Serverless steady-state switch. Valid values are ON, OFF. This parameter is valid only for serverless clusters.

NOTE: When serverless_steady_switch is ON and serverless_type is SteadyServerless, parameters scale_min, scale_max, scale_ro_num_min and scale_ro_num_max are all required.

ServerlessType string

The type of the serverless cluster. Valid values AgileServerless, SteadyServerless. This parameter is valid only for serverless clusters.

SourceResourceId string

Status string

(Available since 1.204.1) PolarDB cluster status.

StoragePayType string

The billing method of the storage. Valid values Postpaid, Prepaid.

StorageSpace int

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

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

StorageType string

NOTE: Serverless cluster does not support this parameter.

SubCategory string

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

Tags Dictionary<string, object>

A mapping of tags to assign to the resource.

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

TargetDbRevisionVersionCode string

The Version Code of the target version, whose parameter values can be obtained from the DescribeDBClusterVersion interface.

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

TdeStatus string

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

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

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

VpcId string

The id of the VPC.

VswitchId string

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

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

ZoneId string

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

AllowShutDown string

Specifies whether to enable the no-activity suspension feature. Default value: false. Valid values are true, false. This parameter is valid only for serverless clusters.

AutoRenewPeriod int

Auto-renewal period of an cluster, in the unit of the month. It is valid when pay_type is PrePaid. Valid value:1, 2, 3, 6, 12, 24, 36, Default to 1.

BackupRetentionPolicyOnClusterDeletion string

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

CloneDataPoint string

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

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

CollectorStatus string

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

ConnectionString string

(Available since 1.81.0) PolarDB cluster connection string.

CreateTime string

(Available since 1.204.1) PolarDB cluster creation time.

CreationCategory string

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

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

CreationOption string

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

DbClusterIpArrays []ClusterDbClusterIpArrayArgs

db_cluster_ip_array defines how users can send requests to your API. See db_cluster_ip_array below.

DbNodeClass string

The db_node_class of cluster node.

NOTE: Node specifications are divided into cluster version, single node version and History Library version. They can't change each other, but the general specification and exclusive specification of cluster version can be changed. From version 1.204.0, If you need to create a Serverless cluster, db_node_class can be set to polar.mysql.sl.small.

DbNodeCount int

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

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

DbNodeId string

The ID of the node or node subscript. Node subscript values: 1 to 15.

DbNodeNum int

The number of Standard Edition nodes. Default value: 1. Valid values are 1, 2.

DbRevisionVersionLists []ClusterDbRevisionVersionListArgs

(Available since v1.216.0) The db_revision_version_list supports the following:

DbType string

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

DbVersion string

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

DefaultTimeZone string

NOTE: This parameter is valid only when the DBType parameter is set to MySQL.

DeletionLock int

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

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

Description string

The description of cluster.

EncryptNewTables string

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

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

EncryptionKey string

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

FromTimeService string

Immediate or scheduled kernel version upgrade. Valid values are true, false. True means immediate execution, False means scheduled execution.

GdnId string

The ID of the global database network (GDN).

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

HotReplicaMode string

Indicates whether the hot standby feature is enabled. Valid values are ON, OFF. Only MySQL supports.

HotStandbyCluster string

Whether to enable the hot standby cluster. Valid values are ON, OFF. Only MySQL supports.

ImciSwitch string

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

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

LoosePolarLogBin string

Enable the Binlog function. Default value: OFF. Valid values are OFF, ON.

NOTE: This parameter is valid only MySQL Engine supports.

LowerCaseTableNames int

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.

MaintainTime string

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

ModifyType string

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

ParameterGroupId string

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 []ClusterParameterArgs

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

PayType string

Valid values are PrePaid, PostPaid, Default to PostPaid.

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 running pulumi up will not effect the resource.

PlannedEndTime string

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.

PlannedStartTime string

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.

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

ProxyType string

The type of PolarProxy. Default value: OFF. Valid values are OFF, EXCLUSIVE GENERAL.

NOTE: This parameter is valid only for standard clusters.

RenewalStatus string

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

ResourceGroupId string

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

RoleArn string

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

ScaleApRoNumMax int

ScaleApRoNumMin int

ScaleMax int

ScaleMin int

ScaleRoNumMax int

ScaleRoNumMin int

SecondsUntilAutoPause int

SecurityGroupIds []string

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

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

SecurityIps []string

ServerlessSteadySwitch string

Serverless steady-state switch. Valid values are ON, OFF. This parameter is valid only for serverless clusters.

NOTE: When serverless_steady_switch is ON and serverless_type is SteadyServerless, parameters scale_min, scale_max, scale_ro_num_min and scale_ro_num_max are all required.

ServerlessType string

The type of the serverless cluster. Valid values AgileServerless, SteadyServerless. This parameter is valid only for serverless clusters.

SourceResourceId string

Status string

(Available since 1.204.1) PolarDB cluster status.

StoragePayType string

The billing method of the storage. Valid values Postpaid, Prepaid.

StorageSpace int

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

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

StorageType string

NOTE: Serverless cluster does not support this parameter.

SubCategory string

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

Tags map[string]interface{}

A mapping of tags to assign to the resource.

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

TargetDbRevisionVersionCode string

The Version Code of the target version, whose parameter values can be obtained from the DescribeDBClusterVersion interface.

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

TdeStatus string

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

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

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

VpcId string

The id of the VPC.

VswitchId string

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

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

ZoneId string

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

allowShutDown String

Specifies whether to enable the no-activity suspension feature. Default value: false. Valid values are true, false. This parameter is valid only for serverless clusters.

autoRenewPeriod Integer

Auto-renewal period of an cluster, in the unit of the month. It is valid when pay_type is PrePaid. Valid value:1, 2, 3, 6, 12, 24, 36, Default to 1.

backupRetentionPolicyOnClusterDeletion String

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

cloneDataPoint String

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

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

collectorStatus String

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

connectionString String

(Available since 1.81.0) PolarDB cluster connection string.

createTime String

(Available since 1.204.1) PolarDB cluster creation time.

creationCategory String

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

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

creationOption String

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

dbClusterIpArrays List<ClusterDbClusterIpArray>

db_cluster_ip_array defines how users can send requests to your API. See db_cluster_ip_array below.

dbNodeClass String

The db_node_class of cluster node.

NOTE: Node specifications are divided into cluster version, single node version and History Library version. They can't change each other, but the general specification and exclusive specification of cluster version can be changed. From version 1.204.0, If you need to create a Serverless cluster, db_node_class can be set to polar.mysql.sl.small.

dbNodeCount Integer

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

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

dbNodeId String

The ID of the node or node subscript. Node subscript values: 1 to 15.

dbNodeNum Integer

The number of Standard Edition nodes. Default value: 1. Valid values are 1, 2.

dbRevisionVersionLists List<ClusterDbRevisionVersionList>

(Available since v1.216.0) The db_revision_version_list supports the following:

dbType String

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

dbVersion String

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

defaultTimeZone String

NOTE: This parameter is valid only when the DBType parameter is set to MySQL.

deletionLock Integer

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

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

description String

The description of cluster.

encryptNewTables String

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

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

encryptionKey String

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

fromTimeService String

Immediate or scheduled kernel version upgrade. Valid values are true, false. True means immediate execution, False means scheduled execution.

gdnId String

The ID of the global database network (GDN).

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

hotReplicaMode String

Indicates whether the hot standby feature is enabled. Valid values are ON, OFF. Only MySQL supports.

hotStandbyCluster String

Whether to enable the hot standby cluster. Valid values are ON, OFF. Only MySQL supports.

imciSwitch String

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

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

loosePolarLogBin String

Enable the Binlog function. Default value: OFF. Valid values are OFF, ON.

NOTE: This parameter is valid only MySQL Engine supports.

lowerCaseTableNames Integer

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.

maintainTime String

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

modifyType String

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

parameterGroupId String

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<ClusterParameter>

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.

payType String

Valid values are PrePaid, PostPaid, Default to PostPaid.

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 running pulumi up will not effect the resource.

plannedEndTime String

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.

plannedStartTime String

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.

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

proxyType String

The type of PolarProxy. Default value: OFF. Valid values are OFF, EXCLUSIVE GENERAL.

NOTE: This parameter is valid only for standard clusters.

renewalStatus String

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

resourceGroupId String

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

roleArn String

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

scaleApRoNumMax Integer

scaleApRoNumMin Integer

scaleMax Integer

scaleMin Integer

scaleRoNumMax Integer

scaleRoNumMin Integer

secondsUntilAutoPause Integer

securityGroupIds List<String>

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

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

securityIps List<String>

serverlessSteadySwitch String

Serverless steady-state switch. Valid values are ON, OFF. This parameter is valid only for serverless clusters.

NOTE: When serverless_steady_switch is ON and serverless_type is SteadyServerless, parameters scale_min, scale_max, scale_ro_num_min and scale_ro_num_max are all required.

serverlessType String

The type of the serverless cluster. Valid values AgileServerless, SteadyServerless. This parameter is valid only for serverless clusters.

sourceResourceId String

status String

(Available since 1.204.1) PolarDB cluster status.

storagePayType String

The billing method of the storage. Valid values Postpaid, Prepaid.

storageSpace Integer

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

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

storageType String

NOTE: Serverless cluster does not support this parameter.

subCategory String

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

tags Map<String,Object>

A mapping of tags to assign to the resource.

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

targetDbRevisionVersionCode String

The Version Code of the target version, whose parameter values can be obtained from the DescribeDBClusterVersion interface.

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

tdeStatus String

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

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

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

vpcId String

The id of the VPC.

vswitchId String

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

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

zoneId String

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

allowShutDown string

Specifies whether to enable the no-activity suspension feature. Default value: false. Valid values are true, false. This parameter is valid only for serverless clusters.

autoRenewPeriod number

Auto-renewal period of an cluster, in the unit of the month. It is valid when pay_type is PrePaid. Valid value:1, 2, 3, 6, 12, 24, 36, Default to 1.

backupRetentionPolicyOnClusterDeletion string

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

cloneDataPoint string

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

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

collectorStatus string

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

connectionString string

(Available since 1.81.0) PolarDB cluster connection string.

createTime string

(Available since 1.204.1) PolarDB cluster creation time.

creationCategory string

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

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

creationOption string

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

dbClusterIpArrays ClusterDbClusterIpArray[]

db_cluster_ip_array defines how users can send requests to your API. See db_cluster_ip_array below.

dbNodeClass string

The db_node_class of cluster node.

NOTE: Node specifications are divided into cluster version, single node version and History Library version. They can't change each other, but the general specification and exclusive specification of cluster version can be changed. From version 1.204.0, If you need to create a Serverless cluster, db_node_class can be set to polar.mysql.sl.small.

dbNodeCount number

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

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

dbNodeId string

The ID of the node or node subscript. Node subscript values: 1 to 15.

dbNodeNum number

The number of Standard Edition nodes. Default value: 1. Valid values are 1, 2.

dbRevisionVersionLists ClusterDbRevisionVersionList[]

(Available since v1.216.0) The db_revision_version_list supports the following:

dbType string

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

dbVersion string

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

defaultTimeZone string

NOTE: This parameter is valid only when the DBType parameter is set to MySQL.

deletionLock number

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

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

description string

The description of cluster.

encryptNewTables string

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

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

encryptionKey string

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

fromTimeService string

Immediate or scheduled kernel version upgrade. Valid values are true, false. True means immediate execution, False means scheduled execution.

gdnId string

The ID of the global database network (GDN).

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

hotReplicaMode string

Indicates whether the hot standby feature is enabled. Valid values are ON, OFF. Only MySQL supports.

hotStandbyCluster string

Whether to enable the hot standby cluster. Valid values are ON, OFF. Only MySQL supports.

imciSwitch string

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

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

loosePolarLogBin string

Enable the Binlog function. Default value: OFF. Valid values are OFF, ON.

NOTE: This parameter is valid only MySQL Engine supports.

lowerCaseTableNames number

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.

maintainTime string

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

modifyType string

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

parameterGroupId string

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 ClusterParameter[]

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.

payType string

Valid values are PrePaid, PostPaid, Default to PostPaid.

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 running pulumi up will not effect the resource.

plannedEndTime string

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.

plannedStartTime string

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.

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

proxyType string

The type of PolarProxy. Default value: OFF. Valid values are OFF, EXCLUSIVE GENERAL.

NOTE: This parameter is valid only for standard clusters.

renewalStatus string

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

resourceGroupId string

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

roleArn string

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

scaleApRoNumMax number

scaleApRoNumMin number

scaleMax number

scaleMin number

scaleRoNumMax number

scaleRoNumMin number

secondsUntilAutoPause number

securityGroupIds string[]

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

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

securityIps string[]

serverlessSteadySwitch string

Serverless steady-state switch. Valid values are ON, OFF. This parameter is valid only for serverless clusters.

NOTE: When serverless_steady_switch is ON and serverless_type is SteadyServerless, parameters scale_min, scale_max, scale_ro_num_min and scale_ro_num_max are all required.

serverlessType string

The type of the serverless cluster. Valid values AgileServerless, SteadyServerless. This parameter is valid only for serverless clusters.

sourceResourceId string

status string

(Available since 1.204.1) PolarDB cluster status.

storagePayType string

The billing method of the storage. Valid values Postpaid, Prepaid.

storageSpace number

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

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

storageType string

NOTE: Serverless cluster does not support this parameter.

subCategory string

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

tags {[key: string]: any}

A mapping of tags to assign to the resource.

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

targetDbRevisionVersionCode string

The Version Code of the target version, whose parameter values can be obtained from the DescribeDBClusterVersion interface.

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

tdeStatus string

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

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

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

vpcId string

The id of the VPC.

vswitchId string

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

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

zoneId string

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

allow_shut_down str

Specifies whether to enable the no-activity suspension feature. Default value: false. Valid values are true, false. This parameter is valid only for serverless clusters.

auto_renew_period int

Auto-renewal period of an cluster, in the unit of the month. It is valid when pay_type is PrePaid. Valid value:1, 2, 3, 6, 12, 24, 36, Default to 1.

backup_retention_policy_on_cluster_deletion str

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

clone_data_point str

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

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

collector_status str

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

connection_string str

(Available 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 CreateDBCluster CreationCategory.

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

creation_option str

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

db_cluster_ip_arrays Sequence[ClusterDbClusterIpArrayArgs]

db_cluster_ip_array defines how users can send requests to your API. See db_cluster_ip_array below.

db_node_class str

The db_node_class of cluster node.

NOTE: Node specifications are divided into cluster version, single node version and History Library version. They can't change each other, but the general specification and exclusive specification of cluster version can be changed. From version 1.204.0, If you need to create a Serverless cluster, db_node_class can be set to polar.mysql.sl.small.

db_node_count int

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

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

db_node_id str

The ID of the node or node subscript. Node subscript values: 1 to 15.

db_node_num int

The number of Standard Edition nodes. Default value: 1. Valid values are 1, 2.

db_revision_version_lists Sequence[ClusterDbRevisionVersionListArgs]

(Available since v1.216.0) The db_revision_version_list supports the following:

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

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 is Prepaid .deletion_lock the cluster protection lock can be turned on or off when pay_type is Postpaid.

description str

The description of cluster.

encrypt_new_tables str

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

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

encryption_key str

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

from_time_service str

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

Indicates whether the hot standby feature is enabled. Valid values are ON, OFF. Only MySQL supports.

hot_standby_cluster str

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

Enable the Binlog function. Default value: OFF. Valid values are OFF, ON.

NOTE: This parameter is valid only MySQL Engine supports.

lower_case_table_names int

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 are Upgrade, Downgrade, Default to Upgrade.

parameter_group_id str

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[ClusterParameterArgs]

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

pay_type str

Valid values are PrePaid, PostPaid, Default to PostPaid.

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 running pulumi up will not effect the resource.

planned_end_time str

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

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 to NotRenewal.

resource_group_id str

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

role_arn str

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

scale_ap_ro_num_max int

scale_ap_ro_num_min int

scale_max int

scale_min int

scale_ro_num_max int

scale_ro_num_min int

seconds_until_auto_pause int

security_group_ids Sequence[str]

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

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

security_ips Sequence[str]

serverless_steady_switch str

Serverless steady-state switch. Valid values are ON, OFF. This parameter is valid only for serverless clusters.

NOTE: When serverless_steady_switch is ON and serverless_type is SteadyServerless, parameters scale_min, scale_max, scale_ro_num_min and scale_ro_num_max are all required.

serverless_type str

The type of the serverless cluster. Valid values AgileServerless, SteadyServerless. This parameter is valid only for serverless clusters.

source_resource_id str

status str

(Available since 1.204.1) PolarDB cluster status.

storage_pay_type str

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 is PrePaid.

storage_type str

NOTE: Serverless cluster does not support this parameter.

sub_category str

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

tags Mapping[str, Any]

A mapping of tags to assign to the resource.

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

target_db_revision_version_code str

The Version Code of the target version, whose parameter values can be obtained from the DescribeDBClusterVersion interface.

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 to Disabled. TDE cannot be closed after it is turned on.

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

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.

allowShutDown String

Specifies whether to enable the no-activity suspension feature. Default value: false. Valid values are true, false. This parameter is valid only for serverless clusters.

autoRenewPeriod Number

Auto-renewal period of an cluster, in the unit of the month. It is valid when pay_type is PrePaid. Valid value:1, 2, 3, 6, 12, 24, 36, Default to 1.

backupRetentionPolicyOnClusterDeletion String

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

cloneDataPoint String

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

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

collectorStatus String

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

connectionString String

(Available since 1.81.0) PolarDB cluster connection string.

createTime String

(Available since 1.204.1) PolarDB cluster creation time.

creationCategory String

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

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

creationOption String

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

dbClusterIpArrays List<Property Map>

db_cluster_ip_array defines how users can send requests to your API. See db_cluster_ip_array below.

dbNodeClass String

The db_node_class of cluster node.

NOTE: Node specifications are divided into cluster version, single node version and History Library version. They can't change each other, but the general specification and exclusive specification of cluster version can be changed. From version 1.204.0, If you need to create a Serverless cluster, db_node_class can be set to polar.mysql.sl.small.

dbNodeCount Number

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

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

dbNodeId String

The ID of the node or node subscript. Node subscript values: 1 to 15.

dbNodeNum Number

The number of Standard Edition nodes. Default value: 1. Valid values are 1, 2.

dbRevisionVersionLists List<Property Map>

(Available since v1.216.0) The db_revision_version_list supports the following:

dbType String

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

dbVersion String

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

defaultTimeZone String

NOTE: This parameter is valid only when the DBType parameter is set to MySQL.

deletionLock Number

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

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

description String

The description of cluster.

encryptNewTables String

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

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

encryptionKey String

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

fromTimeService String

Immediate or scheduled kernel version upgrade. Valid values are true, false. True means immediate execution, False means scheduled execution.

gdnId String

The ID of the global database network (GDN).

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

hotReplicaMode String

Indicates whether the hot standby feature is enabled. Valid values are ON, OFF. Only MySQL supports.

hotStandbyCluster String

Whether to enable the hot standby cluster. Valid values are ON, OFF. Only MySQL supports.

imciSwitch String

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

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

loosePolarLogBin String

Enable the Binlog function. Default value: OFF. Valid values are OFF, ON.

NOTE: This parameter is valid only MySQL Engine supports.

lowerCaseTableNames Number

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.

maintainTime String

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

modifyType String

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

parameterGroupId String

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.

payType String

Valid values are PrePaid, PostPaid, Default to PostPaid.

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 running pulumi up will not effect the resource.

plannedEndTime String

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.

plannedStartTime String

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.

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

proxyType String

The type of PolarProxy. Default value: OFF. Valid values are OFF, EXCLUSIVE GENERAL.

NOTE: This parameter is valid only for standard clusters.

renewalStatus String

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

resourceGroupId String

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

roleArn String

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

scaleApRoNumMax Number

scaleApRoNumMin Number

scaleMax Number

scaleMin Number

scaleRoNumMax Number

scaleRoNumMin Number

secondsUntilAutoPause Number

securityGroupIds List<String>

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

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

securityIps List<String>

serverlessSteadySwitch String

Serverless steady-state switch. Valid values are ON, OFF. This parameter is valid only for serverless clusters.

NOTE: When serverless_steady_switch is ON and serverless_type is SteadyServerless, parameters scale_min, scale_max, scale_ro_num_min and scale_ro_num_max are all required.

serverlessType String

The type of the serverless cluster. Valid values AgileServerless, SteadyServerless. This parameter is valid only for serverless clusters.

sourceResourceId String

status String

(Available since 1.204.1) PolarDB cluster status.

storagePayType String

The billing method of the storage. Valid values Postpaid, Prepaid.

storageSpace Number

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

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

storageType String

NOTE: Serverless cluster does not support this parameter.

subCategory String

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

tags Map<Any>

A mapping of tags to assign to the resource.

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

targetDbRevisionVersionCode String

The Version Code of the target version, whose parameter values can be obtained from the DescribeDBClusterVersion interface.

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

tdeStatus String

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

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

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

vpcId String

The id of the VPC.

vswitchId String

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

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

zoneId String

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

Supporting Types

ClusterDbClusterIpArray, ClusterDbClusterIpArrayArgs

DbClusterIpArrayName string: The name of the IP whitelist group. The group name must be 2 to 120 characters in length and consists of lowercase letters and digits. It must start with a letter, and end with a letter or a digit. NOTE: If the specified whitelist group name does not exist, the whitelist group is created. If the specified whitelist group name exists, the whitelist group is modified. If you do not specify this parameter, the default group is modified. You can create a maximum of 50 IP whitelist groups for a cluster.
ModifyMode string: The method for modifying the IP whitelist. Valid values are Cover, Append, Delete. NOTE: There does not recommend setting modify_mode to Append or Delete and it will bring a potential diff error.
SecurityIps List<string>: 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]).

DbClusterIpArrayName string: The name of the IP whitelist group. The group name must be 2 to 120 characters in length and consists of lowercase letters and digits. It must start with a letter, and end with a letter or a digit. NOTE: If the specified whitelist group name does not exist, the whitelist group is created. If the specified whitelist group name exists, the whitelist group is modified. If you do not specify this parameter, the default group is modified. You can create a maximum of 50 IP whitelist groups for a cluster.
ModifyMode string: The method for modifying the IP whitelist. Valid values are Cover, Append, Delete. NOTE: There does not recommend setting modify_mode to Append or Delete and it will bring a potential diff error.
SecurityIps []string: 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]).

dbClusterIpArrayName String: The name of the IP whitelist group. The group name must be 2 to 120 characters in length and consists of lowercase letters and digits. It must start with a letter, and end with a letter or a digit. NOTE: If the specified whitelist group name does not exist, the whitelist group is created. If the specified whitelist group name exists, the whitelist group is modified. If you do not specify this parameter, the default group is modified. You can create a maximum of 50 IP whitelist groups for a cluster.
modifyMode String: The method for modifying the IP whitelist. Valid values are Cover, Append, Delete. NOTE: There does not recommend setting modify_mode to Append or Delete and it will bring a potential diff error.
securityIps List<String>: 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]).

dbClusterIpArrayName string: The name of the IP whitelist group. The group name must be 2 to 120 characters in length and consists of lowercase letters and digits. It must start with a letter, and end with a letter or a digit. NOTE: If the specified whitelist group name does not exist, the whitelist group is created. If the specified whitelist group name exists, the whitelist group is modified. If you do not specify this parameter, the default group is modified. You can create a maximum of 50 IP whitelist groups for a cluster.
modifyMode string: The method for modifying the IP whitelist. Valid values are Cover, Append, Delete. NOTE: There does not recommend setting modify_mode to Append or Delete and it will bring a potential diff error.
securityIps string[]: 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_ip_array_name str: The name of the IP whitelist group. The group name must be 2 to 120 characters in length and consists of lowercase letters and digits. It must start with a letter, and end with a letter or a digit. NOTE: If the specified whitelist group name does not exist, the whitelist group is created. If the specified whitelist group name exists, the whitelist group is modified. If you do not specify this parameter, the default group is modified. You can create a maximum of 50 IP whitelist groups for a cluster.
modify_mode str: The method for modifying the IP whitelist. Valid values are Cover, Append, Delete. NOTE: There does not recommend setting modify_mode to Append or Delete and it will bring a potential diff error.
security_ips Sequence[str]: 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]).

dbClusterIpArrayName String: The name of the IP whitelist group. The group name must be 2 to 120 characters in length and consists of lowercase letters and digits. It must start with a letter, and end with a letter or a digit. NOTE: If the specified whitelist group name does not exist, the whitelist group is created. If the specified whitelist group name exists, the whitelist group is modified. If you do not specify this parameter, the default group is modified. You can create a maximum of 50 IP whitelist groups for a cluster.
modifyMode String: The method for modifying the IP whitelist. Valid values are Cover, Append, Delete. NOTE: There does not recommend setting modify_mode to Append or Delete and it will bring a potential diff error.
securityIps List<String>: 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]).

ClusterDbRevisionVersionList, ClusterDbRevisionVersionListArgs

ReleaseNote string: (Available since v1.216.0) The revised version Code of the database engine is used to specify the upgrade to the target version.
ReleaseType string: (Available since v1.216.0) Database version release status. Valid values are Stable, Old, HighRisk.
RevisionVersionCode string: (Available since v1.216.0) The revised version Code of the database engine is used to specify the upgrade to the target version.
RevisionVersionName string: (Available since v1.216.0) The revision version number of the database engine.

ReleaseNote string: (Available since v1.216.0) The revised version Code of the database engine is used to specify the upgrade to the target version.
ReleaseType string: (Available since v1.216.0) Database version release status. Valid values are Stable, Old, HighRisk.
RevisionVersionCode string: (Available since v1.216.0) The revised version Code of the database engine is used to specify the upgrade to the target version.
RevisionVersionName string: (Available since v1.216.0) The revision version number of the database engine.

releaseNote String: (Available since v1.216.0) The revised version Code of the database engine is used to specify the upgrade to the target version.
releaseType String: (Available since v1.216.0) Database version release status. Valid values are Stable, Old, HighRisk.
revisionVersionCode String: (Available since v1.216.0) The revised version Code of the database engine is used to specify the upgrade to the target version.
revisionVersionName String: (Available since v1.216.0) The revision version number of the database engine.

releaseNote string: (Available since v1.216.0) The revised version Code of the database engine is used to specify the upgrade to the target version.
releaseType string: (Available since v1.216.0) Database version release status. Valid values are Stable, Old, HighRisk.
revisionVersionCode string: (Available since v1.216.0) The revised version Code of the database engine is used to specify the upgrade to the target version.
revisionVersionName string: (Available since v1.216.0) The revision version number of the database engine.

release_note str: (Available since v1.216.0) The revised version Code of the database engine is used to specify the upgrade to the target version.
release_type str: (Available since v1.216.0) Database version release status. Valid values are Stable, Old, HighRisk.
revision_version_code str: (Available since v1.216.0) The revised version Code of the database engine is used to specify the upgrade to the target version.
revision_version_name str: (Available since v1.216.0) The revision version number of the database engine.

releaseNote String: (Available since v1.216.0) The revised version Code of the database engine is used to specify the upgrade to the target version.
releaseType String: (Available since v1.216.0) Database version release status. Valid values are Stable, Old, HighRisk.
revisionVersionCode String: (Available since v1.216.0) The revised version Code of the database engine is used to specify the upgrade to the target version.
revisionVersionName String: (Available since v1.216.0) The revision version number of the database engine.

ClusterParameter, ClusterParameterArgs

Name string: Kernel parameter name.
Value string: Kernel parameter value.

Name string: Kernel parameter name.
Value string: Kernel parameter value.

name String: Kernel parameter name.
value String: Kernel parameter value.

name string: Kernel parameter name.
value string: Kernel parameter value.

name str: Kernel parameter name.
value str: Kernel parameter value.

name String: Kernel parameter name.
value String: Kernel parameter value.

Package Details

Repository: Alibaba Cloud pulumi/pulumi-alicloud
License: Apache-2.0
Notes: This Pulumi package is based on the alicloud Terraform Provider.

Alibaba Cloud v3.57.1 published on Wednesday, Jun 26, 2024 by Pulumi

pulumi/pulumi-alicloud

alicloud.polardb.Cluster

On this page

On this page

Import

Create Cluster Resource

Constructor syntax

Parameters

Constructor example

Cluster Resource Properties

Inputs

Outputs

Look up Existing Cluster Resource

Supporting Types

ClusterDbClusterIpArray, ClusterDbClusterIpArrayArgs

ClusterDbRevisionVersionList, ClusterDbRevisionVersionListArgs

ClusterParameter, ClusterParameterArgs

Package Details

On this page

On this page