Alibaba Cloud v3.34.0, Mar 17 23

alicloud.polardb.getClusters

The alicloud.polardb.getClusters data source provides a collection of PolarDB clusters available in Alibaba Cloud account. Filters support regular expression for the cluster description, searches by tags, and other filters which are listed below.

NOTE: Available in v1.66.0+.

Example Usage

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

return await Deployment.RunAsync(() => 
{
    var polardbClustersDs = AliCloud.PolarDB.GetClusters.Invoke(new()
    {
        DescriptionRegex = "pc-\\w+",
        Status = "Running",
    });

    return new Dictionary<string, object?>
    {
        ["firstPolardbClusterId"] = polardbClustersDs.Apply(getClustersResult => getClustersResult.Clusters[0]?.Id),
    };
});

package main

import (
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/polardb"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		polardbClustersDs, err := polardb.GetClusters(ctx, &polardb.GetClustersArgs{
			DescriptionRegex: pulumi.StringRef("pc-\\w+"),
			Status:           pulumi.StringRef("Running"),
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("firstPolardbClusterId", polardbClustersDs.Clusters[0].Id)
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.polardb.PolardbFunctions;
import com.pulumi.alicloud.polardb.inputs.GetClustersArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

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

    public static void stack(Context ctx) {
        final var polardbClustersDs = PolardbFunctions.getClusters(GetClustersArgs.builder()
            .descriptionRegex("pc-\\w+")
            .status("Running")
            .build());

        ctx.export("firstPolardbClusterId", polardbClustersDs.applyValue(getClustersResult -> getClustersResult.clusters()[0].id()));
    }
}

import pulumi
import pulumi_alicloud as alicloud

polardb_clusters_ds = alicloud.polardb.get_clusters(description_regex="pc-\\w+",
    status="Running")
pulumi.export("firstPolardbClusterId", polardb_clusters_ds.clusters[0].id)

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

const polardbClustersDs = alicloud.polardb.getClusters({
    descriptionRegex: "pc-\\w+",
    status: "Running",
});
export const firstPolardbClusterId = polardbClustersDs.then(polardbClustersDs => polardbClustersDs.clusters?.[0]?.id);

variables:
  polardbClustersDs:
    fn::invoke:
      Function: alicloud:polardb:getClusters
      Arguments:
        descriptionRegex: pc-\w+
        status: Running
outputs:
  firstPolardbClusterId: ${polardbClustersDs.clusters[0].id}

Using getClusters

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 getClusters(args: GetClustersArgs, opts?: InvokeOptions): Promise<GetClustersResult>
function getClustersOutput(args: GetClustersOutputArgs, opts?: InvokeOptions): Output<GetClustersResult>

def get_clusters(db_type: Optional[str] = None,
                 description_regex: Optional[str] = None,
                 ids: Optional[Sequence[str]] = None,
                 output_file: Optional[str] = None,
                 status: Optional[str] = None,
                 tags: Optional[Mapping[str, Any]] = None,
                 opts: Optional[InvokeOptions] = None) -> GetClustersResult
def get_clusters_output(db_type: Optional[pulumi.Input[str]] = None,
                 description_regex: Optional[pulumi.Input[str]] = None,
                 ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                 output_file: Optional[pulumi.Input[str]] = None,
                 status: Optional[pulumi.Input[str]] = None,
                 tags: Optional[pulumi.Input[Mapping[str, Any]]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetClustersResult]

func GetClusters(ctx *Context, args *GetClustersArgs, opts ...InvokeOption) (*GetClustersResult, error)
func GetClustersOutput(ctx *Context, args *GetClustersOutputArgs, opts ...InvokeOption) GetClustersResultOutput

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

public static class GetClusters 
{
    public static Task<GetClustersResult> InvokeAsync(GetClustersArgs args, InvokeOptions? opts = null)
    public static Output<GetClustersResult> Invoke(GetClustersInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetClustersResult> getClusters(GetClustersArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: alicloud:polardb/getClusters:getClusters
  arguments:
    # arguments dictionary

The following arguments are supported:

DbType string

Database type. Options are MySQL, Oracle and PostgreSQL. If no value is specified, all types are returned.

DescriptionRegex string

A regex string to filter results by cluster description.

Ids List<string>

A list of PolarDB cluster IDs.

OutputFile string

Status string

status of the cluster.

Tags Dictionary<string, object>

A mapping of tags to assign to the resource.

Key: It can be up to 64 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It cannot be a null string.
Value: It can be up to 128 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It can be a null string.

DbType string

Database type. Options are MySQL, Oracle and PostgreSQL. If no value is specified, all types are returned.

DescriptionRegex string

A regex string to filter results by cluster description.

Ids []string

A list of PolarDB cluster IDs.

OutputFile string

Status string

status of the cluster.

Tags map[string]interface{}

A mapping of tags to assign to the resource.

Key: It can be up to 64 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It cannot be a null string.
Value: It can be up to 128 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It can be a null string.

dbType String

Database type. Options are MySQL, Oracle and PostgreSQL. If no value is specified, all types are returned.

descriptionRegex String

A regex string to filter results by cluster description.

ids List<String>

A list of PolarDB cluster IDs.

outputFile String

status String

status of the cluster.

tags Map<String,Object>

A mapping of tags to assign to the resource.

Key: It can be up to 64 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It cannot be a null string.
Value: It can be up to 128 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It can be a null string.

dbType string

Database type. Options are MySQL, Oracle and PostgreSQL. If no value is specified, all types are returned.

descriptionRegex string

A regex string to filter results by cluster description.

ids string[]

A list of PolarDB cluster IDs.

outputFile string

status string

status of the cluster.

tags {[key: string]: any}

A mapping of tags to assign to the resource.

Key: It can be up to 64 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It cannot be a null string.
Value: It can be up to 128 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It can be a null string.

db_type str

Database type. Options are MySQL, Oracle and PostgreSQL. If no value is specified, all types are returned.

description_regex str

A regex string to filter results by cluster description.

ids Sequence[str]

A list of PolarDB cluster IDs.

output_file str

status str

status of the cluster.

tags Mapping[str, Any]

A mapping of tags to assign to the resource.

Key: It can be up to 64 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It cannot be a null string.
Value: It can be up to 128 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It can be a null string.

dbType String

Database type. Options are MySQL, Oracle and PostgreSQL. If no value is specified, all types are returned.

descriptionRegex String

A regex string to filter results by cluster description.

ids List<String>

A list of PolarDB cluster IDs.

outputFile String

status String

status of the cluster.

tags Map<Any>

A mapping of tags to assign to the resource.

Key: It can be up to 64 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It cannot be a null string.
Value: It can be up to 128 characters in length. It cannot begin with "aliyun", "acs:", "http://", or "https://". It can be a null string.

getClusters Result

The following output properties are available:

Clusters List<Pulumi.AliCloud.PolarDB.Outputs.GetClustersCluster>: A list of PolarDB clusters. Each element contains the following attributes:
Descriptions List<string>: A list of RDS cluster descriptions.
Id string: The provider-assigned unique ID for this managed resource.
Ids List<string>: A list of RDS cluster IDs.
DbType string: Primary for primary cluster, ReadOnly for read-only cluster, Guard for disaster recovery cluster, and Temp for temporary cluster.
DescriptionRegex string
OutputFile string
Status string: Status of the cluster.
Tags Dictionary<string, object>

Clusters []GetClustersCluster: A list of PolarDB clusters. Each element contains the following attributes:
Descriptions []string: A list of RDS cluster descriptions.
Id string: The provider-assigned unique ID for this managed resource.
Ids []string: A list of RDS cluster IDs.
DbType string: Primary for primary cluster, ReadOnly for read-only cluster, Guard for disaster recovery cluster, and Temp for temporary cluster.
DescriptionRegex string
OutputFile string
Status string: Status of the cluster.
Tags map[string]interface{}

clusters List<GetClustersCluster>: A list of PolarDB clusters. Each element contains the following attributes:
descriptions List<String>: A list of RDS cluster descriptions.
id String: The provider-assigned unique ID for this managed resource.
ids List<String>: A list of RDS cluster IDs.
dbType String: Primary for primary cluster, ReadOnly for read-only cluster, Guard for disaster recovery cluster, and Temp for temporary cluster.
descriptionRegex String
outputFile String
status String: Status of the cluster.
tags Map<String,Object>

clusters GetClustersCluster[]: A list of PolarDB clusters. Each element contains the following attributes:
descriptions string[]: A list of RDS cluster descriptions.
id string: The provider-assigned unique ID for this managed resource.
ids string[]: A list of RDS cluster IDs.
dbType string: Primary for primary cluster, ReadOnly for read-only cluster, Guard for disaster recovery cluster, and Temp for temporary cluster.
descriptionRegex string
outputFile string
status string: Status of the cluster.
tags {[key: string]: any}

clusters Sequence[GetClustersCluster]: A list of PolarDB clusters. Each element contains the following attributes:
descriptions Sequence[str]: A list of RDS cluster descriptions.
id str: The provider-assigned unique ID for this managed resource.
ids Sequence[str]: A list of RDS cluster IDs.
db_type str: Primary for primary cluster, ReadOnly for read-only cluster, Guard for disaster recovery cluster, and Temp for temporary cluster.
description_regex str
output_file str
status str: Status of the cluster.
tags Mapping[str, Any]

clusters List<Property Map>: A list of PolarDB clusters. Each element contains the following attributes:
descriptions List<String>: A list of RDS cluster descriptions.
id String: The provider-assigned unique ID for this managed resource.
ids List<String>: A list of RDS cluster IDs.
dbType String: Primary for primary cluster, ReadOnly for read-only cluster, Guard for disaster recovery cluster, and Temp for temporary cluster.
descriptionRegex String
outputFile String
status String: Status of the cluster.
tags Map<Any>

Supporting Types

GetClustersCluster

ChargeType string: Billing method. Value options: PostPaid for Pay-As-You-Go and PrePaid for subscription.
ConnectionString string: PolarDB cluster connection string.
CreateTime string: The create_time of the db_nodes.
DbNodeClass string: The db_node_class of the db_nodes.
DbNodeNumber int: The DBNodeNumber of the PolarDB cluster.
DbNodes List<Pulumi.AliCloud.PolarDB.Inputs.GetClustersClusterDbNode>: The DBNodes of the PolarDB cluster.
DbType string: Database type. Options are MySQL, Oracle and PostgreSQL. If no value is specified, all types are returned.
DbVersion string: The DBVersion of the PolarDB cluster.
DeleteLock int: The DeleteLock of the PolarDB cluster.
Description string: The description of the PolarDB cluster.
Engine string: Database type. Options are MySQL, Oracle and PostgreSQL. If no value is specified, all types are returned.
ExpireTime string: Expiration time. Pay-As-You-Go clusters never expire.
Expired string: The expired of the PolarDB cluster.
Id string: The ID of the PolarDB cluster.
LockMode string: The LockMode of the PolarDB cluster.
NetworkType string: The DBClusterNetworkType of the PolarDB cluster.
Port string: PolarDB cluster connection port.
RegionId string: The region_id of the db_nodes.
Status string: status of the cluster.
StorageUsed int: The StorageUsed of the PolarDB cluster.
VpcId string: ID of the VPC the cluster belongs to.
ZoneId string: The zone_id of the db_nodes.

ChargeType string: Billing method. Value options: PostPaid for Pay-As-You-Go and PrePaid for subscription.
ConnectionString string: PolarDB cluster connection string.
CreateTime string: The create_time of the db_nodes.
DbNodeClass string: The db_node_class of the db_nodes.
DbNodeNumber int: The DBNodeNumber of the PolarDB cluster.
DbNodes []GetClustersClusterDbNode: The DBNodes of the PolarDB cluster.
DbType string: Database type. Options are MySQL, Oracle and PostgreSQL. If no value is specified, all types are returned.
DbVersion string: The DBVersion of the PolarDB cluster.
DeleteLock int: The DeleteLock of the PolarDB cluster.
Description string: The description of the PolarDB cluster.
Engine string: Database type. Options are MySQL, Oracle and PostgreSQL. If no value is specified, all types are returned.
ExpireTime string: Expiration time. Pay-As-You-Go clusters never expire.
Expired string: The expired of the PolarDB cluster.
Id string: The ID of the PolarDB cluster.
LockMode string: The LockMode of the PolarDB cluster.
NetworkType string: The DBClusterNetworkType of the PolarDB cluster.
Port string: PolarDB cluster connection port.
RegionId string: The region_id of the db_nodes.
Status string: status of the cluster.
StorageUsed int: The StorageUsed of the PolarDB cluster.
VpcId string: ID of the VPC the cluster belongs to.
ZoneId string: The zone_id of the db_nodes.

chargeType String: Billing method. Value options: PostPaid for Pay-As-You-Go and PrePaid for subscription.
connectionString String: PolarDB cluster connection string.
createTime String: The create_time of the db_nodes.
dbNodeClass String: The db_node_class of the db_nodes.
dbNodeNumber Integer: The DBNodeNumber of the PolarDB cluster.
dbNodes List<GetClustersClusterDbNode>: The DBNodes of the PolarDB cluster.
dbType String: Database type. Options are MySQL, Oracle and PostgreSQL. If no value is specified, all types are returned.
dbVersion String: The DBVersion of the PolarDB cluster.
deleteLock Integer: The DeleteLock of the PolarDB cluster.
description String: The description of the PolarDB cluster.
engine String: Database type. Options are MySQL, Oracle and PostgreSQL. If no value is specified, all types are returned.
expireTime String: Expiration time. Pay-As-You-Go clusters never expire.
expired String: The expired of the PolarDB cluster.
id String: The ID of the PolarDB cluster.
lockMode String: The LockMode of the PolarDB cluster.
networkType String: The DBClusterNetworkType of the PolarDB cluster.
port String: PolarDB cluster connection port.
regionId String: The region_id of the db_nodes.
status String: status of the cluster.
storageUsed Integer: The StorageUsed of the PolarDB cluster.
vpcId String: ID of the VPC the cluster belongs to.
zoneId String: The zone_id of the db_nodes.

chargeType string: Billing method. Value options: PostPaid for Pay-As-You-Go and PrePaid for subscription.
connectionString string: PolarDB cluster connection string.
createTime string: The create_time of the db_nodes.
dbNodeClass string: The db_node_class of the db_nodes.
dbNodeNumber number: The DBNodeNumber of the PolarDB cluster.
dbNodes GetClustersClusterDbNode[]: The DBNodes of the PolarDB cluster.
dbType string: Database type. Options are MySQL, Oracle and PostgreSQL. If no value is specified, all types are returned.
dbVersion string: The DBVersion of the PolarDB cluster.
deleteLock number: The DeleteLock of the PolarDB cluster.
description string: The description of the PolarDB cluster.
engine string: Database type. Options are MySQL, Oracle and PostgreSQL. If no value is specified, all types are returned.
expireTime string: Expiration time. Pay-As-You-Go clusters never expire.
expired string: The expired of the PolarDB cluster.
id string: The ID of the PolarDB cluster.
lockMode string: The LockMode of the PolarDB cluster.
networkType string: The DBClusterNetworkType of the PolarDB cluster.
port string: PolarDB cluster connection port.
regionId string: The region_id of the db_nodes.
status string: status of the cluster.
storageUsed number: The StorageUsed of the PolarDB cluster.
vpcId string: ID of the VPC the cluster belongs to.
zoneId string: The zone_id of the db_nodes.

charge_type str: Billing method. Value options: PostPaid for Pay-As-You-Go and PrePaid for subscription.
connection_string str: PolarDB cluster connection string.
create_time str: The create_time of the db_nodes.
db_node_class str: The db_node_class of the db_nodes.
db_node_number int: The DBNodeNumber of the PolarDB cluster.
db_nodes Sequence[GetClustersClusterDbNode]: The DBNodes of the PolarDB cluster.
db_type str: Database type. Options are MySQL, Oracle and PostgreSQL. If no value is specified, all types are returned.
db_version str: The DBVersion of the PolarDB cluster.
delete_lock int: The DeleteLock of the PolarDB cluster.
description str: The description of the PolarDB cluster.
engine str: Database type. Options are MySQL, Oracle and PostgreSQL. If no value is specified, all types are returned.
expire_time str: Expiration time. Pay-As-You-Go clusters never expire.
expired str: The expired of the PolarDB cluster.
id str: The ID of the PolarDB cluster.
lock_mode str: The LockMode of the PolarDB cluster.
network_type str: The DBClusterNetworkType of the PolarDB cluster.
port str: PolarDB cluster connection port.
region_id str: The region_id of the db_nodes.
status str: status of the cluster.
storage_used int: The StorageUsed of the PolarDB cluster.
vpc_id str: ID of the VPC the cluster belongs to.
zone_id str: The zone_id of the db_nodes.

chargeType String: Billing method. Value options: PostPaid for Pay-As-You-Go and PrePaid for subscription.
connectionString String: PolarDB cluster connection string.
createTime String: The create_time of the db_nodes.
dbNodeClass String: The db_node_class of the db_nodes.
dbNodeNumber Number: The DBNodeNumber of the PolarDB cluster.
dbNodes List<Property Map>: The DBNodes of the PolarDB cluster.
dbType String: Database type. Options are MySQL, Oracle and PostgreSQL. If no value is specified, all types are returned.
dbVersion String: The DBVersion of the PolarDB cluster.
deleteLock Number: The DeleteLock of the PolarDB cluster.
description String: The description of the PolarDB cluster.
engine String: Database type. Options are MySQL, Oracle and PostgreSQL. If no value is specified, all types are returned.
expireTime String: Expiration time. Pay-As-You-Go clusters never expire.
expired String: The expired of the PolarDB cluster.
id String: The ID of the PolarDB cluster.
lockMode String: The LockMode of the PolarDB cluster.
networkType String: The DBClusterNetworkType of the PolarDB cluster.
port String: PolarDB cluster connection port.
regionId String: The region_id of the db_nodes.
status String: status of the cluster.
storageUsed Number: The StorageUsed of the PolarDB cluster.
vpcId String: ID of the VPC the cluster belongs to.
zoneId String: The zone_id of the db_nodes.

GetClustersClusterDbNode

CreateTime string: The create_time of the db_nodes.
DbNodeClass string: The db_node_class of the db_nodes.
DbNodeId string: The db_node_id of the db_nodes.
DbNodeRole string: The db_node_role of the db_nodes.
DbNodeStatus string: The db_node_status of the db_nodes.
MaxConnections int: The max_connections of the db_nodes.
MaxIops int: The max_iops of the db_nodes.
RegionId string: The region_id of the db_nodes.
ZoneId string: The zone_id of the db_nodes.

CreateTime string: The create_time of the db_nodes.
DbNodeClass string: The db_node_class of the db_nodes.
DbNodeId string: The db_node_id of the db_nodes.
DbNodeRole string: The db_node_role of the db_nodes.
DbNodeStatus string: The db_node_status of the db_nodes.
MaxConnections int: The max_connections of the db_nodes.
MaxIops int: The max_iops of the db_nodes.
RegionId string: The region_id of the db_nodes.
ZoneId string: The zone_id of the db_nodes.

createTime String: The create_time of the db_nodes.
dbNodeClass String: The db_node_class of the db_nodes.
dbNodeId String: The db_node_id of the db_nodes.
dbNodeRole String: The db_node_role of the db_nodes.
dbNodeStatus String: The db_node_status of the db_nodes.
maxConnections Integer: The max_connections of the db_nodes.
maxIops Integer: The max_iops of the db_nodes.
regionId String: The region_id of the db_nodes.
zoneId String: The zone_id of the db_nodes.

createTime string: The create_time of the db_nodes.
dbNodeClass string: The db_node_class of the db_nodes.
dbNodeId string: The db_node_id of the db_nodes.
dbNodeRole string: The db_node_role of the db_nodes.
dbNodeStatus string: The db_node_status of the db_nodes.
maxConnections number: The max_connections of the db_nodes.
maxIops number: The max_iops of the db_nodes.
regionId string: The region_id of the db_nodes.
zoneId string: The zone_id of the db_nodes.

create_time str: The create_time of the db_nodes.
db_node_class str: The db_node_class of the db_nodes.
db_node_id str: The db_node_id of the db_nodes.
db_node_role str: The db_node_role of the db_nodes.
db_node_status str: The db_node_status of the db_nodes.
max_connections int: The max_connections of the db_nodes.
max_iops int: The max_iops of the db_nodes.
region_id str: The region_id of the db_nodes.
zone_id str: The zone_id of the db_nodes.

createTime String: The create_time of the db_nodes.
dbNodeClass String: The db_node_class of the db_nodes.
dbNodeId String: The db_node_id of the db_nodes.
dbNodeRole String: The db_node_role of the db_nodes.
dbNodeStatus String: The db_node_status of the db_nodes.
maxConnections Number: The max_connections of the db_nodes.
maxIops Number: The max_iops of the db_nodes.
regionId String: The region_id of the db_nodes.
zoneId String: The zone_id of the db_nodes.

Package Details

Repository: Alibaba Cloud pulumi/pulumi-alicloud
License: Apache-2.0
Notes: This Pulumi package is based on the alicloud Terraform Provider.

alicloud.polardb.getClusters

Example Usage

Using getClusters

getClusters Result

Supporting Types

GetClustersCluster

GetClustersClusterDbNode

Package Details

Contents