Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Alibaba Cloud Provider
  3. API Docs
  4. adb
  5. DBCluster
Alibaba Cloud v3.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-alicloud

alicloud.adb.DBCluster

Explore with Pulumi AI

Alibaba Cloud v3.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-alicloud

Import

AnalyticDB for MySQL (ADB) DBCluster can be imported using the id, e.g.

$ pulumi import alicloud:adb/dBCluster:DBCluster example <id>
Copy

Create DBCluster Resource

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

Constructor syntax

new DBCluster(name: string, args: DBClusterArgs, opts?: CustomResourceOptions);
@overload
def DBCluster(resource_name: str,
              args: DBClusterArgs,
              opts: Optional[ResourceOptions] = None)

@overload
def DBCluster(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              db_cluster_category: Optional[str] = None,
              mode: Optional[str] = None,
              kernel_version: Optional[str] = None,
              switch_mode: Optional[int] = None,
              db_cluster_version: Optional[str] = None,
              db_node_class: Optional[str] = None,
              maintain_time: Optional[str] = None,
              db_node_storage: Optional[int] = None,
              description: Optional[str] = None,
              disk_encryption: Optional[bool] = None,
              disk_performance_level: Optional[str] = None,
              elastic_io_resource: Optional[int] = None,
              elastic_io_resource_size: Optional[str] = None,
              enable_ssl: Optional[bool] = None,
              db_cluster_class: Optional[str] = None,
              auto_renew_period: Optional[int] = None,
              db_node_count: Optional[int] = None,
              compute_resource: 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,
              kms_id: Optional[str] = None,
              tags: Optional[Mapping[str, str]] = None,
              vpc_id: Optional[str] = None,
              vswitch_id: Optional[str] = None,
              zone_id: Optional[str] = None)
func NewDBCluster(ctx *Context, name string, args DBClusterArgs, opts ...ResourceOption) (*DBCluster, error)
public DBCluster(string name, DBClusterArgs args, CustomResourceOptions? opts = null)
public DBCluster(String name, DBClusterArgs args)
public DBCluster(String name, DBClusterArgs args, CustomResourceOptions options)

type: alicloud:adb:DBCluster
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. DBClusterArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. DBClusterArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. DBClusterArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. DBClusterArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. DBClusterArgs
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 dbclusterResource = new AliCloud.Adb.DBCluster("dbclusterResource", new()
{
    DbClusterCategory = "string",
    Mode = "string",
    KernelVersion = "string",
    SwitchMode = 0,
    DbClusterVersion = "string",
    DbNodeClass = "string",
    MaintainTime = "string",
    DbNodeStorage = 0,
    Description = "string",
    DiskEncryption = false,
    DiskPerformanceLevel = "string",
    ElasticIoResource = 0,
    ElasticIoResourceSize = "string",
    EnableSsl = false,
    AutoRenewPeriod = 0,
    DbNodeCount = 0,
    ComputeResource = "string",
    ModifyType = "string",
    PaymentType = "string",
    Period = 0,
    RenewalStatus = "string",
    ResourceGroupId = "string",
    SecurityIps = new[]
    {
        "string",
    },
    KmsId = "string",
    Tags = 
    {
        { "string", "string" },
    },
    VpcId = "string",
    VswitchId = "string",
    ZoneId = "string",
});
Copy
example, err := adb.NewDBCluster(ctx, "dbclusterResource", &adb.DBClusterArgs{
	DbClusterCategory:     pulumi.String("string"),
	Mode:                  pulumi.String("string"),
	KernelVersion:         pulumi.String("string"),
	SwitchMode:            pulumi.Int(0),
	DbClusterVersion:      pulumi.String("string"),
	DbNodeClass:           pulumi.String("string"),
	MaintainTime:          pulumi.String("string"),
	DbNodeStorage:         pulumi.Int(0),
	Description:           pulumi.String("string"),
	DiskEncryption:        pulumi.Bool(false),
	DiskPerformanceLevel:  pulumi.String("string"),
	ElasticIoResource:     pulumi.Int(0),
	ElasticIoResourceSize: pulumi.String("string"),
	EnableSsl:             pulumi.Bool(false),
	AutoRenewPeriod:       pulumi.Int(0),
	DbNodeCount:           pulumi.Int(0),
	ComputeResource:       pulumi.String("string"),
	ModifyType:            pulumi.String("string"),
	PaymentType:           pulumi.String("string"),
	Period:                pulumi.Int(0),
	RenewalStatus:         pulumi.String("string"),
	ResourceGroupId:       pulumi.String("string"),
	SecurityIps: pulumi.StringArray{
		pulumi.String("string"),
	},
	KmsId: pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	VpcId:     pulumi.String("string"),
	VswitchId: pulumi.String("string"),
	ZoneId:    pulumi.String("string"),
})
Copy
var dbclusterResource = new DBCluster("dbclusterResource", DBClusterArgs.builder()
    .dbClusterCategory("string")
    .mode("string")
    .kernelVersion("string")
    .switchMode(0)
    .dbClusterVersion("string")
    .dbNodeClass("string")
    .maintainTime("string")
    .dbNodeStorage(0)
    .description("string")
    .diskEncryption(false)
    .diskPerformanceLevel("string")
    .elasticIoResource(0)
    .elasticIoResourceSize("string")
    .enableSsl(false)
    .autoRenewPeriod(0)
    .dbNodeCount(0)
    .computeResource("string")
    .modifyType("string")
    .paymentType("string")
    .period(0)
    .renewalStatus("string")
    .resourceGroupId("string")
    .securityIps("string")
    .kmsId("string")
    .tags(Map.of("string", "string"))
    .vpcId("string")
    .vswitchId("string")
    .zoneId("string")
    .build());
