1. Packages
  2. Confluent Provider
  3. API Docs
  4. getSchema
Confluent v2.23.0 published on Tuesday, Apr 1, 2025 by Pulumi

confluentcloud.getSchema

Explore with Pulumi AI

General Availability

confluentcloud.Schema describes a Schema data source.

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 purchase_v1 = confluentcloud.getSchema({
    schemaRegistryCluster: {
        id: essentials.id,
    },
    restEndpoint: essentials.restEndpoint,
    subjectName: "proto-purchase-value",
    schemaIdentifier: 10001,
    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>",
    },
});
export const schema = purchase_v1.then(purchase_v1 => purchase_v1.schema);
Copy
import pulumi
import pulumi_confluentcloud as confluentcloud

purchase_v1 = confluentcloud.get_schema(schema_registry_cluster={
        "id": essentials["id"],
    },
    rest_endpoint=essentials["restEndpoint"],
    subject_name="proto-purchase-value",
    schema_identifier=10001,
    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>",
    })
pulumi.export("schema", purchase_v1.schema)
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 {
		purchase_v1, err := confluentcloud.LookupSchema(ctx, &confluentcloud.LookupSchemaArgs{
			SchemaRegistryCluster: confluentcloud.GetSchemaSchemaRegistryCluster{
				Id: essentials.Id,
			},
			RestEndpoint:     pulumi.StringRef(essentials.RestEndpoint),
			SubjectName:      "proto-purchase-value",
			SchemaIdentifier: 10001,
			Credentials: confluentcloud.GetSchemaCredentials{
				Key:    "<Schema Registry API Key for data.confluent_schema_registry_cluster.essentials>",
				Secret: "<Schema Registry API Secret for data.confluent_schema_registry_cluster.essentials>",
			},
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("schema", purchase_v1.Schema)
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using ConfluentCloud = Pulumi.ConfluentCloud;

return await Deployment.RunAsync(() => 
{
    var purchase_v1 = ConfluentCloud.GetSchema.Invoke(new()
    {
        SchemaRegistryCluster = new ConfluentCloud.Inputs.GetSchemaSchemaRegistryClusterInputArgs
        {
            Id = essentials.Id,
        },
        RestEndpoint = essentials.RestEndpoint,
        SubjectName = "proto-purchase-value",
        SchemaIdentifier = 10001,
        Credentials = new ConfluentCloud.Inputs.GetSchemaCredentialsInputArgs
        {
            Key = "<Schema Registry API Key for data.confluent_schema_registry_cluster.essentials>",
            Secret = "<Schema Registry API Secret for data.confluent_schema_registry_cluster.essentials>",
        },
    });

    return new Dictionary<string, object?>
    {
        ["schema"] = purchase_v1.Apply(purchase_v1 => purchase_v1.Apply(getSchemaResult => getSchemaResult.Schema)),
    };
});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.confluentcloud.ConfluentcloudFunctions;
import com.pulumi.confluentcloud.inputs.GetSchemaArgs;
import com.pulumi.confluentcloud.inputs.GetSchemaSchemaRegistryClusterArgs;
import com.pulumi.confluentcloud.inputs.GetSchemaCredentialsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var purchase-v1 = ConfluentcloudFunctions.getSchema(GetSchemaArgs.builder()
            .schemaRegistryCluster(GetSchemaSchemaRegistryClusterArgs.builder()
                .id(essentials.id())
                .build())
            .restEndpoint(essentials.restEndpoint())
            .subjectName("proto-purchase-value")
            .schemaIdentifier(10001)
            .credentials(GetSchemaCredentialsArgs.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());

        ctx.export("schema", purchase_v1.schema());
    }
}
Copy
variables:
  purchase-v1:
    fn::invoke:
      function: confluentcloud:getSchema
      arguments:
        schemaRegistryCluster:
          id: ${essentials.id}
        restEndpoint: ${essentials.restEndpoint}
        subjectName: proto-purchase-value
        schemaIdentifier: 10001
        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>
outputs:
  schema: ${["purchase-v1"].schema}
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 purchase_v1 = confluentcloud.getSchema({
    subjectName: "proto-purchase-value",
    schemaIdentifier: 10001,
});
export const schema = purchase_v1.then(purchase_v1 => purchase_v1.schema);
Copy
import pulumi
import pulumi_confluentcloud as confluentcloud

purchase_v1 = confluentcloud.get_schema(subject_name="proto-purchase-value",
    schema_identifier=10001)
pulumi.export("schema", purchase_v1.schema)
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 {
		purchase_v1, err := confluentcloud.LookupSchema(ctx, &confluentcloud.LookupSchemaArgs{
			SubjectName:      "proto-purchase-value",
			SchemaIdentifier: 10001,
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("schema", purchase_v1.Schema)
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using ConfluentCloud = Pulumi.ConfluentCloud;

return await Deployment.RunAsync(() => 
{
    var purchase_v1 = ConfluentCloud.GetSchema.Invoke(new()
    {
        SubjectName = "proto-purchase-value",
        SchemaIdentifier = 10001,
    });

    return new Dictionary<string, object?>
    {
        ["schema"] = purchase_v1.Apply(purchase_v1 => purchase_v1.Apply(getSchemaResult => getSchemaResult.Schema)),
    };
});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.confluentcloud.ConfluentcloudFunctions;
import com.pulumi.confluentcloud.inputs.GetSchemaArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var purchase-v1 = ConfluentcloudFunctions.getSchema(GetSchemaArgs.builder()
            .subjectName("proto-purchase-value")
            .schemaIdentifier(10001)
            .build());

        ctx.export("schema", purchase_v1.schema());
    }
}
Copy
variables:
  purchase-v1:
    fn::invoke:
      function: confluentcloud:getSchema
      arguments:
        subjectName: proto-purchase-value
        schemaIdentifier: 10001
outputs:
  schema: ${["purchase-v1"].schema}
Copy

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>
Copy
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]
Copy
func LookupSchema(ctx *Context, args *LookupSchemaArgs, opts ...InvokeOption) (*LookupSchemaResult, error)
func LookupSchemaOutput(ctx *Context, args *LookupSchemaOutputArgs, opts ...InvokeOption) LookupSchemaResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetSchemaResult> getSchema(GetSchemaArgs args, InvokeOptions options)
public static Output<GetSchemaResult> getSchema(GetSchemaArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: confluentcloud:index/getSchema:getSchema
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

SchemaIdentifier This property is required. 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 This property is required. 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 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).
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 This property is required. 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 This property is required. 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 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).
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 This property is required. 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 This property is required. 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 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).
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 This property is required. 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 This property is required. 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 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).
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 This property is required. 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 This property is required. 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 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).
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 This property is required. 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 This property is required. 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 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).
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 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.

