Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Vkcs Provider
  4. API Docs
  5. getKubernetesNodeGroup
Viewing docs for vkcs 0.17.0
published on Thursday, Jun 25, 2026 by vk-cs
Schema (JSON)
vk-cs/terraform-provider-vkcs

vkcs.getKubernetesNodeGroup

Viewing docs for vkcs 0.17.0
published on Thursday, Jun 25, 2026 by vk-cs
Schema (JSON)
vk-cs/terraform-provider-vkcs

    Warning
    This data source is intended for first-generation VKCS Kubernetes clusters and should not be used for new deployments. Use the v2 version instead.

    Use this data source to get information on VKCS Kubernetes cluster’s node group.

    Example Usage

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

const k8sNodeGroup = vkcs.getKubernetesNodeGroup({
    id: defaultNg.id,
});

    import pulumi
import pulumi_vkcs as vkcs

k8s_node_group = vkcs.get_kubernetes_node_group(id=default_ng["id"])

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/vkcs/vkcs"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := vkcs.LookupKubernetesNodeGroup(ctx, &vkcs.LookupKubernetesNodeGroupArgs{
			Id: pulumi.StringRef(defaultNg.Id),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Vkcs = Pulumi.Vkcs;

return await Deployment.RunAsync(() => 
{
    var k8sNodeGroup = Vkcs.GetKubernetesNodeGroup.Invoke(new()
    {
        Id = defaultNg.Id,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vkcs.VkcsFunctions;
import com.pulumi.vkcs.inputs.GetKubernetesNodeGroupArgs;
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 k8sNodeGroup = VkcsFunctions.getKubernetesNodeGroup(GetKubernetesNodeGroupArgs.builder()
            .id(defaultNg.id())
            .build());

    }
}

    variables:
  k8sNodeGroup:
    fn::invoke:
      function: vkcs:getKubernetesNodeGroup
      arguments:
        id: ${defaultNg.id}

    Example coming soon!

    Using getKubernetesNodeGroup

    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 getKubernetesNodeGroup(args: GetKubernetesNodeGroupArgs, opts?: InvokeOptions): Promise<GetKubernetesNodeGroupResult>
function getKubernetesNodeGroupOutput(args: GetKubernetesNodeGroupOutputArgs, opts?: InvokeOptions): Output<GetKubernetesNodeGroupResult>
    def get_kubernetes_node_group(autoscaling_enabled: Optional[bool] = None,
                              flavor_id: Optional[str] = None,
                              id: Optional[str] = None,
                              max_node_unavailable: Optional[float] = None,
                              max_nodes: Optional[float] = None,
                              min_nodes: Optional[float] = None,
                              name: Optional[str] = None,
                              node_count: Optional[float] = None,
                              region: Optional[str] = None,
                              uuid: Optional[str] = None,
                              volume_size: Optional[float] = None,
                              volume_type: Optional[str] = None,
                              opts: Optional[InvokeOptions] = None) -> GetKubernetesNodeGroupResult
def get_kubernetes_node_group_output(autoscaling_enabled: pulumi.Input[Optional[bool]] = None,
                              flavor_id: pulumi.Input[Optional[str]] = None,
                              id: pulumi.Input[Optional[str]] = None,
                              max_node_unavailable: pulumi.Input[Optional[float]] = None,
                              max_nodes: pulumi.Input[Optional[float]] = None,
                              min_nodes: pulumi.Input[Optional[float]] = None,
                              name: pulumi.Input[Optional[str]] = None,
                              node_count: pulumi.Input[Optional[float]] = None,
                              region: pulumi.Input[Optional[str]] = None,
                              uuid: pulumi.Input[Optional[str]] = None,
                              volume_size: pulumi.Input[Optional[float]] = None,
                              volume_type: pulumi.Input[Optional[str]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[GetKubernetesNodeGroupResult]
    func LookupKubernetesNodeGroup(ctx *Context, args *LookupKubernetesNodeGroupArgs, opts ...InvokeOption) (*LookupKubernetesNodeGroupResult, error)
func LookupKubernetesNodeGroupOutput(ctx *Context, args *LookupKubernetesNodeGroupOutputArgs, opts ...InvokeOption) LookupKubernetesNodeGroupResultOutput

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

    public static class GetKubernetesNodeGroup 
{
    public static Task<GetKubernetesNodeGroupResult> InvokeAsync(GetKubernetesNodeGroupArgs args, InvokeOptions? opts = null)
    public static Output<GetKubernetesNodeGroupResult> Invoke(GetKubernetesNodeGroupInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetKubernetesNodeGroupResult> getKubernetesNodeGroup(GetKubernetesNodeGroupArgs args, InvokeOptions options)
public static Output<GetKubernetesNodeGroupResult> getKubernetesNodeGroup(GetKubernetesNodeGroupArgs args, InvokeOptions options)

    fn::invoke:
  function: vkcs:index/getKubernetesNodeGroup:getKubernetesNodeGroup
  arguments:
    # arguments dictionary
    data "vkcs_getkubernetesnodegroup" "name" {
    # arguments
}

    The following arguments are supported:

    AutoscalingEnabled bool
    optional boolean → Deprecated: read-only field. Determines whether the autoscaling is enabled.
    FlavorId string
    optional string → Deprecated: read-only field. The id of the flavor.
    Id string
    optional string → The UUID of the cluster's node group.
    MaxNodeUnavailable double
    optional number → Deprecated: read-only field. Specified as a percentage. The maximum number of nodes that can fail during an upgrade.
    MaxNodes double
    optional number → Deprecated: read-only field. The maximum amount of nodes in the node group.
    MinNodes double
    optional number → Deprecated: read-only field. The minimum amount of nodes in the node group.
    Name string
    optional string → Deprecated: read-only field. The name of the node group.
    NodeCount double
    optional number → Deprecated: read-only field. The count of nodes in the node group.
    Region string
    optional string → The region to obtain the service client. If omitted, the region argument of the provider is used.New since v0.4.0.
    Uuid string
    optional deprecated string → The UUID of the cluster's node group. Deprecated This argument is deprecated, please, use the id attribute instead.

    Deprecated: Deprecated

    VolumeSize double
    optional number → Deprecated: read-only field. The amount of memory in the volume in GB
    VolumeType string
    optional string → Deprecated: read-only field. The type of the volume.
    AutoscalingEnabled bool
    optional boolean → Deprecated: read-only field. Determines whether the autoscaling is enabled.
    FlavorId string
    optional string → Deprecated: read-only field. The id of the flavor.
    Id string
    optional string → The UUID of the cluster's node group.
    MaxNodeUnavailable float64
    optional number → Deprecated: read-only field. Specified as a percentage. The maximum number of nodes that can fail during an upgrade.
    MaxNodes float64
    optional number → Deprecated: read-only field. The maximum amount of nodes in the node group.
    MinNodes float64
    optional number → Deprecated: read-only field. The minimum amount of nodes in the node group.
    Name string
    optional string → Deprecated: read-only field. The name of the node group.
    NodeCount float64
    optional number → Deprecated: read-only field. The count of nodes in the node group.
    Region string
    optional string → The region to obtain the service client. If omitted, the region argument of the provider is used.New since v0.4.0.
    Uuid string
    optional deprecated string → The UUID of the cluster's node group. Deprecated This argument is deprecated, please, use the id attribute instead.

    Deprecated: Deprecated

    VolumeSize float64
    optional number → Deprecated: read-only field. The amount of memory in the volume in GB
    VolumeType string
    optional string → Deprecated: read-only field. The type of the volume.
    autoscaling_enabled bool
    optional boolean → Deprecated: read-only field. Determines whether the autoscaling is enabled.
    flavor_id string
    optional string → Deprecated: read-only field. The id of the flavor.
    id string
    optional string → The UUID of the cluster's node group.
    max_node_unavailable number
    optional number → Deprecated: read-only field. Specified as a percentage. The maximum number of nodes that can fail during an upgrade.
    max_nodes number
    optional number → Deprecated: read-only field. The maximum amount of nodes in the node group.
    min_nodes number
    optional number → Deprecated: read-only field. The minimum amount of nodes in the node group.
    name string
    optional string → Deprecated: read-only field. The name of the node group.
    node_count number
    optional number → Deprecated: read-only field. The count of nodes in the node group.
    region string
    optional string → The region to obtain the service client. If omitted, the region argument of the provider is used.New since v0.4.0.
    uuid string
    optional deprecated string → The UUID of the cluster's node group. Deprecated This argument is deprecated, please, use the id attribute instead.

    Deprecated: Deprecated

    volume_size number
    optional number → Deprecated: read-only field. The amount of memory in the volume in GB
    volume_type string
    optional string → Deprecated: read-only field. The type of the volume.
    autoscalingEnabled Boolean
    optional boolean → Deprecated: read-only field. Determines whether the autoscaling is enabled.
    flavorId String
    optional string → Deprecated: read-only field. The id of the flavor.
    id String
    optional string → The UUID of the cluster's node group.
    maxNodeUnavailable Double
    optional number → Deprecated: read-only field. Specified as a percentage. The maximum number of nodes that can fail during an upgrade.
    maxNodes Double
    optional number → Deprecated: read-only field. The maximum amount of nodes in the node group.
    minNodes Double
    optional number → Deprecated: read-only field. The minimum amount of nodes in the node group.
    name String
    optional string → Deprecated: read-only field. The name of the node group.
    nodeCount Double
    optional number → Deprecated: read-only field. The count of nodes in the node group.
    region String
    optional string → The region to obtain the service client. If omitted, the region argument of the provider is used.New since v0.4.0.
    uuid String
    optional deprecated string → The UUID of the cluster's node group. Deprecated This argument is deprecated, please, use the id attribute instead.

    Deprecated: Deprecated

    volumeSize Double
    optional number → Deprecated: read-only field. The amount of memory in the volume in GB
    volumeType String
    optional string → Deprecated: read-only field. The type of the volume.
    autoscalingEnabled boolean
    optional boolean → Deprecated: read-only field. Determines whether the autoscaling is enabled.
    flavorId string
    optional string → Deprecated: read-only field. The id of the flavor.
    id string
    optional string → The UUID of the cluster's node group.
    maxNodeUnavailable number
    optional number → Deprecated: read-only field. Specified as a percentage. The maximum number of nodes that can fail during an upgrade.
    maxNodes number
    optional number → Deprecated: read-only field. The maximum amount of nodes in the node group.
    minNodes number
    optional number → Deprecated: read-only field. The minimum amount of nodes in the node group.
    name string
    optional string → Deprecated: read-only field. The name of the node group.
    nodeCount number
    optional number → Deprecated: read-only field. The count of nodes in the node group.
    region string
    optional string → The region to obtain the service client. If omitted, the region argument of the provider is used.New since v0.4.0.
    uuid string
    optional deprecated string → The UUID of the cluster's node group. Deprecated This argument is deprecated, please, use the id attribute instead.

    Deprecated: Deprecated

    volumeSize number
    optional number → Deprecated: read-only field. The amount of memory in the volume in GB
    volumeType string
    optional string → Deprecated: read-only field. The type of the volume.
    autoscaling_enabled bool
    optional boolean → Deprecated: read-only field. Determines whether the autoscaling is enabled.
    flavor_id str
    optional string → Deprecated: read-only field. The id of the flavor.
    id str
    optional string → The UUID of the cluster's node group.
    max_node_unavailable float
    optional number → Deprecated: read-only field. Specified as a percentage. The maximum number of nodes that can fail during an upgrade.
    max_nodes float
    optional number → Deprecated: read-only field. The maximum amount of nodes in the node group.
    min_nodes float
    optional number → Deprecated: read-only field. The minimum amount of nodes in the node group.
    name str
    optional string → Deprecated: read-only field. The name of the node group.
    node_count float
    optional number → Deprecated: read-only field. The count of nodes in the node group.
    region str
    optional string → The region to obtain the service client. If omitted, the region argument of the provider is used.New since v0.4.0.
    uuid str
    optional deprecated string → The UUID of the cluster's node group. Deprecated This argument is deprecated, please, use the id attribute instead.

    Deprecated: Deprecated

    volume_size float
    optional number → Deprecated: read-only field. The amount of memory in the volume in GB
    volume_type str
    optional string → Deprecated: read-only field. The type of the volume.
    autoscalingEnabled Boolean
    optional boolean → Deprecated: read-only field. Determines whether the autoscaling is enabled.
    flavorId String
    optional string → Deprecated: read-only field. The id of the flavor.
    id String
    optional string → The UUID of the cluster's node group.
    maxNodeUnavailable Number
    optional number → Deprecated: read-only field. Specified as a percentage. The maximum number of nodes that can fail during an upgrade.
    maxNodes Number
    optional number → Deprecated: read-only field. The maximum amount of nodes in the node group.
    minNodes Number
    optional number → Deprecated: read-only field. The minimum amount of nodes in the node group.
    name String
    optional string → Deprecated: read-only field. The name of the node group.
    nodeCount Number
    optional number → Deprecated: read-only field. The count of nodes in the node group.
    region String
    optional string → The region to obtain the service client. If omitted, the region argument of the provider is used.New since v0.4.0.
    uuid String
    optional deprecated string → The UUID of the cluster's node group. Deprecated This argument is deprecated, please, use the id attribute instead.

    Deprecated: Deprecated

    volumeSize Number
    optional number → Deprecated: read-only field. The amount of memory in the volume in GB
    volumeType String
    optional string → Deprecated: read-only field. The type of the volume.

    getKubernetesNodeGroup Result

    The following output properties are available:

    AutoscalingEnabled bool
    AvailabilityZones List<string>
    string → The list of availability zones of the node group.
    ClusterId string
    string → The UUID of cluster that node group belongs.
    FlavorId string
    Id string
    MaxNodeUnavailable double
    MaxNodes double
    MinNodes double
    Name string
    string → Name of a node.
    NodeCount double
    Nodes List<GetKubernetesNodeGroupNode>
    list → The list of node group's node objects.
    Region string
    State string
    string → Determines current state of node group (RUNNING, SHUTOFF, ERROR).
    Uuid string
    string → UUID of a node.

    Deprecated: Deprecated

    VolumeSize double
    VolumeType string
    AutoscalingEnabled bool
    AvailabilityZones []string
    string → The list of availability zones of the node group.
    ClusterId string
    string → The UUID of cluster that node group belongs.
    FlavorId string
    Id string
    MaxNodeUnavailable float64
    MaxNodes float64
    MinNodes float64
    Name string
    string → Name of a node.
    NodeCount float64
    Nodes []GetKubernetesNodeGroupNode
    list → The list of node group's node objects.
    Region string
    State string
    string → Determines current state of node group (RUNNING, SHUTOFF, ERROR).
    Uuid string
    string → UUID of a node.

    Deprecated: Deprecated

    VolumeSize float64
    VolumeType string
    autoscaling_enabled bool
    availability_zones list(string)
    string → The list of availability zones of the node group.
    cluster_id string
    string → The UUID of cluster that node group belongs.
    flavor_id string
    id string
    max_node_unavailable number
    max_nodes number
    min_nodes number
    name string
    string → Name of a node.
    node_count number
    nodes list(object)
    list → The list of node group's node objects.
    region string
    state string
    string → Determines current state of node group (RUNNING, SHUTOFF, ERROR).
    uuid string
    string → UUID of a node.

    Deprecated: Deprecated

    volume_size number
    volume_type string
    autoscalingEnabled Boolean
    availabilityZones List<String>
    string → The list of availability zones of the node group.
    clusterId String
    string → The UUID of cluster that node group belongs.
    flavorId String
    id String
    maxNodeUnavailable Double
    maxNodes Double
    minNodes Double
    name String
    string → Name of a node.
    nodeCount Double
    nodes List<GetKubernetesNodeGroupNode>
    list → The list of node group's node objects.
    region String
    state String
    string → Determines current state of node group (RUNNING, SHUTOFF, ERROR).
    uuid String
    string → UUID of a node.

    Deprecated: Deprecated

    volumeSize Double
    volumeType String
    autoscalingEnabled boolean
    availabilityZones string[]
    string → The list of availability zones of the node group.
    clusterId string
    string → The UUID of cluster that node group belongs.
    flavorId string
    id string
    maxNodeUnavailable number
    maxNodes number
    minNodes number
    name string
    string → Name of a node.
    nodeCount number
    nodes GetKubernetesNodeGroupNode[]
    list → The list of node group's node objects.
    region string
    state string
    string → Determines current state of node group (RUNNING, SHUTOFF, ERROR).
    uuid string
    string → UUID of a node.

    Deprecated: Deprecated

    volumeSize number
    volumeType string
    autoscaling_enabled bool
    availability_zones Sequence[str]
    string → The list of availability zones of the node group.
    cluster_id str
    string → The UUID of cluster that node group belongs.
    flavor_id str
    id str
    max_node_unavailable float
    max_nodes float
    min_nodes float
    name str
    string → Name of a node.
    node_count float
    nodes Sequence[GetKubernetesNodeGroupNode]
    list → The list of node group's node objects.
    region str
    state str
    string → Determines current state of node group (RUNNING, SHUTOFF, ERROR).
    uuid str
    string → UUID of a node.

    Deprecated: Deprecated

    volume_size float
    volume_type str
    autoscalingEnabled Boolean
    availabilityZones List<String>
    string → The list of availability zones of the node group.
    clusterId String
    string → The UUID of cluster that node group belongs.
    flavorId String
    id String
    maxNodeUnavailable Number
    maxNodes Number
    minNodes Number
    name String
    string → Name of a node.
    nodeCount Number
    nodes List<Property Map>
    list → The list of node group's node objects.
    region String
    state String
    string → Determines current state of node group (RUNNING, SHUTOFF, ERROR).
    uuid String
    string → UUID of a node.

    Deprecated: Deprecated

    volumeSize Number
    volumeType String

    Supporting Types

    GetKubernetesNodeGroupNode

    CreatedAt string
    string → Time when a node was created.
    Name string
    optional string → Deprecated: read-only field. The name of the node group.
    NodeGroupId string
    string → The node group id.
    UpdatedAt string
    string → Time when a node was updated.
    Uuid string
    optional deprecated string → The UUID of the cluster's node group. Deprecated This argument is deprecated, please, use the id attribute instead.
    CreatedAt string
    string → Time when a node was created.
    Name string
    optional string → Deprecated: read-only field. The name of the node group.
    NodeGroupId string
    string → The node group id.
    UpdatedAt string
    string → Time when a node was updated.
    Uuid string
    optional deprecated string → The UUID of the cluster's node group. Deprecated This argument is deprecated, please, use the id attribute instead.
    created_at string
    string → Time when a node was created.
    name string
    optional string → Deprecated: read-only field. The name of the node group.
    node_group_id string
    string → The node group id.
    updated_at string
    string → Time when a node was updated.
    uuid string
    optional deprecated string → The UUID of the cluster's node group. Deprecated This argument is deprecated, please, use the id attribute instead.
    createdAt String
    string → Time when a node was created.
    name String
    optional string → Deprecated: read-only field. The name of the node group.
    nodeGroupId String
    string → The node group id.
    updatedAt String
    string → Time when a node was updated.
    uuid String
    optional deprecated string → The UUID of the cluster's node group. Deprecated This argument is deprecated, please, use the id attribute instead.
    createdAt string
    string → Time when a node was created.
    name string
    optional string → Deprecated: read-only field. The name of the node group.
    nodeGroupId string
    string → The node group id.
    updatedAt string
    string → Time when a node was updated.
    uuid string
    optional deprecated string → The UUID of the cluster's node group. Deprecated This argument is deprecated, please, use the id attribute instead.
    created_at str
    string → Time when a node was created.
    name str
    optional string → Deprecated: read-only field. The name of the node group.
    node_group_id str
    string → The node group id.
    updated_at str
    string → Time when a node was updated.
    uuid str
    optional deprecated string → The UUID of the cluster's node group. Deprecated This argument is deprecated, please, use the id attribute instead.
    createdAt String
    string → Time when a node was created.
    name String
    optional string → Deprecated: read-only field. The name of the node group.
    nodeGroupId String
    string → The node group id.
    updatedAt String
    string → Time when a node was updated.
    uuid String
    optional deprecated string → The UUID of the cluster's node group. Deprecated This argument is deprecated, please, use the id attribute instead.

    Package Details

    Repository
    vkcs vk-cs/terraform-provider-vkcs
    License
    Notes
    This Pulumi package is based on the vkcs Terraform Provider.
    Viewing docs for vkcs 0.17.0
    published on Thursday, Jun 25, 2026 by vk-cs
    Schema (JSON)
    vk-cs/terraform-provider-vkcs

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial