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

ibm.getContainerClusterConfig

Explore with Pulumi AI

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

    Example Usage

    1

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

const clusterFoo = ibm.getContainerClusterConfig({
    clusterNameId: "FOO",
    configDir: "/home/foo_config",
});

    import pulumi
import pulumi_ibm as ibm

cluster_foo = ibm.get_container_cluster_config(cluster_name_id="FOO",
    config_dir="/home/foo_config")

    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.GetContainerClusterConfig(ctx, &ibm.GetContainerClusterConfigArgs{
			ClusterNameId: "FOO",
			ConfigDir:     pulumi.StringRef("/home/foo_config"),
		}, 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.GetContainerClusterConfig.Invoke(new()
    {
        ClusterNameId = "FOO",
        ConfigDir = "/home/foo_config",
    });

});

    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.GetContainerClusterConfigArgs;
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.getContainerClusterConfig(GetContainerClusterConfigArgs.builder()
            .clusterNameId("FOO")
            .configDir("/home/foo_config")
            .build());

    }
}

    variables:
  clusterFoo:
    fn::invoke:
      function: ibm:getContainerClusterConfig
      arguments:
        clusterNameId: FOO
        configDir: /home/foo_config

    2

    Example for connecting to Kubernetes provider for classic or VPC Kubernetes cluster with admin certificates

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

const clusterFoo = ibm.getContainerClusterConfig({
    clusterNameId: "FOO",
    admin: true,
});
const example = new kubernetes.index.Kubernetes_namespace("example", {metadata: [{
    name: "terraform-example-namespace",
}]});

    import pulumi
import pulumi_ibm as ibm
import pulumi_kubernetes as kubernetes

cluster_foo = ibm.get_container_cluster_config(cluster_name_id="FOO",
    admin=True)
example = kubernetes.index.Kubernetes_namespace("example", metadata=[{
    name: terraform-example-namespace,
}])

    package main

import (
	"github.com/pulumi/pulumi-kubernetes/sdk/go/kubernetes"
	"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.GetContainerClusterConfig(ctx, &ibm.GetContainerClusterConfigArgs{
			ClusterNameId: "FOO",
			Admin:         pulumi.BoolRef(true),
		}, nil)
		if err != nil {
			return err
		}
		_, err = kubernetes.NewKubernetes_namespace(ctx, "example", &kubernetes.Kubernetes_namespaceArgs{
			Metadata: []map[string]interface{}{
				map[string]interface{}{
					"name": "terraform-example-namespace",
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var clusterFoo = Ibm.GetContainerClusterConfig.Invoke(new()
    {
        ClusterNameId = "FOO",
        Admin = true,
    });

    var example = new Kubernetes.Index.Kubernetes_namespace("example", new()
    {
        Metadata = new[]
        {
            
            {
                { "name", "terraform-example-namespace" },
            },
        },
    });

});

    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.GetContainerClusterConfigArgs;
import com.pulumi.kubernetes.kubernetes_namespace;
import com.pulumi.kubernetes.Kubernetes_namespaceArgs;
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.getContainerClusterConfig(GetContainerClusterConfigArgs.builder()
            .clusterNameId("FOO")
            .admin(true)
            .build());

        var example = new Kubernetes_namespace("example", Kubernetes_namespaceArgs.builder()
            .metadata(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
            .build());

    }
}

    resources:
  example:
    type: kubernetes:kubernetes_namespace
    properties:
      metadata:
        - name: terraform-example-namespace
variables:
  clusterFoo:
    fn::invoke:
      function: ibm:getContainerClusterConfig
      arguments:
        clusterNameId: FOO
        admin: true

    3

    Example for connecting to Kubernetes provider for classic or VPC Kubernetes cluster with host and token.

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

const clusterFoo = ibm.getContainerClusterConfig({
    clusterNameId: "FOO",
});
const example = new kubernetes.index.Kubernetes_namespace("example", {metadata: [{
    name: "terraform-example-namespace",
}]});

    import pulumi
import pulumi_ibm as ibm
import pulumi_kubernetes as kubernetes

cluster_foo = ibm.get_container_cluster_config(cluster_name_id="FOO")
example = kubernetes.index.Kubernetes_namespace("example", metadata=[{
    name: terraform-example-namespace,
}])

    package main

import (
	"github.com/pulumi/pulumi-kubernetes/sdk/go/kubernetes"
	"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.GetContainerClusterConfig(ctx, &ibm.GetContainerClusterConfigArgs{
			ClusterNameId: "FOO",
		}, nil)
		if err != nil {
			return err
		}
		_, err = kubernetes.NewKubernetes_namespace(ctx, "example", &kubernetes.Kubernetes_namespaceArgs{
			Metadata: []map[string]interface{}{
				map[string]interface{}{
					"name": "terraform-example-namespace",
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var clusterFoo = Ibm.GetContainerClusterConfig.Invoke(new()
    {
        ClusterNameId = "FOO",
    });

    var example = new Kubernetes.Index.Kubernetes_namespace("example", new()
    {
        Metadata = new[]
        {
            
            {
                { "name", "terraform-example-namespace" },
            },
        },
    });

});

    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.GetContainerClusterConfigArgs;
import com.pulumi.kubernetes.kubernetes_namespace;
import com.pulumi.kubernetes.Kubernetes_namespaceArgs;
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.getContainerClusterConfig(GetContainerClusterConfigArgs.builder()
            .clusterNameId("FOO")
            .build());

        var example = new Kubernetes_namespace("example", Kubernetes_namespaceArgs.builder()
            .metadata(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
            .build());

    }
}

    resources:
  example:
    type: kubernetes:kubernetes_namespace
    properties:
      metadata:
        - name: terraform-example-namespace
variables:
  clusterFoo:
    fn::invoke:
      function: ibm:getContainerClusterConfig
      arguments:
        clusterNameId: FOO

    4

    Example for connecting to Kubernetes provider for classic OpenShift cluster with admin certificates.

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

const clusterFoo = ibm.getContainerClusterConfig({
    clusterNameId: "FOO",
    admin: true,
});
const example = new kubernetes.index.Kubernetes_namespace("example", {metadata: [{
    name: "terraform-example-namespace",
}]});

    import pulumi
import pulumi_ibm as ibm
import pulumi_kubernetes as kubernetes

cluster_foo = ibm.get_container_cluster_config(cluster_name_id="FOO",
    admin=True)
example = kubernetes.index.Kubernetes_namespace("example", metadata=[{
    name: terraform-example-namespace,
}])

    package main

import (
	"github.com/pulumi/pulumi-kubernetes/sdk/go/kubernetes"
	"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.GetContainerClusterConfig(ctx, &ibm.GetContainerClusterConfigArgs{
			ClusterNameId: "FOO",
			Admin:         pulumi.BoolRef(true),
		}, nil)
		if err != nil {
			return err
		}
		_, err = kubernetes.NewKubernetes_namespace(ctx, "example", &kubernetes.Kubernetes_namespaceArgs{
			Metadata: []map[string]interface{}{
				map[string]interface{}{
					"name": "terraform-example-namespace",
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var clusterFoo = Ibm.GetContainerClusterConfig.Invoke(new()
    {
        ClusterNameId = "FOO",
        Admin = true,
    });

    var example = new Kubernetes.Index.Kubernetes_namespace("example", new()
    {
        Metadata = new[]
        {
            
            {
                { "name", "terraform-example-namespace" },
            },
        },
    });

});

    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.GetContainerClusterConfigArgs;
import com.pulumi.kubernetes.kubernetes_namespace;
import com.pulumi.kubernetes.Kubernetes_namespaceArgs;
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.getContainerClusterConfig(GetContainerClusterConfigArgs.builder()
            .clusterNameId("FOO")
            .admin(true)
            .build());

        var example = new Kubernetes_namespace("example", Kubernetes_namespaceArgs.builder()
            .metadata(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
            .build());

    }
}

    resources:
  example:
    type: kubernetes:kubernetes_namespace
    properties:
      metadata:
        - name: terraform-example-namespace
variables:
  clusterFoo:
    fn::invoke:
      function: ibm:getContainerClusterConfig
      arguments:
        clusterNameId: FOO
        admin: true

    5

    Example usage for connecting to Kubernetes provider for classic OpenShift cluster with host and token.

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

const clusterFoo = ibm.getContainerClusterConfig({
    clusterNameId: "FOO",
});
const example = new kubernetes.index.Kubernetes_namespace("example", {metadata: [{
    name: "terraform-example-namespace",
}]});

    import pulumi
import pulumi_ibm as ibm
import pulumi_kubernetes as kubernetes

cluster_foo = ibm.get_container_cluster_config(cluster_name_id="FOO")
example = kubernetes.index.Kubernetes_namespace("example", metadata=[{
    name: terraform-example-namespace,
}])

    package main

import (
	"github.com/pulumi/pulumi-kubernetes/sdk/go/kubernetes"
	"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.GetContainerClusterConfig(ctx, &ibm.GetContainerClusterConfigArgs{
			ClusterNameId: "FOO",
		}, nil)
		if err != nil {
			return err
		}
		_, err = kubernetes.NewKubernetes_namespace(ctx, "example", &kubernetes.Kubernetes_namespaceArgs{
			Metadata: []map[string]interface{}{
				map[string]interface{}{
					"name": "terraform-example-namespace",
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var clusterFoo = Ibm.GetContainerClusterConfig.Invoke(new()
    {
        ClusterNameId = "FOO",
    });

    var example = new Kubernetes.Index.Kubernetes_namespace("example", new()
    {
        Metadata = new[]
        {
            
            {
                { "name", "terraform-example-namespace" },
            },
        },
    });

});

    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.GetContainerClusterConfigArgs;
import com.pulumi.kubernetes.kubernetes_namespace;
import com.pulumi.kubernetes.Kubernetes_namespaceArgs;
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.getContainerClusterConfig(GetContainerClusterConfigArgs.builder()
            .clusterNameId("FOO")
            .build());

        var example = new Kubernetes_namespace("example", Kubernetes_namespaceArgs.builder()
            .metadata(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
            .build());

    }
}

    resources:
  example:
    type: kubernetes:kubernetes_namespace
    properties:
      metadata:
        - name: terraform-example-namespace
variables:
  clusterFoo:
    fn::invoke:
      function: ibm:getContainerClusterConfig
      arguments:
        clusterNameId: FOO

    6

    Example for getting kubeconfig for VPC Kubernetes cluster with admin certificates and with VPE Gateway as server URL

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    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.GetContainerClusterConfigArgs;
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.getContainerClusterConfig(GetContainerClusterConfigArgs.builder()
            .admint("true")
            .clusterNameId("FOO")
            .configDir("/home/foo_config")
            .endpointType("vpe")
            .build());

    }
}

    variables:
  clusterFoo:
    fn::invoke:
      function: ibm:getContainerClusterConfig
      arguments:
        admint: 'true'
        clusterNameId: FOO
        configDir: /home/foo_config
        endpointType: vpe

    Using getContainerClusterConfig

    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 getContainerClusterConfig(args: GetContainerClusterConfigArgs, opts?: InvokeOptions): Promise<GetContainerClusterConfigResult>
