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

confluentcloud.SchemaExporter

Explore with Pulumi AI

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

General Availability

confluentcloud.SchemaExporter provides a Schema Exporter resource that enables creating, editing, and deleting Schema Exporters on Confluent Cloud.

Example Usage

Option #1: Manage multiple Schema Registry clusters in the same Pulumi Stack

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

const main = new confluentcloud.SchemaExporter("main", {
    schemaRegistryCluster: {
        id: essentials.id,
    },
    restEndpoint: essentials.restEndpoint,
    credentials: {
        key: "<Schema Registry API Key for data.confluent_schema_registry_cluster.essentials>",
        secret: "<Schema Registry API Secret for data.confluent_schema_registry_cluster.essentials>",
    },
    name: "test-exporter",
    subjects: ["foo"],
    destinationSchemaRegistryCluster: {
        restEndpoint: destination.restEndpoint,
        credentials: {
            key: "<Schema Registry API Key for data.confluent_schema_registry_cluster.destination>",
            secret: "<Schema Registry API Secret for data.confluent_schema_registry_cluster.destination>",
        },
    },
});
Copy
import pulumi
import pulumi_confluentcloud as confluentcloud

main = confluentcloud.SchemaExporter("main",
    schema_registry_cluster={
        "id": essentials["id"],
    },
    rest_endpoint=essentials["restEndpoint"],
    credentials={
        "key": "<Schema Registry API Key for data.confluent_schema_registry_cluster.essentials>",
        "secret": "<Schema Registry API Secret for data.confluent_schema_registry_cluster.essentials>",
    },
    name="test-exporter",
    subjects=["foo"],
    destination_schema_registry_cluster={
        "rest_endpoint": destination["restEndpoint"],
        "credentials": {
            "key": "<Schema Registry API Key for data.confluent_schema_registry_cluster.destination>",
            "secret": "<Schema Registry API Secret for data.confluent_schema_registry_cluster.destination>",
        },
    })
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 {
		_, err := confluentcloud.NewSchemaExporter(ctx, "main", &confluentcloud.SchemaExporterArgs{
			SchemaRegistryCluster: &confluentcloud.SchemaExporterSchemaRegistryClusterArgs{
				Id: pulumi.Any(essentials.Id),
			},
			RestEndpoint: pulumi.Any(essentials.RestEndpoint),
			Credentials: &confluentcloud.SchemaExporterCredentialsArgs{
				Key:    pulumi.String("<Schema Registry API Key for data.confluent_schema_registry_cluster.essentials>"),
				Secret: pulumi.String("<Schema Registry API Secret for data.confluent_schema_registry_cluster.essentials>"),
			},
			Name: pulumi.String("test-exporter"),
			Subjects: pulumi.StringArray{
				pulumi.String("foo"),
			},
			DestinationSchemaRegistryCluster: &confluentcloud.SchemaExporterDestinationSchemaRegistryClusterArgs{
				RestEndpoint: pulumi.Any(destination.RestEndpoint),
				Credentials: &confluentcloud.SchemaExporterDestinationSchemaRegistryClusterCredentialsArgs{
					Key:    pulumi.String("<Schema Registry API Key for data.confluent_schema_registry_cluster.destination>"),
					Secret: pulumi.String("<Schema Registry API Secret for data.confluent_schema_registry_cluster.destination>"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using ConfluentCloud = Pulumi.ConfluentCloud;

return await Deployment.RunAsync(() => 
{
    var main = new ConfluentCloud.SchemaExporter("main", new()
    {
        SchemaRegistryCluster = new ConfluentCloud.Inputs.SchemaExporterSchemaRegistryClusterArgs
        {
            Id = essentials.Id,
        },
        RestEndpoint = essentials.RestEndpoint,
        Credentials = new ConfluentCloud.Inputs.SchemaExporterCredentialsArgs
        {
            Key = "<Schema Registry API Key for data.confluent_schema_registry_cluster.essentials>",
            Secret = "<Schema Registry API Secret for data.confluent_schema_registry_cluster.essentials>",
        },
        Name = "test-exporter",
        Subjects = new[]
        {
            "foo",
        },
        DestinationSchemaRegistryCluster = new ConfluentCloud.Inputs.SchemaExporterDestinationSchemaRegistryClusterArgs
        {
            RestEndpoint = destination.RestEndpoint,
            Credentials = new ConfluentCloud.Inputs.SchemaExporterDestinationSchemaRegistryClusterCredentialsArgs
            {
                Key = "<Schema Registry API Key for data.confluent_schema_registry_cluster.destination>",
                Secret = "<Schema Registry API Secret for data.confluent_schema_registry_cluster.destination>",
            },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.confluentcloud.SchemaExporter;
import com.pulumi.confluentcloud.SchemaExporterArgs;
import com.pulumi.confluentcloud.inputs.SchemaExporterSchemaRegistryClusterArgs;
import com.pulumi.confluentcloud.inputs.SchemaExporterCredentialsArgs;
import com.pulumi.confluentcloud.inputs.SchemaExporterDestinationSchemaRegistryClusterArgs;
import com.pulumi.confluentcloud.inputs.SchemaExporterDestinationSchemaRegistryClusterCredentialsArgs;
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 main = new SchemaExporter("main", SchemaExporterArgs.builder()
            .schemaRegistryCluster(SchemaExporterSchemaRegistryClusterArgs.builder()
                .id(essentials.id())
                .build())
            .restEndpoint(essentials.restEndpoint())
            .credentials(SchemaExporterCredentialsArgs.builder()
                .key("<Schema Registry API Key for data.confluent_schema_registry_cluster.essentials>")
                .secret("<Schema Registry API Secret for data.confluent_schema_registry_cluster.essentials>")
                .build())
            .name("test-exporter")
            .subjects("foo")
            .destinationSchemaRegistryCluster(SchemaExporterDestinationSchemaRegistryClusterArgs.builder()
                .restEndpoint(destination.restEndpoint())
                .credentials(SchemaExporterDestinationSchemaRegistryClusterCredentialsArgs.builder()
                    .key("<Schema Registry API Key for data.confluent_schema_registry_cluster.destination>")
                    .secret("<Schema Registry API Secret for data.confluent_schema_registry_cluster.destination>")
                    .build())
                .build())
            .build());

    }
}
Copy
resources:
  main:
    type: confluentcloud:SchemaExporter
    properties:
      schemaRegistryCluster:
        id: ${essentials.id}
      restEndpoint: ${essentials.restEndpoint}
      credentials:
        key: <Schema Registry API Key for data.confluent_schema_registry_cluster.essentials>
        secret: <Schema Registry API Secret for data.confluent_schema_registry_cluster.essentials>
      name: test-exporter
      subjects:
        - foo
      destinationSchemaRegistryCluster:
        restEndpoint: ${destination.restEndpoint}
        credentials:
          key: <Schema Registry API Key for data.confluent_schema_registry_cluster.destination>
          secret: <Schema Registry API Secret for data.confluent_schema_registry_cluster.destination>
Copy

Option #2: Manage a single Schema Registry cluster in the same Pulumi Stack

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

const main = new confluentcloud.SchemaExporter("main", {
    name: "test-exporter",
    subjects: ["foo"],
    destinationSchemaRegistryCluster: {
        restEndpoint: destination.restEndpoint,
        credentials: {
            key: "<Schema Registry API Key for data.confluent_schema_registry_cluster.destination>",
            secret: "<Schema Registry API Secret for data.confluent_schema_registry_cluster.destination>",
        },
    },
});
Copy
import pulumi
import pulumi_confluentcloud as confluentcloud

main = confluentcloud.SchemaExporter("main",
    name="test-exporter",
    subjects=["foo"],
    destination_schema_registry_cluster={
        "rest_endpoint": destination["restEndpoint"],
        "credentials": {
            "key": "<Schema Registry API Key for data.confluent_schema_registry_cluster.destination>",
            "secret": "<Schema Registry API Secret for data.confluent_schema_registry_cluster.destination>",
        },
    })
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 {
		_, err := confluentcloud.NewSchemaExporter(ctx, "main", &confluentcloud.SchemaExporterArgs{
			Name: pulumi.String("test-exporter"),
			Subjects: pulumi.StringArray{
				pulumi.String("foo"),
			},
			DestinationSchemaRegistryCluster: &confluentcloud.SchemaExporterDestinationSchemaRegistryClusterArgs{
				RestEndpoint: pulumi.Any(destination.RestEndpoint),
				Credentials: &confluentcloud.SchemaExporterDestinationSchemaRegistryClusterCredentialsArgs{
					Key:    pulumi.String("<Schema Registry API Key for data.confluent_schema_registry_cluster.destination>"),
					Secret: pulumi.String("<Schema Registry API Secret for data.confluent_schema_registry_cluster.destination>"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using ConfluentCloud = Pulumi.ConfluentCloud;

return await Deployment.RunAsync(() => 
{
    var main = new ConfluentCloud.SchemaExporter("main", new()
    {
        Name = "test-exporter",
        Subjects = new[]
        {
            "foo",
        },
        DestinationSchemaRegistryCluster = new ConfluentCloud.Inputs.SchemaExporterDestinationSchemaRegistryClusterArgs
        {
            RestEndpoint = destination.RestEndpoint,
            Credentials = new ConfluentCloud.Inputs.SchemaExporterDestinationSchemaRegistryClusterCredentialsArgs
            {
                Key = "<Schema Registry API Key for data.confluent_schema_registry_cluster.destination>",
                Secret = "<Schema Registry API Secret for data.confluent_schema_registry_cluster.destination>",
            },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.confluentcloud.SchemaExporter;
import com.pulumi.confluentcloud.SchemaExporterArgs;
import com.pulumi.confluentcloud.inputs.SchemaExporterDestinationSchemaRegistryClusterArgs;
import com.pulumi.confluentcloud.inputs.SchemaExporterDestinationSchemaRegistryClusterCredentialsArgs;
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 main = new SchemaExporter("main", SchemaExporterArgs.builder()
            .name("test-exporter")
            .subjects("foo")
            .destinationSchemaRegistryCluster(SchemaExporterDestinationSchemaRegistryClusterArgs.builder()
                .restEndpoint(destination.restEndpoint())
                .credentials(SchemaExporterDestinationSchemaRegistryClusterCredentialsArgs.builder()
                    .key("<Schema Registry API Key for data.confluent_schema_registry_cluster.destination>")
                    .secret("<Schema Registry API Secret for data.confluent_schema_registry_cluster.destination>")
                    .build())
                .build())
            .build());

    }
}
Copy
resources:
  main:
    type: confluentcloud:SchemaExporter
    properties:
      name: test-exporter
      subjects:
        - foo
      destinationSchemaRegistryCluster:
        restEndpoint: ${destination.restEndpoint}
        credentials:
          key: <Schema Registry API Key for data.confluent_schema_registry_cluster.destination>
          secret: <Schema Registry API Secret for data.confluent_schema_registry_cluster.destination>
Copy

Create SchemaExporter Resource

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

Constructor syntax

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

@overload
def SchemaExporter(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   destination_schema_registry_cluster: Optional[SchemaExporterDestinationSchemaRegistryClusterArgs] = None,
                   config: Optional[Mapping[str, str]] = None,
                   context: Optional[str] = None,
                   context_type: Optional[str] = None,
                   credentials: Optional[SchemaExporterCredentialsArgs] = None,
                   name: Optional[str] = None,
                   reset_on_update: Optional[bool] = None,
                   rest_endpoint: Optional[str] = None,
                   schema_registry_cluster: Optional[SchemaExporterSchemaRegistryClusterArgs] = None,
                   status: Optional[str] = None,
                   subject_rename_format: Optional[str] = None,
                   subjects: Optional[Sequence[str]] = None)
func NewSchemaExporter(ctx *Context, name string, args SchemaExporterArgs, opts ...ResourceOption) (*SchemaExporter, error)
public SchemaExporter(string name, SchemaExporterArgs args, CustomResourceOptions? opts = null)
public SchemaExporter(String name, SchemaExporterArgs args)
public SchemaExporter(String name, SchemaExporterArgs args, CustomResourceOptions options)

type: confluentcloud:SchemaExporter
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. SchemaExporterArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. SchemaExporterArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. SchemaExporterArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. SchemaExporterArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. SchemaExporterArgs
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 schemaExporterResource = new ConfluentCloud.SchemaExporter("schemaExporterResource", new()
{
    DestinationSchemaRegistryCluster = new ConfluentCloud.Inputs.SchemaExporterDestinationSchemaRegistryClusterArgs
    {
        Credentials = new ConfluentCloud.Inputs.SchemaExporterDestinationSchemaRegistryClusterCredentialsArgs
        {
            Key = "string",
            Secret = "string",
        },
        RestEndpoint = "string",
    },
    Config = 
    {
        { "string", "string" },
    },
    Context = "string",
    ContextType = "string",
    Credentials = new ConfluentCloud.Inputs.SchemaExporterCredentialsArgs
    {
        Key = "string",
        Secret = "string",
    },
    Name = "string",
    ResetOnUpdate = false,
    RestEndpoint = "string",
    SchemaRegistryCluster = new ConfluentCloud.Inputs.SchemaExporterSchemaRegistryClusterArgs
    {
        Id = "string",
    },
    Status = "string",
    SubjectRenameFormat = "string",
    Subjects = new[]
    {
        "string",
    },
});
Copy
example, err := confluentcloud.NewSchemaExporter(ctx, "schemaExporterResource", &confluentcloud.SchemaExporterArgs{
	DestinationSchemaRegistryCluster: &confluentcloud.SchemaExporterDestinationSchemaRegistryClusterArgs{
		Credentials: &confluentcloud.SchemaExporterDestinationSchemaRegistryClusterCredentialsArgs{
			Key:    pulumi.String("string"),
			Secret: pulumi.String("string"),
		},
		RestEndpoint: pulumi.String("string"),
	},
	Config: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Context:     pulumi.String("string"),
	ContextType: pulumi.String("string"),
	Credentials: &confluentcloud.SchemaExporterCredentialsArgs{
		Key:    pulumi.String("string"),
		Secret: pulumi.String("string"),
	},
	Name:          pulumi.String("string"),
	ResetOnUpdate: pulumi.Bool(false),
	RestEndpoint:  pulumi.String("string"),
	SchemaRegistryCluster: &confluentcloud.SchemaExporterSchemaRegistryClusterArgs{
		Id: pulumi.String("string"),
	},
	Status:              pulumi.String("string"),
	SubjectRenameFormat: pulumi.String("string"),
	Subjects: pulumi.StringArray{
		pulumi.String("string"),
	},
})
Copy
var schemaExporterResource = new SchemaExporter("schemaExporterResource", SchemaExporterArgs.builder()
    .destinationSchemaRegistryCluster(SchemaExporterDestinationSchemaRegistryClusterArgs.builder()
        .credentials(SchemaExporterDestinationSchemaRegistryClusterCredentialsArgs.builder()
            .key("string")
            .secret("string")
            .build())
        .restEndpoint("string")
        .build())
    .config(Map.of("string", "string"))
    .context("string")
    .contextType("string")
    .credentials(SchemaExporterCredentialsArgs.builder()
        .key("string")
        .secret("string")
        .build())
    .name("string")
    .resetOnUpdate(false)
    .restEndpoint("string")
    .schemaRegistryCluster(SchemaExporterSchemaRegistryClusterArgs.builder()
        .id("string")
        .build())
    .status("string")
    .subjectRenameFormat("string")
    .subjects("string")
    .build());
Copy
schema_exporter_resource = confluentcloud.SchemaExporter("schemaExporterResource",
    destination_schema_registry_cluster={
        "credentials": {
            "key": "string",
            "secret": "string",
        },
        "rest_endpoint": "string",
    },
    config={
        "string": "string",
    },
    context="string",
    context_type="string",
    credentials={
        "key": "string",
        "secret": "string",
    },
    name="string",
    reset_on_update=False,
    rest_endpoint="string",
    schema_registry_cluster={
        "id": "string",
    },
    status="string",
    subject_rename_format="string",
    subjects=["string"])
Copy
const schemaExporterResource = new confluentcloud.SchemaExporter("schemaExporterResource", {
    destinationSchemaRegistryCluster: {
        credentials: {
            key: "string",
            secret: "string",
        },
        restEndpoint: "string",
    },
    config: {
        string: "string",
    },
    context: "string",
    contextType: "string",
    credentials: {
        key: "string",
        secret: "string",
    },
    name: "string",
    resetOnUpdate: false,
    restEndpoint: "string",
    schemaRegistryCluster: {
        id: "string",
    },
    status: "string",
    subjectRenameFormat: "string",
    subjects: ["string"],
});
Copy
type: confluentcloud:SchemaExporter
properties:
    config:
        string: string
    context: string
    contextType: string
    credentials:
        key: string
        secret: string
    destinationSchemaRegistryCluster:
        credentials:
            key: string
            secret: string
        restEndpoint: string
    name: string
    resetOnUpdate: false
    restEndpoint: string
    schemaRegistryCluster:
        id: string
    status: string
    subjectRenameFormat: string
    subjects:
        - string
Copy

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

DestinationSchemaRegistryCluster This property is required. Pulumi.ConfluentCloud.Inputs.SchemaExporterDestinationSchemaRegistryCluster
Config Dictionary<string, string>
Block for custom nonsensitive configuration properties:
Context string
Customized context of the exporter if context_type is set to CUSTOM.
ContextType string
Context type of the exporter. Accepted values are: CUSTOM, NONE or AUTO. Defaults to AUTO.
Credentials Pulumi.ConfluentCloud.Inputs.SchemaExporterCredentials
The Cluster API Credentials.
Name Changes to this property will trigger replacement. string
Name of the Schema Exporter.
ResetOnUpdate bool
The flag to control whether to reset the exporter when updating configs. Defaults to false.
RestEndpoint Changes to this property will trigger replacement. string
The REST endpoint of the Schema Registry cluster, for example, https://psrc-00000.us-central1.gcp.confluent.cloud:443).
SchemaRegistryCluster Changes to this property will trigger replacement. Pulumi.ConfluentCloud.Inputs.SchemaExporterSchemaRegistryCluster
Status string
The status of the schema exporter. Accepted values are: RUNNING and PAUSED.
SubjectRenameFormat string
Format string for the subject name in the destination cluster, which may contain ${subject} as a placeholder for the originating subject name. For example, dc_${subject} for the subject orders will map to the destination subject name dc_orders.
Subjects List<string>
Name of each exporter subject.
DestinationSchemaRegistryCluster This property is required. SchemaExporterDestinationSchemaRegistryClusterArgs
Config map[string]string
Block for custom nonsensitive configuration properties:
Context string
Customized context of the exporter if context_type is set to CUSTOM.
ContextType string
Context type of the exporter. Accepted values are: CUSTOM, NONE or AUTO. Defaults to AUTO.
Credentials SchemaExporterCredentialsArgs
The Cluster API Credentials.
Name Changes to this property will trigger replacement. string
Name of the Schema Exporter.
ResetOnUpdate bool
The flag to control whether to reset the exporter when updating configs. Defaults to false.
RestEndpoint Changes to this property will trigger replacement. string
The REST endpoint of the Schema Registry cluster, for example, https://psrc-00000.us-central1.gcp.confluent.cloud:443).
SchemaRegistryCluster Changes to this property will trigger replacement. SchemaExporterSchemaRegistryClusterArgs
Status string
The status of the schema exporter. Accepted values are: RUNNING and PAUSED.
SubjectRenameFormat string
Format string for the subject name in the destination cluster, which may contain ${subject} as a placeholder for the originating subject name. For example, dc_${subject} for the subject orders will map to the destination subject name dc_orders.
Subjects []string
Name of each exporter subject.
destinationSchemaRegistryCluster This property is required. SchemaExporterDestinationSchemaRegistryCluster
config Map<String,String>
Block for custom nonsensitive configuration properties:
context String
Customized context of the exporter if context_type is set to CUSTOM.
contextType String
Context type of the exporter. Accepted values are: CUSTOM, NONE or AUTO. Defaults to AUTO.
credentials SchemaExporterCredentials
The Cluster API Credentials.
name Changes to this property will trigger replacement. String
Name of the Schema Exporter.
resetOnUpdate Boolean
The flag to control whether to reset the exporter when updating configs. Defaults to false.
restEndpoint Changes to this property will trigger replacement. String
The REST endpoint of the Schema Registry cluster, for example, https://psrc-00000.us-central1.gcp.confluent.cloud:443).
schemaRegistryCluster Changes to this property will trigger replacement. SchemaExporterSchemaRegistryCluster
status String
The status of the schema exporter. Accepted values are: RUNNING and PAUSED.
subjectRenameFormat String
Format string for the subject name in the destination cluster, which may contain ${subject} as a placeholder for the originating subject name. For example, dc_${subject} for the subject orders will map to the destination subject name dc_orders.
subjects List<String>
Name of each exporter subject.
destinationSchemaRegistryCluster This property is required. SchemaExporterDestinationSchemaRegistryCluster
config {[key: string]: string}
Block for custom nonsensitive configuration properties:
context string
Customized context of the exporter if context_type is set to CUSTOM.
contextType string
Context type of the exporter. Accepted values are: CUSTOM, NONE or AUTO. Defaults to AUTO.
credentials SchemaExporterCredentials
The Cluster API Credentials.
name Changes to this property will trigger replacement. string
Name of the Schema Exporter.
resetOnUpdate boolean
The flag to control whether to reset the exporter when updating configs. Defaults to false.
restEndpoint Changes to this property will trigger replacement. string
The REST endpoint of the Schema Registry cluster, for example, https://psrc-00000.us-central1.gcp.confluent.cloud:443).
schemaRegistryCluster Changes to this property will trigger replacement. SchemaExporterSchemaRegistryCluster
status string
The status of the schema exporter. Accepted values are: RUNNING and PAUSED.
subjectRenameFormat string
Format string for the subject name in the destination cluster, which may contain ${subject} as a placeholder for the originating subject name. For example, dc_${subject} for the subject orders will map to the destination subject name dc_orders.
subjects string[]
Name of each exporter subject.
destination_schema_registry_cluster This property is required. SchemaExporterDestinationSchemaRegistryClusterArgs
config Mapping[str, str]
Block for custom nonsensitive configuration properties:
context str
Customized context of the exporter if context_type is set to CUSTOM.
context_type str
Context type of the exporter. Accepted values are: CUSTOM, NONE or AUTO. Defaults to AUTO.
credentials SchemaExporterCredentialsArgs
The Cluster API Credentials.
name Changes to this property will trigger replacement. str
Name of the Schema Exporter.
reset_on_update bool
The flag to control whether to reset the exporter when updating configs. Defaults to false.
rest_endpoint Changes to this property will trigger replacement. str
The REST endpoint of the Schema Registry cluster, for example, https://psrc-00000.us-central1.gcp.confluent.cloud:443).
schema_registry_cluster Changes to this property will trigger replacement. SchemaExporterSchemaRegistryClusterArgs
status str
The status of the schema exporter. Accepted values are: RUNNING and PAUSED.
subject_rename_format str
Format string for the subject name in the destination cluster, which may contain ${subject} as a placeholder for the originating subject name. For example, dc_${subject} for the subject orders will map to the destination subject name dc_orders.
subjects Sequence[str]
Name of each exporter subject.
destinationSchemaRegistryCluster This property is required. Property Map
config Map<String>
Block for custom nonsensitive configuration properties:
context String
Customized context of the exporter if context_type is set to CUSTOM.
contextType String
Context type of the exporter. Accepted values are: CUSTOM, NONE or AUTO. Defaults to AUTO.
credentials Property Map
The Cluster API Credentials.
name Changes to this property will trigger replacement. String
Name of the Schema Exporter.
resetOnUpdate Boolean
The flag to control whether to reset the exporter when updating configs. Defaults to false.
restEndpoint Changes to this property will trigger replacement. String
The REST endpoint of the Schema Registry cluster, for example, https://psrc-00000.us-central1.gcp.confluent.cloud:443).
schemaRegistryCluster Changes to this property will trigger replacement. Property Map
status String
The status of the schema exporter. Accepted values are: RUNNING and PAUSED.
subjectRenameFormat String
Format string for the subject name in the destination cluster, which may contain ${subject} as a placeholder for the originating subject name. For example, dc_${subject} for the subject orders will map to the destination subject name dc_orders.
subjects List<String>
Name of each exporter subject.

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing SchemaExporter Resource

Get an existing SchemaExporter 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?: SchemaExporterState, opts?: CustomResourceOptions): SchemaExporter
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        config: Optional[Mapping[str, str]] = None,
        context: Optional[str] = None,
        context_type: Optional[str] = None,
        credentials: Optional[SchemaExporterCredentialsArgs] = None,
        destination_schema_registry_cluster: Optional[SchemaExporterDestinationSchemaRegistryClusterArgs] = None,
        name: Optional[str] = None,
        reset_on_update: Optional[bool] = None,
        rest_endpoint: Optional[str] = None,
        schema_registry_cluster: Optional[SchemaExporterSchemaRegistryClusterArgs] = None,
        status: Optional[str] = None,
        subject_rename_format: Optional[str] = None,
        subjects: Optional[Sequence[str]] = None) -> SchemaExporter
func GetSchemaExporter(ctx *Context, name string, id IDInput, state *SchemaExporterState, opts ...ResourceOption) (*SchemaExporter, error)
public static SchemaExporter Get(string name, Input<string> id, SchemaExporterState? state, CustomResourceOptions? opts = null)
public static SchemaExporter get(String name, Output<String> id, SchemaExporterState state, CustomResourceOptions options)
resources:  _:    type: confluentcloud:SchemaExporter    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
Config Dictionary<string, string>
Block for custom nonsensitive configuration properties:
Context string
Customized context of the exporter if context_type is set to CUSTOM.
ContextType string
Context type of the exporter. Accepted values are: CUSTOM, NONE or AUTO. Defaults to AUTO.
Credentials Pulumi.ConfluentCloud.Inputs.SchemaExporterCredentials
The Cluster API Credentials.
DestinationSchemaRegistryCluster Pulumi.ConfluentCloud.Inputs.SchemaExporterDestinationSchemaRegistryCluster
Name Changes to this property will trigger replacement. string
Name of the Schema Exporter.
ResetOnUpdate bool
The flag to control whether to reset the exporter when updating configs. Defaults to false.
RestEndpoint Changes to this property will trigger replacement. string
The REST endpoint of the Schema Registry cluster, for example, https://psrc-00000.us-central1.gcp.confluent.cloud:443).
SchemaRegistryCluster Changes to this property will trigger replacement. Pulumi.ConfluentCloud.Inputs.SchemaExporterSchemaRegistryCluster
Status string
The status of the schema exporter. Accepted values are: RUNNING and PAUSED.
SubjectRenameFormat string
Format string for the subject name in the destination cluster, which may contain ${subject} as a placeholder for the originating subject name. For example, dc_${subject} for the subject orders will map to the destination subject name dc_orders.
Subjects List<string>
Name of each exporter subject.
Config map[string]string
Block for custom nonsensitive configuration properties:
Context string
Customized context of the exporter if context_type is set to CUSTOM.
ContextType string
Context type of the exporter. Accepted values are: CUSTOM, NONE or AUTO. Defaults to AUTO.
Credentials SchemaExporterCredentialsArgs
The Cluster API Credentials.
DestinationSchemaRegistryCluster SchemaExporterDestinationSchemaRegistryClusterArgs
Name Changes to this property will trigger replacement. string
Name of the Schema Exporter.
ResetOnUpdate bool
The flag to control whether to reset the exporter when updating configs. Defaults to false.
RestEndpoint Changes to this property will trigger replacement. string
The REST endpoint of the Schema Registry cluster, for example, https://psrc-00000.us-central1.gcp.confluent.cloud:443).
SchemaRegistryCluster Changes to this property will trigger replacement. SchemaExporterSchemaRegistryClusterArgs
Status string
The status of the schema exporter. Accepted values are: RUNNING and PAUSED.
SubjectRenameFormat string
Format string for the subject name in the destination cluster, which may contain ${subject} as a placeholder for the originating subject name. For example, dc_${subject} for the subject orders will map to the destination subject name dc_orders.
Subjects []string
Name of each exporter subject.
config Map<String,String>
Block for custom nonsensitive configuration properties:
context String
Customized context of the exporter if context_type is set to CUSTOM.
contextType String
Context type of the exporter. Accepted values are: CUSTOM, NONE or AUTO. Defaults to AUTO.
credentials SchemaExporterCredentials
The Cluster API Credentials.
destinationSchemaRegistryCluster SchemaExporterDestinationSchemaRegistryCluster
name Changes to this property will trigger replacement. String
Name of the Schema Exporter.
resetOnUpdate Boolean
The flag to control whether to reset the exporter when updating configs. Defaults to false.
restEndpoint Changes to this property will trigger replacement. String
The REST endpoint of the Schema Registry cluster, for example, https://psrc-00000.us-central1.gcp.confluent.cloud:443).
schemaRegistryCluster Changes to this property will trigger replacement. SchemaExporterSchemaRegistryCluster
status String
The status of the schema exporter. Accepted values are: RUNNING and PAUSED.
subjectRenameFormat String
Format string for the subject name in the destination cluster, which may contain ${subject} as a placeholder for the originating subject name. For example, dc_${subject} for the subject orders will map to the destination subject name dc_orders.
subjects List<String>
Name of each exporter subject.
config {[key: string]: string}
Block for custom nonsensitive configuration properties:
context string
Customized context of the exporter if context_type is set to CUSTOM.
contextType string
Context type of the exporter. Accepted values are: CUSTOM, NONE or AUTO. Defaults to AUTO.
credentials SchemaExporterCredentials
The Cluster API Credentials.
destinationSchemaRegistryCluster SchemaExporterDestinationSchemaRegistryCluster
name Changes to this property will trigger replacement. string
Name of the Schema Exporter.
resetOnUpdate boolean
The flag to control whether to reset the exporter when updating configs. Defaults to false.
restEndpoint Changes to this property will trigger replacement. string
The REST endpoint of the Schema Registry cluster, for example, https://psrc-00000.us-central1.gcp.confluent.cloud:443).
schemaRegistryCluster Changes to this property will trigger replacement. SchemaExporterSchemaRegistryCluster
status string
The status of the schema exporter. Accepted values are: RUNNING and PAUSED.
subjectRenameFormat string
Format string for the subject name in the destination cluster, which may contain ${subject} as a placeholder for the originating subject name. For example, dc_${subject} for the subject orders will map to the destination subject name dc_orders.
subjects string[]
Name of each exporter subject.
config Mapping[str, str]
Block for custom nonsensitive configuration properties:
context str
Customized context of the exporter if context_type is set to CUSTOM.
context_type str
Context type of the exporter. Accepted values are: CUSTOM, NONE or AUTO. Defaults to AUTO.
credentials SchemaExporterCredentialsArgs
The Cluster API Credentials.
destination_schema_registry_cluster SchemaExporterDestinationSchemaRegistryClusterArgs
name Changes to this property will trigger replacement. str
Name of the Schema Exporter.
reset_on_update bool
The flag to control whether to reset the exporter when updating configs. Defaults to false.
rest_endpoint Changes to this property will trigger replacement. str
The REST endpoint of the Schema Registry cluster, for example, https://psrc-00000.us-central1.gcp.confluent.cloud:443).
schema_registry_cluster Changes to this property will trigger replacement. SchemaExporterSchemaRegistryClusterArgs
status str
The status of the schema exporter. Accepted values are: RUNNING and PAUSED.
subject_rename_format str
Format string for the subject name in the destination cluster, which may contain ${subject} as a placeholder for the originating subject name. For example, dc_${subject} for the subject orders will map to the destination subject name dc_orders.
subjects Sequence[str]
Name of each exporter subject.
config Map<String>
Block for custom nonsensitive configuration properties:
context String
Customized context of the exporter if context_type is set to CUSTOM.
contextType String
Context type of the exporter. Accepted values are: CUSTOM, NONE or AUTO. Defaults to AUTO.
credentials Property Map
The Cluster API Credentials.
destinationSchemaRegistryCluster Property Map
name Changes to this property will trigger replacement. String
Name of the Schema Exporter.
resetOnUpdate Boolean
The flag to control whether to reset the exporter when updating configs. Defaults to false.
restEndpoint Changes to this property will trigger replacement. String
The REST endpoint of the Schema Registry cluster, for example, https://psrc-00000.us-central1.gcp.confluent.cloud:443).
schemaRegistryCluster Changes to this property will trigger replacement. Property Map
status String
The status of the schema exporter. Accepted values are: RUNNING and PAUSED.
subjectRenameFormat String
Format string for the subject name in the destination cluster, which may contain ${subject} as a placeholder for the originating subject name. For example, dc_${subject} for the subject orders will map to the destination subject name dc_orders.
subjects List<String>
Name of each exporter subject.

Supporting Types

SchemaExporterCredentials
, SchemaExporterCredentialsArgs

Key This property is required. string
The Schema Registry API Key.
Secret This property is required. string
The Schema Registry API Secret.
Key This property is required. string
The Schema Registry API Key.
Secret This property is required. string
The Schema Registry API Secret.
key This property is required. String
The Schema Registry API Key.
secret This property is required. String
The Schema Registry API Secret.
key This property is required. string
The Schema Registry API Key.
secret This property is required. string
The Schema Registry API Secret.
key This property is required. str
The Schema Registry API Key.
secret This property is required. str
The Schema Registry API Secret.
key This property is required. String
The Schema Registry API Key.
secret This property is required. String
The Schema Registry API Secret.

SchemaExporterDestinationSchemaRegistryCluster
, SchemaExporterDestinationSchemaRegistryClusterArgs

Credentials This property is required. Pulumi.ConfluentCloud.Inputs.SchemaExporterDestinationSchemaRegistryClusterCredentials
RestEndpoint This property is required. string
The REST endpoint of the destination Schema Registry cluster, for example, https://pkc-00000.us-central1.gcp.confluent.cloud:443).
Credentials This property is required. SchemaExporterDestinationSchemaRegistryClusterCredentials
RestEndpoint This property is required. string
The REST endpoint of the destination Schema Registry cluster, for example, https://pkc-00000.us-central1.gcp.confluent.cloud:443).
credentials This property is required. SchemaExporterDestinationSchemaRegistryClusterCredentials
restEndpoint This property is required. String
The REST endpoint of the destination Schema Registry cluster, for example, https://pkc-00000.us-central1.gcp.confluent.cloud:443).
credentials This property is required. SchemaExporterDestinationSchemaRegistryClusterCredentials
restEndpoint This property is required. string
The REST endpoint of the destination Schema Registry cluster, for example, https://pkc-00000.us-central1.gcp.confluent.cloud:443).
credentials This property is required. SchemaExporterDestinationSchemaRegistryClusterCredentials
rest_endpoint This property is required. str
The REST endpoint of the destination Schema Registry cluster, for example, https://pkc-00000.us-central1.gcp.confluent.cloud:443).
credentials This property is required. Property Map
restEndpoint This property is required. String
The REST endpoint of the destination Schema Registry cluster, for example, https://pkc-00000.us-central1.gcp.confluent.cloud:443).

SchemaExporterDestinationSchemaRegistryClusterCredentials
, SchemaExporterDestinationSchemaRegistryClusterCredentialsArgs

Key This property is required. string
The Schema Registry API Key.
Secret This property is required. string
The Schema Registry API Secret.
Key This property is required. string
The Schema Registry API Key.
Secret This property is required. string
The Schema Registry API Secret.
key This property is required. String
The Schema Registry API Key.
secret This property is required. String
The Schema Registry API Secret.
key This property is required. string
The Schema Registry API Key.
secret This property is required. string
The Schema Registry API Secret.
key This property is required. str
The Schema Registry API Key.
secret This property is required. str
The Schema Registry API Secret.
key This property is required. String
The Schema Registry API Key.
secret This property is required. String
The Schema Registry API Secret.

SchemaExporterSchemaRegistryCluster
, SchemaExporterSchemaRegistryClusterArgs

Id
This property is required.
Changes to this property will trigger replacement.
string
The ID of the Schema Registry cluster, for example, lsrc-abc123.
Id
This property is required.
Changes to this property will trigger replacement.
string
The ID of the Schema Registry cluster, for example, lsrc-abc123.
id
This property is required.
Changes to this property will trigger replacement.
String
The ID of the Schema Registry cluster, for example, lsrc-abc123.
id
This property is required.
Changes to this property will trigger replacement.
string
The ID of the Schema Registry cluster, for example, lsrc-abc123.
id
This property is required.
Changes to this property will trigger replacement.
str
The ID of the Schema Registry cluster, for example, lsrc-abc123.
id
This property is required.
Changes to this property will trigger replacement.
String
The ID of the Schema Registry cluster, for example, lsrc-abc123.

Import

You can import a Schema Exporter by using the Schema Registry cluster ID, Schema Exporter name in the format <Schema Registry cluster ID>/<Schema Exporter name>, for example:

$ export IMPORT_SCHEMA_REGISTRY_ID="<schema_registry_cluster_id>"

$ export IMPORT_SCHEMA_REGISTRY_API_KEY="<schema_registry_api_key>"

$ export IMPORT_SCHEMA_REGISTRY_API_SECRET="<schema_registry_api_secret>"

$ export IMPORT_SCHEMA_REGISTRY_REST_ENDPOINT="<schema_registry_rest_endpoint>"

$ pulumi import confluentcloud:index/schemaExporter:SchemaExporter main lsrc-8wrx70/test-exporter
Copy

!> Warning: Do not forget to delete terminal command history afterwards for security purposes.

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

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