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

ibm.ContainerBindService

Explore with Pulumi AI

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

    [!CAUTION] This resource will be deprecated, please check this guide on how to bind services.

    Bind an IBM Cloud service to an IBM Cloud Kubernetes Service cluster. Service binding is a quick way to create service credentials for an IBM Cloud service by using its public service endpoint and storing these credentials in a Kubernetes secret in your cluster. The Kubernetes secret is automatically encrypted in etcd to protect your data.

    To bind a service to your cluster, you must provision an instance of the service first. For more information, about service binding, see Adding services by using IBM Cloud service binding.

    Example Usage

    In the following example, you can bind a service to a cluster:

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

const bindService = new ibm.ContainerBindService("bindService", {
    clusterNameId: "cluster_name",
    namespaceId: "default",
    serviceInstanceName: "service_name",
});

    import pulumi
import pulumi_ibm as ibm

bind_service = ibm.ContainerBindService("bindService",
    cluster_name_id="cluster_name",
    namespace_id="default",
    service_instance_name="service_name")

    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.NewContainerBindService(ctx, "bindService", &ibm.ContainerBindServiceArgs{
			ClusterNameId:       pulumi.String("cluster_name"),
			NamespaceId:         pulumi.String("default"),
			ServiceInstanceName: pulumi.String("service_name"),
		})
		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 bindService = new Ibm.ContainerBindService("bindService", new()
    {
        ClusterNameId = "cluster_name",
        NamespaceId = "default",
        ServiceInstanceName = "service_name",
    });

});

    package generated_program;

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

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

    public static void stack(Context ctx) {
        var bindService = new ContainerBindService("bindService", ContainerBindServiceArgs.builder()
            .clusterNameId("cluster_name")
            .namespaceId("default")
            .serviceInstanceName("service_name")
            .build());

    }
}

    resources:
  bindService:
    type: ibm:ContainerBindService
    properties:
      clusterNameId: cluster_name
      namespaceId: default
      serviceInstanceName: service_name

    Create ContainerBindService Resource

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

    Constructor syntax

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

@overload
def ContainerBindService(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         namespace_id: Optional[str] = None,
                         cluster_name_id: Optional[str] = None,
                         region: Optional[str] = None,
                         key: Optional[str] = None,
                         container_bind_service_id: Optional[str] = None,
                         org_guid: Optional[str] = None,
                         account_guid: Optional[str] = None,
                         resource_group_id: Optional[str] = None,
                         role: Optional[str] = None,
                         service_instance_id: Optional[str] = None,
                         service_instance_name: Optional[str] = None,
                         space_guid: Optional[str] = None,
                         tags: Optional[Sequence[str]] = None)
    func NewContainerBindService(ctx *Context, name string, args ContainerBindServiceArgs, opts ...ResourceOption) (*ContainerBindService, error)
    public ContainerBindService(string name, ContainerBindServiceArgs args, CustomResourceOptions? opts = null)
    public ContainerBindService(String name, ContainerBindServiceArgs args)
