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

KafkaSchemaConfiguration

# Kafka Schema Configuration Resource

The Kafka Schema Configuration resource allows the creation and management of Aiven Kafka Schema Configurations.

Example Usage

using Pulumi;
using Aiven = Pulumi.Aiven;

class MyStack : Stack
{
    public MyStack()
    {
        var config = new Aiven.KafkaSchemaConfiguration("config", new Aiven.KafkaSchemaConfigurationArgs
        {
            Project = aiven_project.Kafka_schemas_project1.Project,
            ServiceName = aiven_service.Kafka_service1.Service_name,
            CompatibilityLevel = "BACKWARD",
        });
    }

}

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.NewKafkaSchemaConfiguration(ctx, "config", &aiven.KafkaSchemaConfigurationArgs{
            Project:            pulumi.Any(aiven_project.Kafka - schemas - project1.Project),
            ServiceName:        pulumi.Any(aiven_service.Kafka - service1.Service_name),
            CompatibilityLevel: pulumi.String("BACKWARD"),
        })
        if err != nil {
            return err
        }
        return nil
    })
}
import pulumi
import pulumi_aiven as aiven

config = aiven.KafkaSchemaConfiguration("config",
    project=aiven_project["kafka-schemas-project1"]["project"],
    service_name=aiven_service["kafka-service1"]["service_name"],
    compatibility_level="BACKWARD")
import * as pulumi from "@pulumi/pulumi";
import * as aiven from "@pulumi/aiven";

const config = new aiven.KafkaSchemaConfiguration("config", {
    project: aiven_project["kafka-schemas-project1"].project,
    serviceName: aiven_service["kafka-service1"].service_name,
    compatibilityLevel: "BACKWARD",
});

Create a KafkaSchemaConfiguration Resource

new KafkaSchemaConfiguration(name: string, args: KafkaSchemaConfigurationArgs, opts?: CustomResourceOptions);
def KafkaSchemaConfiguration(resource_name: str, opts: Optional[ResourceOptions] = None, compatibility_level: Optional[str] = None, project: Optional[str] = None, service_name: Optional[str] = None)
func NewKafkaSchemaConfiguration(ctx *Context, name string, args KafkaSchemaConfigurationArgs, opts ...ResourceOption) (*KafkaSchemaConfiguration, error)
public KafkaSchemaConfiguration(string name, KafkaSchemaConfigurationArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args KafkaSchemaConfigurationArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
opts ResourceOptions
A bag of options that control this resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args KafkaSchemaConfigurationArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args KafkaSchemaConfigurationArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

KafkaSchemaConfiguration Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The KafkaSchemaConfiguration resource accepts the following input properties:

CompatibilityLevel string

is the Global Kafka Schema configuration compatibility level when defined for aiven.KafkaSchemaConfiguration resource. Also, Kafka Schema configuration compatibility level can be overridden for a specific subject when used in aiven.KafkaSchema 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.

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

Service to link the Kafka Schemas Configuration to

CompatibilityLevel string

is the Global Kafka Schema configuration compatibility level when defined for aiven.KafkaSchemaConfiguration resource. Also, Kafka Schema configuration compatibility level can be overridden for a specific subject when used in aiven.KafkaSchema 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.

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

Service to link the Kafka Schemas Configuration to

compatibilityLevel string

is the Global Kafka Schema configuration compatibility level when defined for aiven.KafkaSchemaConfiguration resource. Also, Kafka Schema configuration compatibility level can be overridden for a specific subject when used in aiven.KafkaSchema 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.

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

Service to link the Kafka Schemas Configuration to

compatibility_level str

is the Global Kafka Schema configuration compatibility level when defined for aiven.KafkaSchemaConfiguration resource. Also, Kafka Schema configuration compatibility level can be overridden for a specific subject when used in aiven.KafkaSchema 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.

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

Service to link the Kafka Schemas Configuration to

Outputs

All input properties are implicitly available as output properties. Additionally, the KafkaSchemaConfiguration resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.

Look up an Existing KafkaSchemaConfiguration Resource

Get an existing KafkaSchemaConfiguration resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: KafkaSchemaConfigurationState, opts?: CustomResourceOptions): KafkaSchemaConfiguration
@staticmethod
def get(resource_name: str, id: str, opts: Optional[ResourceOptions] = None, compatibility_level: Optional[str] = None, project: Optional[str] = None, service_name: Optional[str] = None) -> KafkaSchemaConfiguration
func GetKafkaSchemaConfiguration(ctx *Context, name string, id IDInput, state *KafkaSchemaConfigurationState, opts ...ResourceOption) (*KafkaSchemaConfiguration, error)
public static KafkaSchemaConfiguration Get(string name, Input<string> id, KafkaSchemaConfigurationState? state, CustomResourceOptions? opts = null)
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.

The following state arguments are supported:

CompatibilityLevel string

is the Global Kafka Schema configuration compatibility level when defined for aiven.KafkaSchemaConfiguration resource. Also, Kafka Schema configuration compatibility level can be overridden for a specific subject when used in aiven.KafkaSchema 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.

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

Service to link the Kafka Schemas Configuration to

CompatibilityLevel string

is the Global Kafka Schema configuration compatibility level when defined for aiven.KafkaSchemaConfiguration resource. Also, Kafka Schema configuration compatibility level can be overridden for a specific subject when used in aiven.KafkaSchema 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.

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

Service to link the Kafka Schemas Configuration to

compatibilityLevel string

is the Global Kafka Schema configuration compatibility level when defined for aiven.KafkaSchemaConfiguration resource. Also, Kafka Schema configuration compatibility level can be overridden for a specific subject when used in aiven.KafkaSchema 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.

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

Service to link the Kafka Schemas Configuration to

compatibility_level str

is the Global Kafka Schema configuration compatibility level when defined for aiven.KafkaSchemaConfiguration resource. Also, Kafka Schema configuration compatibility level can be overridden for a specific subject when used in aiven.KafkaSchema 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.

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

Service to link the Kafka Schemas Configuration to

Package Details

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