ibm 1.77.1, Apr 14 25

ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud

ibm.getContainerCluster

Explore with Pulumi AI

ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud

Example Usage

The following example retrieves information about a cluster that is named mycluster.

TypeScript
Python
Go
C#
Java
YAML

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

const cluster = ibm.getContainerCluster({
    clusterNameId: "mycluster",
});

import pulumi
import pulumi_ibm as ibm

cluster = ibm.get_container_cluster(cluster_name_id="mycluster")

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.LookupContainerCluster(ctx, &ibm.LookupContainerClusterArgs{
			ClusterNameId: pulumi.StringRef("mycluster"),
		}, nil)
		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 cluster = Ibm.GetContainerCluster.Invoke(new()
    {
        ClusterNameId = "mycluster",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.IbmFunctions;
import com.pulumi.ibm.inputs.GetContainerClusterArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var cluster = IbmFunctions.getContainerCluster(GetContainerClusterArgs.builder()
            .clusterNameId("mycluster")
            .build());

    }
}

variables:
  cluster:
    fn::invoke:
      function: ibm:getContainerCluster
      arguments:
        clusterNameId: mycluster

The following example retrieves the name of the cluster.

TypeScript
Python
Go
C#
Java
YAML

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

const clusterFoo = ibm.getContainerCluster({
    name: "FOO",
});

import pulumi
import pulumi_ibm as ibm

cluster_foo = ibm.get_container_cluster(name="FOO")

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.LookupContainerCluster(ctx, &ibm.LookupContainerClusterArgs{
			Name: pulumi.StringRef("FOO"),
		}, nil)
		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 clusterFoo = Ibm.GetContainerCluster.Invoke(new()
    {
        Name = "FOO",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.IbmFunctions;
import com.pulumi.ibm.inputs.GetContainerClusterArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var clusterFoo = IbmFunctions.getContainerCluster(GetContainerClusterArgs.builder()
            .name("FOO")
            .build());

    }
}

variables:
  clusterFoo:
    fn::invoke:
      function: ibm:getContainerCluster
      arguments:
        name: FOO

Using getContainerCluster

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.

TypeScript
Python
Go
C#
Java
YAML

function getContainerCluster(args: GetContainerClusterArgs, opts?: InvokeOptions): Promise<GetContainerClusterResult>
function getContainerClusterOutput(args: GetContainerClusterOutputArgs, opts?: InvokeOptions): Output<GetContainerClusterResult>

def get_container_cluster(account_guid: Optional[str] = None,
                          alb_type: Optional[str] = None,
                          cluster_name_id: Optional[str] = None,
                          id: Optional[str] = None,
                          list_bounded_services: Optional[bool] = None,
                          name: Optional[str] = None,
                          org_guid: Optional[str] = None,
                          region: Optional[str] = None,
                          resource_group_id: Optional[str] = None,
                          space_guid: Optional[str] = None,
                          wait_till: Optional[str] = None,
                          wait_till_timeout: Optional[float] = None,
                          opts: Optional[InvokeOptions] = None) -> GetContainerClusterResult