Copy
dbcluster_resource = alicloud.adb.DBCluster("dbclusterResource",
    db_cluster_category="string",
    mode="string",
    kernel_version="string",
    switch_mode=0,
    db_cluster_version="string",
    db_node_class="string",
    maintain_time="string",
    db_node_storage=0,
    description="string",
    disk_encryption=False,
    disk_performance_level="string",
    elastic_io_resource=0,
    elastic_io_resource_size="string",
    enable_ssl=False,
    auto_renew_period=0,
    db_node_count=0,
    compute_resource="string",
    modify_type="string",
    payment_type="string",
    period=0,
    renewal_status="string",
    resource_group_id="string",
    security_ips=["string"],
    kms_id="string",
    tags={
        "string": "string",
    },
    vpc_id="string",
    vswitch_id="string",
    zone_id="string")
Copy
const dbclusterResource = new alicloud.adb.DBCluster("dbclusterResource", {
    dbClusterCategory: "string",
    mode: "string",
    kernelVersion: "string",
    switchMode: 0,
    dbClusterVersion: "string",
    dbNodeClass: "string",
    maintainTime: "string",
    dbNodeStorage: 0,
    description: "string",
    diskEncryption: false,
    diskPerformanceLevel: "string",
    elasticIoResource: 0,
    elasticIoResourceSize: "string",
    enableSsl: false,
    autoRenewPeriod: 0,
    dbNodeCount: 0,
    computeResource: "string",
    modifyType: "string",
    paymentType: "string",
    period: 0,
    renewalStatus: "string",
    resourceGroupId: "string",
    securityIps: ["string"],
    kmsId: "string",
    tags: {
        string: "string",
    },
    vpcId: "string",
    vswitchId: "string",
    zoneId: "string",
});
Copy
type: alicloud:adb:DBCluster
properties:
    autoRenewPeriod: 0
    computeResource: string
    dbClusterCategory: string
    dbClusterVersion: string
    dbNodeClass: string
    dbNodeCount: 0
    dbNodeStorage: 0
    description: string
    diskEncryption: false
    diskPerformanceLevel: string
    elasticIoResource: 0
    elasticIoResourceSize: string
    enableSsl: false
    kernelVersion: string
    kmsId: string
    maintainTime: string
    mode: string
    modifyType: string
    paymentType: string
    period: 0
    renewalStatus: string
    resourceGroupId: string
    securityIps:
        - string
    switchMode: 0
    tags:
        string: string
    vpcId: string
    vswitchId: string
    zoneId: string
Copy

DBCluster Resource Properties

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

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The DBCluster resource accepts the following input properties:

DbClusterCategory This property is required. string
The db cluster category. Valid values: Basic, Cluster, MixedStorage.
Mode This property is required. string
The mode of the cluster. Valid values: reserver, flexible.
AutoRenewPeriod int
Auto-renewal period of an cluster, in the unit of the month. It is valid when payment_type is Subscription. Valid values: 1, 2, 3, 6, 12, 24, 36. Default Value: 1.
ComputeResource string
The specifications of computing resources in elastic mode. The increase of resources can speed up queries. AnalyticDB for MySQL automatically scales computing resources. For more information, see ComputeResource
DbClusterClass string
It duplicates with attribute db_node_class and is deprecated from 1.121.2.

Deprecated: It duplicates with attribute db_node_class and is deprecated from 1.121.2.

DbClusterVersion Changes to this property will trigger replacement. string
The db cluster version. Valid values: 3.0. Default Value: 3.0.
DbNodeClass string
The db node class. For more information, see DBClusterClass
DbNodeCount int
The db node count.
DbNodeStorage int
The db node storage.
Description string
The description of DBCluster.
DiskEncryption Changes to this property will trigger replacement. bool
Specifies whether to enable disk encryption. Default Value: false. Valid values: true, false.
DiskPerformanceLevel string
The ESSD performance level. Default Value: PL1. Valid values: PL1, PL2, PL3.
ElasticIoResource int
The elastic io resource.
ElasticIoResourceSize string
The specifications of a single elastic resource node. Default Value: 8Core64GB. Valid values:

  • 8Core64GB: If you set elastic_io_resource_size to 8Core64GB, the specifications of an EIU are 24 cores and 192 GB memory.
  • 12Core96GB: If you set elastic_io_resource_size to 12Core96GB, the specifications of an EIU are 36 cores and 288 GB memory.
  • 16Core128GB: (Available since v1.237.0)If you set elastic_io_resource_size to 16Core128GB, the specifications of an EIU are 48 cores and 384 GB memory.
EnableSsl bool
Specifies whether to enable SSL encryption. Default Value: false. Valid values: true, false.
KernelVersion string
The minor version to which you want to update.
KmsId Changes to this property will trigger replacement. string
The Key Management Service (KMS) ID that is used for disk encryption. kms_id is valid only when disk_encryption is set to true.
MaintainTime string
The maintenance window of the cluster. Format: hh:mmZ-hh:mmZ.
ModifyType string
The modify type.
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: PayAsYouGo and Subscription. Default Value: 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 payment_type is Subscription. 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 affect the resource.

RenewalStatus string
Valid values are AutoRenewal, Normal, NotRenewal, Default to NotRenewal.
ResourceGroupId string
The ID of the resource group.
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]).
SwitchMode int
The time when to perform the update. Valid values:
Tags Dictionary<string, string>

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 Changes to this property will trigger replacement. string
The vpc ID of the resource.
VswitchId Changes to this property will trigger replacement. string
The vswitch id.
ZoneId Changes to this property will trigger replacement. string
The zone ID of the resource.
DbClusterCategory This property is required. string
The db cluster category. Valid values: Basic, Cluster, MixedStorage.
Mode This property is required. string
The mode of the cluster. Valid values: reserver, flexible.
AutoRenewPeriod int
Auto-renewal period of an cluster, in the unit of the month. It is valid when payment_type is Subscription. Valid values: 1, 2, 3, 6, 12, 24, 36. Default Value: 1.
ComputeResource string
The specifications of computing resources in elastic mode. The increase of resources can speed up queries. AnalyticDB for MySQL automatically scales computing resources. For more information, see ComputeResource
DbClusterClass string
It duplicates with attribute db_node_class and is deprecated from 1.121.2.

