Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Confluent Provider
  3. API Docs
  4. SubjectConfig
Confluent v2.28.0 published on Wednesday, May 14, 2025 by Pulumi
pulumi/pulumi-confluentcloud

confluentcloud.SubjectConfig

Explore with Pulumi AI

confluentcloud logo
Confluent v2.28.0 published on Wednesday, May 14, 2025 by Pulumi
pulumi/pulumi-confluentcloud

    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 example = new confluentcloud.SubjectConfig("example", {
    schemaRegistryCluster: {
        id: essentials.id,
    },
    restEndpoint: essentialsConfluentSchemaRegistryCluster.restEndpoint,
    subjectName: "proto-purchase-value",
    compatibilityLevel: "BACKWARD",
    compatibilityGroup: "abc.cg.version",
    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>",
    },
});

    import pulumi
import pulumi_confluentcloud as confluentcloud

example = confluentcloud.SubjectConfig("example",
    schema_registry_cluster={
        "id": essentials["id"],
    },
    rest_endpoint=essentials_confluent_schema_registry_cluster["restEndpoint"],
    subject_name="proto-purchase-value",
    compatibility_level="BACKWARD",
    compatibility_group="abc.cg.version",
    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>",
    })

    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.NewSubjectConfig(ctx, "example", &confluentcloud.SubjectConfigArgs{
			SchemaRegistryCluster: &confluentcloud.SubjectConfigSchemaRegistryClusterArgs{
				Id: pulumi.Any(essentials.Id),
			},
			RestEndpoint:       pulumi.Any(essentialsConfluentSchemaRegistryCluster.RestEndpoint),
			SubjectName:        pulumi.String("proto-purchase-value"),
			CompatibilityLevel: pulumi.String("BACKWARD"),
			CompatibilityGroup: pulumi.String("abc.cg.version"),
			Credentials: &confluentcloud.SubjectConfigCredentialsArgs{
				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>"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = new ConfluentCloud.SubjectConfig("example", new()
    {
        SchemaRegistryCluster = new ConfluentCloud.Inputs.SubjectConfigSchemaRegistryClusterArgs
        {
            Id = essentials.Id,
        },
        RestEndpoint = essentialsConfluentSchemaRegistryCluster.RestEndpoint,
        SubjectName = "proto-purchase-value",
        CompatibilityLevel = "BACKWARD",
        CompatibilityGroup = "abc.cg.version",
        Credentials = new ConfluentCloud.Inputs.SubjectConfigCredentialsArgs
        {
            Key = "<Schema Registry API Key for data.confluent_schema_registry_cluster.essentials>",
            Secret = "<Schema Registry API Secret for data.confluent_schema_registry_cluster.essentials>",
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.confluentcloud.SubjectConfig;
import com.pulumi.confluentcloud.SubjectConfigArgs;
import com.pulumi.confluentcloud.inputs.SubjectConfigSchemaRegistryClusterArgs;
import com.pulumi.confluentcloud.inputs.SubjectConfigCredentialsArgs;
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 example = new SubjectConfig("example", SubjectConfigArgs.builder()
            .schemaRegistryCluster(SubjectConfigSchemaRegistryClusterArgs.builder()
                .id(essentials.id())
                .build())
            .restEndpoint(essentialsConfluentSchemaRegistryCluster.restEndpoint())
            .subjectName("proto-purchase-value")
            .compatibilityLevel("BACKWARD")
            .compatibilityGroup("abc.cg.version")
            .credentials(SubjectConfigCredentialsArgs.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())
            .build());

    }
}

    resources:
  example:
    type: confluentcloud:SubjectConfig
    properties:
      schemaRegistryCluster:
        id: ${essentials.id}
      restEndpoint: ${essentialsConfluentSchemaRegistryCluster.restEndpoint}
      subjectName: proto-purchase-value
      compatibilityLevel: BACKWARD
      compatibilityGroup: abc.cg.version
      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>

    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 example = new confluentcloud.SubjectConfig("example", {
    subjectName: "proto-purchase-value",
    compatibilityLevel: "BACKWARD",
    compatibilityGroup: "abc.cg.version",
});

    import pulumi
import pulumi_confluentcloud as confluentcloud

example = confluentcloud.SubjectConfig("example",
    subject_name="proto-purchase-value",
    compatibility_level="BACKWARD",
    compatibility_group="abc.cg.version")

    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.NewSubjectConfig(ctx, "example", &confluentcloud.SubjectConfigArgs{
			SubjectName:        pulumi.String("proto-purchase-value"),
			CompatibilityLevel: pulumi.String("BACKWARD"),
			CompatibilityGroup: pulumi.String("abc.cg.version"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = new ConfluentCloud.SubjectConfig("example", new()
    {
        SubjectName = "proto-purchase-value",
        CompatibilityLevel = "BACKWARD",
        CompatibilityGroup = "abc.cg.version",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.confluentcloud.SubjectConfig;
import com.pulumi.confluentcloud.SubjectConfigArgs;
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 example = new SubjectConfig("example", SubjectConfigArgs.builder()
            .subjectName("proto-purchase-value")
            .compatibilityLevel("BACKWARD")
            .compatibilityGroup("abc.cg.version")
            .build());

    }
}

    resources:
  example:
    type: confluentcloud:SubjectConfig
    properties:
      subjectName: proto-purchase-value
      compatibilityLevel: BACKWARD
      compatibilityGroup: abc.cg.version

    Create SubjectConfig Resource

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

    Constructor syntax

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

@overload
def SubjectConfig(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  subject_name: Optional[str] = None,
                  compatibility_group: Optional[str] = None,
                  compatibility_level: Optional[str] = None,
                  credentials: Optional[SubjectConfigCredentialsArgs] = None,
                  rest_endpoint: Optional[str] = None,
                  schema_registry_cluster: Optional[SubjectConfigSchemaRegistryClusterArgs] = None)
    func NewSubjectConfig(ctx *Context, name string, args SubjectConfigArgs, opts ...ResourceOption) (*SubjectConfig, error)
    public SubjectConfig(string name, SubjectConfigArgs args, CustomResourceOptions? opts = null)
    public SubjectConfig(String name, SubjectConfigArgs args)
public SubjectConfig(String name, SubjectConfigArgs args, CustomResourceOptions options)

    type: confluentcloud:SubjectConfig
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 SubjectConfigArgs
    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 SubjectConfigArgs
    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 SubjectConfigArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SubjectConfigArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SubjectConfigArgs
    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 subjectConfigResource = new ConfluentCloud.SubjectConfig("subjectConfigResource", new()
{
    SubjectName = "string",
    CompatibilityGroup = "string",
    CompatibilityLevel = "string",
    Credentials = new ConfluentCloud.Inputs.SubjectConfigCredentialsArgs
    {
        Key = "string",
        Secret = "string",
    },
    RestEndpoint = "string",
    SchemaRegistryCluster = new ConfluentCloud.Inputs.SubjectConfigSchemaRegistryClusterArgs
    {
        Id = "string",
    },
});

    example, err := confluentcloud.NewSubjectConfig(ctx, "subjectConfigResource", &confluentcloud.SubjectConfigArgs{
	SubjectName:        pulumi.String("string"),
	CompatibilityGroup: pulumi.String("string"),
	CompatibilityLevel: pulumi.String("string"),
	Credentials: &confluentcloud.SubjectConfigCredentialsArgs{
		Key:    pulumi.String("string"),
		Secret: pulumi.String("string"),
	},
	RestEndpoint: pulumi.String("string"),
	SchemaRegistryCluster: &confluentcloud.SubjectConfigSchemaRegistryClusterArgs{
		Id: pulumi.String("string"),
	},
})

    var subjectConfigResource = new SubjectConfig("subjectConfigResource", SubjectConfigArgs.builder()
    .subjectName("string")
    .compatibilityGroup("string")
    .compatibilityLevel("string")
    .credentials(SubjectConfigCredentialsArgs.builder()
        .key("string")
        .secret("string")
        .build())
    .restEndpoint("string")
    .schemaRegistryCluster(SubjectConfigSchemaRegistryClusterArgs.builder()
        .id("string")
        .build())
    .build());

    subject_config_resource = confluentcloud.SubjectConfig("subjectConfigResource",
    subject_name="string",
    compatibility_group="string",
    compatibility_level="string",
    credentials={
        "key": "string",
        "secret": "string",
    },
    rest_endpoint="string",
    schema_registry_cluster={
        "id": "string",
    })

    const subjectConfigResource = new confluentcloud.SubjectConfig("subjectConfigResource", {
    subjectName: "string",
    compatibilityGroup: "string",
    compatibilityLevel: "string",
    credentials: {
        key: "string",
        secret: "string",
    },
    restEndpoint: "string",
    schemaRegistryCluster: {
        id: "string",
    },
});

    type: confluentcloud:SubjectConfig
properties:
    compatibilityGroup: string
    compatibilityLevel: string
    credentials:
        key: string
        secret: string
    restEndpoint: string
    schemaRegistryCluster:
        id: string
    subjectName: string

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

    SubjectName string

    The name of the subject (in other words, the namespace), representing the subject under which the schema will be registered, for example, test-subject.

    Note: If you want to reference the subject that is located in a custom context, use the following naming pattern: :.contextName:subjectName. For example, use subject_name = ":.context1:test-subject" to reference the subject named test-subject in the context1 context, and use subject_name = "test-subject" to reference the subject named test-subject in the default context.

    Note: To configure a config at the context level, affecting all subjects created within that context, use the following naming pattern: :.contextName:. For example, to set the global configuration for the context1 context, use subject_name = ":.context1:".

    CompatibilityGroup string
    The Compatibility Group of the specified subject.
    CompatibilityLevel string
    The Compatibility Level of the specified subject. Accepted values are: BACKWARD, BACKWARD_TRANSITIVE, FORWARD, FORWARD_TRANSITIVE, FULL, FULL_TRANSITIVE, and NONE. See the Compatibility Types for more details.
    Credentials Pulumi.ConfluentCloud.Inputs.SubjectConfigCredentials
    The Cluster API Credentials.
    RestEndpoint string
    The REST endpoint of the Schema Registry cluster, for example, https://psrc-00000.us-central1.gcp.confluent.cloud:443).
    SchemaRegistryCluster Pulumi.ConfluentCloud.Inputs.SubjectConfigSchemaRegistryCluster
    SubjectName string

    The name of the subject (in other words, the namespace), representing the subject under which the schema will be registered, for example, test-subject.

    Note: If you want to reference the subject that is located in a custom context, use the following naming pattern: :.contextName:subjectName. For example, use subject_name = ":.context1:test-subject" to reference the subject named test-subject in the context1 context, and use subject_name = "test-subject" to reference the subject named test-subject in the default context.

    Note: To configure a config at the context level, affecting all subjects created within that context, use the following naming pattern: :.contextName:. For example, to set the global configuration for the context1 context, use subject_name = ":.context1:".

    CompatibilityGroup string
    The Compatibility Group of the specified subject.
    CompatibilityLevel string
    The Compatibility Level of the specified subject. Accepted values are: BACKWARD, BACKWARD_TRANSITIVE, FORWARD, FORWARD_TRANSITIVE, FULL, FULL_TRANSITIVE, and NONE. See the Compatibility Types for more details.
    Credentials SubjectConfigCredentialsArgs
    The Cluster API Credentials.
    RestEndpoint string
    The REST endpoint of the Schema Registry cluster, for example, https://psrc-00000.us-central1.gcp.confluent.cloud:443).
    SchemaRegistryCluster SubjectConfigSchemaRegistryClusterArgs
    subjectName String

    The name of the subject (in other words, the namespace), representing the subject under which the schema will be registered, for example, test-subject.

    Note: If you want to reference the subject that is located in a custom context, use the following naming pattern: :.contextName:subjectName. For example, use subject_name = ":.context1:test-subject" to reference the subject named test-subject in the context1 context, and use subject_name = "test-subject" to reference the subject named test-subject in the default context.

    Note: To configure a config at the context level, affecting all subjects created within that context, use the following naming pattern: :.contextName:. For example, to set the global configuration for the context1 context, use subject_name = ":.context1:".

    compatibilityGroup String
    The Compatibility Group of the specified subject.
    compatibilityLevel String
    The Compatibility Level of the specified subject. Accepted values are: BACKWARD, BACKWARD_TRANSITIVE, FORWARD, FORWARD_TRANSITIVE, FULL, FULL_TRANSITIVE, and NONE. See the Compatibility Types for more details.
    credentials SubjectConfigCredentials
    The Cluster API Credentials.
    restEndpoint String
    The REST endpoint of the Schema Registry cluster, for example, https://psrc-00000.us-central1.gcp.confluent.cloud:443).
    schemaRegistryCluster SubjectConfigSchemaRegistryCluster
    subjectName string

    The name of the subject (in other words, the namespace), representing the subject under which the schema will be registered, for example, test-subject.

    Note: If you want to reference the subject that is located in a custom context, use the following naming pattern: :.contextName:subjectName. For example, use subject_name = ":.context1:test-subject" to reference the subject named test-subject in the context1 context, and use subject_name = "test-subject" to reference the subject named test-subject in the default context.

    Note: To configure a config at the context level, affecting all subjects created within that context, use the following naming pattern: :.contextName:. For example, to set the global configuration for the context1 context, use subject_name = ":.context1:".

    compatibilityGroup string
    The Compatibility Group of the specified subject.
    compatibilityLevel string
    The Compatibility Level of the specified subject. Accepted values are: BACKWARD, BACKWARD_TRANSITIVE, FORWARD, FORWARD_TRANSITIVE, FULL, FULL_TRANSITIVE, and NONE. See the Compatibility Types for more details.
    credentials SubjectConfigCredentials
    The Cluster API Credentials.
    restEndpoint string
    The REST endpoint of the Schema Registry cluster, for example, https://psrc-00000.us-central1.gcp.confluent.cloud:443).
    schemaRegistryCluster SubjectConfigSchemaRegistryCluster
    subject_name str

    The name of the subject (in other words, the namespace), representing the subject under which the schema will be registered, for example, test-subject.

    Note: If you want to reference the subject that is located in a custom context, use the following naming pattern: :.contextName:subjectName. For example, use subject_name = ":.context1:test-subject" to reference the subject named test-subject in the context1 context, and use subject_name = "test-subject" to reference the subject named test-subject in the default context.

    Note: To configure a config at the context level, affecting all subjects created within that context, use the following naming pattern: :.contextName:. For example, to set the global configuration for the context1 context, use subject_name = ":.context1:".

    compatibility_group str
    The Compatibility Group of the specified subject.
    compatibility_level str
    The Compatibility Level of the specified subject. Accepted values are: BACKWARD, BACKWARD_TRANSITIVE, FORWARD, FORWARD_TRANSITIVE, FULL, FULL_TRANSITIVE, and NONE. See the Compatibility Types for more details.
    credentials SubjectConfigCredentialsArgs
    The Cluster API Credentials.
    rest_endpoint str
    The REST endpoint of the Schema Registry cluster, for example, https://psrc-00000.us-central1.gcp.confluent.cloud:443).
    schema_registry_cluster SubjectConfigSchemaRegistryClusterArgs
    subjectName String

    The name of the subject (in other words, the namespace), representing the subject under which the schema will be registered, for example, test-subject.

    Note: If you want to reference the subject that is located in a custom context, use the following naming pattern: :.contextName:subjectName. For example, use subject_name = ":.context1:test-subject" to reference the subject named test-subject in the context1 context, and use subject_name = "test-subject" to reference the subject named test-subject in the default context.

    Note: To configure a config at the context level, affecting all subjects created within that context, use the following naming pattern: :.contextName:. For example, to set the global configuration for the context1 context, use subject_name = ":.context1:".

    compatibilityGroup String
    The Compatibility Group of the specified subject.
    compatibilityLevel String
    The Compatibility Level of the specified subject. Accepted values are: BACKWARD, BACKWARD_TRANSITIVE, FORWARD, FORWARD_TRANSITIVE, FULL, FULL_TRANSITIVE, and NONE. See the Compatibility Types for more details.
    credentials Property Map
    The Cluster API Credentials.
    restEndpoint String
    The REST endpoint of the Schema Registry cluster, for example, https://psrc-00000.us-central1.gcp.confluent.cloud:443).
    schemaRegistryCluster Property Map

    Outputs

    All input properties are implicitly available as output properties. Additionally, the SubjectConfig 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 SubjectConfig Resource

    Get an existing SubjectConfig 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?: SubjectConfigState, opts?: CustomResourceOptions): SubjectConfig
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        compatibility_group: Optional[str] = None,
        compatibility_level: Optional[str] = None,
        credentials: Optional[SubjectConfigCredentialsArgs] = None,
        rest_endpoint: Optional[str] = None,
        schema_registry_cluster: Optional[SubjectConfigSchemaRegistryClusterArgs] = None,
        subject_name: Optional[str] = None) -> SubjectConfig
    func GetSubjectConfig(ctx *Context, name string, id IDInput, state *SubjectConfigState, opts ...ResourceOption) (*SubjectConfig, error)
    public static SubjectConfig Get(string name, Input<string> id, SubjectConfigState? state, CustomResourceOptions? opts = null)
    public static SubjectConfig get(String name, Output<String> id, SubjectConfigState state, CustomResourceOptions options)
    resources:  _:    type: confluentcloud:SubjectConfig    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:
    CompatibilityGroup string
    The Compatibility Group of the specified subject.
    CompatibilityLevel string
    The Compatibility Level of the specified subject. Accepted values are: BACKWARD, BACKWARD_TRANSITIVE, FORWARD, FORWARD_TRANSITIVE, FULL, FULL_TRANSITIVE, and NONE. See the Compatibility Types for more details.
    Credentials Pulumi.ConfluentCloud.Inputs.SubjectConfigCredentials
    The Cluster API Credentials.
    RestEndpoint string
    The REST endpoint of the Schema Registry cluster, for example, https://psrc-00000.us-central1.gcp.confluent.cloud:443).
    SchemaRegistryCluster Pulumi.ConfluentCloud.Inputs.SubjectConfigSchemaRegistryCluster
    SubjectName string

    The name of the subject (in other words, the namespace), representing the subject under which the schema will be registered, for example, test-subject.

    Note: If you want to reference the subject that is located in a custom context, use the following naming pattern: :.contextName:subjectName. For example, use subject_name = ":.context1:test-subject" to reference the subject named test-subject in the context1 context, and use subject_name = "test-subject" to reference the subject named test-subject in the default context.

    Note: To configure a config at the context level, affecting all subjects created within that context, use the following naming pattern: :.contextName:. For example, to set the global configuration for the context1 context, use subject_name = ":.context1:".

    CompatibilityGroup string
    The Compatibility Group of the specified subject.
    CompatibilityLevel string
    The Compatibility Level of the specified subject. Accepted values are: BACKWARD, BACKWARD_TRANSITIVE, FORWARD, FORWARD_TRANSITIVE, FULL, FULL_TRANSITIVE, and NONE. See the Compatibility Types for more details.
    Credentials SubjectConfigCredentialsArgs
    The Cluster API Credentials.
    RestEndpoint string
    The REST endpoint of the Schema Registry cluster, for example, https://psrc-00000.us-central1.gcp.confluent.cloud:443).
    SchemaRegistryCluster SubjectConfigSchemaRegistryClusterArgs
    SubjectName string

    The name of the subject (in other words, the namespace), representing the subject under which the schema will be registered, for example, test-subject.

    Note: If you want to reference the subject that is located in a custom context, use the following naming pattern: :.contextName:subjectName. For example, use subject_name = ":.context1:test-subject" to reference the subject named test-subject in the context1 context, and use subject_name = "test-subject" to reference the subject named test-subject in the default context.

    Note: To configure a config at the context level, affecting all subjects created within that context, use the following naming pattern: :.contextName:. For example, to set the global configuration for the context1 context, use subject_name = ":.context1:".

    compatibilityGroup String
    The Compatibility Group of the specified subject.
    compatibilityLevel String
    The Compatibility Level of the specified subject. Accepted values are: BACKWARD, BACKWARD_TRANSITIVE, FORWARD, FORWARD_TRANSITIVE, FULL, FULL_TRANSITIVE, and NONE. See the Compatibility Types for more details.
    credentials SubjectConfigCredentials
    The Cluster API Credentials.
    restEndpoint String
    The REST endpoint of the Schema Registry cluster, for example, https://psrc-00000.us-central1.gcp.confluent.cloud:443).
    schemaRegistryCluster SubjectConfigSchemaRegistryCluster
    subjectName String

    The name of the subject (in other words, the namespace), representing the subject under which the schema will be registered, for example, test-subject.

    Note: If you want to reference the subject that is located in a custom context, use the following naming pattern: :.contextName:subjectName. For example, use subject_name = ":.context1:test-subject" to reference the subject named test-subject in the context1 context, and use subject_name = "test-subject" to reference the subject named test-subject in the default context.

    Note: To configure a config at the context level, affecting all subjects created within that context, use the following naming pattern: :.contextName:. For example, to set the global configuration for the context1 context, use subject_name = ":.context1:".

    compatibilityGroup string
    The Compatibility Group of the specified subject.
    compatibilityLevel string
    The Compatibility Level of the specified subject. Accepted values are: BACKWARD, BACKWARD_TRANSITIVE, FORWARD, FORWARD_TRANSITIVE, FULL, FULL_TRANSITIVE, and NONE. See the Compatibility Types for more details.
    credentials SubjectConfigCredentials
    The Cluster API Credentials.
    restEndpoint string
    The REST endpoint of the Schema Registry cluster, for example, https://psrc-00000.us-central1.gcp.confluent.cloud:443).
    schemaRegistryCluster SubjectConfigSchemaRegistryCluster
    subjectName string

    The name of the subject (in other words, the namespace), representing the subject under which the schema will be registered, for example, test-subject.

    Note: If you want to reference the subject that is located in a custom context, use the following naming pattern: :.contextName:subjectName. For example, use subject_name = ":.context1:test-subject" to reference the subject named test-subject in the context1 context, and use subject_name = "test-subject" to reference the subject named test-subject in the default context.

    Note: To configure a config at the context level, affecting all subjects created within that context, use the following naming pattern: :.contextName:. For example, to set the global configuration for the context1 context, use subject_name = ":.context1:".

    compatibility_group str
    The Compatibility Group of the specified subject.
    compatibility_level str
    The Compatibility Level of the specified subject. Accepted values are: BACKWARD, BACKWARD_TRANSITIVE, FORWARD, FORWARD_TRANSITIVE, FULL, FULL_TRANSITIVE, and NONE. See the Compatibility Types for more details.
    credentials SubjectConfigCredentialsArgs
    The Cluster API Credentials.
    rest_endpoint str
    The REST endpoint of the Schema Registry cluster, for example, https://psrc-00000.us-central1.gcp.confluent.cloud:443).
    schema_registry_cluster SubjectConfigSchemaRegistryClusterArgs
    subject_name str

    The name of the subject (in other words, the namespace), representing the subject under which the schema will be registered, for example, test-subject.

    Note: If you want to reference the subject that is located in a custom context, use the following naming pattern: :.contextName:subjectName. For example, use subject_name = ":.context1:test-subject" to reference the subject named test-subject in the context1 context, and use subject_name = "test-subject" to reference the subject named test-subject in the default context.

    Note: To configure a config at the context level, affecting all subjects created within that context, use the following naming pattern: :.contextName:. For example, to set the global configuration for the context1 context, use subject_name = ":.context1:".

    compatibilityGroup String
    The Compatibility Group of the specified subject.
    compatibilityLevel String
    The Compatibility Level of the specified subject. Accepted values are: BACKWARD, BACKWARD_TRANSITIVE, FORWARD, FORWARD_TRANSITIVE, FULL, FULL_TRANSITIVE, and NONE. See the Compatibility Types for more details.
    credentials Property Map
    The Cluster API Credentials.
    restEndpoint String
    The REST endpoint of the Schema Registry cluster, for example, https://psrc-00000.us-central1.gcp.confluent.cloud:443).
    schemaRegistryCluster Property Map
    subjectName String

    The name of the subject (in other words, the namespace), representing the subject under which the schema will be registered, for example, test-subject.

    Note: If you want to reference the subject that is located in a custom context, use the following naming pattern: :.contextName:subjectName. For example, use subject_name = ":.context1:test-subject" to reference the subject named test-subject in the context1 context, and use subject_name = "test-subject" to reference the subject named test-subject in the default context.

    Note: To configure a config at the context level, affecting all subjects created within that context, use the following naming pattern: :.contextName:. For example, to set the global configuration for the context1 context, use subject_name = ":.context1:".

    Supporting Types

    SubjectConfigCredentials, SubjectConfigCredentialsArgs

    Key string
    The Schema Registry API Key.
    Secret string
    The Cluster API Secret for your Confluent Cloud cluster.
    Key string
    The Schema Registry API Key.
    Secret string
    The Cluster API Secret for your Confluent Cloud cluster.
    key String
    The Schema Registry API Key.
    secret String
    The Cluster API Secret for your Confluent Cloud cluster.
    key string
    The Schema Registry API Key.
    secret string
    The Cluster API Secret for your Confluent Cloud cluster.
    key str
    The Schema Registry API Key.
    secret str
    The Cluster API Secret for your Confluent Cloud cluster.
    key String
    The Schema Registry API Key.
    secret String
    The Cluster API Secret for your Confluent Cloud cluster.

    SubjectConfigSchemaRegistryCluster, SubjectConfigSchemaRegistryClusterArgs

    Id string
    The ID of the Schema Registry cluster, for example, lsrc-abc123.
    Id string
    The ID of the Schema Registry cluster, for example, lsrc-abc123.
    id String
    The ID of the Schema Registry cluster, for example, lsrc-abc123.
    id string
    The ID of the Schema Registry cluster, for example, lsrc-abc123.
    id str
    The ID of the Schema Registry cluster, for example, lsrc-abc123.
    id String
    The ID of the Schema Registry cluster, for example, lsrc-abc123.

    Import

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

    $ 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/subjectConfig:SubjectConfig example lsrc-abc123/test-subject

    !> 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.
    confluentcloud logo
    Confluent v2.28.0 published on Wednesday, May 14, 2025 by Pulumi
    pulumi/pulumi-confluentcloud