1. Packages
  2. Redpanda Provider
  3. API Docs
  4. ServerlessCluster
redpanda 1.7.0 published on Thursday, Feb 26, 2026 by redpanda-data
Schema (JSON)
redpanda-data/terraform-provider-redpanda

redpanda.ServerlessCluster

redpanda logo
redpanda 1.7.0 published on Thursday, Feb 26, 2026 by redpanda-data
Schema (JSON)
redpanda-data/terraform-provider-redpanda

    Enables the provisioning and management of Redpanda Serverless clusters. A Serverless cluster requires a resource group.

    Example Usage

    Example coming soon!

    Example coming soon!

    Example coming soon!

    Example coming soon!

    Example coming soon!

    resources:
  example:
    type: redpanda:ResourceGroup
    properties:
      name: example-resource-group
  exampleServerlessCluster:
    type: redpanda:ServerlessCluster
    name: example
    properties:
      name: example-serverless-cluster
      resourceGroupId: ${example.id}
      region: us-west-2

    Limitations

    Serverless on GCP is currently in beta. To unlock this feature for your account, contact your Redpanda account team.

    Advanced Usage

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

const test = new redpanda.ResourceGroup("test", {name: resourceGroupName});
const testServerlessPrivateLink: redpanda.ServerlessPrivateLink[] = [];
for (const range = {value: 0}; range.value < (privateNetworking == "STATE_ENABLED" ? 1 : 0); range.value++) {
    testServerlessPrivateLink.push(new redpanda.ServerlessPrivateLink(`test-${range.value}`, {
        name: `${clusterName}-private-link`,
        resourceGroupId: test.id,
        cloudProvider: "aws",
        serverlessRegion: region,
        allowDeletion: allowPrivateLinkDeletion,
        cloudProviderConfig: {
            aws: {
                allowedPrincipals: allowedPrincipals,
            },
        },
    }));
}
const testServerlessCluster = new redpanda.ServerlessCluster("test", {
    name: clusterName,
    resourceGroupId: test.id,
    serverlessRegion: region,
    privateLinkId: privateNetworking == "STATE_ENABLED" ? testServerlessPrivateLink[0].id : null,
    networkingConfig: {
        "public": publicNetworking,
        "private": privateNetworking,
    },
});
const testTopic = new redpanda.Topic("test", {
    name: topicName,
    partitionCount: partitionCount,
    replicationFactor: replicationFactor,
    clusterApiUrl: testServerlessCluster.clusterApiUrl,
    allowDeletion: true,
});
const testUser = new redpanda.User("test", {
    name: userName,
    password: userPw,
    mechanism: mechanism,
    clusterApiUrl: testServerlessCluster.clusterApiUrl,
    allowDeletion: userAllowDeletion,
});

    import pulumi
import pulumi_redpanda as redpanda

test = redpanda.ResourceGroup("test", name=resource_group_name)
test_serverless_private_link = []
for range in [{"value": i} for i in range(0, 1 if private_networking == STATE_ENABLED else 0)]:
    test_serverless_private_link.append(redpanda.ServerlessPrivateLink(f"test-{range['value']}",
        name=f"{cluster_name}-private-link",
        resource_group_id=test.id,
        cloud_provider="aws",
        serverless_region=region,
        allow_deletion=allow_private_link_deletion,
        cloud_provider_config={
            "aws": {
                "allowed_principals": allowed_principals,
            },
        }))
test_serverless_cluster = redpanda.ServerlessCluster("test",
    name=cluster_name,
    resource_group_id=test.id,
    serverless_region=region,
    private_link_id=test_serverless_private_link[0].id if private_networking == "STATE_ENABLED" else None,
    networking_config={
        "public": public_networking,
        "private": private_networking,
    })
test_topic = redpanda.Topic("test",
    name=topic_name,
    partition_count=partition_count,
    replication_factor=replication_factor,
    cluster_api_url=test_serverless_cluster.cluster_api_url,
    allow_deletion=True)
test_user = redpanda.User("test",
    name=user_name,
    password=user_pw,
    mechanism=mechanism,
    cluster_api_url=test_serverless_cluster.cluster_api_url,
    allow_deletion=user_allow_deletion)

    package main

import (
	"fmt"

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		test, err := redpanda.NewResourceGroup(ctx, "test", &redpanda.ResourceGroupArgs{
			Name: pulumi.Any(resourceGroupName),
		})
		if err != nil {
			return err
		}
		var tmp0 float64
		if privateNetworking == "STATE_ENABLED" {
			tmp0 = 1
		} else {
			tmp0 = 0
		}
		var testServerlessPrivateLink []*redpanda.ServerlessPrivateLink
		for index := 0; index < tmp0; index++ {
			key0 := index
			_ := index
			__res, err := redpanda.NewServerlessPrivateLink(ctx, fmt.Sprintf("test-%v", key0), &redpanda.ServerlessPrivateLinkArgs{
				Name:             pulumi.Sprintf("%v-private-link", clusterName),
				ResourceGroupId:  test.ID(),
				CloudProvider:    pulumi.String("aws"),
				ServerlessRegion: pulumi.Any(region),
				AllowDeletion:    pulumi.Any(allowPrivateLinkDeletion),
				CloudProviderConfig: &redpanda.ServerlessPrivateLinkCloudProviderConfigArgs{
					Aws: &redpanda.ServerlessPrivateLinkCloudProviderConfigAwsArgs{
						AllowedPrincipals: pulumi.Any(allowedPrincipals),
					},
				},
			})
			if err != nil {
				return err
			}
			testServerlessPrivateLink = append(testServerlessPrivateLink, __res)
		}
		var tmp1 pulumi.String
		if privateNetworking == "STATE_ENABLED" {
			tmp1 = testServerlessPrivateLink[0].ID()
		} else {
			tmp1 = nil
		}
		testServerlessCluster, err := redpanda.NewServerlessCluster(ctx, "test", &redpanda.ServerlessClusterArgs{
			Name:             pulumi.Any(clusterName),
			ResourceGroupId:  test.ID(),
			ServerlessRegion: pulumi.Any(region),
			PrivateLinkId:    pulumi.String(tmp1),
			NetworkingConfig: &redpanda.ServerlessClusterNetworkingConfigArgs{
				Public:  pulumi.Any(publicNetworking),
				Private: pulumi.Any(privateNetworking),
			},
		})
		if err != nil {
			return err
		}
		_, err = redpanda.NewTopic(ctx, "test", &redpanda.TopicArgs{
			Name:              pulumi.Any(topicName),
			PartitionCount:    pulumi.Any(partitionCount),
			ReplicationFactor: pulumi.Any(replicationFactor),
			ClusterApiUrl:     testServerlessCluster.ClusterApiUrl,
			AllowDeletion:     pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		_, err = redpanda.NewUser(ctx, "test", &redpanda.UserArgs{
			Name:          pulumi.Any(userName),
			Password:      pulumi.Any(userPw),
			Mechanism:     pulumi.Any(mechanism),
			ClusterApiUrl: testServerlessCluster.ClusterApiUrl,
			AllowDeletion: pulumi.Any(userAllowDeletion),
		})
		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 test = new Redpanda.ResourceGroup("test", new()
    {
        Name = resourceGroupName,
    });

    var testServerlessPrivateLink = new List<Redpanda.ServerlessPrivateLink>();
    for (var rangeIndex = 0; rangeIndex < (privateNetworking == "STATE_ENABLED" ? 1 : 0); rangeIndex++)
    {
        var range = new { Value = rangeIndex };
        testServerlessPrivateLink.Add(new Redpanda.ServerlessPrivateLink($"test-{range.Value}", new()
        {
            Name = $"{clusterName}-private-link",
            ResourceGroupId = test.Id,
            CloudProvider = "aws",
            ServerlessRegion = region,
            AllowDeletion = allowPrivateLinkDeletion,
            CloudProviderConfig = new Redpanda.Inputs.ServerlessPrivateLinkCloudProviderConfigArgs
            {
                Aws = new Redpanda.Inputs.ServerlessPrivateLinkCloudProviderConfigAwsArgs
                {
                    AllowedPrincipals = allowedPrincipals,
                },
            },
        }));
    }
    var testServerlessCluster = new Redpanda.ServerlessCluster("test", new()
    {
        Name = clusterName,
        ResourceGroupId = test.Id,
        ServerlessRegion = region,
        PrivateLinkId = privateNetworking == "STATE_ENABLED" ? testServerlessPrivateLink[0].Id : null,
        NetworkingConfig = new Redpanda.Inputs.ServerlessClusterNetworkingConfigArgs
        {
            Public = publicNetworking,
            Private = privateNetworking,
        },
    });

    var testTopic = new Redpanda.Topic("test", new()
    {
        Name = topicName,
        PartitionCount = partitionCount,
        ReplicationFactor = replicationFactor,
        ClusterApiUrl = testServerlessCluster.ClusterApiUrl,
        AllowDeletion = true,
    });

    var testUser = new Redpanda.User("test", new()
    {
        Name = userName,
        Password = userPw,
        Mechanism = mechanism,
        ClusterApiUrl = testServerlessCluster.ClusterApiUrl,
        AllowDeletion = userAllowDeletion,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.redpanda.ResourceGroup;
import com.pulumi.redpanda.ResourceGroupArgs;
import com.pulumi.redpanda.ServerlessPrivateLink;
import com.pulumi.redpanda.ServerlessPrivateLinkArgs;
import com.pulumi.redpanda.inputs.ServerlessPrivateLinkCloudProviderConfigArgs;
import com.pulumi.redpanda.inputs.ServerlessPrivateLinkCloudProviderConfigAwsArgs;
import com.pulumi.redpanda.ServerlessCluster;
import com.pulumi.redpanda.ServerlessClusterArgs;
import com.pulumi.redpanda.inputs.ServerlessClusterNetworkingConfigArgs;
import com.pulumi.redpanda.Topic;
import com.pulumi.redpanda.TopicArgs;
import com.pulumi.redpanda.User;
import com.pulumi.redpanda.UserArgs;
import com.pulumi.codegen.internal.KeyedValue;
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 test = new ResourceGroup("test", ResourceGroupArgs.builder()
            .name(resourceGroupName)
            .build());

        for (var i = 0; i < (privateNetworking == "STATE_ENABLED" ? 1 : 0); i++) {
            new ServerlessPrivateLink("testServerlessPrivateLink-" + i, ServerlessPrivateLinkArgs.builder()
                .name(String.format("%s-private-link", clusterName))
                .resourceGroupId(test.id())
                .cloudProvider("aws")
                .serverlessRegion(region)
                .allowDeletion(allowPrivateLinkDeletion)
                .cloudProviderConfig(ServerlessPrivateLinkCloudProviderConfigArgs.builder()
                    .aws(ServerlessPrivateLinkCloudProviderConfigAwsArgs.builder()
                        .allowedPrincipals(allowedPrincipals)
                        .build())
                    .build())
                .build());

        
}
        var testServerlessCluster = new ServerlessCluster("testServerlessCluster", ServerlessClusterArgs.builder()
            .name(clusterName)
            .resourceGroupId(test.id())
            .serverlessRegion(region)
            .privateLinkId(privateNetworking == "STATE_ENABLED" ? testServerlessPrivateLink[0].id() : null)
            .networkingConfig(ServerlessClusterNetworkingConfigArgs.builder()
                .public_(publicNetworking)
                .private_(privateNetworking)
                .build())
            .build());

        var testTopic = new Topic("testTopic", TopicArgs.builder()
            .name(topicName)
            .partitionCount(partitionCount)
            .replicationFactor(replicationFactor)
            .clusterApiUrl(testServerlessCluster.clusterApiUrl())
            .allowDeletion(true)
            .build());

        var testUser = new User("testUser", UserArgs.builder()
            .name(userName)
            .password(userPw)
            .mechanism(mechanism)
            .clusterApiUrl(testServerlessCluster.clusterApiUrl())
            .allowDeletion(userAllowDeletion)
            .build());

    }
}

    Example coming soon!

    API Reference

    For more information, see the Redpanda Cloud Control Plane API documentation.

    Create ServerlessCluster Resource

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

    Constructor syntax

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

@overload
def ServerlessCluster(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      resource_group_id: Optional[str] = None,
                      serverless_region: Optional[str] = None,
                      name: Optional[str] = None,
                      networking_config: Optional[ServerlessClusterNetworkingConfigArgs] = None,
                      private_link_id: Optional[str] = None,
                      tags: Optional[Mapping[str, str]] = None)
    func NewServerlessCluster(ctx *Context, name string, args ServerlessClusterArgs, opts ...ResourceOption) (*ServerlessCluster, error)
    public ServerlessCluster(string name, ServerlessClusterArgs args, CustomResourceOptions? opts = null)
    public ServerlessCluster(String name, ServerlessClusterArgs args)
public ServerlessCluster(String name, ServerlessClusterArgs args, CustomResourceOptions options)

    type: redpanda:ServerlessCluster
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 ServerlessClusterArgs
    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 ServerlessClusterArgs
    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 ServerlessClusterArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ServerlessClusterArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ServerlessClusterArgs
    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 serverlessClusterResource = new Redpanda.ServerlessCluster("serverlessClusterResource", new()
{
    ResourceGroupId = "string",
    ServerlessRegion = "string",
    Name = "string",
    NetworkingConfig = new Redpanda.Inputs.ServerlessClusterNetworkingConfigArgs
    {
        Private = "string",
        Public = "string",
    },
    PrivateLinkId = "string",
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := redpanda.NewServerlessCluster(ctx, "serverlessClusterResource", &redpanda.ServerlessClusterArgs{
	ResourceGroupId:  pulumi.String("string"),
	ServerlessRegion: pulumi.String("string"),
	Name:             pulumi.String("string"),
	NetworkingConfig: &redpanda.ServerlessClusterNetworkingConfigArgs{
		Private: pulumi.String("string"),
		Public:  pulumi.String("string"),
	},
	PrivateLinkId: pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var serverlessClusterResource = new ServerlessCluster("serverlessClusterResource", ServerlessClusterArgs.builder()
    .resourceGroupId("string")
    .serverlessRegion("string")
    .name("string")
    .networkingConfig(ServerlessClusterNetworkingConfigArgs.builder()
        .private_("string")
        .public_("string")
        .build())
    .privateLinkId("string")
    .tags(Map.of("string", "string"))
    .build());

    serverless_cluster_resource = redpanda.ServerlessCluster("serverlessClusterResource",
    resource_group_id="string",
    serverless_region="string",
    name="string",
    networking_config={
        "private": "string",
        "public": "string",
    },
    private_link_id="string",
    tags={
        "string": "string",
    })

    const serverlessClusterResource = new redpanda.ServerlessCluster("serverlessClusterResource", {
    resourceGroupId: "string",
    serverlessRegion: "string",
    name: "string",
    networkingConfig: {
        "private": "string",
        "public": "string",
    },
    privateLinkId: "string",
    tags: {
        string: "string",
    },
});

    type: redpanda:ServerlessCluster
properties:
    name: string
    networkingConfig:
        private: string
        public: string
    privateLinkId: string
    resourceGroupId: string
    serverlessRegion: string
    tags:
        string: string

    ServerlessCluster 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 ServerlessCluster resource accepts the following input properties:

    ResourceGroupId string
    The ID of the Resource Group in which to create the serverless cluster
    ServerlessRegion string
    Redpanda specific region of the serverless cluster
    Name string
    Name of the serverless cluster
    NetworkingConfig ServerlessClusterNetworkingConfig
    Network configuration controlling public/private access to the cluster
    PrivateLinkId string
    Private link ID for the serverless cluster. Must be set if private networking is enabled.
    Tags Dictionary<string, string>
    Tags placed on cloud resources.
    ResourceGroupId string
    The ID of the Resource Group in which to create the serverless cluster
    ServerlessRegion string
    Redpanda specific region of the serverless cluster
    Name string
    Name of the serverless cluster
    NetworkingConfig ServerlessClusterNetworkingConfigArgs
    Network configuration controlling public/private access to the cluster
    PrivateLinkId string
    Private link ID for the serverless cluster. Must be set if private networking is enabled.
    Tags map[string]string
    Tags placed on cloud resources.
    resourceGroupId String
    The ID of the Resource Group in which to create the serverless cluster
    serverlessRegion String
    Redpanda specific region of the serverless cluster
    name String
    Name of the serverless cluster
    networkingConfig ServerlessClusterNetworkingConfig
    Network configuration controlling public/private access to the cluster
    privateLinkId String
    Private link ID for the serverless cluster. Must be set if private networking is enabled.
    tags Map<String,String>
    Tags placed on cloud resources.
    resourceGroupId string
    The ID of the Resource Group in which to create the serverless cluster
    serverlessRegion string
    Redpanda specific region of the serverless cluster
    name string
    Name of the serverless cluster
    networkingConfig ServerlessClusterNetworkingConfig
    Network configuration controlling public/private access to the cluster
    privateLinkId string
    Private link ID for the serverless cluster. Must be set if private networking is enabled.
    tags {[key: string]: string}
    Tags placed on cloud resources.
    resource_group_id str
    The ID of the Resource Group in which to create the serverless cluster
    serverless_region str
    Redpanda specific region of the serverless cluster
    name str
    Name of the serverless cluster
    networking_config ServerlessClusterNetworkingConfigArgs
    Network configuration controlling public/private access to the cluster
    private_link_id str
    Private link ID for the serverless cluster. Must be set if private networking is enabled.
    tags Mapping[str, str]
    Tags placed on cloud resources.
    resourceGroupId String
    The ID of the Resource Group in which to create the serverless cluster
    serverlessRegion String
    Redpanda specific region of the serverless cluster
    name String
    Name of the serverless cluster
    networkingConfig Property Map
    Network configuration controlling public/private access to the cluster
    privateLinkId String
    Private link ID for the serverless cluster. Must be set if private networking is enabled.
    tags Map<String>
    Tags placed on cloud resources.

    Outputs

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

    ClusterApiUrl string
    The URL of the dataplane API for the serverless cluster

    Deprecated: Deprecated

    ConsolePrivateUrl string
    Private Console URL for the serverless cluster
    ConsoleUrl string
    Public Console URL for the serverless cluster
    DataplaneApi ServerlessClusterDataplaneApi
    Dataplane API endpoints for the serverless cluster
    Id string
    The provider-assigned unique ID for this managed resource.
    KafkaApi ServerlessClusterKafkaApi
    Kafka API endpoints for the serverless cluster
    PlannedDeletion ServerlessClusterPlannedDeletion
    Planned deletion information for the serverless cluster.
    Prometheus ServerlessClusterPrometheus
    Prometheus metrics endpoints for the serverless cluster
    SchemaRegistry ServerlessClusterSchemaRegistry
    Schema Registry endpoints for the serverless cluster
    State string
    Current state of the serverless cluster.
    ClusterApiUrl string
    The URL of the dataplane API for the serverless cluster

    Deprecated: Deprecated

    ConsolePrivateUrl string
    Private Console URL for the serverless cluster
    ConsoleUrl string
    Public Console URL for the serverless cluster
    DataplaneApi ServerlessClusterDataplaneApi
    Dataplane API endpoints for the serverless cluster
    Id string
    The provider-assigned unique ID for this managed resource.
    KafkaApi ServerlessClusterKafkaApi
    Kafka API endpoints for the serverless cluster
    PlannedDeletion ServerlessClusterPlannedDeletion
    Planned deletion information for the serverless cluster.
    Prometheus ServerlessClusterPrometheus
    Prometheus metrics endpoints for the serverless cluster
    SchemaRegistry ServerlessClusterSchemaRegistry
    Schema Registry endpoints for the serverless cluster
    State string
    Current state of the serverless cluster.
    clusterApiUrl String
    The URL of the dataplane API for the serverless cluster

    Deprecated: Deprecated

    consolePrivateUrl String
    Private Console URL for the serverless cluster
    consoleUrl String
    Public Console URL for the serverless cluster
    dataplaneApi ServerlessClusterDataplaneApi
    Dataplane API endpoints for the serverless cluster
    id String
    The provider-assigned unique ID for this managed resource.
    kafkaApi ServerlessClusterKafkaApi
    Kafka API endpoints for the serverless cluster
    plannedDeletion ServerlessClusterPlannedDeletion
    Planned deletion information for the serverless cluster.
    prometheus ServerlessClusterPrometheus
    Prometheus metrics endpoints for the serverless cluster
    schemaRegistry ServerlessClusterSchemaRegistry
    Schema Registry endpoints for the serverless cluster
    state String
    Current state of the serverless cluster.
    clusterApiUrl string
    The URL of the dataplane API for the serverless cluster

    Deprecated: Deprecated

    consolePrivateUrl string
    Private Console URL for the serverless cluster
    consoleUrl string
    Public Console URL for the serverless cluster
    dataplaneApi ServerlessClusterDataplaneApi
    Dataplane API endpoints for the serverless cluster
    id string
    The provider-assigned unique ID for this managed resource.
    kafkaApi ServerlessClusterKafkaApi
    Kafka API endpoints for the serverless cluster
    plannedDeletion ServerlessClusterPlannedDeletion
    Planned deletion information for the serverless cluster.
    prometheus ServerlessClusterPrometheus
    Prometheus metrics endpoints for the serverless cluster
    schemaRegistry ServerlessClusterSchemaRegistry
    Schema Registry endpoints for the serverless cluster
    state string
    Current state of the serverless cluster.
    cluster_api_url str
    The URL of the dataplane API for the serverless cluster

    Deprecated: Deprecated

    console_private_url str
    Private Console URL for the serverless cluster
    console_url str
    Public Console URL for the serverless cluster
    dataplane_api ServerlessClusterDataplaneApi
    Dataplane API endpoints for the serverless cluster
    id str
    The provider-assigned unique ID for this managed resource.
    kafka_api ServerlessClusterKafkaApi
    Kafka API endpoints for the serverless cluster
    planned_deletion ServerlessClusterPlannedDeletion
    Planned deletion information for the serverless cluster.
    prometheus ServerlessClusterPrometheus
    Prometheus metrics endpoints for the serverless cluster
    schema_registry ServerlessClusterSchemaRegistry
    Schema Registry endpoints for the serverless cluster
    state str
    Current state of the serverless cluster.
    clusterApiUrl String
    The URL of the dataplane API for the serverless cluster

    Deprecated: Deprecated

    consolePrivateUrl String
    Private Console URL for the serverless cluster
    consoleUrl String
    Public Console URL for the serverless cluster
    dataplaneApi Property Map
    Dataplane API endpoints for the serverless cluster
    id String
    The provider-assigned unique ID for this managed resource.
    kafkaApi Property Map
    Kafka API endpoints for the serverless cluster
    plannedDeletion Property Map
    Planned deletion information for the serverless cluster.
    prometheus Property Map
    Prometheus metrics endpoints for the serverless cluster
    schemaRegistry Property Map
    Schema Registry endpoints for the serverless cluster
    state String
    Current state of the serverless cluster.

    Look up Existing ServerlessCluster Resource

    Get an existing ServerlessCluster 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?: ServerlessClusterState, opts?: CustomResourceOptions): ServerlessCluster
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cluster_api_url: Optional[str] = None,
        console_private_url: Optional[str] = None,
        console_url: Optional[str] = None,
        dataplane_api: Optional[ServerlessClusterDataplaneApiArgs] = None,
        kafka_api: Optional[ServerlessClusterKafkaApiArgs] = None,
        name: Optional[str] = None,
        networking_config: Optional[ServerlessClusterNetworkingConfigArgs] = None,
        planned_deletion: Optional[ServerlessClusterPlannedDeletionArgs] = None,
        private_link_id: Optional[str] = None,
        prometheus: Optional[ServerlessClusterPrometheusArgs] = None,
        resource_group_id: Optional[str] = None,
        schema_registry: Optional[ServerlessClusterSchemaRegistryArgs] = None,
        serverless_region: Optional[str] = None,
        state: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None) -> ServerlessCluster
    func GetServerlessCluster(ctx *Context, name string, id IDInput, state *ServerlessClusterState, opts ...ResourceOption) (*ServerlessCluster, error)
    public static ServerlessCluster Get(string name, Input<string> id, ServerlessClusterState? state, CustomResourceOptions? opts = null)
    public static ServerlessCluster get(String name, Output<String> id, ServerlessClusterState state, CustomResourceOptions options)
    resources:  _:    type: redpanda:ServerlessCluster    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:
    ClusterApiUrl string
    The URL of the dataplane API for the serverless cluster

    Deprecated: Deprecated

    ConsolePrivateUrl string
    Private Console URL for the serverless cluster
    ConsoleUrl string
    Public Console URL for the serverless cluster
    DataplaneApi ServerlessClusterDataplaneApi
    Dataplane API endpoints for the serverless cluster
    KafkaApi ServerlessClusterKafkaApi
    Kafka API endpoints for the serverless cluster
    Name string
    Name of the serverless cluster
    NetworkingConfig ServerlessClusterNetworkingConfig
    Network configuration controlling public/private access to the cluster
    PlannedDeletion ServerlessClusterPlannedDeletion
    Planned deletion information for the serverless cluster.
    PrivateLinkId string
    Private link ID for the serverless cluster. Must be set if private networking is enabled.
    Prometheus ServerlessClusterPrometheus
    Prometheus metrics endpoints for the serverless cluster
    ResourceGroupId string
    The ID of the Resource Group in which to create the serverless cluster
    SchemaRegistry ServerlessClusterSchemaRegistry
    Schema Registry endpoints for the serverless cluster
    ServerlessRegion string
    Redpanda specific region of the serverless cluster
    State string
    Current state of the serverless cluster.
    Tags Dictionary<string, string>
    Tags placed on cloud resources.
    ClusterApiUrl string
    The URL of the dataplane API for the serverless cluster

    Deprecated: Deprecated

    ConsolePrivateUrl string
    Private Console URL for the serverless cluster
    ConsoleUrl string
    Public Console URL for the serverless cluster
    DataplaneApi ServerlessClusterDataplaneApiArgs
    Dataplane API endpoints for the serverless cluster
    KafkaApi ServerlessClusterKafkaApiArgs
    Kafka API endpoints for the serverless cluster
    Name string
    Name of the serverless cluster
    NetworkingConfig ServerlessClusterNetworkingConfigArgs
    Network configuration controlling public/private access to the cluster
    PlannedDeletion ServerlessClusterPlannedDeletionArgs
    Planned deletion information for the serverless cluster.
    PrivateLinkId string
    Private link ID for the serverless cluster. Must be set if private networking is enabled.
    Prometheus ServerlessClusterPrometheusArgs
    Prometheus metrics endpoints for the serverless cluster
    ResourceGroupId string
    The ID of the Resource Group in which to create the serverless cluster
    SchemaRegistry ServerlessClusterSchemaRegistryArgs
    Schema Registry endpoints for the serverless cluster
    ServerlessRegion string
    Redpanda specific region of the serverless cluster
    State string
    Current state of the serverless cluster.
    Tags map[string]string
    Tags placed on cloud resources.
    clusterApiUrl String
    The URL of the dataplane API for the serverless cluster

    Deprecated: Deprecated

    consolePrivateUrl String
    Private Console URL for the serverless cluster
    consoleUrl String
    Public Console URL for the serverless cluster
    dataplaneApi ServerlessClusterDataplaneApi
    Dataplane API endpoints for the serverless cluster
    kafkaApi ServerlessClusterKafkaApi
    Kafka API endpoints for the serverless cluster
    name String
    Name of the serverless cluster
    networkingConfig ServerlessClusterNetworkingConfig
    Network configuration controlling public/private access to the cluster
    plannedDeletion ServerlessClusterPlannedDeletion
    Planned deletion information for the serverless cluster.
    privateLinkId String
    Private link ID for the serverless cluster. Must be set if private networking is enabled.
    prometheus ServerlessClusterPrometheus
    Prometheus metrics endpoints for the serverless cluster
    resourceGroupId String
    The ID of the Resource Group in which to create the serverless cluster
    schemaRegistry ServerlessClusterSchemaRegistry
    Schema Registry endpoints for the serverless cluster
    serverlessRegion String
    Redpanda specific region of the serverless cluster
    state String
    Current state of the serverless cluster.
    tags Map<String,String>
    Tags placed on cloud resources.
    clusterApiUrl string
    The URL of the dataplane API for the serverless cluster

    Deprecated: Deprecated

    consolePrivateUrl string
    Private Console URL for the serverless cluster
    consoleUrl string
    Public Console URL for the serverless cluster
    dataplaneApi ServerlessClusterDataplaneApi
    Dataplane API endpoints for the serverless cluster
    kafkaApi ServerlessClusterKafkaApi
    Kafka API endpoints for the serverless cluster
    name string
    Name of the serverless cluster
    networkingConfig ServerlessClusterNetworkingConfig
    Network configuration controlling public/private access to the cluster
    plannedDeletion ServerlessClusterPlannedDeletion
    Planned deletion information for the serverless cluster.
    privateLinkId string
    Private link ID for the serverless cluster. Must be set if private networking is enabled.
    prometheus ServerlessClusterPrometheus
    Prometheus metrics endpoints for the serverless cluster
    resourceGroupId string
    The ID of the Resource Group in which to create the serverless cluster
    schemaRegistry ServerlessClusterSchemaRegistry
    Schema Registry endpoints for the serverless cluster
    serverlessRegion string
    Redpanda specific region of the serverless cluster
    state string
    Current state of the serverless cluster.
    tags {[key: string]: string}
    Tags placed on cloud resources.
    cluster_api_url str
    The URL of the dataplane API for the serverless cluster

    Deprecated: Deprecated

    console_private_url str
    Private Console URL for the serverless cluster
    console_url str
    Public Console URL for the serverless cluster
    dataplane_api ServerlessClusterDataplaneApiArgs
    Dataplane API endpoints for the serverless cluster
    kafka_api ServerlessClusterKafkaApiArgs
    Kafka API endpoints for the serverless cluster
    name str
    Name of the serverless cluster
    networking_config ServerlessClusterNetworkingConfigArgs
    Network configuration controlling public/private access to the cluster
    planned_deletion ServerlessClusterPlannedDeletionArgs
    Planned deletion information for the serverless cluster.
    private_link_id str
    Private link ID for the serverless cluster. Must be set if private networking is enabled.
    prometheus ServerlessClusterPrometheusArgs
    Prometheus metrics endpoints for the serverless cluster
    resource_group_id str
    The ID of the Resource Group in which to create the serverless cluster
    schema_registry ServerlessClusterSchemaRegistryArgs
    Schema Registry endpoints for the serverless cluster
    serverless_region str
    Redpanda specific region of the serverless cluster
    state str
    Current state of the serverless cluster.
    tags Mapping[str, str]
    Tags placed on cloud resources.
    clusterApiUrl String
    The URL of the dataplane API for the serverless cluster

    Deprecated: Deprecated

    consolePrivateUrl String
    Private Console URL for the serverless cluster
    consoleUrl String
    Public Console URL for the serverless cluster
    dataplaneApi Property Map
    Dataplane API endpoints for the serverless cluster
    kafkaApi Property Map
    Kafka API endpoints for the serverless cluster
    name String
    Name of the serverless cluster
    networkingConfig Property Map
    Network configuration controlling public/private access to the cluster
    plannedDeletion Property Map
    Planned deletion information for the serverless cluster.
    privateLinkId String
    Private link ID for the serverless cluster. Must be set if private networking is enabled.
    prometheus Property Map
    Prometheus metrics endpoints for the serverless cluster
    resourceGroupId String
    The ID of the Resource Group in which to create the serverless cluster
    schemaRegistry Property Map
    Schema Registry endpoints for the serverless cluster
    serverlessRegion String
    Redpanda specific region of the serverless cluster
    state String
    Current state of the serverless cluster.
    tags Map<String>
    Tags placed on cloud resources.

    Supporting Types

    ServerlessClusterDataplaneApi, ServerlessClusterDataplaneApiArgs

    PrivateUrl string
    Private Dataplane API URL
    Url string
    Public Dataplane API URL
    PrivateUrl string
    Private Dataplane API URL
    Url string
    Public Dataplane API URL
    privateUrl String
    Private Dataplane API URL
    url String
    Public Dataplane API URL
    privateUrl string
    Private Dataplane API URL
    url string
    Public Dataplane API URL
    private_url str
    Private Dataplane API URL
    url str
    Public Dataplane API URL
    privateUrl String
    Private Dataplane API URL
    url String
    Public Dataplane API URL

    ServerlessClusterKafkaApi, ServerlessClusterKafkaApiArgs

    PrivateSeedBrokers List<string>
    Private Kafka API seed brokers (bootstrap servers)
    SeedBrokers List<string>
    Public Kafka API seed brokers (bootstrap servers)
    PrivateSeedBrokers []string
    Private Kafka API seed brokers (bootstrap servers)
    SeedBrokers []string
    Public Kafka API seed brokers (bootstrap servers)
    privateSeedBrokers List<String>
    Private Kafka API seed brokers (bootstrap servers)
    seedBrokers List<String>
    Public Kafka API seed brokers (bootstrap servers)
    privateSeedBrokers string[]
    Private Kafka API seed brokers (bootstrap servers)
    seedBrokers string[]
    Public Kafka API seed brokers (bootstrap servers)
    private_seed_brokers Sequence[str]
    Private Kafka API seed brokers (bootstrap servers)
    seed_brokers Sequence[str]
    Public Kafka API seed brokers (bootstrap servers)
    privateSeedBrokers List<String>
    Private Kafka API seed brokers (bootstrap servers)
    seedBrokers List<String>
    Public Kafka API seed brokers (bootstrap servers)

    ServerlessClusterNetworkingConfig, ServerlessClusterNetworkingConfigArgs

    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

    ServerlessClusterPlannedDeletion, ServerlessClusterPlannedDeletionArgs

    DeleteAfter string
    Timestamp after which the cluster will be deleted.
    Reason string
    Reason for the planned deletion.
    DeleteAfter string
    Timestamp after which the cluster will be deleted.
    Reason string
    Reason for the planned deletion.
    deleteAfter String
    Timestamp after which the cluster will be deleted.
    reason String
    Reason for the planned deletion.
    deleteAfter string
    Timestamp after which the cluster will be deleted.
    reason string
    Reason for the planned deletion.
    delete_after str
    Timestamp after which the cluster will be deleted.
    reason str
    Reason for the planned deletion.
    deleteAfter String
    Timestamp after which the cluster will be deleted.
    reason String
    Reason for the planned deletion.

    ServerlessClusterPrometheus, ServerlessClusterPrometheusArgs

    PrivateUrl string
    Private Prometheus metrics URL
    Url string
    Public Prometheus metrics URL
    PrivateUrl string
    Private Prometheus metrics URL
    Url string
    Public Prometheus metrics URL
    privateUrl String
    Private Prometheus metrics URL
    url String
    Public Prometheus metrics URL
    privateUrl string
    Private Prometheus metrics URL
    url string
    Public Prometheus metrics URL
    private_url str
    Private Prometheus metrics URL
    url str
    Public Prometheus metrics URL
    privateUrl String
    Private Prometheus metrics URL
    url String
    Public Prometheus metrics URL

    ServerlessClusterSchemaRegistry, ServerlessClusterSchemaRegistryArgs

    PrivateUrl string
    Private Schema Registry URL
    Url string
    Public Schema Registry URL
    PrivateUrl string
    Private Schema Registry URL
    Url string
    Public Schema Registry URL
    privateUrl String
    Private Schema Registry URL
    url String
    Public Schema Registry URL
    privateUrl string
    Private Schema Registry URL
    url string
    Public Schema Registry URL
    private_url str
    Private Schema Registry URL
    url str
    Public Schema Registry URL
    privateUrl String
    Private Schema Registry URL
    url String
    Public Schema Registry URL

    Import

    $ pulumi import redpanda:index/serverlessCluster:ServerlessCluster example serverlessClusterId

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

    Package Details

    Repository
    redpanda redpanda-data/terraform-provider-redpanda
    License
    Notes
    This Pulumi package is based on the redpanda Terraform Provider.
    redpanda logo
    redpanda 1.7.0 published on Thursday, Feb 26, 2026 by redpanda-data
    Schema (JSON)
    redpanda-data/terraform-provider-redpanda
      Meet Neo: Your AI Platform Teammate