1. Packages
  2. Packages
  3. Confluent Provider
  4. API Docs
  5. getSchema
Viewing docs for Confluent v1.53.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
Go to latest version
Schema (JSON)
pulumi/pulumi-confluentcloud

confluentcloud.getSchema

confluentcloud logo
Viewing docs for Confluent v1.53.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
Go to latest version
Schema (JSON)
pulumi/pulumi-confluentcloud

    Using getSchema

    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 getSchema(args: GetSchemaArgs, opts?: InvokeOptions): Promise<GetSchemaResult>
function getSchemaOutput(args: GetSchemaOutputArgs, opts?: InvokeOptions): Output<GetSchemaResult>
    def get_schema(credentials: Optional[GetSchemaCredentials] = None,
               metadata: Optional[GetSchemaMetadata] = None,
               rest_endpoint: Optional[str] = None,
               ruleset: Optional[GetSchemaRuleset] = None,
               schema_identifier: Optional[int] = None,
               schema_registry_cluster: Optional[GetSchemaSchemaRegistryCluster] = None,
               subject_name: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetSchemaResult
def get_schema_output(credentials: Optional[pulumi.Input[GetSchemaCredentialsArgs]] = None,
               metadata: Optional[pulumi.Input[GetSchemaMetadataArgs]] = None,
               rest_endpoint: Optional[pulumi.Input[str]] = None,
               ruleset: Optional[pulumi.Input[GetSchemaRulesetArgs]] = None,
               schema_identifier: Optional[pulumi.Input[int]] = None,
               schema_registry_cluster: Optional[pulumi.Input[GetSchemaSchemaRegistryClusterArgs]] = None,
               subject_name: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetSchemaResult]
    func LookupSchema(ctx *Context, args *LookupSchemaArgs, opts ...InvokeOption) (*LookupSchemaResult, error)
func LookupSchemaOutput(ctx *Context, args *LookupSchemaOutputArgs, opts ...InvokeOption) LookupSchemaResultOutput

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

    public static class GetSchema 
{
    public static Task<GetSchemaResult> InvokeAsync(GetSchemaArgs args, InvokeOptions? opts = null)
    public static Output<GetSchemaResult> Invoke(GetSchemaInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetSchemaResult> getSchema(GetSchemaArgs args, InvokeOptions options)
public static Output<GetSchemaResult> getSchema(GetSchemaArgs args, InvokeOptions options)

    fn::invoke:
  function: confluentcloud:index/getSchema:getSchema
  arguments:
    # arguments dictionary

    The following arguments are supported:

    SchemaIdentifier int

    The globally unique ID of the Schema, for example, 100003. If the same schema is registered under a different subject, the same identifier will be returned. However, the version of the schema may be different under different subjects.

    Note: A Schema Registry API key consists of a key and a secret. Schema Registry API keys are required to interact with Schema Registry clusters in Confluent Cloud. Each Schema Registry API key is valid for one specific Schema Registry cluster.

    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. Schemas evolve safely, following a compatibility mode defined, under a subject name.
    Credentials Pulumi.ConfluentCloud.Inputs.GetSchemaCredentials
    Metadata Pulumi.ConfluentCloud.Inputs.GetSchemaMetadata
    (Optional Block) See here for more details. Supports the following:
    RestEndpoint string
    The REST endpoint of the Schema Registry cluster, for example, https://psrc-00000.us-central1.gcp.confluent.cloud:443).
    Ruleset Pulumi.ConfluentCloud.Inputs.GetSchemaRuleset
    (Optional Block) The list of schema rules. See Data Contracts for Schema Registry for more details. For example, these rules can enforce that a field that contains sensitive information must be encrypted, or that a message containing an invalid age must be sent to a dead letter queue.
    SchemaRegistryCluster Pulumi.ConfluentCloud.Inputs.GetSchemaSchemaRegistryCluster
    SchemaIdentifier int

    The globally unique ID of the Schema, for example, 100003. If the same schema is registered under a different subject, the same identifier will be returned. However, the version of the schema may be different under different subjects.

    Note: A Schema Registry API key consists of a key and a secret. Schema Registry API keys are required to interact with Schema Registry clusters in Confluent Cloud. Each Schema Registry API key is valid for one specific Schema Registry cluster.

    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. Schemas evolve safely, following a compatibility mode defined, under a subject name.
    Credentials GetSchemaCredentials
    Metadata GetSchemaMetadata
    (Optional Block) See here for more details. Supports the following:
    RestEndpoint string
    The REST endpoint of the Schema Registry cluster, for example, https://psrc-00000.us-central1.gcp.confluent.cloud:443).
    Ruleset GetSchemaRuleset
    (Optional Block) The list of schema rules. See Data Contracts for Schema Registry for more details. For example, these rules can enforce that a field that contains sensitive information must be encrypted, or that a message containing an invalid age must be sent to a dead letter queue.
    SchemaRegistryCluster GetSchemaSchemaRegistryCluster
    schemaIdentifier Integer

    The globally unique ID of the Schema, for example, 100003. If the same schema is registered under a different subject, the same identifier will be returned. However, the version of the schema may be different under different subjects.

    Note: A Schema Registry API key consists of a key and a secret. Schema Registry API keys are required to interact with Schema Registry clusters in Confluent Cloud. Each Schema Registry API key is valid for one specific Schema Registry cluster.

    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. Schemas evolve safely, following a compatibility mode defined, under a subject name.
    credentials GetSchemaCredentials
    metadata GetSchemaMetadata
    (Optional Block) See here for more details. Supports the following:
    restEndpoint String
    The REST endpoint of the Schema Registry cluster, for example, https://psrc-00000.us-central1.gcp.confluent.cloud:443).
    ruleset GetSchemaRuleset
    (Optional Block) The list of schema rules. See Data Contracts for Schema Registry for more details. For example, these rules can enforce that a field that contains sensitive information must be encrypted, or that a message containing an invalid age must be sent to a dead letter queue.
    schemaRegistryCluster GetSchemaSchemaRegistryCluster
    schemaIdentifier number

    The globally unique ID of the Schema, for example, 100003. If the same schema is registered under a different subject, the same identifier will be returned. However, the version of the schema may be different under different subjects.

    Note: A Schema Registry API key consists of a key and a secret. Schema Registry API keys are required to interact with Schema Registry clusters in Confluent Cloud. Each Schema Registry API key is valid for one specific Schema Registry cluster.

    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. Schemas evolve safely, following a compatibility mode defined, under a subject name.
    credentials GetSchemaCredentials
    metadata GetSchemaMetadata
    (Optional Block) See here for more details. Supports the following:
    restEndpoint string
    The REST endpoint of the Schema Registry cluster, for example, https://psrc-00000.us-central1.gcp.confluent.cloud:443).
    ruleset GetSchemaRuleset
    (Optional Block) The list of schema rules. See Data Contracts for Schema Registry for more details. For example, these rules can enforce that a field that contains sensitive information must be encrypted, or that a message containing an invalid age must be sent to a dead letter queue.
    schemaRegistryCluster GetSchemaSchemaRegistryCluster
    schema_identifier int

    The globally unique ID of the Schema, for example, 100003. If the same schema is registered under a different subject, the same identifier will be returned. However, the version of the schema may be different under different subjects.

    Note: A Schema Registry API key consists of a key and a secret. Schema Registry API keys are required to interact with Schema Registry clusters in Confluent Cloud. Each Schema Registry API key is valid for one specific Schema Registry cluster.

    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. Schemas evolve safely, following a compatibility mode defined, under a subject name.
    credentials GetSchemaCredentials
    metadata GetSchemaMetadata
    (Optional Block) See here for more details. Supports the following:
    rest_endpoint str
    The REST endpoint of the Schema Registry cluster, for example, https://psrc-00000.us-central1.gcp.confluent.cloud:443).
    ruleset GetSchemaRuleset
    (Optional Block) The list of schema rules. See Data Contracts for Schema Registry for more details. For example, these rules can enforce that a field that contains sensitive information must be encrypted, or that a message containing an invalid age must be sent to a dead letter queue.
    schema_registry_cluster GetSchemaSchemaRegistryCluster
    schemaIdentifier Number

    The globally unique ID of the Schema, for example, 100003. If the same schema is registered under a different subject, the same identifier will be returned. However, the version of the schema may be different under different subjects.

    Note: A Schema Registry API key consists of a key and a secret. Schema Registry API keys are required to interact with Schema Registry clusters in Confluent Cloud. Each Schema Registry API key is valid for one specific Schema Registry cluster.

    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. Schemas evolve safely, following a compatibility mode defined, under a subject name.
    credentials Property Map
    metadata Property Map
    (Optional Block) See here for more details. Supports the following:
    restEndpoint String
    The REST endpoint of the Schema Registry cluster, for example, https://psrc-00000.us-central1.gcp.confluent.cloud:443).
    ruleset Property Map
    (Optional Block) The list of schema rules. See Data Contracts for Schema Registry for more details. For example, these rules can enforce that a field that contains sensitive information must be encrypted, or that a message containing an invalid age must be sent to a dead letter queue.
    schemaRegistryCluster Property Map

    getSchema Result

    The following output properties are available:

    Format string
    (Required String) The format of the schema. Accepted values are: AVRO, PROTOBUF, and JSON.
    HardDelete bool
    Id string
    The provider-assigned unique ID for this managed resource.
    Metadata Pulumi.ConfluentCloud.Outputs.GetSchemaMetadata
    (Optional Block) See here for more details. Supports the following:
    RecreateOnUpdate bool
    Ruleset Pulumi.ConfluentCloud.Outputs.GetSchemaRuleset
    (Optional Block) The list of schema rules. See Data Contracts for Schema Registry for more details. For example, these rules can enforce that a field that contains sensitive information must be encrypted, or that a message containing an invalid age must be sent to a dead letter queue.
    Schema string
    (Required String) The schema string, for example, file("./schema_version_1.avsc").
    SchemaIdentifier int
    SchemaReferences List<Pulumi.ConfluentCloud.Outputs.GetSchemaSchemaReference>
    (Optional List) The list of referenced schemas (see Schema References for more details):
    SkipValidationDuringPlan bool
    SubjectName string
    (Required String) The name for the reference. (For Avro Schema, the reference name is the fully qualified schema name, for JSON Schema it is a URL, and for Protobuf Schema, it is the name of another Protobuf file.)
    Version int
    (Required Integer) The version of the Schema, for example, 4.
    Credentials Pulumi.ConfluentCloud.Outputs.GetSchemaCredentials
    RestEndpoint string
    SchemaRegistryCluster Pulumi.ConfluentCloud.Outputs.GetSchemaSchemaRegistryCluster
    Format string
    (Required String) The format of the schema. Accepted values are: AVRO, PROTOBUF, and JSON.
    HardDelete bool
    Id string
    The provider-assigned unique ID for this managed resource.
    Metadata GetSchemaMetadata
    (Optional Block) See here for more details. Supports the following:
    RecreateOnUpdate bool
    Ruleset GetSchemaRuleset
    (Optional Block) The list of schema rules. See Data Contracts for Schema Registry for more details. For example, these rules can enforce that a field that contains sensitive information must be encrypted, or that a message containing an invalid age must be sent to a dead letter queue.
    Schema string
    (Required String) The schema string, for example, file("./schema_version_1.avsc").
    SchemaIdentifier int
    SchemaReferences []GetSchemaSchemaReference
    (Optional List) The list of referenced schemas (see Schema References for more details):
    SkipValidationDuringPlan bool
    SubjectName string
    (Required String) The name for the reference. (For Avro Schema, the reference name is the fully qualified schema name, for JSON Schema it is a URL, and for Protobuf Schema, it is the name of another Protobuf file.)
    Version int
    (Required Integer) The version of the Schema, for example, 4.
    Credentials GetSchemaCredentials
    RestEndpoint string
    SchemaRegistryCluster GetSchemaSchemaRegistryCluster
    format String
    (Required String) The format of the schema. Accepted values are: AVRO, PROTOBUF, and JSON.
    hardDelete Boolean
    id String
    The provider-assigned unique ID for this managed resource.
    metadata GetSchemaMetadata
    (Optional Block) See here for more details. Supports the following:
    recreateOnUpdate Boolean
    ruleset GetSchemaRuleset
    (Optional Block) The list of schema rules. See Data Contracts for Schema Registry for more details. For example, these rules can enforce that a field that contains sensitive information must be encrypted, or that a message containing an invalid age must be sent to a dead letter queue.
    schema String
    (Required String) The schema string, for example, file("./schema_version_1.avsc").
    schemaIdentifier Integer
    schemaReferences List<GetSchemaSchemaReference>
    (Optional List) The list of referenced schemas (see Schema References for more details):
    skipValidationDuringPlan Boolean
    subjectName String
    (Required String) The name for the reference. (For Avro Schema, the reference name is the fully qualified schema name, for JSON Schema it is a URL, and for Protobuf Schema, it is the name of another Protobuf file.)
    version Integer
    (Required Integer) The version of the Schema, for example, 4.
    credentials GetSchemaCredentials
    restEndpoint String
    schemaRegistryCluster GetSchemaSchemaRegistryCluster
    format string
    (Required String) The format of the schema. Accepted values are: AVRO, PROTOBUF, and JSON.
    hardDelete boolean
    id string
    The provider-assigned unique ID for this managed resource.
    metadata GetSchemaMetadata
    (Optional Block) See here for more details. Supports the following:
    recreateOnUpdate boolean
    ruleset GetSchemaRuleset
    (Optional Block) The list of schema rules. See Data Contracts for Schema Registry for more details. For example, these rules can enforce that a field that contains sensitive information must be encrypted, or that a message containing an invalid age must be sent to a dead letter queue.
    schema string
    (Required String) The schema string, for example, file("./schema_version_1.avsc").
    schemaIdentifier number
    schemaReferences GetSchemaSchemaReference[]
    (Optional List) The list of referenced schemas (see Schema References for more details):
    skipValidationDuringPlan boolean
    subjectName string
    (Required String) The name for the reference. (For Avro Schema, the reference name is the fully qualified schema name, for JSON Schema it is a URL, and for Protobuf Schema, it is the name of another Protobuf file.)
    version number
    (Required Integer) The version of the Schema, for example, 4.
    credentials GetSchemaCredentials
    restEndpoint string
    schemaRegistryCluster GetSchemaSchemaRegistryCluster
    format str
    (Required String) The format of the schema. Accepted values are: AVRO, PROTOBUF, and JSON.
    hard_delete bool
    id str
    The provider-assigned unique ID for this managed resource.
    metadata GetSchemaMetadata
    (Optional Block) See here for more details. Supports the following:
    recreate_on_update bool
    ruleset GetSchemaRuleset
    (Optional Block) The list of schema rules. See Data Contracts for Schema Registry for more details. For example, these rules can enforce that a field that contains sensitive information must be encrypted, or that a message containing an invalid age must be sent to a dead letter queue.
    schema str
    (Required String) The schema string, for example, file("./schema_version_1.avsc").
    schema_identifier int
    schema_references Sequence[GetSchemaSchemaReference]
    (Optional List) The list of referenced schemas (see Schema References for more details):
    skip_validation_during_plan bool
    subject_name str
    (Required String) The name for the reference. (For Avro Schema, the reference name is the fully qualified schema name, for JSON Schema it is a URL, and for Protobuf Schema, it is the name of another Protobuf file.)
    version int
    (Required Integer) The version of the Schema, for example, 4.
    credentials GetSchemaCredentials
    rest_endpoint str
    schema_registry_cluster GetSchemaSchemaRegistryCluster
    format String
    (Required String) The format of the schema. Accepted values are: AVRO, PROTOBUF, and JSON.
    hardDelete Boolean
    id String
    The provider-assigned unique ID for this managed resource.
    metadata Property Map
    (Optional Block) See here for more details. Supports the following:
    recreateOnUpdate Boolean
    ruleset Property Map
    (Optional Block) The list of schema rules. See Data Contracts for Schema Registry for more details. For example, these rules can enforce that a field that contains sensitive information must be encrypted, or that a message containing an invalid age must be sent to a dead letter queue.
    schema String
    (Required String) The schema string, for example, file("./schema_version_1.avsc").
    schemaIdentifier Number
    schemaReferences List<Property Map>
    (Optional List) The list of referenced schemas (see Schema References for more details):
    skipValidationDuringPlan Boolean
    subjectName String
    (Required String) The name for the reference. (For Avro Schema, the reference name is the fully qualified schema name, for JSON Schema it is a URL, and for Protobuf Schema, it is the name of another Protobuf file.)
    version Number
    (Required Integer) The version of the Schema, for example, 4.
    credentials Property Map
    restEndpoint String
    schemaRegistryCluster Property Map

    Supporting Types

    GetSchemaCredentials

    Key string
    The Schema Registry API Key.
    Secret string
    The Schema Registry API Secret.
    Key string
    The Schema Registry API Key.
    Secret string
    The Schema Registry API Secret.
    key String
    The Schema Registry API Key.
    secret String
    The Schema Registry API Secret.
    key string
    The Schema Registry API Key.
    secret string
    The Schema Registry API Secret.
    key str
    The Schema Registry API Key.
    secret str
    The Schema Registry API Secret.
    key String
    The Schema Registry API Key.
    secret String
    The Schema Registry API Secret.

    GetSchemaMetadata

    Properties Dictionary<string, string>
    (Optional Map) The custom properties to set:
    Sensitives List<string>
    (Optional List of Strings) A list of metadata properties to be encrypted.
    Tags List<Pulumi.ConfluentCloud.Inputs.GetSchemaMetadataTag>
    (Optional String List) The tags to which the rule applies, if any.
    Properties map[string]string
    (Optional Map) The custom properties to set:
    Sensitives []string
    (Optional List of Strings) A list of metadata properties to be encrypted.
    Tags []GetSchemaMetadataTag
    (Optional String List) The tags to which the rule applies, if any.
    properties Map<String,String>
    (Optional Map) The custom properties to set:
    sensitives List<String>
    (Optional List of Strings) A list of metadata properties to be encrypted.
    tags List<GetSchemaMetadataTag>
    (Optional String List) The tags to which the rule applies, if any.
    properties {[key: string]: string}
    (Optional Map) The custom properties to set:
    sensitives string[]
    (Optional List of Strings) A list of metadata properties to be encrypted.
    tags GetSchemaMetadataTag[]
    (Optional String List) The tags to which the rule applies, if any.
    properties Mapping[str, str]
    (Optional Map) The custom properties to set:
    sensitives Sequence[str]
    (Optional List of Strings) A list of metadata properties to be encrypted.
    tags Sequence[GetSchemaMetadataTag]
    (Optional String List) The tags to which the rule applies, if any.
    properties Map<String>
    (Optional Map) The custom properties to set:
    sensitives List<String>
    (Optional List of Strings) A list of metadata properties to be encrypted.
    tags List<Property Map>
    (Optional String List) The tags to which the rule applies, if any.

    GetSchemaMetadataTag

    Key string
    (Required String) The setting name.
    Values List<string>
    (Required List of Strings) The list of tags.
    Key string
    (Required String) The setting name.
    Values []string
    (Required List of Strings) The list of tags.
    key String
    (Required String) The setting name.
    values List<String>
    (Required List of Strings) The list of tags.
    key string
    (Required String) The setting name.
    values string[]
    (Required List of Strings) The list of tags.
    key str
    (Required String) The setting name.
    values Sequence[str]
    (Required List of Strings) The list of tags.
    key String
    (Required String) The setting name.
    values List<String>
    (Required List of Strings) The list of tags.

    GetSchemaRuleset

    domainRules List<Property Map>
    (Optional List of Blocks) supports the following:
    migrationRules List<Property Map>

    GetSchemaRulesetDomainRule

    Doc string
    (Optional String) An optional description.
    Expr string
    (Optional String) The body of the rule, which is optional.
    Kind string
    (Optional String) Either CONDITION or TRANSFORM.
    Mode string
    (Optional String) The mode of the rule.
    Name string
    (Optional String) A user-defined name that can be used to reference the rule.
    OnFailure string
    (Optional String) An optional action to execute if the rule fails, otherwise the built-in action type ERROR is used. For UPDOWN and WRITEREAD rules, one can specify two actions separated by commas, as mentioned above.
    OnSuccess string
    (Optional String) An optional action to execute if the rule succeeds, otherwise the built-in action type NONE is used. For UPDOWN and WRITEREAD rules, one can specify two actions separated by commas, such as “NONE,ERROR” for a WRITEREAD rule. In this case NONE applies to WRITE and ERROR applies to READ.
    Params Dictionary<string, string>
    (Optional Configuration Block) A set of static parameters for the rule, which is optional. These are key-value pairs that are passed to the rule.
    Tags List<string>
    (Optional String List) The tags to which the rule applies, if any.
    Type string
    (Optional String) The type of rule, which invokes a specific rule executor, such as Google Common Expression Language (CEL) or JSONata.
    Doc string
    (Optional String) An optional description.
    Expr string
    (Optional String) The body of the rule, which is optional.
    Kind string
    (Optional String) Either CONDITION or TRANSFORM.
    Mode string
    (Optional String) The mode of the rule.
    Name string
    (Optional String) A user-defined name that can be used to reference the rule.
    OnFailure string
    (Optional String) An optional action to execute if the rule fails, otherwise the built-in action type ERROR is used. For UPDOWN and WRITEREAD rules, one can specify two actions separated by commas, as mentioned above.
    OnSuccess string
    (Optional String) An optional action to execute if the rule succeeds, otherwise the built-in action type NONE is used. For UPDOWN and WRITEREAD rules, one can specify two actions separated by commas, such as “NONE,ERROR” for a WRITEREAD rule. In this case NONE applies to WRITE and ERROR applies to READ.
    Params map[string]string
    (Optional Configuration Block) A set of static parameters for the rule, which is optional. These are key-value pairs that are passed to the rule.
    Tags []string
    (Optional String List) The tags to which the rule applies, if any.
    Type string
    (Optional String) The type of rule, which invokes a specific rule executor, such as Google Common Expression Language (CEL) or JSONata.
    doc String
    (Optional String) An optional description.
    expr String
    (Optional String) The body of the rule, which is optional.
    kind String
    (Optional String) Either CONDITION or TRANSFORM.
    mode String
    (Optional String) The mode of the rule.
    name String
    (Optional String) A user-defined name that can be used to reference the rule.
    onFailure String
    (Optional String) An optional action to execute if the rule fails, otherwise the built-in action type ERROR is used. For UPDOWN and WRITEREAD rules, one can specify two actions separated by commas, as mentioned above.
    onSuccess String
    (Optional String) An optional action to execute if the rule succeeds, otherwise the built-in action type NONE is used. For UPDOWN and WRITEREAD rules, one can specify two actions separated by commas, such as “NONE,ERROR” for a WRITEREAD rule. In this case NONE applies to WRITE and ERROR applies to READ.
    params Map<String,String>
    (Optional Configuration Block) A set of static parameters for the rule, which is optional. These are key-value pairs that are passed to the rule.
    tags List<String>
    (Optional String List) The tags to which the rule applies, if any.
    type String
    (Optional String) The type of rule, which invokes a specific rule executor, such as Google Common Expression Language (CEL) or JSONata.
    doc string
    (Optional String) An optional description.
    expr string
    (Optional String) The body of the rule, which is optional.
    kind string
    (Optional String) Either CONDITION or TRANSFORM.
    mode string
    (Optional String) The mode of the rule.
    name string
    (Optional String) A user-defined name that can be used to reference the rule.
    onFailure string
    (Optional String) An optional action to execute if the rule fails, otherwise the built-in action type ERROR is used. For UPDOWN and WRITEREAD rules, one can specify two actions separated by commas, as mentioned above.
    onSuccess string
    (Optional String) An optional action to execute if the rule succeeds, otherwise the built-in action type NONE is used. For UPDOWN and WRITEREAD rules, one can specify two actions separated by commas, such as “NONE,ERROR” for a WRITEREAD rule. In this case NONE applies to WRITE and ERROR applies to READ.
    params {[key: string]: string}
    (Optional Configuration Block) A set of static parameters for the rule, which is optional. These are key-value pairs that are passed to the rule.
    tags string[]
    (Optional String List) The tags to which the rule applies, if any.
    type string
    (Optional String) The type of rule, which invokes a specific rule executor, such as Google Common Expression Language (CEL) or JSONata.
    doc str
    (Optional String) An optional description.
    expr str
    (Optional String) The body of the rule, which is optional.
    kind str
    (Optional String) Either CONDITION or TRANSFORM.
    mode str
    (Optional String) The mode of the rule.
    name str
    (Optional String) A user-defined name that can be used to reference the rule.
    on_failure str
    (Optional String) An optional action to execute if the rule fails, otherwise the built-in action type ERROR is used. For UPDOWN and WRITEREAD rules, one can specify two actions separated by commas, as mentioned above.
    on_success str
    (Optional String) An optional action to execute if the rule succeeds, otherwise the built-in action type NONE is used. For UPDOWN and WRITEREAD rules, one can specify two actions separated by commas, such as “NONE,ERROR” for a WRITEREAD rule. In this case NONE applies to WRITE and ERROR applies to READ.
    params Mapping[str, str]
    (Optional Configuration Block) A set of static parameters for the rule, which is optional. These are key-value pairs that are passed to the rule.
    tags Sequence[str]
    (Optional String List) The tags to which the rule applies, if any.
    type str
    (Optional String) The type of rule, which invokes a specific rule executor, such as Google Common Expression Language (CEL) or JSONata.
    doc String
    (Optional String) An optional description.
    expr String
    (Optional String) The body of the rule, which is optional.
    kind String
    (Optional String) Either CONDITION or TRANSFORM.
    mode String
    (Optional String) The mode of the rule.
    name String
    (Optional String) A user-defined name that can be used to reference the rule.
    onFailure String
    (Optional String) An optional action to execute if the rule fails, otherwise the built-in action type ERROR is used. For UPDOWN and WRITEREAD rules, one can specify two actions separated by commas, as mentioned above.
    onSuccess String
    (Optional String) An optional action to execute if the rule succeeds, otherwise the built-in action type NONE is used. For UPDOWN and WRITEREAD rules, one can specify two actions separated by commas, such as “NONE,ERROR” for a WRITEREAD rule. In this case NONE applies to WRITE and ERROR applies to READ.
    params Map<String>
    (Optional Configuration Block) A set of static parameters for the rule, which is optional. These are key-value pairs that are passed to the rule.
    tags List<String>
    (Optional String List) The tags to which the rule applies, if any.
    type String
    (Optional String) The type of rule, which invokes a specific rule executor, such as Google Common Expression Language (CEL) or JSONata.

    GetSchemaRulesetMigrationRule

    Doc string
    (Optional String) An optional description.
    Expr string
    (Optional String) The body of the rule, which is optional.
    Kind string
    (Optional String) Either CONDITION or TRANSFORM.
    Mode string
    (Optional String) The mode of the rule.
    Name string
    (Optional String) A user-defined name that can be used to reference the rule.
    OnFailure string
    (Optional String) An optional action to execute if the rule fails, otherwise the built-in action type ERROR is used. For UPDOWN and WRITEREAD rules, one can specify two actions separated by commas, as mentioned above.
    OnSuccess string
    (Optional String) An optional action to execute if the rule succeeds, otherwise the built-in action type NONE is used. For UPDOWN and WRITEREAD rules, one can specify two actions separated by commas, such as “NONE,ERROR” for a WRITEREAD rule. In this case NONE applies to WRITE and ERROR applies to READ.
    Params Dictionary<string, string>
    (Optional Configuration Block) A set of static parameters for the rule, which is optional. These are key-value pairs that are passed to the rule.
    Tags List<string>
    (Optional String List) The tags to which the rule applies, if any.
    Type string
    (Optional String) The type of rule, which invokes a specific rule executor, such as Google Common Expression Language (CEL) or JSONata.
    Doc string
    (Optional String) An optional description.
    Expr string
    (Optional String) The body of the rule, which is optional.
    Kind string
    (Optional String) Either CONDITION or TRANSFORM.
    Mode string
    (Optional String) The mode of the rule.
    Name string
    (Optional String) A user-defined name that can be used to reference the rule.
    OnFailure string
    (Optional String) An optional action to execute if the rule fails, otherwise the built-in action type ERROR is used. For UPDOWN and WRITEREAD rules, one can specify two actions separated by commas, as mentioned above.
    OnSuccess string
    (Optional String) An optional action to execute if the rule succeeds, otherwise the built-in action type NONE is used. For UPDOWN and WRITEREAD rules, one can specify two actions separated by commas, such as “NONE,ERROR” for a WRITEREAD rule. In this case NONE applies to WRITE and ERROR applies to READ.
    Params map[string]string
    (Optional Configuration Block) A set of static parameters for the rule, which is optional. These are key-value pairs that are passed to the rule.
    Tags []string
    (Optional String List) The tags to which the rule applies, if any.
    Type string
    (Optional String) The type of rule, which invokes a specific rule executor, such as Google Common Expression Language (CEL) or JSONata.
    doc String
    (Optional String) An optional description.
    expr String
    (Optional String) The body of the rule, which is optional.
    kind String
    (Optional String) Either CONDITION or TRANSFORM.
    mode String
    (Optional String) The mode of the rule.
    name String
    (Optional String) A user-defined name that can be used to reference the rule.
    onFailure String
    (Optional String) An optional action to execute if the rule fails, otherwise the built-in action type ERROR is used. For UPDOWN and WRITEREAD rules, one can specify two actions separated by commas, as mentioned above.
    onSuccess String
    (Optional String) An optional action to execute if the rule succeeds, otherwise the built-in action type NONE is used. For UPDOWN and WRITEREAD rules, one can specify two actions separated by commas, such as “NONE,ERROR” for a WRITEREAD rule. In this case NONE applies to WRITE and ERROR applies to READ.
    params Map<String,String>
    (Optional Configuration Block) A set of static parameters for the rule, which is optional. These are key-value pairs that are passed to the rule.
    tags List<String>
    (Optional String List) The tags to which the rule applies, if any.
    type String
    (Optional String) The type of rule, which invokes a specific rule executor, such as Google Common Expression Language (CEL) or JSONata.
    doc string
    (Optional String) An optional description.
    expr string
    (Optional String) The body of the rule, which is optional.
    kind string
    (Optional String) Either CONDITION or TRANSFORM.
    mode string
    (Optional String) The mode of the rule.
    name string
    (Optional String) A user-defined name that can be used to reference the rule.
    onFailure string
    (Optional String) An optional action to execute if the rule fails, otherwise the built-in action type ERROR is used. For UPDOWN and WRITEREAD rules, one can specify two actions separated by commas, as mentioned above.
    onSuccess string
    (Optional String) An optional action to execute if the rule succeeds, otherwise the built-in action type NONE is used. For UPDOWN and WRITEREAD rules, one can specify two actions separated by commas, such as “NONE,ERROR” for a WRITEREAD rule. In this case NONE applies to WRITE and ERROR applies to READ.
    params {[key: string]: string}
    (Optional Configuration Block) A set of static parameters for the rule, which is optional. These are key-value pairs that are passed to the rule.
    tags string[]
    (Optional String List) The tags to which the rule applies, if any.
    type string
    (Optional String) The type of rule, which invokes a specific rule executor, such as Google Common Expression Language (CEL) or JSONata.
    doc str
    (Optional String) An optional description.
    expr str
    (Optional String) The body of the rule, which is optional.
    kind str
    (Optional String) Either CONDITION or TRANSFORM.
    mode str
    (Optional String) The mode of the rule.
    name str
    (Optional String) A user-defined name that can be used to reference the rule.
    on_failure str
    (Optional String) An optional action to execute if the rule fails, otherwise the built-in action type ERROR is used. For UPDOWN and WRITEREAD rules, one can specify two actions separated by commas, as mentioned above.
    on_success str
    (Optional String) An optional action to execute if the rule succeeds, otherwise the built-in action type NONE is used. For UPDOWN and WRITEREAD rules, one can specify two actions separated by commas, such as “NONE,ERROR” for a WRITEREAD rule. In this case NONE applies to WRITE and ERROR applies to READ.
    params Mapping[str, str]
    (Optional Configuration Block) A set of static parameters for the rule, which is optional. These are key-value pairs that are passed to the rule.
    tags Sequence[str]
    (Optional String List) The tags to which the rule applies, if any.
    type str
    (Optional String) The type of rule, which invokes a specific rule executor, such as Google Common Expression Language (CEL) or JSONata.
    doc String
    (Optional String) An optional description.
    expr String
    (Optional String) The body of the rule, which is optional.
    kind String
    (Optional String) Either CONDITION or TRANSFORM.
    mode String
    (Optional String) The mode of the rule.
    name String
    (Optional String) A user-defined name that can be used to reference the rule.
    onFailure String
    (Optional String) An optional action to execute if the rule fails, otherwise the built-in action type ERROR is used. For UPDOWN and WRITEREAD rules, one can specify two actions separated by commas, as mentioned above.
    onSuccess String
    (Optional String) An optional action to execute if the rule succeeds, otherwise the built-in action type NONE is used. For UPDOWN and WRITEREAD rules, one can specify two actions separated by commas, such as “NONE,ERROR” for a WRITEREAD rule. In this case NONE applies to WRITE and ERROR applies to READ.
    params Map<String>
    (Optional Configuration Block) A set of static parameters for the rule, which is optional. These are key-value pairs that are passed to the rule.
    tags List<String>
    (Optional String List) The tags to which the rule applies, if any.
    type String
    (Optional String) The type of rule, which invokes a specific rule executor, such as Google Common Expression Language (CEL) or JSONata.

    GetSchemaSchemaReference

    Name string
    (Optional String) A user-defined name that can be used to reference the rule.
    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. Schemas evolve safely, following a compatibility mode defined, under a subject name.
    Version int
    (Required Integer) The version of the Schema, for example, 4.
    Name string
    (Optional String) A user-defined name that can be used to reference the rule.
    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. Schemas evolve safely, following a compatibility mode defined, under a subject name.
    Version int
    (Required Integer) The version of the Schema, for example, 4.
    name String
    (Optional String) A user-defined name that can be used to reference the rule.
    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. Schemas evolve safely, following a compatibility mode defined, under a subject name.
    version Integer
    (Required Integer) The version of the Schema, for example, 4.
    name string
    (Optional String) A user-defined name that can be used to reference the rule.
    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. Schemas evolve safely, following a compatibility mode defined, under a subject name.
    version number
    (Required Integer) The version of the Schema, for example, 4.
    name str
    (Optional String) A user-defined name that can be used to reference the rule.
    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. Schemas evolve safely, following a compatibility mode defined, under a subject name.
    version int
    (Required Integer) The version of the Schema, for example, 4.
    name String
    (Optional String) A user-defined name that can be used to reference the rule.
    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. Schemas evolve safely, following a compatibility mode defined, under a subject name.
    version Number
    (Required Integer) The version of the Schema, for example, 4.

    GetSchemaSchemaRegistryCluster

    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.

    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
    Viewing docs for Confluent v1.53.0 (Older version)
    published on Monday, Mar 9, 2026 by Pulumi
    Go to latest version
    Schema (JSON)
    pulumi/pulumi-confluentcloud
      Try Pulumi Cloud free. Your team will thank you.