confluentcloud.getSchema
Explore with Pulumi AI
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);
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)
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
})
}
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)),
};
});
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());
}
}
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}
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);
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)
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
})
}
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)),
};
});
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());
}
}
variables:
purchase-v1:
fn::invoke:
function: confluentcloud:getSchema
arguments:
subjectName: proto-purchase-value
schemaIdentifier: 10001
outputs:
schema: ${["purchase-v1"].schema}
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:
- 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, theversion
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. 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.
Confluent Cloud. Inputs. Get Schema Credentials - Metadata
Pulumi.
Confluent Cloud. Inputs. Get Schema Metadata - (Optional Block) See here for more details. Supports the following:
- Rest
Endpoint Changes to this property will trigger replacement.
- The REST endpoint of the Schema Registry cluster, for example,
https://psrc-00000.us-central1.gcp.confluent.cloud:443
). - Ruleset
Pulumi.
Confluent Cloud. Inputs. Get Schema Ruleset - (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 Pulumi.Cluster Confluent Cloud. Inputs. Get Schema Schema Registry Cluster
- 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, theversion
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. 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
Get
Schema Credentials - Metadata
Get
Schema Metadata - (Optional Block) See here for more details. Supports the following:
- Rest
Endpoint Changes to this property will trigger replacement.
- The REST endpoint of the Schema Registry cluster, for example,
https://psrc-00000.us-central1.gcp.confluent.cloud:443
). - Ruleset
Get
Schema Ruleset - (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 GetCluster Schema Schema Registry Cluster
- schema
Identifier 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, theversion
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. 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
Get
Schema Credentials - metadata
Get
Schema Metadata - (Optional Block) See here for more details. Supports the following:
- rest
Endpoint Changes to this property will trigger replacement.
- The REST endpoint of the Schema Registry cluster, for example,
https://psrc-00000.us-central1.gcp.confluent.cloud:443
). - ruleset
Get
Schema Ruleset - (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 GetCluster Schema Schema Registry Cluster
- schema
Identifier 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, theversion
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. 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
Get
Schema Credentials - metadata
Get
Schema Metadata - (Optional Block) See here for more details. Supports the following:
- rest
Endpoint Changes to this property will trigger replacement.
- The REST endpoint of the Schema Registry cluster, for example,
https://psrc-00000.us-central1.gcp.confluent.cloud:443
). - ruleset
Get
Schema Ruleset - (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 GetCluster Schema Schema Registry Cluster
- 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, theversion
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
Get
Schema Credentials - metadata
Get
Schema Metadata - (Optional Block) See here for more details. Supports the following:
- rest_
endpoint Changes to this property will trigger replacement.
- The REST endpoint of the Schema Registry cluster, for example,
https://psrc-00000.us-central1.gcp.confluent.cloud:443
). - ruleset
Get
Schema Ruleset - (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_ Getcluster Schema Schema Registry Cluster
- schema
Identifier 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, theversion
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. 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:
- rest
Endpoint Changes to this property will trigger replacement.
- 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.
- schema
Registry Property MapCluster
getSchema Result
The following output properties are available:
- Format string
- (Required String) The format of the schema. Accepted values are:
AVRO
,PROTOBUF
, andJSON
. - Hard
Delete bool - Id string
- The provider-assigned unique ID for this managed resource.
- Metadata
Pulumi.
Confluent Cloud. Outputs. Get Schema Metadata - (Optional Block) See here for more details. Supports the following:
- Recreate
On boolUpdate - Ruleset
Pulumi.
Confluent Cloud. Outputs. Get Schema Ruleset - (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")
. - Schema
Identifier int - Schema
References List<Pulumi.Confluent Cloud. Outputs. Get Schema Schema Reference> - (Optional List) The list of referenced schemas (see Schema References for more details):
- Skip
Validation boolDuring Plan - Subject
Name 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.
Confluent Cloud. Outputs. Get Schema Credentials - Rest
Endpoint string - Schema
Registry Pulumi.Cluster Confluent Cloud. Outputs. Get Schema Schema Registry Cluster
- Format string
- (Required String) The format of the schema. Accepted values are:
AVRO
,PROTOBUF
, andJSON
. - Hard
Delete bool - Id string
- The provider-assigned unique ID for this managed resource.
- Metadata
Get
Schema Metadata - (Optional Block) See here for more details. Supports the following:
- Recreate
On boolUpdate - Ruleset
Get
Schema Ruleset - (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")
. - Schema
Identifier int - Schema
References []GetSchema Schema Reference - (Optional List) The list of referenced schemas (see Schema References for more details):
- Skip
Validation boolDuring Plan - Subject
Name 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
Get
Schema Credentials - Rest
Endpoint string - Schema
Registry GetCluster Schema Schema Registry Cluster
- format String
- (Required String) The format of the schema. Accepted values are:
AVRO
,PROTOBUF
, andJSON
. - hard
Delete Boolean - id String
- The provider-assigned unique ID for this managed resource.
- metadata
Get
Schema Metadata - (Optional Block) See here for more details. Supports the following:
- recreate
On BooleanUpdate - ruleset
Get
Schema Ruleset - (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")
. - schema
Identifier Integer - schema
References List<GetSchema Schema Reference> - (Optional List) The list of referenced schemas (see Schema References for more details):
- skip
Validation BooleanDuring Plan - subject
Name 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
Get
Schema Credentials - rest
Endpoint String - schema
Registry GetCluster Schema Schema Registry Cluster
- format string
- (Required String) The format of the schema. Accepted values are:
AVRO
,PROTOBUF
, andJSON
. - hard
Delete boolean - id string
- The provider-assigned unique ID for this managed resource.
- metadata
Get
Schema Metadata - (Optional Block) See here for more details. Supports the following:
- recreate
On booleanUpdate - ruleset
Get
Schema Ruleset - (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")
. - schema
Identifier number - schema
References GetSchema Schema Reference[] - (Optional List) The list of referenced schemas (see Schema References for more details):
- skip
Validation booleanDuring Plan - subject
Name 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
Get
Schema Credentials - rest
Endpoint string - schema
Registry GetCluster Schema Schema Registry Cluster
- format str
- (Required String) The format of the schema. Accepted values are:
AVRO
,PROTOBUF
, andJSON
. - hard_
delete bool - id str
- The provider-assigned unique ID for this managed resource.
- metadata
Get
Schema Metadata - (Optional Block) See here for more details. Supports the following:
- recreate_
on_ boolupdate - ruleset
Get
Schema Ruleset - (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[GetSchema Schema Reference] - (Optional List) The list of referenced schemas (see Schema References for more details):
- skip_
validation_ boolduring_ plan - 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
Get
Schema Credentials - rest_
endpoint str - schema_
registry_ Getcluster Schema Schema Registry Cluster
- format String
- (Required String) The format of the schema. Accepted values are:
AVRO
,PROTOBUF
, andJSON
. - hard
Delete 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:
- recreate
On BooleanUpdate - 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")
. - schema
Identifier Number - schema
References List<Property Map> - (Optional List) The list of referenced schemas (see Schema References for more details):
- skip
Validation BooleanDuring Plan - subject
Name 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
- rest
Endpoint String - schema
Registry Property MapCluster
Supporting Types
GetSchemaCredentials
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.
This property is required. List<Pulumi.Confluent Cloud. Inputs. Get Schema Metadata Tag> - (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.
This property is required. []GetSchema Metadata Tag - (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.
This property is required. List<GetSchema Metadata Tag> - (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.
This property is required. GetSchema Metadata Tag[] - (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.
This property is required. Sequence[GetSchema Metadata Tag] - (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.
This property is required. List<Property Map>- (Optional String List) The tags to which the rule applies, if any.
GetSchemaMetadataTag
GetSchemaRuleset
- Domain
Rules This property is required. List<Pulumi.Confluent Cloud. Inputs. Get Schema Ruleset Domain Rule> - (Optional List of Blocks) supports the following:
- Migration
Rules This property is required. List<Pulumi.Confluent Cloud. Inputs. Get Schema Ruleset Migration Rule>
- Domain
Rules This property is required. []GetSchema Ruleset Domain Rule - (Optional List of Blocks) supports the following:
- Migration
Rules This property is required. []GetSchema Ruleset Migration Rule
- domain
Rules This property is required. List<GetSchema Ruleset Domain Rule> - (Optional List of Blocks) supports the following:
- migration
Rules This property is required. List<GetSchema Ruleset Migration Rule>
- domain
Rules This property is required. GetSchema Ruleset Domain Rule[] - (Optional List of Blocks) supports the following:
- migration
Rules This property is required. GetSchema Ruleset Migration Rule[]
- domain_
rules This property is required. Sequence[GetSchema Ruleset Domain Rule] - (Optional List of Blocks) supports the following:
- migration_
rules This property is required. Sequence[GetSchema Ruleset Migration Rule]
- domain
Rules This property is required. List<Property Map> - (Optional List of Blocks) supports the following:
- migration
Rules 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
andTRANSFORM
.CONDITION
- validate the value of a field,TRANSFORM
- transform the value of a field. Data quality rules useCONDITION
kind, data transformation, encryption and migration rules useTRANSFORM
kind. - Mode
This property is required. string - (Required String) The mode of the rule. Accepted values are
UPGRADE
,DOWNGRADE
,UPDOWN
,WRITE
,READ
, andWRITEREAD
. - 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.
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, ConfluentENCRYPT
is used for data encryption rules, andJSONata
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 useJSONata
expressions. Defaults to "". - On
Failure string - (Optional String) An optional action to execute if the rule fails, otherwise the built-in action type
ERROR
is used. ForUPDOWN
andWRITEREAD
rules, one can specify two actions separated by commas, as mentioned above. - On
Success string - (Optional String) An optional action to execute if the rule succeeds, otherwise the built-in action type
NONE
is used. ForUPDOWN
andWRITEREAD
rules, one can specify two actions separated by commas, such as "NONE,ERROR" for aWRITEREAD
rule. In this caseNONE
applies toWRITE
andERROR
applies toREAD
.
- Kind
This property is required. string - (Required String) The kind of the rule. Accepted values are
CONDITION
andTRANSFORM
.CONDITION
- validate the value of a field,TRANSFORM
- transform the value of a field. Data quality rules useCONDITION
kind, data transformation, encryption and migration rules useTRANSFORM
kind. - Mode
This property is required. string - (Required String) The mode of the rule. Accepted values are
UPGRADE
,DOWNGRADE
,UPDOWN
,WRITE
,READ
, andWRITEREAD
. - 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.
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, ConfluentENCRYPT
is used for data encryption rules, andJSONata
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 useJSONata
expressions. Defaults to "". - On
Failure string - (Optional String) An optional action to execute if the rule fails, otherwise the built-in action type
ERROR
is used. ForUPDOWN
andWRITEREAD
rules, one can specify two actions separated by commas, as mentioned above. - On
Success string - (Optional String) An optional action to execute if the rule succeeds, otherwise the built-in action type
NONE
is used. ForUPDOWN
andWRITEREAD
rules, one can specify two actions separated by commas, such as "NONE,ERROR" for aWRITEREAD
rule. In this caseNONE
applies toWRITE
andERROR
applies toREAD
.
- kind
This property is required. String - (Required String) The kind of the rule. Accepted values are
CONDITION
andTRANSFORM
.CONDITION
- validate the value of a field,TRANSFORM
- transform the value of a field. Data quality rules useCONDITION
kind, data transformation, encryption and migration rules useTRANSFORM
kind. - mode
This property is required. String - (Required String) The mode of the rule. Accepted values are
UPGRADE
,DOWNGRADE
,UPDOWN
,WRITE
,READ
, andWRITEREAD
. - 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.
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, ConfluentENCRYPT
is used for data encryption rules, andJSONata
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 useJSONata
expressions. Defaults to "". - on
Failure String - (Optional String) An optional action to execute if the rule fails, otherwise the built-in action type
ERROR
is used. ForUPDOWN
andWRITEREAD
rules, one can specify two actions separated by commas, as mentioned above. - on
Success String - (Optional String) An optional action to execute if the rule succeeds, otherwise the built-in action type
NONE
is used. ForUPDOWN
andWRITEREAD
rules, one can specify two actions separated by commas, such as "NONE,ERROR" for aWRITEREAD
rule. In this caseNONE
applies toWRITE
andERROR
applies toREAD
.
- kind
This property is required. string - (Required String) The kind of the rule. Accepted values are
CONDITION
andTRANSFORM
.CONDITION
- validate the value of a field,TRANSFORM
- transform the value of a field. Data quality rules useCONDITION
kind, data transformation, encryption and migration rules useTRANSFORM
kind. - mode
This property is required. string - (Required String) The mode of the rule. Accepted values are
UPGRADE
,DOWNGRADE
,UPDOWN
,WRITE
,READ
, andWRITEREAD
. - 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.
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, ConfluentENCRYPT
is used for data encryption rules, andJSONata
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 useJSONata
expressions. Defaults to "". - on
Failure string - (Optional String) An optional action to execute if the rule fails, otherwise the built-in action type
ERROR
is used. ForUPDOWN
andWRITEREAD
rules, one can specify two actions separated by commas, as mentioned above. - on
Success string - (Optional String) An optional action to execute if the rule succeeds, otherwise the built-in action type
NONE
is used. ForUPDOWN
andWRITEREAD
rules, one can specify two actions separated by commas, such as "NONE,ERROR" for aWRITEREAD
rule. In this caseNONE
applies toWRITE
andERROR
applies toREAD
.
- kind
This property is required. str - (Required String) The kind of the rule. Accepted values are
CONDITION
andTRANSFORM
.CONDITION
- validate the value of a field,TRANSFORM
- transform the value of a field. Data quality rules useCONDITION
kind, data transformation, encryption and migration rules useTRANSFORM
kind. - mode
This property is required. str - (Required String) The mode of the rule. Accepted values are
UPGRADE
,DOWNGRADE
,UPDOWN
,WRITE
,READ
, andWRITEREAD
. - 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.
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, ConfluentENCRYPT
is used for data encryption rules, andJSONata
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 useJSONata
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. ForUPDOWN
andWRITEREAD
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. ForUPDOWN
andWRITEREAD
rules, one can specify two actions separated by commas, such as "NONE,ERROR" for aWRITEREAD
rule. In this caseNONE
applies toWRITE
andERROR
applies toREAD
.
- kind
This property is required. String - (Required String) The kind of the rule. Accepted values are
CONDITION
andTRANSFORM
.CONDITION
- validate the value of a field,TRANSFORM
- transform the value of a field. Data quality rules useCONDITION
kind, data transformation, encryption and migration rules useTRANSFORM
kind. - mode
This property is required. String - (Required String) The mode of the rule. Accepted values are
UPGRADE
,DOWNGRADE
,UPDOWN
,WRITE
,READ
, andWRITEREAD
. - 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.
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, ConfluentENCRYPT
is used for data encryption rules, andJSONata
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 useJSONata
expressions. Defaults to "". - on
Failure String - (Optional String) An optional action to execute if the rule fails, otherwise the built-in action type
ERROR
is used. ForUPDOWN
andWRITEREAD
rules, one can specify two actions separated by commas, as mentioned above. - on
Success String - (Optional String) An optional action to execute if the rule succeeds, otherwise the built-in action type
NONE
is used. ForUPDOWN
andWRITEREAD
rules, one can specify two actions separated by commas, such as "NONE,ERROR" for aWRITEREAD
rule. In this caseNONE
applies toWRITE
andERROR
applies toREAD
.
GetSchemaRulesetMigrationRule
- Kind
This property is required. string - (Required String) The kind of the rule. Accepted values are
CONDITION
andTRANSFORM
.CONDITION
- validate the value of a field,TRANSFORM
- transform the value of a field. Data quality rules useCONDITION
kind, data transformation, encryption and migration rules useTRANSFORM
kind. - Mode
This property is required. string - (Required String) The mode of the rule. Accepted values are
UPGRADE
,DOWNGRADE
,UPDOWN
,WRITE
,READ
, andWRITEREAD
. - 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.
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, ConfluentENCRYPT
is used for data encryption rules, andJSONata
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 useJSONata
expressions. Defaults to "". - On
Failure string - (Optional String) An optional action to execute if the rule fails, otherwise the built-in action type
ERROR
is used. ForUPDOWN
andWRITEREAD
rules, one can specify two actions separated by commas, as mentioned above. - On
Success string - (Optional String) An optional action to execute if the rule succeeds, otherwise the built-in action type
NONE
is used. ForUPDOWN
andWRITEREAD
rules, one can specify two actions separated by commas, such as "NONE,ERROR" for aWRITEREAD
rule. In this caseNONE
applies toWRITE
andERROR
applies toREAD
.
- Kind
This property is required. string - (Required String) The kind of the rule. Accepted values are
CONDITION
andTRANSFORM
.CONDITION
- validate the value of a field,TRANSFORM
- transform the value of a field. Data quality rules useCONDITION
kind, data transformation, encryption and migration rules useTRANSFORM
kind. - Mode
This property is required. string - (Required String) The mode of the rule. Accepted values are
UPGRADE
,DOWNGRADE
,UPDOWN
,WRITE
,READ
, andWRITEREAD
. - 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.
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, ConfluentENCRYPT
is used for data encryption rules, andJSONata
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 useJSONata
expressions. Defaults to "". - On
Failure string - (Optional String) An optional action to execute if the rule fails, otherwise the built-in action type
ERROR
is used. ForUPDOWN
andWRITEREAD
rules, one can specify two actions separated by commas, as mentioned above. - On
Success string - (Optional String) An optional action to execute if the rule succeeds, otherwise the built-in action type
NONE
is used. ForUPDOWN
andWRITEREAD
rules, one can specify two actions separated by commas, such as "NONE,ERROR" for aWRITEREAD
rule. In this caseNONE
applies toWRITE
andERROR
applies toREAD
.
- kind
This property is required. String - (Required String) The kind of the rule. Accepted values are
CONDITION
andTRANSFORM
.CONDITION
- validate the value of a field,TRANSFORM
- transform the value of a field. Data quality rules useCONDITION
kind, data transformation, encryption and migration rules useTRANSFORM
kind. - mode
This property is required. String - (Required String) The mode of the rule. Accepted values are
UPGRADE
,DOWNGRADE
,UPDOWN
,WRITE
,READ
, andWRITEREAD
. - 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.
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, ConfluentENCRYPT
is used for data encryption rules, andJSONata
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 useJSONata
expressions. Defaults to "". - on
Failure String - (Optional String) An optional action to execute if the rule fails, otherwise the built-in action type
ERROR
is used. ForUPDOWN
andWRITEREAD
rules, one can specify two actions separated by commas, as mentioned above. - on
Success String - (Optional String) An optional action to execute if the rule succeeds, otherwise the built-in action type
NONE
is used. ForUPDOWN
andWRITEREAD
rules, one can specify two actions separated by commas, such as "NONE,ERROR" for aWRITEREAD
rule. In this caseNONE
applies toWRITE
andERROR
applies toREAD
.
- kind
This property is required. string - (Required String) The kind of the rule. Accepted values are
CONDITION
andTRANSFORM
.CONDITION
- validate the value of a field,TRANSFORM
- transform the value of a field. Data quality rules useCONDITION
kind, data transformation, encryption and migration rules useTRANSFORM
kind. - mode
This property is required. string - (Required String) The mode of the rule. Accepted values are
UPGRADE
,DOWNGRADE
,UPDOWN
,WRITE
,READ
, andWRITEREAD
. - 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.
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, ConfluentENCRYPT
is used for data encryption rules, andJSONata
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 useJSONata
expressions. Defaults to "". - on
Failure string - (Optional String) An optional action to execute if the rule fails, otherwise the built-in action type
ERROR
is used. ForUPDOWN
andWRITEREAD
rules, one can specify two actions separated by commas, as mentioned above. - on
Success string - (Optional String) An optional action to execute if the rule succeeds, otherwise the built-in action type
NONE
is used. ForUPDOWN
andWRITEREAD
rules, one can specify two actions separated by commas, such as "NONE,ERROR" for aWRITEREAD
rule. In this caseNONE
applies toWRITE
andERROR
applies toREAD
.
- kind
This property is required. str - (Required String) The kind of the rule. Accepted values are
CONDITION
andTRANSFORM
.CONDITION
- validate the value of a field,TRANSFORM
- transform the value of a field. Data quality rules useCONDITION
kind, data transformation, encryption and migration rules useTRANSFORM
kind. - mode
This property is required. str - (Required String) The mode of the rule. Accepted values are
UPGRADE
,DOWNGRADE
,UPDOWN
,WRITE
,READ
, andWRITEREAD
. - 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.
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, ConfluentENCRYPT
is used for data encryption rules, andJSONata
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 useJSONata
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. ForUPDOWN
andWRITEREAD
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. ForUPDOWN
andWRITEREAD
rules, one can specify two actions separated by commas, such as "NONE,ERROR" for aWRITEREAD
rule. In this caseNONE
applies toWRITE
andERROR
applies toREAD
.
- kind
This property is required. String - (Required String) The kind of the rule. Accepted values are
CONDITION
andTRANSFORM
.CONDITION
- validate the value of a field,TRANSFORM
- transform the value of a field. Data quality rules useCONDITION
kind, data transformation, encryption and migration rules useTRANSFORM
kind. - mode
This property is required. String - (Required String) The mode of the rule. Accepted values are
UPGRADE
,DOWNGRADE
,UPDOWN
,WRITE
,READ
, andWRITEREAD
. - 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.
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, ConfluentENCRYPT
is used for data encryption rules, andJSONata
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 useJSONata
expressions. Defaults to "". - on
Failure String - (Optional String) An optional action to execute if the rule fails, otherwise the built-in action type
ERROR
is used. ForUPDOWN
andWRITEREAD
rules, one can specify two actions separated by commas, as mentioned above. - on
Success String - (Optional String) An optional action to execute if the rule succeeds, otherwise the built-in action type
NONE
is used. ForUPDOWN
andWRITEREAD
rules, one can specify two actions separated by commas, such as "NONE,ERROR" for aWRITEREAD
rule. In this caseNONE
applies toWRITE
andERROR
applies toREAD
.
GetSchemaSchemaReference
- Name
This property is required. string - (Required String) A user-defined name that can be used to reference the rule.
- Subject
Name 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.
- Subject
Name 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.
- subject
Name 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.
- subject
Name 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.
- subject
Name 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.