public ContainerBindService(String name, ContainerBindServiceArgs args, CustomResourceOptions options)

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

    Parameters

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

    Constructor example

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

    var containerBindServiceResource = new Ibm.ContainerBindService("containerBindServiceResource", new()
{
    NamespaceId = "string",
    ClusterNameId = "string",
    Key = "string",
    ContainerBindServiceId = "string",
    ResourceGroupId = "string",
    Role = "string",
    ServiceInstanceId = "string",
    ServiceInstanceName = "string",
    Tags = new[]
    {
        "string",
    },
});

    example, err := ibm.NewContainerBindService(ctx, "containerBindServiceResource", &ibm.ContainerBindServiceArgs{
	NamespaceId:            pulumi.String("string"),
	ClusterNameId:          pulumi.String("string"),
	Key:                    pulumi.String("string"),
	ContainerBindServiceId: pulumi.String("string"),
	ResourceGroupId:        pulumi.String("string"),
	Role:                   pulumi.String("string"),
	ServiceInstanceId:      pulumi.String("string"),
	ServiceInstanceName:    pulumi.String("string"),
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    var containerBindServiceResource = new ContainerBindService("containerBindServiceResource", ContainerBindServiceArgs.builder()
    .namespaceId("string")
    .clusterNameId("string")
    .key("string")
    .containerBindServiceId("string")
    .resourceGroupId("string")
    .role("string")
    .serviceInstanceId("string")
    .serviceInstanceName("string")
    .tags("string")
    .build());

    container_bind_service_resource = ibm.ContainerBindService("containerBindServiceResource",
    namespace_id="string",
    cluster_name_id="string",
    key="string",
    container_bind_service_id="string",
    resource_group_id="string",
    role="string",
    service_instance_id="string",
    service_instance_name="string",
    tags=["string"])

    const containerBindServiceResource = new ibm.ContainerBindService("containerBindServiceResource", {
    namespaceId: "string",
    clusterNameId: "string",
    key: "string",
    containerBindServiceId: "string",
    resourceGroupId: "string",
    role: "string",
    serviceInstanceId: "string",
    serviceInstanceName: "string",
    tags: ["string"],
});

    type: ibm:ContainerBindService
properties:
    clusterNameId: string
    containerBindServiceId: string
    key: string
    namespaceId: string
    resourceGroupId: string
    role: string
    serviceInstanceId: string
    serviceInstanceName: string
    tags:
        - string

    ContainerBindService Resource Properties

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

    Inputs

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

    The ContainerBindService resource accepts the following input properties:

    ClusterNameId string
    The name or ID of the cluster to which you want to bind an IBM Cloud service. To find the cluster name or ID, run ibmcloud ks cluster ls.
    NamespaceId string
    The Kubernetes namespace where you want to create the Kubernetes secret that holds the service credentials of the service that you want to bind to the cluster.
    AccountGuid string
    The GUID for the IBM Cloud account associated with the cluster. You can retrieve the value from data source ibm.getAccount or by running the ibmcloud iam accounts command in the IBM Cloud CLI.

    Deprecated: Deprecated

    ContainerBindServiceId string
    (String) The unique identifier of the service bind resource in your cluster in the format <cluster_name_ID>/<service_instance_name> or <service_instance_id>/<namespace_id>.
    Key string
    The name or guid of existing service credentials that you want to use for the service. If you do not provide this option, service credentials are automatically created as part of the service binding process.
    OrgGuid string
    The GUID for the IBM Cloud organization associated with the cluster. You can retrieve the value from data source ibm.Org 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 IBM Cloud service is provisioned into. To list resource groups, run ibmcloud resource groups.
    Role string
    The IAM service access role that you want to use to create the service credentials for the IBM Cloud service instance. If you specified existing service credentials in the key parameter, settings for the role parameter are ignored.
    ServiceInstanceId string
    The ID of the service that you want to bind to the cluster. If you specify this parameter, do not specify service_instance_name at the same time.
    ServiceInstanceName string
    The name of the service that you want to bind to the cluster. If you specify this parameter, do not specify service_instance_id at the same time.
    SpaceGuid string
    The GUID for the IBM Cloud space associated with the cluster. You can retrieve the value from data source ibm.Space or by running the ibmcloud iam space <space-name> --guid command in the IBM Cloud CLI.

    Deprecated: Deprecated

    Tags List<string>

    A list of tags that you want to associate with the IBM Cloud service instance that you bind to the cluster. Note Tags are managed locally and are not stored on the IBM Cloud service endpoint.

    Deprecated reference

    ClusterNameId string
    The name or ID of the cluster to which you want to bind an IBM Cloud service. To find the cluster name or ID, run ibmcloud ks cluster ls.
    NamespaceId string
    The Kubernetes namespace where you want to create the Kubernetes secret that holds the service credentials of the service that you want to bind to the cluster.
    AccountGuid string
    The GUID for the IBM Cloud account associated with the cluster. You can retrieve the value from data source ibm.getAccount or by running the ibmcloud iam accounts command in the IBM Cloud CLI.

    Deprecated: Deprecated

    ContainerBindServiceId string
    (String) The unique identifier of the service bind resource in your cluster in the format <cluster_name_ID>/<service_instance_name> or <service_instance_id>/<namespace_id>.
    Key string
    The name or guid of existing service credentials that you want to use for the service. If you do not provide this option, service credentials are automatically created as part of the service binding process.
    OrgGuid string
    The GUID for the IBM Cloud organization associated with the cluster. You can retrieve the value from data source ibm.Org 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 IBM Cloud service is provisioned into. To list resource groups, run ibmcloud resource groups.
    Role string
    The IAM service access role that you want to use to create the service credentials for the IBM Cloud service instance. If you specified existing service credentials in the key parameter, settings for the role parameter are ignored.
    ServiceInstanceId string
    The ID of the service that you want to bind to the cluster. If you specify this parameter, do not specify service_instance_name at the same time.
    ServiceInstanceName string
    The name of the service that you want to bind to the cluster. If you specify this parameter, do not specify service_instance_id at the same time.
    SpaceGuid string
    The GUID for the IBM Cloud space associated with the cluster. You can retrieve the value from data source ibm.Space or by running the ibmcloud iam space <space-name> --guid command in the IBM Cloud CLI.

    Deprecated: Deprecated

    Tags []string

    A list of tags that you want to associate with the IBM Cloud service instance that you bind to the cluster. Note Tags are managed locally and are not stored on the IBM Cloud service endpoint.

    Deprecated reference

    clusterNameId String
    The name or ID of the cluster to which you want to bind an IBM Cloud service. To find the cluster name or ID, run ibmcloud ks cluster ls.
    namespaceId String
    The Kubernetes namespace where you want to create the Kubernetes secret that holds the service credentials of the service that you want to bind to the cluster.
    accountGuid String
    The GUID for the IBM Cloud account associated with the cluster. You can retrieve the value from data source ibm.getAccount or by running the ibmcloud iam accounts command in the IBM Cloud CLI.

    Deprecated: Deprecated

    containerBindServiceId String
    (String) The unique identifier of the service bind resource in your cluster in the format <cluster_name_ID>/<service_instance_name> or <service_instance_id>/<namespace_id>.
    key String
    The name or guid of existing service credentials that you want to use for the service. If you do not provide this option, service credentials are automatically created as part of the service binding process.
    orgGuid String
    The GUID for the IBM Cloud organization associated with the cluster. You can retrieve the value from data source ibm.Org 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 IBM Cloud service is provisioned into. To list resource groups, run ibmcloud resource groups.
    role String
    The IAM service access role that you want to use to create the service credentials for the IBM Cloud service instance. If you specified existing service credentials in the key parameter, settings for the role parameter are ignored.
    serviceInstanceId String
    The ID of the service that you want to bind to the cluster. If you specify this parameter, do not specify service_instance_name at the same time.
    serviceInstanceName String
    The name of the service that you want to bind to the cluster. If you specify this parameter, do not specify service_instance_id at the same time.
    spaceGuid String
    The GUID for the IBM Cloud space associated with the cluster. You can retrieve the value from data source ibm.Space or by running the ibmcloud iam space <space-name> --guid command in the IBM Cloud CLI.

    Deprecated: Deprecated

    tags List<String>

    A list of tags that you want to associate with the IBM Cloud service instance that you bind to the cluster. Note Tags are managed locally and are not stored on the IBM Cloud service endpoint.

    Deprecated reference

    clusterNameId string
    The name or ID of the cluster to which you want to bind an IBM Cloud service. To find the cluster name or ID, run ibmcloud ks cluster ls.
    namespaceId string
    The Kubernetes namespace where you want to create the Kubernetes secret that holds the service credentials of the service that you want to bind to the cluster.
    accountGuid string
    The GUID for the IBM Cloud account associated with the cluster. You can retrieve the value from data source ibm.getAccount or by running the ibmcloud iam accounts command in the IBM Cloud CLI.

    Deprecated: Deprecated

    containerBindServiceId string
    (String) The unique identifier of the service bind resource in your cluster in the format <cluster_name_ID>/<service_instance_name> or <service_instance_id>/<namespace_id>.
    key string
    The name or guid of existing service credentials that you want to use for the service. If you do not provide this option, service credentials are automatically created as part of the service binding process.
    orgGuid string
    The GUID for the IBM Cloud organization associated with the cluster. You can retrieve the value from data source ibm.Org 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 IBM Cloud service is provisioned into. To list resource groups, run ibmcloud resource groups.
    role string
    The IAM service access role that you want to use to create the service credentials for the IBM Cloud service instance. If you specified existing service credentials in the key parameter, settings for the role parameter are ignored.
    serviceInstanceId string
    The ID of the service that you want to bind to the cluster. If you specify this parameter, do not specify service_instance_name at the same time.
    serviceInstanceName string
    The name of the service that you want to bind to the cluster. If you specify this parameter, do not specify service_instance_id at the same time.
    spaceGuid string
    The GUID for the IBM Cloud space associated with the cluster. You can retrieve the value from data source ibm.Space or by running the ibmcloud iam space <space-name> --guid command in the IBM Cloud CLI.

    Deprecated: Deprecated

    tags string[]

    A list of tags that you want to associate with the IBM Cloud service instance that you bind to the cluster. Note Tags are managed locally and are not stored on the IBM Cloud service endpoint.

    Deprecated reference

    cluster_name_id str
    The name or ID of the cluster to which you want to bind an IBM Cloud service. To find the cluster name or ID, run ibmcloud ks cluster ls.
    namespace_id str
    The Kubernetes namespace where you want to create the Kubernetes secret that holds the service credentials of the service that you want to bind to the cluster.
    account_guid str
    The GUID for the IBM Cloud account associated with the cluster. You can retrieve the value from data source ibm.getAccount or by running the ibmcloud iam accounts command in the IBM Cloud CLI.

    Deprecated: Deprecated

    container_bind_service_id str
    (String) The unique identifier of the service bind resource in your cluster in the format <cluster_name_ID>/<service_instance_name> or <service_instance_id>/<namespace_id>.
    key str
    The name or guid of existing service credentials that you want to use for the service. If you do not provide this option, service credentials are automatically created as part of the service binding process.
    org_guid str
    The GUID for the IBM Cloud organization associated with the cluster. You can retrieve the value from data source ibm.Org 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 IBM Cloud service is provisioned into. To list resource groups, run ibmcloud resource groups.
    role str
    The IAM service access role that you want to use to create the service credentials for the IBM Cloud service instance. If you specified existing service credentials in the key parameter, settings for the role parameter are ignored.
    service_instance_id str
    The ID of the service that you want to bind to the cluster. If you specify this parameter, do not specify service_instance_name at the same time.
    service_instance_name str
    The name of the service that you want to bind to the cluster. If you specify this parameter, do not specify service_instance_id at the same time.
    space_guid str
    The GUID for the IBM Cloud space associated with the cluster. You can retrieve the value from data source ibm.Space or by running the ibmcloud iam space <space-name> --guid command in the IBM Cloud CLI.

    Deprecated: Deprecated

    tags Sequence[str]

    A list of tags that you want to associate with the IBM Cloud service instance that you bind to the cluster. Note Tags are managed locally and are not stored on the IBM Cloud service endpoint.

    Deprecated reference

    clusterNameId String
    The name or ID of the cluster to which you want to bind an IBM Cloud service. To find the cluster name or ID, run ibmcloud ks cluster ls.
    namespaceId String
    The Kubernetes namespace where you want to create the Kubernetes secret that holds the service credentials of the service that you want to bind to the cluster.
    accountGuid String
    The GUID for the IBM Cloud account associated with the cluster. You can retrieve the value from data source ibm.getAccount or by running the ibmcloud iam accounts command in the IBM Cloud CLI.

    Deprecated: Deprecated

    containerBindServiceId String
    (String) The unique identifier of the service bind resource in your cluster in the format <cluster_name_ID>/<service_instance_name> or <service_instance_id>/<namespace_id>.
    key String
    The name or guid of existing service credentials that you want to use for the service. If you do not provide this option, service credentials are automatically created as part of the service binding process.
    orgGuid String
    The GUID for the IBM Cloud organization associated with the cluster. You can retrieve the value from data source ibm.Org 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 IBM Cloud service is provisioned into. To list resource groups, run ibmcloud resource groups.
    role String
    The IAM service access role that you want to use to create the service credentials for the IBM Cloud service instance. If you specified existing service credentials in the key parameter, settings for the role parameter are ignored.
    serviceInstanceId String
    The ID of the service that you want to bind to the cluster. If you specify this parameter, do not specify service_instance_name at the same time.
    serviceInstanceName String
    The name of the service that you want to bind to the cluster. If you specify this parameter, do not specify service_instance_id at the same time.
    spaceGuid String
    The GUID for the IBM Cloud space associated with the cluster. You can retrieve the value from data source ibm.Space or by running the ibmcloud iam space <space-name> --guid command in the IBM Cloud CLI.

    Deprecated: Deprecated

    tags List<String>

    A list of tags that you want to associate with the IBM Cloud service instance that you bind to the cluster. Note Tags are managed locally and are not stored on the IBM Cloud service endpoint.

    Deprecated reference

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing ContainerBindService Resource

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

    public static get(name: string, id: Input<ID>, state?: ContainerBindServiceState, opts?: CustomResourceOptions): ContainerBindService
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account_guid: Optional[str] = None,
        cluster_name_id: Optional[str] = None,
        container_bind_service_id: Optional[str] = None,
        key: Optional[str] = None,
        namespace_id: Optional[str] = None,
        org_guid: Optional[str] = None,
        region: Optional[str] = None,
        resource_group_id: Optional[str] = None,
        role: Optional[str] = None,
        service_instance_id: Optional[str] = None,
        service_instance_name: Optional[str] = None,
        space_guid: Optional[str] = None,
        tags: Optional[Sequence[str]] = None) -> ContainerBindService
    func GetContainerBindService(ctx *Context, name string, id IDInput, state *ContainerBindServiceState, opts ...ResourceOption) (*ContainerBindService, error)
    public static ContainerBindService Get(string name, Input<string> id, ContainerBindServiceState? state, CustomResourceOptions? opts = null)
    public static ContainerBindService get(String name, Output<String> id, ContainerBindServiceState state, CustomResourceOptions options)
    resources:  _:    type: ibm:ContainerBindService    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AccountGuid string
    The GUID for the IBM Cloud account associated with the cluster. You can retrieve the value from data source ibm.getAccount or by running the ibmcloud iam accounts command in the IBM Cloud CLI.

    Deprecated: Deprecated

    ClusterNameId string
    The name or ID of the cluster to which you want to bind an IBM Cloud service. To find the cluster name or ID, run ibmcloud ks cluster ls.
    ContainerBindServiceId string
    (String) The unique identifier of the service bind resource in your cluster in the format <cluster_name_ID>/<service_instance_name> or <service_instance_id>/<namespace_id>.
    Key string
    The name or guid of existing service credentials that you want to use for the service. If you do not provide this option, service credentials are automatically created as part of the service binding process.
    NamespaceId string
    The Kubernetes namespace where you want to create the Kubernetes secret that holds the service credentials of the service that you want to bind to the cluster.
    OrgGuid string
    The GUID for the IBM Cloud organization associated with the cluster. You can retrieve the value from data source ibm.Org 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 IBM Cloud service is provisioned into. To list resource groups, run ibmcloud resource groups.
    Role string
    The IAM service access role that you want to use to create the service credentials for the IBM Cloud service instance. If you specified existing service credentials in the key parameter, settings for the role parameter are ignored.
    ServiceInstanceId string
    The ID of the service that you want to bind to the cluster. If you specify this parameter, do not specify service_instance_name at the same time.
    ServiceInstanceName string
    The name of the service that you want to bind to the cluster. If you specify this parameter, do not specify service_instance_id at the same time.
    SpaceGuid string
    The GUID for the IBM Cloud space associated with the cluster. You can retrieve the value from data source ibm.Space or by running the ibmcloud iam space <space-name> --guid command in the IBM Cloud CLI.

    Deprecated: Deprecated

    Tags List<string>

    A list of tags that you want to associate with the IBM Cloud service instance that you bind to the cluster. Note Tags are managed locally and are not stored on the IBM Cloud service endpoint.

    Deprecated reference

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

    Deprecated: Deprecated

    ClusterNameId string
    The name or ID of the cluster to which you want to bind an IBM Cloud service. To find the cluster name or ID, run ibmcloud ks cluster ls.
    ContainerBindServiceId string
    (String) The unique identifier of the service bind resource in your cluster in the format <cluster_name_ID>/<service_instance_name> or <service_instance_id>/<namespace_id>.
    Key string
    The name or guid of existing service credentials that you want to use for the service. If you do not provide this option, service credentials are automatically created as part of the service binding process.
    NamespaceId string
    The Kubernetes namespace where you want to create the Kubernetes secret that holds the service credentials of the service that you want to bind to the cluster.
    OrgGuid string
    The GUID for the IBM Cloud organization associated with the cluster. You can retrieve the value from data source ibm.Org 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 IBM Cloud service is provisioned into. To list resource groups, run ibmcloud resource groups.
    Role string
    The IAM service access role that you want to use to create the service credentials for the IBM Cloud service instance. If you specified existing service credentials in the key parameter, settings for the role parameter are ignored.
    ServiceInstanceId string
    The ID of the service that you want to bind to the cluster. If you specify this parameter, do not specify service_instance_name at the same time.
    ServiceInstanceName string
    The name of the service that you want to bind to the cluster. If you specify this parameter, do not specify service_instance_id at the same time.
    SpaceGuid string
    The GUID for the IBM Cloud space associated with the cluster. You can retrieve the value from data source ibm.Space or by running the ibmcloud iam space <space-name> --guid command in the IBM Cloud CLI.

    Deprecated: Deprecated

    Tags []string

    A list of tags that you want to associate with the IBM Cloud service instance that you bind to the cluster. Note Tags are managed locally and are not stored on the IBM Cloud service endpoint.

    Deprecated reference

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

    Deprecated: Deprecated

    clusterNameId String
    The name or ID of the cluster to which you want to bind an IBM Cloud service. To find the cluster name or ID, run ibmcloud ks cluster ls.
    containerBindServiceId String
    (String) The unique identifier of the service bind resource in your cluster in the format <cluster_name_ID>/<service_instance_name> or <service_instance_id>/<namespace_id>.
    key String
    The name or guid of existing service credentials that you want to use for the service. If you do not provide this option, service credentials are automatically created as part of the service binding process.
    namespaceId String
    The Kubernetes namespace where you want to create the Kubernetes secret that holds the service credentials of the service that you want to bind to the cluster.
    orgGuid String
    The GUID for the IBM Cloud organization associated with the cluster. You can retrieve the value from data source ibm.Org 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 IBM Cloud service is provisioned into. To list resource groups, run ibmcloud resource groups.
    role String
    The IAM service access role that you want to use to create the service credentials for the IBM Cloud service instance. If you specified existing service credentials in the key parameter, settings for the role parameter are ignored.
    serviceInstanceId String
    The ID of the service that you want to bind to the cluster. If you specify this parameter, do not specify service_instance_name at the same time.
    serviceInstanceName String
    The name of the service that you want to bind to the cluster. If you specify this parameter, do not specify service_instance_id at the same time.
    spaceGuid String
    The GUID for the IBM Cloud space associated with the cluster. You can retrieve the value from data source ibm.Space or by running the ibmcloud iam space <space-name> --guid command in the IBM Cloud CLI.

    Deprecated: Deprecated

    tags List<String>

    A list of tags that you want to associate with the IBM Cloud service instance that you bind to the cluster. Note Tags are managed locally and are not stored on the IBM Cloud service endpoint.

    Deprecated reference

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

    Deprecated: Deprecated

    clusterNameId string
    The name or ID of the cluster to which you want to bind an IBM Cloud service. To find the cluster name or ID, run ibmcloud ks cluster ls.
    containerBindServiceId string
    (String) The unique identifier of the service bind resource in your cluster in the format <cluster_name_ID>/<service_instance_name> or <service_instance_id>/<namespace_id>.
    key string
    The name or guid of existing service credentials that you want to use for the service. If you do not provide this option, service credentials are automatically created as part of the service binding process.
    namespaceId string
    The Kubernetes namespace where you want to create the Kubernetes secret that holds the service credentials of the service that you want to bind to the cluster.
    orgGuid string
    The GUID for the IBM Cloud organization associated with the cluster. You can retrieve the value from data source ibm.Org 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 IBM Cloud service is provisioned into. To list resource groups, run ibmcloud resource groups.
    role string
    The IAM service access role that you want to use to create the service credentials for the IBM Cloud service instance. If you specified existing service credentials in the key parameter, settings for the role parameter are ignored.
    serviceInstanceId string
    The ID of the service that you want to bind to the cluster. If you specify this parameter, do not specify service_instance_name at the same time.
    serviceInstanceName string
    The name of the service that you want to bind to the cluster. If you specify this parameter, do not specify service_instance_id at the same time.
    spaceGuid string
    The GUID for the IBM Cloud space associated with the cluster. You can retrieve the value from data source ibm.Space or by running the ibmcloud iam space <space-name> --guid command in the IBM Cloud CLI.

    Deprecated: Deprecated

    tags string[]

    A list of tags that you want to associate with the IBM Cloud service instance that you bind to the cluster. Note Tags are managed locally and are not stored on the IBM Cloud service endpoint.

    Deprecated reference

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

    Deprecated: Deprecated

    cluster_name_id str
    The name or ID of the cluster to which you want to bind an IBM Cloud service. To find the cluster name or ID, run ibmcloud ks cluster ls.
    container_bind_service_id str
    (String) The unique identifier of the service bind resource in your cluster in the format <cluster_name_ID>/<service_instance_name> or <service_instance_id>/<namespace_id>.
    key str
    The name or guid of existing service credentials that you want to use for the service. If you do not provide this option, service credentials are automatically created as part of the service binding process.
    namespace_id str
    The Kubernetes namespace where you want to create the Kubernetes secret that holds the service credentials of the service that you want to bind to the cluster.
    org_guid str
    The GUID for the IBM Cloud organization associated with the cluster. You can retrieve the value from data source ibm.Org 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 IBM Cloud service is provisioned into. To list resource groups, run ibmcloud resource groups.
    role str
    The IAM service access role that you want to use to create the service credentials for the IBM Cloud service instance. If you specified existing service credentials in the key parameter, settings for the role parameter are ignored.
    service_instance_id str
    The ID of the service that you want to bind to the cluster. If you specify this parameter, do not specify service_instance_name at the same time.
    service_instance_name str
    The name of the service that you want to bind to the cluster. If you specify this parameter, do not specify service_instance_id at the same time.
    space_guid str
    The GUID for the IBM Cloud space associated with the cluster. You can retrieve the value from data source ibm.Space or by running the ibmcloud iam space <space-name> --guid command in the IBM Cloud CLI.

    Deprecated: Deprecated

    tags Sequence[str]

    A list of tags that you want to associate with the IBM Cloud service instance that you bind to the cluster. Note Tags are managed locally and are not stored on the IBM Cloud service endpoint.

    Deprecated reference

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

    Deprecated: Deprecated

    clusterNameId String
    The name or ID of the cluster to which you want to bind an IBM Cloud service. To find the cluster name or ID, run ibmcloud ks cluster ls.
    containerBindServiceId String
    (String) The unique identifier of the service bind resource in your cluster in the format <cluster_name_ID>/<service_instance_name> or <service_instance_id>/<namespace_id>.
    key String
    The name or guid of existing service credentials that you want to use for the service. If you do not provide this option, service credentials are automatically created as part of the service binding process.
    namespaceId String
    The Kubernetes namespace where you want to create the Kubernetes secret that holds the service credentials of the service that you want to bind to the cluster.
    orgGuid String
    The GUID for the IBM Cloud organization associated with the cluster. You can retrieve the value from data source ibm.Org 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 IBM Cloud service is provisioned into. To list resource groups, run ibmcloud resource groups.
    role String
    The IAM service access role that you want to use to create the service credentials for the IBM Cloud service instance. If you specified existing service credentials in the key parameter, settings for the role parameter are ignored.
    serviceInstanceId String
    The ID of the service that you want to bind to the cluster. If you specify this parameter, do not specify service_instance_name at the same time.
    serviceInstanceName String
    The name of the service that you want to bind to the cluster. If you specify this parameter, do not specify service_instance_id at the same time.
    spaceGuid String
    The GUID for the IBM Cloud space associated with the cluster. You can retrieve the value from data source ibm.Space or by running the ibmcloud iam space <space-name> --guid command in the IBM Cloud CLI.

    Deprecated: Deprecated

    tags List<String>

    A list of tags that you want to associate with the IBM Cloud service instance that you bind to the cluster. Note Tags are managed locally and are not stored on the IBM Cloud service endpoint.

    Deprecated reference

    Import

    The ibm_container_bind_service can be imported by using cluster_name_id, service_instance_name or service_instance_id and namespace_id.

    Example

    $ pulumi import ibm:index/containerBindService:ContainerBindService example mycluster/myservice/default

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

    Package Details

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