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
@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)
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.
resource "aws-native_glue_schema" "name" {
# resource properties
}
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.
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:
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.
- initial_schema_version_id
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.
Look up Existing Schema Resource
Get an existing Schema resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static Schema get(String name, Output<String> id, CustomResourceOptions options)
resources: existingSchema: type: aws-native:glue:Schema get: id: ${id}
import {
to = aws-native_glue_schema.example
id = "${id}"
}
- name
string
- The unique name of the resulting resource.
- id
Input<ID>
- The unique provider ID of the resource to look up.
- opts
CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name
str
- The unique name of the resulting resource.
- id
str
- The unique provider ID of the resource to look up.
- 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 resulting resource.
- id
IDInput
- The unique provider ID of the resource to look up.
- state
SchemaState
- Pass nil. This resource has no state arguments.
- opts
ResourceOption
- Bag of options to control resource's behavior.
- name
string
- The unique name of the resulting resource.
- id
Input<string>
- The unique provider ID of the resource to look up.
- opts
CustomResourceOptions
- Bag of options to control resource's behavior.
- name
String
- The unique name of the resulting resource.
- id
Output<String>
- The unique provider ID of the resource to look up.
- options
CustomResourceOptions
- Bag of options to control resource's behavior.
Supporting Types
SchemaCompatibility, SchemaCompatibilityArgs
Compatibility setting for the schema.| Name | Value |
|---|
| None | NONE |
| Disabled | DISABLED |
| Backward | BACKWARD |
| BackwardAll | BACKWARD_ALL |
| Forward | FORWARD |
| ForwardAll | FORWARD_ALL |
| Full | FULL |
| FullAll | FULL_ALL |
| Name | Value |
|---|
| SchemaCompatibilityNone | NONE |
| SchemaCompatibilityDisabled | DISABLED |
| SchemaCompatibilityBackward | BACKWARD |
| SchemaCompatibilityBackwardAll | BACKWARD_ALL |
| SchemaCompatibilityForward | FORWARD |
| SchemaCompatibilityForwardAll | FORWARD_ALL |
| SchemaCompatibilityFull | FULL |
| SchemaCompatibilityFullAll | FULL_ALL |
| Value |
|---|
NONE |
DISABLED |
BACKWARD |
BACKWARD_ALL |
FORWARD |
FORWARD_ALL |
FULL |
FULL_ALL |
| Name | Value |
|---|
| None | NONE |
| Disabled | DISABLED |
| Backward | BACKWARD |
| BackwardAll | BACKWARD_ALL |
| Forward | FORWARD |
| ForwardAll | FORWARD_ALL |
| Full | FULL |
| FullAll | FULL_ALL |
| Name | Value |
|---|
| None | NONE |
| Disabled | DISABLED |
| Backward | BACKWARD |
| BackwardAll | BACKWARD_ALL |
| Forward | FORWARD |
| ForwardAll | FORWARD_ALL |
| Full | FULL |
| FullAll | FULL_ALL |
| Name | Value |
|---|
| NONE | NONE |
| DISABLED | DISABLED |
| BACKWARD | BACKWARD |
| BACKWARD_ALL | BACKWARD_ALL |
| FORWARD | FORWARD |
| FORWARD_ALL | FORWARD_ALL |
| FULL | FULL |
| FULL_ALL | FULL_ALL |
| Value |
|---|
NONE |
DISABLED |
BACKWARD |
BACKWARD_ALL |
FORWARD |
FORWARD_ALL |
FULL |
FULL_ALL |
Data format name to use for the schema. Accepted values: 'AVRO', 'JSON', 'PROTOBUF'| Name | Value |
|---|
| Avro | AVRO |
| Json | JSON |
| Protobuf | PROTOBUF |
| Name | Value |
|---|
| SchemaDataFormatAvro | AVRO |
| SchemaDataFormatJson | JSON |
| SchemaDataFormatProtobuf | PROTOBUF |
| Name | Value |
|---|
| Avro | AVRO |
| Json | JSON |
| Protobuf | PROTOBUF |
| Name | Value |
|---|
| Avro | AVRO |
| Json | JSON |
| Protobuf | PROTOBUF |
| Name | Value |
|---|
| AVRO | AVRO |
| JSON | JSON |
| PROTOBUF | PROTOBUF |
SchemaRegistry, SchemaRegistryArgs
Identifier for the registry which the schema is part of.- 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
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
Specify checkpoint version for update. This is only required to update the Compatibility.- 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.
- is_latest
bool
- Indicates if the latest version needs to be updated.
- version_number
number
- 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
A set of tags to apply to the resource.- Key
string
- The key name of the tag
- Value
string
- The value of the tag
- Key
string
- The key name of the tag
- Value
string
- The value of the tag
- key
string
- The key name of the tag
- value
string
- The value of the tag
- key
String
- The key name of the tag
- value
String
- The value of the tag
- key
string
- The key name of the tag
- value
string
- The value of the tag
- key
str
- The key name of the tag
- value
str
- The value of the tag
- key
String
- The key name of the tag
- value
String
- The value of the tag
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0