Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Redpanda Provider
  4. API Docs
  5. getServerlessCluster
Viewing docs for redpanda 2.4.0
published on Wednesday, Sep 16, 2026 by redpanda-data
Schema (JSON)
redpanda-data/terraform-provider-redpanda

redpanda.getServerlessCluster

Viewing docs for redpanda 2.4.0
published on Wednesday, Sep 16, 2026 by redpanda-data
Schema (JSON)
redpanda-data/terraform-provider-redpanda

    Data source for a Redpanda Cloud serverless cluster

    Usage

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

const example = redpanda.getServerlessCluster({
    id: "serverless_cluster_id",
});

    import pulumi
import pulumi_redpanda as redpanda

example = redpanda.get_serverless_cluster(id="serverless_cluster_id")

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/redpanda/v2/redpanda"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := redpanda.LookupServerlessCluster(ctx, &redpanda.LookupServerlessClusterArgs{
			Id: "serverless_cluster_id",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Redpanda = Pulumi.Redpanda;

return await Deployment.RunAsync(() => 
{
    var example = Redpanda.GetServerlessCluster.Invoke(new()
    {
        Id = "serverless_cluster_id",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.redpanda.RedpandaFunctions;
import com.pulumi.redpanda.inputs.GetServerlessClusterArgs;
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 example = RedpandaFunctions.getServerlessCluster(GetServerlessClusterArgs.builder()
            .id("serverless_cluster_id")
            .build());

    }
}

    variables:
  example:
    fn::invoke:
      function: redpanda:getServerlessCluster
      arguments:
        id: serverless_cluster_id

    Example coming soon!

    Using getServerlessCluster

    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 getServerlessCluster(args: GetServerlessClusterArgs, opts?: InvokeOptions): Promise<GetServerlessClusterResult>
function getServerlessClusterOutput(args: GetServerlessClusterOutputArgs, opts?: InvokeOutputOptions): Output<GetServerlessClusterResult>
    def get_serverless_cluster(id: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetServerlessClusterResult
def get_serverless_cluster_output(id: pulumi.Input[Optional[str]] = None,
                           opts: Optional[InvokeOutputOptions] = None) -> Output[GetServerlessClusterResult]
    func LookupServerlessCluster(ctx *Context, args *LookupServerlessClusterArgs, opts ...InvokeOption) (*LookupServerlessClusterResult, error)
func LookupServerlessClusterOutput(ctx *Context, args *LookupServerlessClusterOutputArgs, opts ...InvokeOption) LookupServerlessClusterResultOutput

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

    public static class GetServerlessCluster 
{
    public static Task<GetServerlessClusterResult> InvokeAsync(GetServerlessClusterArgs args, InvokeOptions? opts = null)
    public static Output<GetServerlessClusterResult> Invoke(GetServerlessClusterInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetServerlessClusterResult> Invoke(GetServerlessClusterInvokeArgs args, InvokeOutputOptions opts)
}
    public static CompletableFuture<GetServerlessClusterResult> getServerlessCluster(GetServerlessClusterArgs args, InvokeOptions options)
public static Output<GetServerlessClusterResult> getServerlessCluster(GetServerlessClusterArgs args, InvokeOptions options)
public static Output<GetServerlessClusterResult> getServerlessCluster(GetServerlessClusterArgs args, InvokeOutputOptions options)

    fn::invoke:
  function: redpanda:index/getServerlessCluster:getServerlessCluster
  arguments:
    # arguments dictionary
    data "redpanda_get_serverless_cluster" "name" {
    # arguments
}

    The following arguments are supported:

    Id string
    ID of the Serverless cluster. ID is an output from the Create Serverless Cluster operation and cannot be set by the caller.
    Id string
    ID of the Serverless cluster. ID is an output from the Create Serverless Cluster operation and cannot be set by the caller.
    id string
    ID of the Serverless cluster. ID is an output from the Create Serverless Cluster operation and cannot be set by the caller.
    id String
    ID of the Serverless cluster. ID is an output from the Create Serverless Cluster operation and cannot be set by the caller.
    id string
    ID of the Serverless cluster. ID is an output from the Create Serverless Cluster operation and cannot be set by the caller.
    id str
    ID of the Serverless cluster. ID is an output from the Create Serverless Cluster operation and cannot be set by the caller.
    id String
    ID of the Serverless cluster. ID is an output from the Create Serverless Cluster operation and cannot be set by the caller.

    getServerlessCluster Result

    The following output properties are available:

    ClusterApiUrl string
    The URL of the dataplane API for the serverless cluster.
    ConsolePrivateUrl string
    Private Console URL for the serverless cluster.
    ConsoleUrl string
    Public Console URL for the serverless cluster.
    DataplaneApi GetServerlessClusterDataplaneApi
    Cluster's Data Plane API properties.
    Id string
    ID of the Serverless cluster. ID is an output from the Create Serverless Cluster operation and cannot be set by the caller.
    KafkaApi GetServerlessClusterKafkaApi
    Cluster's Kafka API properties.
    Name string
    Unique name of the Serverless cluster.
    NetworkingConfig GetServerlessClusterNetworkingConfig
    Networking Config configuration
    PlannedDeletion GetServerlessClusterPlannedDeletion
    Date after which this cluster can and should be deleted.
    PrivateLinkId string
    Private link ID for the serverless cluster. Must be set if private networking is enabled.
    Prometheus GetServerlessClusterPrometheus
    Prometheus metrics endpoint properties.
    ResourceGroupId string
    Resource group ID of the cluster.
    SchemaRegistry GetServerlessClusterSchemaRegistry
    Cluster's Schema Registry properties.
    ServerlessRegion string
    Serverless region in which the cluster is placed, backed by a cloud provider region.
    State string
    State describes the state of the ServerlessCluster. - STATEPLACING: Serverless cluster is in the process of being placed on a cell with sufficient resources in the data plane. - STATECREATING: Serverless cluster is in the process of having its control plane state created. - STATEREADY: Serverless cluster is in execution and accepting external requests. - STATEDELETING: Serverless cluster is in the process of having its control plane state removed. Resources dedicated to the cluster in the data plane will be released. - STATEFAILED: Serverless cluster was unable to enter the ready state from either the creating or placing states. - STATESUSPENDED: Serverless cluster is in execution but blocks all external requests.
    Tags Dictionary<string, string>
    User-defined tags for the Serverless cluster
    ClusterApiUrl string
    The URL of the dataplane API for the serverless cluster.
    ConsolePrivateUrl string
    Private Console URL for the serverless cluster.
    ConsoleUrl string
    Public Console URL for the serverless cluster.
    DataplaneApi GetServerlessClusterDataplaneApi
    Cluster's Data Plane API properties.
    Id string
    ID of the Serverless cluster. ID is an output from the Create Serverless Cluster operation and cannot be set by the caller.
    KafkaApi GetServerlessClusterKafkaApi
    Cluster's Kafka API properties.
    Name string
    Unique name of the Serverless cluster.
    NetworkingConfig GetServerlessClusterNetworkingConfig
    Networking Config configuration
    PlannedDeletion GetServerlessClusterPlannedDeletion
    Date after which this cluster can and should be deleted.
    PrivateLinkId string
    Private link ID for the serverless cluster. Must be set if private networking is enabled.
    Prometheus GetServerlessClusterPrometheus
    Prometheus metrics endpoint properties.
    ResourceGroupId string
    Resource group ID of the cluster.
    SchemaRegistry GetServerlessClusterSchemaRegistry
    Cluster's Schema Registry properties.
    ServerlessRegion string
    Serverless region in which the cluster is placed, backed by a cloud provider region.
    State string
    State describes the state of the ServerlessCluster. - STATEPLACING: Serverless cluster is in the process of being placed on a cell with sufficient resources in the data plane. - STATECREATING: Serverless cluster is in the process of having its control plane state created. - STATEREADY: Serverless cluster is in execution and accepting external requests. - STATEDELETING: Serverless cluster is in the process of having its control plane state removed. Resources dedicated to the cluster in the data plane will be released. - STATEFAILED: Serverless cluster was unable to enter the ready state from either the creating or placing states. - STATESUSPENDED: Serverless cluster is in execution but blocks all external requests.
    Tags map[string]string
    User-defined tags for the Serverless cluster
    cluster_api_url string
    The URL of the dataplane API for the serverless cluster.
    console_private_url string
    Private Console URL for the serverless cluster.
    console_url string
    Public Console URL for the serverless cluster.
    dataplane_api object
    Cluster's Data Plane API properties.
    id string
    ID of the Serverless cluster. ID is an output from the Create Serverless Cluster operation and cannot be set by the caller.
    kafka_api object
    Cluster's Kafka API properties.
    name string
    Unique name of the Serverless cluster.
    networking_config object
    Networking Config configuration
    planned_deletion object
    Date after which this cluster can and should be deleted.
    private_link_id string
    Private link ID for the serverless cluster. Must be set if private networking is enabled.
    prometheus object
    Prometheus metrics endpoint properties.
    resource_group_id string
    Resource group ID of the cluster.
    schema_registry object
    Cluster's Schema Registry properties.
    serverless_region string
    Serverless region in which the cluster is placed, backed by a cloud provider region.
    state string
    State describes the state of the ServerlessCluster. - STATEPLACING: Serverless cluster is in the process of being placed on a cell with sufficient resources in the data plane. - STATECREATING: Serverless cluster is in the process of having its control plane state created. - STATEREADY: Serverless cluster is in execution and accepting external requests. - STATEDELETING: Serverless cluster is in the process of having its control plane state removed. Resources dedicated to the cluster in the data plane will be released. - STATEFAILED: Serverless cluster was unable to enter the ready state from either the creating or placing states. - STATESUSPENDED: Serverless cluster is in execution but blocks all external requests.
    tags map(string)
    User-defined tags for the Serverless cluster
    clusterApiUrl String
    The URL of the dataplane API for the serverless cluster.
    consolePrivateUrl String
    Private Console URL for the serverless cluster.
    consoleUrl String
    Public Console URL for the serverless cluster.
    dataplaneApi GetServerlessClusterDataplaneApi
    Cluster's Data Plane API properties.
    id String
    ID of the Serverless cluster. ID is an output from the Create Serverless Cluster operation and cannot be set by the caller.
    kafkaApi GetServerlessClusterKafkaApi
    Cluster's Kafka API properties.
    name String
    Unique name of the Serverless cluster.
    networkingConfig GetServerlessClusterNetworkingConfig
    Networking Config configuration
    plannedDeletion GetServerlessClusterPlannedDeletion
    Date after which this cluster can and should be deleted.
    privateLinkId String
    Private link ID for the serverless cluster. Must be set if private networking is enabled.
    prometheus GetServerlessClusterPrometheus
    Prometheus metrics endpoint properties.
    resourceGroupId String
    Resource group ID of the cluster.
    schemaRegistry GetServerlessClusterSchemaRegistry
    Cluster's Schema Registry properties.
    serverlessRegion String
    Serverless region in which the cluster is placed, backed by a cloud provider region.
    state String
    State describes the state of the ServerlessCluster. - STATEPLACING: Serverless cluster is in the process of being placed on a cell with sufficient resources in the data plane. - STATECREATING: Serverless cluster is in the process of having its control plane state created. - STATEREADY: Serverless cluster is in execution and accepting external requests. - STATEDELETING: Serverless cluster is in the process of having its control plane state removed. Resources dedicated to the cluster in the data plane will be released. - STATEFAILED: Serverless cluster was unable to enter the ready state from either the creating or placing states. - STATESUSPENDED: Serverless cluster is in execution but blocks all external requests.
    tags Map<String,String>
    User-defined tags for the Serverless cluster
    clusterApiUrl string
    The URL of the dataplane API for the serverless cluster.
    consolePrivateUrl string
    Private Console URL for the serverless cluster.
    consoleUrl string
    Public Console URL for the serverless cluster.
    dataplaneApi GetServerlessClusterDataplaneApi
    Cluster's Data Plane API properties.
    id string
    ID of the Serverless cluster. ID is an output from the Create Serverless Cluster operation and cannot be set by the caller.
    kafkaApi GetServerlessClusterKafkaApi
    Cluster's Kafka API properties.
    name string
    Unique name of the Serverless cluster.
    networkingConfig GetServerlessClusterNetworkingConfig
    Networking Config configuration
    plannedDeletion GetServerlessClusterPlannedDeletion
    Date after which this cluster can and should be deleted.
    privateLinkId string
    Private link ID for the serverless cluster. Must be set if private networking is enabled.
    prometheus GetServerlessClusterPrometheus
    Prometheus metrics endpoint properties.
    resourceGroupId string
    Resource group ID of the cluster.
    schemaRegistry GetServerlessClusterSchemaRegistry
    Cluster's Schema Registry properties.
    serverlessRegion string
    Serverless region in which the cluster is placed, backed by a cloud provider region.
    state string
    State describes the state of the ServerlessCluster. - STATEPLACING: Serverless cluster is in the process of being placed on a cell with sufficient resources in the data plane. - STATECREATING: Serverless cluster is in the process of having its control plane state created. - STATEREADY: Serverless cluster is in execution and accepting external requests. - STATEDELETING: Serverless cluster is in the process of having its control plane state removed. Resources dedicated to the cluster in the data plane will be released. - STATEFAILED: Serverless cluster was unable to enter the ready state from either the creating or placing states. - STATESUSPENDED: Serverless cluster is in execution but blocks all external requests.
    tags {[key: string]: string}
    User-defined tags for the Serverless cluster
    cluster_api_url str
    The URL of the dataplane API for the serverless cluster.
    console_private_url str
    Private Console URL for the serverless cluster.
    console_url str
    Public Console URL for the serverless cluster.
    dataplane_api GetServerlessClusterDataplaneApi
    Cluster's Data Plane API properties.
    id str
    ID of the Serverless cluster. ID is an output from the Create Serverless Cluster operation and cannot be set by the caller.
    kafka_api GetServerlessClusterKafkaApi
    Cluster's Kafka API properties.
    name str
    Unique name of the Serverless cluster.
    networking_config GetServerlessClusterNetworkingConfig
    Networking Config configuration
    planned_deletion GetServerlessClusterPlannedDeletion
    Date after which this cluster can and should be deleted.
    private_link_id str
    Private link ID for the serverless cluster. Must be set if private networking is enabled.
    prometheus GetServerlessClusterPrometheus
    Prometheus metrics endpoint properties.
    resource_group_id str
    Resource group ID of the cluster.
    schema_registry GetServerlessClusterSchemaRegistry
    Cluster's Schema Registry properties.
    serverless_region str
    Serverless region in which the cluster is placed, backed by a cloud provider region.
    state str
    State describes the state of the ServerlessCluster. - STATEPLACING: Serverless cluster is in the process of being placed on a cell with sufficient resources in the data plane. - STATECREATING: Serverless cluster is in the process of having its control plane state created. - STATEREADY: Serverless cluster is in execution and accepting external requests. - STATEDELETING: Serverless cluster is in the process of having its control plane state removed. Resources dedicated to the cluster in the data plane will be released. - STATEFAILED: Serverless cluster was unable to enter the ready state from either the creating or placing states. - STATESUSPENDED: Serverless cluster is in execution but blocks all external requests.
    tags Mapping[str, str]
    User-defined tags for the Serverless cluster
    clusterApiUrl String
    The URL of the dataplane API for the serverless cluster.
    consolePrivateUrl String
    Private Console URL for the serverless cluster.
    consoleUrl String
    Public Console URL for the serverless cluster.
    dataplaneApi Property Map
    Cluster's Data Plane API properties.
    id String
    ID of the Serverless cluster. ID is an output from the Create Serverless Cluster operation and cannot be set by the caller.
    kafkaApi Property Map
    Cluster's Kafka API properties.
    name String
    Unique name of the Serverless cluster.
    networkingConfig Property Map
    Networking Config configuration
    plannedDeletion Property Map
    Date after which this cluster can and should be deleted.
    privateLinkId String
    Private link ID for the serverless cluster. Must be set if private networking is enabled.
    prometheus Property Map
    Prometheus metrics endpoint properties.
    resourceGroupId String
    Resource group ID of the cluster.
    schemaRegistry Property Map
    Cluster's Schema Registry properties.
    serverlessRegion String
    Serverless region in which the cluster is placed, backed by a cloud provider region.
    state String
    State describes the state of the ServerlessCluster. - STATEPLACING: Serverless cluster is in the process of being placed on a cell with sufficient resources in the data plane. - STATECREATING: Serverless cluster is in the process of having its control plane state created. - STATEREADY: Serverless cluster is in execution and accepting external requests. - STATEDELETING: Serverless cluster is in the process of having its control plane state removed. Resources dedicated to the cluster in the data plane will be released. - STATEFAILED: Serverless cluster was unable to enter the ready state from either the creating or placing states. - STATESUSPENDED: Serverless cluster is in execution but blocks all external requests.
    tags Map<String>
    User-defined tags for the Serverless cluster

    Supporting Types

    GetServerlessClusterDataplaneApi

    PrivateUrl string
    private_url is the private url of the dataplane api if private networking is enabled for this cluster.
    Url string
    Dataplane API URL
    PrivateUrl string
    private_url is the private url of the dataplane api if private networking is enabled for this cluster.
    Url string
    Dataplane API URL
    private_url string
    private_url is the private url of the dataplane api if private networking is enabled for this cluster.
    url string
    Dataplane API URL
    privateUrl String
    private_url is the private url of the dataplane api if private networking is enabled for this cluster.
    url String
    Dataplane API URL
    privateUrl string
    private_url is the private url of the dataplane api if private networking is enabled for this cluster.
    url string
    Dataplane API URL
    private_url str
    private_url is the private url of the dataplane api if private networking is enabled for this cluster.
    url str
    Dataplane API URL
    privateUrl String
    private_url is the private url of the dataplane api if private networking is enabled for this cluster.
    url String
    Dataplane API URL

    GetServerlessClusterKafkaApi

    PrivateSeedBrokers List<string>
    Kafka API seed brokers (also known as bootstrap servers). Private addresses
    SeedBrokers List<string>
    Kafka API seed brokers (also known as bootstrap servers). Implicitly public
    PrivateSeedBrokers []string
    Kafka API seed brokers (also known as bootstrap servers). Private addresses
    SeedBrokers []string
    Kafka API seed brokers (also known as bootstrap servers). Implicitly public
    private_seed_brokers list(string)
    Kafka API seed brokers (also known as bootstrap servers). Private addresses
    seed_brokers list(string)
    Kafka API seed brokers (also known as bootstrap servers). Implicitly public
    privateSeedBrokers List<String>
    Kafka API seed brokers (also known as bootstrap servers). Private addresses
    seedBrokers List<String>
    Kafka API seed brokers (also known as bootstrap servers). Implicitly public
    privateSeedBrokers string[]
    Kafka API seed brokers (also known as bootstrap servers). Private addresses
    seedBrokers string[]
    Kafka API seed brokers (also known as bootstrap servers). Implicitly public
    private_seed_brokers Sequence[str]
    Kafka API seed brokers (also known as bootstrap servers). Private addresses
    seed_brokers Sequence[str]
    Kafka API seed brokers (also known as bootstrap servers). Implicitly public
    privateSeedBrokers List<String>
    Kafka API seed brokers (also known as bootstrap servers). Private addresses
    seedBrokers List<String>
    Kafka API seed brokers (also known as bootstrap servers). Implicitly public

    GetServerlessClusterNetworkingConfig

    Private string
    Private network state. Valid values: STATEUNSPECIFIED, STATEDISABLED, STATE_ENABLED.
    Public string
    Public network state. Valid values: STATEUNSPECIFIED, STATEDISABLED, STATE_ENABLED.
    Private string
    Private network state. Valid values: STATEUNSPECIFIED, STATEDISABLED, STATE_ENABLED.
    Public string
    Public network state. Valid values: STATEUNSPECIFIED, STATEDISABLED, STATE_ENABLED.
    private string
    Private network state. Valid values: STATEUNSPECIFIED, STATEDISABLED, STATE_ENABLED.
    public string
    Public network state. Valid values: STATEUNSPECIFIED, STATEDISABLED, STATE_ENABLED.
    private_ String
    Private network state. Valid values: STATEUNSPECIFIED, STATEDISABLED, STATE_ENABLED.
    public_ String
    Public network state. Valid values: STATEUNSPECIFIED, STATEDISABLED, STATE_ENABLED.
    private string
    Private network state. Valid values: STATEUNSPECIFIED, STATEDISABLED, STATE_ENABLED.
    public string
    Public network state. Valid values: STATEUNSPECIFIED, STATEDISABLED, STATE_ENABLED.
    private str
    Private network state. Valid values: STATEUNSPECIFIED, STATEDISABLED, STATE_ENABLED.
    public str
    Public network state. Valid values: STATEUNSPECIFIED, STATEDISABLED, STATE_ENABLED.
    private String
    Private network state. Valid values: STATEUNSPECIFIED, STATEDISABLED, STATE_ENABLED.
    public String
    Public network state. Valid values: STATEUNSPECIFIED, STATEDISABLED, STATE_ENABLED.

    GetServerlessClusterPlannedDeletion

    DeleteAfter string
    Delete After
    Reason string
    Reason
    DeleteAfter string
    Delete After
    Reason string
    Reason
    delete_after string
    Delete After
    reason string
    Reason
    deleteAfter String
    Delete After
    reason String
    Reason
    deleteAfter string
    Delete After
    reason string
    Reason
    delete_after str
    Delete After
    reason str
    Reason
    deleteAfter String
    Delete After
    reason String
    Reason

    GetServerlessClusterPrometheus

    PrivateUrl string
    Prometheus API Private URL.
    Url string
    Prometheus API URL.
    PrivateUrl string
    Prometheus API Private URL.
    Url string
    Prometheus API URL.
    private_url string
    Prometheus API Private URL.
    url string
    Prometheus API URL.
    privateUrl String
    Prometheus API Private URL.
    url String
    Prometheus API URL.
    privateUrl string
    Prometheus API Private URL.
    url string
    Prometheus API URL.
    private_url str
    Prometheus API Private URL.
    url str
    Prometheus API URL.
    privateUrl String
    Prometheus API Private URL.
    url String
    Prometheus API URL.

    GetServerlessClusterSchemaRegistry

    PrivateUrl string
    Private url for the schema registry
    Url string
    Schema Registry URL
    PrivateUrl string
    Private url for the schema registry
    Url string
    Schema Registry URL
    private_url string
    Private url for the schema registry
    url string
    Schema Registry URL
    privateUrl String
    Private url for the schema registry
    url String
    Schema Registry URL
    privateUrl string
    Private url for the schema registry
    url string
    Schema Registry URL
    private_url str
    Private url for the schema registry
    url str
    Schema Registry URL
    privateUrl String
    Private url for the schema registry
    url String
    Schema Registry URL

    Package Details

    Repository
    redpanda redpanda-data/terraform-provider-redpanda
    License
    Notes
    This Pulumi package is based on the redpanda Terraform Provider.
    Viewing docs for redpanda 2.4.0
    published on Wednesday, Sep 16, 2026 by redpanda-data
    Schema (JSON)
    redpanda-data/terraform-provider-redpanda

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial