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:
- Db
Type string Database type. Options are
MySQL
,Oracle
andPostgreSQL
. If no value is specified, all types are returned.- Description
Regex string A regex string to filter results by cluster description.
- Ids List<string>
A list of PolarDB cluster IDs.
- Output
File string - Status string
status of the cluster.
- 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.
- Db
Type string Database type. Options are
MySQL
,Oracle
andPostgreSQL
. If no value is specified, all types are returned.- Description
Regex string A regex string to filter results by cluster description.
- Ids []string
A list of PolarDB cluster IDs.
- Output
File string - Status string
status of the cluster.
- 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.
- db
Type String Database type. Options are
MySQL
,Oracle
andPostgreSQL
. If no value is specified, all types are returned.- description
Regex String A regex string to filter results by cluster description.
- ids List<String>
A list of PolarDB cluster IDs.
- output
File String - status String
status of the cluster.
- 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.
- db
Type string Database type. Options are
MySQL
,Oracle
andPostgreSQL
. If no value is specified, all types are returned.- description
Regex string A regex string to filter results by cluster description.
- ids string[]
A list of PolarDB cluster IDs.
- output
File string - status string
status of the cluster.
- {[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
andPostgreSQL
. 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.
- 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.
- db
Type String Database type. Options are
MySQL
,Oracle
andPostgreSQL
. If no value is specified, all types are returned.- description
Regex String A regex string to filter results by cluster description.
- ids List<String>
A list of PolarDB cluster IDs.
- output
File String - status String
status of the cluster.
- 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.
Ali Cloud. Polar DB. Outputs. Get Clusters Cluster> 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.
- Db
Type string Primary
for primary cluster,ReadOnly
for read-only cluster,Guard
for disaster recovery cluster, andTemp
for temporary cluster.- Description
Regex string - Output
File string - Status string
Status of the cluster.
- Dictionary<string, object>
- Clusters
[]Get
Clusters Cluster 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.
- Db
Type string Primary
for primary cluster,ReadOnly
for read-only cluster,Guard
for disaster recovery cluster, andTemp
for temporary cluster.- Description
Regex string - Output
File string - Status string
Status of the cluster.
- map[string]interface{}
- clusters
List<Get
Clusters Cluster> 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.
- db
Type String Primary
for primary cluster,ReadOnly
for read-only cluster,Guard
for disaster recovery cluster, andTemp
for temporary cluster.- description
Regex String - output
File String - status String
Status of the cluster.
- Map<String,Object>
- clusters
Get
Clusters Cluster[] 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.
- db
Type string Primary
for primary cluster,ReadOnly
for read-only cluster,Guard
for disaster recovery cluster, andTemp
for temporary cluster.- description
Regex string - output
File string - status string
Status of the cluster.
- {[key: string]: any}
- clusters
Sequence[Get
Clusters Cluster] 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, andTemp
for temporary cluster.- description_
regex str - output_
file str - status str
Status of the cluster.
- 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.
- db
Type String Primary
for primary cluster,ReadOnly
for read-only cluster,Guard
for disaster recovery cluster, andTemp
for temporary cluster.- description
Regex String - output
File String - status String
Status of the cluster.
- Map<Any>
Supporting Types
GetClustersCluster
- Charge
Type string Billing method. Value options:
PostPaid
for Pay-As-You-Go andPrePaid
for subscription.- Connection
String string PolarDB cluster connection string.
- Create
Time string The create_time of the db_nodes.
- Db
Node stringClass The db_node_class of the db_nodes.
- Db
Node intNumber The DBNodeNumber of the PolarDB cluster.
- Db
Nodes List<Pulumi.Ali Cloud. Polar DB. Inputs. Get Clusters Cluster Db Node> The DBNodes of the PolarDB cluster.
- Db
Type string Database type. Options are
MySQL
,Oracle
andPostgreSQL
. If no value is specified, all types are returned.- Db
Version string The DBVersion of the PolarDB cluster.
- Delete
Lock int The DeleteLock of the PolarDB cluster.
- Description string
The description of the PolarDB cluster.
- Engine string
Database type. Options are
MySQL
,Oracle
andPostgreSQL
. If no value is specified, all types are returned.- Expire
Time 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.
- Lock
Mode string The LockMode of the PolarDB cluster.
- Network
Type string The DBClusterNetworkType of the PolarDB cluster.
- Port string
PolarDB cluster connection port.
- Region
Id string The region_id of the db_nodes.
- Status string
status of the cluster.
- Storage
Used int The StorageUsed of the PolarDB cluster.
- Vpc
Id string ID of the VPC the cluster belongs to.
- Zone
Id string The zone_id of the db_nodes.
- Charge
Type string Billing method. Value options:
PostPaid
for Pay-As-You-Go andPrePaid
for subscription.- Connection
String string PolarDB cluster connection string.
- Create
Time string The create_time of the db_nodes.
- Db
Node stringClass The db_node_class of the db_nodes.
- Db
Node intNumber The DBNodeNumber of the PolarDB cluster.
- Db
Nodes []GetClusters Cluster Db Node The DBNodes of the PolarDB cluster.
- Db
Type string Database type. Options are
MySQL
,Oracle
andPostgreSQL
. If no value is specified, all types are returned.- Db
Version string The DBVersion of the PolarDB cluster.
- Delete
Lock int The DeleteLock of the PolarDB cluster.
- Description string
The description of the PolarDB cluster.
- Engine string
Database type. Options are
MySQL
,Oracle
andPostgreSQL
. If no value is specified, all types are returned.- Expire
Time 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.
- Lock
Mode string The LockMode of the PolarDB cluster.
- Network
Type string The DBClusterNetworkType of the PolarDB cluster.
- Port string
PolarDB cluster connection port.
- Region
Id string The region_id of the db_nodes.
- Status string
status of the cluster.
- Storage
Used int The StorageUsed of the PolarDB cluster.
- Vpc
Id string ID of the VPC the cluster belongs to.
- Zone
Id string The zone_id of the db_nodes.
- charge
Type String Billing method. Value options:
PostPaid
for Pay-As-You-Go andPrePaid
for subscription.- connection
String String PolarDB cluster connection string.
- create
Time String The create_time of the db_nodes.
- db
Node StringClass The db_node_class of the db_nodes.
- db
Node IntegerNumber The DBNodeNumber of the PolarDB cluster.
- db
Nodes List<GetClusters Cluster Db Node> The DBNodes of the PolarDB cluster.
- db
Type String Database type. Options are
MySQL
,Oracle
andPostgreSQL
. If no value is specified, all types are returned.- db
Version String The DBVersion of the PolarDB cluster.
- delete
Lock Integer The DeleteLock of the PolarDB cluster.
- description String
The description of the PolarDB cluster.
- engine String
Database type. Options are
MySQL
,Oracle
andPostgreSQL
. If no value is specified, all types are returned.- expire
Time 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.
- lock
Mode String The LockMode of the PolarDB cluster.
- network
Type String The DBClusterNetworkType of the PolarDB cluster.
- port String
PolarDB cluster connection port.
- region
Id String The region_id of the db_nodes.
- status String
status of the cluster.
- storage
Used Integer The StorageUsed of the PolarDB cluster.
- vpc
Id String ID of the VPC the cluster belongs to.
- zone
Id String The zone_id of the db_nodes.
- charge
Type string Billing method. Value options:
PostPaid
for Pay-As-You-Go andPrePaid
for subscription.- connection
String string PolarDB cluster connection string.
- create
Time string The create_time of the db_nodes.
- db
Node stringClass The db_node_class of the db_nodes.
- db
Node numberNumber The DBNodeNumber of the PolarDB cluster.
- db
Nodes GetClusters Cluster Db Node[] The DBNodes of the PolarDB cluster.
- db
Type string Database type. Options are
MySQL
,Oracle
andPostgreSQL
. If no value is specified, all types are returned.- db
Version string The DBVersion of the PolarDB cluster.
- delete
Lock number The DeleteLock of the PolarDB cluster.
- description string
The description of the PolarDB cluster.
- engine string
Database type. Options are
MySQL
,Oracle
andPostgreSQL
. If no value is specified, all types are returned.- expire
Time 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.
- lock
Mode string The LockMode of the PolarDB cluster.
- network
Type string The DBClusterNetworkType of the PolarDB cluster.
- port string
PolarDB cluster connection port.
- region
Id string The region_id of the db_nodes.
- status string
status of the cluster.
- storage
Used number The StorageUsed of the PolarDB cluster.
- vpc
Id string ID of the VPC the cluster belongs to.
- zone
Id string The zone_id of the db_nodes.
- charge_
type str Billing method. Value options:
PostPaid
for Pay-As-You-Go andPrePaid
for subscription.- connection_
string str PolarDB cluster connection string.
- create_
time str The create_time of the db_nodes.
- db_
node_ strclass The db_node_class of the db_nodes.
- db_
node_ intnumber The DBNodeNumber of the PolarDB cluster.
- db_
nodes Sequence[GetClusters Cluster Db Node] The DBNodes of the PolarDB cluster.
- db_
type str Database type. Options are
MySQL
,Oracle
andPostgreSQL
. 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
andPostgreSQL
. 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.
- charge
Type String Billing method. Value options:
PostPaid
for Pay-As-You-Go andPrePaid
for subscription.- connection
String String PolarDB cluster connection string.
- create
Time String The create_time of the db_nodes.
- db
Node StringClass The db_node_class of the db_nodes.
- db
Node NumberNumber The DBNodeNumber of the PolarDB cluster.
- db
Nodes List<Property Map> The DBNodes of the PolarDB cluster.
- db
Type String Database type. Options are
MySQL
,Oracle
andPostgreSQL
. If no value is specified, all types are returned.- db
Version String The DBVersion of the PolarDB cluster.
- delete
Lock Number The DeleteLock of the PolarDB cluster.
- description String
The description of the PolarDB cluster.
- engine String
Database type. Options are
MySQL
,Oracle
andPostgreSQL
. If no value is specified, all types are returned.- expire
Time 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.
- lock
Mode String The LockMode of the PolarDB cluster.
- network
Type String The DBClusterNetworkType of the PolarDB cluster.
- port String
PolarDB cluster connection port.
- region
Id String The region_id of the db_nodes.
- status String
status of the cluster.
- storage
Used Number The StorageUsed of the PolarDB cluster.
- vpc
Id String ID of the VPC the cluster belongs to.
- zone
Id String The zone_id of the db_nodes.
GetClustersClusterDbNode
- Create
Time string The create_time of the db_nodes.
- Db
Node stringClass The db_node_class of the db_nodes.
- Db
Node stringId The db_node_id of the db_nodes.
- Db
Node stringRole The db_node_role of the db_nodes.
- Db
Node stringStatus 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 string The region_id of the db_nodes.
- Zone
Id string The zone_id of the db_nodes.
- Create
Time string The create_time of the db_nodes.
- Db
Node stringClass The db_node_class of the db_nodes.
- Db
Node stringId The db_node_id of the db_nodes.
- Db
Node stringRole The db_node_role of the db_nodes.
- Db
Node stringStatus 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 string The region_id of the db_nodes.
- Zone
Id string The zone_id of the db_nodes.
- create
Time String The create_time of the db_nodes.
- db
Node StringClass The db_node_class of the db_nodes.
- db
Node StringId The db_node_id of the db_nodes.
- db
Node StringRole The db_node_role of the db_nodes.
- db
Node StringStatus The db_node_status of the db_nodes.
- max
Connections Integer The max_connections of the db_nodes.
- max
Iops Integer The max_iops of the db_nodes.
- region
Id String The region_id of the db_nodes.
- zone
Id String The zone_id of the db_nodes.
- create
Time string The create_time of the db_nodes.
- db
Node stringClass The db_node_class of the db_nodes.
- db
Node stringId The db_node_id of the db_nodes.
- db
Node stringRole The db_node_role of the db_nodes.
- db
Node stringStatus The db_node_status of the db_nodes.
- max
Connections number The max_connections of the db_nodes.
- max
Iops number The max_iops of the db_nodes.
- region
Id string The region_id of the db_nodes.
- zone
Id string The zone_id of the db_nodes.
- create_
time str The create_time of the db_nodes.
- db_
node_ strclass The db_node_class of the db_nodes.
- db_
node_ strid The db_node_id of the db_nodes.
- db_
node_ strrole The db_node_role of the db_nodes.
- db_
node_ strstatus 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.
- create
Time String The create_time of the db_nodes.
- db
Node StringClass The db_node_class of the db_nodes.
- db
Node StringId The db_node_id of the db_nodes.
- db
Node StringRole The db_node_role of the db_nodes.
- db
Node StringStatus The db_node_status of the db_nodes.
- max
Connections Number The max_connections of the db_nodes.
- max
Iops Number The max_iops of the db_nodes.
- region
Id String The region_id of the db_nodes.
- zone
Id 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.