Docs Packages
  1. Packages
  2. Alibaba Cloud
  3. API Docs
  4. adb
  5. Cluster
Alibaba Cloud v3.44.0 published on Thursday, Sep 28, 2023 by Pulumi
pulumi/pulumi-alicloud

alicloud.adb.Cluster

Explore with Pulumi AI

alicloud logo
Alibaba Cloud v3.44.0 published on Thursday, Sep 28, 2023 by Pulumi
pulumi/pulumi-alicloud

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

    DEPRECATED: This resource has been deprecated from version 1.121.0. Please use new resource alicloud_adb_db_cluster.

    NOTE: Available in v1.71.0+.

    Example Usage

    Create a ADB MySQL cluster

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

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

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

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

    var defaultCluster = new AliCloud.Adb.Cluster("defaultCluster", new()
    {
        DbClusterVersion = "3.0",
        DbClusterCategory = "Cluster",
        DbNodeClass = "C8",
        DbNodeCount = 2,
        DbNodeStorage = 200,
        PayType = "PostPaid",
        Description = name,
        VswitchId = defaultSwitch.Id,
    });

});

    package main

import (
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud"
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/adb"
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/vpc"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		name := "adbClusterconfig"
		if param := cfg.Get("name"); param != "" {
			name = param
		}
		creation := "ADB"
		if param := cfg.Get("creation"); param != "" {
			creation = param
		}
		defaultZones, err := alicloud.GetZones(ctx, &alicloud.GetZonesArgs{
			AvailableResourceCreation: pulumi.StringRef(creation),
		}, nil)
		if err != nil {
			return err
		}
		defaultNetwork, err := vpc.NewNetwork(ctx, "defaultNetwork", &vpc.NetworkArgs{
			VpcName:   pulumi.String(name),
			CidrBlock: pulumi.String("172.16.0.0/16"),
		})
		if err != nil {
			return err
		}
		defaultSwitch, err := vpc.NewSwitch(ctx, "defaultSwitch", &vpc.SwitchArgs{
			VpcId:       defaultNetwork.ID(),
			CidrBlock:   pulumi.String("172.16.0.0/24"),
			ZoneId:      *pulumi.String(defaultZones.Zones[0].Id),
			VswitchName: pulumi.String(name),
		})
		if err != nil {
			return err
		}
		_, err = adb.NewCluster(ctx, "defaultCluster", &adb.ClusterArgs{
			DbClusterVersion:  pulumi.String("3.0"),
			DbClusterCategory: pulumi.String("Cluster"),
			DbNodeClass:       pulumi.String("C8"),
			DbNodeCount:       pulumi.Int(2),
			DbNodeStorage:     pulumi.Int(200),
			PayType:           pulumi.String("PostPaid"),
			Description:       pulumi.String(name),
			VswitchId:         defaultSwitch.ID(),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.AlicloudFunctions;
import com.pulumi.alicloud.inputs.GetZonesArgs;
import com.pulumi.alicloud.vpc.Network;
import com.pulumi.alicloud.vpc.NetworkArgs;
import com.pulumi.alicloud.vpc.Switch;
import com.pulumi.alicloud.vpc.SwitchArgs;
import com.pulumi.alicloud.adb.Cluster;
import com.pulumi.alicloud.adb.ClusterArgs;
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("adbClusterconfig");
        final var creation = config.get("creation").orElse("ADB");
        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()        
            .dbClusterVersion("3.0")
            .dbClusterCategory("Cluster")
            .dbNodeClass("C8")
            .dbNodeCount(2)
            .dbNodeStorage(200)
            .payType("PostPaid")
            .description(name)
            .vswitchId(defaultSwitch.id())
            .build());

    }
}

    import pulumi
import pulumi_alicloud as alicloud

config = pulumi.Config()
name = config.get("name")
if name is None:
    name = "adbClusterconfig"
creation = config.get("creation")
if creation is None:
    creation = "ADB"
default_zones = alicloud.get_zones(available_resource_creation=creation)
default_network = alicloud.vpc.Network("defaultNetwork",
    vpc_name=name,
    cidr_block="172.16.0.0/16")
default_switch = alicloud.vpc.Switch("defaultSwitch",
    vpc_id=default_network.id,
    cidr_block="172.16.0.0/24",
    zone_id=default_zones.zones[0].id,
    vswitch_name=name)
default_cluster = alicloud.adb.Cluster("defaultCluster",
    db_cluster_version="3.0",
    db_cluster_category="Cluster",
    db_node_class="C8",
    db_node_count=2,
    db_node_storage=200,
    pay_type="PostPaid",
    description=name,
    vswitch_id=default_switch.id)

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

const config = new pulumi.Config();
const name = config.get("name") || "adbClusterconfig";
const creation = config.get("creation") || "ADB";
const defaultZones = alicloud.getZones({
    availableResourceCreation: creation,
});
const defaultNetwork = new alicloud.vpc.Network("defaultNetwork", {
    vpcName: name,
    cidrBlock: "172.16.0.0/16",
});
const defaultSwitch = new alicloud.vpc.Switch("defaultSwitch", {
    vpcId: defaultNetwork.id,
    cidrBlock: "172.16.0.0/24",
    zoneId: defaultZones.then(defaultZones => defaultZones.zones?.[0]?.id),
    vswitchName: name,
});
const defaultCluster = new alicloud.adb.Cluster("defaultCluster", {
    dbClusterVersion: "3.0",
    dbClusterCategory: "Cluster",
    dbNodeClass: "C8",
    dbNodeCount: 2,
    dbNodeStorage: 200,
    payType: "PostPaid",
    description: name,
    vswitchId: defaultSwitch.id,
});

    configuration:
  name:
    type: string
    default: adbClusterconfig
  creation:
    type: string
    default: ADB
resources:
  defaultNetwork:
    type: alicloud:vpc:Network
    properties:
      vpcName: ${name}
      cidrBlock: 172.16.0.0/16
  defaultSwitch:
    type: alicloud:vpc:Switch
    properties:
      vpcId: ${defaultNetwork.id}
      cidrBlock: 172.16.0.0/24
      zoneId: ${defaultZones.zones[0].id}
      vswitchName: ${name}
  defaultCluster:
    type: alicloud:adb:Cluster
    properties:
      dbClusterVersion: '3.0'
      dbClusterCategory: Cluster
      dbNodeClass: C8
      dbNodeCount: 2
      dbNodeStorage: 200
      payType: PostPaid
      description: ${name}
      vswitchId: ${defaultSwitch.id}
variables:
  defaultZones:
    fn::invoke:
      Function: alicloud:getZones
      Arguments:
        availableResourceCreation: ${creation}

    Create Cluster Resource

    new Cluster(name: string, args: ClusterArgs, opts?: CustomResourceOptions);
    @overload
def Cluster(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            auto_renew_period: Optional[int] = None,
            compute_resource: Optional[str] = None,
            db_cluster_category: Optional[str] = None,
            db_cluster_class: Optional[str] = None,
            db_cluster_version: Optional[str] = None,
            db_node_class: Optional[str] = None,
            db_node_count: Optional[int] = None,
            db_node_storage: Optional[int] = None,
            description: Optional[str] = None,
            disk_performance_level: Optional[str] = None,
            elastic_io_resource: Optional[int] = None,
            elastic_io_resource_size: Optional[str] = None,
            maintain_time: Optional[str] = None,
            mode: Optional[str] = None,
            modify_type: Optional[str] = None,
            pay_type: Optional[str] = None,
            payment_type: Optional[str] = None,
            period: Optional[int] = None,
            renewal_status: Optional[str] = None,
            resource_group_id: Optional[str] = None,
            security_ips: Optional[Sequence[str]] = None,
            tags: Optional[Mapping[str, Any]] = None,
            vpc_id: Optional[str] = None,
            vswitch_id: Optional[str] = None,
            zone_id: Optional[str] = None)
@overload
def Cluster(resource_name: str,
            args: ClusterArgs,
            opts: Optional[ResourceOptions] = None)
    func NewCluster(ctx *Context, name string, args ClusterArgs, opts ...ResourceOption) (*Cluster, error)
    public Cluster(string name, ClusterArgs args, CustomResourceOptions? opts = null)
    public Cluster(String name, ClusterArgs args)
public Cluster(String name, ClusterArgs args, CustomResourceOptions options)

    type: alicloud:adb:Cluster
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ClusterArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ClusterArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ClusterArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ClusterArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ClusterArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Cluster Resource Properties

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

    Inputs

    The Cluster resource accepts the following input properties:

    DbClusterCategory string

    Cluster category. Value options: Basic, Cluster.

    Mode string
    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.

    ComputeResource string
    DbClusterClass string

    Deprecated:

    It duplicates with attribute db_node_class and is deprecated from 1.121.2.

    DbClusterVersion string

    Cluster version. Value options: 3.0, Default to 3.0.

    DbNodeClass string

    The db_node_class of cluster node.

    DbNodeCount int

    The db_node_count of cluster node.

    DbNodeStorage int

    The db_node_storage of cluster node.

    Description string

    The description of cluster.

    DiskPerformanceLevel string
    ElasticIoResource int
    ElasticIoResourceSize string
    MaintainTime string

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

    ModifyType string
    PayType string

    Field pay_type has been deprecated. New field payment_type instead.

    Deprecated:

    Attribute 'pay_type' has been deprecated from the provider version 1.166.0 and it will be remove in the future version. Please use the new attribute 'payment_type' instead.

    PaymentType string

    The payment type of the resource. Valid values are PayAsYouGo and Subscription. Default to PayAsYouGo. Note: The payment_type supports updating from v1.166.0+.

    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. Default to 1.

    RenewalStatus string

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

    ResourceGroupId string
    SecurityIps List<string>

    List of IP addresses allowed to access all databases of an 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]).

    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.

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

    VpcId string
    VswitchId string

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

    ZoneId string

    The Zone to launch the DB cluster.

    DbClusterCategory string

    Cluster category. Value options: Basic, Cluster.

    Mode string
    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.

    ComputeResource string
    DbClusterClass string

    Deprecated:

    It duplicates with attribute db_node_class and is deprecated from 1.121.2.

    DbClusterVersion string

    Cluster version. Value options: 3.0, Default to 3.0.

    DbNodeClass string

    The db_node_class of cluster node.

    DbNodeCount int

    The db_node_count of cluster node.

    DbNodeStorage int

    The db_node_storage of cluster node.

    Description string

    The description of cluster.

    DiskPerformanceLevel string
    ElasticIoResource int
    ElasticIoResourceSize string
    MaintainTime string

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

    ModifyType string
    PayType string

    Field pay_type has been deprecated. New field payment_type instead.

    Deprecated:

    Attribute 'pay_type' has been deprecated from the provider version 1.166.0 and it will be remove in the future version. Please use the new attribute 'payment_type' instead.

    PaymentType string

    The payment type of the resource. Valid values are PayAsYouGo and Subscription. Default to PayAsYouGo. Note: The payment_type supports updating from v1.166.0+.

    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. Default to 1.

    RenewalStatus string

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

    ResourceGroupId string
    SecurityIps []string

    List of IP addresses allowed to access all databases of an 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]).

    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.

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

    VpcId string
    VswitchId string

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

    ZoneId string

    The Zone to launch the DB cluster.

    dbClusterCategory String

    Cluster category. Value options: Basic, Cluster.

    mode String
    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.

    computeResource String
    dbClusterClass String

    Deprecated:

    It duplicates with attribute db_node_class and is deprecated from 1.121.2.

    dbClusterVersion String

    Cluster version. Value options: 3.0, Default to 3.0.

    dbNodeClass String

    The db_node_class of cluster node.

    dbNodeCount Integer

    The db_node_count of cluster node.

    dbNodeStorage Integer

    The db_node_storage of cluster node.

    description String

    The description of cluster.

    diskPerformanceLevel String
    elasticIoResource Integer
    elasticIoResourceSize String
    maintainTime String

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

    modifyType String
    payType String

    Field pay_type has been deprecated. New field payment_type instead.

    Deprecated:

    Attribute 'pay_type' has been deprecated from the provider version 1.166.0 and it will be remove in the future version. Please use the new attribute 'payment_type' instead.

    paymentType String

    The payment type of the resource. Valid values are PayAsYouGo and Subscription. Default to PayAsYouGo. Note: The payment_type supports updating from v1.166.0+.

    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. Default to 1.

    renewalStatus String

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

    resourceGroupId String
    securityIps List<String>

    List of IP addresses allowed to access all databases of an 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]).

    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.

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

    vpcId String
    vswitchId String

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

    zoneId String

    The Zone to launch the DB cluster.

    dbClusterCategory string

    Cluster category. Value options: Basic, Cluster.

    mode string
    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.

    computeResource string
    dbClusterClass string

    Deprecated:

    It duplicates with attribute db_node_class and is deprecated from 1.121.2.

    dbClusterVersion string

    Cluster version. Value options: 3.0, Default to 3.0.

    dbNodeClass string

    The db_node_class of cluster node.

    dbNodeCount number

    The db_node_count of cluster node.

    dbNodeStorage number

    The db_node_storage of cluster node.

    description string

    The description of cluster.

    diskPerformanceLevel string
    elasticIoResource number
    elasticIoResourceSize string
    maintainTime string

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

    modifyType string
    payType string

    Field pay_type has been deprecated. New field payment_type instead.

    Deprecated:

    Attribute 'pay_type' has been deprecated from the provider version 1.166.0 and it will be remove in the future version. Please use the new attribute 'payment_type' instead.

    paymentType string

    The payment type of the resource. Valid values are PayAsYouGo and Subscription. Default to PayAsYouGo. Note: The payment_type supports updating from v1.166.0+.

    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. Default to 1.

    renewalStatus string

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

    resourceGroupId string
    securityIps string[]

    List of IP addresses allowed to access all databases of an 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]).

    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.

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

    vpcId string
    vswitchId string

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

    zoneId string

    The Zone to launch the DB cluster.

    db_cluster_category str

    Cluster category. Value options: Basic, Cluster.

    mode str
    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.

    compute_resource str
    db_cluster_class str

    Deprecated:

    It duplicates with attribute db_node_class and is deprecated from 1.121.2.

    db_cluster_version str

    Cluster version. Value options: 3.0, Default to 3.0.

    db_node_class str

    The db_node_class of cluster node.

    db_node_count int

    The db_node_count of cluster node.

    db_node_storage int

    The db_node_storage of cluster node.

    description str

    The description of cluster.

    disk_performance_level str
    elastic_io_resource int
    elastic_io_resource_size str
    maintain_time str

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

    modify_type str
    pay_type str

    Field pay_type has been deprecated. New field payment_type instead.

    Deprecated:

    Attribute 'pay_type' has been deprecated from the provider version 1.166.0 and it will be remove in the future version. Please use the new attribute 'payment_type' instead.

    payment_type str

    The payment type of the resource. Valid values are PayAsYouGo and Subscription. Default to PayAsYouGo. Note: The payment_type supports updating from v1.166.0+.

    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. Default to 1.

    renewal_status str

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

    resource_group_id str
    security_ips Sequence[str]

    List of IP addresses allowed to access all databases of an 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]).

    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.

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

    vpc_id str
    vswitch_id str

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

    zone_id str

    The Zone to launch the DB cluster.

    dbClusterCategory String

    Cluster category. Value options: Basic, Cluster.

    mode String
    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.

    computeResource String
    dbClusterClass String

    Deprecated:

    It duplicates with attribute db_node_class and is deprecated from 1.121.2.

    dbClusterVersion String

    Cluster version. Value options: 3.0, Default to 3.0.

    dbNodeClass String

    The db_node_class of cluster node.

    dbNodeCount Number

    The db_node_count of cluster node.

    dbNodeStorage Number

    The db_node_storage of cluster node.

    description String

    The description of cluster.

    diskPerformanceLevel String
    elasticIoResource Number
    elasticIoResourceSize String
    maintainTime String

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

    modifyType String
    payType String

    Field pay_type has been deprecated. New field payment_type instead.

    Deprecated:

    Attribute 'pay_type' has been deprecated from the provider version 1.166.0 and it will be remove in the future version. Please use the new attribute 'payment_type' instead.

    paymentType String

    The payment type of the resource. Valid values are PayAsYouGo and Subscription. Default to PayAsYouGo. Note: The payment_type supports updating from v1.166.0+.

    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. Default to 1.

    renewalStatus String

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

    resourceGroupId String
    securityIps List<String>

    List of IP addresses allowed to access all databases of an 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]).

    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.

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

    vpcId String
    vswitchId String

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

    zoneId String

    The Zone to launch the DB cluster.

    Outputs

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

    ConnectionString string

    (Available in 1.93.0+) The connection string of the ADB cluster.

    Id string

    The provider-assigned unique ID for this managed resource.

    Port string

    (Available in 1.196.0+) The connection port of the ADB cluster.

    Status string
    ConnectionString string

    (Available in 1.93.0+) The connection string of the ADB cluster.

    Id string

    The provider-assigned unique ID for this managed resource.

    Port string

    (Available in 1.196.0+) The connection port of the ADB cluster.

    Status string
    connectionString String

    (Available in 1.93.0+) The connection string of the ADB cluster.

    id String

    The provider-assigned unique ID for this managed resource.

    port String

    (Available in 1.196.0+) The connection port of the ADB cluster.

    status String
    connectionString string

    (Available in 1.93.0+) The connection string of the ADB cluster.

    id string

    The provider-assigned unique ID for this managed resource.

    port string

    (Available in 1.196.0+) The connection port of the ADB cluster.

    status string
    connection_string str

    (Available in 1.93.0+) The connection string of the ADB cluster.

    id str

    The provider-assigned unique ID for this managed resource.

    port str

    (Available in 1.196.0+) The connection port of the ADB cluster.

    status str
    connectionString String

    (Available in 1.93.0+) The connection string of the ADB cluster.

    id String

    The provider-assigned unique ID for this managed resource.

    port String

    (Available in 1.196.0+) The connection port of the ADB cluster.

    status String

    Look up Existing Cluster Resource

    Get an existing Cluster resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ClusterState, opts?: CustomResourceOptions): Cluster
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        auto_renew_period: Optional[int] = None,
        compute_resource: Optional[str] = None,
        connection_string: Optional[str] = None,
        db_cluster_category: Optional[str] = None,
        db_cluster_class: Optional[str] = None,
        db_cluster_version: Optional[str] = None,
        db_node_class: Optional[str] = None,
        db_node_count: Optional[int] = None,
        db_node_storage: Optional[int] = None,
        description: Optional[str] = None,
        disk_performance_level: Optional[str] = None,
        elastic_io_resource: Optional[int] = None,
        elastic_io_resource_size: Optional[str] = None,
        maintain_time: Optional[str] = None,
        mode: Optional[str] = None,
        modify_type: Optional[str] = None,
        pay_type: Optional[str] = None,
        payment_type: Optional[str] = None,
        period: Optional[int] = None,
        port: Optional[str] = None,
        renewal_status: Optional[str] = None,
        resource_group_id: Optional[str] = None,
        security_ips: Optional[Sequence[str]] = None,
        status: Optional[str] = None,
        tags: Optional[Mapping[str, Any]] = None,
        vpc_id: Optional[str] = None,
        vswitch_id: Optional[str] = None,
        zone_id: Optional[str] = None) -> Cluster
    func GetCluster(ctx *Context, name string, id IDInput, state *ClusterState, opts ...ResourceOption) (*Cluster, error)
    public static Cluster Get(string name, Input<string> id, ClusterState? state, CustomResourceOptions? opts = null)
    public static Cluster get(String name, Output<String> id, ClusterState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AutoRenewPeriod int

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

    ComputeResource string
    ConnectionString string

    (Available in 1.93.0+) The connection string of the ADB cluster.

    DbClusterCategory string

    Cluster category. Value options: Basic, Cluster.

    DbClusterClass string

    Deprecated:

    It duplicates with attribute db_node_class and is deprecated from 1.121.2.

    DbClusterVersion string

    Cluster version. Value options: 3.0, Default to 3.0.

    DbNodeClass string

    The db_node_class of cluster node.

    DbNodeCount int

    The db_node_count of cluster node.

    DbNodeStorage int

    The db_node_storage of cluster node.

    Description string

    The description of cluster.

    DiskPerformanceLevel string
    ElasticIoResource int
    ElasticIoResourceSize string
    MaintainTime string

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

    Mode string
    ModifyType string
    PayType string

    Field pay_type has been deprecated. New field payment_type instead.

    Deprecated:

    Attribute 'pay_type' has been deprecated from the provider version 1.166.0 and it will be remove in the future version. Please use the new attribute 'payment_type' instead.

    PaymentType string

    The payment type of the resource. Valid values are PayAsYouGo and Subscription. Default to PayAsYouGo. Note: The payment_type supports updating from v1.166.0+.

    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. Default to 1.

    Port string

    (Available in 1.196.0+) The connection port of the ADB cluster.

    RenewalStatus string

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

    ResourceGroupId string
    SecurityIps List<string>

    List of IP addresses allowed to access all databases of an 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]).

    Status string
    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.

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

    VpcId string
    VswitchId string

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

    ZoneId string

    The Zone to launch the DB cluster.

    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.

    ComputeResource string
    ConnectionString string

    (Available in 1.93.0+) The connection string of the ADB cluster.

    DbClusterCategory string

    Cluster category. Value options: Basic, Cluster.

    DbClusterClass string

    Deprecated:

    It duplicates with attribute db_node_class and is deprecated from 1.121.2.

    DbClusterVersion string

    Cluster version. Value options: 3.0, Default to 3.0.

    DbNodeClass string

    The db_node_class of cluster node.

    DbNodeCount int

    The db_node_count of cluster node.

    DbNodeStorage int

    The db_node_storage of cluster node.

    Description string

    The description of cluster.

    DiskPerformanceLevel string
    ElasticIoResource int
    ElasticIoResourceSize string
    MaintainTime string

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

    Mode string
    ModifyType string
    PayType string

    Field pay_type has been deprecated. New field payment_type instead.

    Deprecated:

    Attribute 'pay_type' has been deprecated from the provider version 1.166.0 and it will be remove in the future version. Please use the new attribute 'payment_type' instead.

    PaymentType string

    The payment type of the resource. Valid values are PayAsYouGo and Subscription. Default to PayAsYouGo. Note: The payment_type supports updating from v1.166.0+.

    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. Default to 1.

    Port string

    (Available in 1.196.0+) The connection port of the ADB cluster.

    RenewalStatus string

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

    ResourceGroupId string
    SecurityIps []string

    List of IP addresses allowed to access all databases of an 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]).

    Status string
    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.

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

    VpcId string
    VswitchId string

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

    ZoneId string

    The Zone to launch the DB cluster.

    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.

    computeResource String
    connectionString String

    (Available in 1.93.0+) The connection string of the ADB cluster.

    dbClusterCategory String

    Cluster category. Value options: Basic, Cluster.

    dbClusterClass String

    Deprecated:

    It duplicates with attribute db_node_class and is deprecated from 1.121.2.

    dbClusterVersion String

    Cluster version. Value options: 3.0, Default to 3.0.

    dbNodeClass String

    The db_node_class of cluster node.

    dbNodeCount Integer

    The db_node_count of cluster node.

    dbNodeStorage Integer

    The db_node_storage of cluster node.

    description String

    The description of cluster.

    diskPerformanceLevel String
    elasticIoResource Integer
    elasticIoResourceSize String
    maintainTime String

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

    mode String
    modifyType String
    payType String

    Field pay_type has been deprecated. New field payment_type instead.

    Deprecated:

    Attribute 'pay_type' has been deprecated from the provider version 1.166.0 and it will be remove in the future version. Please use the new attribute 'payment_type' instead.

    paymentType String

    The payment type of the resource. Valid values are PayAsYouGo and Subscription. Default to PayAsYouGo. Note: The payment_type supports updating from v1.166.0+.

    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. Default to 1.

    port String

    (Available in 1.196.0+) The connection port of the ADB cluster.

    renewalStatus String

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

    resourceGroupId String
    securityIps List<String>

    List of IP addresses allowed to access all databases of an 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]).

    status String
    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.

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

    vpcId String
    vswitchId String

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

    zoneId String

    The Zone to launch the DB cluster.

    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.

    computeResource string
    connectionString string

    (Available in 1.93.0+) The connection string of the ADB cluster.

    dbClusterCategory string

    Cluster category. Value options: Basic, Cluster.

    dbClusterClass string

    Deprecated:

    It duplicates with attribute db_node_class and is deprecated from 1.121.2.

    dbClusterVersion string

    Cluster version. Value options: 3.0, Default to 3.0.

    dbNodeClass string

    The db_node_class of cluster node.

    dbNodeCount number

    The db_node_count of cluster node.

    dbNodeStorage number

    The db_node_storage of cluster node.

    description string

    The description of cluster.

    diskPerformanceLevel string
    elasticIoResource number
    elasticIoResourceSize string
    maintainTime string

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

    mode string
    modifyType string
    payType string

    Field pay_type has been deprecated. New field payment_type instead.

    Deprecated:

    Attribute 'pay_type' has been deprecated from the provider version 1.166.0 and it will be remove in the future version. Please use the new attribute 'payment_type' instead.

    paymentType string

    The payment type of the resource. Valid values are PayAsYouGo and Subscription. Default to PayAsYouGo. Note: The payment_type supports updating from v1.166.0+.

    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. Default to 1.

    port string

    (Available in 1.196.0+) The connection port of the ADB cluster.

    renewalStatus string

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

    resourceGroupId string
    securityIps string[]

    List of IP addresses allowed to access all databases of an 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]).

    status string
    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.

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

    vpcId string
    vswitchId string

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

    zoneId string

    The Zone to launch the DB cluster.

    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.

    compute_resource str
    connection_string str

    (Available in 1.93.0+) The connection string of the ADB cluster.

    db_cluster_category str

    Cluster category. Value options: Basic, Cluster.

    db_cluster_class str

    Deprecated:

    It duplicates with attribute db_node_class and is deprecated from 1.121.2.

    db_cluster_version str

    Cluster version. Value options: 3.0, Default to 3.0.

    db_node_class str

    The db_node_class of cluster node.

    db_node_count int

    The db_node_count of cluster node.

    db_node_storage int

    The db_node_storage of cluster node.

    description str

    The description of cluster.

    disk_performance_level str
    elastic_io_resource int
    elastic_io_resource_size str
    maintain_time str

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

    mode str
    modify_type str
    pay_type str

    Field pay_type has been deprecated. New field payment_type instead.

    Deprecated:

    Attribute 'pay_type' has been deprecated from the provider version 1.166.0 and it will be remove in the future version. Please use the new attribute 'payment_type' instead.

    payment_type str

    The payment type of the resource. Valid values are PayAsYouGo and Subscription. Default to PayAsYouGo. Note: The payment_type supports updating from v1.166.0+.

    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. Default to 1.

    port str

    (Available in 1.196.0+) The connection port of the ADB cluster.

    renewal_status str

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

    resource_group_id str
    security_ips Sequence[str]

    List of IP addresses allowed to access all databases of an 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]).

    status str
    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.

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

    vpc_id str
    vswitch_id str

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

    zone_id str

    The Zone to launch the DB cluster.

    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.

    computeResource String
    connectionString String

    (Available in 1.93.0+) The connection string of the ADB cluster.

    dbClusterCategory String

    Cluster category. Value options: Basic, Cluster.

    dbClusterClass String

    Deprecated:

    It duplicates with attribute db_node_class and is deprecated from 1.121.2.

    dbClusterVersion String

    Cluster version. Value options: 3.0, Default to 3.0.

    dbNodeClass String

    The db_node_class of cluster node.

    dbNodeCount Number

    The db_node_count of cluster node.

    dbNodeStorage Number

    The db_node_storage of cluster node.

    description String

    The description of cluster.

    diskPerformanceLevel String
    elasticIoResource Number
    elasticIoResourceSize String
    maintainTime String

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

    mode String
    modifyType String
    payType String

    Field pay_type has been deprecated. New field payment_type instead.

    Deprecated:

    Attribute 'pay_type' has been deprecated from the provider version 1.166.0 and it will be remove in the future version. Please use the new attribute 'payment_type' instead.

    paymentType String

    The payment type of the resource. Valid values are PayAsYouGo and Subscription. Default to PayAsYouGo. Note: The payment_type supports updating from v1.166.0+.

    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. Default to 1.

    port String

    (Available in 1.196.0+) The connection port of the ADB cluster.

    renewalStatus String

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

    resourceGroupId String
    securityIps List<String>

    List of IP addresses allowed to access all databases of an 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]).

    status String
    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.

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

    vpcId String
    vswitchId String

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

    zoneId String

    The Zone to launch the DB cluster.

    Import

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

     $ pulumi import alicloud:adb/cluster:Cluster example am-abc12345678

    Package Details

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

    This Pulumi package is based on the alicloud Terraform Provider.

    alicloud logo
    Alibaba Cloud v3.44.0 published on Thursday, Sep 28, 2023 by Pulumi
    pulumi/pulumi-alicloud