function getContainerClusterConfigOutput(args: GetContainerClusterConfigOutputArgs, opts?: InvokeOptions): Output<GetContainerClusterConfigResult>
    def get_container_cluster_config(account_guid: Optional[str] = None,
                                 admin: Optional[bool] = None,
                                 cluster_name_id: Optional[str] = None,
                                 config_dir: Optional[str] = None,
                                 download: Optional[bool] = None,
                                 endpoint_type: Optional[str] = None,
                                 id: Optional[str] = None,
                                 network: Optional[bool] = None,
                                 org_guid: Optional[str] = None,
                                 region: Optional[str] = None,
                                 resource_group_id: Optional[str] = None,
                                 space_guid: Optional[str] = None,
                                 opts: Optional[InvokeOptions] = None) -> GetContainerClusterConfigResult
def get_container_cluster_config_output(account_guid: Optional[pulumi.Input[str]] = None,
                                 admin: Optional[pulumi.Input[bool]] = None,
                                 cluster_name_id: Optional[pulumi.Input[str]] = None,
                                 config_dir: Optional[pulumi.Input[str]] = None,
                                 download: Optional[pulumi.Input[bool]] = None,
                                 endpoint_type: Optional[pulumi.Input[str]] = None,
                                 id: Optional[pulumi.Input[str]] = None,
                                 network: Optional[pulumi.Input[bool]] = 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,
                                 opts: Optional[InvokeOptions] = None) -> Output[GetContainerClusterConfigResult]
    func GetContainerClusterConfig(ctx *Context, args *GetContainerClusterConfigArgs, opts ...InvokeOption) (*GetContainerClusterConfigResult, error)
