Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Confluent Provider
  3. API Docs
  4. getSchemaRegistryCluster
Confluent v2.24.0 published on Saturday, Apr 19, 2025 by Pulumi
pulumi/pulumi-confluentcloud

confluentcloud.getSchemaRegistryCluster

Explore with Pulumi AI

Confluent v2.24.0 published on Saturday, Apr 19, 2025 by Pulumi
pulumi/pulumi-confluentcloud

General Availability

data.confluent_schema_registry_cluster describes a Schema Registry cluster data source.

Example Usage

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

export = async () => {
    // Loads the only Schema Registry cluster in the target environment
    const exampleUsingEnvId = await confluentcloud.getSchemaRegistryCluster({
        environment: {
            id: "env-xyz456",
        },
    });
    const exampleUsingId = await confluentcloud.getSchemaRegistryCluster({
        id: "lsrc-abc123",
        environment: {
            id: "env-xyz456",
        },
    });
    const exampleUsingName = await confluentcloud.getSchemaRegistryCluster({
        displayName: "Stream Governance Package",
        environment: {
            id: "env-xyz456",
        },
    });
    return {
        exampleUsingEnvId: exampleUsingEnvId,
        exampleUsingId: exampleUsingId,
        exampleUsingName: exampleUsingName,
    };
}
Copy
import pulumi
import pulumi_confluentcloud as confluentcloud

# Loads the only Schema Registry cluster in the target environment
example_using_env_id = confluentcloud.get_schema_registry_cluster(environment={
    "id": "env-xyz456",
})
pulumi.export("exampleUsingEnvId", example_using_env_id)
example_using_id = confluentcloud.get_schema_registry_cluster(id="lsrc-abc123",
    environment={
        "id": "env-xyz456",
    })
pulumi.export("exampleUsingId", example_using_id)
example_using_name = confluentcloud.get_schema_registry_cluster(display_name="Stream Governance Package",
    environment={
        "id": "env-xyz456",
    })
pulumi.export("exampleUsingName", example_using_name)
Copy
package main