def get_container_cluster_output(account_guid: Optional[pulumi.Input[str]] = None,
                          alb_type: Optional[pulumi.Input[str]] = None,
                          cluster_name_id: Optional[pulumi.Input[str]] = None,
                          id: Optional[pulumi.Input[str]] = None,
                          list_bounded_services: Optional[pulumi.Input[bool]] = None,
                          name: Optional[pulumi.Input[str]] = None,
                          org_guid: Optional[pulumi.Input[str]] = None,
                          region: Optional[pulumi.Input[str]] = None,
                          resource_group_id: Optional[pulumi.Input[str]] = None,
                          space_guid: Optional[pulumi.Input[str]] = None,
                          wait_till: Optional[pulumi.Input[str]] = None,
                          wait_till_timeout: Optional[pulumi.Input[float]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetContainerClusterResult]

func LookupContainerCluster(ctx *Context, args *LookupContainerClusterArgs, opts ...InvokeOption) (*LookupContainerClusterResult, error)
func LookupContainerClusterOutput(ctx *Context, args *LookupContainerClusterOutputArgs, opts ...InvokeOption) LookupContainerClusterResultOutput

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

public static class GetContainerCluster 
{
    public static Task<GetContainerClusterResult> InvokeAsync(GetContainerClusterArgs args, InvokeOptions? opts = null)
    public static Output<GetContainerClusterResult> Invoke(GetContainerClusterInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetContainerClusterResult> getContainerCluster(GetContainerClusterArgs args, InvokeOptions options)
public static Output<GetContainerClusterResult> getContainerCluster(GetContainerClusterArgs args, InvokeOptions options)

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

The following arguments are supported:

AccountGuid string

The GUID for the IBM Cloud account associated with the cluster. You can retrieve the value from the ibm.getAccount data source or by running the ibmcloud iam accounts command in the IBM Cloud CLI.

Deprecated: Deprecated

AlbType string

Filters the albs based on type. The valid values are private, public, and all. The default value is all.

ClusterNameId string

The name or ID of the cluster that you want to retrieve.

Deprecated: Deprecated

Id string

(String) The ID of the worker pool.

ListBoundedServices bool

If set to false services which are bound to the cluster are not going to be listed. The default value is true.

Name string

The name or ID of the cluster.

OrgGuid string

The GUID for the IBM Cloud organization associated with the cluster. You can retrieve the value from the ibm.Org data source or by running the ibmcloud iam orgs.

Deprecated: Deprecated

Region string

The region where the cluster is provisioned. If the region is not specified it will be defaulted to provider region(IC_REGION/IBMCLOUD_REGION). To get the list of supported regions please access this link and use the alias.

Deprecated: Deprecated

ResourceGroupId string

The ID of the resource group where your cluster is provisioned into. To list resource groups, run ibmcloud resource groups or use the ibm.ResourceGroup data source.

SpaceGuid string

The GUID for the IBM Cloud space associated with the cluster. You can retrieve the value from the ibm.Space data source or by running the ibmcloud iam space <space-name> --guid command in the IBM Cloud CLI.

Deprecated: Deprecated

WaitTill string

WaitTillTimeout double

This parameter can be used to set the wait_till timeout in minutes. The wait_till_timeout can only be used with wait_till. The default value is 20 minutes.

Deprecated reference

AccountGuid string

Deprecated: Deprecated

AlbType string

Filters the albs based on type. The valid values are private, public, and all. The default value is all.

ClusterNameId string

The name or ID of the cluster that you want to retrieve.

Deprecated: Deprecated

Id string

(String) The ID of the worker pool.

ListBoundedServices bool

If set to false services which are bound to the cluster are not going to be listed. The default value is true.

Name string

The name or ID of the cluster.

OrgGuid string

The GUID for the IBM Cloud organization associated with the cluster. You can retrieve the value from the ibm.Org data source or by running the ibmcloud iam orgs.

Deprecated: Deprecated

Region string

Deprecated: Deprecated

ResourceGroupId string

The ID of the resource group where your cluster is provisioned into. To list resource groups, run ibmcloud resource groups or use the ibm.ResourceGroup data source.

SpaceGuid string

Deprecated: Deprecated

WaitTill string

WaitTillTimeout float64

This parameter can be used to set the wait_till timeout in minutes. The wait_till_timeout can only be used with wait_till. The default value is 20 minutes.

Deprecated reference

accountGuid String

Deprecated: Deprecated

albType String

Filters the albs based on type. The valid values are private, public, and all. The default value is all.

clusterNameId String

The name or ID of the cluster that you want to retrieve.

Deprecated: Deprecated

id String

(String) The ID of the worker pool.

listBoundedServices Boolean

If set to false services which are bound to the cluster are not going to be listed. The default value is true.

name String

The name or ID of the cluster.

orgGuid String

The GUID for the IBM Cloud organization associated with the cluster. You can retrieve the value from the ibm.Org data source or by running the ibmcloud iam orgs.

Deprecated: Deprecated

region String

Deprecated: Deprecated

resourceGroupId String

The ID of the resource group where your cluster is provisioned into. To list resource groups, run ibmcloud resource groups or use the ibm.ResourceGroup data source.

spaceGuid String

Deprecated: Deprecated

waitTill String

waitTillTimeout Double

This parameter can be used to set the wait_till timeout in minutes. The wait_till_timeout can only be used with wait_till. The default value is 20 minutes.

Deprecated reference

accountGuid string

Deprecated: Deprecated

albType string

Filters the albs based on type. The valid values are private, public, and all. The default value is all.

clusterNameId string

The name or ID of the cluster that you want to retrieve.

Deprecated: Deprecated

id string

(String) The ID of the worker pool.

listBoundedServices boolean

If set to false services which are bound to the cluster are not going to be listed. The default value is true.

name string

The name or ID of the cluster.

orgGuid string

The GUID for the IBM Cloud organization associated with the cluster. You can retrieve the value from the ibm.Org data source or by running the ibmcloud iam orgs.

Deprecated: Deprecated

region string

Deprecated: Deprecated

resourceGroupId string

The ID of the resource group where your cluster is provisioned into. To list resource groups, run ibmcloud resource groups or use the ibm.ResourceGroup data source.

spaceGuid string

Deprecated: Deprecated

waitTill string

waitTillTimeout number

This parameter can be used to set the wait_till timeout in minutes. The wait_till_timeout can only be used with wait_till. The default value is 20 minutes.

Deprecated reference

account_guid str

Deprecated: Deprecated

alb_type str

Filters the albs based on type. The valid values are private, public, and all. The default value is all.

cluster_name_id str

The name or ID of the cluster that you want to retrieve.

Deprecated: Deprecated

id str

(String) The ID of the worker pool.

list_bounded_services bool

If set to false services which are bound to the cluster are not going to be listed. The default value is true.

name str

The name or ID of the cluster.

org_guid str

The GUID for the IBM Cloud organization associated with the cluster. You can retrieve the value from the ibm.Org data source or by running the ibmcloud iam orgs.

Deprecated: Deprecated

region str

Deprecated: Deprecated

resource_group_id str

The ID of the resource group where your cluster is provisioned into. To list resource groups, run ibmcloud resource groups or use the ibm.ResourceGroup data source.

space_guid str

Deprecated: Deprecated

wait_till str

wait_till_timeout float

This parameter can be used to set the wait_till timeout in minutes. The wait_till_timeout can only be used with wait_till. The default value is 20 minutes.

Deprecated reference

accountGuid String

Deprecated: Deprecated

albType String

Filters the albs based on type. The valid values are private, public, and all. The default value is all.

clusterNameId String

The name or ID of the cluster that you want to retrieve.

Deprecated: Deprecated

id String

(String) The ID of the worker pool.

listBoundedServices Boolean

If set to false services which are bound to the cluster are not going to be listed. The default value is true.

name String

The name or ID of the cluster.

orgGuid String

The GUID for the IBM Cloud organization associated with the cluster. You can retrieve the value from the ibm.Org data source or by running the ibmcloud iam orgs.

Deprecated: Deprecated

region String

Deprecated: Deprecated

resourceGroupId String

The ID of the resource group where your cluster is provisioned into. To list resource groups, run ibmcloud resource groups or use the ibm.ResourceGroup data source.

spaceGuid String

Deprecated: Deprecated

waitTill String

waitTillTimeout Number

This parameter can be used to set the wait_till timeout in minutes. The wait_till_timeout can only be used with wait_till. The default value is 20 minutes.

Deprecated reference

getContainerCluster Result

The following output properties are available:

Albs List<GetContainerClusterAlb>: List of objects - A list of Ingress application load balancers (ALBs) that are attached to the cluster.
ApiKeyId string: (String) The ID of the API key.
ApiKeyOwnerEmail string: (String) The Email ID of the key owner.
ApiKeyOwnerName string: (String) The name of the key owner.
BoundedServices List<GetContainerClusterBoundedService>: List of strings - A list of IBM Cloud services that are bounded to the cluster.
Crn string: (String) The CRN of the cluster.
Id string: (String) The ID of the worker pool.
ImageSecurityEnforcement bool: (Bool) Indicates if image security enforcement policies are enabled in a cluster.
IngressHostname string: (String) The Ingress host name.
IngressSecret string: (String) The name of the Ingress secret.
IsTrusted bool
PrivateServiceEndpoint bool: (Bool) Indicates if the private service endpoint is enabled (true) or disabled (false) for a cluster.
PrivateServiceEndpointUrl string: (String) The URL of the private service endpoint for your cluster.
PublicServiceEndpoint bool: (Bool) Indicates if the public service endpoint is enabled (true) or disabled (false) for a cluster.
PublicServiceEndpointUrl string: (String) The URL of the public service endpoint for your cluster.
Region string: Deprecated: Deprecated
ResourceControllerUrl string
ResourceCrn string
ResourceGroupId string
ResourceGroupName string
ResourceName string
ResourceStatus string
ServerUrl string
State string: (String) The state of the worker pool.
Vlans List<GetContainerClusterVlan>: (List of objects) A list of VLANs that are attached to the cluster.
WorkerCount double: (Integer) The number of worker nodes that are attached to the zone.
WorkerPools List<GetContainerClusterWorkerPool>: List of objects - A list of worker pools that exist in the cluster.
Workers List<string>: List of objects - A list of worker nodes that belong to the cluster.
AccountGuid string: Deprecated: Deprecated
AlbType string: (String) The type of ALB. Supported values are public and private.
ClusterNameId string: Deprecated: Deprecated
ListBoundedServices bool
Name string: (String) The name of the worker pool.
OrgGuid string: Deprecated: Deprecated
SpaceGuid string: Deprecated: Deprecated
WaitTill string
WaitTillTimeout double

Albs []GetContainerClusterAlb: List of objects - A list of Ingress application load balancers (ALBs) that are attached to the cluster.
ApiKeyId string: (String) The ID of the API key.
ApiKeyOwnerEmail string: (String) The Email ID of the key owner.
ApiKeyOwnerName string: (String) The name of the key owner.
BoundedServices []GetContainerClusterBoundedService: List of strings - A list of IBM Cloud services that are bounded to the cluster.
Crn string: (String) The CRN of the cluster.
Id string: (String) The ID of the worker pool.
ImageSecurityEnforcement bool: (Bool) Indicates if image security enforcement policies are enabled in a cluster.
IngressHostname string: (String) The Ingress host name.
IngressSecret string: (String) The name of the Ingress secret.
IsTrusted bool
PrivateServiceEndpoint bool: (Bool) Indicates if the private service endpoint is enabled (true) or disabled (false) for a cluster.
PrivateServiceEndpointUrl string: (String) The URL of the private service endpoint for your cluster.
PublicServiceEndpoint bool: (Bool) Indicates if the public service endpoint is enabled (true) or disabled (false) for a cluster.
PublicServiceEndpointUrl string: (String) The URL of the public service endpoint for your cluster.
Region string: Deprecated: Deprecated
ResourceControllerUrl string
ResourceCrn string
ResourceGroupId string
ResourceGroupName string
ResourceName string
ResourceStatus string
ServerUrl string
State string: (String) The state of the worker pool.
Vlans []GetContainerClusterVlan: (List of objects) A list of VLANs that are attached to the cluster.
WorkerCount float64: (Integer) The number of worker nodes that are attached to the zone.
WorkerPools []GetContainerClusterWorkerPool: List of objects - A list of worker pools that exist in the cluster.
Workers []string: List of objects - A list of worker nodes that belong to the cluster.
AccountGuid string: Deprecated: Deprecated
AlbType string: (String) The type of ALB. Supported values are public and private.
ClusterNameId string: Deprecated: Deprecated
ListBoundedServices bool
Name string: (String) The name of the worker pool.
OrgGuid string: Deprecated: Deprecated
SpaceGuid string: Deprecated: Deprecated
WaitTill string
WaitTillTimeout float64

albs List<GetContainerClusterAlb>: List of objects - A list of Ingress application load balancers (ALBs) that are attached to the cluster.
apiKeyId String: (String) The ID of the API key.
apiKeyOwnerEmail String: (String) The Email ID of the key owner.
apiKeyOwnerName String: (String) The name of the key owner.
boundedServices List<GetContainerClusterBoundedService>: List of strings - A list of IBM Cloud services that are bounded to the cluster.
crn String: (String) The CRN of the cluster.
id String: (String) The ID of the worker pool.
imageSecurityEnforcement Boolean: (Bool) Indicates if image security enforcement policies are enabled in a cluster.
ingressHostname String: (String) The Ingress host name.
ingressSecret String: (String) The name of the Ingress secret.
isTrusted Boolean
privateServiceEndpoint Boolean: (Bool) Indicates if the private service endpoint is enabled (true) or disabled (false) for a cluster.
privateServiceEndpointUrl String: (String) The URL of the private service endpoint for your cluster.
publicServiceEndpoint Boolean: (Bool) Indicates if the public service endpoint is enabled (true) or disabled (false) for a cluster.
publicServiceEndpointUrl String: (String) The URL of the public service endpoint for your cluster.
region String: Deprecated: Deprecated
resourceControllerUrl String
resourceCrn String
resourceGroupId String
resourceGroupName String
resourceName String
resourceStatus String
serverUrl String
state String: (String) The state of the worker pool.
vlans List<GetContainerClusterVlan>: (List of objects) A list of VLANs that are attached to the cluster.
workerCount Double: (Integer) The number of worker nodes that are attached to the zone.
workerPools List<GetContainerClusterWorkerPool>: List of objects - A list of worker pools that exist in the cluster.
workers List<String>: List of objects - A list of worker nodes that belong to the cluster.
accountGuid String: Deprecated: Deprecated
albType String: (String) The type of ALB. Supported values are public and private.
clusterNameId String: Deprecated: Deprecated
listBoundedServices Boolean
name String: (String) The name of the worker pool.
orgGuid String: Deprecated: Deprecated
spaceGuid String: Deprecated: Deprecated
waitTill String
waitTillTimeout Double

albs GetContainerClusterAlb[]: List of objects - A list of Ingress application load balancers (ALBs) that are attached to the cluster.
apiKeyId string: (String) The ID of the API key.
apiKeyOwnerEmail string: (String) The Email ID of the key owner.
apiKeyOwnerName string: (String) The name of the key owner.
boundedServices GetContainerClusterBoundedService[]: List of strings - A list of IBM Cloud services that are bounded to the cluster.
crn string: (String) The CRN of the cluster.
id string: (String) The ID of the worker pool.
imageSecurityEnforcement boolean: (Bool) Indicates if image security enforcement policies are enabled in a cluster.
ingressHostname string: (String) The Ingress host name.
ingressSecret string: (String) The name of the Ingress secret.
isTrusted boolean
privateServiceEndpoint boolean: (Bool) Indicates if the private service endpoint is enabled (true) or disabled (false) for a cluster.
privateServiceEndpointUrl string: (String) The URL of the private service endpoint for your cluster.
publicServiceEndpoint boolean: (Bool) Indicates if the public service endpoint is enabled (true) or disabled (false) for a cluster.
publicServiceEndpointUrl string: (String) The URL of the public service endpoint for your cluster.
region string: Deprecated: Deprecated
resourceControllerUrl string
resourceCrn string
resourceGroupId string
resourceGroupName string
resourceName string
resourceStatus string
serverUrl string
state string: (String) The state of the worker pool.
vlans GetContainerClusterVlan[]: (List of objects) A list of VLANs that are attached to the cluster.
workerCount number: (Integer) The number of worker nodes that are attached to the zone.
workerPools GetContainerClusterWorkerPool[]: List of objects - A list of worker pools that exist in the cluster.
workers string[]: List of objects - A list of worker nodes that belong to the cluster.
accountGuid string: Deprecated: Deprecated
albType string: (String) The type of ALB. Supported values are public and private.
clusterNameId string: Deprecated: Deprecated
listBoundedServices boolean
name string: (String) The name of the worker pool.
orgGuid string: Deprecated: Deprecated
spaceGuid string: Deprecated: Deprecated
waitTill string
waitTillTimeout number

albs Sequence[GetContainerClusterAlb]: List of objects - A list of Ingress application load balancers (ALBs) that are attached to the cluster.
api_key_id str: (String) The ID of the API key.
api_key_owner_email str: (String) The Email ID of the key owner.
api_key_owner_name str: (String) The name of the key owner.
bounded_services Sequence[GetContainerClusterBoundedService]: List of strings - A list of IBM Cloud services that are bounded to the cluster.
crn str: (String) The CRN of the cluster.
id str: (String) The ID of the worker pool.
image_security_enforcement bool: (Bool) Indicates if image security enforcement policies are enabled in a cluster.
ingress_hostname str: (String) The Ingress host name.
ingress_secret str: (String) The name of the Ingress secret.
is_trusted bool
private_service_endpoint bool: (Bool) Indicates if the private service endpoint is enabled (true) or disabled (false) for a cluster.
private_service_endpoint_url str: (String) The URL of the private service endpoint for your cluster.
public_service_endpoint bool: (Bool) Indicates if the public service endpoint is enabled (true) or disabled (false) for a cluster.
public_service_endpoint_url str: (String) The URL of the public service endpoint for your cluster.
region str: Deprecated: Deprecated
resource_controller_url str
resource_crn str
resource_group_id str
resource_group_name str
resource_name str
resource_status str
server_url str
state str: (String) The state of the worker pool.
vlans Sequence[GetContainerClusterVlan]: (List of objects) A list of VLANs that are attached to the cluster.
worker_count float: (Integer) The number of worker nodes that are attached to the zone.
worker_pools Sequence[GetContainerClusterWorkerPool]: List of objects - A list of worker pools that exist in the cluster.
workers Sequence[str]: List of objects - A list of worker nodes that belong to the cluster.
account_guid str: Deprecated: Deprecated
alb_type str: (String) The type of ALB. Supported values are public and private.
cluster_name_id str: Deprecated: Deprecated
list_bounded_services bool
name str: (String) The name of the worker pool.
org_guid str: Deprecated: Deprecated
space_guid str: Deprecated: Deprecated
wait_till str
wait_till_timeout float

albs List<Property Map>: List of objects - A list of Ingress application load balancers (ALBs) that are attached to the cluster.
apiKeyId String: (String) The ID of the API key.
apiKeyOwnerEmail String: (String) The Email ID of the key owner.
apiKeyOwnerName String: (String) The name of the key owner.
boundedServices List<Property Map>: List of strings - A list of IBM Cloud services that are bounded to the cluster.
crn String: (String) The CRN of the cluster.
id String: (String) The ID of the worker pool.
imageSecurityEnforcement Boolean: (Bool) Indicates if image security enforcement policies are enabled in a cluster.
ingressHostname String: (String) The Ingress host name.
ingressSecret String: (String) The name of the Ingress secret.
isTrusted Boolean
privateServiceEndpoint Boolean: (Bool) Indicates if the private service endpoint is enabled (true) or disabled (false) for a cluster.
privateServiceEndpointUrl String: (String) The URL of the private service endpoint for your cluster.
publicServiceEndpoint Boolean: (Bool) Indicates if the public service endpoint is enabled (true) or disabled (false) for a cluster.
publicServiceEndpointUrl String: (String) The URL of the public service endpoint for your cluster.
region String: Deprecated: Deprecated
resourceControllerUrl String
resourceCrn String
resourceGroupId String
resourceGroupName String
resourceName String
resourceStatus String
serverUrl String
state String: (String) The state of the worker pool.
vlans List<Property Map>: (List of objects) A list of VLANs that are attached to the cluster.
workerCount Number: (Integer) The number of worker nodes that are attached to the zone.
workerPools List<Property Map>: List of objects - A list of worker pools that exist in the cluster.
workers List<String>: List of objects - A list of worker nodes that belong to the cluster.
accountGuid String: Deprecated: Deprecated
albType String: (String) The type of ALB. Supported values are public and private.
clusterNameId String: Deprecated: Deprecated
listBoundedServices Boolean
name String: (String) The name of the worker pool.
orgGuid String: Deprecated: Deprecated
spaceGuid String: Deprecated: Deprecated
waitTill String
waitTillTimeout Number

Supporting Types

GetContainerClusterAlb

AlbIp string: (String) BYOIP VIP to use for application load balancer. Currently supported only for private application load balancer.
AlbType string: Filters the albs based on type. The valid values are private, public, and all. The default value is all.
DisableDeployment bool: (Bool) Indicate whether to disable deployment only on disable application load balancer (ALB).
Enable bool: (Bool) Indicates if the ALB is enabled (true) or disabled (false) in the cluster.
Id string: (String) The ID of the worker pool.
Name string: The name or ID of the cluster.
NumOfInstances string: (Integer) The number of ALB replicas.
Resize bool: (Bool) Indicate whether resizing should be done.
State string: (String) The state of the worker pool.

AlbIp string: (String) BYOIP VIP to use for application load balancer. Currently supported only for private application load balancer.
AlbType string: Filters the albs based on type. The valid values are private, public, and all. The default value is all.
DisableDeployment bool: (Bool) Indicate whether to disable deployment only on disable application load balancer (ALB).
Enable bool: (Bool) Indicates if the ALB is enabled (true) or disabled (false) in the cluster.
Id string: (String) The ID of the worker pool.
Name string: The name or ID of the cluster.
NumOfInstances string: (Integer) The number of ALB replicas.
Resize bool: (Bool) Indicate whether resizing should be done.
State string: (String) The state of the worker pool.

albIp String: (String) BYOIP VIP to use for application load balancer. Currently supported only for private application load balancer.
albType String: Filters the albs based on type. The valid values are private, public, and all. The default value is all.
disableDeployment Boolean: (Bool) Indicate whether to disable deployment only on disable application load balancer (ALB).
enable Boolean: (Bool) Indicates if the ALB is enabled (true) or disabled (false) in the cluster.
id String: (String) The ID of the worker pool.
name String: The name or ID of the cluster.
numOfInstances String: (Integer) The number of ALB replicas.
resize Boolean: (Bool) Indicate whether resizing should be done.
state String: (String) The state of the worker pool.

albIp string: (String) BYOIP VIP to use for application load balancer. Currently supported only for private application load balancer.
albType string: Filters the albs based on type. The valid values are private, public, and all. The default value is all.
disableDeployment boolean: (Bool) Indicate whether to disable deployment only on disable application load balancer (ALB).
enable boolean: (Bool) Indicates if the ALB is enabled (true) or disabled (false) in the cluster.
id string: (String) The ID of the worker pool.
name string: The name or ID of the cluster.
numOfInstances string: (Integer) The number of ALB replicas.
resize boolean: (Bool) Indicate whether resizing should be done.
state string: (String) The state of the worker pool.

alb_ip str: (String) BYOIP VIP to use for application load balancer. Currently supported only for private application load balancer.
alb_type str: Filters the albs based on type. The valid values are private, public, and all. The default value is all.
disable_deployment bool: (Bool) Indicate whether to disable deployment only on disable application load balancer (ALB).
enable bool: (Bool) Indicates if the ALB is enabled (true) or disabled (false) in the cluster.
id str: (String) The ID of the worker pool.
name str: The name or ID of the cluster.
num_of_instances str: (Integer) The number of ALB replicas.
resize bool: (Bool) Indicate whether resizing should be done.
state str: (String) The state of the worker pool.

albIp String: (String) BYOIP VIP to use for application load balancer. Currently supported only for private application load balancer.
albType String: Filters the albs based on type. The valid values are private, public, and all. The default value is all.
disableDeployment Boolean: (Bool) Indicate whether to disable deployment only on disable application load balancer (ALB).
enable Boolean: (Bool) Indicates if the ALB is enabled (true) or disabled (false) in the cluster.
id String: (String) The ID of the worker pool.
name String: The name or ID of the cluster.
numOfInstances String: (Integer) The number of ALB replicas.
resize Boolean: (Bool) Indicate whether resizing should be done.
state String: (String) The state of the worker pool.

GetContainerClusterBoundedService

Namespace string
ServiceId string
ServiceKeyName string
ServiceName string

Namespace string
ServiceId string
ServiceKeyName string
ServiceName string

namespace String
serviceId String
serviceKeyName String
serviceName String

namespace string
serviceId string
serviceKeyName string
serviceName string

namespace str
service_id str
service_key_name str
service_name str

namespace String
serviceId String
serviceKeyName String
serviceName String

GetContainerClusterVlan

Id string: (String) The ID of the worker pool.
Subnets List<GetContainerClusterVlanSubnet>: List of objects - A list of subnets that belong to the cluster.

Id string: (String) The ID of the worker pool.
Subnets []GetContainerClusterVlanSubnet: List of objects - A list of subnets that belong to the cluster.

id String: (String) The ID of the worker pool.
subnets List<GetContainerClusterVlanSubnet>: List of objects - A list of subnets that belong to the cluster.

id string: (String) The ID of the worker pool.
subnets GetContainerClusterVlanSubnet[]: List of objects - A list of subnets that belong to the cluster.

id str: (String) The ID of the worker pool.
subnets Sequence[GetContainerClusterVlanSubnet]: List of objects - A list of subnets that belong to the cluster.

id String: (String) The ID of the worker pool.
subnets List<Property Map>: List of objects - A list of subnets that belong to the cluster.

GetContainerClusterVlanSubnet

Cidr string: (String) The IP address CIDR of the subnet.
Id string: (String) The ID of the worker pool.
Ips List<string>: List of strings - The IP addresses that belong to the subnet.
IsByoip bool
IsPublic bool: (Bool) If set to true, the VLAN is public. If set to false, the VLAN is private.

Cidr string: (String) The IP address CIDR of the subnet.
Id string: (String) The ID of the worker pool.
Ips []string: List of strings - The IP addresses that belong to the subnet.
IsByoip bool
IsPublic bool: (Bool) If set to true, the VLAN is public. If set to false, the VLAN is private.

cidr String: (String) The IP address CIDR of the subnet.
id String: (String) The ID of the worker pool.
ips List<String>: List of strings - The IP addresses that belong to the subnet.
isByoip Boolean
isPublic Boolean: (Bool) If set to true, the VLAN is public. If set to false, the VLAN is private.

cidr string: (String) The IP address CIDR of the subnet.
id string: (String) The ID of the worker pool.
ips string[]: List of strings - The IP addresses that belong to the subnet.
isByoip boolean
isPublic boolean: (Bool) If set to true, the VLAN is public. If set to false, the VLAN is private.

cidr str: (String) The IP address CIDR of the subnet.
id str: (String) The ID of the worker pool.
ips Sequence[str]: List of strings - The IP addresses that belong to the subnet.
is_byoip bool
is_public bool: (Bool) If set to true, the VLAN is public. If set to false, the VLAN is private.

cidr String: (String) The IP address CIDR of the subnet.
id String: (String) The ID of the worker pool.
ips List<String>: List of strings - The IP addresses that belong to the subnet.
isByoip Boolean
isPublic Boolean: (Bool) If set to true, the VLAN is public. If set to false, the VLAN is private.

GetContainerClusterWorkerPool

Hardware string: (String) The level of hardware isolation that is used for the worker node of the worker pool.
Id string: (String) The ID of the worker pool.
Labels Dictionary<string, string>: List of strings - A list of labels that are added to the worker pool.
MachineType string: (String) The machine type that is used for the worker nodes in the worker pool.
Name string: The name or ID of the cluster.
SizePerZone double: (Integer) The number of worker nodes per zone.
State string: (String) The state of the worker pool.
Zones List<GetContainerClusterWorkerPoolZone>: List of objects - A list of zones that are attached to the worker pool.

Hardware string: (String) The level of hardware isolation that is used for the worker node of the worker pool.
Id string: (String) The ID of the worker pool.
Labels map[string]string: List of strings - A list of labels that are added to the worker pool.
MachineType string: (String) The machine type that is used for the worker nodes in the worker pool.
Name string: The name or ID of the cluster.
SizePerZone float64: (Integer) The number of worker nodes per zone.
State string: (String) The state of the worker pool.
Zones []GetContainerClusterWorkerPoolZone: List of objects - A list of zones that are attached to the worker pool.

hardware String: (String) The level of hardware isolation that is used for the worker node of the worker pool.
id String: (String) The ID of the worker pool.
labels Map<String,String>: List of strings - A list of labels that are added to the worker pool.
machineType String: (String) The machine type that is used for the worker nodes in the worker pool.
name String: The name or ID of the cluster.
sizePerZone Double: (Integer) The number of worker nodes per zone.
state String: (String) The state of the worker pool.
zones List<GetContainerClusterWorkerPoolZone>: List of objects - A list of zones that are attached to the worker pool.

hardware string: (String) The level of hardware isolation that is used for the worker node of the worker pool.
id string: (String) The ID of the worker pool.
labels {[key: string]: string}: List of strings - A list of labels that are added to the worker pool.
machineType string: (String) The machine type that is used for the worker nodes in the worker pool.
name string: The name or ID of the cluster.
sizePerZone number: (Integer) The number of worker nodes per zone.
state string: (String) The state of the worker pool.
zones GetContainerClusterWorkerPoolZone[]: List of objects - A list of zones that are attached to the worker pool.

hardware str: (String) The level of hardware isolation that is used for the worker node of the worker pool.
id str: (String) The ID of the worker pool.
labels Mapping[str, str]: List of strings - A list of labels that are added to the worker pool.
machine_type str: (String) The machine type that is used for the worker nodes in the worker pool.
name str: The name or ID of the cluster.
size_per_zone float: (Integer) The number of worker nodes per zone.
state str: (String) The state of the worker pool.
zones Sequence[GetContainerClusterWorkerPoolZone]: List of objects - A list of zones that are attached to the worker pool.

hardware String: (String) The level of hardware isolation that is used for the worker node of the worker pool.
id String: (String) The ID of the worker pool.
labels Map<String>: List of strings - A list of labels that are added to the worker pool.
machineType String: (String) The machine type that is used for the worker nodes in the worker pool.
name String: The name or ID of the cluster.
sizePerZone Number: (Integer) The number of worker nodes per zone.
state String: (String) The state of the worker pool.
zones List<Property Map>: List of objects - A list of zones that are attached to the worker pool.

GetContainerClusterWorkerPoolZone

PrivateVlan string: (String) The ID of the private VLAN that is used in that zone.
PublicVlan string: (String) The ID of the private VLAN that is used in that zone.
WorkerCount double: (Integer) The number of worker nodes that are attached to the zone.
Zone string: (String) The name of the zone.

PrivateVlan string: (String) The ID of the private VLAN that is used in that zone.
PublicVlan string: (String) The ID of the private VLAN that is used in that zone.
WorkerCount float64: (Integer) The number of worker nodes that are attached to the zone.
Zone string: (String) The name of the zone.

privateVlan String: (String) The ID of the private VLAN that is used in that zone.
publicVlan String: (String) The ID of the private VLAN that is used in that zone.
workerCount Double: (Integer) The number of worker nodes that are attached to the zone.
zone String: (String) The name of the zone.

privateVlan string: (String) The ID of the private VLAN that is used in that zone.
publicVlan string: (String) The ID of the private VLAN that is used in that zone.
workerCount number: (Integer) The number of worker nodes that are attached to the zone.
zone string: (String) The name of the zone.

private_vlan str: (String) The ID of the private VLAN that is used in that zone.
public_vlan str: (String) The ID of the private VLAN that is used in that zone.
worker_count float: (Integer) The number of worker nodes that are attached to the zone.
zone str: (String) The name of the zone.

privateVlan String: (String) The ID of the private VLAN that is used in that zone.
publicVlan String: (String) The ID of the private VLAN that is used in that zone.
workerCount Number: (Integer) The number of worker nodes that are attached to the zone.
zone String: (String) The name of the zone.

Package Details

Repository: ibm ibm-cloud/terraform-provider-ibm
License
Notes: This Pulumi package is based on the ibm Terraform Provider.

ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud

ibm-cloud/terraform-provider-ibm

ibm.getContainerCluster

On this page

On this page

Example Usage

Using getContainerCluster

getContainerCluster Result

Supporting Types

GetContainerClusterAlb

GetContainerClusterBoundedService

GetContainerClusterVlan

GetContainerClusterVlanSubnet

GetContainerClusterWorkerPool

GetContainerClusterWorkerPoolZone

Package Details

On this page

On this page