func GetContainerClusterConfigOutput(ctx *Context, args *GetContainerClusterConfigOutputArgs, opts ...InvokeOption) GetContainerClusterConfigResultOutput

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

    public static class GetContainerClusterConfig 
{
    public static Task<GetContainerClusterConfigResult> InvokeAsync(GetContainerClusterConfigArgs args, InvokeOptions? opts = null)
    public static Output<GetContainerClusterConfigResult> Invoke(GetContainerClusterConfigInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetContainerClusterConfigResult> getContainerClusterConfig(GetContainerClusterConfigArgs args, InvokeOptions options)
public static Output<GetContainerClusterConfigResult> getContainerClusterConfig(GetContainerClusterConfigArgs args, InvokeOptions options)

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

    The following arguments are supported:

    ClusterNameId string
    The name or ID of the cluster that you want to log in to.
    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

    Admin bool
    If set to true, the Kubernetes configuration for cluster administrators is downloaded. The default is false.
    ConfigDir string
    The directory on your local machine where you want to download the Kubernetes config files and certificates.
    Download bool
    Set the value to false to skip downloading the configuration for the administrator. The default value is true. The configuration files and certificates are downloaded to the directory that you specified in config_dir every time that you run your infrastructure code.
    EndpointType string

    The server URL for the cluster context. If you do not include this parameter, the default cluster service endpoint is used. Available options: private, link (Satellite), vpe (VPC). For Satellite clusters, the link endpoint is the default. When the public service endpoint is disabled in Red Hat OpenShift on IBM Cloud clusters, the endpoint_type parameter will also influence the communication method used by the provider plugin with the cluster when generating the cluster config. If you set it to private, the plugin will utilize the cluster's Private Service Endpoint URL for communication, while setting it to vpe will make it use the cluster's Virtual Private Endpoint gateway URL for communication purposes.

    Deprecated reference

    Id string
    (String) The unique identifier of the cluster configuration.
    Network bool
    If set to true, the Calico configuration file, TLS certificates, and permission files that are required to run calicoctl commands in your cluster are downloaded in addition to the configuration files for the administrator. The default value is false.
    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 --guid command in the IBM Cloud CLI.

    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 find the resource group, run ibmcloud resource groups or use the ibm.ResourceGroup data source. If this parameter is not provided, the default resource group is used.
    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

    ClusterNameId string
    The name or ID of the cluster that you want to log in to.
    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

    Admin bool
    If set to true, the Kubernetes configuration for cluster administrators is downloaded. The default is false.
    ConfigDir string
    The directory on your local machine where you want to download the Kubernetes config files and certificates.
    Download bool
    Set the value to false to skip downloading the configuration for the administrator. The default value is true. The configuration files and certificates are downloaded to the directory that you specified in config_dir every time that you run your infrastructure code.
    EndpointType string

    The server URL for the cluster context. If you do not include this parameter, the default cluster service endpoint is used. Available options: private, link (Satellite), vpe (VPC). For Satellite clusters, the link endpoint is the default. When the public service endpoint is disabled in Red Hat OpenShift on IBM Cloud clusters, the endpoint_type parameter will also influence the communication method used by the provider plugin with the cluster when generating the cluster config. If you set it to private, the plugin will utilize the cluster's Private Service Endpoint URL for communication, while setting it to vpe will make it use the cluster's Virtual Private Endpoint gateway URL for communication purposes.

    Deprecated reference

    Id string
    (String) The unique identifier of the cluster configuration.
    Network bool
    If set to true, the Calico configuration file, TLS certificates, and permission files that are required to run calicoctl commands in your cluster are downloaded in addition to the configuration files for the administrator. The default value is false.
    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 --guid command in the IBM Cloud CLI.

    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 find the resource group, run ibmcloud resource groups or use the ibm.ResourceGroup data source. If this parameter is not provided, the default resource group is used.
    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

    clusterNameId String
    The name or ID of the cluster that you want to log in to.
    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

    admin Boolean
    If set to true, the Kubernetes configuration for cluster administrators is downloaded. The default is false.
    configDir String
    The directory on your local machine where you want to download the Kubernetes config files and certificates.
    download Boolean
    Set the value to false to skip downloading the configuration for the administrator. The default value is true. The configuration files and certificates are downloaded to the directory that you specified in config_dir every time that you run your infrastructure code.
    endpointType String

    The server URL for the cluster context. If you do not include this parameter, the default cluster service endpoint is used. Available options: private, link (Satellite), vpe (VPC). For Satellite clusters, the link endpoint is the default. When the public service endpoint is disabled in Red Hat OpenShift on IBM Cloud clusters, the endpoint_type parameter will also influence the communication method used by the provider plugin with the cluster when generating the cluster config. If you set it to private, the plugin will utilize the cluster's Private Service Endpoint URL for communication, while setting it to vpe will make it use the cluster's Virtual Private Endpoint gateway URL for communication purposes.

    Deprecated reference

    id String
    (String) The unique identifier of the cluster configuration.
    network Boolean
    If set to true, the Calico configuration file, TLS certificates, and permission files that are required to run calicoctl commands in your cluster are downloaded in addition to the configuration files for the administrator. The default value is false.
    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 --guid command in the IBM Cloud CLI.

    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 find the resource group, run ibmcloud resource groups or use the ibm.ResourceGroup data source. If this parameter is not provided, the default resource group is used.
    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

    clusterNameId string
    The name or ID of the cluster that you want to log in to.
    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

    admin boolean
    If set to true, the Kubernetes configuration for cluster administrators is downloaded. The default is false.
    configDir string
    The directory on your local machine where you want to download the Kubernetes config files and certificates.
    download boolean
    Set the value to false to skip downloading the configuration for the administrator. The default value is true. The configuration files and certificates are downloaded to the directory that you specified in config_dir every time that you run your infrastructure code.
    endpointType string

    The server URL for the cluster context. If you do not include this parameter, the default cluster service endpoint is used. Available options: private, link (Satellite), vpe (VPC). For Satellite clusters, the link endpoint is the default. When the public service endpoint is disabled in Red Hat OpenShift on IBM Cloud clusters, the endpoint_type parameter will also influence the communication method used by the provider plugin with the cluster when generating the cluster config. If you set it to private, the plugin will utilize the cluster's Private Service Endpoint URL for communication, while setting it to vpe will make it use the cluster's Virtual Private Endpoint gateway URL for communication purposes.

    Deprecated reference

    id string
    (String) The unique identifier of the cluster configuration.
    network boolean
    If set to true, the Calico configuration file, TLS certificates, and permission files that are required to run calicoctl commands in your cluster are downloaded in addition to the configuration files for the administrator. The default value is false.
    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 --guid command in the IBM Cloud CLI.

    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 find the resource group, run ibmcloud resource groups or use the ibm.ResourceGroup data source. If this parameter is not provided, the default resource group is used.
    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

    cluster_name_id str
    The name or ID of the cluster that you want to log in to.
    account_guid str
    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

    admin bool
    If set to true, the Kubernetes configuration for cluster administrators is downloaded. The default is false.
    config_dir str
    The directory on your local machine where you want to download the Kubernetes config files and certificates.
    download bool
    Set the value to false to skip downloading the configuration for the administrator. The default value is true. The configuration files and certificates are downloaded to the directory that you specified in config_dir every time that you run your infrastructure code.
    endpoint_type str

    The server URL for the cluster context. If you do not include this parameter, the default cluster service endpoint is used. Available options: private, link (Satellite), vpe (VPC). For Satellite clusters, the link endpoint is the default. When the public service endpoint is disabled in Red Hat OpenShift on IBM Cloud clusters, the endpoint_type parameter will also influence the communication method used by the provider plugin with the cluster when generating the cluster config. If you set it to private, the plugin will utilize the cluster's Private Service Endpoint URL for communication, while setting it to vpe will make it use the cluster's Virtual Private Endpoint gateway URL for communication purposes.

    Deprecated reference

    id str
    (String) The unique identifier of the cluster configuration.
    network bool
    If set to true, the Calico configuration file, TLS certificates, and permission files that are required to run calicoctl commands in your cluster are downloaded in addition to the configuration files for the administrator. The default value is false.
    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 --guid command in the IBM Cloud CLI.

    Deprecated: Deprecated

    region str
    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

    resource_group_id str
    The ID of the resource group where your cluster is provisioned into. To find the resource group, run ibmcloud resource groups or use the ibm.ResourceGroup data source. If this parameter is not provided, the default resource group is used.
    space_guid str
    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

    clusterNameId String
    The name or ID of the cluster that you want to log in to.
    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

    admin Boolean
    If set to true, the Kubernetes configuration for cluster administrators is downloaded. The default is false.
    configDir String
    The directory on your local machine where you want to download the Kubernetes config files and certificates.
    download Boolean
    Set the value to false to skip downloading the configuration for the administrator. The default value is true. The configuration files and certificates are downloaded to the directory that you specified in config_dir every time that you run your infrastructure code.
    endpointType String

    The server URL for the cluster context. If you do not include this parameter, the default cluster service endpoint is used. Available options: private, link (Satellite), vpe (VPC). For Satellite clusters, the link endpoint is the default. When the public service endpoint is disabled in Red Hat OpenShift on IBM Cloud clusters, the endpoint_type parameter will also influence the communication method used by the provider plugin with the cluster when generating the cluster config. If you set it to private, the plugin will utilize the cluster's Private Service Endpoint URL for communication, while setting it to vpe will make it use the cluster's Virtual Private Endpoint gateway URL for communication purposes.

    Deprecated reference

    id String
    (String) The unique identifier of the cluster configuration.
    network Boolean
    If set to true, the Calico configuration file, TLS certificates, and permission files that are required to run calicoctl commands in your cluster are downloaded in addition to the configuration files for the administrator. The default value is false.
    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 --guid command in the IBM Cloud CLI.

    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 find the resource group, run ibmcloud resource groups or use the ibm.ResourceGroup data source. If this parameter is not provided, the default resource group is used.
    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

    getContainerClusterConfig Result

    The following output properties are available:

    AdminCertificate string
    (String) The admin certificate of the cluster configuration.
    AdminKey string
    (String) The admin key of the cluster configuration. Note that this key is case-sensitive.
    CaCertificate string
    (String) The cluster CA certificate of the cluster configuration.
    CalicoConfigFilePath string
    (String) The path on your local machine where your Calico configuration files and certificates are downloaded to.
    ClusterNameId string
    ConfigDir string
    ConfigFilePath string
    (String) The path on your local machine where the cluster configuration file and certificates are downloaded to.
    Host string
    (String) The host name of the cluster configuration.
    Id string
    (String) The unique identifier of the cluster configuration.
    Token string
    (String) The token of the cluster configuration.
    AccountGuid string

    Deprecated: Deprecated

    Admin bool
    Download bool
    EndpointType string
    Network bool
    OrgGuid string

    Deprecated: Deprecated

    Region string

    Deprecated: Deprecated

    ResourceGroupId string
    SpaceGuid string

    Deprecated: Deprecated

    AdminCertificate string
    (String) The admin certificate of the cluster configuration.
    AdminKey string
    (String) The admin key of the cluster configuration. Note that this key is case-sensitive.
    CaCertificate string
    (String) The cluster CA certificate of the cluster configuration.
    CalicoConfigFilePath string
    (String) The path on your local machine where your Calico configuration files and certificates are downloaded to.
    ClusterNameId string
    ConfigDir string
    ConfigFilePath string
    (String) The path on your local machine where the cluster configuration file and certificates are downloaded to.
    Host string
    (String) The host name of the cluster configuration.
    Id string
    (String) The unique identifier of the cluster configuration.
    Token string
    (String) The token of the cluster configuration.
    AccountGuid string

    Deprecated: Deprecated

    Admin bool
    Download bool
    EndpointType string
    Network bool
    OrgGuid string

    Deprecated: Deprecated

    Region string

    Deprecated: Deprecated

    ResourceGroupId string
    SpaceGuid string

    Deprecated: Deprecated

    adminCertificate String
    (String) The admin certificate of the cluster configuration.
    adminKey String
    (String) The admin key of the cluster configuration. Note that this key is case-sensitive.
    caCertificate String
    (String) The cluster CA certificate of the cluster configuration.
    calicoConfigFilePath String
    (String) The path on your local machine where your Calico configuration files and certificates are downloaded to.
    clusterNameId String
    configDir String
    configFilePath String
    (String) The path on your local machine where the cluster configuration file and certificates are downloaded to.
    host String
    (String) The host name of the cluster configuration.
    id String
    (String) The unique identifier of the cluster configuration.
    token String
    (String) The token of the cluster configuration.
    accountGuid String

    Deprecated: Deprecated

    admin Boolean
    download Boolean
    endpointType String
    network Boolean
    orgGuid String

    Deprecated: Deprecated

    region String

    Deprecated: Deprecated

    resourceGroupId String
    spaceGuid String

    Deprecated: Deprecated

    adminCertificate string
    (String) The admin certificate of the cluster configuration.
    adminKey string
    (String) The admin key of the cluster configuration. Note that this key is case-sensitive.
    caCertificate string
    (String) The cluster CA certificate of the cluster configuration.
    calicoConfigFilePath string
    (String) The path on your local machine where your Calico configuration files and certificates are downloaded to.
    clusterNameId string
    configDir string
    configFilePath string
    (String) The path on your local machine where the cluster configuration file and certificates are downloaded to.
    host string
    (String) The host name of the cluster configuration.
    id string
    (String) The unique identifier of the cluster configuration.
    token string
    (String) The token of the cluster configuration.
    accountGuid string

    Deprecated: Deprecated

    admin boolean
    download boolean
    endpointType string
    network boolean
    orgGuid string

    Deprecated: Deprecated

    region string

    Deprecated: Deprecated

    resourceGroupId string
    spaceGuid string

    Deprecated: Deprecated

    admin_certificate str
    (String) The admin certificate of the cluster configuration.
    admin_key str
    (String) The admin key of the cluster configuration. Note that this key is case-sensitive.
    ca_certificate str
    (String) The cluster CA certificate of the cluster configuration.
    calico_config_file_path str
    (String) The path on your local machine where your Calico configuration files and certificates are downloaded to.
    cluster_name_id str
    config_dir str
    config_file_path str
    (String) The path on your local machine where the cluster configuration file and certificates are downloaded to.
    host str
    (String) The host name of the cluster configuration.
    id str
    (String) The unique identifier of the cluster configuration.
    token str
    (String) The token of the cluster configuration.
    account_guid str

    Deprecated: Deprecated

    admin bool
    download bool
    endpoint_type str
    network bool
    org_guid str

    Deprecated: Deprecated

    region str

    Deprecated: Deprecated

    resource_group_id str
    space_guid str

    Deprecated: Deprecated

    adminCertificate String
    (String) The admin certificate of the cluster configuration.
    adminKey String
    (String) The admin key of the cluster configuration. Note that this key is case-sensitive.
    caCertificate String
    (String) The cluster CA certificate of the cluster configuration.
    calicoConfigFilePath String
    (String) The path on your local machine where your Calico configuration files and certificates are downloaded to.
    clusterNameId String
    configDir String
    configFilePath String
    (String) The path on your local machine where the cluster configuration file and certificates are downloaded to.
    host String
    (String) The host name of the cluster configuration.
    id String
    (String) The unique identifier of the cluster configuration.
    token String
    (String) The token of the cluster configuration.
    accountGuid String

    Deprecated: Deprecated

    admin Boolean
    download Boolean
    endpointType String
    network Boolean
    orgGuid String

    Deprecated: Deprecated

    region String

    Deprecated: Deprecated

    resourceGroupId String
    spaceGuid String

    Deprecated: Deprecated

    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