import (
	"github.com/pulumi/pulumi-confluentcloud/sdk/v2/go/confluentcloud"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// Loads the only Schema Registry cluster in the target environment
		exampleUsingEnvId, err := confluentcloud.GetSchemaRegistryCluster(ctx, &confluentcloud.GetSchemaRegistryClusterArgs{
			Environment: confluentcloud.GetSchemaRegistryClusterEnvironment{
				Id: "env-xyz456",
			},
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("exampleUsingEnvId", exampleUsingEnvId)
		exampleUsingId, err := confluentcloud.GetSchemaRegistryCluster(ctx, &confluentcloud.GetSchemaRegistryClusterArgs{
			Id: pulumi.StringRef("lsrc-abc123"),
			Environment: confluentcloud.GetSchemaRegistryClusterEnvironment{
				Id: "env-xyz456",
			},
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("exampleUsingId", exampleUsingId)
		exampleUsingName, err := confluentcloud.GetSchemaRegistryCluster(ctx, &confluentcloud.GetSchemaRegistryClusterArgs{
			DisplayName: pulumi.StringRef("Stream Governance Package"),
			Environment: confluentcloud.GetSchemaRegistryClusterEnvironment{
				Id: "env-xyz456",
			},
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("exampleUsingName", exampleUsingName)
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using ConfluentCloud = Pulumi.ConfluentCloud;

return await Deployment.RunAsync(() => 
{
    // Loads the only Schema Registry cluster in the target environment
    var exampleUsingEnvId = ConfluentCloud.GetSchemaRegistryCluster.Invoke(new()
    {
        Environment = new ConfluentCloud.Inputs.GetSchemaRegistryClusterEnvironmentInputArgs
        {
            Id = "env-xyz456",
        },
    });

    var exampleUsingId = ConfluentCloud.GetSchemaRegistryCluster.Invoke(new()
    {
        Id = "lsrc-abc123",
        Environment = new ConfluentCloud.Inputs.GetSchemaRegistryClusterEnvironmentInputArgs
        {
            Id = "env-xyz456",
        },
    });

    var exampleUsingName = ConfluentCloud.GetSchemaRegistryCluster.Invoke(new()
    {
        DisplayName = "Stream Governance Package",
        Environment = new ConfluentCloud.Inputs.GetSchemaRegistryClusterEnvironmentInputArgs
        {
            Id = "env-xyz456",
        },
    });

    return new Dictionary<string, object?>
    {
        ["exampleUsingEnvId"] = exampleUsingEnvId,
        ["exampleUsingId"] = exampleUsingId,
        ["exampleUsingName"] = exampleUsingName,
    };
});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.confluentcloud.ConfluentcloudFunctions;
import com.pulumi.confluentcloud.inputs.GetSchemaRegistryClusterArgs;
import com.pulumi.confluentcloud.inputs.GetSchemaRegistryClusterEnvironmentArgs;
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) {
        // Loads the only Schema Registry cluster in the target environment
        final var exampleUsingEnvId = ConfluentcloudFunctions.getSchemaRegistryCluster(GetSchemaRegistryClusterArgs.builder()
            .environment(GetSchemaRegistryClusterEnvironmentArgs.builder()
                .id("env-xyz456")
                .build())
            .build());

        ctx.export("exampleUsingEnvId", exampleUsingEnvId);
        final var exampleUsingId = ConfluentcloudFunctions.getSchemaRegistryCluster(GetSchemaRegistryClusterArgs.builder()
            .id("lsrc-abc123")
            .environment(GetSchemaRegistryClusterEnvironmentArgs.builder()
                .id("env-xyz456")
                .build())
            .build());

        ctx.export("exampleUsingId", exampleUsingId);
        final var exampleUsingName = ConfluentcloudFunctions.getSchemaRegistryCluster(GetSchemaRegistryClusterArgs.builder()
            .displayName("Stream Governance Package")
            .environment(GetSchemaRegistryClusterEnvironmentArgs.builder()
                .id("env-xyz456")
                .build())
            .build());

        ctx.export("exampleUsingName", exampleUsingName);
    }
}
Copy
variables:
  # Loads the only Schema Registry cluster in the target environment
  exampleUsingEnvId:
    fn::invoke:
      function: confluentcloud:getSchemaRegistryCluster
      arguments:
        environment:
          id: env-xyz456
  exampleUsingId:
    fn::invoke:
      function: confluentcloud:getSchemaRegistryCluster
      arguments:
        id: lsrc-abc123
        environment:
          id: env-xyz456
  exampleUsingName:
    fn::invoke:
      function: confluentcloud:getSchemaRegistryCluster
      arguments:
        displayName: Stream Governance Package
        environment:
          id: env-xyz456
outputs:
  exampleUsingEnvId: ${exampleUsingEnvId}
  exampleUsingId: ${exampleUsingId}
  exampleUsingName: ${exampleUsingName}
Copy

Using getSchemaRegistryCluster

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 getSchemaRegistryCluster(args: GetSchemaRegistryClusterArgs, opts?: InvokeOptions): Promise<GetSchemaRegistryClusterResult>
function getSchemaRegistryClusterOutput(args: GetSchemaRegistryClusterOutputArgs, opts?: InvokeOptions): Output<GetSchemaRegistryClusterResult>
Copy
def get_schema_registry_cluster(display_name: Optional[str] = None,
                                environment: Optional[GetSchemaRegistryClusterEnvironment] = None,
                                id: Optional[str] = None,
                                opts: Optional[InvokeOptions] = None) -> GetSchemaRegistryClusterResult
def get_schema_registry_cluster_output(display_name: Optional[pulumi.Input[str]] = None,
                                environment: Optional[pulumi.Input[GetSchemaRegistryClusterEnvironmentArgs]] = None,
                                id: Optional[pulumi.Input[str]] = None,
                                opts: Optional[InvokeOptions] = None) -> Output[GetSchemaRegistryClusterResult]
Copy
func GetSchemaRegistryCluster(ctx *Context, args *GetSchemaRegistryClusterArgs, opts ...InvokeOption) (*GetSchemaRegistryClusterResult, error)
func GetSchemaRegistryClusterOutput(ctx *Context, args *GetSchemaRegistryClusterOutputArgs, opts ...InvokeOption) GetSchemaRegistryClusterResultOutput
Copy

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

public static class GetSchemaRegistryCluster 
{
    public static Task<GetSchemaRegistryClusterResult> InvokeAsync(GetSchemaRegistryClusterArgs args, InvokeOptions? opts = null)
    public static Output<GetSchemaRegistryClusterResult> Invoke(GetSchemaRegistryClusterInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetSchemaRegistryClusterResult> getSchemaRegistryCluster(GetSchemaRegistryClusterArgs args, InvokeOptions options)
public static Output<GetSchemaRegistryClusterResult> getSchemaRegistryCluster(GetSchemaRegistryClusterArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: confluentcloud:index/getSchemaRegistryCluster:getSchemaRegistryCluster
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Environment This property is required. Pulumi.ConfluentCloud.Inputs.GetSchemaRegistryClusterEnvironment
DisplayName string
The name for the Schema Registry cluster.
Id string
The ID of the Schema Registry cluster (for example, lsrc-abc123).
Environment This property is required. GetSchemaRegistryClusterEnvironment
DisplayName string
The name for the Schema Registry cluster.
Id string
The ID of the Schema Registry cluster (for example, lsrc-abc123).
environment This property is required. GetSchemaRegistryClusterEnvironment
displayName String
The name for the Schema Registry cluster.
id String
The ID of the Schema Registry cluster (for example, lsrc-abc123).
environment This property is required. GetSchemaRegistryClusterEnvironment
displayName string
The name for the Schema Registry cluster.
id string
The ID of the Schema Registry cluster (for example, lsrc-abc123).
environment This property is required. GetSchemaRegistryClusterEnvironment
display_name str
The name for the Schema Registry cluster.
id str
The ID of the Schema Registry cluster (for example, lsrc-abc123).
environment This property is required. Property Map
displayName String
The name for the Schema Registry cluster.
id String
The ID of the Schema Registry cluster (for example, lsrc-abc123).

getSchemaRegistryCluster Result

The following output properties are available:

ApiVersion string
(Required String) An API Version of the schema version of the Schema Registry cluster, for example, stream-governance/v2.
CatalogEndpoint string
(Required String) The Catalog endpoint of the Schema Registry cluster, for example, https://psrc-y1113.us-west-2.aws.confluent.cloud.
Cloud string
(Required String) The cloud service provider that the Schema Registry cluster belongs to, for example, AWS.
DisplayName string
(Required String) The name of the Schema Registry cluster, for example, Stream Governance Package.
Environment Pulumi.ConfluentCloud.Outputs.GetSchemaRegistryClusterEnvironment
Id string
(Required String) The ID of the Schema Registry cluster, for example, lsrc-abc123.
Kind string
(Required String) A kind of the Schema Registry cluster, for example, Cluster.
Package string
(Required String) The type of the billing package. Accepted values are: ESSENTIALS and ADVANCED.
PrivateRegionalRestEndpoints Dictionary<string, string>
(Required Map) The private regional HTTP endpoint map of the Schema Registry cluster. For example, to reference the endpoint corresponding to the us-central-1 region, use private_regional_rest_endpoints["us-central-1"].
PrivateRestEndpoint string
(Required String, Deprecated) The private HTTP endpoint of the Schema Registry cluster, for example, https://lsrc.us-west-2.aws.private.confluent.cloud. Please use the private_regional_rest_endpoints attribute instead, which supersedes the private_rest_endpoint attribute.

Deprecated: Please use the private_regional_rest_endpoints attribute instead, which supersedes the private_rest_endpoint attribute.

Region string
(Required String) The ID of the Schema Registry region that the Schema Registry cluster belongs to, for example, us-east4.
ResourceName string
(Required String) The Confluent Resource Name of the Schema Registry cluster, for example, crn://confluent.cloud/organization=1111aaaa-11aa-11aa-11aa-111111aaaaaa/environment=env-abc123/schema-registry=lsrc-abc123.
RestEndpoint string
(Required String) The HTTP endpoint of the Schema Registry cluster, for example, https://psrc-00000.us-west-2.aws.confluent.cloud.
ApiVersion string
(Required String) An API Version of the schema version of the Schema Registry cluster, for example, stream-governance/v2.
CatalogEndpoint string
(Required String) The Catalog endpoint of the Schema Registry cluster, for example, https://psrc-y1113.us-west-2.aws.confluent.cloud.
Cloud string
(Required String) The cloud service provider that the Schema Registry cluster belongs to, for example, AWS.
DisplayName string
(Required String) The name of the Schema Registry cluster, for example, Stream Governance Package.
Environment GetSchemaRegistryClusterEnvironment
Id string
(Required String) The ID of the Schema Registry cluster, for example, lsrc-abc123.
Kind string
(Required String) A kind of the Schema Registry cluster, for example, Cluster.
Package string
(Required String) The type of the billing package. Accepted values are: ESSENTIALS and ADVANCED.
PrivateRegionalRestEndpoints map[string]string
(Required Map) The private regional HTTP endpoint map of the Schema Registry cluster. For example, to reference the endpoint corresponding to the us-central-1 region, use private_regional_rest_endpoints["us-central-1"].
PrivateRestEndpoint string
(Required String, Deprecated) The private HTTP endpoint of the Schema Registry cluster, for example, https://lsrc.us-west-2.aws.private.confluent.cloud. Please use the private_regional_rest_endpoints attribute instead, which supersedes the private_rest_endpoint attribute.

Deprecated: Please use the private_regional_rest_endpoints attribute instead, which supersedes the private_rest_endpoint attribute.

Region string
(Required String) The ID of the Schema Registry region that the Schema Registry cluster belongs to, for example, us-east4.
ResourceName string
(Required String) The Confluent Resource Name of the Schema Registry cluster, for example, crn://confluent.cloud/organization=1111aaaa-11aa-11aa-11aa-111111aaaaaa/environment=env-abc123/schema-registry=lsrc-abc123.
RestEndpoint string
(Required String) The HTTP endpoint of the Schema Registry cluster, for example, https://psrc-00000.us-west-2.aws.confluent.cloud.
apiVersion String
(Required String) An API Version of the schema version of the Schema Registry cluster, for example, stream-governance/v2.
catalogEndpoint String
(Required String) The Catalog endpoint of the Schema Registry cluster, for example, https://psrc-y1113.us-west-2.aws.confluent.cloud.
cloud String
(Required String) The cloud service provider that the Schema Registry cluster belongs to, for example, AWS.
displayName String
(Required String) The name of the Schema Registry cluster, for example, Stream Governance Package.
environment GetSchemaRegistryClusterEnvironment
id String
(Required String) The ID of the Schema Registry cluster, for example, lsrc-abc123.
kind String
(Required String) A kind of the Schema Registry cluster, for example, Cluster.
package_ String
(Required String) The type of the billing package. Accepted values are: ESSENTIALS and ADVANCED.
privateRegionalRestEndpoints Map<String,String>
(Required Map) The private regional HTTP endpoint map of the Schema Registry cluster. For example, to reference the endpoint corresponding to the us-central-1 region, use private_regional_rest_endpoints["us-central-1"].
privateRestEndpoint String
(Required String, Deprecated) The private HTTP endpoint of the Schema Registry cluster, for example, https://lsrc.us-west-2.aws.private.confluent.cloud. Please use the private_regional_rest_endpoints attribute instead, which supersedes the private_rest_endpoint attribute.

Deprecated: Please use the private_regional_rest_endpoints attribute instead, which supersedes the private_rest_endpoint attribute.

region String
(Required String) The ID of the Schema Registry region that the Schema Registry cluster belongs to, for example, us-east4.
resourceName String
(Required String) The Confluent Resource Name of the Schema Registry cluster, for example, crn://confluent.cloud/organization=1111aaaa-11aa-11aa-11aa-111111aaaaaa/environment=env-abc123/schema-registry=lsrc-abc123.
restEndpoint String
(Required String) The HTTP endpoint of the Schema Registry cluster, for example, https://psrc-00000.us-west-2.aws.confluent.cloud.
apiVersion string
(Required String) An API Version of the schema version of the Schema Registry cluster, for example, stream-governance/v2.
catalogEndpoint string
(Required String) The Catalog endpoint of the Schema Registry cluster, for example, https://psrc-y1113.us-west-2.aws.confluent.cloud.
cloud string
(Required String) The cloud service provider that the Schema Registry cluster belongs to, for example, AWS.
displayName string
(Required String) The name of the Schema Registry cluster, for example, Stream Governance Package.
environment GetSchemaRegistryClusterEnvironment
id string
(Required String) The ID of the Schema Registry cluster, for example, lsrc-abc123.
kind string
(Required String) A kind of the Schema Registry cluster, for example, Cluster.
package string
(Required String) The type of the billing package. Accepted values are: ESSENTIALS and ADVANCED.
privateRegionalRestEndpoints {[key: string]: string}
(Required Map) The private regional HTTP endpoint map of the Schema Registry cluster. For example, to reference the endpoint corresponding to the us-central-1 region, use private_regional_rest_endpoints["us-central-1"].
privateRestEndpoint string
(Required String, Deprecated) The private HTTP endpoint of the Schema Registry cluster, for example, https://lsrc.us-west-2.aws.private.confluent.cloud. Please use the private_regional_rest_endpoints attribute instead, which supersedes the private_rest_endpoint attribute.

Deprecated: Please use the private_regional_rest_endpoints attribute instead, which supersedes the private_rest_endpoint attribute.

region string
(Required String) The ID of the Schema Registry region that the Schema Registry cluster belongs to, for example, us-east4.
resourceName string
(Required String) The Confluent Resource Name of the Schema Registry cluster, for example, crn://confluent.cloud/organization=1111aaaa-11aa-11aa-11aa-111111aaaaaa/environment=env-abc123/schema-registry=lsrc-abc123.
restEndpoint string
(Required String) The HTTP endpoint of the Schema Registry cluster, for example, https://psrc-00000.us-west-2.aws.confluent.cloud.
api_version str
(Required String) An API Version of the schema version of the Schema Registry cluster, for example, stream-governance/v2.
catalog_endpoint str
(Required String) The Catalog endpoint of the Schema Registry cluster, for example, https://psrc-y1113.us-west-2.aws.confluent.cloud.
cloud str
(Required String) The cloud service provider that the Schema Registry cluster belongs to, for example, AWS.
display_name str
(Required String) The name of the Schema Registry cluster, for example, Stream Governance Package.
environment GetSchemaRegistryClusterEnvironment
id str
(Required String) The ID of the Schema Registry cluster, for example, lsrc-abc123.
kind str
(Required String) A kind of the Schema Registry cluster, for example, Cluster.
package str
(Required String) The type of the billing package. Accepted values are: ESSENTIALS and ADVANCED.
private_regional_rest_endpoints Mapping[str, str]
(Required Map) The private regional HTTP endpoint map of the Schema Registry cluster. For example, to reference the endpoint corresponding to the us-central-1 region, use private_regional_rest_endpoints["us-central-1"].
private_rest_endpoint str
(Required String, Deprecated) The private HTTP endpoint of the Schema Registry cluster, for example, https://lsrc.us-west-2.aws.private.confluent.cloud. Please use the private_regional_rest_endpoints attribute instead, which supersedes the private_rest_endpoint attribute.

Deprecated: Please use the private_regional_rest_endpoints attribute instead, which supersedes the private_rest_endpoint attribute.

region str
(Required String) The ID of the Schema Registry region that the Schema Registry cluster belongs to, for example, us-east4.
resource_name str
(Required String) The Confluent Resource Name of the Schema Registry cluster, for example, crn://confluent.cloud/organization=1111aaaa-11aa-11aa-11aa-111111aaaaaa/environment=env-abc123/schema-registry=lsrc-abc123.
rest_endpoint str
(Required String) The HTTP endpoint of the Schema Registry cluster, for example, https://psrc-00000.us-west-2.aws.confluent.cloud.
apiVersion String
(Required String) An API Version of the schema version of the Schema Registry cluster, for example, stream-governance/v2.
catalogEndpoint String
(Required String) The Catalog endpoint of the Schema Registry cluster, for example, https://psrc-y1113.us-west-2.aws.confluent.cloud.
cloud String
(Required String) The cloud service provider that the Schema Registry cluster belongs to, for example, AWS.
displayName String
(Required String) The name of the Schema Registry cluster, for example, Stream Governance Package.
environment Property Map
id String
(Required String) The ID of the Schema Registry cluster, for example, lsrc-abc123.
kind String
(Required String) A kind of the Schema Registry cluster, for example, Cluster.
package String
(Required String) The type of the billing package. Accepted values are: ESSENTIALS and ADVANCED.
privateRegionalRestEndpoints Map<String>
(Required Map) The private regional HTTP endpoint map of the Schema Registry cluster. For example, to reference the endpoint corresponding to the us-central-1 region, use private_regional_rest_endpoints["us-central-1"].
privateRestEndpoint String
(Required String, Deprecated) The private HTTP endpoint of the Schema Registry cluster, for example, https://lsrc.us-west-2.aws.private.confluent.cloud. Please use the private_regional_rest_endpoints attribute instead, which supersedes the private_rest_endpoint attribute.

Deprecated: Please use the private_regional_rest_endpoints attribute instead, which supersedes the private_rest_endpoint attribute.

region String
(Required String) The ID of the Schema Registry region that the Schema Registry cluster belongs to, for example, us-east4.
resourceName String
(Required String) The Confluent Resource Name of the Schema Registry cluster, for example, crn://confluent.cloud/organization=1111aaaa-11aa-11aa-11aa-111111aaaaaa/environment=env-abc123/schema-registry=lsrc-abc123.
restEndpoint String
(Required String) The HTTP endpoint of the Schema Registry cluster, for example, https://psrc-00000.us-west-2.aws.confluent.cloud.

Supporting Types

GetSchemaRegistryClusterEnvironment

Id This property is required. string
The ID of the Environment that the Schema Registry cluster belongs to, for example, env-xyz456.
Id This property is required. string
The ID of the Environment that the Schema Registry cluster belongs to, for example, env-xyz456.
id This property is required. String
The ID of the Environment that the Schema Registry cluster belongs to, for example, env-xyz456.
id This property is required. string
The ID of the Environment that the Schema Registry cluster belongs to, for example, env-xyz456.
id This property is required. str
The ID of the Environment that the Schema Registry cluster belongs to, for example, env-xyz456.
id This property is required. String
The ID of the Environment that the Schema Registry cluster belongs to, for example, env-xyz456.

Package Details

Repository
Confluent Cloud pulumi/pulumi-confluentcloud
License
Apache-2.0
Notes
This Pulumi package is based on the confluent Terraform Provider.
Confluent v2.24.0 published on Saturday, Apr 19, 2025 by Pulumi
pulumi/pulumi-confluentcloud