1. Packages
  2. Ibm Provider
  3. API Docs
  4. getEventStreamsTopic
ibm 1.85.0-beta0 published on Wednesday, Oct 29, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

ibm.getEventStreamsTopic

Start a Neo task
Explain and create an ibm.getEventStreamsTopic resource
ibm logo
ibm 1.85.0-beta0 published on Wednesday, Oct 29, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

    Review the Event Streams resource that you can connect, administer, developed with Event Streams and integrate with the other services.

    Example Usage

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

const esInstance = ibm.getResourceInstance({
    name: "terraform-integration",
    resourceGroupId: data.ibm_resource_group.group.id,
});
const esTopic = esInstance.then(esInstance => ibm.getEventStreamsTopic({
    resourceInstanceId: esInstance.id,
    name: "my-es-topic",
}));

    import pulumi
import pulumi_ibm as ibm

es_instance = ibm.get_resource_instance(name="terraform-integration",
    resource_group_id=data["ibm_resource_group"]["group"]["id"])
es_topic = ibm.get_event_streams_topic(resource_instance_id=es_instance.id,
    name="my-es-topic")

    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 {
		esInstance, err := ibm.LookupResourceInstance(ctx, &ibm.LookupResourceInstanceArgs{
			Name:            pulumi.StringRef("terraform-integration"),
			ResourceGroupId: pulumi.StringRef(data.Ibm_resource_group.Group.Id),
		}, nil)
		if err != nil {
			return err
		}
		_, err = ibm.LookupEventStreamsTopic(ctx, &ibm.LookupEventStreamsTopicArgs{
			ResourceInstanceId: esInstance.Id,
			Name:               "my-es-topic",
		}, 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 esInstance = Ibm.GetResourceInstance.Invoke(new()
    {
        Name = "terraform-integration",
        ResourceGroupId = data.Ibm_resource_group.Group.Id,
    });

    var esTopic = Ibm.GetEventStreamsTopic.Invoke(new()
    {
        ResourceInstanceId = esInstance.Apply(getResourceInstanceResult => getResourceInstanceResult.Id),
        Name = "my-es-topic",
    });

});

    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.GetResourceInstanceArgs;
import com.pulumi.ibm.inputs.GetEventStreamsTopicArgs;
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 esInstance = IbmFunctions.getResourceInstance(GetResourceInstanceArgs.builder()
            .name("terraform-integration")
            .resourceGroupId(data.ibm_resource_group().group().id())
            .build());

        final var esTopic = IbmFunctions.getEventStreamsTopic(GetEventStreamsTopicArgs.builder()
            .resourceInstanceId(esInstance.applyValue(getResourceInstanceResult -> getResourceInstanceResult.id()))
            .name("my-es-topic")
            .build());

    }
}

    variables:
  esInstance:
    fn::invoke:
      function: ibm:getResourceInstance
      arguments:
        name: terraform-integration
        resourceGroupId: ${data.ibm_resource_group.group.id}
  esTopic:
    fn::invoke:
      function: ibm:getEventStreamsTopic
      arguments:
        resourceInstanceId: ${esInstance.id}
        name: my-es-topic

    Using getEventStreamsTopic

    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 getEventStreamsTopic(args: GetEventStreamsTopicArgs, opts?: InvokeOptions): Promise<GetEventStreamsTopicResult>
