Ready to level-up your engineering skills? Join a Pulumi Workshop. Register Now
  1. Docs
  2. Reference
  3. API
  4. Aiven
  5. getKafkaSchema

getKafkaSchema

# Kafka Schema Data Source

The Kafka Schema data source provides information about the existing Aiven Kafka Schema.

Example Usage

using Pulumi;
using Aiven = Pulumi.Aiven;

class MyStack : Stack
{
    public MyStack()
    {
        var kafka_schema1 = Output.Create(Aiven.GetKafkaSchema.InvokeAsync(new Aiven.GetKafkaSchemaArgs
        {
            Project = aiven_project.Kafka_schemas_project1.Project,
            ServiceName = aiven_service.Kafka_service1.Service_name,
            SubjectName = "kafka-schema1",
        }));
    }

}

package main

import (
    "github.com/pulumi/pulumi-aiven/sdk/v3/go/aiven"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        _, err := aiven.LookupKafkaSchema(ctx, &aiven.LookupKafkaSchemaArgs{
            Project:     aiven_project.Kafka - schemas - project1.Project,
            ServiceName: aiven_service.Kafka - service1.Service_name,
            SubjectName: "kafka-schema1",
        }, nil)
        if err != nil {
            return err
        }
        return nil
    })
}
import pulumi
import pulumi_aiven as aiven

kafka_schema1 = aiven.get_kafka_schema(project=aiven_project["kafka-schemas-project1"]["project"],
    service_name=aiven_service["kafka-service1"]["service_name"],
    subject_name="kafka-schema1")
import * as pulumi from "@pulumi/pulumi";
import * as aiven from "@pulumi/aiven";

const kafka-schema1 = aiven.getKafkaSchema({
    project: aiven_project["kafka-schemas-project1"].project,
    serviceName: aiven_service["kafka-service1"].service_name,
    subjectName: "kafka-schema1",
});

Using getKafkaSchema

function getKafkaSchema(args: GetKafkaSchemaArgs, opts?: InvokeOptions): Promise<GetKafkaSchemaResult>
def get_kafka_schema(compatibility_level: Optional[str] = None, project: Optional[str] = None, schema: Optional[str] = None, service_name: Optional[str] = None, subject_name: Optional[str] = None, version: Optional[int] = None, opts: Optional[InvokeOptions] = None) -> GetKafkaSchemaResult
func LookupKafkaSchema(ctx *Context, args *LookupKafkaSchemaArgs, opts ...InvokeOption) (*LookupKafkaSchemaResult, error)

Note: This function is named LookupKafkaSchema in the Go SDK.

public static class GetKafkaSchema {
    public static Task<GetKafkaSchemaResult> InvokeAsync(GetKafkaSchemaArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

Project string

and service_name - (Required) define the project and service the Kafka Schemas belongs to. They should be defined using reference as shown above to set up dependencies correctly.

ServiceName string
SubjectName string

is Kafka Schema subject name.

CompatibilityLevel string

configuration compatibility level overrides specific subject resource. If the compatibility level not specified for the individual subject by default, it takes a global value. Allowed values: BACKWARD, BACKWARD_TRANSITIVE, FORWARD, FORWARD_TRANSITIVE, FULL, FULL_TRANSITIVE, NONE.

Schema string

is Kafka Schema configuration should be a valid Avro Schema JSON format.

Version int
Project string

and service_name - (Required) define the project and service the Kafka Schemas belongs to. They should be defined using reference as shown above to set up dependencies correctly.

ServiceName string
SubjectName string

is Kafka Schema subject name.

CompatibilityLevel string

configuration compatibility level overrides specific subject resource. If the compatibility level not specified for the individual subject by default, it takes a global value. Allowed values: BACKWARD, BACKWARD_TRANSITIVE, FORWARD, FORWARD_TRANSITIVE, FULL, FULL_TRANSITIVE, NONE.

Schema string

is Kafka Schema configuration should be a valid Avro Schema JSON format.

Version int
project string

and service_name - (Required) define the project and service the Kafka Schemas belongs to. They should be defined using reference as shown above to set up dependencies correctly.

serviceName string
subjectName string

is Kafka Schema subject name.

compatibilityLevel string

configuration compatibility level overrides specific subject resource. If the compatibility level not specified for the individual subject by default, it takes a global value. Allowed values: BACKWARD, BACKWARD_TRANSITIVE, FORWARD, FORWARD_TRANSITIVE, FULL, FULL_TRANSITIVE, NONE.

schema string

is Kafka Schema configuration should be a valid Avro Schema JSON format.

version number
project str

and service_name - (Required) define the project and service the Kafka Schemas belongs to. They should be defined using reference as shown above to set up dependencies correctly.

service_name str
subject_name str

is Kafka Schema subject name.

compatibility_level str

configuration compatibility level overrides specific subject resource. If the compatibility level not specified for the individual subject by default, it takes a global value. Allowed values: BACKWARD, BACKWARD_TRANSITIVE, FORWARD, FORWARD_TRANSITIVE, FULL, FULL_TRANSITIVE, NONE.

schema str

is Kafka Schema configuration should be a valid Avro Schema JSON format.

version int

getKafkaSchema Result

The following output properties are available:

Id string

The provider-assigned unique ID for this managed resource.

Project string
ServiceName string
SubjectName string
Version int
CompatibilityLevel string

configuration compatibility level overrides specific subject resource. If the compatibility level not specified for the individual subject by default, it takes a global value. Allowed values: BACKWARD, BACKWARD_TRANSITIVE, FORWARD, FORWARD_TRANSITIVE, FULL, FULL_TRANSITIVE, NONE.

Schema string

is Kafka Schema configuration should be a valid Avro Schema JSON format.

Id string

The provider-assigned unique ID for this managed resource.

Project string
ServiceName string
SubjectName string
Version int
CompatibilityLevel string

configuration compatibility level overrides specific subject resource. If the compatibility level not specified for the individual subject by default, it takes a global value. Allowed values: BACKWARD, BACKWARD_TRANSITIVE, FORWARD, FORWARD_TRANSITIVE, FULL, FULL_TRANSITIVE, NONE.

Schema string

is Kafka Schema configuration should be a valid Avro Schema JSON format.

id string

The provider-assigned unique ID for this managed resource.

project string
serviceName string
subjectName string
version number
compatibilityLevel string

configuration compatibility level overrides specific subject resource. If the compatibility level not specified for the individual subject by default, it takes a global value. Allowed values: BACKWARD, BACKWARD_TRANSITIVE, FORWARD, FORWARD_TRANSITIVE, FULL, FULL_TRANSITIVE, NONE.

schema string

is Kafka Schema configuration should be a valid Avro Schema JSON format.

id str

The provider-assigned unique ID for this managed resource.

project str
service_name str
subject_name str
version int
compatibility_level str

configuration compatibility level overrides specific subject resource. If the compatibility level not specified for the individual subject by default, it takes a global value. Allowed values: BACKWARD, BACKWARD_TRANSITIVE, FORWARD, FORWARD_TRANSITIVE, FULL, FULL_TRANSITIVE, NONE.

schema str

is Kafka Schema configuration should be a valid Avro Schema JSON format.

Package Details

Repository
https://github.com/pulumi/pulumi-aiven
License
Apache-2.0
Notes
This Pulumi package is based on the aiven Terraform Provider.