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

ibm.getContainerVpcClusterWorkerPool

Explore with Pulumi AI

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

    Retrieve information about a Kubernetes cluster worker pool on IBM Cloud as a read-only data source. For more information, about VPC cluster, see creating clusters.

    Using getContainerVpcClusterWorkerPool

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getContainerVpcClusterWorkerPool(args: GetContainerVpcClusterWorkerPoolArgs, opts?: InvokeOptions): Promise<GetContainerVpcClusterWorkerPoolResult>
function getContainerVpcClusterWorkerPoolOutput(args: GetContainerVpcClusterWorkerPoolOutputArgs, opts?: InvokeOptions): Output<GetContainerVpcClusterWorkerPoolResult>
    def get_container_vpc_cluster_worker_pool(cluster: Optional[str] = None,
                                          id: Optional[str] = None,
                                          worker_pool_name: Optional[str] = None,
                                          opts: Optional[InvokeOptions] = None) -> GetContainerVpcClusterWorkerPoolResult
def get_container_vpc_cluster_worker_pool_output(cluster: Optional[pulumi.Input[str]] = None,
                                          id: Optional[pulumi.Input[str]] = None,
                                          worker_pool_name: Optional[pulumi.Input[str]] = None,
                                          opts: Optional[InvokeOptions] = None) -> Output[GetContainerVpcClusterWorkerPoolResult]
    func LookupContainerVpcClusterWorkerPool(ctx *Context, args *LookupContainerVpcClusterWorkerPoolArgs, opts ...InvokeOption) (*LookupContainerVpcClusterWorkerPoolResult, error)
func LookupContainerVpcClusterWorkerPoolOutput(ctx *Context, args *LookupContainerVpcClusterWorkerPoolOutputArgs, opts ...InvokeOption) LookupContainerVpcClusterWorkerPoolResultOutput

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

    public static class GetContainerVpcClusterWorkerPool 
{
    public static Task<GetContainerVpcClusterWorkerPoolResult> InvokeAsync(GetContainerVpcClusterWorkerPoolArgs args, InvokeOptions? opts = null)
    public static Output<GetContainerVpcClusterWorkerPoolResult> Invoke(GetContainerVpcClusterWorkerPoolInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetContainerVpcClusterWorkerPoolResult> getContainerVpcClusterWorkerPool(GetContainerVpcClusterWorkerPoolArgs args, InvokeOptions options)
public static Output<GetContainerVpcClusterWorkerPoolResult> getContainerVpcClusterWorkerPool(GetContainerVpcClusterWorkerPoolArgs args, InvokeOptions options)

    fn::invoke:
  function: ibm:index/getContainerVpcClusterWorkerPool:getContainerVpcClusterWorkerPool
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Cluster string
    The name or ID of the cluster.
    WorkerPoolName string
    The name of the worker pool.
    Id string
    (String) The unique identifier of the worker pool resource, as <cluster_name_id>/<worker_pool_id>.
    Cluster string
    The name or ID of the cluster.
    WorkerPoolName string
    The name of the worker pool.
    Id string
    (String) The unique identifier of the worker pool resource, as <cluster_name_id>/<worker_pool_id>.
    cluster String
    The name or ID of the cluster.
    workerPoolName String
    The name of the worker pool.
    id String
    (String) The unique identifier of the worker pool resource, as <cluster_name_id>/<worker_pool_id>.
    cluster string
    The name or ID of the cluster.
    workerPoolName string
    The name of the worker pool.
    id string
    (String) The unique identifier of the worker pool resource, as <cluster_name_id>/<worker_pool_id>.
    cluster str
    The name or ID of the cluster.
    worker_pool_name str
    The name of the worker pool.
    id str
    (String) The unique identifier of the worker pool resource, as <cluster_name_id>/<worker_pool_id>.
    cluster String
    The name or ID of the cluster.
    workerPoolName String
    The name of the worker pool.
    id String
    (String) The unique identifier of the worker pool resource, as <cluster_name_id>/<worker_pool_id>.

    getContainerVpcClusterWorkerPool Result

    The following output properties are available:

    AutoscaleEnabled bool
    (Bool) Autoscaling is enabled on the workerpool
    Cluster string
    Crk string
    Flavor string
    (String) The flavour of the worker node.
    HostPoolId string
    (String) The ID of the dedicated host pool the worker pool is associated with.
    Id string
    (String) The unique identifier of the worker pool resource, as <cluster_name_id>/<worker_pool_id>.
    Isolation string
    (String) Isolation for the worker node.
    KmsAccountId string
    KmsInstanceId string
    Labels Dictionary<string, string>
    (String) Labels on all the workers in the worker pool.
    OperatingSystem string
    (String) The operating system of the workers in the worker pool.
    ResourceGroupId string
    (String) The ID of the resource group.
    SecondaryStorages List<GetContainerVpcClusterWorkerPoolSecondaryStorage>
    List of objects - The optional secondary storage configuration of the workers in the worker pool.
    VpcId string
    (String) The ID of the VPC.
    WorkerCount double
    (String) The number of worker nodes per zone in the worker pool.
    WorkerPoolName string
    Zones List<GetContainerVpcClusterWorkerPoolZone>
    (String) A nested block describes the zones of the worker_pool. Nested zones blocks has subnet-id and name.
    AutoscaleEnabled bool
    (Bool) Autoscaling is enabled on the workerpool
    Cluster string
    Crk string
    Flavor string
    (String) The flavour of the worker node.
    HostPoolId string
    (String) The ID of the dedicated host pool the worker pool is associated with.
    Id string
    (String) The unique identifier of the worker pool resource, as <cluster_name_id>/<worker_pool_id>.
    Isolation string
    (String) Isolation for the worker node.
    KmsAccountId string
    KmsInstanceId string
    Labels map[string]string
    (String) Labels on all the workers in the worker pool.
    OperatingSystem string
    (String) The operating system of the workers in the worker pool.
    ResourceGroupId string
    (String) The ID of the resource group.
    SecondaryStorages []GetContainerVpcClusterWorkerPoolSecondaryStorage
    List of objects - The optional secondary storage configuration of the workers in the worker pool.
    VpcId string
    (String) The ID of the VPC.
    WorkerCount float64
    (String) The number of worker nodes per zone in the worker pool.
    WorkerPoolName string
    Zones []GetContainerVpcClusterWorkerPoolZone
    (String) A nested block describes the zones of the worker_pool. Nested zones blocks has subnet-id and name.
    autoscaleEnabled Boolean
    (Bool) Autoscaling is enabled on the workerpool
    cluster String
    crk String
    flavor String
    (String) The flavour of the worker node.
    hostPoolId String
    (String) The ID of the dedicated host pool the worker pool is associated with.
    id String
    (String) The unique identifier of the worker pool resource, as <cluster_name_id>/<worker_pool_id>.
    isolation String
    (String) Isolation for the worker node.
    kmsAccountId String
    kmsInstanceId String
    labels Map<String,String>
    (String) Labels on all the workers in the worker pool.
    operatingSystem String
    (String) The operating system of the workers in the worker pool.
    resourceGroupId String
    (String) The ID of the resource group.
    secondaryStorages List<GetContainerVpcClusterWorkerPoolSecondaryStorage>
    List of objects - The optional secondary storage configuration of the workers in the worker pool.
    vpcId String
    (String) The ID of the VPC.
    workerCount Double
    (String) The number of worker nodes per zone in the worker pool.
    workerPoolName String
    zones List<GetContainerVpcClusterWorkerPoolZone>
    (String) A nested block describes the zones of the worker_pool. Nested zones blocks has subnet-id and name.
    autoscaleEnabled boolean
    (Bool) Autoscaling is enabled on the workerpool
    cluster string
    crk string
    flavor string
    (String) The flavour of the worker node.
    hostPoolId string
    (String) The ID of the dedicated host pool the worker pool is associated with.
    id string
    (String) The unique identifier of the worker pool resource, as <cluster_name_id>/<worker_pool_id>.
    isolation string
    (String) Isolation for the worker node.
    kmsAccountId string
    kmsInstanceId string
    labels {[key: string]: string}
    (String) Labels on all the workers in the worker pool.
    operatingSystem string
    (String) The operating system of the workers in the worker pool.
    resourceGroupId string
    (String) The ID of the resource group.
    secondaryStorages GetContainerVpcClusterWorkerPoolSecondaryStorage[]
    List of objects - The optional secondary storage configuration of the workers in the worker pool.
    vpcId string
    (String) The ID of the VPC.
    workerCount number
    (String) The number of worker nodes per zone in the worker pool.
    workerPoolName string
    zones GetContainerVpcClusterWorkerPoolZone[]
    (String) A nested block describes the zones of the worker_pool. Nested zones blocks has subnet-id and name.
    autoscale_enabled bool
    (Bool) Autoscaling is enabled on the workerpool
    cluster str
    crk str
    flavor str
    (String) The flavour of the worker node.
    host_pool_id str
    (String) The ID of the dedicated host pool the worker pool is associated with.
    id str
    (String) The unique identifier of the worker pool resource, as <cluster_name_id>/<worker_pool_id>.
    isolation str
    (String) Isolation for the worker node.
    kms_account_id str
    kms_instance_id str
    labels Mapping[str, str]
    (String) Labels on all the workers in the worker pool.
    operating_system str
    (String) The operating system of the workers in the worker pool.
    resource_group_id str
    (String) The ID of the resource group.
    secondary_storages Sequence[GetContainerVpcClusterWorkerPoolSecondaryStorage]
    List of objects - The optional secondary storage configuration of the workers in the worker pool.
    vpc_id str
    (String) The ID of the VPC.
    worker_count float
    (String) The number of worker nodes per zone in the worker pool.
    worker_pool_name str
    zones Sequence[GetContainerVpcClusterWorkerPoolZone]
    (String) A nested block describes the zones of the worker_pool. Nested zones blocks has subnet-id and name.
    autoscaleEnabled Boolean
    (Bool) Autoscaling is enabled on the workerpool
    cluster String
    crk String
    flavor String
    (String) The flavour of the worker node.
    hostPoolId String
    (String) The ID of the dedicated host pool the worker pool is associated with.
    id String
    (String) The unique identifier of the worker pool resource, as <cluster_name_id>/<worker_pool_id>.
    isolation String
    (String) Isolation for the worker node.
    kmsAccountId String
    kmsInstanceId String
    labels Map<String>
    (String) Labels on all the workers in the worker pool.
    operatingSystem String
    (String) The operating system of the workers in the worker pool.
    resourceGroupId String
    (String) The ID of the resource group.
    secondaryStorages List<Property Map>
    List of objects - The optional secondary storage configuration of the workers in the worker pool.
    vpcId String
    (String) The ID of the VPC.
    workerCount Number
    (String) The number of worker nodes per zone in the worker pool.
    workerPoolName String
    zones List<Property Map>
    (String) A nested block describes the zones of the worker_pool. Nested zones blocks has subnet-id and name.

    Supporting Types

    GetContainerVpcClusterWorkerPoolSecondaryStorage

    Count double
    (Integer) The device count of the secondary storage.
    DeviceType string
    (String) The device type of the secondary storage.
    Name string
    (String) The name of the secondary storage.
    Profile string
    (String) The profile of the secondary storage.
    RaidConfiguration string
    (String) The raid configuration of the secondary storage.
    Size double
    (Integer) The size of the secondary storage.
    Count float64
    (Integer) The device count of the secondary storage.
    DeviceType string
    (String) The device type of the secondary storage.
    Name string
    (String) The name of the secondary storage.
    Profile string
    (String) The profile of the secondary storage.
    RaidConfiguration string
    (String) The raid configuration of the secondary storage.
    Size float64
    (Integer) The size of the secondary storage.
    count Double
    (Integer) The device count of the secondary storage.
    deviceType String
    (String) The device type of the secondary storage.
    name String
    (String) The name of the secondary storage.
    profile String
    (String) The profile of the secondary storage.
    raidConfiguration String
    (String) The raid configuration of the secondary storage.
    size Double
    (Integer) The size of the secondary storage.
    count number
    (Integer) The device count of the secondary storage.
    deviceType string
    (String) The device type of the secondary storage.
    name string
    (String) The name of the secondary storage.
    profile string
    (String) The profile of the secondary storage.
    raidConfiguration string
    (String) The raid configuration of the secondary storage.
    size number
    (Integer) The size of the secondary storage.
    count float
    (Integer) The device count of the secondary storage.
    device_type str
    (String) The device type of the secondary storage.
    name str
    (String) The name of the secondary storage.
    profile str
    (String) The profile of the secondary storage.
    raid_configuration str
    (String) The raid configuration of the secondary storage.
    size float
    (Integer) The size of the secondary storage.
    count Number
    (Integer) The device count of the secondary storage.
    deviceType String
    (String) The device type of the secondary storage.
    name String
    (String) The name of the secondary storage.
    profile String
    (String) The profile of the secondary storage.
    raidConfiguration String
    (String) The raid configuration of the secondary storage.
    size Number
    (Integer) The size of the secondary storage.

    GetContainerVpcClusterWorkerPoolZone

    Name string
    (String) The name of the secondary storage.
    SubnetId string
    Name string
    (String) The name of the secondary storage.
    SubnetId string
    name String
    (String) The name of the secondary storage.
    subnetId String
    name string
    (String) The name of the secondary storage.
    subnetId string
    name str
    (String) The name of the secondary storage.
    subnet_id str
    name String
    (String) The name of the secondary storage.
    subnetId String

    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