1. Registry
  2. Packages
  3. Ucloud Provider
  4. API Docs
  5. Uk8sNodeGroup
Viewing docs for ucloud 1.45.0
published on Thursday, Sep 24, 2026 by ucloud
Viewing docs for ucloud 1.45.0
published on Thursday, Sep 24, 2026 by ucloud

    Import

    Import a node group using its cluster ID and node group ID, separated by /:

    $ pulumi import ucloud:index/uk8sNodeGroup:Uk8sNodeGroup workers uk8s-example/nodegroup-example
    

    Configure the provider with the cluster’s region and project. Import stores cluster_id separately and keeps the node group ID as the Terraform resource ID, matching normal creation. The remaining template fields are populated by reading the node group. Add the corresponding resource configuration and review pulumi preview after import.

    Create Uk8sNodeGroup Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Uk8sNodeGroup(name: string, args: Uk8sNodeGroupArgs, opts?: CustomResourceOptions);
    @overload
    def Uk8sNodeGroup(resource_name: str,
                      args: Uk8sNodeGroupArgs,
                      opts: Optional[ResourceOptions] = None)
    
    @overload
    def Uk8sNodeGroup(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      cluster_id: Optional[str] = None,
                      subnet_id: Optional[str] = None,
                      instance_type: Optional[str] = None,
                      availability_zone: Optional[str] = None,
                      data_disk_size: Optional[float] = None,
                      min_cpu_platform: Optional[str] = None,
                      data_disk_type: Optional[str] = None,
                      image_id: Optional[str] = None,
                      init_script: Optional[str] = None,
                      boot_disk_type: Optional[str] = None,
                      isolation_group: Optional[str] = None,
                      labels: Optional[Mapping[str, str]] = None,
                      max_pods: Optional[float] = None,
                      charge_type: Optional[str] = None,
                      name: Optional[str] = None,
                      boot_disk_size: Optional[float] = None,
                      tag: Optional[str] = None,
                      taints: Optional[Sequence[Uk8sNodeGroupTaintArgs]] = None,
                      timeouts: Optional[Uk8sNodeGroupTimeoutsArgs] = None,
                      uhost_family: Optional[str] = None,
                      uk8s_node_group_id: Optional[str] = None,
                      user_data: Optional[str] = None)
    func NewUk8sNodeGroup(ctx *Context, name string, args Uk8sNodeGroupArgs, opts ...ResourceOption) (*Uk8sNodeGroup, error)
    public Uk8sNodeGroup(string name, Uk8sNodeGroupArgs args, CustomResourceOptions? opts = null)
    public Uk8sNodeGroup(String name, Uk8sNodeGroupArgs args)
    public Uk8sNodeGroup(String name, Uk8sNodeGroupArgs args, CustomResourceOptions options)
    
    type: ucloud:Uk8sNodeGroup
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "ucloud_uk8s_node_group" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args Uk8sNodeGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args Uk8sNodeGroupArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args Uk8sNodeGroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args Uk8sNodeGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args Uk8sNodeGroupArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var uk8sNodeGroupResource = new Ucloud.Uk8sNodeGroup("uk8sNodeGroupResource", new()
    {
        ClusterId = "string",
        SubnetId = "string",
        InstanceType = "string",
        AvailabilityZone = "string",
        DataDiskSize = 0.0,
        MinCpuPlatform = "string",
        DataDiskType = "string",
        ImageId = "string",
        InitScript = "string",
        BootDiskType = "string",
        IsolationGroup = "string",
        Labels = 
        {
            { "string", "string" },
        },
        MaxPods = 0.0,
        ChargeType = "string",
        Name = "string",
        BootDiskSize = 0.0,
        Tag = "string",
        Taints = new[]
        {
            new Ucloud.Inputs.Uk8sNodeGroupTaintArgs
            {
                Effect = "string",
                Key = "string",
                Value = "string",
            },
        },
        Timeouts = new Ucloud.Inputs.Uk8sNodeGroupTimeoutsArgs
        {
            Create = "string",
            Delete = "string",
            Update = "string",
        },
        UhostFamily = "string",
        Uk8sNodeGroupId = "string",
        UserData = "string",
    });
    
    example, err := ucloud.NewUk8sNodeGroup(ctx, "uk8sNodeGroupResource", &ucloud.Uk8sNodeGroupArgs{
    	ClusterId:        pulumi.String("string"),
    	SubnetId:         pulumi.String("string"),
    	InstanceType:     pulumi.String("string"),
    	AvailabilityZone: pulumi.String("string"),
    	DataDiskSize:     pulumi.Float64(0),
    	MinCpuPlatform:   pulumi.String("string"),
    	DataDiskType:     pulumi.String("string"),
    	ImageId:          pulumi.String("string"),
    	InitScript:       pulumi.String("string"),
    	BootDiskType:     pulumi.String("string"),
    	IsolationGroup:   pulumi.String("string"),
    	Labels: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	MaxPods:      pulumi.Float64(0),
    	ChargeType:   pulumi.String("string"),
    	Name:         pulumi.String("string"),
    	BootDiskSize: pulumi.Float64(0),
    	Tag:          pulumi.String("string"),
    	Taints: ucloud.Uk8sNodeGroupTaintArray{
    		&ucloud.Uk8sNodeGroupTaintArgs{
    			Effect: pulumi.String("string"),
    			Key:    pulumi.String("string"),
    			Value:  pulumi.String("string"),
    		},
    	},
    	Timeouts: &ucloud.Uk8sNodeGroupTimeoutsArgs{
    		Create: pulumi.String("string"),
    		Delete: pulumi.String("string"),
    		Update: pulumi.String("string"),
    	},
    	UhostFamily:     pulumi.String("string"),
    	Uk8sNodeGroupId: pulumi.String("string"),
    	UserData:        pulumi.String("string"),
    })
    
    resource "ucloud_uk8s_node_group" "uk8sNodeGroupResource" {
      lifecycle {
        create_before_destroy = true
      }
      cluster_id        = "string"
      subnet_id         = "string"
      instance_type     = "string"
      availability_zone = "string"
      data_disk_size    = 0
      min_cpu_platform  = "string"
      data_disk_type    = "string"
      image_id          = "string"
      init_script       = "string"
      boot_disk_type    = "string"
      isolation_group   = "string"
      labels = {
        "string" = "string"
      }
      max_pods       = 0
      charge_type    = "string"
      name           = "string"
      boot_disk_size = 0
      tag            = "string"
      taints {
        effect = "string"
        key    = "string"
        value  = "string"
      }
      timeouts = {
        create = "string"
        delete = "string"
        update = "string"
      }
      uhost_family       = "string"
      uk8s_node_group_id = "string"
      user_data          = "string"
    }
    
    var uk8sNodeGroupResource = new Uk8sNodeGroup("uk8sNodeGroupResource", Uk8sNodeGroupArgs.builder()
        .clusterId("string")
        .subnetId("string")
        .instanceType("string")
        .availabilityZone("string")
        .dataDiskSize(0.0)
        .minCpuPlatform("string")
        .dataDiskType("string")
        .imageId("string")
        .initScript("string")
        .bootDiskType("string")
        .isolationGroup("string")
        .labels(Map.of("string", "string"))
        .maxPods(0.0)
        .chargeType("string")
        .name("string")
        .bootDiskSize(0.0)
        .tag("string")
        .taints(Uk8sNodeGroupTaintArgs.builder()
            .effect("string")
            .key("string")
            .value("string")
            .build())
        .timeouts(Uk8sNodeGroupTimeoutsArgs.builder()
            .create("string")
            .delete("string")
            .update("string")
            .build())
        .uhostFamily("string")
        .uk8sNodeGroupId("string")
        .userData("string")
        .build());
    
    uk8s_node_group_resource = ucloud.Uk8sNodeGroup("uk8sNodeGroupResource",
        cluster_id="string",
        subnet_id="string",
        instance_type="string",
        availability_zone="string",
        data_disk_size=float(0),
        min_cpu_platform="string",
        data_disk_type="string",
        image_id="string",
        init_script="string",
        boot_disk_type="string",
        isolation_group="string",
        labels={
            "string": "string",
        },
        max_pods=float(0),
        charge_type="string",
        name="string",
        boot_disk_size=float(0),
        tag="string",
        taints=[{
            "effect": "string",
            "key": "string",
            "value": "string",
        }],
        timeouts={
            "create": "string",
            "delete": "string",
            "update": "string",
        },
        uhost_family="string",
        uk8s_node_group_id="string",
        user_data="string")
    
    const uk8sNodeGroupResource = new ucloud.Uk8sNodeGroup("uk8sNodeGroupResource", {
        clusterId: "string",
        subnetId: "string",
        instanceType: "string",
        availabilityZone: "string",
        dataDiskSize: 0,
        minCpuPlatform: "string",
        dataDiskType: "string",
        imageId: "string",
        initScript: "string",
        bootDiskType: "string",
        isolationGroup: "string",
        labels: {
            string: "string",
        },
        maxPods: 0,
        chargeType: "string",
        name: "string",
        bootDiskSize: 0,
        tag: "string",
        taints: [{
            effect: "string",
            key: "string",
            value: "string",
        }],
        timeouts: {
            create: "string",
            "delete": "string",
            update: "string",
        },
        uhostFamily: "string",
        uk8sNodeGroupId: "string",
        userData: "string",
    });
    
    type: ucloud:Uk8sNodeGroup
    properties:
        availabilityZone: string
        bootDiskSize: 0
        bootDiskType: string
        chargeType: string
        clusterId: string
        dataDiskSize: 0
        dataDiskType: string
        imageId: string
        initScript: string
        instanceType: string
        isolationGroup: string
        labels:
            string: string
        maxPods: 0
        minCpuPlatform: string
        name: string
        subnetId: string
        tag: string
        taints:
            - effect: string
              key: string
              value: string
        timeouts:
            create: string
            delete: string
            update: string
        uhostFamily: string
        uk8sNodeGroupId: string
        userData: string
    

    Uk8sNodeGroup Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Uk8sNodeGroup resource accepts the following input properties:

    AvailabilityZone string
    The availability zone used by the node group template.
    ClusterId string
    The ID of the UK8S cluster.
    InstanceType string
    The worker instance type, such as o-basic-2.
    SubnetId string
    The subnet ID used by the node group template.
    BootDiskSize double
    The boot disk size in GB. Default is 40.
    BootDiskType string
    The boot disk type, including cloud_rssd. Default is cloud_ssd. Set cloud_rssd when using uhost_family = "o1i" or "o2i".
    ChargeType string
    The charge type. Valid values are year, month, and dynamic. Default is month.
    DataDiskSize double
    The data disk size in GB. Default is 0.
    DataDiskType string
    The data disk type, including cloud_rssd. Default is cloud_ssd. Set a positive data_disk_size to create a data disk.
    ImageId string
    The image ID used by new nodes.
    InitScript string
    A script run after the node initializes.
    IsolationGroup string
    The isolation group ID.
    Labels Dictionary<string, string>
    A map of Kubernetes labels for nodes added from this node group. At most 20 labels are supported.
    MaxPods double
    The maximum number of pods per node. Default is 110.
    MinCpuPlatform string
    The minimum CPU platform. Default is Intel/Auto.
    Name string
    The name of the node group.
    Tag string
    The business tag.
    Taints List<Uk8sNodeGroupTaint>
    One or more taints for nodes added from this node group. At most 10 taints are supported. Each block accepts key, value, and an effect of NoSchedule, PreferNoSchedule, or NoExecute.
    Timeouts Uk8sNodeGroupTimeouts
    UhostFamily string
    The Intel outstanding instance family: o1i or o2i. Use instance_type = "o-basic-2", uhost_family = "o2i", and boot_disk_type = "cloud_rssd" for O2 Intel nodes. For an RSSD data disk, also set data_disk_type = "cloud_rssd" and a positive data_disk_size. Requires an Intel CPU platform. When omitted, the family is read from UK8S. Updates change the template for future nodes without replacing existing nodes.
    Uk8sNodeGroupId string
    UserData string
    User data run while the instance initializes.
    AvailabilityZone string
    The availability zone used by the node group template.
    ClusterId string
    The ID of the UK8S cluster.
    InstanceType string
    The worker instance type, such as o-basic-2.
    SubnetId string
    The subnet ID used by the node group template.
    BootDiskSize float64
    The boot disk size in GB. Default is 40.
    BootDiskType string
    The boot disk type, including cloud_rssd. Default is cloud_ssd. Set cloud_rssd when using uhost_family = "o1i" or "o2i".
    ChargeType string
    The charge type. Valid values are year, month, and dynamic. Default is month.
    DataDiskSize float64
    The data disk size in GB. Default is 0.
    DataDiskType string
    The data disk type, including cloud_rssd. Default is cloud_ssd. Set a positive data_disk_size to create a data disk.
    ImageId string
    The image ID used by new nodes.
    InitScript string
    A script run after the node initializes.
    IsolationGroup string
    The isolation group ID.
    Labels map[string]string
    A map of Kubernetes labels for nodes added from this node group. At most 20 labels are supported.
    MaxPods float64
    The maximum number of pods per node. Default is 110.
    MinCpuPlatform string
    The minimum CPU platform. Default is Intel/Auto.
    Name string
    The name of the node group.
    Tag string
    The business tag.
    Taints []Uk8sNodeGroupTaintArgs
    One or more taints for nodes added from this node group. At most 10 taints are supported. Each block accepts key, value, and an effect of NoSchedule, PreferNoSchedule, or NoExecute.
    Timeouts Uk8sNodeGroupTimeoutsArgs
    UhostFamily string
    The Intel outstanding instance family: o1i or o2i. Use instance_type = "o-basic-2", uhost_family = "o2i", and boot_disk_type = "cloud_rssd" for O2 Intel nodes. For an RSSD data disk, also set data_disk_type = "cloud_rssd" and a positive data_disk_size. Requires an Intel CPU platform. When omitted, the family is read from UK8S. Updates change the template for future nodes without replacing existing nodes.
    Uk8sNodeGroupId string
    UserData string
    User data run while the instance initializes.
    availability_zone string
    The availability zone used by the node group template.
    cluster_id string
    The ID of the UK8S cluster.
    instance_type string
    The worker instance type, such as o-basic-2.
    subnet_id string
    The subnet ID used by the node group template.
    boot_disk_size number
    The boot disk size in GB. Default is 40.
    boot_disk_type string
    The boot disk type, including cloud_rssd. Default is cloud_ssd. Set cloud_rssd when using uhost_family = "o1i" or "o2i".
    charge_type string
    The charge type. Valid values are year, month, and dynamic. Default is month.
    data_disk_size number
    The data disk size in GB. Default is 0.
    data_disk_type string
    The data disk type, including cloud_rssd. Default is cloud_ssd. Set a positive data_disk_size to create a data disk.
    image_id string
    The image ID used by new nodes.
    init_script string
    A script run after the node initializes.
    isolation_group string
    The isolation group ID.
    labels map(string)
    A map of Kubernetes labels for nodes added from this node group. At most 20 labels are supported.
    max_pods number
    The maximum number of pods per node. Default is 110.
    min_cpu_platform string
    The minimum CPU platform. Default is Intel/Auto.
    name string
    The name of the node group.
    tag string
    The business tag.
    taints list(object)
    One or more taints for nodes added from this node group. At most 10 taints are supported. Each block accepts key, value, and an effect of NoSchedule, PreferNoSchedule, or NoExecute.
    timeouts object
    uhost_family string
    The Intel outstanding instance family: o1i or o2i. Use instance_type = "o-basic-2", uhost_family = "o2i", and boot_disk_type = "cloud_rssd" for O2 Intel nodes. For an RSSD data disk, also set data_disk_type = "cloud_rssd" and a positive data_disk_size. Requires an Intel CPU platform. When omitted, the family is read from UK8S. Updates change the template for future nodes without replacing existing nodes.
    uk8s_node_group_id string
    user_data string
    User data run while the instance initializes.
    availabilityZone String
    The availability zone used by the node group template.
    clusterId String
    The ID of the UK8S cluster.
    instanceType String
    The worker instance type, such as o-basic-2.
    subnetId String
    The subnet ID used by the node group template.
    bootDiskSize Double
    The boot disk size in GB. Default is 40.
    bootDiskType String
    The boot disk type, including cloud_rssd. Default is cloud_ssd. Set cloud_rssd when using uhost_family = "o1i" or "o2i".
    chargeType String
    The charge type. Valid values are year, month, and dynamic. Default is month.
    dataDiskSize Double
    The data disk size in GB. Default is 0.
    dataDiskType String
    The data disk type, including cloud_rssd. Default is cloud_ssd. Set a positive data_disk_size to create a data disk.
    imageId String
    The image ID used by new nodes.
    initScript String
    A script run after the node initializes.
    isolationGroup String
    The isolation group ID.
    labels Map<String,String>
    A map of Kubernetes labels for nodes added from this node group. At most 20 labels are supported.
    maxPods Double
    The maximum number of pods per node. Default is 110.
    minCpuPlatform String
    The minimum CPU platform. Default is Intel/Auto.
    name String
    The name of the node group.
    tag String
    The business tag.
    taints List<Uk8sNodeGroupTaint>
    One or more taints for nodes added from this node group. At most 10 taints are supported. Each block accepts key, value, and an effect of NoSchedule, PreferNoSchedule, or NoExecute.
    timeouts Uk8sNodeGroupTimeouts
    uhostFamily String
    The Intel outstanding instance family: o1i or o2i. Use instance_type = "o-basic-2", uhost_family = "o2i", and boot_disk_type = "cloud_rssd" for O2 Intel nodes. For an RSSD data disk, also set data_disk_type = "cloud_rssd" and a positive data_disk_size. Requires an Intel CPU platform. When omitted, the family is read from UK8S. Updates change the template for future nodes without replacing existing nodes.
    uk8sNodeGroupId String
    userData String
    User data run while the instance initializes.
    availabilityZone string
    The availability zone used by the node group template.
    clusterId string
    The ID of the UK8S cluster.
    instanceType string
    The worker instance type, such as o-basic-2.
    subnetId string
    The subnet ID used by the node group template.
    bootDiskSize number
    The boot disk size in GB. Default is 40.
    bootDiskType string
    The boot disk type, including cloud_rssd. Default is cloud_ssd. Set cloud_rssd when using uhost_family = "o1i" or "o2i".
    chargeType string
    The charge type. Valid values are year, month, and dynamic. Default is month.
    dataDiskSize number
    The data disk size in GB. Default is 0.
    dataDiskType string
    The data disk type, including cloud_rssd. Default is cloud_ssd. Set a positive data_disk_size to create a data disk.
    imageId string
    The image ID used by new nodes.
    initScript string
    A script run after the node initializes.
    isolationGroup string
    The isolation group ID.
    labels {[key: string]: string}
    A map of Kubernetes labels for nodes added from this node group. At most 20 labels are supported.
    maxPods number
    The maximum number of pods per node. Default is 110.
    minCpuPlatform string
    The minimum CPU platform. Default is Intel/Auto.
    name string
    The name of the node group.
    tag string
    The business tag.
    taints Uk8sNodeGroupTaint[]
    One or more taints for nodes added from this node group. At most 10 taints are supported. Each block accepts key, value, and an effect of NoSchedule, PreferNoSchedule, or NoExecute.
    timeouts Uk8sNodeGroupTimeouts
    uhostFamily string
    The Intel outstanding instance family: o1i or o2i. Use instance_type = "o-basic-2", uhost_family = "o2i", and boot_disk_type = "cloud_rssd" for O2 Intel nodes. For an RSSD data disk, also set data_disk_type = "cloud_rssd" and a positive data_disk_size. Requires an Intel CPU platform. When omitted, the family is read from UK8S. Updates change the template for future nodes without replacing existing nodes.
    uk8sNodeGroupId string
    userData string
    User data run while the instance initializes.
    availability_zone str
    The availability zone used by the node group template.
    cluster_id str
    The ID of the UK8S cluster.
    instance_type str
    The worker instance type, such as o-basic-2.
    subnet_id str
    The subnet ID used by the node group template.
    boot_disk_size float
    The boot disk size in GB. Default is 40.
    boot_disk_type str
    The boot disk type, including cloud_rssd. Default is cloud_ssd. Set cloud_rssd when using uhost_family = "o1i" or "o2i".
    charge_type str
    The charge type. Valid values are year, month, and dynamic. Default is month.
    data_disk_size float
    The data disk size in GB. Default is 0.
    data_disk_type str
    The data disk type, including cloud_rssd. Default is cloud_ssd. Set a positive data_disk_size to create a data disk.
    image_id str
    The image ID used by new nodes.
    init_script str
    A script run after the node initializes.
    isolation_group str
    The isolation group ID.
    labels Mapping[str, str]
    A map of Kubernetes labels for nodes added from this node group. At most 20 labels are supported.
    max_pods float
    The maximum number of pods per node. Default is 110.
    min_cpu_platform str
    The minimum CPU platform. Default is Intel/Auto.
    name str
    The name of the node group.
    tag str
    The business tag.
    taints Sequence[Uk8sNodeGroupTaintArgs]
    One or more taints for nodes added from this node group. At most 10 taints are supported. Each block accepts key, value, and an effect of NoSchedule, PreferNoSchedule, or NoExecute.
    timeouts Uk8sNodeGroupTimeoutsArgs
    uhost_family str
    The Intel outstanding instance family: o1i or o2i. Use instance_type = "o-basic-2", uhost_family = "o2i", and boot_disk_type = "cloud_rssd" for O2 Intel nodes. For an RSSD data disk, also set data_disk_type = "cloud_rssd" and a positive data_disk_size. Requires an Intel CPU platform. When omitted, the family is read from UK8S. Updates change the template for future nodes without replacing existing nodes.
    uk8s_node_group_id str
    user_data str
    User data run while the instance initializes.
    availabilityZone String
    The availability zone used by the node group template.
    clusterId String
    The ID of the UK8S cluster.
    instanceType String
    The worker instance type, such as o-basic-2.
    subnetId String
    The subnet ID used by the node group template.
    bootDiskSize Number
    The boot disk size in GB. Default is 40.
    bootDiskType String
    The boot disk type, including cloud_rssd. Default is cloud_ssd. Set cloud_rssd when using uhost_family = "o1i" or "o2i".
    chargeType String
    The charge type. Valid values are year, month, and dynamic. Default is month.
    dataDiskSize Number
    The data disk size in GB. Default is 0.
    dataDiskType String
    The data disk type, including cloud_rssd. Default is cloud_ssd. Set a positive data_disk_size to create a data disk.
    imageId String
    The image ID used by new nodes.
    initScript String
    A script run after the node initializes.
    isolationGroup String
    The isolation group ID.
    labels Map<String>
    A map of Kubernetes labels for nodes added from this node group. At most 20 labels are supported.
    maxPods Number
    The maximum number of pods per node. Default is 110.
    minCpuPlatform String
    The minimum CPU platform. Default is Intel/Auto.
    name String
    The name of the node group.
    tag String
    The business tag.
    taints List<Property Map>
    One or more taints for nodes added from this node group. At most 10 taints are supported. Each block accepts key, value, and an effect of NoSchedule, PreferNoSchedule, or NoExecute.
    timeouts Property Map
    uhostFamily String
    The Intel outstanding instance family: o1i or o2i. Use instance_type = "o-basic-2", uhost_family = "o2i", and boot_disk_type = "cloud_rssd" for O2 Intel nodes. For an RSSD data disk, also set data_disk_type = "cloud_rssd" and a positive data_disk_size. Requires an Intel CPU platform. When omitted, the family is read from UK8S. Updates change the template for future nodes without replacing existing nodes.
    uk8sNodeGroupId String
    userData String
    User data run while the instance initializes.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Uk8sNodeGroup resource produces the following output properties:

    CreateTime string
    The node group creation time in RFC3339 format.
    Id string
    The provider-assigned unique ID for this managed resource.
    NodeIds List<string>
    IDs of nodes currently associated with the node group.
    UpdateTime string
    The last node group update time in RFC3339 format.
    CreateTime string
    The node group creation time in RFC3339 format.
    Id string
    The provider-assigned unique ID for this managed resource.
    NodeIds []string
    IDs of nodes currently associated with the node group.
    UpdateTime string
    The last node group update time in RFC3339 format.
    create_time string
    The node group creation time in RFC3339 format.
    id string
    The provider-assigned unique ID for this managed resource.
    node_ids list(string)
    IDs of nodes currently associated with the node group.
    update_time string
    The last node group update time in RFC3339 format.
    createTime String
    The node group creation time in RFC3339 format.
    id String
    The provider-assigned unique ID for this managed resource.
    nodeIds List<String>
    IDs of nodes currently associated with the node group.
    updateTime String
    The last node group update time in RFC3339 format.
    createTime string
    The node group creation time in RFC3339 format.
    id string
    The provider-assigned unique ID for this managed resource.
    nodeIds string[]
    IDs of nodes currently associated with the node group.
    updateTime string
    The last node group update time in RFC3339 format.
    create_time str
    The node group creation time in RFC3339 format.
    id str
    The provider-assigned unique ID for this managed resource.
    node_ids Sequence[str]
    IDs of nodes currently associated with the node group.
    update_time str
    The last node group update time in RFC3339 format.
    createTime String
    The node group creation time in RFC3339 format.
    id String
    The provider-assigned unique ID for this managed resource.
    nodeIds List<String>
    IDs of nodes currently associated with the node group.
    updateTime String
    The last node group update time in RFC3339 format.

    Look up Existing Uk8sNodeGroup Resource

    Get an existing Uk8sNodeGroup resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: Uk8sNodeGroupState, opts?: CustomResourceOptions): Uk8sNodeGroup
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            availability_zone: Optional[str] = None,
            boot_disk_size: Optional[float] = None,
            boot_disk_type: Optional[str] = None,
            charge_type: Optional[str] = None,
            cluster_id: Optional[str] = None,
            create_time: Optional[str] = None,
            data_disk_size: Optional[float] = None,
            data_disk_type: Optional[str] = None,
            image_id: Optional[str] = None,
            init_script: Optional[str] = None,
            instance_type: Optional[str] = None,
            isolation_group: Optional[str] = None,
            labels: Optional[Mapping[str, str]] = None,
            max_pods: Optional[float] = None,
            min_cpu_platform: Optional[str] = None,
            name: Optional[str] = None,
            node_ids: Optional[Sequence[str]] = None,
            subnet_id: Optional[str] = None,
            tag: Optional[str] = None,
            taints: Optional[Sequence[Uk8sNodeGroupTaintArgs]] = None,
            timeouts: Optional[Uk8sNodeGroupTimeoutsArgs] = None,
            uhost_family: Optional[str] = None,
            uk8s_node_group_id: Optional[str] = None,
            update_time: Optional[str] = None,
            user_data: Optional[str] = None) -> Uk8sNodeGroup
    func GetUk8sNodeGroup(ctx *Context, name string, id IDInput, state *Uk8sNodeGroupState, opts ...ResourceOption) (*Uk8sNodeGroup, error)
    public static Uk8sNodeGroup Get(string name, Input<string> id, Uk8sNodeGroupState? state, CustomResourceOptions? opts = null)
    public static Uk8sNodeGroup get(String name, Output<String> id, Uk8sNodeGroupState state, CustomResourceOptions options)
    resources:  _:    type: ucloud:Uk8sNodeGroup    get:      id: ${id}
    import {
      to = ucloud_uk8s_node_group.example
      id = "${id}"
    }
    
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AvailabilityZone string
    The availability zone used by the node group template.
    BootDiskSize double
    The boot disk size in GB. Default is 40.
    BootDiskType string
    The boot disk type, including cloud_rssd. Default is cloud_ssd. Set cloud_rssd when using uhost_family = "o1i" or "o2i".
    ChargeType string
    The charge type. Valid values are year, month, and dynamic. Default is month.
    ClusterId string
    The ID of the UK8S cluster.
    CreateTime string
    The node group creation time in RFC3339 format.
    DataDiskSize double
    The data disk size in GB. Default is 0.
    DataDiskType string
    The data disk type, including cloud_rssd. Default is cloud_ssd. Set a positive data_disk_size to create a data disk.
    ImageId string
    The image ID used by new nodes.
    InitScript string
    A script run after the node initializes.
    InstanceType string
    The worker instance type, such as o-basic-2.
    IsolationGroup string
    The isolation group ID.
    Labels Dictionary<string, string>
    A map of Kubernetes labels for nodes added from this node group. At most 20 labels are supported.
    MaxPods double
    The maximum number of pods per node. Default is 110.
    MinCpuPlatform string
    The minimum CPU platform. Default is Intel/Auto.
    Name string
    The name of the node group.
    NodeIds List<string>
    IDs of nodes currently associated with the node group.
    SubnetId string
    The subnet ID used by the node group template.
    Tag string
    The business tag.
    Taints List<Uk8sNodeGroupTaint>
    One or more taints for nodes added from this node group. At most 10 taints are supported. Each block accepts key, value, and an effect of NoSchedule, PreferNoSchedule, or NoExecute.
    Timeouts Uk8sNodeGroupTimeouts
    UhostFamily string
    The Intel outstanding instance family: o1i or o2i. Use instance_type = "o-basic-2", uhost_family = "o2i", and boot_disk_type = "cloud_rssd" for O2 Intel nodes. For an RSSD data disk, also set data_disk_type = "cloud_rssd" and a positive data_disk_size. Requires an Intel CPU platform. When omitted, the family is read from UK8S. Updates change the template for future nodes without replacing existing nodes.
    Uk8sNodeGroupId string
    UpdateTime string
    The last node group update time in RFC3339 format.
    UserData string
    User data run while the instance initializes.
    AvailabilityZone string
    The availability zone used by the node group template.
    BootDiskSize float64
    The boot disk size in GB. Default is 40.
    BootDiskType string
    The boot disk type, including cloud_rssd. Default is cloud_ssd. Set cloud_rssd when using uhost_family = "o1i" or "o2i".
    ChargeType string
    The charge type. Valid values are year, month, and dynamic. Default is month.
    ClusterId string
    The ID of the UK8S cluster.
    CreateTime string
    The node group creation time in RFC3339 format.
    DataDiskSize float64
    The data disk size in GB. Default is 0.
    DataDiskType string
    The data disk type, including cloud_rssd. Default is cloud_ssd. Set a positive data_disk_size to create a data disk.
    ImageId string
    The image ID used by new nodes.
    InitScript string
    A script run after the node initializes.
    InstanceType string
    The worker instance type, such as o-basic-2.
    IsolationGroup string
    The isolation group ID.
    Labels map[string]string
    A map of Kubernetes labels for nodes added from this node group. At most 20 labels are supported.
    MaxPods float64
    The maximum number of pods per node. Default is 110.
    MinCpuPlatform string
    The minimum CPU platform. Default is Intel/Auto.
    Name string
    The name of the node group.
    NodeIds []string
    IDs of nodes currently associated with the node group.
    SubnetId string
    The subnet ID used by the node group template.
    Tag string
    The business tag.
    Taints []Uk8sNodeGroupTaintArgs
    One or more taints for nodes added from this node group. At most 10 taints are supported. Each block accepts key, value, and an effect of NoSchedule, PreferNoSchedule, or NoExecute.
    Timeouts Uk8sNodeGroupTimeoutsArgs
    UhostFamily string
    The Intel outstanding instance family: o1i or o2i. Use instance_type = "o-basic-2", uhost_family = "o2i", and boot_disk_type = "cloud_rssd" for O2 Intel nodes. For an RSSD data disk, also set data_disk_type = "cloud_rssd" and a positive data_disk_size. Requires an Intel CPU platform. When omitted, the family is read from UK8S. Updates change the template for future nodes without replacing existing nodes.
    Uk8sNodeGroupId string
    UpdateTime string
    The last node group update time in RFC3339 format.
    UserData string
    User data run while the instance initializes.
    availability_zone string
    The availability zone used by the node group template.
    boot_disk_size number
    The boot disk size in GB. Default is 40.
    boot_disk_type string
    The boot disk type, including cloud_rssd. Default is cloud_ssd. Set cloud_rssd when using uhost_family = "o1i" or "o2i".
    charge_type string
    The charge type. Valid values are year, month, and dynamic. Default is month.
    cluster_id string
    The ID of the UK8S cluster.
    create_time string
    The node group creation time in RFC3339 format.
    data_disk_size number
    The data disk size in GB. Default is 0.
    data_disk_type string
    The data disk type, including cloud_rssd. Default is cloud_ssd. Set a positive data_disk_size to create a data disk.
    image_id string
    The image ID used by new nodes.
    init_script string
    A script run after the node initializes.
    instance_type string
    The worker instance type, such as o-basic-2.
    isolation_group string
    The isolation group ID.
    labels map(string)
    A map of Kubernetes labels for nodes added from this node group. At most 20 labels are supported.
    max_pods number
    The maximum number of pods per node. Default is 110.
    min_cpu_platform string
    The minimum CPU platform. Default is Intel/Auto.
    name string
    The name of the node group.
    node_ids list(string)
    IDs of nodes currently associated with the node group.
    subnet_id string
    The subnet ID used by the node group template.
    tag string
    The business tag.
    taints list(object)
    One or more taints for nodes added from this node group. At most 10 taints are supported. Each block accepts key, value, and an effect of NoSchedule, PreferNoSchedule, or NoExecute.
    timeouts object
    uhost_family string
    The Intel outstanding instance family: o1i or o2i. Use instance_type = "o-basic-2", uhost_family = "o2i", and boot_disk_type = "cloud_rssd" for O2 Intel nodes. For an RSSD data disk, also set data_disk_type = "cloud_rssd" and a positive data_disk_size. Requires an Intel CPU platform. When omitted, the family is read from UK8S. Updates change the template for future nodes without replacing existing nodes.
    uk8s_node_group_id string
    update_time string
    The last node group update time in RFC3339 format.
    user_data string
    User data run while the instance initializes.
    availabilityZone String
    The availability zone used by the node group template.
    bootDiskSize Double
    The boot disk size in GB. Default is 40.
    bootDiskType String
    The boot disk type, including cloud_rssd. Default is cloud_ssd. Set cloud_rssd when using uhost_family = "o1i" or "o2i".
    chargeType String
    The charge type. Valid values are year, month, and dynamic. Default is month.
    clusterId String
    The ID of the UK8S cluster.
    createTime String
    The node group creation time in RFC3339 format.
    dataDiskSize Double
    The data disk size in GB. Default is 0.
    dataDiskType String
    The data disk type, including cloud_rssd. Default is cloud_ssd. Set a positive data_disk_size to create a data disk.
    imageId String
    The image ID used by new nodes.
    initScript String
    A script run after the node initializes.
    instanceType String
    The worker instance type, such as o-basic-2.
    isolationGroup String
    The isolation group ID.
    labels Map<String,String>
    A map of Kubernetes labels for nodes added from this node group. At most 20 labels are supported.
    maxPods Double
    The maximum number of pods per node. Default is 110.
    minCpuPlatform String
    The minimum CPU platform. Default is Intel/Auto.
    name String
    The name of the node group.
    nodeIds List<String>
    IDs of nodes currently associated with the node group.
    subnetId String
    The subnet ID used by the node group template.
    tag String
    The business tag.
    taints List<Uk8sNodeGroupTaint>
    One or more taints for nodes added from this node group. At most 10 taints are supported. Each block accepts key, value, and an effect of NoSchedule, PreferNoSchedule, or NoExecute.
    timeouts Uk8sNodeGroupTimeouts
    uhostFamily String
    The Intel outstanding instance family: o1i or o2i. Use instance_type = "o-basic-2", uhost_family = "o2i", and boot_disk_type = "cloud_rssd" for O2 Intel nodes. For an RSSD data disk, also set data_disk_type = "cloud_rssd" and a positive data_disk_size. Requires an Intel CPU platform. When omitted, the family is read from UK8S. Updates change the template for future nodes without replacing existing nodes.
    uk8sNodeGroupId String
    updateTime String
    The last node group update time in RFC3339 format.
    userData String
    User data run while the instance initializes.
    availabilityZone string
    The availability zone used by the node group template.
    bootDiskSize number
    The boot disk size in GB. Default is 40.
    bootDiskType string
    The boot disk type, including cloud_rssd. Default is cloud_ssd. Set cloud_rssd when using uhost_family = "o1i" or "o2i".
    chargeType string
    The charge type. Valid values are year, month, and dynamic. Default is month.
    clusterId string
    The ID of the UK8S cluster.
    createTime string
    The node group creation time in RFC3339 format.
    dataDiskSize number
    The data disk size in GB. Default is 0.
    dataDiskType string
    The data disk type, including cloud_rssd. Default is cloud_ssd. Set a positive data_disk_size to create a data disk.
    imageId string
    The image ID used by new nodes.
    initScript string
    A script run after the node initializes.
    instanceType string
    The worker instance type, such as o-basic-2.
    isolationGroup string
    The isolation group ID.
    labels {[key: string]: string}
    A map of Kubernetes labels for nodes added from this node group. At most 20 labels are supported.
    maxPods number
    The maximum number of pods per node. Default is 110.
    minCpuPlatform string
    The minimum CPU platform. Default is Intel/Auto.
    name string
    The name of the node group.
    nodeIds string[]
    IDs of nodes currently associated with the node group.
    subnetId string
    The subnet ID used by the node group template.
    tag string
    The business tag.
    taints Uk8sNodeGroupTaint[]
    One or more taints for nodes added from this node group. At most 10 taints are supported. Each block accepts key, value, and an effect of NoSchedule, PreferNoSchedule, or NoExecute.
    timeouts Uk8sNodeGroupTimeouts
    uhostFamily string
    The Intel outstanding instance family: o1i or o2i. Use instance_type = "o-basic-2", uhost_family = "o2i", and boot_disk_type = "cloud_rssd" for O2 Intel nodes. For an RSSD data disk, also set data_disk_type = "cloud_rssd" and a positive data_disk_size. Requires an Intel CPU platform. When omitted, the family is read from UK8S. Updates change the template for future nodes without replacing existing nodes.
    uk8sNodeGroupId string
    updateTime string
    The last node group update time in RFC3339 format.
    userData string
    User data run while the instance initializes.
    availability_zone str
    The availability zone used by the node group template.
    boot_disk_size float
    The boot disk size in GB. Default is 40.
    boot_disk_type str
    The boot disk type, including cloud_rssd. Default is cloud_ssd. Set cloud_rssd when using uhost_family = "o1i" or "o2i".
    charge_type str
    The charge type. Valid values are year, month, and dynamic. Default is month.
    cluster_id str
    The ID of the UK8S cluster.
    create_time str
    The node group creation time in RFC3339 format.
    data_disk_size float
    The data disk size in GB. Default is 0.
    data_disk_type str
    The data disk type, including cloud_rssd. Default is cloud_ssd. Set a positive data_disk_size to create a data disk.
    image_id str
    The image ID used by new nodes.
    init_script str
    A script run after the node initializes.
    instance_type str
    The worker instance type, such as o-basic-2.
    isolation_group str
    The isolation group ID.
    labels Mapping[str, str]
    A map of Kubernetes labels for nodes added from this node group. At most 20 labels are supported.
    max_pods float
    The maximum number of pods per node. Default is 110.
    min_cpu_platform str
    The minimum CPU platform. Default is Intel/Auto.
    name str
    The name of the node group.
    node_ids Sequence[str]
    IDs of nodes currently associated with the node group.
    subnet_id str
    The subnet ID used by the node group template.
    tag str
    The business tag.
    taints Sequence[Uk8sNodeGroupTaintArgs]
    One or more taints for nodes added from this node group. At most 10 taints are supported. Each block accepts key, value, and an effect of NoSchedule, PreferNoSchedule, or NoExecute.
    timeouts Uk8sNodeGroupTimeoutsArgs
    uhost_family str
    The Intel outstanding instance family: o1i or o2i. Use instance_type = "o-basic-2", uhost_family = "o2i", and boot_disk_type = "cloud_rssd" for O2 Intel nodes. For an RSSD data disk, also set data_disk_type = "cloud_rssd" and a positive data_disk_size. Requires an Intel CPU platform. When omitted, the family is read from UK8S. Updates change the template for future nodes without replacing existing nodes.
    uk8s_node_group_id str
    update_time str
    The last node group update time in RFC3339 format.
    user_data str
    User data run while the instance initializes.
    availabilityZone String
    The availability zone used by the node group template.
    bootDiskSize Number
    The boot disk size in GB. Default is 40.
    bootDiskType String
    The boot disk type, including cloud_rssd. Default is cloud_ssd. Set cloud_rssd when using uhost_family = "o1i" or "o2i".
    chargeType String
    The charge type. Valid values are year, month, and dynamic. Default is month.
    clusterId String
    The ID of the UK8S cluster.
    createTime String
    The node group creation time in RFC3339 format.
    dataDiskSize Number
    The data disk size in GB. Default is 0.
    dataDiskType String
    The data disk type, including cloud_rssd. Default is cloud_ssd. Set a positive data_disk_size to create a data disk.
    imageId String
    The image ID used by new nodes.
    initScript String
    A script run after the node initializes.
    instanceType String
    The worker instance type, such as o-basic-2.
    isolationGroup String
    The isolation group ID.
    labels Map<String>
    A map of Kubernetes labels for nodes added from this node group. At most 20 labels are supported.
    maxPods Number
    The maximum number of pods per node. Default is 110.
    minCpuPlatform String
    The minimum CPU platform. Default is Intel/Auto.
    name String
    The name of the node group.
    nodeIds List<String>
    IDs of nodes currently associated with the node group.
    subnetId String
    The subnet ID used by the node group template.
    tag String
    The business tag.
    taints List<Property Map>
    One or more taints for nodes added from this node group. At most 10 taints are supported. Each block accepts key, value, and an effect of NoSchedule, PreferNoSchedule, or NoExecute.
    timeouts Property Map
    uhostFamily String
    The Intel outstanding instance family: o1i or o2i. Use instance_type = "o-basic-2", uhost_family = "o2i", and boot_disk_type = "cloud_rssd" for O2 Intel nodes. For an RSSD data disk, also set data_disk_type = "cloud_rssd" and a positive data_disk_size. Requires an Intel CPU platform. When omitted, the family is read from UK8S. Updates change the template for future nodes without replacing existing nodes.
    uk8sNodeGroupId String
    updateTime String
    The last node group update time in RFC3339 format.
    userData String
    User data run while the instance initializes.

    Supporting Types

    Uk8sNodeGroupTaint, Uk8sNodeGroupTaintArgs

    Effect string
    Key string
    Value string
    Effect string
    Key string
    Value string
    effect string
    key string
    value string
    effect String
    key String
    value String
    effect string
    key string
    value string
    effect str
    key str
    value str
    effect String
    key String
    value String

    Uk8sNodeGroupTimeouts, Uk8sNodeGroupTimeoutsArgs

    Create string
    Delete string
    Update string
    Create string
    Delete string
    Update string
    create string
    delete string
    update string
    create String
    delete String
    update String
    create string
    delete string
    update string
    create str
    delete str
    update str
    create String
    delete String
    update String

    Package Details

    Repository
    ucloud ucloud/terraform-provider-ucloud
    License
    Notes
    This Pulumi package is based on the ucloud Terraform Provider.
    Viewing docs for ucloud 1.45.0
    published on Thursday, Sep 24, 2026 by ucloud

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial