Aiven v6.28.0 published on Friday, Nov 15, 2024 by Pulumi
aiven.getKafkaSchema
Explore with Pulumi AI
The Kafka Schema data source provides information about the existing Aiven Kafka Schema.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aiven from "@pulumi/aiven";
const config = aiven.getKafkaSchemaConfiguration({
project: kafka_schemas_project1.project,
serviceName: kafka_service1.serviceName,
});
import pulumi
import pulumi_aiven as aiven
config = aiven.get_kafka_schema_configuration(project=kafka_schemas_project1["project"],
service_name=kafka_service1["serviceName"])
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.LookupKafkaSchemaConfiguration(ctx, &aiven.LookupKafkaSchemaConfigurationArgs{
Project: kafka_schemas_project1.Project,
ServiceName: kafka_service1.ServiceName,
}, nil)
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 = Aiven.GetKafkaSchemaConfiguration.Invoke(new()
{
Project = kafka_schemas_project1.Project,
ServiceName = kafka_service1.ServiceName,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aiven.AivenFunctions;
import com.pulumi.aiven.inputs.GetKafkaSchemaConfigurationArgs;
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 config = AivenFunctions.getKafkaSchemaConfiguration(GetKafkaSchemaConfigurationArgs.builder()
.project(kafka_schemas_project1.project())
.serviceName(kafka_service1.serviceName())
.build());
}
}
variables:
config:
fn::invoke:
Function: aiven:getKafkaSchemaConfiguration
Arguments:
project: ${["kafka-schemas-project1"].project}
serviceName: ${["kafka-service1"].serviceName}
Using getKafkaSchema
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 getKafkaSchema(args: GetKafkaSchemaArgs, opts?: InvokeOptions): Promise<GetKafkaSchemaResult>
function getKafkaSchemaOutput(args: GetKafkaSchemaOutputArgs, opts?: InvokeOptions): Output<GetKafkaSchemaResult>
def get_kafka_schema(project: Optional[str] = None,
service_name: Optional[str] = None,
subject_name: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetKafkaSchemaResult
def get_kafka_schema_output(project: Optional[pulumi.Input[str]] = None,
service_name: Optional[pulumi.Input[str]] = None,
subject_name: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetKafkaSchemaResult]
func LookupKafkaSchema(ctx *Context, args *LookupKafkaSchemaArgs, opts ...InvokeOption) (*LookupKafkaSchemaResult, error)
func LookupKafkaSchemaOutput(ctx *Context, args *LookupKafkaSchemaOutputArgs, opts ...InvokeOption) LookupKafkaSchemaResultOutput
> Note: This function is named LookupKafkaSchema
in the Go SDK.
public static class GetKafkaSchema
{
public static Task<GetKafkaSchemaResult> InvokeAsync(GetKafkaSchemaArgs args, InvokeOptions? opts = null)
public static Output<GetKafkaSchemaResult> Invoke(GetKafkaSchemaInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetKafkaSchemaResult> getKafkaSchema(GetKafkaSchemaArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: aiven:index/getKafkaSchema:getKafkaSchema
arguments:
# arguments dictionary
The following arguments are supported:
- 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.
- Service
Name 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.
- Subject
Name string - The Kafka Schema Subject name. Changing this property forces recreation of the resource.
- 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.
- Service
Name 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.
- Subject
Name string - The Kafka Schema Subject name. Changing this property forces recreation of the resource.
- 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.
- service
Name 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.
- subject
Name String - The Kafka Schema Subject name. Changing this property forces recreation of the resource.
- 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.
- service
Name 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.
- subject
Name string - The Kafka Schema Subject name. Changing this property forces recreation of the resource.
- 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.
- subject_
name str - The Kafka Schema Subject name. Changing this property forces recreation of the resource.
- 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.
- service
Name 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.
- subject
Name String - The Kafka Schema Subject name. Changing this property forces recreation of the resource.
getKafkaSchema Result
The following output properties are available:
- Compatibility
Level string - Kafka Schemas compatibility level. The possible values are
BACKWARD
,BACKWARD_TRANSITIVE
,FORWARD
,FORWARD_TRANSITIVE
,FULL
,FULL_TRANSITIVE
andNONE
. - Id string
- The provider-assigned unique ID for this managed resource.
- 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.
- Schema string
- Kafka Schema configuration. Should be a valid Avro, JSON, or Protobuf schema, depending on the schema type.
- Schema
Type string - Kafka Schema configuration type. Defaults to AVRO. The possible values are
AVRO
,JSON
andPROTOBUF
. - Service
Name 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.
- Subject
Name string - The Kafka Schema Subject name. Changing this property forces recreation of the resource.
- Version int
- Kafka Schema configuration version.
- Compatibility
Level string - Kafka Schemas compatibility level. The possible values are
BACKWARD
,BACKWARD_TRANSITIVE
,FORWARD
,FORWARD_TRANSITIVE
,FULL
,FULL_TRANSITIVE
andNONE
. - Id string
- The provider-assigned unique ID for this managed resource.
- 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.
- Schema string
- Kafka Schema configuration. Should be a valid Avro, JSON, or Protobuf schema, depending on the schema type.
- Schema
Type string - Kafka Schema configuration type. Defaults to AVRO. The possible values are
AVRO
,JSON
andPROTOBUF
. - Service
Name 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.
- Subject
Name string - The Kafka Schema Subject name. Changing this property forces recreation of the resource.
- Version int
- Kafka Schema configuration version.
- compatibility
Level String - Kafka Schemas compatibility level. The possible values are
BACKWARD
,BACKWARD_TRANSITIVE
,FORWARD
,FORWARD_TRANSITIVE
,FULL
,FULL_TRANSITIVE
andNONE
. - id String
- The provider-assigned unique ID for this managed resource.
- 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.
- schema String
- Kafka Schema configuration. Should be a valid Avro, JSON, or Protobuf schema, depending on the schema type.
- schema
Type String - Kafka Schema configuration type. Defaults to AVRO. The possible values are
AVRO
,JSON
andPROTOBUF
. - service
Name 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.
- subject
Name String - The Kafka Schema Subject name. Changing this property forces recreation of the resource.
- version Integer
- Kafka Schema configuration version.
- compatibility
Level string - Kafka Schemas compatibility level. The possible values are
BACKWARD
,BACKWARD_TRANSITIVE
,FORWARD
,FORWARD_TRANSITIVE
,FULL
,FULL_TRANSITIVE
andNONE
. - id string
- The provider-assigned unique ID for this managed resource.
- 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.
- schema string
- Kafka Schema configuration. Should be a valid Avro, JSON, or Protobuf schema, depending on the schema type.
- schema
Type string - Kafka Schema configuration type. Defaults to AVRO. The possible values are
AVRO
,JSON
andPROTOBUF
. - service
Name 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.
- subject
Name string - The Kafka Schema Subject name. Changing this property forces recreation of the resource.
- version number
- Kafka Schema configuration version.
- compatibility_
level str - Kafka Schemas compatibility level. The possible values are
BACKWARD
,BACKWARD_TRANSITIVE
,FORWARD
,FORWARD_TRANSITIVE
,FULL
,FULL_TRANSITIVE
andNONE
. - id str
- The provider-assigned unique ID for this managed resource.
- 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.
- schema str
- Kafka Schema configuration. Should be a valid Avro, JSON, or Protobuf schema, depending on the schema type.
- schema_
type str - Kafka Schema configuration type. Defaults to AVRO. The possible values are
AVRO
,JSON
andPROTOBUF
. - 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.
- subject_
name str - The Kafka Schema Subject name. Changing this property forces recreation of the resource.
- version int
- Kafka Schema configuration version.
- compatibility
Level String - Kafka Schemas compatibility level. The possible values are
BACKWARD
,BACKWARD_TRANSITIVE
,FORWARD
,FORWARD_TRANSITIVE
,FULL
,FULL_TRANSITIVE
andNONE
. - id String
- The provider-assigned unique ID for this managed resource.
- 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.
- schema String
- Kafka Schema configuration. Should be a valid Avro, JSON, or Protobuf schema, depending on the schema type.
- schema
Type String - Kafka Schema configuration type. Defaults to AVRO. The possible values are
AVRO
,JSON
andPROTOBUF
. - service
Name 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.
- subject
Name String - The Kafka Schema Subject name. Changing this property forces recreation of the resource.
- version Number
- Kafka Schema configuration version.
Package Details
- Repository
- Aiven pulumi/pulumi-aiven
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
aiven
Terraform Provider.