Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. glue
  5. Schema

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.glue.Schema

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

This resource represents a schema of Glue Schema Registry.

Create Schema Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Schema(name: string, args: SchemaArgs, opts?: CustomResourceOptions);
@overload
def Schema(resource_name: str,
           args: SchemaArgs,
           opts: Optional[ResourceOptions] = None)

@overload
def Schema(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           compatibility: Optional[SchemaCompatibility] = None,
           data_format: Optional[SchemaDataFormat] = None,
           checkpoint_version: Optional[SchemaVersionArgs] = None,
           description: Optional[str] = None,
           name: Optional[str] = None,
           registry: Optional[SchemaRegistryArgs] = None,
           schema_definition: Optional[str] = None,
           tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
func NewSchema(ctx *Context, name string, args SchemaArgs, opts ...ResourceOption) (*Schema, error)
public Schema(string name, SchemaArgs args, CustomResourceOptions? opts = null)
public Schema(String name, SchemaArgs args)
public Schema(String name, SchemaArgs args, CustomResourceOptions options)

type: aws-native:glue:Schema
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. SchemaArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. SchemaArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. SchemaArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. SchemaArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. SchemaArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Schema Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Schema resource accepts the following input properties:

Compatibility This property is required. Pulumi.AwsNative.Glue.SchemaCompatibility
Compatibility setting for the schema.
DataFormat This property is required. Pulumi.AwsNative.Glue.SchemaDataFormat
Data format name to use for the schema. Accepted values: 'AVRO', 'JSON', 'PROTOBUF'
CheckpointVersion Pulumi.AwsNative.Glue.Inputs.SchemaVersion
Specify the VersionNumber or the IsLatest for setting the checkpoint for the schema. This is only required for updating a checkpoint.
Description string
A description of the schema. If description is not provided, there will not be any default value for this.
Name string
Name of the schema.
Registry Pulumi.AwsNative.Glue.Inputs.SchemaRegistry
The registry where a schema is stored.
SchemaDefinition string
Definition for the initial schema version in plain-text.
Tags List<Pulumi.AwsNative.Inputs.Tag>
List of tags to tag the schema
Compatibility This property is required. SchemaCompatibility
Compatibility setting for the schema.
DataFormat This property is required. SchemaDataFormat
Data format name to use for the schema. Accepted values: 'AVRO', 'JSON', 'PROTOBUF'
CheckpointVersion SchemaVersionTypeArgs
Specify the VersionNumber or the IsLatest for setting the checkpoint for the schema. This is only required for updating a checkpoint.
Description string
A description of the schema. If description is not provided, there will not be any default value for this.
Name string
Name of the schema.
Registry SchemaRegistryArgs
The registry where a schema is stored.
SchemaDefinition string
Definition for the initial schema version in plain-text.
Tags TagArgs
List of tags to tag the schema
compatibility This property is required. SchemaCompatibility
Compatibility setting for the schema.
dataFormat This property is required. SchemaDataFormat
Data format name to use for the schema. Accepted values: 'AVRO', 'JSON', 'PROTOBUF'
checkpointVersion SchemaVersion
Specify the VersionNumber or the IsLatest for setting the checkpoint for the schema. This is only required for updating a checkpoint.
description String
A description of the schema. If description is not provided, there will not be any default value for this.
name String
Name of the schema.
registry SchemaRegistry
The registry where a schema is stored.
schemaDefinition String
Definition for the initial schema version in plain-text.
tags List<Tag>
List of tags to tag the schema
compatibility This property is required. SchemaCompatibility
Compatibility setting for the schema.
dataFormat This property is required. SchemaDataFormat
Data format name to use for the schema. Accepted values: 'AVRO', 'JSON', 'PROTOBUF'
checkpointVersion SchemaVersion
Specify the VersionNumber or the IsLatest for setting the checkpoint for the schema. This is only required for updating a checkpoint.
description string
A description of the schema. If description is not provided, there will not be any default value for this.
name string
Name of the schema.
registry SchemaRegistry
The registry where a schema is stored.
schemaDefinition string
Definition for the initial schema version in plain-text.
tags Tag[]
List of tags to tag the schema
compatibility This property is required. SchemaCompatibility
Compatibility setting for the schema.
data_format This property is required. SchemaDataFormat
Data format name to use for the schema. Accepted values: 'AVRO', 'JSON', 'PROTOBUF'
checkpoint_version SchemaVersionArgs
Specify the VersionNumber or the IsLatest for setting the checkpoint for the schema. This is only required for updating a checkpoint.
description str
A description of the schema. If description is not provided, there will not be any default value for this.
name str
Name of the schema.
registry SchemaRegistryArgs
The registry where a schema is stored.
schema_definition str
Definition for the initial schema version in plain-text.
tags Sequence[TagArgs]
List of tags to tag the schema
compatibility This property is required. "NONE" | "DISABLED" | "BACKWARD" | "BACKWARD_ALL" | "FORWARD" | "FORWARD_ALL" | "FULL" | "FULL_ALL"
Compatibility setting for the schema.
dataFormat This property is required. "AVRO" | "JSON" | "PROTOBUF"
Data format name to use for the schema. Accepted values: 'AVRO', 'JSON', 'PROTOBUF'
checkpointVersion Property Map
Specify the VersionNumber or the IsLatest for setting the checkpoint for the schema. This is only required for updating a checkpoint.
description String
A description of the schema. If description is not provided, there will not be any default value for this.
name String
Name of the schema.
registry Property Map
The registry where a schema is stored.
schemaDefinition String
Definition for the initial schema version in plain-text.
tags List<Property Map>
List of tags to tag the schema

Outputs

All input properties are implicitly available as output properties. Additionally, the Schema resource produces the following output properties:

Arn string
Amazon Resource Name for the Schema.
Id string
The provider-assigned unique ID for this managed resource.
InitialSchemaVersionId string
Represents the version ID associated with the initial schema version.
Arn string
Amazon Resource Name for the Schema.
Id string
The provider-assigned unique ID for this managed resource.
InitialSchemaVersionId string
Represents the version ID associated with the initial schema version.
arn String
Amazon Resource Name for the Schema.
id String
The provider-assigned unique ID for this managed resource.
initialSchemaVersionId String
Represents the version ID associated with the initial schema version.
arn string
Amazon Resource Name for the Schema.
id string
The provider-assigned unique ID for this managed resource.
initialSchemaVersionId string
Represents the version ID associated with the initial schema version.
arn str
Amazon Resource Name for the Schema.
id str
The provider-assigned unique ID for this managed resource.
initial_schema_version_id str
Represents the version ID associated with the initial schema version.
arn String
Amazon Resource Name for the Schema.
id String
The provider-assigned unique ID for this managed resource.
initialSchemaVersionId String
Represents the version ID associated with the initial schema version.

Supporting Types

SchemaCompatibility
, SchemaCompatibilityArgs

None
NONE
Disabled
DISABLED
Backward
BACKWARD
BackwardAll
BACKWARD_ALL
Forward
FORWARD
ForwardAll
FORWARD_ALL
Full
FULL
FullAll
FULL_ALL
SchemaCompatibilityNone
NONE
SchemaCompatibilityDisabled
DISABLED
SchemaCompatibilityBackward
BACKWARD
SchemaCompatibilityBackwardAll
BACKWARD_ALL
SchemaCompatibilityForward
FORWARD
SchemaCompatibilityForwardAll
FORWARD_ALL
SchemaCompatibilityFull
FULL
SchemaCompatibilityFullAll
FULL_ALL
None
NONE
Disabled
DISABLED
Backward
BACKWARD
BackwardAll
BACKWARD_ALL
Forward
FORWARD
ForwardAll
FORWARD_ALL
Full
FULL
FullAll
FULL_ALL
None
NONE
Disabled
DISABLED
Backward
BACKWARD
BackwardAll
BACKWARD_ALL
Forward
FORWARD
ForwardAll
FORWARD_ALL
Full
FULL
FullAll
FULL_ALL
NONE
NONE
DISABLED
DISABLED
BACKWARD
BACKWARD
BACKWARD_ALL
BACKWARD_ALL
FORWARD
FORWARD
FORWARD_ALL
FORWARD_ALL
FULL
FULL
FULL_ALL
FULL_ALL
"NONE"
NONE
"DISABLED"
DISABLED
"BACKWARD"
BACKWARD
"BACKWARD_ALL"
BACKWARD_ALL
"FORWARD"
FORWARD
"FORWARD_ALL"
FORWARD_ALL
"FULL"
FULL
"FULL_ALL"
FULL_ALL

SchemaDataFormat
, SchemaDataFormatArgs

Avro
AVRO
Json
JSON
Protobuf
PROTOBUF
SchemaDataFormatAvro
AVRO
SchemaDataFormatJson
JSON
SchemaDataFormatProtobuf
PROTOBUF
Avro
AVRO
Json
JSON
Protobuf
PROTOBUF
Avro
AVRO
Json
JSON
Protobuf
PROTOBUF
AVRO
AVRO
JSON
JSON
PROTOBUF
PROTOBUF
"AVRO"
AVRO
"JSON"
JSON
"PROTOBUF"
PROTOBUF

SchemaRegistry
, SchemaRegistryArgs

Arn string
Amazon Resource Name for the Registry.
Name string
Name of the registry in which the schema will be created.
Arn string
Amazon Resource Name for the Registry.
Name string
Name of the registry in which the schema will be created.
arn String
Amazon Resource Name for the Registry.
name String
Name of the registry in which the schema will be created.
arn string
Amazon Resource Name for the Registry.
name string
Name of the registry in which the schema will be created.
arn str
Amazon Resource Name for the Registry.
name str
Name of the registry in which the schema will be created.
arn String
Amazon Resource Name for the Registry.
name String
Name of the registry in which the schema will be created.

SchemaVersion
, SchemaVersionArgs

IsLatest bool
Indicates if the latest version needs to be updated.
VersionNumber int
Indicates the version number in the schema to update.
IsLatest bool
Indicates if the latest version needs to be updated.
VersionNumber int
Indicates the version number in the schema to update.
isLatest Boolean
Indicates if the latest version needs to be updated.
versionNumber Integer
Indicates the version number in the schema to update.
isLatest boolean
Indicates if the latest version needs to be updated.
versionNumber number
Indicates the version number in the schema to update.
is_latest bool
Indicates if the latest version needs to be updated.
version_number int
Indicates the version number in the schema to update.
isLatest Boolean
Indicates if the latest version needs to be updated.
versionNumber Number
Indicates the version number in the schema to update.

Tag
, TagArgs

Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag
key This property is required. string
The key name of the tag
value This property is required. string
The value of the tag
key This property is required. str
The key name of the tag
value This property is required. str
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native