1. Packages
  2. Alibaba Cloud Provider
  3. API Docs
  4. clickhouse
  5. getDbClusters
Alibaba Cloud v3.76.0 published on Tuesday, Apr 8, 2025 by Pulumi

alicloud.clickhouse.getDbClusters

Explore with Pulumi AI

Alibaba Cloud v3.76.0 published on Tuesday, Apr 8, 2025 by Pulumi

This data source provides the Click House DBCluster of the current Alibaba Cloud user.

NOTE: Available in v1.134.0+.

Example Usage

Basic Usage

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

const defaultDbCluster = new alicloud.clickhouse.DbCluster("default", {
    dbClusterVersion: "20.3.10.75",
    category: "Basic",
    dbClusterClass: "S8",
    dbClusterNetworkType: "vpc",
    dbNodeGroupCount: 1,
    paymentType: "PayAsYouGo",
    dbNodeStorage: "500",
    storageType: "cloud_essd",
    vswitchId: "your_vswitch_id",
});
const _default = alicloud.clickhouse.getDbClustersOutput({
    ids: [defaultDbCluster.id],
});
export const dbCluster = _default.apply(_default => _default.ids?.[0]);
Copy
import pulumi
import pulumi_alicloud as alicloud

default_db_cluster = alicloud.clickhouse.DbCluster("default",
    db_cluster_version="20.3.10.75",
    category="Basic",
    db_cluster_class="S8",
    db_cluster_network_type="vpc",
    db_node_group_count=1,
    payment_type="PayAsYouGo",
    db_node_storage="500",
    storage_type="cloud_essd",
    vswitch_id="your_vswitch_id")
default = alicloud.clickhouse.get_db_clusters_output(ids=[default_db_cluster.id])
pulumi.export("dbCluster", default.ids[0])
Copy
package main

import (
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/clickhouse"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
defaultDbCluster, err := clickhouse.NewDbCluster(ctx, "default", &clickhouse.DbClusterArgs{
DbClusterVersion: pulumi.String("20.3.10.75"),
Category: pulumi.String("Basic"),
DbClusterClass: pulumi.String("S8"),
DbClusterNetworkType: pulumi.String("vpc"),
DbNodeGroupCount: pulumi.Int(1),
PaymentType: pulumi.String("PayAsYouGo"),
DbNodeStorage: pulumi.String("500"),
StorageType: pulumi.String("cloud_essd"),
VswitchId: pulumi.String("your_vswitch_id"),
})
if err != nil {
return err
}
_default := clickhouse.GetDbClustersOutput(ctx, clickhouse.GetDbClustersOutputArgs{
Ids: pulumi.StringArray{
defaultDbCluster.ID(),
},
}, nil);
ctx.Export("dbCluster", _default.ApplyT(func(_default clickhouse.GetDbClustersResult) (*string, error) {
return &default.Ids[0], nil
}).(pulumi.StringPtrOutput))
return nil
})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AliCloud = Pulumi.AliCloud;

return await Deployment.RunAsync(() => 
{
    var defaultDbCluster = new AliCloud.ClickHouse.DbCluster("default", new()
    {
        DbClusterVersion = "20.3.10.75",
        Category = "Basic",
        DbClusterClass = "S8",
        DbClusterNetworkType = "vpc",
        DbNodeGroupCount = 1,
        PaymentType = "PayAsYouGo",
        DbNodeStorage = "500",
        StorageType = "cloud_essd",
        VswitchId = "your_vswitch_id",
    });

    var @default = AliCloud.ClickHouse.GetDbClusters.Invoke(new()
    {
        Ids = new[]
        {
            defaultDbCluster.Id,
        },
    });

    return new Dictionary<string, object?>
    {
        ["dbCluster"] = @default.Apply(@default => @default.Apply(getDbClustersResult => getDbClustersResult.Ids[0])),
    };
});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.clickhouse.DbCluster;
import com.pulumi.alicloud.clickhouse.DbClusterArgs;
import com.pulumi.alicloud.clickhouse.ClickhouseFunctions;
import com.pulumi.alicloud.clickhouse.inputs.GetDbClustersArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var defaultDbCluster = new DbCluster("defaultDbCluster", DbClusterArgs.builder()
            .dbClusterVersion("20.3.10.75")
            .category("Basic")
            .dbClusterClass("S8")
            .dbClusterNetworkType("vpc")
            .dbNodeGroupCount("1")
            .paymentType("PayAsYouGo")
            .dbNodeStorage("500")
            .storageType("cloud_essd")
            .vswitchId("your_vswitch_id")
            .build());

        final var default = ClickhouseFunctions.getDbClusters(GetDbClustersArgs.builder()
            .ids(defaultDbCluster.id())
            .build());

        ctx.export("dbCluster", default_.applyValue(default_ -> default_.ids()[0]));
    }
}
Copy
resources:
  defaultDbCluster:
    type: alicloud:clickhouse:DbCluster
    name: default
    properties:
      dbClusterVersion: 20.3.10.75
      category: Basic
      dbClusterClass: S8
      dbClusterNetworkType: vpc
      dbNodeGroupCount: '1'
      paymentType: PayAsYouGo
      dbNodeStorage: '500'
      storageType: cloud_essd
      vswitchId: your_vswitch_id