Deprecated: It duplicates with attribute db_node_class and is deprecated from 1.121.2.

DbClusterVersion Changes to this property will trigger replacement. string
The db cluster version. Valid values: 3.0. Default Value: 3.0.
DbNodeClass string
The db node class. For more information, see DBClusterClass
DbNodeCount int
The db node count.
DbNodeStorage int
The db node storage.
Description string
The description of DBCluster.
DiskEncryption Changes to this property will trigger replacement. bool
Specifies whether to enable disk encryption. Default Value: false. Valid values: true, false.
DiskPerformanceLevel string
The ESSD performance level. Default Value: PL1. Valid values: PL1, PL2, PL3.
ElasticIoResource int
The elastic io resource.
ElasticIoResourceSize string
The specifications of a single elastic resource node. Default Value: 8Core64GB. Valid values:

  • 8Core64GB: If you set elastic_io_resource_size to 8Core64GB, the specifications of an EIU are 24 cores and 192 GB memory.
  • 12Core96GB: If you set elastic_io_resource_size to 12Core96GB, the specifications of an EIU are 36 cores and 288 GB memory.
  • 16Core128GB: (Available since v1.237.0)If you set elastic_io_resource_size to 16Core128GB, the specifications of an EIU are 48 cores and 384 GB memory.
EnableSsl bool
Specifies whether to enable SSL encryption. Default Value: false. Valid values: true, false.
KernelVersion string
The minor version to which you want to update.
KmsId Changes to this property will trigger replacement. string
The Key Management Service (KMS) ID that is used for disk encryption. kms_id is valid only when disk_encryption is set to true.
MaintainTime string
The maintenance window of the cluster. Format: hh:mmZ-hh:mmZ.
ModifyType string
The modify type.
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: PayAsYouGo and Subscription. Default Value: 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 payment_type is Subscription. 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 affect the resource.

RenewalStatus string
Valid values are AutoRenewal, Normal, NotRenewal, Default to NotRenewal.
ResourceGroupId string
The ID of the resource group.
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]).
SwitchMode int
The time when to perform the update. Valid values:
Tags map[string]string

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 Changes to this property will trigger replacement. string
The vpc ID of the resource.
VswitchId Changes to this property will trigger replacement. string
The vswitch id.
ZoneId Changes to this property will trigger replacement. string
The zone ID of the resource.
dbClusterCategory This property is required. String
The db cluster category. Valid values: Basic, Cluster, MixedStorage.
mode This property is required. String
The mode of the cluster. Valid values: reserver, flexible.
autoRenewPeriod Integer
Auto-renewal period of an cluster, in the unit of the month. It is valid when payment_type is Subscription. Valid values: 1, 2, 3, 6, 12, 24, 36. Default Value: 1.
computeResource String
The specifications of computing resources in elastic mode. The increase of resources can speed up queries. AnalyticDB for MySQL automatically scales computing resources. For more information, see ComputeResource
dbClusterClass String
It duplicates with attribute db_node_class and is deprecated from 1.121.2.

Deprecated: It duplicates with attribute db_node_class and is deprecated from 1.121.2.

dbClusterVersion Changes to this property will trigger replacement. String
The db cluster version. Valid values: 3.0. Default Value: 3.0.
dbNodeClass String
The db node class. For more information, see DBClusterClass
dbNodeCount Integer
The db node count.
dbNodeStorage Integer
The db node storage.
description String
The description of DBCluster.
diskEncryption Changes to this property will trigger replacement. Boolean
Specifies whether to enable disk encryption. Default Value: false. Valid values: true, false.
diskPerformanceLevel String
The ESSD performance level. Default Value: PL1. Valid values: PL1, PL2, PL3.
elasticIoResource Integer
The elastic io resource.
elasticIoResourceSize String
The specifications of a single elastic resource node. Default Value: 8Core64GB. Valid values:

  • 8Core64GB: If you set elastic_io_resource_size to 8Core64GB, the specifications of an EIU are 24 cores and 192 GB memory.
  • 12Core96GB: If you set elastic_io_resource_size to 12Core96GB, the specifications of an EIU are 36 cores and 288 GB memory.
  • 16Core128GB: (Available since v1.237.0)If you set elastic_io_resource_size to 16Core128GB, the specifications of an EIU are 48 cores and 384 GB memory.
enableSsl Boolean
Specifies whether to enable SSL encryption. Default Value: false. Valid values: true, false.
kernelVersion String
The minor version to which you want to update.
kmsId Changes to this property will trigger replacement. String
The Key Management Service (KMS) ID that is used for disk encryption. kms_id is valid only when disk_encryption is set to true.
maintainTime String
The maintenance window of the cluster. Format: hh:mmZ-hh:mmZ.
modifyType String
The modify type.
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: PayAsYouGo and Subscription. Default Value: 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 payment_type is Subscription. 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 affect the resource.

renewalStatus String
Valid values are AutoRenewal, Normal, NotRenewal, Default to NotRenewal.
resourceGroupId String
The ID of the resource group.
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]).
switchMode Integer
The time when to perform the update. Valid values:
tags Map<String,String>

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 Changes to this property will trigger replacement. String
The vpc ID of the resource.
vswitchId Changes to this property will trigger replacement. String
The vswitch id.
zoneId Changes to this property will trigger replacement. String
The zone ID of the resource.
dbClusterCategory This property is required. string
The db cluster category. Valid values: Basic, Cluster, MixedStorage.
mode This property is required. string
The mode of the cluster. Valid values: reserver, flexible.
autoRenewPeriod number
Auto-renewal period of an cluster, in the unit of the month. It is valid when payment_type is Subscription. Valid values: 1, 2, 3, 6, 12, 24, 36. Default Value: 1.
computeResource string
The specifications of computing resources in elastic mode. The increase of resources can speed up queries. AnalyticDB for MySQL automatically scales computing resources. For more information, see ComputeResource
dbClusterClass string
It duplicates with attribute db_node_class and is deprecated from 1.121.2.

Deprecated: It duplicates with attribute db_node_class and is deprecated from 1.121.2.

dbClusterVersion Changes to this property will trigger replacement. string
The db cluster version. Valid values: 3.0. Default Value: 3.0.
dbNodeClass string
The db node class. For more information, see DBClusterClass
dbNodeCount number
The db node count.
dbNodeStorage number
The db node storage.
description string
The description of DBCluster.
diskEncryption Changes to this property will trigger replacement. boolean
Specifies whether to enable disk encryption. Default Value: false. Valid values: true, false.
diskPerformanceLevel string
The ESSD performance level. Default Value: PL1. Valid values: PL1, PL2, PL3.
elasticIoResource number
The elastic io resource.
elasticIoResourceSize string
The specifications of a single elastic resource node. Default Value: 8Core64GB. Valid values:

  • 8Core64GB: If you set elastic_io_resource_size to 8Core64GB, the specifications of an EIU are 24 cores and 192 GB memory.
  • 12Core96GB: If you set elastic_io_resource_size to 12Core96GB, the specifications of an EIU are 36 cores and 288 GB memory.
  • 16Core128GB: (Available since v1.237.0)If you set elastic_io_resource_size to 16Core128GB, the specifications of an EIU are 48 cores and 384 GB memory.
enableSsl boolean
Specifies whether to enable SSL encryption. Default Value: false. Valid values: true, false.
kernelVersion string
The minor version to which you want to update.
kmsId Changes to this property will trigger replacement. string
The Key Management Service (KMS) ID that is used for disk encryption. kms_id is valid only when disk_encryption is set to true.
maintainTime string
The maintenance window of the cluster. Format: hh:mmZ-hh:mmZ.
modifyType string
The modify type.
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: PayAsYouGo and Subscription. Default Value: 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 payment_type is Subscription. 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 affect the resource.

renewalStatus string
Valid values are AutoRenewal, Normal, NotRenewal, Default to NotRenewal.
resourceGroupId string
The ID of the resource group.
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]).
switchMode number
The time when to perform the update. Valid values:
tags {[key: string]: string}

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 Changes to this property will trigger replacement. string
The vpc ID of the resource.
vswitchId Changes to this property will trigger replacement. string
The vswitch id.
zoneId Changes to this property will trigger replacement. string
The zone ID of the resource.
db_cluster_category This property is required. str
The db cluster category. Valid values: Basic, Cluster, MixedStorage.
mode This property is required. str
The mode of the cluster. Valid values: reserver, flexible.
auto_renew_period int
Auto-renewal period of an cluster, in the unit of the month. It is valid when payment_type is Subscription. Valid values: 1, 2, 3, 6, 12, 24, 36. Default Value: 1.
compute_resource str
The specifications of computing resources in elastic mode. The increase of resources can speed up queries. AnalyticDB for MySQL automatically scales computing resources. For more information, see ComputeResource
db_cluster_class str
It duplicates with attribute db_node_class and is deprecated from 1.121.2.

Deprecated: It duplicates with attribute db_node_class and is deprecated from 1.121.2.

db_cluster_version Changes to this property will trigger replacement. str
The db cluster version. Valid values: 3.0. Default Value: 3.0.
db_node_class str
The db node class. For more information, see DBClusterClass
db_node_count int
The db node count.
db_node_storage int
The db node storage.
description str
The description of DBCluster.
disk_encryption Changes to this property will trigger replacement. bool
Specifies whether to enable disk encryption. Default Value: false. Valid values: true, false.
disk_performance_level str
The ESSD performance level. Default Value: PL1. Valid values: PL1, PL2, PL3.
elastic_io_resource int
The elastic io resource.
elastic_io_resource_size str
The specifications of a single elastic resource node. Default Value: 8Core64GB. Valid values:

  • 8Core64GB: If you set elastic_io_resource_size to 8Core64GB, the specifications of an EIU are 24 cores and 192 GB memory.
  • 12Core96GB: If you set elastic_io_resource_size to 12Core96GB, the specifications of an EIU are 36 cores and 288 GB memory.
  • 16Core128GB: (Available since v1.237.0)If you set elastic_io_resource_size to 16Core128GB, the specifications of an EIU are 48 cores and 384 GB memory.
enable_ssl bool
Specifies whether to enable SSL encryption. Default Value: false. Valid values: true, false.
kernel_version str
The minor version to which you want to update.
kms_id Changes to this property will trigger replacement. str
The Key Management Service (KMS) ID that is used for disk encryption. kms_id is valid only when disk_encryption is set to true.
maintain_time str
The maintenance window of the cluster. Format: hh:mmZ-hh:mmZ.
modify_type str
The modify type.
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: PayAsYouGo and Subscription. Default Value: 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 payment_type is Subscription. 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 affect the resource.

renewal_status str
Valid values are AutoRenewal, Normal, NotRenewal, Default to NotRenewal.
resource_group_id str
The ID of the resource group.
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]).
switch_mode int
The time when to perform the update. Valid values:
tags Mapping[str, str]

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 Changes to this property will trigger replacement. str
The vpc ID of the resource.
vswitch_id Changes to this property will trigger replacement. str
The vswitch id.
zone_id Changes to this property will trigger replacement. str
The zone ID of the resource.
dbClusterCategory This property is required. String
The db cluster category. Valid values: Basic, Cluster, MixedStorage.
mode This property is required. String
The mode of the cluster. Valid values: reserver, flexible.
autoRenewPeriod Number
Auto-renewal period of an cluster, in the unit of the month. It is valid when payment_type is Subscription. Valid values: 1, 2, 3, 6, 12, 24, 36. Default Value: 1.
computeResource String
The specifications of computing resources in elastic mode. The increase of resources can speed up queries. AnalyticDB for MySQL automatically scales computing resources. For more information, see ComputeResource
dbClusterClass String
It duplicates with attribute db_node_class and is deprecated from 1.121.2.

Deprecated: It duplicates with attribute db_node_class and is deprecated from 1.121.2.

dbClusterVersion Changes to this property will trigger replacement. String
The db cluster version. Valid values: 3.0. Default Value: 3.0.
dbNodeClass String
The db node class. For more information, see DBClusterClass
dbNodeCount Number
The db node count.
dbNodeStorage Number
The db node storage.
description String
The description of DBCluster.
diskEncryption Changes to this property will trigger replacement. Boolean
Specifies whether to enable disk encryption. Default Value: false. Valid values: true, false.
diskPerformanceLevel String
The ESSD performance level. Default Value: PL1. Valid values: PL1, PL2, PL3.
elasticIoResource Number
The elastic io resource.
elasticIoResourceSize String
The specifications of a single elastic resource node. Default Value: 8Core64GB. Valid values:

  • 8Core64GB: If you set elastic_io_resource_size to 8Core64GB, the specifications of an EIU are 24 cores and 192 GB memory.
  • 12Core96GB: If you set elastic_io_resource_size to 12Core96GB, the specifications of an EIU are 36 cores and 288 GB memory.
  • 16Core128GB: (Available since v1.237.0)If you set elastic_io_resource_size to 16Core128GB, the specifications of an EIU are 48 cores and 384 GB memory.
enableSsl Boolean
Specifies whether to enable SSL encryption. Default Value: false. Valid values: true, false.
kernelVersion String
The minor version to which you want to update.
kmsId Changes to this property will trigger replacement. String
The Key Management Service (KMS) ID that is used for disk encryption. kms_id is valid only when disk_encryption is set to true.
maintainTime String
The maintenance window of the cluster. Format: hh:mmZ-hh:mmZ.
modifyType String
The modify type.
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: PayAsYouGo and Subscription. Default Value: 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 payment_type is Subscription. 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 affect the resource.

renewalStatus String
Valid values are AutoRenewal, Normal, NotRenewal, Default to NotRenewal.
resourceGroupId String
The ID of the resource group.
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]).
switchMode Number
The time when to perform the update. Valid values:
tags Map<String>

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 Changes to this property will trigger replacement. String
The vpc ID of the resource.
vswitchId Changes to this property will trigger replacement. String
The vswitch id.
zoneId Changes to this property will trigger replacement. String
The zone ID of the resource.

Outputs

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

ConnectionString string
The connection string of the cluster.
Id string
The provider-assigned unique ID for this managed resource.
Port string
(Available since v1.196.0) The connection port of the ADB cluster.
Status string
The status of the resource.
ConnectionString string
The connection string of the cluster.
Id string
The provider-assigned unique ID for this managed resource.
Port string
(Available since v1.196.0) The connection port of the ADB cluster.
Status string
The status of the resource.
connectionString String
The connection string of the cluster.
id String
The provider-assigned unique ID for this managed resource.
port String
(Available since v1.196.0) The connection port of the ADB cluster.
status String
The status of the resource.
connectionString string
The connection string of the cluster.
id string
The provider-assigned unique ID for this managed resource.
port string
(Available since v1.196.0) The connection port of the ADB cluster.
status string
The status of the resource.
connection_string str
The connection string of the cluster.
id str
The provider-assigned unique ID for this managed resource.
port str
(Available since v1.196.0) The connection port of the ADB cluster.
status str
The status of the resource.
connectionString String
The connection string of the cluster.
id String
The provider-assigned unique ID for this managed resource.
port String
(Available since v1.196.0) The connection port of the ADB cluster.
status String
The status of the resource.

Look up Existing DBCluster Resource

Get an existing DBCluster 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?: DBClusterState, opts?: CustomResourceOptions): DBCluster
@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_encryption: Optional[bool] = None,
        disk_performance_level: Optional[str] = None,
        elastic_io_resource: Optional[int] = None,
        elastic_io_resource_size: Optional[str] = None,
        enable_ssl: Optional[bool] = None,
        kernel_version: Optional[str] = None,
        kms_id: 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,
        switch_mode: Optional[int] = None,
        tags: Optional[Mapping[str, str]] = None,
        vpc_id: Optional[str] = None,
        vswitch_id: Optional[str] = None,
        zone_id: Optional[str] = None) -> DBCluster
func GetDBCluster(ctx *Context, name string, id IDInput, state *DBClusterState, opts ...ResourceOption) (*DBCluster, error)
public static DBCluster Get(string name, Input<string> id, DBClusterState? state, CustomResourceOptions? opts = null)
public static DBCluster get(String name, Output<String> id, DBClusterState state, CustomResourceOptions options)
resources:  _:    type: alicloud:adb:DBCluster    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 payment_type is Subscription. Valid values: 1, 2, 3, 6, 12, 24, 36. Default Value: 1.
ComputeResource string
The specifications of computing resources in elastic mode. The increase of resources can speed up queries. AnalyticDB for MySQL automatically scales computing resources. For more information, see ComputeResource
ConnectionString string
The connection string of the cluster.
DbClusterCategory string
The db cluster category. Valid values: Basic, Cluster, MixedStorage.
DbClusterClass string
It duplicates with attribute db_node_class and is deprecated from 1.121.2.

Deprecated: It duplicates with attribute db_node_class and is deprecated from 1.121.2.