GetSchemaMetadata

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

GetSchemaMetadataTag

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

GetSchemaRuleset

DomainRules This property is required. List<Pulumi.ConfluentCloud.Inputs.GetSchemaRulesetDomainRule>
(Optional List of Blocks) supports the following:
MigrationRules This property is required. List<Pulumi.ConfluentCloud.Inputs.GetSchemaRulesetMigrationRule>
DomainRules This property is required. []GetSchemaRulesetDomainRule
(Optional List of Blocks) supports the following:
MigrationRules This property is required. []GetSchemaRulesetMigrationRule
domainRules This property is required. List<GetSchemaRulesetDomainRule>
(Optional List of Blocks) supports the following:
migrationRules This property is required. List<GetSchemaRulesetMigrationRule>
domainRules This property is required. GetSchemaRulesetDomainRule[]
(Optional List of Blocks) supports the following:
migrationRules This property is required. GetSchemaRulesetMigrationRule[]
domain_rules This property is required. Sequence[GetSchemaRulesetDomainRule]
(Optional List of Blocks) supports the following:
migration_rules This property is required. Sequence[GetSchemaRulesetMigrationRule]
domainRules This property is required. List<Property Map>
(Optional List of Blocks) supports the following:
migrationRules This property is required. List<Property Map>

GetSchemaRulesetDomainRule

Kind This property is required. string
(Required String) The kind of the rule. Accepted values are CONDITION and TRANSFORM. CONDITION - validate the value of a field, TRANSFORM - transform the value of a field. Data quality rules use CONDITION kind, data transformation, encryption and migration rules use TRANSFORM kind.
Mode This property is required. string
(Required String) The mode of the rule. Accepted values are UPGRADE, DOWNGRADE, UPDOWN, WRITE, READ, and WRITEREAD.
Name This property is required. string
(Required String) A user-defined name that can be used to reference the rule.
Params This property is required. 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 This property is required. List<string>
(Optional String List) The tags to which the rule applies, if any.
Type This property is required. string
(Required String) The type of rule, which invokes a specific rule executor that that will run the rule. Google Common Expression Language (CEL) is used for data quality and transformation rules, Confluent ENCRYPT is used for data encryption rules, and JSONata is used for migration rules.
Disabled bool
(Optional Boolean) The boolean flag to control whether the rule should be disabled.
Doc string
(Optional String) An optional description of the rule.
Expr string
(Optional String) The rule body. Data quality and transformation rules use CEL language expressions, data migration rules use JSONata expressions. Defaults to "".
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.
Kind This property is required. string
(Required String) The kind of the rule. Accepted values are CONDITION and TRANSFORM. CONDITION - validate the value of a field, TRANSFORM - transform the value of a field. Data quality rules use CONDITION kind, data transformation, encryption and migration rules use TRANSFORM kind.
Mode This property is required. string
(Required String) The mode of the rule. Accepted values are UPGRADE, DOWNGRADE, UPDOWN, WRITE, READ, and WRITEREAD.
Name This property is required. string
(Required String) A user-defined name that can be used to reference the rule.
Params This property is required. 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 This property is required. []string
(Optional String List) The tags to which the rule applies, if any.
Type This property is required. string
(Required String) The type of rule, which invokes a specific rule executor that that will run the rule. Google Common Expression Language (CEL) is used for data quality and transformation rules, Confluent ENCRYPT is used for data encryption rules, and JSONata is used for migration rules.
Disabled bool
(Optional Boolean) The boolean flag to control whether the rule should be disabled.
Doc string
(Optional String) An optional description of the rule.
Expr string
(Optional String) The rule body. Data quality and transformation rules use CEL language expressions, data migration rules use JSONata expressions. Defaults to "".
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.
kind This property is required. String
(Required String) The kind of the rule. Accepted values are CONDITION and TRANSFORM. CONDITION - validate the value of a field, TRANSFORM - transform the value of a field. Data quality rules use CONDITION kind, data transformation, encryption and migration rules use TRANSFORM kind.
mode This property is required. String
(Required String) The mode of the rule. Accepted values are UPGRADE, DOWNGRADE, UPDOWN, WRITE, READ, and WRITEREAD.
name This property is required. String
(Required String) A user-defined name that can be used to reference the rule.
params This property is required. 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 This property is required. List<String>
(Optional String List) The tags to which the rule applies, if any.
type This property is required. String
(Required String) The type of rule, which invokes a specific rule executor that that will run the rule. Google Common Expression Language (CEL) is used for data quality and transformation rules, Confluent ENCRYPT is used for data encryption rules, and JSONata is used for migration rules.
disabled Boolean
(Optional Boolean) The boolean flag to control whether the rule should be disabled.
doc String
(Optional String) An optional description of the rule.
expr String
(Optional String) The rule body. Data quality and transformation rules use CEL language expressions, data migration rules use JSONata expressions. Defaults to "".
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.
kind This property is required. string
(Required String) The kind of the rule. Accepted values are CONDITION and TRANSFORM. CONDITION - validate the value of a field, TRANSFORM - transform the value of a field. Data quality rules use CONDITION kind, data transformation, encryption and migration rules use TRANSFORM kind.
mode This property is required. string
(Required String) The mode of the rule. Accepted values are UPGRADE, DOWNGRADE, UPDOWN, WRITE, READ, and WRITEREAD.
name This property is required. string
(Required String) A user-defined name that can be used to reference the rule.
params This property is required. {[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 This property is required. string[]
(Optional String List) The tags to which the rule applies, if any.
type This property is required. string
(Required String) The type of rule, which invokes a specific rule executor that that will run the rule. Google Common Expression Language (CEL) is used for data quality and transformation rules, Confluent ENCRYPT is used for data encryption rules, and JSONata is used for migration rules.
disabled boolean
(Optional Boolean) The boolean flag to control whether the rule should be disabled.
doc string
(Optional String) An optional description of the rule.
expr string
(Optional String) The rule body. Data quality and transformation rules use CEL language expressions, data migration rules use JSONata expressions. Defaults to "".
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.
kind This property is required. str
(Required String) The kind of the rule. Accepted values are CONDITION and TRANSFORM. CONDITION - validate the value of a field, TRANSFORM - transform the value of a field. Data quality rules use CONDITION kind, data transformation, encryption and migration rules use TRANSFORM kind.
mode This property is required. str
(Required String) The mode of the rule. Accepted values are UPGRADE, DOWNGRADE, UPDOWN, WRITE, READ, and WRITEREAD.
name This property is required. str
(Required String) A user-defined name that can be used to reference the rule.
params This property is required. 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 This property is required. Sequence[str]
(Optional String List) The tags to which the rule applies, if any.
type This property is required. str
(Required String) The type of rule, which invokes a specific rule executor that that will run the rule. Google Common Expression Language (CEL) is used for data quality and transformation rules, Confluent ENCRYPT is used for data encryption rules, and JSONata is used for migration rules.
disabled bool
(Optional Boolean) The boolean flag to control whether the rule should be disabled.
doc str
(Optional String) An optional description of the rule.
expr str
(Optional String) The rule body. Data quality and transformation rules use CEL language expressions, data migration rules use JSONata expressions. Defaults to "".
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.
kind This property is required. String
(Required String) The kind of the rule. Accepted values are CONDITION and TRANSFORM. CONDITION - validate the value of a field, TRANSFORM - transform the value of a field. Data quality rules use CONDITION kind, data transformation, encryption and migration rules use TRANSFORM kind.
mode This property is required. String
(Required String) The mode of the rule. Accepted values are UPGRADE, DOWNGRADE, UPDOWN, WRITE, READ, and WRITEREAD.
name This property is required. String
(Required String) A user-defined name that can be used to reference the rule.
params This property is required. 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 This property is required. List<String>
(Optional String List) The tags to which the rule applies, if any.
type This property is required. String
(Required String) The type of rule, which invokes a specific rule executor that that will run the rule. Google Common Expression Language (CEL) is used for data quality and transformation rules, Confluent ENCRYPT is used for data encryption rules, and JSONata is used for migration rules.
disabled Boolean
(Optional Boolean) The boolean flag to control whether the rule should be disabled.
doc String
(Optional String) An optional description of the rule.
expr String
(Optional String) The rule body. Data quality and transformation rules use CEL language expressions, data migration rules use JSONata expressions. Defaults to "".
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.

GetSchemaRulesetMigrationRule

Kind This property is required. string
(Required String) The kind of the rule. Accepted values are CONDITION and TRANSFORM. CONDITION - validate the value of a field, TRANSFORM - transform the value of a field. Data quality rules use CONDITION kind, data transformation, encryption and migration rules use TRANSFORM kind.
Mode This property is required. string
(Required String) The mode of the rule. Accepted values are UPGRADE, DOWNGRADE, UPDOWN, WRITE, READ, and WRITEREAD.
Name This property is required. string
(Required String) A user-defined name that can be used to reference the rule.
Params This property is required. 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 This property is required. List<string>
(Optional String List) The tags to which the rule applies, if any.
Type This property is required. string
(Required String) The type of rule, which invokes a specific rule executor that that will run the rule. Google Common Expression Language (CEL) is used for data quality and transformation rules, Confluent ENCRYPT is used for data encryption rules, and JSONata is used for migration rules.
Disabled bool
(Optional Boolean) The boolean flag to control whether the rule should be disabled.
Doc string
(Optional String) An optional description of the rule.
Expr string
(Optional String) The rule body. Data quality and transformation rules use CEL language expressions, data migration rules use JSONata expressions. Defaults to "".
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.
Kind This property is required. string
(Required String) The kind of the rule. Accepted values are CONDITION and TRANSFORM. CONDITION - validate the value of a field, TRANSFORM - transform the value of a field. Data quality rules use CONDITION kind, data transformation, encryption and migration rules use TRANSFORM kind.
Mode This property is required. string
(Required String) The mode of the rule. Accepted values are UPGRADE, DOWNGRADE, UPDOWN, WRITE, READ, and WRITEREAD.
Name This property is required. string
(Required String) A user-defined name that can be used to reference the rule.
Params This property is required. 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 This property is required. []string
(Optional String List) The tags to which the rule applies, if any.
Type This property is required. string
(Required String) The type of rule, which invokes a specific rule executor that that will run the rule. Google Common Expression Language (CEL) is used for data quality and transformation rules, Confluent ENCRYPT is used for data encryption rules, and JSONata is used for migration rules.
Disabled bool
(Optional Boolean) The boolean flag to control whether the rule should be disabled.
Doc string
(Optional String) An optional description of the rule.
Expr string
(Optional String) The rule body. Data quality and transformation rules use CEL language expressions, data migration rules use JSONata expressions. Defaults to "".
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.
kind This property is required. String
(Required String) The kind of the rule. Accepted values are CONDITION and TRANSFORM. CONDITION - validate the value of a field, TRANSFORM - transform the value of a field. Data quality rules use CONDITION kind, data transformation, encryption and migration rules use TRANSFORM kind.
mode This property is required. String
(Required String) The mode of the rule. Accepted values are UPGRADE, DOWNGRADE, UPDOWN, WRITE, READ, and WRITEREAD.
name This property is required. String
(Required String) A user-defined name that can be used to reference the rule.
params This property is required. 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 This property is required. List<String>
(Optional String List) The tags to which the rule applies, if any.
type This property is required. String
(Required String) The type of rule, which invokes a specific rule executor that that will run the rule. Google Common Expression Language (CEL) is used for data quality and transformation rules, Confluent ENCRYPT is used for data encryption rules, and JSONata is used for migration rules.
disabled Boolean
(Optional Boolean) The boolean flag to control whether the rule should be disabled.
doc String
(Optional String) An optional description of the rule.
expr String
(Optional String) The rule body. Data quality and transformation rules use CEL language expressions, data migration rules use JSONata expressions. Defaults to "".
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.
kind This property is required. string
(Required String) The kind of the rule. Accepted values are CONDITION and TRANSFORM. CONDITION - validate the value of a field, TRANSFORM - transform the value of a field. Data quality rules use CONDITION kind, data transformation, encryption and migration rules use TRANSFORM kind.
mode This property is required. string
(Required String) The mode of the rule. Accepted values are UPGRADE, DOWNGRADE, UPDOWN, WRITE, READ, and WRITEREAD.
name This property is required. string
(Required String) A user-defined name that can be used to reference the rule.
params This property is required. {[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 This property is required. string[]
(Optional String List) The tags to which the rule applies, if any.
type This property is required. string
(Required String) The type of rule, which invokes a specific rule executor that that will run the rule. Google Common Expression Language (CEL) is used for data quality and transformation rules, Confluent ENCRYPT is used for data encryption rules, and JSONata is used for migration rules.
disabled boolean
(Optional Boolean) The boolean flag to control whether the rule should be disabled.
doc string
(Optional String) An optional description of the rule.
expr string
(Optional String) The rule body. Data quality and transformation rules use CEL language expressions, data migration rules use JSONata expressions. Defaults to "".
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.
kind This property is required. str
(Required String) The kind of the rule. Accepted values are CONDITION and TRANSFORM. CONDITION - validate the value of a field, TRANSFORM - transform the value of a field. Data quality rules use CONDITION kind, data transformation, encryption and migration rules use TRANSFORM kind.
mode This property is required. str
(Required String) The mode of the rule. Accepted values are UPGRADE, DOWNGRADE, UPDOWN, WRITE, READ, and WRITEREAD.
name This property is required. str
(Required String) A user-defined name that can be used to reference the rule.
params This property is required. 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 This property is required. Sequence[str]
(Optional String List) The tags to which the rule applies, if any.
type This property is required. str
(Required String) The type of rule, which invokes a specific rule executor that that will run the rule. Google Common Expression Language (CEL) is used for data quality and transformation rules, Confluent ENCRYPT is used for data encryption rules, and JSONata is used for migration rules.
disabled bool
(Optional Boolean) The boolean flag to control whether the rule should be disabled.
doc str
(Optional String) An optional description of the rule.
expr str
(Optional String) The rule body. Data quality and transformation rules use CEL language expressions, data migration rules use JSONata expressions. Defaults to "".
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.
kind This property is required. String
(Required String) The kind of the rule. Accepted values are CONDITION and TRANSFORM. CONDITION - validate the value of a field, TRANSFORM - transform the value of a field. Data quality rules use CONDITION kind, data transformation, encryption and migration rules use TRANSFORM kind.
mode This property is required. String
(Required String) The mode of the rule. Accepted values are UPGRADE, DOWNGRADE, UPDOWN, WRITE, READ, and WRITEREAD.
name This property is required. String
(Required String) A user-defined name that can be used to reference the rule.
params This property is required. 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 This property is required. List<String>
(Optional String List) The tags to which the rule applies, if any.
type This property is required. String
(Required String) The type of rule, which invokes a specific rule executor that that will run the rule. Google Common Expression Language (CEL) is used for data quality and transformation rules, Confluent ENCRYPT is used for data encryption rules, and JSONata is used for migration rules.
disabled Boolean
(Optional Boolean) The boolean flag to control whether the rule should be disabled.
doc String
(Optional String) An optional description of the rule.
expr String
(Optional String) The rule body. Data quality and transformation rules use CEL language expressions, data migration rules use JSONata expressions. Defaults to "".
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.

GetSchemaSchemaReference

Name This property is required. string
(Required String) A user-defined name that can be used to reference the rule.
SubjectName This property is required. 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 This property is required. int
(Required Integer) The version of the Schema, for example, 4.
Name This property is required. string
(Required String) A user-defined name that can be used to reference the rule.
SubjectName This property is required. 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 This property is required. int
(Required Integer) The version of the Schema, for example, 4.
name This property is required. String
(Required String) A user-defined name that can be used to reference the rule.
subjectName This property is required. 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 This property is required. Integer
(Required Integer) The version of the Schema, for example, 4.
name This property is required. string
(Required String) A user-defined name that can be used to reference the rule.
subjectName This property is required. 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 This property is required. number
(Required Integer) The version of the Schema, for example, 4.
name This property is required. str
(Required String) A user-defined name that can be used to reference the rule.
subject_name This property is required. 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 This property is required. int
(Required Integer) The version of the Schema, for example, 4.
name This property is required. String
(Required String) A user-defined name that can be used to reference the rule.
subjectName This property is required. 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 This property is required. Number
(Required Integer) The version of the Schema, for example, 4.

GetSchemaSchemaRegistryCluster

Id This property is required. string
The ID of the Schema Registry cluster, for example, lsrc-abc123.
Id This property is required. string
The ID of the Schema Registry cluster, for example, lsrc-abc123.
id This property is required. String
The ID of the Schema Registry cluster, for example, lsrc-abc123.
id This property is required. string
The ID of the Schema Registry cluster, for example, lsrc-abc123.
id This property is required. str
The ID of the Schema Registry cluster, for example, lsrc-abc123.
id This property is required. 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.