com.pulumi.aws.glue.kotlin.SchemaArgs.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-aws-kotlin Show documentation
Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.
There is a newer version: 6.57.0.0
Show newest version
@file:Suppress("NAME_SHADOWING", "DEPRECATION")

package com.pulumi.aws.glue.kotlin

import com.pulumi.aws.glue.SchemaArgs.builder
import com.pulumi.core.Output
import com.pulumi.core.Output.of
import com.pulumi.kotlin.ConvertibleToJava
import com.pulumi.kotlin.PulumiTagMarker
import kotlin.Pair
import kotlin.String
import kotlin.Suppress
import kotlin.collections.Map
import kotlin.jvm.JvmName

/**
 * Provides a Glue Schema resource.
 * ## Example Usage
 * 
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as aws from "@pulumi/aws";
 * const example = new aws.glue.Schema("example", {
 *     schemaName: "example",
 *     registryArn: test.arn,
 *     dataFormat: "AVRO",
 *     compatibility: "NONE",
 *     schemaDefinition: "{\"type\": \"record\", \"name\": \"r1\", \"fields\": [ {\"name\": \"f1\", \"type\": \"int\"}, {\"name\": \"f2\", \"type\": \"string\"} ]}",
 * });
 * ```
 * ```python
 * import pulumi
 * import pulumi_aws as aws
 * example = aws.glue.Schema("example",
 *     schema_name="example",
 *     registry_arn=test["arn"],
 *     data_format="AVRO",
 *     compatibility="NONE",
 *     schema_definition="{\"type\": \"record\", \"name\": \"r1\", \"fields\": [ {\"name\": \"f1\", \"type\": \"int\"}, {\"name\": \"f2\", \"type\": \"string\"} ]}")
 * ```
 * ```csharp
 * using System.Collections.Generic;
 * using System.Linq;
 * using Pulumi;
 * using Aws = Pulumi.Aws;
 * return await Deployment.RunAsync(() =>
 * {
 *     var example = new Aws.Glue.Schema("example", new()
 *     {
 *         SchemaName = "example",
 *         RegistryArn = test.Arn,
 *         DataFormat = "AVRO",
 *         Compatibility = "NONE",
 *         SchemaDefinition = "{\"type\": \"record\", \"name\": \"r1\", \"fields\": [ {\"name\": \"f1\", \"type\": \"int\"}, {\"name\": \"f2\", \"type\": \"string\"} ]}",
 *     });
 * });
 * ```
 * ```go
 * package main
 * import (
 * 	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/glue"
 * 	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
 * )
 * func main() {
 * 	pulumi.Run(func(ctx *pulumi.Context) error {
 * 		_, err := glue.NewSchema(ctx, "example", &glue.SchemaArgs{
 * 			SchemaName:       pulumi.String("example"),
 * 			RegistryArn:      pulumi.Any(test.Arn),
 * 			DataFormat:       pulumi.String("AVRO"),
 * 			Compatibility:    pulumi.String("NONE"),
 * 			SchemaDefinition: pulumi.String("{\"type\": \"record\", \"name\": \"r1\", \"fields\": [ {\"name\": \"f1\", \"type\": \"int\"}, {\"name\": \"f2\", \"type\": \"string\"} ]}"),
 * 		})
 * 		if err != nil {
 * 			return err
 * 		}
 * 		return nil
 * 	})
 * }
 * ```
 * ```java
 * package generated_program;
 * import com.pulumi.Context;
 * import com.pulumi.Pulumi;
 * import com.pulumi.core.Output;
 * import com.pulumi.aws.glue.Schema;
 * import com.pulumi.aws.glue.SchemaArgs;
 * 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 example = new Schema("example", SchemaArgs.builder()
 *             .schemaName("example")
 *             .registryArn(test.arn())
 *             .dataFormat("AVRO")
 *             .compatibility("NONE")
 *             .schemaDefinition("{\"type\": \"record\", \"name\": \"r1\", \"fields\": [ {\"name\": \"f1\", \"type\": \"int\"}, {\"name\": \"f2\", \"type\": \"string\"} ]}")
 *             .build());
 *     }
 * }
 * ```
 * ```yaml
 * resources:
 *   example:
 *     type: aws:glue:Schema
 *     properties:
 *       schemaName: example
 *       registryArn: ${test.arn}
 *       dataFormat: AVRO
 *       compatibility: NONE
 *       schemaDefinition: '{"type": "record", "name": "r1", "fields": [ {"name": "f1", "type": "int"}, {"name": "f2", "type": "string"} ]}'
 * ```
 * 
 * ## Import
 * Using `pulumi import`, import Glue Registries using `arn`. For example:
 * ```sh
 * $ pulumi import aws:glue/schema:Schema example arn:aws:glue:us-west-2:123456789012:schema/example/example
 * ```
 * @property compatibility The compatibility mode of the schema. Values values are: `NONE`, `DISABLED`, `BACKWARD`, `BACKWARD_ALL`, `FORWARD`, `FORWARD_ALL`, `FULL`, and `FULL_ALL`.
 * @property dataFormat The data format of the schema definition. Valid values are `AVRO`, `JSON` and `PROTOBUF`.
 * @property description A description of the schema.
 * @property registryArn The ARN of the Glue Registry to create the schema in.
 * @property schemaDefinition The schema definition using the `data_format` setting for `schema_name`.
 * @property schemaName The Name of the schema.
 * @property tags Key-value map of resource tags. .If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
 */