DbClusterVersion Changes to this property will trigger replacement. string
The db cluster version. Valid values: 3.0. Default Value: 3.0.
DbNodeClass string
The db node class. For more information, see DBClusterClass
DbNodeCount int
The db node count.
DbNodeStorage int
The db node storage.
Description string
The description of DBCluster.
DiskEncryption Changes to this property will trigger replacement. bool
Specifies whether to enable disk encryption. Default Value: false. Valid values: true, false.
DiskPerformanceLevel string
The ESSD performance level. Default Value: PL1. Valid values: PL1, PL2, PL3.
ElasticIoResource int
The elastic io resource.
ElasticIoResourceSize string
The specifications of a single elastic resource node. Default Value: 8Core64GB. Valid values:

  • 8Core64GB: If you set elastic_io_resource_size to 8Core64GB, the specifications of an EIU are 24 cores and 192 GB memory.
  • 12Core96GB: If you set elastic_io_resource_size to 12Core96GB, the specifications of an EIU are 36 cores and 288 GB memory.
  • 16Core128GB: (Available since v1.237.0)If you set elastic_io_resource_size to 16Core128GB, the specifications of an EIU are 48 cores and 384 GB memory.
EnableSsl bool
Specifies whether to enable SSL encryption. Default Value: false. Valid values: true, false.
KernelVersion string
The minor version to which you want to update.
KmsId Changes to this property will trigger replacement. string
The Key Management Service (KMS) ID that is used for disk encryption. kms_id is valid only when disk_encryption is set to true.
MaintainTime string
The maintenance window of the cluster. Format: hh:mmZ-hh:mmZ.
Mode string
The mode of the cluster. Valid values: reserver, flexible.
ModifyType string
The modify type.
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: PayAsYouGo and Subscription. Default Value: 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 payment_type is Subscription. 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 affect the resource.

Port string
(Available since v1.196.0) The connection port of the ADB cluster.
RenewalStatus string
Valid values are AutoRenewal, Normal, NotRenewal, Default to NotRenewal.
ResourceGroupId string
The ID of the resource group.
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
The status of the resource.
SwitchMode int
The time when to perform the update. Valid values:
Tags Dictionary<string, string>

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 Changes to this property will trigger replacement. string
The vpc ID of the resource.
VswitchId Changes to this property will trigger replacement. string
The vswitch id.
ZoneId Changes to this property will trigger replacement. string
The zone ID of the resource.
AutoRenewPeriod int
Auto-renewal period of an cluster, in the unit of the month. It is valid when payment_type is Subscription. Valid values: 1, 2, 3, 6, 12, 24, 36. Default Value: 1.
ComputeResource string
The specifications of computing resources in elastic mode. The increase of resources can speed up queries. AnalyticDB for MySQL automatically scales computing resources. For more information, see ComputeResource
ConnectionString string
The connection string of the cluster.
DbClusterCategory string
The db cluster category. Valid values: Basic, Cluster, MixedStorage.
DbClusterClass string
It duplicates with attribute db_node_class and is deprecated from 1.121.2.

Deprecated: It duplicates with attribute db_node_class and is deprecated from 1.121.2.

DbClusterVersion Changes to this property will trigger replacement. string
The db cluster version. Valid values: 3.0. Default Value: 3.0.
DbNodeClass string
The db node class. For more information, see DBClusterClass
DbNodeCount int
The db node count.
DbNodeStorage int
The db node storage.
Description string
The description of DBCluster.
DiskEncryption Changes to this property will trigger replacement. bool
Specifies whether to enable disk encryption. Default Value: false. Valid values: true, false.
DiskPerformanceLevel string
The ESSD performance level. Default Value: PL1. Valid values: PL1, PL2, PL3.
ElasticIoResource int
The elastic io resource.
ElasticIoResourceSize string
The specifications of a single elastic resource node. Default Value: 8Core64GB. Valid values:

  • 8Core64GB: If you set elastic_io_resource_size to 8Core64GB, the specifications of an EIU are 24 cores and 192 GB memory.
  • 12Core96GB: If you set elastic_io_resource_size to 12Core96GB, the specifications of an EIU are 36 cores and 288 GB memory.
  • 16Core128GB: (Available since v1.237.0)If you set elastic_io_resource_size to 16Core128GB, the specifications of an EIU are 48 cores and 384 GB memory.
EnableSsl bool
Specifies whether to enable SSL encryption. Default Value: false. Valid values: true, false.
KernelVersion string
The minor version to which you want to update.
KmsId Changes to this property will trigger replacement. string
The Key Management Service (KMS) ID that is used for disk encryption. kms_id is valid only when disk_encryption is set to true.
MaintainTime string
The maintenance window of the cluster. Format: hh:mmZ-hh:mmZ.
Mode string
The mode of the cluster. Valid values: reserver, flexible.
ModifyType string
The modify type.
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: PayAsYouGo and Subscription. Default Value: 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 payment_type is Subscription. 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 affect the resource.

Port string
(Available since v1.196.0) The connection port of the ADB cluster.
RenewalStatus string
Valid values are AutoRenewal, Normal, NotRenewal, Default to NotRenewal.
ResourceGroupId string
The ID of the resource group.
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
The status of the resource.
SwitchMode int
The time when to perform the update. Valid values:
Tags map[string]string

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 Changes to this property will trigger replacement. string
The vpc ID of the resource.
VswitchId Changes to this property will trigger replacement. string
The vswitch id.
ZoneId Changes to this property will trigger replacement. string
The zone ID of the resource.
autoRenewPeriod Integer
Auto-renewal period of an cluster, in the unit of the month. It is valid when payment_type is Subscription. Valid values: 1, 2, 3, 6, 12, 24, 36. Default Value: 1.
computeResource String
The specifications of computing resources in elastic mode. The increase of resources can speed up queries. AnalyticDB for MySQL automatically scales computing resources. For more information, see ComputeResource
connectionString String
The connection string of the cluster.
dbClusterCategory String
The db cluster category. Valid values: Basic, Cluster, MixedStorage.
dbClusterClass String
It duplicates with attribute db_node_class and is deprecated from 1.121.2.

