GetKubernetesClusters

This data source provides a list Container Service Kubernetes Clusters on Alibaba Cloud.

NOTE: Available in v1.34.0+.

Example Usage

using Pulumi;
using AliCloud = Pulumi.AliCloud;

class MyStack : Stack
{
    public MyStack()
    {
        var k8sClusters = Output.Create(AliCloud.CS.GetKubernetesClusters.InvokeAsync(new AliCloud.CS.GetKubernetesClustersArgs
        {
            NameRegex = "my-first-k8s",
            OutputFile = "my-first-k8s-json",
        }));
        this.Output = k8sClusters.Apply(k8sClusters => k8sClusters.Clusters);
    }

    [Output("output")]
    public Output<string> Output { get; set; }
}

Coming soon!

import pulumi
import pulumi_alicloud as alicloud

k8s_clusters = alicloud.cs.get_kubernetes_clusters(name_regex="my-first-k8s",
    output_file="my-first-k8s-json")
pulumi.export("output", k8s_clusters.clusters)

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

// Declare the data source
const k8sClusters = pulumi.output(alicloud.cs.getKubernetesClusters({
    nameRegex: "my-first-k8s",
    outputFile: "my-first-k8s-json",
}, { async: true }));

export const output = k8sClusters.clusters;

Using GetKubernetesClusters

function getKubernetesClusters(args: GetKubernetesClustersArgs, opts?: InvokeOptions): Promise<GetKubernetesClustersResult>

function  get_kubernetes_clusters(enable_details=None, ids=None, name_regex=None, output_file=None, opts=None)

func GetKubernetesClusters(ctx *Context, args *GetKubernetesClustersArgs, opts ...InvokeOption) (*GetKubernetesClustersResult, error)

public static class GetKubernetesClusters {
    public static Task<GetKubernetesClustersResult> InvokeAsync(GetKubernetesClustersArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

EnableDetails bool
Ids List<string>: Cluster IDs to filter.
NameRegex string: A regex string to filter results by cluster name.
OutputFile string

EnableDetails bool
Ids []string: Cluster IDs to filter.
NameRegex string: A regex string to filter results by cluster name.
OutputFile string

enableDetails boolean
ids string[]: Cluster IDs to filter.
nameRegex string: A regex string to filter results by cluster name.
outputFile string

enable_details bool
ids List[str]: Cluster IDs to filter.
name_regex str: A regex string to filter results by cluster name.
output_file str

GetKubernetesClusters Result

The following output properties are available:

Clusters List<Pulumi.AliCloud.CS.Outputs.GetKubernetesClustersCluster>: A list of matched Kubernetes clusters. Each element contains the following attributes:
Id string: The provider-assigned unique ID for this managed resource.
Ids List<string>: A list of matched Kubernetes clusters’ ids.
Names List<string>: A list of matched Kubernetes clusters’ names.
EnableDetails bool
NameRegex string
OutputFile string

Clusters []GetKubernetesClustersCluster: A list of matched Kubernetes clusters. Each element contains the following attributes:
Id string: The provider-assigned unique ID for this managed resource.
Ids []string: A list of matched Kubernetes clusters’ ids.
Names []string: A list of matched Kubernetes clusters’ names.
EnableDetails bool
NameRegex string
OutputFile string

clusters GetKubernetesClustersCluster[]: A list of matched Kubernetes clusters. Each element contains the following attributes:
id string: The provider-assigned unique ID for this managed resource.
ids string[]: A list of matched Kubernetes clusters’ ids.
names string[]: A list of matched Kubernetes clusters’ names.
enableDetails boolean
nameRegex string
outputFile string

clusters List[GetKubernetesClustersCluster]: A list of matched Kubernetes clusters. Each element contains the following attributes:
id str: The provider-assigned unique ID for this managed resource.
ids List[str]: A list of matched Kubernetes clusters’ ids.
names List[str]: A list of matched Kubernetes clusters’ names.
enable_details bool
name_regex str
output_file str

Supporting Types

GetKubernetesClustersCluster

See the output API doc for this type.

AvailabilityZone string: The ID of availability zone.
ClusterNetworkType string
Connections Pulumi.AliCloud.CS.Inputs.GetKubernetesClustersClusterConnectionsArgs: Map of kubernetes cluster connection information. It contains several attributes to Block Connections.
Id string: ID of the node.
ImageId string: The ID of node image.
KeyName string: The keypair of ssh login cluster node, you have to create it first.
LogConfigs List<Pulumi.AliCloud.CS.Inputs.GetKubernetesClustersClusterLogConfigArgs>: A list of one element containing information about the associated log store. It contains the following attributes:
MasterAutoRenew bool
MasterAutoRenewPeriod int
MasterDiskCategory string: The system disk category of master node.
MasterDiskSize int: The system disk size of master node.
MasterInstanceChargeType string
MasterInstanceTypes List<string>: The instance type of master node.
MasterNodes List<Pulumi.AliCloud.CS.Inputs.GetKubernetesClustersClusterMasterNodeArgs>: List of cluster master nodes. It contains several attributes to Block Nodes.
MasterPeriod int
MasterPeriodUnit string
Name string: Node name.
NatGatewayId string: The ID of nat gateway used to launch kubernetes cluster.
NodeCidrMask int: The network mask used on pods for each node.
PodCidr string
SecurityGroupId string: The ID of security group where the current cluster worker node is located.
ServiceCidr string
SlbInternetEnabled bool: Whether internet load balancer for API Server is created
VpcId string: The ID of VPC where the current cluster is located.
VswitchIds List<string>: The ID of VSwitches where the current cluster is located.
WorkerAutoRenew bool
WorkerAutoRenewPeriod int
WorkerDataDiskCategory string: The data disk size of worker node.
WorkerDataDiskSize int: The data disk category of worker node.
WorkerDiskCategory string: The system disk category of worker node.
WorkerDiskSize int: The system disk size of worker node.
WorkerInstanceChargeType string
WorkerInstanceTypes List<string>: The instance type of worker node.
WorkerNodes List<Pulumi.AliCloud.CS.Inputs.GetKubernetesClustersClusterWorkerNodeArgs>: List of cluster worker nodes. It contains several attributes to Block Nodes.
WorkerNumbers List<int>: The ECS instance node number in the current container cluster.
WorkerPeriod int
WorkerPeriodUnit string

AvailabilityZone string: The ID of availability zone.
ClusterNetworkType string
Connections GetKubernetesClustersClusterConnections: Map of kubernetes cluster connection information. It contains several attributes to Block Connections.
Id string: ID of the node.
ImageId string: The ID of node image.
KeyName string: The keypair of ssh login cluster node, you have to create it first.
LogConfigs []GetKubernetesClustersClusterLogConfig: A list of one element containing information about the associated log store. It contains the following attributes:
MasterAutoRenew bool
MasterAutoRenewPeriod int
MasterDiskCategory string: The system disk category of master node.
MasterDiskSize int: The system disk size of master node.
MasterInstanceChargeType string
MasterInstanceTypes []string: The instance type of master node.
MasterNodes []GetKubernetesClustersClusterMasterNode: List of cluster master nodes. It contains several attributes to Block Nodes.
MasterPeriod int
MasterPeriodUnit string
Name string: Node name.
NatGatewayId string: The ID of nat gateway used to launch kubernetes cluster.
NodeCidrMask int: The network mask used on pods for each node.
PodCidr string
SecurityGroupId string: The ID of security group where the current cluster worker node is located.
ServiceCidr string
SlbInternetEnabled bool: Whether internet load balancer for API Server is created
VpcId string: The ID of VPC where the current cluster is located.
VswitchIds []string: The ID of VSwitches where the current cluster is located.
WorkerAutoRenew bool
WorkerAutoRenewPeriod int
WorkerDataDiskCategory string: The data disk size of worker node.
WorkerDataDiskSize int: The data disk category of worker node.
WorkerDiskCategory string: The system disk category of worker node.
WorkerDiskSize int: The system disk size of worker node.
WorkerInstanceChargeType string
WorkerInstanceTypes []string: The instance type of worker node.
WorkerNodes []GetKubernetesClustersClusterWorkerNode: List of cluster worker nodes. It contains several attributes to Block Nodes.
WorkerNumbers []int: The ECS instance node number in the current container cluster.
WorkerPeriod int
WorkerPeriodUnit string

availabilityZone string: The ID of availability zone.
clusterNetworkType string
connections GetKubernetesClustersClusterConnections: Map of kubernetes cluster connection information. It contains several attributes to Block Connections.
id string: ID of the node.
imageId string: The ID of node image.
keyName string: The keypair of ssh login cluster node, you have to create it first.
logConfigs GetKubernetesClustersClusterLogConfig[]: A list of one element containing information about the associated log store. It contains the following attributes:
masterAutoRenew boolean
masterAutoRenewPeriod number
masterDiskCategory string: The system disk category of master node.
masterDiskSize number: The system disk size of master node.
masterInstanceChargeType string
masterInstanceTypes string[]: The instance type of master node.
masterNodes GetKubernetesClustersClusterMasterNode[]: List of cluster master nodes. It contains several attributes to Block Nodes.
masterPeriod number
masterPeriodUnit string
name string: Node name.
natGatewayId string: The ID of nat gateway used to launch kubernetes cluster.
nodeCidrMask number: The network mask used on pods for each node.
podCidr string
securityGroupId string: The ID of security group where the current cluster worker node is located.
serviceCidr string
slbInternetEnabled boolean: Whether internet load balancer for API Server is created
vpcId string: The ID of VPC where the current cluster is located.
vswitchIds string[]: The ID of VSwitches where the current cluster is located.
workerAutoRenew boolean
workerAutoRenewPeriod number
workerDataDiskCategory string: The data disk size of worker node.
workerDataDiskSize number: The data disk category of worker node.
workerDiskCategory string: The system disk category of worker node.
workerDiskSize number: The system disk size of worker node.
workerInstanceChargeType string
workerInstanceTypes string[]: The instance type of worker node.
workerNodes GetKubernetesClustersClusterWorkerNode[]: List of cluster worker nodes. It contains several attributes to Block Nodes.
workerNumbers number[]: The ECS instance node number in the current container cluster.
workerPeriod number
workerPeriodUnit string

availability_zone str: The ID of availability zone.
clusterNetworkType str
connections Dict[GetKubernetesClustersClusterConnections]: Map of kubernetes cluster connection information. It contains several attributes to Block Connections.
id str: ID of the node.
image_id str: The ID of node image.
key_name str: The keypair of ssh login cluster node, you have to create it first.
logConfigs List[GetKubernetesClustersClusterLogConfig]: A list of one element containing information about the associated log store. It contains the following attributes:
master_auto_renew bool
master_auto_renew_period float
master_disk_category str: The system disk category of master node.
master_disk_size float: The system disk size of master node.
master_instance_charge_type str
master_instance_types List[str]: The instance type of master node.
master_nodes List[GetKubernetesClustersClusterMasterNode]: List of cluster master nodes. It contains several attributes to Block Nodes.
master_period float
master_period_unit str
name str: Node name.
nat_gateway_id str: The ID of nat gateway used to launch kubernetes cluster.
node_cidr_mask float: The network mask used on pods for each node.
pod_cidr str
security_group_id str: The ID of security group where the current cluster worker node is located.
service_cidr str
slb_internet_enabled bool: Whether internet load balancer for API Server is created
vpc_id str: The ID of VPC where the current cluster is located.
vswitch_ids List[str]: The ID of VSwitches where the current cluster is located.
workerNumbers List[Integer]: The ECS instance node number in the current container cluster.
worker_auto_renew bool
worker_auto_renew_period float
worker_data_disk_category str: The data disk size of worker node.
worker_data_disk_size float: The data disk category of worker node.
worker_disk_category str: The system disk category of worker node.
worker_disk_size float: The system disk size of worker node.
worker_instance_charge_type str
worker_instance_types List[str]: The instance type of worker node.
worker_nodes List[GetKubernetesClustersClusterWorkerNode]: List of cluster worker nodes. It contains several attributes to Block Nodes.
worker_period float
worker_period_unit str

GetKubernetesClustersClusterConnections

See the output API doc for this type.

ApiServerInternet string: API Server Internet endpoint.
ApiServerIntranet string: API Server Intranet endpoint.
MasterPublicIp string: Master node SSH IP address.
ServiceDomain string: Service Access Domain.

ApiServerInternet string: API Server Internet endpoint.
ApiServerIntranet string: API Server Intranet endpoint.
MasterPublicIp string: Master node SSH IP address.
ServiceDomain string: Service Access Domain.

apiServerInternet string: API Server Internet endpoint.
apiServerIntranet string: API Server Intranet endpoint.
masterPublicIp string: Master node SSH IP address.
serviceDomain string: Service Access Domain.

api_server_internet str: API Server Internet endpoint.
api_server_intranet str: API Server Intranet endpoint.
master_public_ip str: Master node SSH IP address.
service_domain str: Service Access Domain.

GetKubernetesClustersClusterLogConfig

See the output API doc for this type.

Project string: Log Service project name.
Type string: Type of collecting logs.

Project string: Log Service project name.
Type string: Type of collecting logs.

project string: Log Service project name.
type string: Type of collecting logs.

project str: Log Service project name.
type str: Type of collecting logs.

GetKubernetesClustersClusterMasterNode

See the output API doc for this type.

Id string: ID of the node.
Name string: Node name.
PrivateIp string: The private IP address of node.

Id string: ID of the node.
Name string: Node name.
PrivateIp string: The private IP address of node.

id string: ID of the node.
name string: Node name.
privateIp string: The private IP address of node.

id str: ID of the node.
name str: Node name.
private_ip str: The private IP address of node.

GetKubernetesClustersClusterWorkerNode

See the output API doc for this type.

Id string: ID of the node.
Name string: Node name.
PrivateIp string: The private IP address of node.

Id string: ID of the node.
Name string: Node name.
PrivateIp string: The private IP address of node.

id string: ID of the node.
name string: Node name.
privateIp string: The private IP address of node.

id str: ID of the node.
name str: Node name.
private_ip str: The private IP address of node.

Package Details

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

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

GetKubernetesClusters

Example Usage

Using GetKubernetesClusters

GetKubernetesClusters Result

Supporting Types

GetKubernetesClustersCluster

GetKubernetesClustersClusterConnections

GetKubernetesClustersClusterLogConfig

GetKubernetesClustersClusterMasterNode

GetKubernetesClustersClusterWorkerNode

Package Details

On This Page