function getEventStreamsTopicOutput(args: GetEventStreamsTopicOutputArgs, opts?: InvokeOptions): Output<GetEventStreamsTopicResult>
    def get_event_streams_topic(id: Optional[str] = None,
                            name: Optional[str] = None,
                            resource_instance_id: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetEventStreamsTopicResult
def get_event_streams_topic_output(id: Optional[pulumi.Input[str]] = None,
                            name: Optional[pulumi.Input[str]] = None,
                            resource_instance_id: Optional[pulumi.Input[str]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetEventStreamsTopicResult]
    func LookupEventStreamsTopic(ctx *Context, args *LookupEventStreamsTopicArgs, opts ...InvokeOption) (*LookupEventStreamsTopicResult, error)
func LookupEventStreamsTopicOutput(ctx *Context, args *LookupEventStreamsTopicOutputArgs, opts ...InvokeOption) LookupEventStreamsTopicResultOutput

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

    public static class GetEventStreamsTopic 
{
    public static Task<GetEventStreamsTopicResult> InvokeAsync(GetEventStreamsTopicArgs args, InvokeOptions? opts = null)
    public static Output<GetEventStreamsTopicResult> Invoke(GetEventStreamsTopicInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetEventStreamsTopicResult> getEventStreamsTopic(GetEventStreamsTopicArgs args, InvokeOptions options)
public static Output<GetEventStreamsTopicResult> getEventStreamsTopic(GetEventStreamsTopicArgs args, InvokeOptions options)

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

    The following arguments are supported:

    Name string
    The name of the topic.
    ResourceInstanceId string
    The ID or CRN of the Event Streams service instance.
    Id string
    (String) The ID of the topic in CRN format. For example, crn:v1:bluemix:public:messagehub:us-south:a/6db1b0d0b5c54ee5c201552547febcd8:cb5a0252-8b8d-4390-b017-80b743d32839:topic:my-es-topic.
    Name string
    The name of the topic.
    ResourceInstanceId string
    The ID or CRN of the Event Streams service instance.
    Id string
    (String) The ID of the topic in CRN format. For example, crn:v1:bluemix:public:messagehub:us-south:a/6db1b0d0b5c54ee5c201552547febcd8:cb5a0252-8b8d-4390-b017-80b743d32839:topic:my-es-topic.
    name String
    The name of the topic.
    resourceInstanceId String
    The ID or CRN of the Event Streams service instance.
    id String
    (String) The ID of the topic in CRN format. For example, crn:v1:bluemix:public:messagehub:us-south:a/6db1b0d0b5c54ee5c201552547febcd8:cb5a0252-8b8d-4390-b017-80b743d32839:topic:my-es-topic.
    name string
    The name of the topic.
    resourceInstanceId string
    The ID or CRN of the Event Streams service instance.
    id string
    (String) The ID of the topic in CRN format. For example, crn:v1:bluemix:public:messagehub:us-south:a/6db1b0d0b5c54ee5c201552547febcd8:cb5a0252-8b8d-4390-b017-80b743d32839:topic:my-es-topic.
    name str
    The name of the topic.
    resource_instance_id str
    The ID or CRN of the Event Streams service instance.
    id str
    (String) The ID of the topic in CRN format. For example, crn:v1:bluemix:public:messagehub:us-south:a/6db1b0d0b5c54ee5c201552547febcd8:cb5a0252-8b8d-4390-b017-80b743d32839:topic:my-es-topic.
    name String
    The name of the topic.
    resourceInstanceId String
    The ID or CRN of the Event Streams service instance.
    id String
    (String) The ID of the topic in CRN format. For example, crn:v1:bluemix:public:messagehub:us-south:a/6db1b0d0b5c54ee5c201552547febcd8:cb5a0252-8b8d-4390-b017-80b743d32839:topic:my-es-topic.

    getEventStreamsTopic Result

    The following output properties are available:

    Config Dictionary<string, string>
    Id string
    (String) The ID of the topic in CRN format. For example, crn:v1:bluemix:public:messagehub:us-south:a/6db1b0d0b5c54ee5c201552547febcd8:cb5a0252-8b8d-4390-b017-80b743d32839:topic:my-es-topic.
    KafkaBrokersSasls List<string>
    (Array of strings) Kafka brokers uses for interacting with Kafka native API.
    KafkaHttpUrl string
    (String) The API endpoint for interacting with Event Streams REST API.
    Name string
    Partitions double
    ResourceInstanceId string
    Config map[string]string
    Id string
    (String) The ID of the topic in CRN format. For example, crn:v1:bluemix:public:messagehub:us-south:a/6db1b0d0b5c54ee5c201552547febcd8:cb5a0252-8b8d-4390-b017-80b743d32839:topic:my-es-topic.
    KafkaBrokersSasls []string
    (Array of strings) Kafka brokers uses for interacting with Kafka native API.
    KafkaHttpUrl string
    (String) The API endpoint for interacting with Event Streams REST API.
    Name string
    Partitions float64
    ResourceInstanceId string
    config Map<String,String>
    id String
    (String) The ID of the topic in CRN format. For example, crn:v1:bluemix:public:messagehub:us-south:a/6db1b0d0b5c54ee5c201552547febcd8:cb5a0252-8b8d-4390-b017-80b743d32839:topic:my-es-topic.
    kafkaBrokersSasls List<String>
    (Array of strings) Kafka brokers uses for interacting with Kafka native API.
    kafkaHttpUrl String
    (String) The API endpoint for interacting with Event Streams REST API.
    name String
    partitions Double
    resourceInstanceId String
    config {[key: string]: string}
    id string
    (String) The ID of the topic in CRN format. For example, crn:v1:bluemix:public:messagehub:us-south:a/6db1b0d0b5c54ee5c201552547febcd8:cb5a0252-8b8d-4390-b017-80b743d32839:topic:my-es-topic.
    kafkaBrokersSasls string[]
    (Array of strings) Kafka brokers uses for interacting with Kafka native API.
    kafkaHttpUrl string
    (String) The API endpoint for interacting with Event Streams REST API.
    name string
    partitions number
    resourceInstanceId string
    config Mapping[str, str]
    id str
    (String) The ID of the topic in CRN format. For example, crn:v1:bluemix:public:messagehub:us-south:a/6db1b0d0b5c54ee5c201552547febcd8:cb5a0252-8b8d-4390-b017-80b743d32839:topic:my-es-topic.
    kafka_brokers_sasls Sequence[str]
    (Array of strings) Kafka brokers uses for interacting with Kafka native API.
    kafka_http_url str
    (String) The API endpoint for interacting with Event Streams REST API.
    name str
    partitions float
    resource_instance_id str
    config Map<String>
    id String
    (String) The ID of the topic in CRN format. For example, crn:v1:bluemix:public:messagehub:us-south:a/6db1b0d0b5c54ee5c201552547febcd8:cb5a0252-8b8d-4390-b017-80b743d32839:topic:my-es-topic.
    kafkaBrokersSasls List<String>
    (Array of strings) Kafka brokers uses for interacting with Kafka native API.
    kafkaHttpUrl String
    (String) The API endpoint for interacting with Event Streams REST API.
    name String
    partitions Number
    resourceInstanceId String

    Package Details

    Repository
    ibm ibm-cloud/terraform-provider-ibm
    License
    Notes
    This Pulumi package is based on the ibm Terraform Provider.
    ibm logo
    ibm 1.85.0-beta0 published on Wednesday, Oct 29, 2025 by ibm-cloud
    ibm-cloud/terraform-provider-ibm
      Meet Neo: Your AI Platform Teammate