Deprecated: It duplicates with attribute db_node_class and is deprecated from 1.121.2.

dbClusterVersion Changes to this property will trigger replacement. String
The db cluster version. Valid values: 3.0. Default Value: 3.0.
dbNodeClass String
The db node class. For more information, see DBClusterClass
dbNodeCount Integer
The db node count.
dbNodeStorage Integer
The db node storage.
description String
The description of DBCluster.
diskEncryption Changes to this property will trigger replacement. Boolean
Specifies whether to enable disk encryption. Default Value: false. Valid values: true, false.
diskPerformanceLevel String
The ESSD performance level. Default Value: PL1. Valid values: PL1, PL2, PL3.
elasticIoResource Integer
The elastic io resource.
elasticIoResourceSize String
The specifications of a single elastic resource node. Default Value: 8Core64GB. Valid values:

  • 8Core64GB: If you set elastic_io_resource_size to 8Core64GB, the specifications of an EIU are 24 cores and 192 GB memory.
  • 12Core96GB: If you set elastic_io_resource_size to 12Core96GB, the specifications of an EIU are 36 cores and 288 GB memory.
  • 16Core128GB: (Available since v1.237.0)If you set elastic_io_resource_size to 16Core128GB, the specifications of an EIU are 48 cores and 384 GB memory.
enableSsl Boolean
Specifies whether to enable SSL encryption. Default Value: false. Valid values: true, false.
kernelVersion String
The minor version to which you want to update.
kmsId Changes to this property will trigger replacement. String
The Key Management Service (KMS) ID that is used for disk encryption. kms_id is valid only when disk_encryption is set to true.
maintainTime String
The maintenance window of the cluster. Format: hh:mmZ-hh:mmZ.
mode String
The mode of the cluster. Valid values: reserver, flexible.
modifyType String
The modify type.
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: PayAsYouGo and Subscription. Default Value: 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 payment_type is Subscription. 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 affect the resource.

port String
(Available since v1.196.0) The connection port of the ADB cluster.
renewalStatus String
Valid values are AutoRenewal, Normal, NotRenewal, Default to NotRenewal.
resourceGroupId String
The ID of the resource group.
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
The status of the resource.
switchMode Integer
The time when to perform the update. Valid values:
tags Map<String,String>

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 Changes to this property will trigger replacement. String
The vpc ID of the resource.
vswitchId Changes to this property will trigger replacement. String
The vswitch id.
zoneId Changes to this property will trigger replacement. String
The zone ID of the resource.
autoRenewPeriod number
Auto-renewal period of an cluster, in the unit of the month. It is valid when payment_type is Subscription. Valid values: 1, 2, 3, 6, 12, 24, 36. Default Value: 1.
computeResource string
The specifications of computing resources in elastic mode. The increase of resources can speed up queries. AnalyticDB for MySQL automatically scales computing resources. For more information, see ComputeResource
connectionString string
The connection string of the cluster.
dbClusterCategory string
The db cluster category. Valid values: Basic, Cluster, MixedStorage.
dbClusterClass string
It duplicates with attribute db_node_class and is deprecated from 1.121.2.

Deprecated: It duplicates with attribute db_node_class and is deprecated from 1.121.2.

dbClusterVersion Changes to this property will trigger replacement. string
The db cluster version. Valid values: 3.0. Default Value: 3.0.
dbNodeClass string
The db node class. For more information, see DBClusterClass
dbNodeCount number
The db node count.
dbNodeStorage number
The db node storage.
description string
The description of DBCluster.
diskEncryption Changes to this property will trigger replacement. boolean
Specifies whether to enable disk encryption. Default Value: false. Valid values: true, false.
diskPerformanceLevel string
The ESSD performance level. Default Value: PL1. Valid values: PL1, PL2, PL3.
elasticIoResource number
The elastic io resource.
elasticIoResourceSize string
The specifications of a single elastic resource node. Default Value: 8Core64GB. Valid values:

  • 8Core64GB: If you set elastic_io_resource_size to 8Core64GB, the specifications of an EIU are 24 cores and 192 GB memory.
  • 12Core96GB: If you set elastic_io_resource_size to 12Core96GB, the specifications of an EIU are 36 cores and 288 GB memory.
  • 16Core128GB: (Available since v1.237.0)If you set elastic_io_resource_size to 16Core128GB, the specifications of an EIU are 48 cores and 384 GB memory.
enableSsl boolean
Specifies whether to enable SSL encryption. Default Value: false. Valid values: true, false.
kernelVersion string
The minor version to which you want to update.
kmsId Changes to this property will trigger replacement. string
The Key Management Service (KMS) ID that is used for disk encryption. kms_id is valid only when disk_encryption is set to true.
maintainTime string
The maintenance window of the cluster. Format: hh:mmZ-hh:mmZ.
mode string
The mode of the cluster. Valid values: reserver, flexible.
modifyType string
The modify type.
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: PayAsYouGo and Subscription. Default Value: 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 payment_type is Subscription. 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 affect the resource.

port string
(Available since v1.196.0) The connection port of the ADB cluster.
renewalStatus string
Valid values are AutoRenewal, Normal, NotRenewal, Default to NotRenewal.
resourceGroupId string
The ID of the resource group.
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
The status of the resource.
switchMode number
The time when to perform the update. Valid values:
tags {[key: string]: string}

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 Changes to this property will trigger replacement. string
The vpc ID of the resource.
vswitchId Changes to this property will trigger replacement. string
The vswitch id.
zoneId Changes to this property will trigger replacement. string
The zone ID of the resource.
auto_renew_period int
Auto-renewal period of an cluster, in the unit of the month. It is valid when payment_type is Subscription. Valid values: 1, 2, 3, 6, 12, 24, 36. Default Value: 1.
compute_resource str
The specifications of computing resources in elastic mode. The increase of resources can speed up queries. AnalyticDB for MySQL automatically scales computing resources. For more information, see ComputeResource
connection_string str
The connection string of the cluster.
db_cluster_category str
The db cluster category. Valid values: Basic, Cluster, MixedStorage.
db_cluster_class str
It duplicates with attribute db_node_class and is deprecated from 1.121.2.

