Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Alibaba Cloud Provider
  3. API Docs
  4. adb
  5. DBCluster
Alibaba Cloud v3.66.0 published on Friday, Nov 15, 2024 by Pulumi
pulumi/pulumi-alicloud

alicloud.adb.DBCluster

Explore with Pulumi AI

alicloud logo
Alibaba Cloud v3.66.0 published on Friday, Nov 15, 2024 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>

    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,
              kms_id: Optional[str] = None,
              db_cluster_version: Optional[str] = None,
              maintain_time: Optional[str] = None,
              compute_resource: 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,
              zone_id: Optional[str] = None,
              db_cluster_class: Optional[str] = None,
              db_node_class: 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, str]] = None,
              vpc_id: Optional[str] = None,
              vswitch_id: Optional[str] = None,
              auto_renew_period: Optional[int] = 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 string
    The unique name of the resource.
    args DBClusterArgs
    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 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 string
    The unique name of the resource.
    args DBClusterArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DBClusterArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args 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",
    KmsId = "string",
    DbClusterVersion = "string",
    MaintainTime = "string",
    ComputeResource = "string",
    DbNodeCount = 0,
    DbNodeStorage = 0,
    Description = "string",
    DiskEncryption = false,
    DiskPerformanceLevel = "string",
    ElasticIoResource = 0,
    ElasticIoResourceSize = "string",
    EnableSsl = false,
    ZoneId = "string",
    DbNodeClass = "string",
    ModifyType = "string",
    PaymentType = "string",
    Period = 0,
    RenewalStatus = "string",
    ResourceGroupId = "string",
    SecurityIps = new[]
    {
        "string",
    },
    Tags = 
    {
        { "string", "string" },
    },
    VpcId = "string",
    VswitchId = "string",
    AutoRenewPeriod = 0,
});

    example, err := adb.NewDBCluster(ctx, "dbclusterResource", &adb.DBClusterArgs{
	DbClusterCategory:     pulumi.String("string"),
	Mode:                  pulumi.String("string"),
	KmsId:                 pulumi.String("string"),
	DbClusterVersion:      pulumi.String("string"),
	MaintainTime:          pulumi.String("string"),
	ComputeResource:       pulumi.String("string"),
	DbNodeCount:           pulumi.Int(0),
	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),
	ZoneId:                pulumi.String("string"),
	DbNodeClass:           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"),
	},
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	VpcId:           pulumi.String("string"),
	VswitchId:       pulumi.String("string"),
	AutoRenewPeriod: pulumi.Int(0),
})

    var dbclusterResource = new DBCluster("dbclusterResource", DBClusterArgs.builder()
    .dbClusterCategory("string")
    .mode("string")
    .kmsId("string")
    .dbClusterVersion("string")
    .maintainTime("string")
    .computeResource("string")
    .dbNodeCount(0)
    .dbNodeStorage(0)
    .description("string")
    .diskEncryption(false)
    .diskPerformanceLevel("string")
    .elasticIoResource(0)
    .elasticIoResourceSize("string")
    .enableSsl(false)
    .zoneId("string")
    .dbNodeClass("string")
    .modifyType("string")
    .paymentType("string")
    .period(0)
    .renewalStatus("string")
    .resourceGroupId("string")
    .securityIps("string")
    .tags(Map.of("string", "string"))
    .vpcId("string")
    .vswitchId("string")
    .autoRenewPeriod(0)
    .build());

    dbcluster_resource = alicloud.adb.DBCluster("dbclusterResource",
    db_cluster_category="string",
    mode="string",
    kms_id="string",
    db_cluster_version="string",
    maintain_time="string",
    compute_resource="string",
    db_node_count=0,
    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,
    zone_id="string",
    db_node_class="string",
    modify_type="string",
    payment_type="string",
    period=0,
    renewal_status="string",
    resource_group_id="string",
    security_ips=["string"],
    tags={
        "string": "string",
    },
    vpc_id="string",
    vswitch_id="string",
    auto_renew_period=0)

    const dbclusterResource = new alicloud.adb.DBCluster("dbclusterResource", {
    dbClusterCategory: "string",
    mode: "string",
    kmsId: "string",
    dbClusterVersion: "string",
    maintainTime: "string",
    computeResource: "string",
    dbNodeCount: 0,
    dbNodeStorage: 0,
    description: "string",
    diskEncryption: false,
    diskPerformanceLevel: "string",
    elasticIoResource: 0,
    elasticIoResourceSize: "string",
    enableSsl: false,
    zoneId: "string",
    dbNodeClass: "string",
    modifyType: "string",
    paymentType: "string",
    period: 0,
    renewalStatus: "string",
    resourceGroupId: "string",
    securityIps: ["string"],
    tags: {
        string: "string",
    },
    vpcId: "string",
    vswitchId: "string",
    autoRenewPeriod: 0,
});

    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
    kmsId: string
    maintainTime: string
    mode: string
    modifyType: string
    paymentType: string
    period: 0
    renewalStatus: string
    resourceGroupId: string
    securityIps:
        - string
    tags:
        string: string
    vpcId: string
    vswitchId: string
    zoneId: string

    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 string
    The db cluster category. Valid values: Basic, Cluster, MixedStorage.
    Mode 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 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 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.
    EnableSsl bool
    Specifies whether to enable SSL encryption. Default Value: false. Valid values: true, false.
    KmsId 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]).
    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 string
    The vpc ID of the resource.
    VswitchId string
    The vswitch id.
    ZoneId string
    The zone ID of the resource.
    DbClusterCategory string
    The db cluster category. Valid values: Basic, Cluster, MixedStorage.
    Mode 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 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 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.
    EnableSsl bool
    Specifies whether to enable SSL encryption. Default Value: false. Valid values: true, false.
    KmsId 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]).
    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 string
    The vpc ID of the resource.
    VswitchId string
    The vswitch id.
    ZoneId string
    The zone ID of the resource.
    dbClusterCategory String
    The db cluster category. Valid values: Basic, Cluster, MixedStorage.
    mode 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 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 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.
    enableSsl Boolean
    Specifies whether to enable SSL encryption. Default Value: false. Valid values: true, false.
    kmsId 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]).
    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 String
    The vpc ID of the resource.
    vswitchId String
    The vswitch id.
    zoneId String
    The zone ID of the resource.
    dbClusterCategory string
    The db cluster category. Valid values: Basic, Cluster, MixedStorage.
    mode 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 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 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.
    enableSsl boolean
    Specifies whether to enable SSL encryption. Default Value: false. Valid values: true, false.
    kmsId 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]).
    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 string
    The vpc ID of the resource.
    vswitchId string
    The vswitch id.
    zoneId string
    The zone ID of the resource.
    db_cluster_category str
    The db cluster category. Valid values: Basic, Cluster, MixedStorage.
    mode 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 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 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.
    enable_ssl bool
    Specifies whether to enable SSL encryption. Default Value: false. Valid values: true, false.
    kms_id 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]).
    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 str
    The vpc ID of the resource.
    vswitch_id str
    The vswitch id.
    zone_id str
    The zone ID of the resource.
    dbClusterCategory String
    The db cluster category. Valid values: Basic, Cluster, MixedStorage.
    mode 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 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 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.
    enableSsl Boolean
    Specifies whether to enable SSL encryption. Default Value: false. Valid values: true, false.
    kmsId 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]).
    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 String
    The vpc ID of the resource.
    vswitchId String
    The vswitch id.
    zoneId 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,
        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,
        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)
    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 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 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 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.
    EnableSsl bool
    Specifies whether to enable SSL encryption. Default Value: false. Valid values: true, false.
    KmsId 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.
    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 string
    The vpc ID of the resource.
    VswitchId string
    The vswitch id.
    ZoneId 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 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 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.
    EnableSsl bool
    Specifies whether to enable SSL encryption. Default Value: false. Valid values: true, false.
    KmsId 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.
    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 string
    The vpc ID of the resource.
    VswitchId string
    The vswitch id.
    ZoneId 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 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 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.
    enableSsl Boolean
    Specifies whether to enable SSL encryption. Default Value: false. Valid values: true, false.
    kmsId 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.
    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 String
    The vpc ID of the resource.
    vswitchId String
    The vswitch id.
    zoneId 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 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 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.
    enableSsl boolean
    Specifies whether to enable SSL encryption. Default Value: false. Valid values: true, false.
    kmsId 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.
    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 string
    The vpc ID of the resource.
    vswitchId string
    The vswitch id.
    zoneId 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 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 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.
    enable_ssl bool
    Specifies whether to enable SSL encryption. Default Value: false. Valid values: true, false.
    kms_id 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.
    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 str
    The vpc ID of the resource.
    vswitch_id str
    The vswitch id.
    zone_id 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 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 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.
    enableSsl Boolean
    Specifies whether to enable SSL encryption. Default Value: false. Valid values: true, false.
    kmsId 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.
    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 String
    The vpc ID of the resource.
    vswitchId String
    The vswitch id.
    zoneId 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.
    alicloud logo
    Alibaba Cloud v3.66.0 published on Friday, Nov 15, 2024 by Pulumi
    pulumi/pulumi-alicloud