variables:
  default:
    fn::invoke:
      function: alicloud:clickhouse:getDbClusters
      arguments:
        ids:
          - ${defaultDbCluster.id}
outputs:
  dbCluster: ${default.ids[0]}
Copy

Using getDbClusters

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getDbClusters(args: GetDbClustersArgs, opts?: InvokeOptions): Promise<GetDbClustersResult>
function getDbClustersOutput(args: GetDbClustersOutputArgs, opts?: InvokeOptions): Output<GetDbClustersResult>
Copy
def get_db_clusters(db_cluster_description: Optional[str] = None,
                    enable_details: Optional[bool] = None,
                    ids: Optional[Sequence[str]] = None,
                    output_file: Optional[str] = None,
                    status: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetDbClustersResult
def get_db_clusters_output(db_cluster_description: Optional[pulumi.Input[str]] = None,
                    enable_details: Optional[pulumi.Input[bool]] = None,
                    ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                    output_file: Optional[pulumi.Input[str]] = None,
                    status: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetDbClustersResult]
Copy
func GetDbClusters(ctx *Context, args *GetDbClustersArgs, opts ...InvokeOption) (*GetDbClustersResult, error)
func GetDbClustersOutput(ctx *Context, args *GetDbClustersOutputArgs, opts ...InvokeOption) GetDbClustersResultOutput
Copy

> Note: This function is named GetDbClusters in the Go SDK.

public static class GetDbClusters 
{
    public static Task<GetDbClustersResult> InvokeAsync(GetDbClustersArgs args, InvokeOptions? opts = null)
    public static Output<GetDbClustersResult> Invoke(GetDbClustersInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetDbClustersResult> getDbClusters(GetDbClustersArgs args, InvokeOptions options)
public static Output<GetDbClustersResult> getDbClusters(GetDbClustersArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: alicloud:clickhouse/getDbClusters:getDbClusters
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

DbClusterDescription Changes to this property will trigger replacement. string
The DBCluster description.
EnableDetails bool
Default to false. Set it to true can output more details about resource attributes.
Ids Changes to this property will trigger replacement. List<string>
A list of DBCluster IDs.
OutputFile string
File name where to save data source results (after running pulumi preview).
Status Changes to this property will trigger replacement. string
The status of the resource. Valid values: Running,Creating,Deleting,Restarting,Preparing,.
DbClusterDescription Changes to this property will trigger replacement. string
The DBCluster description.
EnableDetails bool
Default to false. Set it to true can output more details about resource attributes.
Ids Changes to this property will trigger replacement. []string
A list of DBCluster IDs.
OutputFile string
File name where to save data source results (after running pulumi preview).
Status Changes to this property will trigger replacement. string
The status of the resource. Valid values: Running,Creating,Deleting,Restarting,Preparing,.
dbClusterDescription Changes to this property will trigger replacement. String
The DBCluster description.
enableDetails Boolean
Default to false. Set it to true can output more details about resource attributes.
ids Changes to this property will trigger replacement. List<String>
A list of DBCluster IDs.
outputFile String
File name where to save data source results (after running pulumi preview).
status Changes to this property will trigger replacement. String
The status of the resource. Valid values: Running,Creating,Deleting,Restarting,Preparing,.
dbClusterDescription Changes to this property will trigger replacement. string
The DBCluster description.
enableDetails boolean
Default to false. Set it to true can output more details about resource attributes.
ids Changes to this property will trigger replacement. string[]
A list of DBCluster IDs.
outputFile string
File name where to save data source results (after running pulumi preview).
status Changes to this property will trigger replacement. string
The status of the resource. Valid values: Running,Creating,Deleting,Restarting,Preparing,.
db_cluster_description Changes to this property will trigger replacement. str
The DBCluster description.
enable_details bool
Default to false. Set it to true can output more details about resource attributes.
ids Changes to this property will trigger replacement. Sequence[str]
A list of DBCluster IDs.
output_file str
File name where to save data source results (after running pulumi preview).
status Changes to this property will trigger replacement. str
The status of the resource. Valid values: Running,Creating,Deleting,Restarting,Preparing,.
dbClusterDescription Changes to this property will trigger replacement. String
The DBCluster description.
enableDetails Boolean
Default to false. Set it to true can output more details about resource attributes.
ids Changes to this property will trigger replacement. List<String>
A list of DBCluster IDs.
outputFile String
File name where to save data source results (after running pulumi preview).
status Changes to this property will trigger replacement. String
The status of the resource. Valid values: Running,Creating,Deleting,Restarting,Preparing,.

getDbClusters Result

The following output properties are available:

Clusters List<Pulumi.AliCloud.ClickHouse.Outputs.GetDbClustersCluster>
Id string
The provider-assigned unique ID for this managed resource.
Ids List<string>
DbClusterDescription string
EnableDetails bool
OutputFile string
Status string
Clusters []GetDbClustersCluster
Id string
The provider-assigned unique ID for this managed resource.
Ids []string
DbClusterDescription string
EnableDetails bool
OutputFile string
Status string
clusters List<GetDbClustersCluster>
id String
The provider-assigned unique ID for this managed resource.
ids List<String>
dbClusterDescription String
enableDetails Boolean
outputFile String
status String
clusters GetDbClustersCluster[]
id string
The provider-assigned unique ID for this managed resource.
ids string[]
dbClusterDescription string
enableDetails boolean
outputFile string
status string
clusters Sequence[GetDbClustersCluster]
id str
The provider-assigned unique ID for this managed resource.
ids Sequence[str]
db_cluster_description str
enable_details bool
output_file str
status str
clusters List<Property Map>
id String
The provider-assigned unique ID for this managed resource.
ids List<String>
dbClusterDescription String
enableDetails Boolean
outputFile String
status String

Supporting Types

GetDbClustersCluster

AliUid This property is required. string
Alibaba Cloud account Id.
Bid This property is required. string
The ID of the business process flow.
Category This property is required. string
Instance family values include: Basic: Basic edition; HighAvailability: high availability edition.
CommodityCode This property is required. string
The Commodity Code of the DBCluster.
ConnectionString This property is required. string
Connection string.
ControlVersion This property is required. string
The control version of the DBCluster.
CreateTime This property is required. string
The creation time of the resource.
DbClusterAccessWhiteLists This property is required. List<Pulumi.AliCloud.ClickHouse.Inputs.GetDbClustersClusterDbClusterAccessWhiteList>
The db cluster access white list.
DbClusterDescription This property is required. string
The DBCluster description.
DbClusterId This property is required. string
DbClusterNetworkType This property is required. string
The DBCluster network type.
DbClusterType This property is required. string
The DBCluster type.
DbNodeClass This property is required. string
The node class of the DBCluster.
DbNodeCount This property is required. string
The node count of the DBCluster.
DbNodeStorage This property is required. string
The node storage of the DBCluster.
EncryptionKey This property is required. string
Key management service KMS key ID.
EncryptionType This property is required. string
Currently only supports ECS disk encryption, with a value of CloudDisk, not encrypted when empty.
Engine This property is required. string
The Engine of the DBCluster.
EngineVersion This property is required. string
The engine version of the DBCluster.
ExpireTime This property is required. string
The expiration time of the DBCluster.
Id This property is required. string
The ID of the DBCluster.
IsExpired This property is required. string
If the instance has expired.
LockMode This property is required. string
The lock mode of the DBCluster.
LockReason This property is required. string
Lock reason of the DBCluster.
MaintainTime This property is required. string
Examples of the maintenance window, in the format of hh:mmZ-hh:mm Z.
PaymentType This property is required. string
The payment type of the resource. Valid values: PayAsYouGo,Subscription.
Port This property is required. int
Connection port.
PublicConnectionString This property is required. string
A public IP address for the connection.
PublicPort This property is required. string
Public network port.
ScaleOutStatuses This property is required. List<Pulumi.AliCloud.ClickHouse.Inputs.GetDbClustersClusterScaleOutStatus>
Scale state.
Status This property is required. string
The status of the DBCluster. Valid values: Running,Creating,Deleting,Restarting,Preparing.
StorageType This property is required. string
Storage type of DBCluster. Valid values: cloud_essd, cloud_efficiency, cloud_essd_pl2, cloud_essd_pl3.
SupportBackup This property is required. int
Support fallback scheme.
SupportHttpsPort This property is required. bool
The system supports http port number.
SupportMysqlPort This property is required. bool
Supports Mysql, and those of the ports.
VpcCloudInstanceId This property is required. string
Virtual Private Cloud (VPC cloud instance ID.
VpcId This property is required. string
The VPC ID of the DBCluster.
VswitchId This property is required. string
The vswitch id of the DBCluster.
ZoneId This property is required. string
The zone ID of the DBCluster.
AliUid This property is required. string
Alibaba Cloud account Id.
Bid This property is required. string
The ID of the business process flow.
Category This property is required. string
Instance family values include: Basic: Basic edition; HighAvailability: high availability edition.
CommodityCode This property is required. string
The Commodity Code of the DBCluster.
ConnectionString This property is required. string
Connection string.
ControlVersion This property is required. string
The control version of the DBCluster.
CreateTime This property is required. string
The creation time of the resource.
DbClusterAccessWhiteLists This property is required. []GetDbClustersClusterDbClusterAccessWhiteList
The db cluster access white list.
DbClusterDescription This property is required. string
The DBCluster description.
DbClusterId This property is required. string
DbClusterNetworkType This property is required. string
The DBCluster network type.
DbClusterType This property is required. string
The DBCluster type.
DbNodeClass This property is required. string
The node class of the DBCluster.
DbNodeCount This property is required. string
The node count of the DBCluster.
DbNodeStorage This property is required. string
The node storage of the DBCluster.
EncryptionKey This property is required. string
Key management service KMS key ID.
EncryptionType This property is required. string
Currently only supports ECS disk encryption, with a value of CloudDisk, not encrypted when empty.
Engine This property is required. string
The Engine of the DBCluster.
EngineVersion This property is required. string
The engine version of the DBCluster.
ExpireTime This property is required. string
The expiration time of the DBCluster.
Id This property is required. string
The ID of the DBCluster.
IsExpired This property is required. string
If the instance has expired.
LockMode This property is required. string
The lock mode of the DBCluster.
LockReason This property is required. string
Lock reason of the DBCluster.
MaintainTime This property is required. string
Examples of the maintenance window, in the format of hh:mmZ-hh:mm Z.
PaymentType This property is required. string
The payment type of the resource. Valid values: PayAsYouGo,Subscription.
Port This property is required. int
Connection port.
PublicConnectionString This property is required. string
A public IP address for the connection.
PublicPort This property is required. string
Public network port.
ScaleOutStatuses This property is required. []GetDbClustersClusterScaleOutStatus
Scale state.
Status This property is required. string
The status of the DBCluster. Valid values: Running,Creating,Deleting,Restarting,Preparing.
StorageType This property is required. string
Storage type of DBCluster. Valid values: cloud_essd, cloud_efficiency, cloud_essd_pl2, cloud_essd_pl3.
SupportBackup This property is required. int
Support fallback scheme.
SupportHttpsPort This property is required. bool
The system supports http port number.
SupportMysqlPort This property is required. bool
Supports Mysql, and those of the ports.
VpcCloudInstanceId This property is required. string
Virtual Private Cloud (VPC cloud instance ID.
VpcId This property is required. string
The VPC ID of the DBCluster.
VswitchId This property is required. string
The vswitch id of the DBCluster.
ZoneId This property is required. string
The zone ID of the DBCluster.
aliUid This property is required. String
Alibaba Cloud account Id.
bid This property is required. String
The ID of the business process flow.
category This property is required. String
Instance family values include: Basic: Basic edition; HighAvailability: high availability edition.
commodityCode This property is required. String
The Commodity Code of the DBCluster.
connectionString This property is required. String
Connection string.
controlVersion This property is required. String
The control version of the DBCluster.
createTime This property is required. String
The creation time of the resource.
dbClusterAccessWhiteLists This property is required. List<GetDbClustersClusterDbClusterAccessWhiteList>
The db cluster access white list.
dbClusterDescription This property is required. String
The DBCluster description.
dbClusterId This property is required. String
dbClusterNetworkType This property is required. String
The DBCluster network type.
dbClusterType This property is required. String
The DBCluster type.
dbNodeClass This property is required. String
The node class of the DBCluster.
dbNodeCount This property is required. String
The node count of the DBCluster.
dbNodeStorage This property is required. String
The node storage of the DBCluster.
encryptionKey This property is required. String
Key management service KMS key ID.
encryptionType This property is required. String
Currently only supports ECS disk encryption, with a value of CloudDisk, not encrypted when empty.
engine This property is required. String
The Engine of the DBCluster.
engineVersion This property is required. String
The engine version of the DBCluster.
expireTime This property is required. String
The expiration time of the DBCluster.
id This property is required. String
The ID of the DBCluster.
isExpired This property is required. String
If the instance has expired.
lockMode This property is required. String
The lock mode of the DBCluster.
lockReason This property is required. String
Lock reason of the DBCluster.
maintainTime This property is required. String
Examples of the maintenance window, in the format of hh:mmZ-hh:mm Z.
paymentType This property is required. String
The payment type of the resource. Valid values: PayAsYouGo,Subscription.
port This property is required. Integer
Connection port.
publicConnectionString This property is required. String
A public IP address for the connection.
publicPort This property is required. String
Public network port.
scaleOutStatuses This property is required. List<GetDbClustersClusterScaleOutStatus>
Scale state.
status This property is required. String
The status of the DBCluster. Valid values: Running,Creating,Deleting,Restarting,Preparing.
storageType This property is required. String
Storage type of DBCluster. Valid values: cloud_essd, cloud_efficiency, cloud_essd_pl2, cloud_essd_pl3.
supportBackup This property is required. Integer
Support fallback scheme.
supportHttpsPort This property is required. Boolean
The system supports http port number.
supportMysqlPort This property is required. Boolean
Supports Mysql, and those of the ports.
vpcCloudInstanceId This property is required. String
Virtual Private Cloud (VPC cloud instance ID.
vpcId This property is required. String
The VPC ID of the DBCluster.
vswitchId This property is required. String
The vswitch id of the DBCluster.
zoneId This property is required. String
The zone ID of the DBCluster.
aliUid This property is required. string
Alibaba Cloud account Id.
bid This property is required. string
The ID of the business process flow.
category This property is required. string
Instance family values include: Basic: Basic edition; HighAvailability: high availability edition.
commodityCode This property is required. string
The Commodity Code of the DBCluster.
connectionString This property is required. string
Connection string.
controlVersion This property is required. string
The control version of the DBCluster.
createTime This property is required. string
The creation time of the resource.
dbClusterAccessWhiteLists This property is required. GetDbClustersClusterDbClusterAccessWhiteList[]
The db cluster access white list.
dbClusterDescription This property is required. string
The DBCluster description.
dbClusterId This property is required. string
dbClusterNetworkType This property is required. string
The DBCluster network type.
dbClusterType This property is required. string
The DBCluster type.
dbNodeClass This property is required. string
The node class of the DBCluster.
dbNodeCount This property is required. string
The node count of the DBCluster.
dbNodeStorage This property is required. string
The node storage of the DBCluster.
encryptionKey This property is required. string
Key management service KMS key ID.
encryptionType This property is required. string
Currently only supports ECS disk encryption, with a value of CloudDisk, not encrypted when empty.
engine This property is required. string
The Engine of the DBCluster.
engineVersion This property is required. string
The engine version of the DBCluster.
expireTime This property is required. string
The expiration time of the DBCluster.
id This property is required. string
The ID of the DBCluster.
isExpired This property is required. string
If the instance has expired.
lockMode This property is required. string
The lock mode of the DBCluster.
lockReason This property is required. string
Lock reason of the DBCluster.
maintainTime This property is required. string
Examples of the maintenance window, in the format of hh:mmZ-hh:mm Z.
paymentType This property is required. string
The payment type of the resource. Valid values: PayAsYouGo,Subscription.
port This property is required. number
Connection port.
publicConnectionString This property is required. string
A public IP address for the connection.
publicPort This property is required. string
Public network port.
scaleOutStatuses This property is required. GetDbClustersClusterScaleOutStatus[]
Scale state.
status This property is required. string
The status of the DBCluster. Valid values: Running,Creating,Deleting,Restarting,Preparing.
storageType This property is required. string
Storage type of DBCluster. Valid values: cloud_essd, cloud_efficiency, cloud_essd_pl2, cloud_essd_pl3.
supportBackup This property is required. number
Support fallback scheme.
supportHttpsPort This property is required. boolean
The system supports http port number.
supportMysqlPort This property is required. boolean
Supports Mysql, and those of the ports.
vpcCloudInstanceId This property is required. string
Virtual Private Cloud (VPC cloud instance ID.
vpcId This property is required. string
The VPC ID of the DBCluster.
vswitchId This property is required. string
The vswitch id of the DBCluster.
zoneId This property is required. string
The zone ID of the DBCluster.
ali_uid This property is required. str
Alibaba Cloud account Id.
bid This property is required. str
The ID of the business process flow.
category This property is required. str
Instance family values include: Basic: Basic edition; HighAvailability: high availability edition.
commodity_code This property is required. str
The Commodity Code of the DBCluster.
connection_string This property is required. str
Connection string.
control_version This property is required. str
The control version of the DBCluster.
create_time This property is required. str
The creation time of the resource.
db_cluster_access_white_lists This property is required. Sequence[GetDbClustersClusterDbClusterAccessWhiteList]
The db cluster access white list.
db_cluster_description This property is required. str
The DBCluster description.
db_cluster_id This property is required. str
db_cluster_network_type This property is required. str
The DBCluster network type.
db_cluster_type This property is required. str
The DBCluster type.
db_node_class This property is required. str
The node class of the DBCluster.
db_node_count This property is required. str
The node count of the DBCluster.
db_node_storage This property is required. str
The node storage of the DBCluster.
encryption_key This property is required. str
Key management service KMS key ID.
encryption_type This property is required. str
Currently only supports ECS disk encryption, with a value of CloudDisk, not encrypted when empty.
engine This property is required. str
The Engine of the DBCluster.
engine_version This property is required. str
The engine version of the DBCluster.
expire_time This property is required. str
The expiration time of the DBCluster.
id This property is required. str
The ID of the DBCluster.
is_expired This property is required. str
If the instance has expired.
lock_mode This property is required. str
The lock mode of the DBCluster.
lock_reason This property is required. str
Lock reason of the DBCluster.
maintain_time This property is required. str
Examples of the maintenance window, in the format of hh:mmZ-hh:mm Z.
payment_type This property is required. str
The payment type of the resource. Valid values: PayAsYouGo,Subscription.
port This property is required. int
Connection port.
public_connection_string This property is required. str
A public IP address for the connection.
public_port This property is required. str
Public network port.
scale_out_statuses This property is required. Sequence[GetDbClustersClusterScaleOutStatus]
Scale state.
status This property is required. str
The status of the DBCluster. Valid values: Running,Creating,Deleting,Restarting,Preparing.
storage_type This property is required. str
Storage type of DBCluster. Valid values: cloud_essd, cloud_efficiency, cloud_essd_pl2, cloud_essd_pl3.
support_backup This property is required. int
Support fallback scheme.
support_https_port This property is required. bool
The system supports http port number.
support_mysql_port This property is required. bool
Supports Mysql, and those of the ports.
vpc_cloud_instance_id This property is required. str
Virtual Private Cloud (VPC cloud instance ID.
vpc_id This property is required. str
The VPC ID of the DBCluster.
vswitch_id This property is required. str
The vswitch id of the DBCluster.
zone_id This property is required. str
The zone ID of the DBCluster.
aliUid This property is required. String
Alibaba Cloud account Id.
bid This property is required. String
The ID of the business process flow.
category This property is required. String
Instance family values include: Basic: Basic edition; HighAvailability: high availability edition.
commodityCode This property is required. String
The Commodity Code of the DBCluster.
connectionString This property is required. String
Connection string.
controlVersion This property is required. String
The control version of the DBCluster.
createTime This property is required. String
The creation time of the resource.
dbClusterAccessWhiteLists This property is required. List<Property Map>
The db cluster access white list.
dbClusterDescription This property is required. String
The DBCluster description.
dbClusterId This property is required. String
dbClusterNetworkType This property is required. String
The DBCluster network type.
dbClusterType This property is required. String
The DBCluster type.
dbNodeClass This property is required. String
The node class of the DBCluster.
dbNodeCount This property is required. String
The node count of the DBCluster.
dbNodeStorage This property is required. String
The node storage of the DBCluster.
encryptionKey This property is required. String
Key management service KMS key ID.
encryptionType This property is required. String
Currently only supports ECS disk encryption, with a value of CloudDisk, not encrypted when empty.
engine This property is required. String
The Engine of the DBCluster.
engineVersion This property is required. String
The engine version of the DBCluster.
expireTime This property is required. String
The expiration time of the DBCluster.
id This property is required. String
The ID of the DBCluster.
isExpired This property is required. String
If the instance has expired.
lockMode This property is required. String
The lock mode of the DBCluster.
lockReason This property is required. String
Lock reason of the DBCluster.
maintainTime This property is required. String
Examples of the maintenance window, in the format of hh:mmZ-hh:mm Z.
paymentType This property is required. String
The payment type of the resource. Valid values: PayAsYouGo,Subscription.
port This property is required. Number
Connection port.
publicConnectionString This property is required. String
A public IP address for the connection.
publicPort This property is required. String
Public network port.
scaleOutStatuses This property is required. List<Property Map>
Scale state.
status This property is required. String
The status of the DBCluster. Valid values: Running,Creating,Deleting,Restarting,Preparing.
storageType This property is required. String
Storage type of DBCluster. Valid values: cloud_essd, cloud_efficiency, cloud_essd_pl2, cloud_essd_pl3.
supportBackup This property is required. Number
Support fallback scheme.
supportHttpsPort This property is required. Boolean
The system supports http port number.
supportMysqlPort This property is required. Boolean
Supports Mysql, and those of the ports.
vpcCloudInstanceId This property is required. String
Virtual Private Cloud (VPC cloud instance ID.
vpcId This property is required. String
The VPC ID of the DBCluster.
vswitchId This property is required. String
The vswitch id of the DBCluster.
zoneId This property is required. String
The zone ID of the DBCluster.

GetDbClustersClusterDbClusterAccessWhiteList

DbClusterIpArrayAttribute This property is required. string
Field db_cluster_ip_array_attribute has been removed from provider.
DbClusterIpArrayName This property is required. string
Whitelist group name.
SecurityIpList This property is required. string
The IP address list under the whitelist group.
DbClusterIpArrayAttribute This property is required. string
Field db_cluster_ip_array_attribute has been removed from provider.
DbClusterIpArrayName This property is required. string
Whitelist group name.
SecurityIpList This property is required. string
The IP address list under the whitelist group.
dbClusterIpArrayAttribute This property is required. String
Field db_cluster_ip_array_attribute has been removed from provider.
dbClusterIpArrayName This property is required. String
Whitelist group name.
securityIpList This property is required. String
The IP address list under the whitelist group.
dbClusterIpArrayAttribute This property is required. string
Field db_cluster_ip_array_attribute has been removed from provider.
dbClusterIpArrayName This property is required. string
Whitelist group name.
securityIpList This property is required. string
The IP address list under the whitelist group.
db_cluster_ip_array_attribute This property is required. str
Field db_cluster_ip_array_attribute has been removed from provider.
db_cluster_ip_array_name This property is required. str
Whitelist group name.
security_ip_list This property is required. str
The IP address list under the whitelist group.
dbClusterIpArrayAttribute This property is required. String
Field db_cluster_ip_array_attribute has been removed from provider.
dbClusterIpArrayName This property is required. String
Whitelist group name.
securityIpList This property is required. String
The IP address list under the whitelist group.

GetDbClustersClusterScaleOutStatus

Progress This property is required. string
Process.
Ratio This property is required. string
Efficiency.
Progress This property is required. string
Process.
Ratio This property is required. string
Efficiency.
progress This property is required. String
Process.
ratio This property is required. String
Efficiency.
progress This property is required. string
Process.
ratio This property is required. string
Efficiency.
progress This property is required. str
Process.
ratio This property is required. str
Efficiency.
progress This property is required. String
Process.
ratio This property is required. String
Efficiency.

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