Deprecated: It duplicates with attribute db_node_class and is deprecated from 1.121.2.

db_cluster_version Changes to this property will trigger replacement. str
The db cluster version. Valid values: 3.0. Default Value: 3.0.
db_node_class str
The db node class. For more information, see DBClusterClass
db_node_count int
The db node count.
db_node_storage int
The db node storage.
description str
The description of DBCluster.
disk_encryption Changes to this property will trigger replacement. bool
Specifies whether to enable disk encryption. Default Value: false. Valid values: true, false.
disk_performance_level str
The ESSD performance level. Default Value: PL1. Valid values: PL1, PL2, PL3.
elastic_io_resource int
The elastic io resource.
elastic_io_resource_size str
The specifications of a single elastic resource node. Default Value: 8Core64GB. Valid values:

  • 8Core64GB: If you set elastic_io_resource_size to 8Core64GB, the specifications of an EIU are 24 cores and 192 GB memory.
  • 12Core96GB: If you set elastic_io_resource_size to 12Core96GB, the specifications of an EIU are 36 cores and 288 GB memory.
  • 16Core128GB: (Available since v1.237.0)If you set elastic_io_resource_size to 16Core128GB, the specifications of an EIU are 48 cores and 384 GB memory.
enable_ssl bool
Specifies whether to enable SSL encryption. Default Value: false. Valid values: true, false.
kernel_version str
The minor version to which you want to update.
kms_id Changes to this property will trigger replacement. str
The Key Management Service (KMS) ID that is used for disk encryption. kms_id is valid only when disk_encryption is set to true.
maintain_time str
The maintenance window of the cluster. Format: hh:mmZ-hh:mmZ.
mode str
The mode of the cluster. Valid values: reserver, flexible.
modify_type str
The modify type.
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: PayAsYouGo and Subscription. Default Value: 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 payment_type is Subscription. 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 affect the resource.

port str
(Available since v1.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
The ID of the resource group.
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
The status of the resource.
switch_mode int
The time when to perform the update. Valid values:
tags Mapping[str, str]

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 Changes to this property will trigger replacement. str
The vpc ID of the resource.
vswitch_id Changes to this property will trigger replacement. str
The vswitch id.
zone_id Changes to this property will trigger replacement. str
The zone ID of the resource.
autoRenewPeriod Number
Auto-renewal period of an cluster, in the unit of the month. It is valid when payment_type is Subscription. Valid values: 1, 2, 3, 6, 12, 24, 36. Default Value: 1.
computeResource String
The specifications of computing resources in elastic mode. The increase of resources can speed up queries. AnalyticDB for MySQL automatically scales computing resources. For more information, see ComputeResource
connectionString String
The connection string of the cluster.
dbClusterCategory String
The db cluster category. Valid values: Basic, Cluster, MixedStorage.
dbClusterClass String
It duplicates with attribute db_node_class and is deprecated from 1.121.2.

Deprecated: It duplicates with attribute db_node_class and is deprecated from 1.121.2.

dbClusterVersion Changes to this property will trigger replacement. String
The db cluster version. Valid values: 3.0. Default Value: 3.0.
dbNodeClass String
The db node class. For more information, see DBClusterClass
dbNodeCount Number
The db node count.
dbNodeStorage Number
The db node storage.
description String
The description of DBCluster.
diskEncryption Changes to this property will trigger replacement. Boolean
Specifies whether to enable disk encryption. Default Value: false. Valid values: true, false.
diskPerformanceLevel String
The ESSD performance level. Default Value: PL1. Valid values: PL1, PL2, PL3.
elasticIoResource Number
The elastic io resource.
elasticIoResourceSize String
The specifications of a single elastic resource node. Default Value: 8Core64GB. Valid values:

  • 8Core64GB: If you set elastic_io_resource_size to 8Core64GB, the specifications of an EIU are 24 cores and 192 GB memory.
  • 12Core96GB: If you set elastic_io_resource_size to 12Core96GB, the specifications of an EIU are 36 cores and 288 GB memory.
  • 16Core128GB: (Available since v1.237.0)If you set elastic_io_resource_size to 16Core128GB, the specifications of an EIU are 48 cores and 384 GB memory.
enableSsl Boolean
Specifies whether to enable SSL encryption. Default Value: false. Valid values: true, false.
kernelVersion String
The minor version to which you want to update.
kmsId Changes to this property will trigger replacement. String
The Key Management Service (KMS) ID that is used for disk encryption. kms_id is valid only when disk_encryption is set to true.
maintainTime String
The maintenance window of the cluster. Format: hh:mmZ-hh:mmZ.
mode String
The mode of the cluster. Valid values: reserver, flexible.
modifyType String
The modify type.
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: PayAsYouGo and Subscription. Default Value: 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 payment_type is Subscription. 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 affect the resource.

port String
(Available since v1.196.0) The connection port of the ADB cluster.
renewalStatus String
Valid values are AutoRenewal, Normal, NotRenewal, Default to NotRenewal.
resourceGroupId String
The ID of the resource group.
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
The status of the resource.
switchMode Number
The time when to perform the update. Valid values:
tags Map<String>

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 Changes to this property will trigger replacement. String
The vpc ID of the resource.
vswitchId Changes to this property will trigger replacement. String
The vswitch id.
zoneId Changes to this property will trigger replacement. String
The zone ID of the resource.

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.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-alicloud