Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Ibm Provider
  3. API Docs
  4. ContainerVpcWorkerPool
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

ibm.ContainerVpcWorkerPool

Explore with Pulumi AI

ibm logo
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

    Create or delete a worker pool. The worker pool will be attached to the specified cluster. For more information, about VPC worker pool, see creating clusters.

    Example Usage

    In the following example, you can create a worker pool for a vpc cluster:

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

const testPool = new ibm.ContainerVpcWorkerPool("testPool", {
    cluster: "my_vpc_cluster",
    flavor: "c2.2x4",
    vpcId: "6015365a-9d93-4bb4-8248-79ae0db2dc21",
    workerCount: 1,
    workerPoolName: "my_vpc_pool",
    zones: [{
        name: "us-south-1",
        subnetId: "015ffb8b-efb1-4c03-8757-29335a07493b",
    }],
});

    import pulumi
import pulumi_ibm as ibm

test_pool = ibm.ContainerVpcWorkerPool("testPool",
    cluster="my_vpc_cluster",
    flavor="c2.2x4",
    vpc_id="6015365a-9d93-4bb4-8248-79ae0db2dc21",
    worker_count=1,
    worker_pool_name="my_vpc_pool",
    zones=[{
        "name": "us-south-1",
        "subnet_id": "015ffb8b-efb1-4c03-8757-29335a07493b",
    }])

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ibm.NewContainerVpcWorkerPool(ctx, "testPool", &ibm.ContainerVpcWorkerPoolArgs{
			Cluster:        pulumi.String("my_vpc_cluster"),
			Flavor:         pulumi.String("c2.2x4"),
			VpcId:          pulumi.String("6015365a-9d93-4bb4-8248-79ae0db2dc21"),
			WorkerCount:    pulumi.Float64(1),
			WorkerPoolName: pulumi.String("my_vpc_pool"),
			Zones: ibm.ContainerVpcWorkerPoolZoneArray{
				&ibm.ContainerVpcWorkerPoolZoneArgs{
					Name:     pulumi.String("us-south-1"),
					SubnetId: pulumi.String("015ffb8b-efb1-4c03-8757-29335a07493b"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var testPool = new Ibm.ContainerVpcWorkerPool("testPool", new()
    {
        Cluster = "my_vpc_cluster",
        Flavor = "c2.2x4",
        VpcId = "6015365a-9d93-4bb4-8248-79ae0db2dc21",
        WorkerCount = 1,
        WorkerPoolName = "my_vpc_pool",
        Zones = new[]
        {
            new Ibm.Inputs.ContainerVpcWorkerPoolZoneArgs
            {
                Name = "us-south-1",
                SubnetId = "015ffb8b-efb1-4c03-8757-29335a07493b",
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.ContainerVpcWorkerPool;
import com.pulumi.ibm.ContainerVpcWorkerPoolArgs;
import com.pulumi.ibm.inputs.ContainerVpcWorkerPoolZoneArgs;
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) {
        var testPool = new ContainerVpcWorkerPool("testPool", ContainerVpcWorkerPoolArgs.builder()
            .cluster("my_vpc_cluster")
            .flavor("c2.2x4")
            .vpcId("6015365a-9d93-4bb4-8248-79ae0db2dc21")
            .workerCount("1")
            .workerPoolName("my_vpc_pool")
            .zones(ContainerVpcWorkerPoolZoneArgs.builder()
                .name("us-south-1")
                .subnetId("015ffb8b-efb1-4c03-8757-29335a07493b")
                .build())
            .build());

    }
}

    resources:
  testPool:
    type: ibm:ContainerVpcWorkerPool
    properties:
      cluster: my_vpc_cluster
      flavor: c2.2x4
      vpcId: 6015365a-9d93-4bb4-8248-79ae0db2dc21
      workerCount: '1'
      workerPoolName: my_vpc_pool
      zones:
        - name: us-south-1
          subnetId: 015ffb8b-efb1-4c03-8757-29335a07493b

    In the following example, you can create a worker pool for a vpc cluster with boot volume encryption enabled:

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

const testPool = new ibm.ContainerVpcWorkerPool("testPool", {
    cluster: "my_vpc_cluster",
    crk: "804cb251-fa0a-46f5-a442-fe42cfb0ed5f",
    flavor: "c2.2x4",
    kmsInstanceId: "8e9056e6-1936-4dd9-a0a1-51d824765e11",
    vpcId: "6015365a-9d93-4bb4-8248-79ae0db2dc21",
    workerCount: 1,
    workerPoolName: "my_vpc_pool",
    zones: [{
        name: "us-south-1",
        subnetId: "015ffb8b-efb1-4c03-8757-29335a07493b",
    }],
});

    import pulumi
import pulumi_ibm as ibm

test_pool = ibm.ContainerVpcWorkerPool("testPool",
    cluster="my_vpc_cluster",
    crk="804cb251-fa0a-46f5-a442-fe42cfb0ed5f",
    flavor="c2.2x4",
    kms_instance_id="8e9056e6-1936-4dd9-a0a1-51d824765e11",
    vpc_id="6015365a-9d93-4bb4-8248-79ae0db2dc21",
    worker_count=1,
    worker_pool_name="my_vpc_pool",
    zones=[{
        "name": "us-south-1",
        "subnet_id": "015ffb8b-efb1-4c03-8757-29335a07493b",
    }])

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ibm.NewContainerVpcWorkerPool(ctx, "testPool", &ibm.ContainerVpcWorkerPoolArgs{
			Cluster:        pulumi.String("my_vpc_cluster"),
			Crk:            pulumi.String("804cb251-fa0a-46f5-a442-fe42cfb0ed5f"),
			Flavor:         pulumi.String("c2.2x4"),
			KmsInstanceId:  pulumi.String("8e9056e6-1936-4dd9-a0a1-51d824765e11"),
			VpcId:          pulumi.String("6015365a-9d93-4bb4-8248-79ae0db2dc21"),
			WorkerCount:    pulumi.Float64(1),
			WorkerPoolName: pulumi.String("my_vpc_pool"),
			Zones: ibm.ContainerVpcWorkerPoolZoneArray{
				&ibm.ContainerVpcWorkerPoolZoneArgs{
					Name:     pulumi.String("us-south-1"),
					SubnetId: pulumi.String("015ffb8b-efb1-4c03-8757-29335a07493b"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var testPool = new Ibm.ContainerVpcWorkerPool("testPool", new()
    {
        Cluster = "my_vpc_cluster",
        Crk = "804cb251-fa0a-46f5-a442-fe42cfb0ed5f",
        Flavor = "c2.2x4",
        KmsInstanceId = "8e9056e6-1936-4dd9-a0a1-51d824765e11",
        VpcId = "6015365a-9d93-4bb4-8248-79ae0db2dc21",
        WorkerCount = 1,
        WorkerPoolName = "my_vpc_pool",
        Zones = new[]
        {
            new Ibm.Inputs.ContainerVpcWorkerPoolZoneArgs
            {
                Name = "us-south-1",
                SubnetId = "015ffb8b-efb1-4c03-8757-29335a07493b",
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.ContainerVpcWorkerPool;
import com.pulumi.ibm.ContainerVpcWorkerPoolArgs;
import com.pulumi.ibm.inputs.ContainerVpcWorkerPoolZoneArgs;
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) {
        var testPool = new ContainerVpcWorkerPool("testPool", ContainerVpcWorkerPoolArgs.builder()
            .cluster("my_vpc_cluster")
            .crk("804cb251-fa0a-46f5-a442-fe42cfb0ed5f")
            .flavor("c2.2x4")
            .kmsInstanceId("8e9056e6-1936-4dd9-a0a1-51d824765e11")
            .vpcId("6015365a-9d93-4bb4-8248-79ae0db2dc21")
            .workerCount("1")
            .workerPoolName("my_vpc_pool")
            .zones(ContainerVpcWorkerPoolZoneArgs.builder()
                .name("us-south-1")
                .subnetId("015ffb8b-efb1-4c03-8757-29335a07493b")
                .build())
            .build());

    }
}

    resources:
  testPool:
    type: ibm:ContainerVpcWorkerPool
    properties:
      cluster: my_vpc_cluster
      crk: 804cb251-fa0a-46f5-a442-fe42cfb0ed5f
      flavor: c2.2x4
      kmsInstanceId: 8e9056e6-1936-4dd9-a0a1-51d824765e11
      vpcId: 6015365a-9d93-4bb4-8248-79ae0db2dc21
      workerCount: '1'
      workerPoolName: my_vpc_pool
      zones:
        - name: us-south-1
          subnetId: 015ffb8b-efb1-4c03-8757-29335a07493b

    In the follwoing example, you can create a worker pool for openshift cluster type with entitlement.

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

const testPool = new ibm.ContainerVpcWorkerPool("testPool", {
    cluster: "my_openshift_cluster",
    entitlement: "cloud_pak",
    flavor: "b3c.4x16",
    vpcId: "6015365a-9d93-4bb4-8248-79ae0db2dc21",
    workerCount: 1,
    workerPoolName: "my_openshift_vpc_pool",
    zones: [{
        name: "us-south-1",
        subnetId: "015ffb8b-efb1-4c03-8757-29335a07493b",
    }],
});

    import pulumi
import pulumi_ibm as ibm

test_pool = ibm.ContainerVpcWorkerPool("testPool",
    cluster="my_openshift_cluster",
    entitlement="cloud_pak",
    flavor="b3c.4x16",
    vpc_id="6015365a-9d93-4bb4-8248-79ae0db2dc21",
    worker_count=1,
    worker_pool_name="my_openshift_vpc_pool",
    zones=[{
        "name": "us-south-1",
        "subnet_id": "015ffb8b-efb1-4c03-8757-29335a07493b",
    }])

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ibm.NewContainerVpcWorkerPool(ctx, "testPool", &ibm.ContainerVpcWorkerPoolArgs{
			Cluster:        pulumi.String("my_openshift_cluster"),
			Entitlement:    pulumi.String("cloud_pak"),
			Flavor:         pulumi.String("b3c.4x16"),
			VpcId:          pulumi.String("6015365a-9d93-4bb4-8248-79ae0db2dc21"),
			WorkerCount:    pulumi.Float64(1),
			WorkerPoolName: pulumi.String("my_openshift_vpc_pool"),
			Zones: ibm.ContainerVpcWorkerPoolZoneArray{
				&ibm.ContainerVpcWorkerPoolZoneArgs{
					Name:     pulumi.String("us-south-1"),
					SubnetId: pulumi.String("015ffb8b-efb1-4c03-8757-29335a07493b"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var testPool = new Ibm.ContainerVpcWorkerPool("testPool", new()
    {
        Cluster = "my_openshift_cluster",
        Entitlement = "cloud_pak",
        Flavor = "b3c.4x16",
        VpcId = "6015365a-9d93-4bb4-8248-79ae0db2dc21",
        WorkerCount = 1,
        WorkerPoolName = "my_openshift_vpc_pool",
        Zones = new[]
        {
            new Ibm.Inputs.ContainerVpcWorkerPoolZoneArgs
            {
                Name = "us-south-1",
                SubnetId = "015ffb8b-efb1-4c03-8757-29335a07493b",
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.ContainerVpcWorkerPool;
import com.pulumi.ibm.ContainerVpcWorkerPoolArgs;
import com.pulumi.ibm.inputs.ContainerVpcWorkerPoolZoneArgs;
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) {
        var testPool = new ContainerVpcWorkerPool("testPool", ContainerVpcWorkerPoolArgs.builder()
            .cluster("my_openshift_cluster")
            .entitlement("cloud_pak")
            .flavor("b3c.4x16")
            .vpcId("6015365a-9d93-4bb4-8248-79ae0db2dc21")
            .workerCount("1")
            .workerPoolName("my_openshift_vpc_pool")
            .zones(ContainerVpcWorkerPoolZoneArgs.builder()
                .name("us-south-1")
                .subnetId("015ffb8b-efb1-4c03-8757-29335a07493b")
                .build())
            .build());

    }
}

    resources:
  testPool:
    type: ibm:ContainerVpcWorkerPool
    properties:
      cluster: my_openshift_cluster
      entitlement: cloud_pak
      flavor: b3c.4x16
      vpcId: 6015365a-9d93-4bb4-8248-79ae0db2dc21
      workerCount: '1'
      workerPoolName: my_openshift_vpc_pool
      zones:
        - name: us-south-1
          subnetId: 015ffb8b-efb1-4c03-8757-29335a07493b

    Create ContainerVpcWorkerPool Resource

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

    Constructor syntax

    new ContainerVpcWorkerPool(name: string, args: ContainerVpcWorkerPoolArgs, opts?: CustomResourceOptions);
    @overload
def ContainerVpcWorkerPool(resource_name: str,
                           args: ContainerVpcWorkerPoolArgs,
                           opts: Optional[ResourceOptions] = None)

@overload
def ContainerVpcWorkerPool(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           cluster: Optional[str] = None,
                           zones: Optional[Sequence[ContainerVpcWorkerPoolZoneArgs]] = None,
                           worker_pool_name: Optional[str] = None,
                           worker_count: Optional[float] = None,
                           flavor: Optional[str] = None,
                           vpc_id: Optional[str] = None,
                           operating_system: Optional[str] = None,
                           secondary_storage: Optional[str] = None,
                           kms_instance_id: Optional[str] = None,
                           labels: Optional[Mapping[str, str]] = None,
                           import_on_create: Optional[bool] = None,
                           orphan_on_delete: Optional[bool] = None,
                           resource_group_id: Optional[str] = None,
                           kms_account_id: Optional[str] = None,
                           security_groups: Optional[Sequence[str]] = None,
                           taints: Optional[Sequence[ContainerVpcWorkerPoolTaintArgs]] = None,
                           timeouts: Optional[ContainerVpcWorkerPoolTimeoutsArgs] = None,
                           host_pool_id: Optional[str] = None,
                           entitlement: Optional[str] = None,
                           crk: Optional[str] = None,
                           container_vpc_worker_pool_id: Optional[str] = None)
    func NewContainerVpcWorkerPool(ctx *Context, name string, args ContainerVpcWorkerPoolArgs, opts ...ResourceOption) (*ContainerVpcWorkerPool, error)
    public ContainerVpcWorkerPool(string name, ContainerVpcWorkerPoolArgs args, CustomResourceOptions? opts = null)
    public ContainerVpcWorkerPool(String name, ContainerVpcWorkerPoolArgs args)
public ContainerVpcWorkerPool(String name, ContainerVpcWorkerPoolArgs args, CustomResourceOptions options)

    type: ibm:ContainerVpcWorkerPool
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args ContainerVpcWorkerPoolArgs
    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 ContainerVpcWorkerPoolArgs
    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 ContainerVpcWorkerPoolArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ContainerVpcWorkerPoolArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ContainerVpcWorkerPoolArgs
    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 containerVpcWorkerPoolResource = new Ibm.ContainerVpcWorkerPool("containerVpcWorkerPoolResource", new()
{
    Cluster = "string",
    Zones = new[]
    {
        new Ibm.Inputs.ContainerVpcWorkerPoolZoneArgs
        {
            Name = "string",
            SubnetId = "string",
        },
    },
    WorkerPoolName = "string",
    WorkerCount = 0,
    Flavor = "string",
    VpcId = "string",
    OperatingSystem = "string",
    SecondaryStorage = "string",
    KmsInstanceId = "string",
    Labels = 
    {
        { "string", "string" },
    },
    ImportOnCreate = false,
    OrphanOnDelete = false,
    ResourceGroupId = "string",
    KmsAccountId = "string",
    SecurityGroups = new[]
    {
        "string",
    },
    Taints = new[]
    {
        new Ibm.Inputs.ContainerVpcWorkerPoolTaintArgs
        {
            Effect = "string",
            Key = "string",
            Value = "string",
        },
    },
    Timeouts = new Ibm.Inputs.ContainerVpcWorkerPoolTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
    },
    HostPoolId = "string",
    Entitlement = "string",
    Crk = "string",
    ContainerVpcWorkerPoolId = "string",
});

    example, err := ibm.NewContainerVpcWorkerPool(ctx, "containerVpcWorkerPoolResource", &ibm.ContainerVpcWorkerPoolArgs{
	Cluster: pulumi.String("string"),
	Zones: ibm.ContainerVpcWorkerPoolZoneArray{
		&ibm.ContainerVpcWorkerPoolZoneArgs{
			Name:     pulumi.String("string"),
			SubnetId: pulumi.String("string"),
		},
	},
	WorkerPoolName:   pulumi.String("string"),
	WorkerCount:      pulumi.Float64(0),
	Flavor:           pulumi.String("string"),
	VpcId:            pulumi.String("string"),
	OperatingSystem:  pulumi.String("string"),
	SecondaryStorage: pulumi.String("string"),
	KmsInstanceId:    pulumi.String("string"),
	Labels: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	ImportOnCreate:  pulumi.Bool(false),
	OrphanOnDelete:  pulumi.Bool(false),
	ResourceGroupId: pulumi.String("string"),
	KmsAccountId:    pulumi.String("string"),
	SecurityGroups: pulumi.StringArray{
		pulumi.String("string"),
	},
	Taints: ibm.ContainerVpcWorkerPoolTaintArray{
		&ibm.ContainerVpcWorkerPoolTaintArgs{
			Effect: pulumi.String("string"),
			Key:    pulumi.String("string"),
			Value:  pulumi.String("string"),
		},
	},
	Timeouts: &ibm.ContainerVpcWorkerPoolTimeoutsArgs{
		Create: pulumi.String("string"),
		Delete: pulumi.String("string"),
	},
	HostPoolId:               pulumi.String("string"),
	Entitlement:              pulumi.String("string"),
	Crk:                      pulumi.String("string"),
	ContainerVpcWorkerPoolId: pulumi.String("string"),
})

    var containerVpcWorkerPoolResource = new ContainerVpcWorkerPool("containerVpcWorkerPoolResource", ContainerVpcWorkerPoolArgs.builder()
    .cluster("string")
    .zones(ContainerVpcWorkerPoolZoneArgs.builder()
        .name("string")
        .subnetId("string")
        .build())
    .workerPoolName("string")
    .workerCount(0)
    .flavor("string")
    .vpcId("string")
    .operatingSystem("string")
    .secondaryStorage("string")
    .kmsInstanceId("string")
    .labels(Map.of("string", "string"))
    .importOnCreate(false)
    .orphanOnDelete(false)
    .resourceGroupId("string")
    .kmsAccountId("string")
    .securityGroups("string")
    .taints(ContainerVpcWorkerPoolTaintArgs.builder()
        .effect("string")
        .key("string")
        .value("string")
        .build())
    .timeouts(ContainerVpcWorkerPoolTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .build())
    .hostPoolId("string")
    .entitlement("string")
    .crk("string")
    .containerVpcWorkerPoolId("string")
    .build());

    container_vpc_worker_pool_resource = ibm.ContainerVpcWorkerPool("containerVpcWorkerPoolResource",
    cluster="string",
    zones=[{
        "name": "string",
        "subnet_id": "string",
    }],
    worker_pool_name="string",
    worker_count=0,
    flavor="string",
    vpc_id="string",
    operating_system="string",
    secondary_storage="string",
    kms_instance_id="string",
    labels={
        "string": "string",
    },
    import_on_create=False,
    orphan_on_delete=False,
    resource_group_id="string",
    kms_account_id="string",
    security_groups=["string"],
    taints=[{
        "effect": "string",
        "key": "string",
        "value": "string",
    }],
    timeouts={
        "create": "string",
        "delete": "string",
    },
    host_pool_id="string",
    entitlement="string",
    crk="string",
    container_vpc_worker_pool_id="string")

    const containerVpcWorkerPoolResource = new ibm.ContainerVpcWorkerPool("containerVpcWorkerPoolResource", {
    cluster: "string",
    zones: [{
        name: "string",
        subnetId: "string",
    }],
    workerPoolName: "string",
    workerCount: 0,
    flavor: "string",
    vpcId: "string",
    operatingSystem: "string",
    secondaryStorage: "string",
    kmsInstanceId: "string",
    labels: {
        string: "string",
    },
    importOnCreate: false,
    orphanOnDelete: false,
    resourceGroupId: "string",
    kmsAccountId: "string",
    securityGroups: ["string"],
    taints: [{
        effect: "string",
        key: "string",
        value: "string",
    }],
    timeouts: {
        create: "string",
        "delete": "string",
    },
    hostPoolId: "string",
    entitlement: "string",
    crk: "string",
    containerVpcWorkerPoolId: "string",
});

    type: ibm:ContainerVpcWorkerPool
properties:
    cluster: string
    containerVpcWorkerPoolId: string
    crk: string
    entitlement: string
    flavor: string
    hostPoolId: string
    importOnCreate: false
    kmsAccountId: string
    kmsInstanceId: string
    labels:
        string: string
    operatingSystem: string
    orphanOnDelete: false
    resourceGroupId: string
    secondaryStorage: string
    securityGroups:
        - string
    taints:
        - effect: string
          key: string
          value: string
    timeouts:
        create: string
        delete: string
    vpcId: string
    workerCount: 0
    workerPoolName: string
    zones:
        - name: string
          subnetId: string

    ContainerVpcWorkerPool 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 ContainerVpcWorkerPool resource accepts the following input properties:

    Cluster string
    The name or ID of the cluster.
    Flavor string
    The flavor of the worker node.
    VpcId string
    The ID of the VPC.
    WorkerCount double
    The number of worker nodes per zone in the worker pool.
    WorkerPoolName string
    The name of the worker pool.
    Zones List<ContainerVpcWorkerPoolZone>

    A nested block describes the zones of this worker pool.

    Nested scheme for zones:

    ContainerVpcWorkerPoolId string
    (String) The unique identifier of the worker pool. The ID is composed of <cluster_name_id>/<worker_pool_id>.
    Crk string
    Root Key ID for boot volume encryption.
    Entitlement string
    The OpenShift cluster entitlement avoids incurred OCP license charges and use cloud pak with OCP license entitlement to add the OpenShift cluster worker pool. Note It is set as one time creation of the worker pool. There is no impacts on any modification. Set the argument to entitlement only when you use cluster with a cloud pak that has an OpenShift entitlement.
    HostPoolId string
    The ID of the dedicated host pool the worker pool is associated with.
    ImportOnCreate bool
    Import an existing WorkerPool from the cluster, instead of creating a new.
    KmsAccountId string
    Account ID for boot volume encryption, if other account is providing the kms.
    KmsInstanceId string
    Instance ID for boot volume encryption.
    Labels Dictionary<string, string>
    A list of labels that you want to add to all the worker nodes in the worker pool.
    OperatingSystem string
    The operating system of the workers in the worker pool.
    OrphanOnDelete bool
    Orphan the Worker Pool resource, instead of deleting it. The argument allows the user to remove the worker pool from the state, without deleting the actual cloud resource. The worker pool can be re-imported into the state using the import_on_create argument.
    ResourceGroupId string
    The ID of the resource group. To retrieve the ID, run ibmcloud resource groups or use the ibm.ResourceGroup data source. If no value is provided, the default resource group is used.
    SecondaryStorage string
    The secondary storage option for the workers in the worker pool.
    SecurityGroups List<string>
    Enables users to define specific security groups for their workers.
    Taints List<ContainerVpcWorkerPoolTaint>

    A nested block that sets or removes Kubernetes taints for all worker nodes in a worker pool

    Nested scheme for taints:

    Timeouts ContainerVpcWorkerPoolTimeouts
    Cluster string
    The name or ID of the cluster.
    Flavor string
    The flavor of the worker node.
    VpcId string
    The ID of the VPC.
    WorkerCount float64
    The number of worker nodes per zone in the worker pool.
    WorkerPoolName string
    The name of the worker pool.
    Zones []ContainerVpcWorkerPoolZoneArgs

    A nested block describes the zones of this worker pool.

    Nested scheme for zones:

    ContainerVpcWorkerPoolId string
    (String) The unique identifier of the worker pool. The ID is composed of <cluster_name_id>/<worker_pool_id>.
    Crk string
    Root Key ID for boot volume encryption.
    Entitlement string
    The OpenShift cluster entitlement avoids incurred OCP license charges and use cloud pak with OCP license entitlement to add the OpenShift cluster worker pool. Note It is set as one time creation of the worker pool. There is no impacts on any modification. Set the argument to entitlement only when you use cluster with a cloud pak that has an OpenShift entitlement.
    HostPoolId string
    The ID of the dedicated host pool the worker pool is associated with.
    ImportOnCreate bool
    Import an existing WorkerPool from the cluster, instead of creating a new.
    KmsAccountId string
    Account ID for boot volume encryption, if other account is providing the kms.
    KmsInstanceId string
    Instance ID for boot volume encryption.
    Labels map[string]string
    A list of labels that you want to add to all the worker nodes in the worker pool.
    OperatingSystem string
    The operating system of the workers in the worker pool.
    OrphanOnDelete bool
    Orphan the Worker Pool resource, instead of deleting it. The argument allows the user to remove the worker pool from the state, without deleting the actual cloud resource. The worker pool can be re-imported into the state using the import_on_create argument.
    ResourceGroupId string
    The ID of the resource group. To retrieve the ID, run ibmcloud resource groups or use the ibm.ResourceGroup data source. If no value is provided, the default resource group is used.
    SecondaryStorage string
    The secondary storage option for the workers in the worker pool.
    SecurityGroups []string
    Enables users to define specific security groups for their workers.
    Taints []ContainerVpcWorkerPoolTaintArgs

    A nested block that sets or removes Kubernetes taints for all worker nodes in a worker pool

    Nested scheme for taints:

    Timeouts ContainerVpcWorkerPoolTimeoutsArgs
    cluster String
    The name or ID of the cluster.
    flavor String
    The flavor of the worker node.
    vpcId String
    The ID of the VPC.
    workerCount Double
    The number of worker nodes per zone in the worker pool.
    workerPoolName String
    The name of the worker pool.
    zones List<ContainerVpcWorkerPoolZone>

    A nested block describes the zones of this worker pool.

    Nested scheme for zones:

    containerVpcWorkerPoolId String
    (String) The unique identifier of the worker pool. The ID is composed of <cluster_name_id>/<worker_pool_id>.
    crk String
    Root Key ID for boot volume encryption.
    entitlement String
    The OpenShift cluster entitlement avoids incurred OCP license charges and use cloud pak with OCP license entitlement to add the OpenShift cluster worker pool. Note It is set as one time creation of the worker pool. There is no impacts on any modification. Set the argument to entitlement only when you use cluster with a cloud pak that has an OpenShift entitlement.
    hostPoolId String
    The ID of the dedicated host pool the worker pool is associated with.
    importOnCreate Boolean
    Import an existing WorkerPool from the cluster, instead of creating a new.
    kmsAccountId String
    Account ID for boot volume encryption, if other account is providing the kms.
    kmsInstanceId String
    Instance ID for boot volume encryption.
    labels Map<String,String>
    A list of labels that you want to add to all the worker nodes in the worker pool.
    operatingSystem String
    The operating system of the workers in the worker pool.
    orphanOnDelete Boolean
    Orphan the Worker Pool resource, instead of deleting it. The argument allows the user to remove the worker pool from the state, without deleting the actual cloud resource. The worker pool can be re-imported into the state using the import_on_create argument.
    resourceGroupId String
    The ID of the resource group. To retrieve the ID, run ibmcloud resource groups or use the ibm.ResourceGroup data source. If no value is provided, the default resource group is used.
    secondaryStorage String
    The secondary storage option for the workers in the worker pool.
    securityGroups List<String>
    Enables users to define specific security groups for their workers.
    taints List<ContainerVpcWorkerPoolTaint>

    A nested block that sets or removes Kubernetes taints for all worker nodes in a worker pool

    Nested scheme for taints:

    timeouts ContainerVpcWorkerPoolTimeouts
    cluster string
    The name or ID of the cluster.
    flavor string
    The flavor of the worker node.
    vpcId string
    The ID of the VPC.
    workerCount number
    The number of worker nodes per zone in the worker pool.
    workerPoolName string
    The name of the worker pool.
    zones ContainerVpcWorkerPoolZone[]

    A nested block describes the zones of this worker pool.

    Nested scheme for zones:

    containerVpcWorkerPoolId string
    (String) The unique identifier of the worker pool. The ID is composed of <cluster_name_id>/<worker_pool_id>.
    crk string
    Root Key ID for boot volume encryption.
    entitlement string
    The OpenShift cluster entitlement avoids incurred OCP license charges and use cloud pak with OCP license entitlement to add the OpenShift cluster worker pool. Note It is set as one time creation of the worker pool. There is no impacts on any modification. Set the argument to entitlement only when you use cluster with a cloud pak that has an OpenShift entitlement.
    hostPoolId string
    The ID of the dedicated host pool the worker pool is associated with.
    importOnCreate boolean
    Import an existing WorkerPool from the cluster, instead of creating a new.
    kmsAccountId string
    Account ID for boot volume encryption, if other account is providing the kms.
    kmsInstanceId string
    Instance ID for boot volume encryption.
    labels {[key: string]: string}
    A list of labels that you want to add to all the worker nodes in the worker pool.
    operatingSystem string
    The operating system of the workers in the worker pool.
    orphanOnDelete boolean
    Orphan the Worker Pool resource, instead of deleting it. The argument allows the user to remove the worker pool from the state, without deleting the actual cloud resource. The worker pool can be re-imported into the state using the import_on_create argument.
    resourceGroupId string
    The ID of the resource group. To retrieve the ID, run ibmcloud resource groups or use the ibm.ResourceGroup data source. If no value is provided, the default resource group is used.
    secondaryStorage string
    The secondary storage option for the workers in the worker pool.
    securityGroups string[]
    Enables users to define specific security groups for their workers.
    taints ContainerVpcWorkerPoolTaint[]

    A nested block that sets or removes Kubernetes taints for all worker nodes in a worker pool

    Nested scheme for taints:

    timeouts ContainerVpcWorkerPoolTimeouts
    cluster str
    The name or ID of the cluster.
    flavor str
    The flavor of the worker node.
    vpc_id str
    The ID of the VPC.
    worker_count float
    The number of worker nodes per zone in the worker pool.
    worker_pool_name str
    The name of the worker pool.
    zones Sequence[ContainerVpcWorkerPoolZoneArgs]

    A nested block describes the zones of this worker pool.

    Nested scheme for zones:

    container_vpc_worker_pool_id str
    (String) The unique identifier of the worker pool. The ID is composed of <cluster_name_id>/<worker_pool_id>.
    crk str
    Root Key ID for boot volume encryption.
    entitlement str
    The OpenShift cluster entitlement avoids incurred OCP license charges and use cloud pak with OCP license entitlement to add the OpenShift cluster worker pool. Note It is set as one time creation of the worker pool. There is no impacts on any modification. Set the argument to entitlement only when you use cluster with a cloud pak that has an OpenShift entitlement.
    host_pool_id str
    The ID of the dedicated host pool the worker pool is associated with.
    import_on_create bool
    Import an existing WorkerPool from the cluster, instead of creating a new.
    kms_account_id str
    Account ID for boot volume encryption, if other account is providing the kms.
    kms_instance_id str
    Instance ID for boot volume encryption.
    labels Mapping[str, str]
    A list of labels that you want to add to all the worker nodes in the worker pool.
    operating_system str
    The operating system of the workers in the worker pool.
    orphan_on_delete bool
    Orphan the Worker Pool resource, instead of deleting it. The argument allows the user to remove the worker pool from the state, without deleting the actual cloud resource. The worker pool can be re-imported into the state using the import_on_create argument.
    resource_group_id str
    The ID of the resource group. To retrieve the ID, run ibmcloud resource groups or use the ibm.ResourceGroup data source. If no value is provided, the default resource group is used.
    secondary_storage str
    The secondary storage option for the workers in the worker pool.
    security_groups Sequence[str]
    Enables users to define specific security groups for their workers.
    taints Sequence[ContainerVpcWorkerPoolTaintArgs]

    A nested block that sets or removes Kubernetes taints for all worker nodes in a worker pool

    Nested scheme for taints:

    timeouts ContainerVpcWorkerPoolTimeoutsArgs
    cluster String
    The name or ID of the cluster.
    flavor String
    The flavor of the worker node.
    vpcId String
    The ID of the VPC.
    workerCount Number
    The number of worker nodes per zone in the worker pool.
    workerPoolName String
    The name of the worker pool.
    zones List<Property Map>

    A nested block describes the zones of this worker pool.

    Nested scheme for zones:

    containerVpcWorkerPoolId String
    (String) The unique identifier of the worker pool. The ID is composed of <cluster_name_id>/<worker_pool_id>.
    crk String
    Root Key ID for boot volume encryption.
    entitlement String
    The OpenShift cluster entitlement avoids incurred OCP license charges and use cloud pak with OCP license entitlement to add the OpenShift cluster worker pool. Note It is set as one time creation of the worker pool. There is no impacts on any modification. Set the argument to entitlement only when you use cluster with a cloud pak that has an OpenShift entitlement.
    hostPoolId String
    The ID of the dedicated host pool the worker pool is associated with.
    importOnCreate Boolean
    Import an existing WorkerPool from the cluster, instead of creating a new.
    kmsAccountId String
    Account ID for boot volume encryption, if other account is providing the kms.
    kmsInstanceId String
    Instance ID for boot volume encryption.
    labels Map<String>
    A list of labels that you want to add to all the worker nodes in the worker pool.
    operatingSystem String
    The operating system of the workers in the worker pool.
    orphanOnDelete Boolean
    Orphan the Worker Pool resource, instead of deleting it. The argument allows the user to remove the worker pool from the state, without deleting the actual cloud resource. The worker pool can be re-imported into the state using the import_on_create argument.
    resourceGroupId String
    The ID of the resource group. To retrieve the ID, run ibmcloud resource groups or use the ibm.ResourceGroup data source. If no value is provided, the default resource group is used.
    secondaryStorage String
    The secondary storage option for the workers in the worker pool.
    securityGroups List<String>
    Enables users to define specific security groups for their workers.
    taints List<Property Map>

    A nested block that sets or removes Kubernetes taints for all worker nodes in a worker pool

    Nested scheme for taints:

    timeouts Property Map

    Outputs

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

    AutoscaleEnabled bool
    (Bool) Autoscaling is enabled on the workerpool
    Id string
    The provider-assigned unique ID for this managed resource.
    ResourceControllerUrl string
    Resource Controller URL
    WorkerPoolId string
    (String) The unique identifier of the worker pool.
    AutoscaleEnabled bool
    (Bool) Autoscaling is enabled on the workerpool
    Id string
    The provider-assigned unique ID for this managed resource.
    ResourceControllerUrl string
    Resource Controller URL
    WorkerPoolId string
    (String) The unique identifier of the worker pool.
    autoscaleEnabled Boolean
    (Bool) Autoscaling is enabled on the workerpool
    id String
    The provider-assigned unique ID for this managed resource.
    resourceControllerUrl String
    Resource Controller URL
    workerPoolId String
    (String) The unique identifier of the worker pool.
    autoscaleEnabled boolean
    (Bool) Autoscaling is enabled on the workerpool
    id string
    The provider-assigned unique ID for this managed resource.
    resourceControllerUrl string
    Resource Controller URL
    workerPoolId string
    (String) The unique identifier of the worker pool.
    autoscale_enabled bool
    (Bool) Autoscaling is enabled on the workerpool
    id str
    The provider-assigned unique ID for this managed resource.
    resource_controller_url str
    Resource Controller URL
    worker_pool_id str
    (String) The unique identifier of the worker pool.
    autoscaleEnabled Boolean
    (Bool) Autoscaling is enabled on the workerpool
    id String
    The provider-assigned unique ID for this managed resource.
    resourceControllerUrl String
    Resource Controller URL
    workerPoolId String
    (String) The unique identifier of the worker pool.

    Look up Existing ContainerVpcWorkerPool Resource

    Get an existing ContainerVpcWorkerPool 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?: ContainerVpcWorkerPoolState, opts?: CustomResourceOptions): ContainerVpcWorkerPool
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        autoscale_enabled: Optional[bool] = None,
        cluster: Optional[str] = None,
        container_vpc_worker_pool_id: Optional[str] = None,
        crk: Optional[str] = None,
        entitlement: Optional[str] = None,
        flavor: Optional[str] = None,
        host_pool_id: Optional[str] = None,
        import_on_create: Optional[bool] = None,
        kms_account_id: Optional[str] = None,
        kms_instance_id: Optional[str] = None,
        labels: Optional[Mapping[str, str]] = None,
        operating_system: Optional[str] = None,
        orphan_on_delete: Optional[bool] = None,
        resource_controller_url: Optional[str] = None,
        resource_group_id: Optional[str] = None,
        secondary_storage: Optional[str] = None,
        security_groups: Optional[Sequence[str]] = None,
        taints: Optional[Sequence[ContainerVpcWorkerPoolTaintArgs]] = None,
        timeouts: Optional[ContainerVpcWorkerPoolTimeoutsArgs] = None,
        vpc_id: Optional[str] = None,
        worker_count: Optional[float] = None,
        worker_pool_id: Optional[str] = None,
        worker_pool_name: Optional[str] = None,
        zones: Optional[Sequence[ContainerVpcWorkerPoolZoneArgs]] = None) -> ContainerVpcWorkerPool
    func GetContainerVpcWorkerPool(ctx *Context, name string, id IDInput, state *ContainerVpcWorkerPoolState, opts ...ResourceOption) (*ContainerVpcWorkerPool, error)
    public static ContainerVpcWorkerPool Get(string name, Input<string> id, ContainerVpcWorkerPoolState? state, CustomResourceOptions? opts = null)
    public static ContainerVpcWorkerPool get(String name, Output<String> id, ContainerVpcWorkerPoolState state, CustomResourceOptions options)
    resources:  _:    type: ibm:ContainerVpcWorkerPool    get:      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:
    AutoscaleEnabled bool
    (Bool) Autoscaling is enabled on the workerpool
    Cluster string
    The name or ID of the cluster.
    ContainerVpcWorkerPoolId string
    (String) The unique identifier of the worker pool. The ID is composed of <cluster_name_id>/<worker_pool_id>.
    Crk string
    Root Key ID for boot volume encryption.
    Entitlement string
    The OpenShift cluster entitlement avoids incurred OCP license charges and use cloud pak with OCP license entitlement to add the OpenShift cluster worker pool. Note It is set as one time creation of the worker pool. There is no impacts on any modification. Set the argument to entitlement only when you use cluster with a cloud pak that has an OpenShift entitlement.
    Flavor string
    The flavor of the worker node.
    HostPoolId string
    The ID of the dedicated host pool the worker pool is associated with.
    ImportOnCreate bool
    Import an existing WorkerPool from the cluster, instead of creating a new.
    KmsAccountId string
    Account ID for boot volume encryption, if other account is providing the kms.
    KmsInstanceId string
    Instance ID for boot volume encryption.
    Labels Dictionary<string, string>
    A list of labels that you want to add to all the worker nodes in the worker pool.
    OperatingSystem string
    The operating system of the workers in the worker pool.
    OrphanOnDelete bool
    Orphan the Worker Pool resource, instead of deleting it. The argument allows the user to remove the worker pool from the state, without deleting the actual cloud resource. The worker pool can be re-imported into the state using the import_on_create argument.
    ResourceControllerUrl string
    Resource Controller URL
    ResourceGroupId string
    The ID of the resource group. To retrieve the ID, run ibmcloud resource groups or use the ibm.ResourceGroup data source. If no value is provided, the default resource group is used.
    SecondaryStorage string
    The secondary storage option for the workers in the worker pool.
    SecurityGroups List<string>
    Enables users to define specific security groups for their workers.
    Taints List<ContainerVpcWorkerPoolTaint>

    A nested block that sets or removes Kubernetes taints for all worker nodes in a worker pool

    Nested scheme for taints:

    Timeouts ContainerVpcWorkerPoolTimeouts
    VpcId string
    The ID of the VPC.
    WorkerCount double
    The number of worker nodes per zone in the worker pool.
    WorkerPoolId string
    (String) The unique identifier of the worker pool.
    WorkerPoolName string
    The name of the worker pool.
    Zones List<ContainerVpcWorkerPoolZone>

    A nested block describes the zones of this worker pool.

    Nested scheme for zones:

    AutoscaleEnabled bool
    (Bool) Autoscaling is enabled on the workerpool
    Cluster string
    The name or ID of the cluster.
    ContainerVpcWorkerPoolId string
    (String) The unique identifier of the worker pool. The ID is composed of <cluster_name_id>/<worker_pool_id>.
    Crk string
    Root Key ID for boot volume encryption.
    Entitlement string
    The OpenShift cluster entitlement avoids incurred OCP license charges and use cloud pak with OCP license entitlement to add the OpenShift cluster worker pool. Note It is set as one time creation of the worker pool. There is no impacts on any modification. Set the argument to entitlement only when you use cluster with a cloud pak that has an OpenShift entitlement.
    Flavor string
    The flavor of the worker node.
    HostPoolId string
    The ID of the dedicated host pool the worker pool is associated with.
    ImportOnCreate bool
    Import an existing WorkerPool from the cluster, instead of creating a new.
    KmsAccountId string
    Account ID for boot volume encryption, if other account is providing the kms.
    KmsInstanceId string
    Instance ID for boot volume encryption.
    Labels map[string]string
    A list of labels that you want to add to all the worker nodes in the worker pool.
    OperatingSystem string
    The operating system of the workers in the worker pool.
    OrphanOnDelete bool
    Orphan the Worker Pool resource, instead of deleting it. The argument allows the user to remove the worker pool from the state, without deleting the actual cloud resource. The worker pool can be re-imported into the state using the import_on_create argument.
    ResourceControllerUrl string
    Resource Controller URL
    ResourceGroupId string
    The ID of the resource group. To retrieve the ID, run ibmcloud resource groups or use the ibm.ResourceGroup data source. If no value is provided, the default resource group is used.
    SecondaryStorage string
    The secondary storage option for the workers in the worker pool.
    SecurityGroups []string
    Enables users to define specific security groups for their workers.
    Taints []ContainerVpcWorkerPoolTaintArgs

    A nested block that sets or removes Kubernetes taints for all worker nodes in a worker pool

    Nested scheme for taints:

    Timeouts ContainerVpcWorkerPoolTimeoutsArgs
    VpcId string
    The ID of the VPC.
    WorkerCount float64
    The number of worker nodes per zone in the worker pool.
    WorkerPoolId string
    (String) The unique identifier of the worker pool.
    WorkerPoolName string
    The name of the worker pool.
    Zones []ContainerVpcWorkerPoolZoneArgs

    A nested block describes the zones of this worker pool.

    Nested scheme for zones:

    autoscaleEnabled Boolean
    (Bool) Autoscaling is enabled on the workerpool
    cluster String
    The name or ID of the cluster.
    containerVpcWorkerPoolId String
    (String) The unique identifier of the worker pool. The ID is composed of <cluster_name_id>/<worker_pool_id>.
    crk String
    Root Key ID for boot volume encryption.
    entitlement String
    The OpenShift cluster entitlement avoids incurred OCP license charges and use cloud pak with OCP license entitlement to add the OpenShift cluster worker pool. Note It is set as one time creation of the worker pool. There is no impacts on any modification. Set the argument to entitlement only when you use cluster with a cloud pak that has an OpenShift entitlement.
    flavor String
    The flavor of the worker node.
    hostPoolId String
    The ID of the dedicated host pool the worker pool is associated with.
    importOnCreate Boolean
    Import an existing WorkerPool from the cluster, instead of creating a new.
    kmsAccountId String
    Account ID for boot volume encryption, if other account is providing the kms.
    kmsInstanceId String
    Instance ID for boot volume encryption.
    labels Map<String,String>
    A list of labels that you want to add to all the worker nodes in the worker pool.
    operatingSystem String
    The operating system of the workers in the worker pool.
    orphanOnDelete Boolean
    Orphan the Worker Pool resource, instead of deleting it. The argument allows the user to remove the worker pool from the state, without deleting the actual cloud resource. The worker pool can be re-imported into the state using the import_on_create argument.
    resourceControllerUrl String
    Resource Controller URL
    resourceGroupId String
    The ID of the resource group. To retrieve the ID, run ibmcloud resource groups or use the ibm.ResourceGroup data source. If no value is provided, the default resource group is used.
    secondaryStorage String
    The secondary storage option for the workers in the worker pool.
    securityGroups List<String>
    Enables users to define specific security groups for their workers.
    taints List<ContainerVpcWorkerPoolTaint>

    A nested block that sets or removes Kubernetes taints for all worker nodes in a worker pool

    Nested scheme for taints:

    timeouts ContainerVpcWorkerPoolTimeouts
    vpcId String
    The ID of the VPC.
    workerCount Double
    The number of worker nodes per zone in the worker pool.
    workerPoolId String
    (String) The unique identifier of the worker pool.
    workerPoolName String
    The name of the worker pool.
    zones List<ContainerVpcWorkerPoolZone>

    A nested block describes the zones of this worker pool.

    Nested scheme for zones:

    autoscaleEnabled boolean
    (Bool) Autoscaling is enabled on the workerpool
    cluster string
    The name or ID of the cluster.
    containerVpcWorkerPoolId string
    (String) The unique identifier of the worker pool. The ID is composed of <cluster_name_id>/<worker_pool_id>.
    crk string
    Root Key ID for boot volume encryption.
    entitlement string
    The OpenShift cluster entitlement avoids incurred OCP license charges and use cloud pak with OCP license entitlement to add the OpenShift cluster worker pool. Note It is set as one time creation of the worker pool. There is no impacts on any modification. Set the argument to entitlement only when you use cluster with a cloud pak that has an OpenShift entitlement.
    flavor string
    The flavor of the worker node.
    hostPoolId string
    The ID of the dedicated host pool the worker pool is associated with.
    importOnCreate boolean
    Import an existing WorkerPool from the cluster, instead of creating a new.
    kmsAccountId string
    Account ID for boot volume encryption, if other account is providing the kms.
    kmsInstanceId string
    Instance ID for boot volume encryption.
    labels {[key: string]: string}
    A list of labels that you want to add to all the worker nodes in the worker pool.
    operatingSystem string
    The operating system of the workers in the worker pool.
    orphanOnDelete boolean
    Orphan the Worker Pool resource, instead of deleting it. The argument allows the user to remove the worker pool from the state, without deleting the actual cloud resource. The worker pool can be re-imported into the state using the import_on_create argument.
    resourceControllerUrl string
    Resource Controller URL
    resourceGroupId string
    The ID of the resource group. To retrieve the ID, run ibmcloud resource groups or use the ibm.ResourceGroup data source. If no value is provided, the default resource group is used.
    secondaryStorage string
    The secondary storage option for the workers in the worker pool.
    securityGroups string[]
    Enables users to define specific security groups for their workers.
    taints ContainerVpcWorkerPoolTaint[]

    A nested block that sets or removes Kubernetes taints for all worker nodes in a worker pool

    Nested scheme for taints:

    timeouts ContainerVpcWorkerPoolTimeouts
    vpcId string
    The ID of the VPC.
    workerCount number
    The number of worker nodes per zone in the worker pool.
    workerPoolId string
    (String) The unique identifier of the worker pool.
    workerPoolName string
    The name of the worker pool.
    zones ContainerVpcWorkerPoolZone[]

    A nested block describes the zones of this worker pool.

    Nested scheme for zones:

    autoscale_enabled bool
    (Bool) Autoscaling is enabled on the workerpool
    cluster str
    The name or ID of the cluster.
    container_vpc_worker_pool_id str
    (String) The unique identifier of the worker pool. The ID is composed of <cluster_name_id>/<worker_pool_id>.
    crk str
    Root Key ID for boot volume encryption.
    entitlement str
    The OpenShift cluster entitlement avoids incurred OCP license charges and use cloud pak with OCP license entitlement to add the OpenShift cluster worker pool. Note It is set as one time creation of the worker pool. There is no impacts on any modification. Set the argument to entitlement only when you use cluster with a cloud pak that has an OpenShift entitlement.
    flavor str
    The flavor of the worker node.
    host_pool_id str
    The ID of the dedicated host pool the worker pool is associated with.
    import_on_create bool
    Import an existing WorkerPool from the cluster, instead of creating a new.
    kms_account_id str
    Account ID for boot volume encryption, if other account is providing the kms.
    kms_instance_id str
    Instance ID for boot volume encryption.
    labels Mapping[str, str]
    A list of labels that you want to add to all the worker nodes in the worker pool.
    operating_system str
    The operating system of the workers in the worker pool.
    orphan_on_delete bool
    Orphan the Worker Pool resource, instead of deleting it. The argument allows the user to remove the worker pool from the state, without deleting the actual cloud resource. The worker pool can be re-imported into the state using the import_on_create argument.
    resource_controller_url str
    Resource Controller URL
    resource_group_id str
    The ID of the resource group. To retrieve the ID, run ibmcloud resource groups or use the ibm.ResourceGroup data source. If no value is provided, the default resource group is used.
    secondary_storage str
    The secondary storage option for the workers in the worker pool.
    security_groups Sequence[str]
    Enables users to define specific security groups for their workers.
    taints Sequence[ContainerVpcWorkerPoolTaintArgs]

    A nested block that sets or removes Kubernetes taints for all worker nodes in a worker pool

    Nested scheme for taints:

    timeouts ContainerVpcWorkerPoolTimeoutsArgs
    vpc_id str
    The ID of the VPC.
    worker_count float
    The number of worker nodes per zone in the worker pool.
    worker_pool_id str
    (String) The unique identifier of the worker pool.
    worker_pool_name str
    The name of the worker pool.
    zones Sequence[ContainerVpcWorkerPoolZoneArgs]

    A nested block describes the zones of this worker pool.

    Nested scheme for zones:

    autoscaleEnabled Boolean
    (Bool) Autoscaling is enabled on the workerpool
    cluster String
    The name or ID of the cluster.
    containerVpcWorkerPoolId String
    (String) The unique identifier of the worker pool. The ID is composed of <cluster_name_id>/<worker_pool_id>.
    crk String
    Root Key ID for boot volume encryption.
    entitlement String
    The OpenShift cluster entitlement avoids incurred OCP license charges and use cloud pak with OCP license entitlement to add the OpenShift cluster worker pool. Note It is set as one time creation of the worker pool. There is no impacts on any modification. Set the argument to entitlement only when you use cluster with a cloud pak that has an OpenShift entitlement.
    flavor String
    The flavor of the worker node.
    hostPoolId String
    The ID of the dedicated host pool the worker pool is associated with.
    importOnCreate Boolean
    Import an existing WorkerPool from the cluster, instead of creating a new.
    kmsAccountId String
    Account ID for boot volume encryption, if other account is providing the kms.
    kmsInstanceId String
    Instance ID for boot volume encryption.
    labels Map<String>
    A list of labels that you want to add to all the worker nodes in the worker pool.
    operatingSystem String
    The operating system of the workers in the worker pool.
    orphanOnDelete Boolean
    Orphan the Worker Pool resource, instead of deleting it. The argument allows the user to remove the worker pool from the state, without deleting the actual cloud resource. The worker pool can be re-imported into the state using the import_on_create argument.
    resourceControllerUrl String
    Resource Controller URL
    resourceGroupId String
    The ID of the resource group. To retrieve the ID, run ibmcloud resource groups or use the ibm.ResourceGroup data source. If no value is provided, the default resource group is used.
    secondaryStorage String
    The secondary storage option for the workers in the worker pool.
    securityGroups List<String>
    Enables users to define specific security groups for their workers.
    taints List<Property Map>

    A nested block that sets or removes Kubernetes taints for all worker nodes in a worker pool

    Nested scheme for taints:

    timeouts Property Map
    vpcId String
    The ID of the VPC.
    workerCount Number
    The number of worker nodes per zone in the worker pool.
    workerPoolId String
    (String) The unique identifier of the worker pool.
    workerPoolName String
    The name of the worker pool.
    zones List<Property Map>

    A nested block describes the zones of this worker pool.

    Nested scheme for zones:

    Supporting Types

    ContainerVpcWorkerPoolTaint, ContainerVpcWorkerPoolTaintArgs

    Effect string
    Effect for taint. Accepted values are NoSchedule, PreferNoSchedule, and NoExecute.
    Key string
    Key for taint.
    Value string
    Value for taint.
    Effect string
    Effect for taint. Accepted values are NoSchedule, PreferNoSchedule, and NoExecute.
    Key string
    Key for taint.
    Value string
    Value for taint.
    effect String
    Effect for taint. Accepted values are NoSchedule, PreferNoSchedule, and NoExecute.
    key String
    Key for taint.
    value String
    Value for taint.
    effect string
    Effect for taint. Accepted values are NoSchedule, PreferNoSchedule, and NoExecute.
    key string
    Key for taint.
    value string
    Value for taint.
    effect str
    Effect for taint. Accepted values are NoSchedule, PreferNoSchedule, and NoExecute.
    key str
    Key for taint.
    value str
    Value for taint.
    effect String
    Effect for taint. Accepted values are NoSchedule, PreferNoSchedule, and NoExecute.
    key String
    Key for taint.
    value String
    Value for taint.

    ContainerVpcWorkerPoolTimeouts, ContainerVpcWorkerPoolTimeoutsArgs

    Create string
    Delete string
    Create string
    Delete string
    create String
    delete String
    create string
    delete string
    create str
    delete str
    create String
    delete String

    ContainerVpcWorkerPoolZone, ContainerVpcWorkerPoolZoneArgs

    Name string
    The name of the zone.
    SubnetId string
    The subnet that you want to use for your worker pool.
    Name string
    The name of the zone.
    SubnetId string
    The subnet that you want to use for your worker pool.
    name String
    The name of the zone.
    subnetId String
    The subnet that you want to use for your worker pool.
    name string
    The name of the zone.
    subnetId string
    The subnet that you want to use for your worker pool.
    name str
    The name of the zone.
    subnet_id str
    The subnet that you want to use for your worker pool.
    name String
    The name of the zone.
    subnetId String
    The subnet that you want to use for your worker pool.

    Import

    The ibm_container_vpc_worker_pool can be imported by using cluster_name_id, worker_pool_id.

    Example

    $ pulumi import ibm:index/containerVpcWorkerPool:ContainerVpcWorkerPool example mycluster/5c4f4d06e0dc402084922dea70850e3b-7cafe35

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    ibm ibm-cloud/terraform-provider-ibm
    License
    Notes
    This Pulumi package is based on the ibm Terraform Provider.
    ibm logo
    ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
    ibm-cloud/terraform-provider-ibm