public data class SchemaArgs(
    public val compatibility: Output? = null,
    public val dataFormat: Output? = null,
    public val description: Output? = null,
    public val registryArn: Output? = null,
    public val schemaDefinition: Output? = null,
    public val schemaName: Output? = null,
    public val tags: Output>? = null,
) : ConvertibleToJava {
    override fun toJava(): com.pulumi.aws.glue.SchemaArgs = com.pulumi.aws.glue.SchemaArgs.builder()
        .compatibility(compatibility?.applyValue({ args0 -> args0 }))
        .dataFormat(dataFormat?.applyValue({ args0 -> args0 }))
        .description(description?.applyValue({ args0 -> args0 }))
        .registryArn(registryArn?.applyValue({ args0 -> args0 }))
        .schemaDefinition(schemaDefinition?.applyValue({ args0 -> args0 }))
        .schemaName(schemaName?.applyValue({ args0 -> args0 }))
        .tags(
            tags?.applyValue({ args0 ->
                args0.map({ args0 ->
                    args0.key.to(args0.value)
                }).toMap()
            }),
        ).build()
}

/**
 * Builder for [SchemaArgs].
 */
@PulumiTagMarker
public class SchemaArgsBuilder internal constructor() {
    private var compatibility: Output? = null

    private var dataFormat: Output? = null

    private var description: Output? = null

    private var registryArn: Output? = null

    private var schemaDefinition: Output? = null

    private var schemaName: Output? = null

    private var tags: Output>? = null

    /**
     * @param value The compatibility mode of the schema. Values values are: `NONE`, `DISABLED`, `BACKWARD`, `BACKWARD_ALL`, `FORWARD`, `FORWARD_ALL`, `FULL`, and `FULL_ALL`.
     */
    @JvmName("tieotwapxfyemreb")
    public suspend fun compatibility(`value`: Output) {
        this.compatibility = value
    }

    /**
     * @param value The data format of the schema definition. Valid values are `AVRO`, `JSON` and `PROTOBUF`.
     */
    @JvmName("gtepnowukctdopry")
    public suspend fun dataFormat(`value`: Output) {
        this.dataFormat = value
    }

    /**
     * @param value A description of the schema.
     */
    @JvmName("nasieqtxuwamwnrc")
    public suspend fun description(`value`: Output) {
        this.description = value
    }

    /**
     * @param value The ARN of the Glue Registry to create the schema in.
     */
    @JvmName("vvswuepytkceohco")
    public suspend fun registryArn(`value`: Output) {
        this.registryArn = value
    }

    /**
     * @param value The schema definition using the `data_format` setting for `schema_name`.
     */
    @JvmName("itcqdjpjpgwmifwa")
    public suspend fun schemaDefinition(`value`: Output) {
        this.schemaDefinition = value
    }

    /**
     * @param value The Name of the schema.
     */
    @JvmName("cfalfbgudsaqtbkb")
    public suspend fun schemaName(`value`: Output) {
        this.schemaName = value
    }

    /**
     * @param value Key-value map of resource tags. .If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
     */
    @JvmName("gvrtklcogcdqkhpv")
    public suspend fun tags(`value`: Output>) {
        this.tags = value
    }

    /**
     * @param value The compatibility mode of the schema. Values values are: `NONE`, `DISABLED`, `BACKWARD`, `BACKWARD_ALL`, `FORWARD`, `FORWARD_ALL`, `FULL`, and `FULL_ALL`.
     */
    @JvmName("roawvnomndwbirke")
    public suspend fun compatibility(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.compatibility = mapped
    }

    /**
     * @param value The data format of the schema definition. Valid values are `AVRO`, `JSON` and `PROTOBUF`.
     */
    @JvmName("vkxetembewyrhhpm")
    public suspend fun dataFormat(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.dataFormat = mapped
    }

    /**
     * @param value A description of the schema.
     */
    @JvmName("ahwdqjcvoyppmsnl")
    public suspend fun description(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.description = mapped
    }

    /**
     * @param value The ARN of the Glue Registry to create the schema in.
     */
    @JvmName("lhbxhfruqiendtrs")
    public suspend fun registryArn(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.registryArn = mapped
    }

    /**
     * @param value The schema definition using the `data_format` setting for `schema_name`.
     */
    @JvmName("lywenhmrpsnyqqnf")
    public suspend fun schemaDefinition(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.schemaDefinition = mapped
    }

    /**
     * @param value The Name of the schema.
     */
    @JvmName("iswyisfpmnfwwpwn")
    public suspend fun schemaName(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.schemaName = mapped
    }

    /**
     * @param value Key-value map of resource tags. .If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
     */
    @JvmName("upnybgqbapqnkxtt")
    public suspend fun tags(`value`: Map?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.tags = mapped
    }

    /**
     * @param values Key-value map of resource tags. .If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
     */
    @JvmName("kgckcploaudelrvb")
    public fun tags(vararg values: Pair) {
        val toBeMapped = values.toMap()
        val mapped = toBeMapped.let({ args0 -> of(args0) })
        this.tags = mapped
    }

    internal fun build(): SchemaArgs = SchemaArgs(
        compatibility = compatibility,
        dataFormat = dataFormat,
        description = description,
        registryArn = registryArn,
        schemaDefinition = schemaDefinition,
        schemaName = schemaName,
        tags = tags,
    )
}