@pulumi/digitalocean
Version:
A Pulumi package for creating and managing DigitalOcean cloud resources.
122 lines (121 loc) • 4.13 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Provides a DigitalOcean Kafka schema registry for Kafka clusters.
*
* ## Example Usage
*
* ### Create a new Kafka Schema Registry
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as digitalocean from "@pulumi/digitalocean";
*
* const kafka_example = new digitalocean.DatabaseCluster("kafka-example", {
* name: "example-kafka-cluster",
* engine: "kafka",
* version: "3.5",
* size: "gd-2vcpu-8gb",
* region: digitalocean.Region.BLR1,
* nodeCount: 3,
* tags: ["production"],
* });
* const schema_01 = new digitalocean.DatabaseKafkaSchemaRegistry("schema-01", {
* clusterId: kafka_example.id,
* subjectName: "test-schema",
* schemaType: "avro",
* schema: `{
* \\"type\\": \\"record\\",
* \\"namespace\\": \\"example\\",
* \\"name\\": \\"TestRecord\\",
* \\"fields\\": [
* {\\"name\\": \\"id\\", \\"type\\": \\"string\\"},
* {\\"name\\": \\"name\\", \\"type\\": \\"string\\"},
* {\\"name\\": \\"value\\", \\"type\\": \\"int\\"}
* ]
* }
* `,
* });
* ```
*/
export declare class DatabaseKafkaSchemaRegistry extends pulumi.CustomResource {
/**
* Get an existing DatabaseKafkaSchemaRegistry resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: DatabaseKafkaSchemaRegistryState, opts?: pulumi.CustomResourceOptions): DatabaseKafkaSchemaRegistry;
/**
* Returns true if the given object is an instance of DatabaseKafkaSchemaRegistry. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is DatabaseKafkaSchemaRegistry;
/**
* The ID of the target Kafka cluster.
*/
readonly clusterId: pulumi.Output<string>;
/**
* The schema definition as a string.
*/
readonly schema: pulumi.Output<string>;
/**
* The schema type. Available values are: avro, json, or protobuf.
*/
readonly schemaType: pulumi.Output<string>;
/**
* The name of the schema subject.
*/
readonly subjectName: pulumi.Output<string>;
/**
* Create a DatabaseKafkaSchemaRegistry resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: DatabaseKafkaSchemaRegistryArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering DatabaseKafkaSchemaRegistry resources.
*/
export interface DatabaseKafkaSchemaRegistryState {
/**
* The ID of the target Kafka cluster.
*/
clusterId?: pulumi.Input<string>;
/**
* The schema definition as a string.
*/
schema?: pulumi.Input<string>;
/**
* The schema type. Available values are: avro, json, or protobuf.
*/
schemaType?: pulumi.Input<string>;
/**
* The name of the schema subject.
*/
subjectName?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a DatabaseKafkaSchemaRegistry resource.
*/
export interface DatabaseKafkaSchemaRegistryArgs {
/**
* The ID of the target Kafka cluster.
*/
clusterId: pulumi.Input<string>;
/**
* The schema definition as a string.
*/
schema: pulumi.Input<string>;
/**
* The schema type. Available values are: avro, json, or protobuf.
*/
schemaType: pulumi.Input<string>;
/**
* The name of the schema subject.
*/
subjectName: pulumi.Input<string>;
}