Schema class
Provides a Glue Schema resource.
Example Usage
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\"} ]}",
});
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\"} ]}")
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\"} ]}",
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/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
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "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\"} ]}"
}
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.ArrayList;
import java.util.Arrays;
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());
}
}
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
Identity Schema
Required
arn(String) ARN of the Glue schema.
Using pulumi import, import Glue Registries using arn. For example:
$ pulumi import aws:glue/schema:Schema example arn:aws:glue:us-west-2:123456789012:schema/example/example
Constructors
- Schema(String name, {SchemaArgs? args, CustomResourceOptions? options})
-
Creates a new Schema.
nameThe Pulumi resource name.argsArguments used to configure this Schema. The set of arguments for Schema.optionsResource options controlling this resource's behavior. - Schema.reference(String urn)
- Creates a typed reference to an existing Schema resource.
Properties
-
arn
↔ Output<
String> -
ARN of the schema.
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
compatibility
↔ Output<
String> -
The compatibility mode of the schema. Values values are:
NONE,DISABLED,BACKWARD,BACKWARD_ALL,FORWARD,FORWARD_ALL,FULL, andFULL_ALL.latefinal -
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
dataFormat
↔ Output<
String> -
The data format of the schema definition. Valid values are
AVRO,JSONandPROTOBUF.latefinal -
description
↔ Output<
String?> -
A description of the schema.
latefinal
- hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
latestSchemaVersion
↔ Output<
int> -
The latest version of the schema associated with the returned schema definition.
latefinal
-
nextSchemaVersion
↔ Output<
int> -
The next version of the schema associated with the returned schema definition.
latefinal
-
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
registryArn
↔ Output<
String> -
The ARN of the Glue Registry to create the schema in.
latefinal
-
registryName
↔ Output<
String> -
The name of the Glue Registry.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
schemaCheckpoint
↔ Output<
int> -
The version number of the checkpoint (the last time the compatibility mode was changed).
latefinal
-
schemaDefinition
↔ Output<
String> -
The schema definition using the
dataFormatsetting forschemaName.latefinal -
schemaName
↔ Output<
String> -
The Name of the schema.
latefinal
-
Key-value map of resource tags. .If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.latefinal -
A map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.latefinal -
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited