Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Aiven Provider
  3. API Docs
  4. KafkaSchemaConfiguration
Aiven v6.28.0 published on Friday, Nov 15, 2024 by Pulumi
pulumi/pulumi-aiven

aiven.KafkaSchemaConfiguration

Explore with Pulumi AI

aiven logo
Aiven v6.28.0 published on Friday, Nov 15, 2024 by Pulumi
pulumi/pulumi-aiven

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

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as aiven from "@pulumi/aiven";

const config = new aiven.KafkaSchemaConfiguration("config", {
    project: kafka_schemas_project1.project,
    serviceName: kafka_service1.serviceName,
    compatibilityLevel: "BACKWARD",
});

    import pulumi
import pulumi_aiven as aiven

config = aiven.KafkaSchemaConfiguration("config",
    project=kafka_schemas_project1["project"],
    service_name=kafka_service1["serviceName"],
    compatibility_level="BACKWARD")

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := aiven.NewKafkaSchemaConfiguration(ctx, "config", &aiven.KafkaSchemaConfigurationArgs{
			Project:            pulumi.Any(kafka_schemas_project1.Project),
			ServiceName:        pulumi.Any(kafka_service1.ServiceName),
			CompatibilityLevel: pulumi.String("BACKWARD"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aiven = Pulumi.Aiven;

return await Deployment.RunAsync(() => 
{
    var config = new Aiven.KafkaSchemaConfiguration("config", new()
    {
        Project = kafka_schemas_project1.Project,
        ServiceName = kafka_service1.ServiceName,
        CompatibilityLevel = "BACKWARD",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aiven.KafkaSchemaConfiguration;
import com.pulumi.aiven.KafkaSchemaConfigurationArgs;
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) {
        var config = new KafkaSchemaConfiguration("config", KafkaSchemaConfigurationArgs.builder()
            .project(kafka_schemas_project1.project())
            .serviceName(kafka_service1.serviceName())
            .compatibilityLevel("BACKWARD")
            .build());

    }
}

    resources:
  config:
    type: aiven:KafkaSchemaConfiguration
    properties:
      project: ${["kafka-schemas-project1"].project}
      serviceName: ${["kafka-service1"].serviceName}
      compatibilityLevel: BACKWARD

    Create KafkaSchemaConfiguration Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new KafkaSchemaConfiguration(name: string, args: KafkaSchemaConfigurationArgs, opts?: CustomResourceOptions);
    @overload
def KafkaSchemaConfiguration(resource_name: str,
                             args: KafkaSchemaConfigurationArgs,
                             opts: Optional[ResourceOptions] = None)

@overload
def KafkaSchemaConfiguration(resource_name: str,
                             opts: Optional[ResourceOptions] = None,
                             project: Optional[str] = None,
                             service_name: Optional[str] = None,
                             compatibility_level: Optional[str] = None)
    func NewKafkaSchemaConfiguration(ctx *Context, name string, args KafkaSchemaConfigurationArgs, opts ...ResourceOption) (*KafkaSchemaConfiguration, error)
    public KafkaSchemaConfiguration(string name, KafkaSchemaConfigurationArgs args, CustomResourceOptions? opts = null)
    public KafkaSchemaConfiguration(String name, KafkaSchemaConfigurationArgs args)
public KafkaSchemaConfiguration(String name, KafkaSchemaConfigurationArgs args, CustomResourceOptions options)

    type: aiven:KafkaSchemaConfiguration
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    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.
    args KafkaSchemaConfigurationArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control 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.
    name String
    The unique name of the resource.
    args KafkaSchemaConfigurationArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var kafkaSchemaConfigurationResource = new Aiven.KafkaSchemaConfiguration("kafkaSchemaConfigurationResource", new()
{
    Project = "string",
    ServiceName = "string",
    CompatibilityLevel = "string",
});

    example, err := aiven.NewKafkaSchemaConfiguration(ctx, "kafkaSchemaConfigurationResource", &aiven.KafkaSchemaConfigurationArgs{
	Project:            pulumi.String("string"),
	ServiceName:        pulumi.String("string"),
	CompatibilityLevel: pulumi.String("string"),
})

    var kafkaSchemaConfigurationResource = new KafkaSchemaConfiguration("kafkaSchemaConfigurationResource", KafkaSchemaConfigurationArgs.builder()
    .project("string")
    .serviceName("string")
    .compatibilityLevel("string")
    .build());

    kafka_schema_configuration_resource = aiven.KafkaSchemaConfiguration("kafkaSchemaConfigurationResource",
    project="string",
    service_name="string",
    compatibility_level="string")

    const kafkaSchemaConfigurationResource = new aiven.KafkaSchemaConfiguration("kafkaSchemaConfigurationResource", {
    project: "string",
    serviceName: "string",
    compatibilityLevel: "string",
});

    type: aiven:KafkaSchemaConfiguration
properties:
    compatibilityLevel: string
    project: string
    serviceName: string

    KafkaSchemaConfiguration Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The KafkaSchemaConfiguration resource accepts the following input properties:

    Project string
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    ServiceName string
    The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    CompatibilityLevel string
    Kafka Schemas compatibility level. The possible values are BACKWARD, BACKWARD_TRANSITIVE, FORWARD, FORWARD_TRANSITIVE, FULL, FULL_TRANSITIVE and NONE.
    Project string
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    ServiceName string
    The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    CompatibilityLevel string
    Kafka Schemas compatibility level. The possible values are BACKWARD, BACKWARD_TRANSITIVE, FORWARD, FORWARD_TRANSITIVE, FULL, FULL_TRANSITIVE and NONE.
    project String
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    serviceName String
    The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    compatibilityLevel String
    Kafka Schemas compatibility level. The possible values are BACKWARD, BACKWARD_TRANSITIVE, FORWARD, FORWARD_TRANSITIVE, FULL, FULL_TRANSITIVE and NONE.
    project string
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    serviceName string
    The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    compatibilityLevel string
    Kafka Schemas compatibility level. The possible values are BACKWARD, BACKWARD_TRANSITIVE, FORWARD, FORWARD_TRANSITIVE, FULL, FULL_TRANSITIVE and NONE.
    project str
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    service_name str
    The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    compatibility_level str
    Kafka Schemas compatibility level. The possible values are BACKWARD, BACKWARD_TRANSITIVE, FORWARD, FORWARD_TRANSITIVE, FULL, FULL_TRANSITIVE and NONE.
    project String
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    serviceName String
    The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    compatibilityLevel String
    Kafka Schemas compatibility level. The possible values are BACKWARD, BACKWARD_TRANSITIVE, FORWARD, FORWARD_TRANSITIVE, FULL, FULL_TRANSITIVE and NONE.

    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 string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up 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)
    public static KafkaSchemaConfiguration get(String name, Output<String> id, KafkaSchemaConfigurationState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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.
    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
    Kafka Schemas compatibility level. The possible values are BACKWARD, BACKWARD_TRANSITIVE, FORWARD, FORWARD_TRANSITIVE, FULL, FULL_TRANSITIVE and NONE.
    Project string
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    ServiceName string
    The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    CompatibilityLevel string
    Kafka Schemas compatibility level. The possible values are BACKWARD, BACKWARD_TRANSITIVE, FORWARD, FORWARD_TRANSITIVE, FULL, FULL_TRANSITIVE and NONE.
    Project string
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    ServiceName string
    The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    compatibilityLevel String
    Kafka Schemas compatibility level. The possible values are BACKWARD, BACKWARD_TRANSITIVE, FORWARD, FORWARD_TRANSITIVE, FULL, FULL_TRANSITIVE and NONE.
    project String
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    serviceName String
    The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    compatibilityLevel string
    Kafka Schemas compatibility level. The possible values are BACKWARD, BACKWARD_TRANSITIVE, FORWARD, FORWARD_TRANSITIVE, FULL, FULL_TRANSITIVE and NONE.
    project string
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    serviceName string
    The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    compatibility_level str
    Kafka Schemas compatibility level. The possible values are BACKWARD, BACKWARD_TRANSITIVE, FORWARD, FORWARD_TRANSITIVE, FULL, FULL_TRANSITIVE and NONE.
    project str
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    service_name str
    The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    compatibilityLevel String
    Kafka Schemas compatibility level. The possible values are BACKWARD, BACKWARD_TRANSITIVE, FORWARD, FORWARD_TRANSITIVE, FULL, FULL_TRANSITIVE and NONE.
    project String
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    serviceName String
    The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.

    Import

    $ pulumi import aiven:index/kafkaSchemaConfiguration:KafkaSchemaConfiguration config PROJECT/SERVICE_NAME

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Aiven pulumi/pulumi-aiven
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aiven Terraform Provider.
    aiven logo
    Aiven v6.28.0 published on Friday, Nov 15, 2024 by Pulumi
    pulumi/pulumi-aiven