com.pulumi.aws.schemas.kotlin.Schema.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
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.
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.aws.schemas.kotlin
import com.pulumi.core.Output
import com.pulumi.kotlin.KotlinCustomResource
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.ResourceMapper
import com.pulumi.kotlin.options.CustomResourceOptions
import com.pulumi.kotlin.options.CustomResourceOptionsBuilder
import com.pulumi.resources.Resource
import kotlin.Boolean
import kotlin.Deprecated
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.collections.Map
/**
* Builder for [Schema].
*/
@PulumiTagMarker
public class SchemaResourceBuilder internal constructor() {
public var name: String? = null
public var args: SchemaArgs = SchemaArgs()
public var opts: CustomResourceOptions = CustomResourceOptions()
/**
* @param name The _unique_ name of the resulting resource.
*/
public fun name(`value`: String) {
this.name = value
}
/**
* @param block The arguments to use to populate this resource's properties.
*/
public suspend fun args(block: suspend SchemaArgsBuilder.() -> Unit) {
val builder = SchemaArgsBuilder()
block(builder)
this.args = builder.build()
}
/**
* @param block A bag of options that control this resource's behavior.
*/
public suspend fun opts(block: suspend CustomResourceOptionsBuilder.() -> Unit) {
this.opts = com.pulumi.kotlin.options.CustomResourceOptions.opts(block)
}
internal fun build(): Schema {
val builtJavaResource = com.pulumi.aws.schemas.Schema(
this.name,
this.args.toJava(),
this.opts.toJava(),
)
return Schema(builtJavaResource)
}
}
/**
* Provides an EventBridge Schema resource.
* > **Note:** EventBridge was formerly known as CloudWatch Events. The functionality is identical.
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
* const test = new aws.schemas.Registry("test", {name: "my_own_registry"});
* const testSchema = new aws.schemas.Schema("test", {
* name: "my_schema",
* registryName: test.name,
* type: "OpenApi3",
* description: "The schema definition for my event",
* content: JSON.stringify({
* openapi: "3.0.0",
* info: {
* version: "1.0.0",
* title: "Event",
* },
* paths: {},
* components: {
* schemas: {
* Event: {
* type: "object",
* properties: {
* name: {
* type: "string",
* },
* },
* },
* },
* },
* }),
* });
* ```
* ```python
* import pulumi
* import json
* import pulumi_aws as aws
* test = aws.schemas.Registry("test", name="my_own_registry")
* test_schema = aws.schemas.Schema("test",
* name="my_schema",
* registry_name=test.name,
* type="OpenApi3",
* description="The schema definition for my event",
* content=json.dumps({
* "openapi": "3.0.0",
* "info": {
* "version": "1.0.0",
* "title": "Event",
* },
* "paths": {},
* "components": {
* "schemas": {
* "Event": {
* "type": "object",
* "properties": {
* "name": {
* "type": "string",
* },
* },
* },
* },
* },
* }))
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using System.Text.Json;
* using Pulumi;
* using Aws = Pulumi.Aws;
* return await Deployment.RunAsync(() =>
* {
* var test = new Aws.Schemas.Registry("test", new()
* {
* Name = "my_own_registry",
* });
* var testSchema = new Aws.Schemas.Schema("test", new()
* {
* Name = "my_schema",
* RegistryName = test.Name,
* Type = "OpenApi3",
* Description = "The schema definition for my event",
* Content = JsonSerializer.Serialize(new Dictionary
* {
* ["openapi"] = "3.0.0",
* ["info"] = new Dictionary
* {
* ["version"] = "1.0.0",
* ["title"] = "Event",
* },
* ["paths"] = new Dictionary
* {
* },
* ["components"] = new Dictionary
* {
* ["schemas"] = new Dictionary
* {
* ["Event"] = new Dictionary
* {
* ["type"] = "object",
* ["properties"] = new Dictionary
* {
* ["name"] = new Dictionary
* {
* ["type"] = "string",
* },
* },
* },
* },
* },
* }),
* });
* });
* ```
* ```go
* package main
* import (
* "encoding/json"
* "github.com/pulumi/pulumi-aws/sdk/v6/go/aws/schemas"
* "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
* )
* func main() {
* pulumi.Run(func(ctx *pulumi.Context) error {
* test, err := schemas.NewRegistry(ctx, "test", &schemas.RegistryArgs{
* Name: pulumi.String("my_own_registry"),
* })
* if err != nil {
* return err
* }
* tmpJSON0, err := json.Marshal(map[string]interface{}{
* "openapi": "3.0.0",
* "info": map[string]interface{}{
* "version": "1.0.0",
* "title": "Event",
* },
* "paths": map[string]interface{}{},
* "components": map[string]interface{}{
* "schemas": map[string]interface{}{
* "Event": map[string]interface{}{
* "type": "object",
* "properties": map[string]interface{}{
* "name": map[string]interface{}{
* "type": "string",
* },
* },
* },
* },
* },
* })
* if err != nil {
* return err
* }
* json0 := string(tmpJSON0)
* _, err = schemas.NewSchema(ctx, "test", &schemas.SchemaArgs{
* Name: pulumi.String("my_schema"),
* RegistryName: test.Name,
* Type: pulumi.String("OpenApi3"),
* Description: pulumi.String("The schema definition for my event"),
* Content: pulumi.String(json0),
* })
* 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.schemas.Registry;
* import com.pulumi.aws.schemas.RegistryArgs;
* import com.pulumi.aws.schemas.Schema;
* import com.pulumi.aws.schemas.SchemaArgs;
* import static com.pulumi.codegen.internal.Serialization.*;
* 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 test = new Registry("test", RegistryArgs.builder()
* .name("my_own_registry")
* .build());
* var testSchema = new Schema("testSchema", SchemaArgs.builder()
* .name("my_schema")
* .registryName(test.name())
* .type("OpenApi3")
* .description("The schema definition for my event")
* .content(serializeJson(
* jsonObject(
* jsonProperty("openapi", "3.0.0"),
* jsonProperty("info", jsonObject(
* jsonProperty("version", "1.0.0"),
* jsonProperty("title", "Event")
* )),
* jsonProperty("paths", jsonObject(
* )),
* jsonProperty("components", jsonObject(
* jsonProperty("schemas", jsonObject(
* jsonProperty("Event", jsonObject(
* jsonProperty("type", "object"),
* jsonProperty("properties", jsonObject(
* jsonProperty("name", jsonObject(
* jsonProperty("type", "string")
* ))
* ))
* ))
* ))
* ))
* )))
* .build());
* }
* }
* ```
* ```yaml
* resources:
* test:
* type: aws:schemas:Registry
* properties:
* name: my_own_registry
* testSchema:
* type: aws:schemas:Schema
* name: test
* properties:
* name: my_schema
* registryName: ${test.name}
* type: OpenApi3
* description: The schema definition for my event
* content:
* fn::toJSON:
* openapi: 3.0.0
* info:
* version: 1.0.0
* title: Event
* paths: {}
* components:
* schemas:
* Event:
* type: object
* properties:
* name:
* type: string
* ```
*
* ## Import
* Using `pulumi import`, import EventBridge schema using the `name` and `registry_name`. For example:
* ```sh
* $ pulumi import aws:schemas/schema:Schema test name/registry
* ```
*/
public class Schema internal constructor(
override val javaResource: com.pulumi.aws.schemas.Schema,
) : KotlinCustomResource(javaResource, SchemaMapper) {
/**
* The Amazon Resource Name (ARN) of the discoverer.
*/
public val arn: Output
get() = javaResource.arn().applyValue({ args0 -> args0 })
/**
* The schema specification. Must be a valid Open API 3.0 spec.
*/
public val content: Output
get() = javaResource.content().applyValue({ args0 -> args0 })
/**
* The description of the schema. Maximum of 256 characters.
*/
public val description: Output?
get() = javaResource.description().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* The last modified date of the schema.
*/
public val lastModified: Output
get() = javaResource.lastModified().applyValue({ args0 -> args0 })
/**
* The name of the schema. Maximum of 385 characters consisting of lower case letters, upper case letters, ., -, _, @.
*/
public val name: Output
get() = javaResource.name().applyValue({ args0 -> args0 })
/**
* The name of the registry in which this schema belongs.
*/
public val registryName: Output
get() = javaResource.registryName().applyValue({ args0 -> args0 })
/**
* A map of tags to assign to the resource. If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
public val tags: Output>?
get() = javaResource.tags().applyValue({ args0 ->
args0.map({ args0 ->
args0.map({ args0 ->
args0.key.to(args0.value)
}).toMap()
}).orElse(null)
})
/**
* A map of tags assigned to the resource, including those inherited from the provider `default_tags` configuration block.
*/
@Deprecated(
message = """
Please use `tags` instead.
""",
)
public val tagsAll: Output>
get() = javaResource.tagsAll().applyValue({ args0 ->
args0.map({ args0 ->
args0.key.to(args0.value)
}).toMap()
})
/**
* The type of the schema. Valid values: `OpenApi3` or `JSONSchemaDraft4`.
*/
public val type: Output
get() = javaResource.type().applyValue({ args0 -> args0 })
/**
* The version of the schema.
*/
public val version: Output
get() = javaResource.version().applyValue({ args0 -> args0 })
/**
* The created date of the version of the schema.
*/
public val versionCreatedDate: Output
get() = javaResource.versionCreatedDate().applyValue({ args0 -> args0 })
}
public object SchemaMapper : ResourceMapper {
override fun supportsMappingOfType(javaResource: Resource): Boolean =
com.pulumi.aws.schemas.Schema::class == javaResource::class
override fun map(javaResource: Resource): Schema = Schema(
javaResource as
com.pulumi.aws.schemas.Schema,
)
}
/**
* @see [Schema].
* @param name The _unique_ name of the resulting resource.
* @param block Builder for [Schema].
*/
public suspend fun schema(name: String, block: suspend SchemaResourceBuilder.() -> Unit): Schema {
val builder = SchemaResourceBuilder()
builder.name(name)
block(builder)
return builder.build()
}
/**
* @see [Schema].
* @param name The _unique_ name of the resulting resource.
*/
public fun schema(name: String): Schema {
val builder = SchemaResourceBuilder()
builder.name(name)
return builder.build()
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy