redpanda 1.3.4, Nov 3 25

redpanda 1.3.4 published on Monday, Nov 3, 2025 by redpanda-data

redpanda-data/terraform-provider-redpanda

redpanda.getServerlessCluster

Start a Neo task

Explain and create a redpanda.getServerlessCluster resource

redpanda 1.3.4 published on Monday, Nov 3, 2025 by redpanda-data

redpanda-data/terraform-provider-redpanda

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/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 Usage to create a serverless cluster

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

const testResourceGroup = new redpanda.ResourceGroup("testResourceGroup", {});
const testServerlessCluster = new redpanda.ServerlessCluster("testServerlessCluster", {
    resourceGroupId: testResourceGroup.id,
    serverlessRegion: _var.region,
});
const testTopic = new redpanda.Topic("testTopic", {
    partitionCount: _var.partition_count,
    replicationFactor: _var.replication_factor,
    clusterApiUrl: testServerlessCluster.clusterApiUrl,
    allowDeletion: true,
});
const testUser = new redpanda.User("testUser", {
    password: _var.user_pw,
    mechanism: _var.mechanism,
    clusterApiUrl: testServerlessCluster.clusterApiUrl,
    allowDeletion: _var.user_allow_deletion,
});

import pulumi
import pulumi_redpanda as redpanda

test_resource_group = redpanda.ResourceGroup("testResourceGroup")
test_serverless_cluster = redpanda.ServerlessCluster("testServerlessCluster",
    resource_group_id=test_resource_group.id,
    serverless_region=var["region"])
test_topic = redpanda.Topic("testTopic",
    partition_count=var["partition_count"],
    replication_factor=var["replication_factor"],
    cluster_api_url=test_serverless_cluster.cluster_api_url,
    allow_deletion=True)
test_user = redpanda.User("testUser",
    password=var["user_pw"],
    mechanism=var["mechanism"],
    cluster_api_url=test_serverless_cluster.cluster_api_url,
    allow_deletion=var["user_allow_deletion"])

package main

import (
	"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 {
		testResourceGroup, err := redpanda.NewResourceGroup(ctx, "testResourceGroup", nil)
		if err != nil {
			return err
		}
		testServerlessCluster, err := redpanda.NewServerlessCluster(ctx, "testServerlessCluster", &redpanda.ServerlessClusterArgs{
			ResourceGroupId:  testResourceGroup.ID(),
			ServerlessRegion: pulumi.Any(_var.Region),
		})
		if err != nil {
			return err
		}
		_, err = redpanda.NewTopic(ctx, "testTopic", &redpanda.TopicArgs{
			PartitionCount:    pulumi.Any(_var.Partition_count),
			ReplicationFactor: pulumi.Any(_var.Replication_factor),
			ClusterApiUrl:     testServerlessCluster.ClusterApiUrl,
			AllowDeletion:     pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		_, err = redpanda.NewUser(ctx, "testUser", &redpanda.UserArgs{
			Password:      pulumi.Any(_var.User_pw),
			Mechanism:     pulumi.Any(_var.Mechanism),
			ClusterApiUrl: testServerlessCluster.ClusterApiUrl,
			AllowDeletion: pulumi.Any(_var.User_allow_deletion),
		})
		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 testResourceGroup = new Redpanda.ResourceGroup("testResourceGroup");

    var testServerlessCluster = new Redpanda.ServerlessCluster("testServerlessCluster", new()
    {
        ResourceGroupId = testResourceGroup.Id,
        ServerlessRegion = @var.Region,
    });

    var testTopic = new Redpanda.Topic("testTopic", new()
    {
        PartitionCount = @var.Partition_count,
        ReplicationFactor = @var.Replication_factor,
        ClusterApiUrl = testServerlessCluster.ClusterApiUrl,
        AllowDeletion = true,
    });

    var testUser = new Redpanda.User("testUser", new()
    {
        Password = @var.User_pw,
        Mechanism = @var.Mechanism,
        ClusterApiUrl = testServerlessCluster.ClusterApiUrl,
        AllowDeletion = @var.User_allow_deletion,
    });

});

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.ServerlessCluster;
import com.pulumi.redpanda.ServerlessClusterArgs;
import com.pulumi.redpanda.Topic;
import com.pulumi.redpanda.TopicArgs;
import com.pulumi.redpanda.User;
import com.pulumi.redpanda.UserArgs;
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 testResourceGroup = new ResourceGroup("testResourceGroup");

        var testServerlessCluster = new ServerlessCluster("testServerlessCluster", ServerlessClusterArgs.builder()
            .resourceGroupId(testResourceGroup.id())
            .serverlessRegion(var_.region())
            .build());

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

        var testUser = new User("testUser", UserArgs.builder()
            .password(var_.user_pw())
            .mechanism(var_.mechanism())
            .clusterApiUrl(testServerlessCluster.clusterApiUrl())
            .allowDeletion(var_.user_allow_deletion())
            .build());

    }
}

resources:
  testResourceGroup:
    type: redpanda:ResourceGroup
  testServerlessCluster:
    type: redpanda:ServerlessCluster
    properties:
      resourceGroupId: ${testResourceGroup.id}
      serverlessRegion: ${var.region}
  testTopic:
    type: redpanda:Topic
    properties:
      partitionCount: ${var.partition_count}
      replicationFactor: ${var.replication_factor}
      clusterApiUrl: ${testServerlessCluster.clusterApiUrl}
      allowDeletion: true
  testUser:
    type: redpanda:User
    properties:
      password: ${var.user_pw}
      mechanism: ${var.mechanism}
      clusterApiUrl: ${testServerlessCluster.clusterApiUrl}
      allowDeletion: ${var.user_allow_deletion}

Limitations

Can only be used with Redpanda Cloud serverless clusters.

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?: InvokeOptions): Output<GetServerlessClusterResult>

def get_serverless_cluster(id: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetServerlessClusterResult
def get_serverless_cluster_output(id: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = 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 CompletableFuture<GetServerlessClusterResult> getServerlessCluster(GetServerlessClusterArgs args, InvokeOptions options)
public static Output<GetServerlessClusterResult> getServerlessCluster(GetServerlessClusterArgs args, InvokeOptions options)

fn::invoke:
  function: redpanda:index/getServerlessCluster:getServerlessCluster
  arguments:
    # arguments dictionary

The following arguments are supported:

Id string: The ID of the serverless cluster

Id string: The ID of the serverless cluster

id String: The ID of the serverless cluster

id string: The ID of the serverless cluster

id str: The ID of the serverless cluster

id String: The ID of the serverless cluster

getServerlessCluster Result

The following output properties are available:

ClusterApiUrl string: The URL of the cluster API
Id string: The ID of the serverless cluster
Name string: Name of the serverless cluster
ResourceGroupId string: The ID of the resource group in which to create the serverless cluster
ServerlessRegion string: Redpanda specific region for the serverless cluster

ClusterApiUrl string: The URL of the cluster API
Id string: The ID of the serverless cluster
Name string: Name of the serverless cluster
ResourceGroupId string: The ID of the resource group in which to create the serverless cluster
ServerlessRegion string: Redpanda specific region for the serverless cluster

clusterApiUrl String: The URL of the cluster API
id String: The ID of the serverless cluster
name String: Name of the serverless cluster
resourceGroupId String: The ID of the resource group in which to create the serverless cluster
serverlessRegion String: Redpanda specific region for the serverless cluster

clusterApiUrl string: The URL of the cluster API
id string: The ID of the serverless cluster
name string: Name of the serverless cluster
resourceGroupId string: The ID of the resource group in which to create the serverless cluster
serverlessRegion string: Redpanda specific region for the serverless cluster

cluster_api_url str: The URL of the cluster API
id str: The ID of the serverless cluster
name str: Name of the serverless cluster
resource_group_id str: The ID of the resource group in which to create the serverless cluster
serverless_region str: Redpanda specific region for the serverless cluster

clusterApiUrl String: The URL of the cluster API
id String: The ID of the serverless cluster
name String: Name of the serverless cluster
resourceGroupId String: The ID of the resource group in which to create the serverless cluster
serverlessRegion String: Redpanda specific region for the serverless cluster

Package Details

Repository: redpanda redpanda-data/terraform-provider-redpanda
License
Notes: This Pulumi package is based on the redpanda Terraform Provider.

redpanda 1.3.4 published on Monday, Nov 3, 2025 by redpanda-data

redpanda-data/terraform-provider-redpanda

redpanda.getServerlessCluster

On this page

On this page

Usage

Example Usage to create a serverless cluster

Limitations

Using getServerlessCluster

getServerlessCluster Result

Package Details

On this page

On this page