pulumi-alicloud-kotlin/com.pulumi.alicloud.polardb.kotlin/Cluster

Cluster

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

NOTE: Available in v1.66.0+.

Example Usage

Create a PolarDB MySQL cluster

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.AlicloudFunctions;
import com.pulumi.alicloud.inputs.GetZonesArgs;
import com.pulumi.alicloud.vpc.Network;
import com.pulumi.alicloud.vpc.NetworkArgs;
import com.pulumi.alicloud.vpc.Switch;
import com.pulumi.alicloud.vpc.SwitchArgs;
import com.pulumi.alicloud.polardb.Cluster;
import com.pulumi.alicloud.polardb.ClusterArgs;
import com.pulumi.alicloud.polardb.inputs.ClusterDbClusterIpArrayArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        final var config = ctx.config();
        final var name = config.get("name").orElse("polardbClusterconfig");
        final var creation = config.get("creation").orElse("PolarDB");
        final var defaultZones = AlicloudFunctions.getZones(GetZonesArgs.builder()
            .availableResourceCreation(creation)
            .build());
        var defaultNetwork = new Network("defaultNetwork", NetworkArgs.builder()
            .vpcName(name)
            .cidrBlock("172.16.0.0/16")
            .build());
        var defaultSwitch = new Switch("defaultSwitch", SwitchArgs.builder()
            .vpcId(defaultNetwork.id())
            .cidrBlock("172.16.0.0/24")
            .zoneId(defaultZones.applyValue(getZonesResult -> getZonesResult.zones()[0].id()))
            .vswitchName(name)
            .build());
        var defaultCluster = new Cluster("defaultCluster", ClusterArgs.builder()
            .dbType("MySQL")
            .dbVersion("5.6")
            .dbNodeClass("polar.mysql.x4.medium")
            .payType("PostPaid")
            .description(name)
            .vswitchId(defaultSwitch.id())
            .dbClusterIpArrays(
                ClusterDbClusterIpArrayArgs.builder()
                    .dbClusterIpArrayName("default")
                    .securityIps(
                        "1.2.3.4",
                        "1.2.3.5")
                    .build(),
                ClusterDbClusterIpArrayArgs.builder()
                    .dbClusterIpArrayName("test_ips1")
                    .securityIps("1.2.3.6")
                    .build())
            .build());
    }
}

Import

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

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

Properties

autoRenewPeriod

val autoRenewPeriod: Output<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

val backupRetentionPolicyOnClusterDeletion: Output<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

val cloneDataPoint: Output<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.

collectorStatus

val collectorStatus: Output<String>

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

connectionString

val connectionString: Output<String>

(Available in 1.81.0+) PolarDB cluster connection string.

creationCategory

val creationCategory: Output<String>

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

creationOption

val creationOption: Output<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.

dbClusterIpArrays

val dbClusterIpArrays: Output<List<ClusterDbClusterIpArray>>

db_cluster_ip_array defines how users can send requests to your API.

dbNodeClass

val dbNodeClass: Output<String>

The db_node_class of cluster node.

dbNodeCount

val dbNodeCount: Output<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.

dbType

val dbType: Output<String>

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

dbVersion

val dbVersion: Output<String>

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

deletionLock

val deletionLock: Output<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

description

val description: Output<String>

The description of cluster.

encryptNewTables

val encryptNewTables: Output<String>?

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

gdnId

val gdnId: Output<String>?

The ID of the global database network (GDN).

val id: Output<String>

imciSwitch

val imciSwitch: Output<String>

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

maintainTime

val maintainTime: Output<String>

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

modifyType

val modifyType: Output<String>?

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

parameters

val parameters: Output<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 .

payType

val payType: Output<String>?

Valid values are PrePaid, PostPaid, Default to PostPaid.

period

val period: Output<Int>?

port

val port: Output<String>

(Available in 1.196.0+) PolarDB cluster connection port.

pulumiChildResources

val pulumiChildResources: Set<KotlinResource>

pulumiResourceName

val pulumiResourceName: String

pulumiResourceType

val pulumiResourceType: String

renewalStatus

val renewalStatus: Output<String>?

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

resourceGroupId

val resourceGroupId: Output<String>

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

securityGroupIds

val securityGroupIds: Output<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.

securityIps

val securityIps: Output<List<String>>

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

sourceResourceId

val sourceResourceId: Output<String>?

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

subCategory

val subCategory: Output<String>

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