We recommend new projects start with resources from the AWS provider.
We recommend new projects start with resources from the AWS provider.
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 string
- The unique name of the resource.
- args SchemaArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args 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 string
- The unique name of the resource.
- args SchemaArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args SchemaArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args 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
Pulumi.
Aws Native. Glue. Schema Compatibility - Compatibility setting for the schema.
- Data
Format Pulumi.Aws Native. Glue. Schema Data Format - Data format name to use for the schema. Accepted values: 'AVRO', 'JSON', 'PROTOBUF'
- Checkpoint
Version Pulumi.Aws Native. Glue. Inputs. Schema Version - Specify the
VersionNumberor theIsLatestfor 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.
Aws Native. Glue. Inputs. Schema Registry - The registry where a schema is stored.
- Schema
Definition string - Definition for the initial schema version in plain-text.
-
List<Pulumi.
Aws Native. Inputs. Tag> - List of tags to tag the schema
- Compatibility
Schema
Compatibility - Compatibility setting for the schema.
- Data
Format SchemaData Format - Data format name to use for the schema. Accepted values: 'AVRO', 'JSON', 'PROTOBUF'
- Checkpoint
Version SchemaVersion Type Args - Specify the
VersionNumberor theIsLatestfor 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
Schema
Registry Args - The registry where a schema is stored.
- Schema
Definition string - Definition for the initial schema version in plain-text.
-
Tag
Args - List of tags to tag the schema
- compatibility
Schema
Compatibility - Compatibility setting for the schema.
- data
Format SchemaData Format - Data format name to use for the schema. Accepted values: 'AVRO', 'JSON', 'PROTOBUF'
- checkpoint
Version SchemaVersion - Specify the
VersionNumberor theIsLatestfor 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
Schema
Registry - The registry where a schema is stored.
- schema
Definition String - Definition for the initial schema version in plain-text.
- List<Tag>
- List of tags to tag the schema
- compatibility
Schema
Compatibility - Compatibility setting for the schema.
- data
Format SchemaData Format - Data format name to use for the schema. Accepted values: 'AVRO', 'JSON', 'PROTOBUF'
- checkpoint
Version SchemaVersion - Specify the
VersionNumberor theIsLatestfor 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
Schema
Registry - The registry where a schema is stored.
- schema
Definition string - Definition for the initial schema version in plain-text.
- Tag[]
- List of tags to tag the schema
- compatibility
Schema
Compatibility - Compatibility setting for the schema.
- data_
format SchemaData Format - Data format name to use for the schema. Accepted values: 'AVRO', 'JSON', 'PROTOBUF'
- checkpoint_
version SchemaVersion Args - Specify the
VersionNumberor theIsLatestfor 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
Schema
Registry Args - The registry where a schema is stored.
- schema_
definition str - Definition for the initial schema version in plain-text.
-
Sequence[Tag
Args] - List of tags to tag the schema
- compatibility "NONE" | "DISABLED" | "BACKWARD" | "BACKWARD_ALL" | "FORWARD" | "FORWARD_ALL" | "FULL" | "FULL_ALL"
- Compatibility setting for the schema.
- data
Format "AVRO" | "JSON" | "PROTOBUF" - Data format name to use for the schema. Accepted values: 'AVRO', 'JSON', 'PROTOBUF'
- checkpoint
Version Property Map - Specify the
VersionNumberor theIsLatestfor 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.
- schema
Definition String - Definition for the initial schema version in plain-text.
- 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.
- Initial
Schema stringVersion Id - 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.
- Initial
Schema stringVersion Id - 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.
- initial
Schema StringVersion Id - 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.
- initial
Schema stringVersion Id - 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_ strversion_ id - 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.
- initial
Schema StringVersion Id - Represents the version ID associated with the initial schema version.
Supporting Types
SchemaCompatibility, SchemaCompatibilityArgs
- None
NONE- Disabled
DISABLED- Backward
BACKWARD- Backward
All BACKWARD_ALL- Forward
FORWARD- Forward
All FORWARD_ALL- Full
FULL- Full
All FULL_ALL
- Schema
Compatibility None NONE- Schema
Compatibility Disabled DISABLED- Schema
Compatibility Backward BACKWARD- Schema
Compatibility Backward All BACKWARD_ALL- Schema
Compatibility Forward FORWARD- Schema
Compatibility Forward All FORWARD_ALL- Schema
Compatibility Full FULL- Schema
Compatibility 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
- 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
- "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
- Schema
Data Format Avro AVRO- Schema
Data Format Json JSON- Schema
Data Format Protobuf 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
Identifier for the registry which the schema is part of.SchemaVersion, SchemaVersionArgs
Specify checkpoint version for update. This is only required to update the Compatibility.- Is
Latest bool - Indicates if the latest version needs to be updated.
- Version
Number int - 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.
- is
Latest Boolean - Indicates if the latest version needs to be updated.
- version
Number Integer - Indicates the version number in the schema to update.
- is
Latest boolean - Indicates if the latest version needs to be updated.
- version
Number 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.
- is
Latest Boolean - Indicates if the latest version needs to be updated.
- version
Number Number - Indicates the version number in the schema to update.
Tag, TagArgs
A set of tags to apply to the resource.Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.
